Eclipse MicroProfileを使ったマイクロサービスの構築

1概要

この記事では、Eclipse MicroProfileをベースにしたマイクロサービスの構築に焦点を当てます。

JAX-RS、CDI、およびJSON-P APIを使用してRESTful Webアプリケーションを作成する方法を見ていきます。

2マイクロサービスアーキテクチャ

簡単に言えば、マイクロサービスは、いくつかの独立したサービスの集合として完全なシステムを形成するソフトウェアアーキテクチャスタイルです。

それぞれが1つの機能的な境界に焦点を当て、RESTなどの言語にとらわれないプロトコルで他と通信します。

3 Eclipse MicroProfile

Eclipse MicroProfileは、Microservicesアーキテクチャー用にEnterprise Javaを最適化することを目的としたイニシアチブです。これは、Java EE WebProfile APIのサブセットに基づいているため、Java EEアプリケーションと同様にMicroProfileアプリケーションを構築できます。

MicroProfileの目的は、マイクロサービスを構築するための標準APIを定義し、複数のMicroProfileランタイムにわたってポータブルアプリケーションを提供することです。

4 Mavenの依存関係

Eclipse MicroProfileアプリケーションの構築に必要なすべての依存関係は、このBOM(Bill of Materials)依存関係によって提供されます。

<dependency>
    <groupId>org.eclipse.microprofile</groupId>
    <artifactId>microprofile</artifactId>
    <version>1.2</version>
    <type>pom</type>
    <scope>provided</scope>
</dependency>

MicroProfileランタイムにはすでにAPIと実装が含まれているため、有効範囲は provided に設定されています。

5表現モデル

クイックリソースクラスを作成することから始めましょう。

public class Book {
    private String id;
    private String name;
    private String author;
    private Integer pages;
   //...
}

ご覧のとおり、この Book クラスには注釈がありません。

6. CDI を使う

簡単に言えば、CDIは依存性注入とライフサイクル管理を提供するAPIです。 WebアプリケーションでのEnterprise Beanの使用が簡単になります。

それでは、ブック表現のストアとしてCDIマネージドBeanを作成しましょう。

@ApplicationScoped
public class BookManager {

    private ConcurrentMap<String, Book> inMemoryStore
      = new ConcurrentHashMap<>();

    public String add(Book book) {
       //...
    }

    public Book get(String id) {
       //...
    }

    public List getAll() {
       //...
    }
}

このクラスに @ ApplicationScoped というアノテーションを付けるのは、状態がすべてのクライアントによって共有されるインスタンスが1つだけ必要なためです。そのために、タイプセーフなインメモリデータストアとして ConcurrentMap を使用しました。それから CRUD 操作のためのメソッドを追加しました。

これで、このBeanはCDI対応になり、@ @ Inject__アノテーションを使用してBeanのBookBookエンドポイントに挿入できます。

7. JAX-RS API

JAX-RSを使用してRESTアプリケーションを作成するには、 @ ApplicationPath というアノテーションが付いた Application クラスと @Path. というアノテーションが付いたリソースを作成する必要があります。

7.1. JAX RSアプリケーション

JAX-RSアプリケーションは、Webアプリケーションでリソースを公開するためのベースURIを識別します。

次のJAX-RSアプリケーションを作成しましょう。

@ApplicationPath("/library")
public class LibraryApplication extends Application {
}

この例では、Webアプリケーション内のすべてのJAX-RSリソースクラスは LibraryApplication に関連付けられており、それらは同じ library パス、つまり__ApplicationPathアノテーションの値の下に置かれています。

このアノテーション付きクラスはJAX RSランタイムに、リソースを自動的に見つけてそれらを公開するように指示します。

7.2. JAX RSエンドポイント

Endpoint クラスは Resource クラスとも呼ばれ、1つのリソースを定義する必要がありますが、技術的には同じ種類のものが多数あります。

@ Path でアノテーションが付けられた、または @ Pathまたは@HttpMethod でアノテーションが付けられた少なくとも1つのメソッドを持つ各Javaクラスはエンドポイントです。

それでは、その表現を公開するJAX-RSエンドポイントを作成します。

@Path("books")
@RequestScoped
public class BookEndpoint {

