[230831] java spi(service provider interface)

서비스가 정의하는 인터페이스 또는 추상클래스 집합. 어플리케이션에서 사용할 수 있는 클래스와 메서드를 말함.

Provider라고 부르는 서비스 구현체. resource 디렉터리에 META-INF/services 에다가 provider configuration file을 위치시켜야 식별된다. 어플리케이션의 클래스패스에서 사용할 수 있어야 한다.

서비스 구현체를 lazy하게 검색 및 로딩하는데 사용되는 기본 클래스. ServiceLoader는 이미 로드된 서비스의 캐시를 유지한다. 서비스로더를 호출할 때마다 캐시에 있는 요소를 먼저 나열한 다음 나머지 provider를 검색하고 인스턴스화한다.

SPI 클래스는 classpath 내에 정의된 다양한 Provider를 자동으로 로드하므로 검색 메커니즘으로 설명해야한다.

ServiceLoader는 검색을 제공하는 몇 가지 방법을 제공하며 이를 수행하는데 사용되는 기본도구이다.

• iterate() : available providers 를 lazy하게 로드하고 인스턴스화 하는 iterator를 리턴한다. #+BEGIN_RC Iterator<ServiceInterface> providers = loader.iterator(); while (providers.hasNext()) { ServiceProvider provider = providers.next(); } #+END_SRC
• stream() : iterator 대신 stream을 리턴하는 것이다. #+BEGIN_SRC Stream<ServiceInterface> providers = ServiceLoader.load(ServiceInterface.class) .stream() .map(Provider::get) #+END
• reload() : 로더의 provider 캐시를 지우고 provider를 다시 로드한다. 이 방법은 실행 중인 JVM에 새로운 서비스 공급자가 설치되는 상황에서 사용한다.

ServiceLOader가 이러한 Provider를 식별하고 로드할 수 있도록 등록하는 프로세스가 있다. META-INF/services 폴더에 configuration file을 추가해야 한다.

service provider interface의 fully qualified class name 이 파일명이고 1개 이상의 fully qualified class name을 가진다. 한줄에 하나씩이다.

예를들어, InterfaceName 이라는 Service Provider가 있다. ServiceProviderImplementation 을 공급자로 등록하고 싶다면, package.name.IterfaceName 이라는 파일명과, package.name.ServiceProviderImplementation 한 줄이 있어야 한다.

classpath 에 같은 이름을 가진 많은 configuration 파일이 있음을 알 수 있다. 이런 이유로, ServiceLoader는 ClassLoader.getResources() 메서드를 사용하여 각 공급자를 식별하기 위해 모든 Configuration의 Enumeration을 가져온다.

서적 객체.

public class Book {
  String name;
  String author;
  String description;
}

서비스를 위한 Service provider interface

package org.library.spi;

public interface Library {
  String getCategory();
  Book getBook(String name);
}

마지막으로, 우리는 LibraryService 클래스를 만든다. 클라이언트가 도서관의 책을 검색하기 위해 사용한다.

public class LibraryService {
  private static LibraryService libraryService;
  private final ServiceLoader<Library> loader;

  public static synchronized LibraryService getInstance() {
    if (libraryService == null) {
      libraryService = new LibraryService();
    }
    return libraryService;
  }

  private LibraryService() {
    loader = ServiceLoader.load(Library.class);
  }

  public Optional<Book> getBook(String name) {
    Book book = null;
    Iterator<Library> libraries = loader.iterator();
    while (book == null && libraries.hasNext()) {
      Library library = libraries.next());
      book = library.getBook(name);
    }
    return Optional.ofNullable(book);
  }

  public Optional<Book> getBook(String name, String category) {
    return loader.stream()
      .map(ServiceLoader.Provider::get)
      .filter(library -> library.getCategory().equals(category))
      .map(library -> library.getBook(name))
      .filter(Objects::nonNull)
      .findFirst();
  }
}

클라이언트는 getInstance() 메서드를 사용하여 필요한 책을 검색하기 위한 싱글톤 LibraryService 객체를 가져온다.

