WebOTX Manual V10.4 (第4版) 目次を表示

---

14.7. MicroProfile Rest Client

14.7.1. 概要

14.7.2. MicroProfile Rest Client アプリケーションの作成方法の違いによる特徴

14.7.2.1. CDIを使用する場合

14.7.2.2. CDIを使用しない場合

Memo
どちらにも属さないプロバイダクラス登録方法
独自に作成したプロバイダクラスの登録方法は、上記にそれぞれ存在しますが、それとは別に、プロバイダ構成ファイルにプロバイダクラス名を記載し、サービスローダによりロードさせる方法があります。これには登録方法をソースに記載しないという利点があります。上記それぞれでの登録方法の代わりに使用することができます。

14.7.3. 提供機能

14.7.3.1. MicroProfile Rest Client の提供アノテーション

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
       bean-discovery-mode="all">
</beans>
    

Caution
上記でスコープアノテーションを付与する方法を採用した場合、次の注意点があります。
スコープアノテーションを省略した場合、@Dependentアノテーションがデフォルトとなります。
一方、beans.xmlがない場合、bean-discovery-mode属性のデフォルト値はannotatedとなります。annotatedはスコープアノテーションが付与されたクラスのみを CDI管理Beanとします。したがって、対象クラスをCDI管理Beanとしたい場合は、スコープアノテーションを明示する必要があります。

14.7.3.2. ベースURL/URI(※)の設定

14.7.3.3. RestClientBuilder APIの提供メソッド

14.7.3.4. サービスローダの設定

1. org.eclipse.microprofile.rest.client.spi.RestClientBuilderListenerインターフェースを実装します。
2. META-INF/services ディレクトリ配下に org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener ファイル(プロバイダ構成ファイル)を作成します。
3. 上記ファイルに、RestClientBuilderListenerインターフェース実装クラスの完全修飾クラス名を記載します。
   その際、文字コードをUTF-8にします。

14.7.3.5. 独自例外Mapperクラスの作成

@Provider
public class CustomExceptionMapper implements ResponseExceptionMapper<CustomBaseException> {
    @Override
    public boolean handles(int status, MultivaluedMap<String, Object> headers) {
        return status == 404 || status == 409;
    }
    
    @Override
    public CustomBaseException toThrowable(Response response) {
        switch (response) {
            case 404:
                return new CustomUnknownUrlException();
            case 409:
                return new CustomConfrictDataException();
        }
        return null;
    }
}
    

14.7.3.6. デフォルト例外Mapper

• CDI使用時、MicroProfile Rest Client 設定項目一覧の[microprofile.rest.client.disable.default.mapper]を参照してください。
  microprofile-config.properties はMicroProfile Configの機能を使うための設定ファイルです。microprofile-config.properties を使わずに設定する方法もあります。詳細は[MicroProfile Config]をご確認ください。
• CDI未使用時、RestClientBuilder APIのpropertyメソッドに次のように指定します。
  RestClientBuilder.newBuilder().property("microprofile.rest.client.disable.default.mapper", true)

14.7.3.7. 非同期処理

public interface CustomAsyncClient {
    @GET
    public CompletionStage<Response> getAsync();
}
    

CompletableFuture<Response> future = customAsyncClient.getAsync().toCompletableFuture();
Response res = future.get();
    

14.7.3.8. ※ベースURL/URIとは

14.7.4. XMLで通信するMicroProfile Rest Client アプリケーションの作成

14.7.4.1. MicroProfile Rest Client アプリケーション作成(CDI使用)

MicroProfile Rest Clientプロジェクトの作成

Customerクラスのコピー

インターフェースの作成

package sample.restclient;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import sample.resource.Customer;

@RegisterRestClient
public interface RestClientInterface {
    public Customer getCustomerList(String id);
}
    

package sample.restclient;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import sample.resource.Customer;

@Path(value = "/name_list")
@RegisterRestClient
public interface RestClientInterface {
    @Produces(value = { "application/xml" })
    @GET
    @Path(value = "{id}")
    public Customer getCustomerList(@PathParam(value = "id") String id);
}
    

ルートリソースクラスの作成

package sample.restclient;

import org.eclipse.microprofile.rest.client.inject.RestClient;

import sample.resource.Customer;

