最初のCoherence RESTアプリケーションの作成

29 最初のCoherence RESTアプリケーションの作成

Coherenceキャッシュにアクセスして使用するシンプルなCoherence RESTアプリケーションをビルドして実行します。

ディストリビューションに付属のCoherenceの例には、RESTアプリケーションのエンドツーエンドの例も含まれます。『Oracle Coherenceのインストール』のCoherence RESTの例に関する項を参照してください。

この章の内容は次のとおりです。

基本的なCoherence RESTの例の概要
Coherence RESTの例では、一連のステップを使用して基本的なCoherence RESTアプリケーションを構成および実行します。
前提条件
この例を構築するには、次のものをインストールする必要があります。
ステップ1: クラスタ側の構成
Coherence RESTには、キャッシュおよびプロキシのスキームの両方が必要です。プロキシ・スキームでは、受信するHTTPリクエストを処理するHTTPアクセプタを定義する必要があります。
ステップ2: ユーザー・タイプの作成
Personユーザー・タイプを作成します。これはキャッシュに保存され、基本的なREST操作を説明するために使用します。
ステップ3: RESTサービスの構成
Coherence RESTサービスには、公開されるキャッシュに関するメタデータが必要です。
ステップ4: キャッシュ・サーバー・プロセスの開始
RESTサービスは、キャッシュ・サービス・プロセス(DefaultCacheServer)の一環として公開されます。
ステップ5: クライアントからRESTサービスへのアクセス
クライアント・アプリケーションでは、キャッシュの操作を行うためにCoherence RESTサービスを使用します。HTTPベース・クライアントを構築するためのクライアント・ライブラリを提供するアプリケーション・プラットフォームは数多くあります。

基本的なCoherence RESTの例の概要

Coherence RESTの例では、一連のステップを使用して基本的なCoherence RESTアプリケーションを構成および実行します。各ステップでは、HTTPリクエストの処理、リモート・キャッシュの構成、Coherence REST APIの使用を管理するプロキシ・サーバーの構成など、基本的な概念について説明します。

この章の例では、アプリケーション・サーバーが不要なスタンドアロンのアプリケーションをデプロイするために、埋込みHTTPサーバーを使用します。追加のデプロイメント・オプションが使用できます。「Coherence RESTのデプロイ」を参照してください。

この章のステップを完了するには、Coherence for Javaをインストールする必要があります。またこの例では、次のユーザー定義の変数を使用します。

DEV_ROOT - リストされているすべてのステップを実行する場所となるルート・フォルダのパス。つまり、その後のすべてのフォルダはDEV_ROOTに対する相対フォルダになります
COHERENCE_HOME - この変数は、Coherenceインストールのcoherenceディレクトリへのフルパスである必要があります。

親トピック: 最初のCoherence RESTアプリケーションの作成

前提条件

この例を構築するには、次のものをインストールする必要があります。

必要なソフトウェア

JDK 17または21
Maven 3.8.5+
Coherence 14.1.2.0.0 (インストール手順は、Oracle WebLogic ServerおよびCoherenceソフトウェアのインストールに関する項を参照してください)。

依存関係

次のCoherence依存関係をローカルのMavenリポジトリにインストールします。使用しているオペレーティング・システムに応じて、次のコマンドを使用します。

Windows

mvn install:install-file -Dfile=%COHERENCE_HOME%\lib\coherence.jar -DpomFile=%COHERENCE_HOME%\plugins\maven\com\oracle\coherence\coherence\14.1.2\coherence.14.1.2.pom
mvn install:install-file -Dfile=%COHERENCE_HOME%\lib\coherence-rest.jar -DpomFile=%COHERENCE_HOME%\plugins\maven\com\oracle\coherence\coherence-rest\14.1.2\coherence-rest.14.1.2.pom
mvn install:install-file -Dfile=%COHERENCE_HOME%\lib\coherence-http-netty.jar -DpomFile=%COHERENCE_HOME%\plugins\maven\com\oracle\coherence\coherence-http-netty\14.1.2\coherence-http-netty.14.1.2.pom

Mac/Linux

mvn install:install-file -Dfile=$COHERENCE_HOME/lib/coherence.jar -DpomFile=$COHERENCE_HOME/plugins/maven/com/oracle/coherence/coherence/14.1.2/coherence.14.1.2.pom
mvn install:install-file -Dfile=$COHERENCE_HOME/lib/coherence-rest.jar -DpomFile=$COHERENCE_HOME/plugins/maven/com/oracle/coherence/coherence-rest/14.1.2/coherence-rest.14.1.2.pom
mvn install:install-file -Dfile=$COHERENCE_HOME/lib/coherence-http-netty.jar -DpomFile=$COHERENCE_HOME/plugins/maven/com/oracle/coherence/coherence-http-netty/14.1.2/coherence-http-netty.14.1.2.pom