생성자 LibraryService는 정적 팩터리 메서드 load()를 호출하여 라이브러리 구현을 검색할 수 있는 ServiceLoader의 인스턴스를 가져온다.

getBook(String name)은 iterate()을 이용해서 사용 가능한 모든 라이브러리 구현을 순회하여 찾아낸다.

getBook(String name, String category) : 특정 카테고리에서 책을 찾는다. 여기선 stream() 으로 공급자(Provider)를 로드한 다음 getBook() 메서드를 호출하여 책을 찾는 방식을 이용한다.

• 공식문서

package org.library;
import java.util.Map;
import java.util.TreeMap;

import org.library.spi.Book;
import org.library.spi.Library;

public class ComputerScienceLibrary implements Library {

    public static final String COMPUTER_SCIENCE_LIBRARY = "COMPUTER_SCIENCE";

    private final Map<String, Book> books;

    public ComputerScienceLibrary() {
	books = new TreeMap<>();

	Book cleanCode = new Book("Clean Code", "Robert C. Martin",
		"Even bad code can function. But if code isn’t clean, it can bring a development organization to its knees");
	Book pragmaticProgrammer = new Book("The Pragmatic Programmer", "Hunt Andrew, Thomas David",
		"This book is filled with both technical and professional practical advices for developers in order become better developers.");

	books.put(cleanCode.getName(), cleanCode);
	books.put(pragmaticProgrammer.getName(), pragmaticProgrammer);
    }

    @Override
    public String getCategory() {
	return COMPUTER_SCIENCE_LIBRARY;
    }

    @Override
    public Book getBook(String name) {
	return books.get(name);
    }
}

resources/META-INF/services/org.library.spi.Library 안에 org.library.ComputerScienceLibrary 가 있다.

이 모듈은 이제 사용자이므로, Library에서 책을 찾기위해 LibarayService를 사용할 것이다. 처음은 데모용으로 classic library만 쓰고 이후에 computer science library를 의존성에 넣자. 그러면 ServiceLoader가 알아서 검색해서 인스턴스화 할 것이다.

library-client pom.xml 에 드디어 classic-library 모듈이 들어간다.

<dependency>
  <groupId>org.library</groupId>
  <artifactId>classics-library</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
  <groupId>org.library</groupId>
  <artifactId>library-service-provider</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

이제 책을 검색하자

public class LibraryClient {
  public static void main(String[] args) {
    LibraryService libraryService = LibraryService.getInstance();
    requestBook("Clean Code", libraryService);
    requestBook("The Lord of the Rings", libraryService);
    requestBook("The Lord of the Rings", "COMPUTER_SCIENCE", libraryService);
  }

  private static void requestBook(
      String bookName,
      String category,
      LibraryService library) {
    library.getBook(bookName, category)
      .ifPresentOrElse(
	book -> System.out.println("The book '" + bookName +
	  "' was found in  " + category + ", here are the details:" + book),
	() -> System.out.println("The library " + category + " doesn't have the book '"
	  + bookName + "' that you need."));
  }
}
--- output ---
The library doesn't have the book 'Clean Code' that you need.
The book 'The Lord of the Rings' was found, here are the details:Book{name='The Lord of the Rings',...}
The library COMPUTER_SCIENCE doesn't have the book 'The Lord of the Rings' that you need.

Clean Code는computer science library 에 있을 것이다.

자 그럼 이것을 추가하자

<dependency>
  <groupId>org.library</groupId>
  <artifactId>computer-science-library</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

다시 시도하면 Clean Code가 검색될 것이다.

The book 'Clean Code'was found, here are the details:Book{name='Clean Code...}
The book 'The Lord of the Rings' was found, here are the details: Book{name='The Lord of ...}
The library COMPUTER_SCIENCE doesn't have the book 'The Lord of the Rings' that you need.

이렇게 provider를 플러그인만 하면 되었다.

• 관련 소스코드 git : https://github.com/thombergs/code-examples/tree/master/core-java/service-provider-interface