public class RestClientResource {
    
    @RestClient
    RestClientInterface itf;

    public Customer getCustomerList(String id) {
        Customer custom = itf.getCustomerList(id);
        return custom;
    }
}
    

• クラス名RestClientResourceにアノテーション@Path("/client")、@RequestScopedを追加
• インスタンス変数clientにアノテーション@Injectを追加
• getCustomerListメソッドにアノテーション@Produces(value = { "application/xml" })、@GET、@Path(value = "{id}")を追加。
• ・パラメーターidにアノテーション@PathParam(value = "id")を追加

package sample.restclient;

import javax.enterprise.context.RequestScoped;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.eclipse.microprofile.rest.client.inject.RestClient;

import sample.resource.Customer;

@Path("/client")
@RequestScoped
public class RestClientResource {
    
    @Inject
    @RestClient
    RestClientInterface itf;

    @Produces(value = { "application/xml" })
    @GET
    @Path(value = "{id}")
    public Customer getCustomerList(@PathParam(value = "id") String id) {
        Customer custom = itf.getCustomerList(id);
        return custom;
    }
}
    

web.xml にリソースクラスを指定

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  <display-name>RestClientXML</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <servlet>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
      <param-name>jersey.config.server.provider.classnames</param-name>
      <param-value>sample.restclient.RestClientResource</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

microprofile-config.propertiesの作成

インターフェースの完全修飾名 + "/mp-rest/" + "url" または"uri"=JAX-RS アプリケーションのベースURL/URI

Caution
microprofile-config_propertiesへの記述はSourceタブで行ってください。Propertiesタブに記述すると、ベースURL/URIに意図せずエスケープ文字が追加され、正しいURL/URIとして認識されなくなります。

アプリケーションのデプロイ

アプリケーションの実行

14.7.4.2. MicroProfile Rest Client アプリケーション作成(CDI未使用)

MicroProfile Rest Clientプロジェクトの作成

Customerクラスのコピー

インターフェースの作成

ルートリソースクラスの作成

package sample.restclient;

import java.net.URL;

import org.eclipse.microprofile.rest.client.RestClientBuilder;

import sample.resource.Customer;

public class RestClientResource {
    public Customer getCustomerList(String id) {
        URL apUrl = null;
        try {
            apUrl = new URL("http://localhost/Hello");
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }

        RestClientInterface itf = RestClientBuilder.newBuilder()
                                                   .baseUrl(apUrl)
                                                   .build(RestClientInterface.class);
        Customer custom = itf.getCustomerList(id);

        return custom;
    }
}
    

package sample.restclient;

import java.net.URL;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.eclipse.microprofile.rest.client.RestClientBuilder;

import sample.resource.Customer;

@Path(value = "client")
public class RestClientResource {
    @Produces(value = { "application/xml" })
    @GET
    @Path(value = "{id}")
    public Customer getCustomerList(@PathParam(value = "id") String id) {
        URL apUrl = null;
        try {
            apUrl = new URL("http://localhost/Hello");
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }

        RestClientInterface itf = RestClientBuilder.newBuilder()
                                                   .baseUrl(apUrl)
                                                   .build(RestClientInterface.class);
        Customer custom = itf.getCustomerList(id);

        return custom;
    }
}
    

web.xml にリソースクラスを指定

アプリケーションのデプロイ

アプリケーションの実行

14.7.5. JSONで通信するMicroProfile Rest Client アプリケーションの作成

package sample.restclient;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import sample.resource.Customer;

@Path(value = "/name_list")
@RegisterRestClient
public interface RestClientInterface {
    @Produces(value = { "application/json" })
    @GET
    @Path(value = "{id}")
    public Customer getCustomerList(@PathParam(value = "id") String id);
}
    

package sample.restclient;

import javax.enterprise.context.RequestScoped;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.eclipse.microprofile.rest.client.inject.RestClient;

import sample.resource.Customer;

@Path("/client")
@RequestScoped
public class RestClientResource {
    
    @Inject
    @RestClient
    RestClientInterface itf;

    @Produces(value = { "application/json" })
    @GET
    @Path(value = "{id}")
    public Customer getCustomerList(@PathParam(value = "id") String id) {
        Customer custom = itf.getCustomerList(id);
        return custom;
    }
}