    @Inject
    private BookManager bookManager;

    @GET
    @Path("{id}")
    @Produces(MediaType.APPLICATION__JSON)
    public Response getBook(@PathParam("id") String id) {
        return Response.ok(bookManager.get(id)).build();
    }

    @GET
    @Produces(MediaType.APPLICATION__JSON)
    public Response getAllBooks() {
        return Response.ok(bookManager.getAll()).build();
    }

    @POST
    @Consumes(MediaType.APPLICATION__JSON)
    public Response add(Book book) {
        String bookId = bookManager.add(book);
        return Response.created(
          UriBuilder.fromResource(this.getClass())
            .path(bookId).build())
            .build();
    }
}

この時点で、Webアプリケーションの /library/books パスにある BookEndpoint Resourceにアクセスできます。

7.3. JAX RS JSONメディアタイプ

JAX RSはRESTクライアントと通信するために多くのメディアタイプをサポートしますが、 Eclipse MicroProfileはJSOP-P APIの使用を指定しているのでJSON の使用を制限します。そのため、メソッドに @ Consumes(MediaType.APPLICATION JSON) および@ Produces(MediaType.APPLICATION__JSON)のアノテーションを付ける必要があります。

@ Consumes アノテーションは受け入れられる形式を制限します - この例では、JSONデータ形式だけが受け入れられます。 HTTPリクエストヘッダ Content-Type application/json であるべきです。

同じ考え方が @ Produces アノテーションの背後にあります。 JAX RS RuntimeはJSON形式への応答を整列化する必要があります。要求HTTPヘッダー Accept application/json. にする必要があります。

8 JSON-P

JAX RS RuntimeはそのままでJSON-Pをサポートしているので、 JsonObject をメソッドの入力パラメータまたは戻り値の型として使用できます。

しかし、現実の世界では、私たちはしばしばPOJOクラスで作業します。そのため、 JsonObject とPOJOの間のマッピングを行う方法が必要です。ここがJAX RSエンティティプロバイダの役割です。

JSON入力ストリームを Book POJOに整列化するには、__Book型のパラメータでリソースメソッドを呼び出します。

@Provider
@Consumes(MediaType.APPLICATION__JSON)
public class BookMessageBodyReader implements MessageBodyReader<Book> {

    @Override
    public boolean isReadable(
      Class<?> type, Type genericType,
      Annotation[]annotations,
      MediaType mediaType) {

        return type.equals(Book.class);
    }

    @Override
    public Book readFrom(
      Class type, Type genericType,
      Annotation[]annotations,
      MediaType mediaType,
      MultivaluedMap<String, String> httpHeaders,
      InputStream entityStream) throws IOException, WebApplicationException {

        return BookMapper.map(entityStream);
    }
}

Book からJSONへの出力ストリームを非整列化するのと同じプロセスを実行します。それは、戻り値の型が__Bookであるリソースメソッドを呼び出すことです。

@Provider
@Produces(MediaType.APPLICATION__JSON)
public class BookMessageBodyWriter
  implements MessageBodyWriter<Book> {

    @Override
    public boolean isWriteable(
      Class<?> type, Type genericType,
      Annotation[]annotations,
      MediaType mediaType) {

        return type.equals(Book.class);
    }

   //...

    @Override
    public void writeTo(
      Book book, Class<?> type,
      Type genericType,
      Annotation[]annotations,
      MediaType mediaType,
      MultivaluedMap<String, Object> httpHeaders,
      OutputStream entityStream) throws IOException, WebApplicationException {

        JsonWriter jsonWriter = Json.createWriter(entityStream);
        JsonObject jsonObject = BookMapper.map(book);
        jsonWriter.writeObject(jsonObject);
        jsonWriter.close();
    }
}

BookMes​​sageBodyReader BookMes​​sageBodyWriter には @ Provider というアノテーションが付けられているので、それらはJAX RSランタイムによって自動的に登録されます。

** 9アプリケーションの構築と実行

MicroProfileアプリケーションは移植性があり、準拠しているMicroProfileランタイムで実行する必要があります。 Open Liberty でアプリケーションのビルド方法と実行方法について説明しますが、準拠しているEclipse MicroProfileを使用することもできます。