クラスパスの生成

前の依存関係に基づいてクラスパスを生成します。次の内容でDEV_ROOTにpom.xmlというファイルを作成します:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <artifactId>com.oracle.coherence.rest.example</artifactId>
  <groupId>rest</groupId>
  <version>1.0.0</version>
  <name>Coherence REST dependencies</name>
  <packaging>pom</packaging>

  <properties>
      <coherence.groupId>com.oracle.coherence</coherence.groupId>
      <coherence.version>14.1.2-0-0</coherence.version>
  </properties>

  <dependencies>
      <dependency>
           <groupId>${coherence.groupId}</groupId>
           <artifactId>coherence-rest</artifactId>
           <version>${coherence.version}</version>
      </dependency>
      <dependency>
           <groupId>${coherence.groupId}</groupId>
           <artifactId>coherence</artifactId>
           <version>${coherence.version}</version>
      </dependency>
      <dependency>
           <groupId>${coherence.groupId}</groupId>
           <artifactId>coherence-http-netty</artifactId>
           <version>${coherence.version}</version>
      </dependency>
      <dependency>
          <groupId>org.glassfish.jersey.inject</groupId>
          <artifactId>jersey-hk2</artifactId>
          <version>2.41</version>
      </dependency>
      <dependency>
        <groupId>javax.xml.bind</groupId>
        <artifactId>jaxb-api</artifactId>
        <version>2.3.1</version>
      </dependency>
      <dependency>
        <groupId>org.glassfish.jaxb</groupId>
        <artifactId>jaxb-runtime</artifactId>
        <version>2.3.1</version>
      </dependency>	  
  </dependencies>
</project>

次のコマンドを実行して、cp.txtというファイルへのクラスパスを生成します:

mvn -q dependency:build-classpath -Dmdep.outputFile=cp.txt

親トピック: 最初のCoherence RESTアプリケーションの作成

ステップ1: クラスタ側の構成

Coherence RESTには、キャッシュおよびプロキシ・スキームの両方が必要です。プロキシ・スキームでは、受信するHTTPリクエストを処理するHTTPアクセプタを定義する必要があります。

クラスタ側のキャッシュ構成デプロイメント・ディスクリプタで、キャッシュおよびプロキシを構成します。この例では、プロキシはlocalhostおよびポート8080上でクライアントHTTPリクエストを受け入れるように構成されます。dist-http-exampleという名前の分散キャッシュを定義し、これを使用してクライアント・データをクラスタに格納します。

クラスタ側を構成するには:

example-server-config.xmlという名前のXMLファイルをDEV_ROOT\configフォルダに作成します。

このファイルに次のXMLをコピーします。

<?xml version="1.0"?>
<cache-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-cache-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-cache-config coherence-cache-config.xsd">
   <caching-scheme-mapping>
      <cache-mapping>
         <cache-name>dist-http-example</cache-name>
         <scheme-name>dist-http</scheme-name>
      </cache-mapping>
   </caching-scheme-mapping>

   <caching-schemes>
      <distributed-scheme>
         <scheme-name>dist-http</scheme-name>
         <backing-map-scheme>
            <local-scheme/>
         </backing-map-scheme>
         <autostart>true</autostart>
      </distributed-scheme>

      <proxy-scheme>
         <service-name>ExtendHttpProxyService</service-name>
         <acceptor-config>
            <http-acceptor>
               <class-name>com.tangosol.coherence.http.netty.NettyHttpServer</class-name>
               <local-address>
                  <address>127.0.0.1</address>
                  <port>8080</port>
               </local-address>
            </http-acceptor>
         </acceptor-config>
         <autostart>true</autostart>
      </proxy-scheme>
   </caching-schemes>
</cache-config>

ファイルを保存して閉じます。

親トピック: 最初のCoherence RESTアプリケーションの作成

ステップ2: ユーザー・タイプの作成

Personユーザー・タイプを作成します。これはキャッシュに保存され、基本的なREST操作を説明するために使用します。

Personオブジェクトを作成するには:

DEV_ROOT\exampleフォルダにテキスト・ファイルを作成します。

このファイルに次のJavaコードをコピーします。

package example;
import java.io.Serializable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name="person")
@XmlAccessorType(XmlAccessType.PROPERTY)
public class Person implements Serializable {

    public Person() {}

    public Person(String name, int age)
        {
        m_name = name;
        m_age  = age;
        }

    public String getName() { return m_name; }

    public void setName(String name) { m_name = name; }

    public int getAge() { return m_age; }

    public void setAge(int age) {  m_age = age; }

    protected String m_name;
    protected int    m_age;
}

Person.javaという名前でファイルを保存して閉じます。

Person.javaをコンパイルします。

Windows