Open Libertyランタイムを構成ファイル server.xml を介して構成します。

<server description="OpenLiberty MicroProfile server">
    <featureManager>
        <feature>jaxrs-2.0</feature>
        <feature>cdi-1.2</feature>
        <feature>jsonp-1.0</feature>
    </featureManager>
    <httpEndpoint httpPort="${default.http.port}" httpsPort="${default.https.port}"
      id="defaultHttpEndpoint" host="** "/>
    <applicationManager autoExpand="true"/>
    <webApplication context-root="${app.context.root}" location="${app.location}"/>
</server>

プラグイン liberty-maven-plugin をpom.xmlに追加しましょう。

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <groupId>net.wasdev.wlp.maven.plugins</groupId>
    <artifactId>liberty-maven-plugin</artifactId>
    <version>2.1.2</version>
    <configuration>
        <assemblyArtifact>
            <groupId>io.openliberty</groupId>
            <artifactId>openliberty-runtime</artifactId>
            <version>17.0.0.4</version>
            <type>zip</type>
        </assemblyArtifact>
        <configFile>${basedir}/src/main/liberty/config/server.xml</configFile>
        <packageFile>${package.file}</packageFile>
        <include>${packaging.type}</include>
        <looseApplication>false</looseApplication>
        <installAppPackages>project</installAppPackages>
        <bootstrapProperties>
            <app.context.root>/</app.context.root>
            <app.location>${project.artifactId}-${project.version}.war</app.location>
            <default.http.port>9080</default.http.port>
            <default.https.port>9443</default.https.port>
        </bootstrapProperties>
    </configuration>
    <executions>
        <execution>
            <id>install-server</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>install-server</goal>
                <goal>create-server</goal>
                <goal>install-feature</goal>
            </goals>
        </execution>
        <execution>
            <id>package-server-with-apps</id>
            <phase>package</phase>
            <goals>
                <goal>install-apps</goal>
                <goal>package-server</goal>
            </goals>
        </execution>
    </executions>
</plugin>

このプラグインは一連のプロパティを設定して設定できます。

<properties>
    <!--...-->
    <app.name>library</app.name>
    <package.file>${project.build.directory}/${app.name}-service.jar</package.file>
    <packaging.type>runnable</packaging.type>
</properties>

上記のexecの目標は実行可能なjarファイルを作成するので、私たちのアプリケーションは独立してデプロイして実行できる独立したマイクロサービスになります。 Dockerイメージとして展開することもできます。

実行可能jarを作成するには、次のコマンドを実行します。

mvn package

マイクロサービスを実行するには、次のコマンドを使用します。

java -jar target/library-service.jar

これでOpen Libertyランタイムが起動し、私たちのサービスがデプロイされます。エンドポイントにアクセスして、次のURLですべての書籍を入手できます。

curl http://localhost:9080/library/books

結果はJSONです。

----[  {
    "id": "0001-201802",
    "isbn": "1",
    "name": "Building Microservice With Eclipse MicroProfile",
    "author": "baeldung",
    "pages": 420
  }]----

一冊の本を入手するには、次のURLをリクエストします。

curl http://localhost:9080/library/books/0001-201802

そして結果はJSONです。

{
    "id": "0001-201802",
    "isbn": "1",
    "name": "Building Microservice With Eclipse MicroProfile",
    "author": "baeldung",
    "pages": 420
}

それでは、APIと対話して新しいBookを追加します。

curl
  -H "Content-Type: application/json"
  -X POST
  -d '{"isbn": "22", "name": "Gradle in Action","author": "baeldung","pages": 420}'
  http://localhost:9080/library/books

ご覧のとおり、レスポンスのステータスは201で、書籍が正常に作成されたことを示し、 Location はアクセスできるURIです。

< HTTP/1.1 201 Created
< Location: http://localhost:9080/library/books/0009-201802

10結論

この記事では、Eclipse MicroProfileに基づいて単純なマイクロサービスを構築する方法を説明し、JAX RS、JSON-PおよびCDIについて説明しました。

このコードはhttps://github.com/eugenp/tutorials/tree/master/microprofile[Githubで利用可能]です。これはMavenベースのプロジェクトなので、そのままインポートして実行するのは簡単なはずです。