for /f %i in (cp.txt) do set CP=%i
SET CLASSPATH=%CP%;%DEV_ROOT%\config;%DEV_ROOT%
java -Dcoherence.wka=127.0.0.1 -Dcoherence.cacheconfig=%DEV_ROOT%\config\example-server-config.xml com.tangosol.net.Coherence

Mac/Linux

javac -cp `cat cp.txt` example/Person.java

親トピック: 最初のCoherence RESTアプリケーションの作成

ステップ3: RESTサービスの構成

Coherence RESTサービスには、公開されるキャッシュに関するメタデータが必要です。メタデータには、キャッシュ・エントリのキーと値のタイプ、およびキー・コンバータおよび値マーシャリング処理が含まれます。キーおよび値のタイプは、Coherenceが組込みのコンバータおよびマーシャリング処理を使用できるようにするために必要です(XMLとJSONがサポートされます)。

RESTサービスを構成するには:

coherence-rest-config.xmlという名前のXMLファイルをDEV_ROOT\configフォルダに作成します。

このファイルに次のXMLをコピーします。

<?xml version="1.0"?>
<rest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-rest-config" 
xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-rest-config
   coherence-rest-config.xsd">
   <resources>
      <resource>
         <cache-name>dist-http-example</cache-name>
         <key-class>java.lang.String</key-class>
         <value-class>example.Person</value-class>
         <direct-query enabled="true"/>
      </resource>
   </resources>
</rest>

ノート:

<key-class>および<value-class>要素は、キャッシュ構成ファイルの<cache-mapping>要素内または<resource>要素内のいずれかに定義できます。

保存してファイルを閉じます。

親トピック: 最初のCoherence RESTアプリケーションの作成

ステップ4: キャッシュ・サーバー・プロセスの開始

RESTサービスは、キャッシュ・サービス・プロセス(DefaultCacheServer)の一環として公開されます。キャッシュ・サーバーのクラスパスは、前のステップで作成したすべての構成ファイルおよびPerson.classを検索できるように構成する必要があります。クラスパスには、必要な依存関係ライブラリも含まれている必要があります。「Coherence RESTの依存性」を参照してください。わかりやすくするために、依存性はすべてDEV_ROOT\libsフォルダに配置され、個別にはリストされません。

DEV_ROOTフォルダは、次のような構成になります。

\
\config
\config\example-server-config.xml
\config\coherence-rest-config.xml
\example
\example\Person.class
\libs
\libs\*

次のコマンド行では、キャッシュ・サーバー・プロセスが開始され、coherence.cacheconfigシステム・プロパティを使用して、ステップ1で作成したキャッシュ構成ファイルに明示的に名前が付けられます。また、「前提条件」で作成されたクラスパスが使用されます。

Windows

set DEV_ROOT=%cd%

java -Dcoherence.wka=127.0.0.1 -cp %DEV_ROOT%\config;%DEV_ROOT%;"$(type cp.txt)" -Dcoherence.cacheconfig=%DEV_ROOT%\config\example-server-config.xml com.tangosol.net.Coherence

Mac/Linux

export DEV_ROOT=`pwd`

java -Dcoherence.wka=127.0.0.1 -cp ${DEV_ROOT}/config:${DEV_ROOT}:`cat cp.txt` -Dcoherence.cacheconfig=${DEV_ROOT}/config/example-server-config.xml com.tangosol.net.Coherence

コンソール出力をチェックして、プロキシ・サービスが開始されていることを確認します。出力メッセージは次のようになります。

ProxyService{Name=ExtendHttpProxyService, State=(SERVICE_STARTED), Id=…, OldestMemberId=1, Serializer=java}

親トピック: 最初のCoherence RESTアプリケーションの作成

ステップ5: クライアントからRESTサービスへのアクセス

クライアント・アプリケーションでは、キャッシュの操作を行うためにCoherence RESTサービスを使用します。HTTPベース・クライアントを構築するためのクライアント・ライブラリを提供するアプリケーション・プラットフォームは数多くあります。たとえば、Jersey Projectでは、HTTPベースのREST Webサービスによるクライアント側通信にJavaがサポートされます。

クライアントでdist-http-exampleキャッシュにアクセスするために使用するPUT、GETおよびPost操作のセマンティクスを次に示します。Jerseyを使用して構築されたJavaクライアントの例は、Jersey-client-2.12.jarライブラリに従っており、このライブラリが必要です。「RESTによるグリッド操作の実行」を参照してください。

curlコマンドを使用した操作の例を次に示します。

Put操作

PUT http://localhost:8080/api/dist-http-example/1
Content-Type=application/json
Request Body: {"name":"chris","age":30}

PUT http://localhost:8080/api/dist-http-example/2
Content-Type=application/json
Request Body: {"name":"adam","age":26}

GET操作

GET http://localhost:8080/api/dist-http-example/1.json

GET http://localhost:8080/api/dist-http-example/1.xml

GET http://localhost:8080/api/dist-http-example/entries?q=name is 'chris'

GET http://localhost:8080/api/dist-http-example/1.json;p=name

GET http://localhost:8080/api/dist-http-example/count()

GET http://localhost:8080/api/dist-http-example/double-average(age)

Post操作

POST http://localhost:8080/api/dist-http-example/increment(age,1)

サンプルcurlコマンド

前述のRESTリクエストを実行するためのcurlコマンドを次に示します。

PUT操作

curl -v -H 'Content-Type: application/json' -X PUT http://localhost:8080/api/dist-http-example/1 -d '{"name":"chris","age":30}'

curl -v -H 'Content-Type: application/json' -X PUT http://localhost:8080/api/dist-http-example/2 -d '{"name":"adam","age":26}'

GET操作

curl -X GET http://localhost:8080/api/dist-http-example/1.json

curl -X GET http://localhost:8080/api/dist-http-example/1.xml

curl -X GET http://localhost:8080/api/dist-http-example/entries?q=name%20is%20%27adam%27

curl -X GET "http://localhost:8080/api/dist-http-example/1.json;p=name"

curl -X GET "http://localhost:8080/api/dist-http-example/count()"

curl -X GET "http://localhost:8080/api/dist-http-example/double-average(age)"

POST操作

curl -X POST "http://localhost:8080/api/dist-http-example/increment(age,1)"

サンプルJersey RESTクライアント

RestExampe.javaというサンプル・ディレクトリにファイルを作成し、次の内容を追加します。前にPerson.javaで使用した方法と同じ方法でコンパイルし、次を使用して実行します:

Windows

SET CLASSPATH=%CP%;%DEV_ROOT%\config;%DEV_ROOT%
java example.RestExample

Mac/Linux

java -cp `cat cp.txt`:. example.RestExample

package example;

import java.io.IOException;

import java.net.MalformedURLException;

import java.net.URISyntaxException;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

public class RestExample {
    public static void PUT(String url, MediaType mediaType, String data) {
        process(url, "put", mediaType, data);
    }

    public static void GET(String url, MediaType mediaType) {
        process(url, "get", mediaType, null);
    }

    public static void POST(String url, MediaType mediaType, String data) {
        process(url, "post", mediaType, data);
    }

    public static void DELETE(String url, MediaType mediaType) {
        process(url, "delete", mediaType, null);
    }

    public static void process(String sUrl, String action,
            MediaType mediaType,
            String data) {
        Client client = ClientBuilder.newClient();
        Response response = null;

        WebTarget webTarget = client.target(sUrl);
        String responseType = MediaType.APPLICATION_XML;
        if (mediaType == MediaType.APPLICATION_JSON_TYPE) {
            responseType = MediaType.APPLICATION_JSON;
        }

        if (action.equalsIgnoreCase("get")) {
            response = webTarget.request(responseType).get();
        } else if (action.equalsIgnoreCase("post")) {
            Entity<String> person = Entity.entity(data, responseType);
            response = webTarget.request(responseType).post(person);
        } else if (action.equalsIgnoreCase("put")) {
            Entity<String> person = Entity.entity(data, responseType);
            response = webTarget.request(responseType).put(person);
        } else if (action.equalsIgnoreCase("delete")) {
            Entity<String> person = Entity.entity(data, responseType);
            response = webTarget.request(responseType).delete();
        }
        System.out.println(response.readEntity(String.class));
    }

    public static void main(String[] args) throws URISyntaxException,
            MalformedURLException, IOException {
        PUT("http://localhost:8080/api/dist-http-example/1",
                MediaType.APPLICATION_JSON_TYPE,
                "{\"name\":\"chris\",\"age\":32}");
        PUT("http://localhost:8080/api/dist-http-example/2",
                MediaType.APPLICATION_JSON_TYPE,
                "{\"name\":\"\ufeff\u30b8\u30e7\u30f3A\",\"age\":66}");
        PUT("http://localhost:8080/api/dist-http-example/3",
                MediaType.APPLICATION_JSON_TYPE,
                "{\"name\":\"adm\",\"age\":88}");
        POST("http://localhost:8080/api/dist-http-example/increment(age,1)",
                MediaType.APPLICATION_XML_TYPE, null);
        GET("http://localhost:8080/api/dist-http-example/1",
                MediaType.APPLICATION_JSON_TYPE);
        GET("http://localhost:8080/api/dist-http-example/1",
                MediaType.APPLICATION_XML_TYPE);
        GET("http://localhost:8080/api/dist-http-example/count()",
                MediaType.APPLICATION_XML_TYPE);
    }
}

親トピック: 最初のCoherence RESTアプリケーションの作成