10.1 res tful services

Camel In Action 2nd edition 読書会
10.1 RESTful services
2019年11⽉19⽇

l RESTfulサービスはRESTサービスとも呼ばれる
l 昨今のエンタープライズプロジェクトで使⽤される⼀般的なアーキテク
チャスタイルになっている
l REST（ Representational State Transfer）という⾔葉は、Roy
Fielding博⼠が2000年に発表した論⽂にあった
l https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
l RESTサービスは最新のWebサービスとも考えられる。APIはRESTfulで
HTTPベースであるため、Web上で簡単に利⽤できる。
（SOAP Webサービスは７章を参照）
RESTful servicesとは
20192

l アドレス指定可能なURIで公開されていること
l インターフェース(HTTPメソッドの利⽤)の統⼀がされていること
l ステートレスであること
l 処理結果がHTTPステータスコードで通知されること
l サーバが処理結果のキャッシュできること（オプション）
RESTサービスの設計原則
20193
ファーストステップ、設計結果の例:
(The RESTful API for the Rider Auto Parts order web service )

l RESTサービスの実装は、多くな⽅法があるが、本書では以下の５つ
の⽅式を使って説明している
RESTサービスの実装⽅式
20194
# 実装⽅式概要
1 Apache CXF
<10.1.2 Using JAX-RS with REST services>
Camelコンポーネントを使わず、CXFのみ
で実装する⽅法
2 Apache CXF with Camel
<10.1.3 Using Camel in an existing JAX-RS
application>
CXFでREST送受信を⾏い、処理ロジックの
部分はCamelルートに任せる⽅法
3 Camel Restlet component
<10.1.4 Using camel-restlet with REST
services>
最も簡易なCamelコンポーネントcamel-
restletを使って実装する⽅法
4 Camel CXF REST component
<10.1.5 Using camel-cxf with REST services>
Camelコンポーネントcamel-cxfを使った
実装する⽅法
5 Camel REST DSL
**こっちが推奨**
<10.2 The Camel Rest DSL>
Camel DSLを使って、REST専⽤⾔語
(REST DSL)で定義及び実装する⽅法

JVM
l 仕組み
REST実装⽅式1. Apache CXFのみの実装⽅法
20195
CXF
REST
Client
REST
Order
Service
getOrder()
<Method>http
createOrder()
<Method>
updateOrder()
<Method>
cancelOrder()
<Method>

l プロジェクトの構成
20196
1. 依存ライブラリの定義
2. データモデルの定義
3. RESTサービスのJava Interfaceの定義
4. RESTサービスのの定義
6. RESTサービス起動するmainクラス
(番号は開発順）
5. サービス中⾝(処理ロジック)の実装

1. 依存ライブラリ(pom.xml)
20197
• Cxf
• org.apache.cxf:cxf-core
• org.apache.cxf:cxf-rt-frontend-jaxrs
• Cxf http/jetty server
• org.apache.cxf:cxf-rt-transports-http
• org.apache.cxf:cxf-rt-transports-http-jetty
• Logging
• org.slf4j:slf4j-log4j12
• log4j:log4j

2. データモデルの定義(Order.java)
20198
このサンプルはXMLを扱うため、JAXB
のアノテーションで定義している

3. RESTサービスのJava Interfaceの定義(OrderService.java)
20199
標準なJava InterfaceでRESTサービス
のOperationを羅列する

4. RESTサービスの定義(RestOrderService.java)
201910
RESTサービスのベースパス
応答のコンテンツタイプ - XML
サービス中⾝（処理ロジック）実装の注⼊

201911
個々のOperationの定義
HTTPメソッド – GET/PUT/POST/DELETE パスパラメータ –実⾏時idが⾃動
的にorderIdにマップされる
パスパラメータ –実⾏時idが⾃動
的にorderIdにマップされる
サービス実装を呼び出し
Orderを⾒つかった場合、okステータ
ス(200)、及びOrderを返す
Orderを⾒つからなかった場合、not
foundステータス(404) を返す

5. サービス中⾝(処理ロジック)の実装 (DummyOrderService.java)
201912
RESTサービスのJava Interfaceを実装
CXF, JAX-RSなど依存しないのPOJOで
実装可能

6. RESTサービス起動するmainクラス(RestOrderServer.java)
201913
サービス中⾝（処理ロジック）の初期化
RESTサービス定義の初期化
CXF関連の初期化
CXFサーバの起動

XMLの代わりに、JSONでリクエスト・レスポンスの場合は、以下の2点を修正だけ
201914
1. 依存ライブラリ(pom.xml)の追加
• to support json
• org.apache.cxf:cxf-rt-rs-extension-providers
• to use Jackson
• com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider
2. RESTサービス起動するmainクラス(RestOrderServer.java)の修正
CXFはクラスパスのJSONプロバイダ
を⾃動発⾒してくれないので、 CXF関
連の初期化時、明⽰的にJacksonを
JSONプロバイダとして使うように
セットアップする

l メリット
l JAX-RS標準的な⽅法
l Apache CXF-RSは定評のあるRESTライブラリ
l 開発者はソースコードを変更して完全に制御できる
l デメリット
l Javaコードを書かずにRESTサービスを定義できない
l Camelに統合されていない
l CXF-RSの設定が簡単ではない（特にHTTPサーバ周り、SSLなど）
l “CXF in Action”という本が出版されてない
201915

JVM
l 仕組み
REST実装⽅式2. Apache CXF with Camelの実装⽅法
<10.1.3 Using Camel in an existing JAX-RS application>
201916
CXF Camelルート
REST
Client
REST
Order
Service
getOrder
<Camel Route>direct:xxxhttp
createOrder
<Camel Route>
updateOrder
<Camel Route>
cancelOrder
<Camel Route>
…
producer.requestBody(“direct:xxx”, …);
…

201917
（Camelの依存ライブラリを追加）
2. データモデルの定義(⽅法1同様)
3. RESTサービスのJava Interfaceの定義(⽅法1同様)
（Camelルートへ送信するように変更）
6. RESTサービス起動するmainクラス
（Camel関連の初期化を追加）
5. サービス中⾝(Camelルート)の実装
（Camelルートで処理ロジックを実装）

201918
• Cxf
• Logging
• log4j:log4j
• Camel
• org.apache.camel:camel-core

201919
Camelルートへ送信するため、
ProducerTemplateを注⼊のため、メ
ソッドを⽤意する
注⼊されたProducerTemplateを使って、
Camel directコンポーネントで送信する
Camelの処理結果のBodyをorderに格納する

5. サービス中⾝(Camelルート)の実装 (OrderRoute.java)
201920
Java DSLの実装のため、RouteBuilderを
継承する
Camelルートの実装。
便利上、⽅式１で実装した
DummyOrderServiceをBeanとして
再利⽤しているが、本当はどんな
Camelルートでも可能。

6. RESTサービス起動するmainクラス(RestOrderServer.java)
201921
CamelのProducerTemplateをRESTサービスに
注⼊する
CXF及びRESTサービスの初期化の前に、
CamelコンテキストとProducerTemplateを
初期化する

l メリット
l JAX-RS標準的な⽅法
l Camelが統合されている
l デメリット
l Javaコードを書かずにRESTサービスを定義できない
l Camelに統合されていない
l 起動時にCamelとCXF双⽅のセットアップが必要
201922
業務ロジック上で他システムと連携がある
場合、このメリットが⼤きい。Camelコン
ポーネントが使えるから。

JVM
l 仕組み
REST実装⽅式3. Camel Restlet component
<10.1.4 Using camel-restlet with REST services>
201923
Camelルート
REST
Client
Camel-
restlet
http
getOrder
<Camel Route>
createOrder
<Camel Route>
updateOrder
<Camel Route>
cancelOrder
<Camel Route>
get
例:
<from
uri=“restlet:http://0.0.0.0:8080/orders/{id}/restletMethod=get”/>

201924
3. RESTサービスのJava Interfaceの定義(⽅法1同様)

201925
• Camel
• org.apache.camel:camel-restlet
• org.apache.camel:camel-jaxb (XML扱う場合)
• org.apache.camel:camel-Jackson (JSON扱う場合)

4. サービス中⾝(Camelルート)の実装（Camelルートで処理ロジックを実装）
201926
継承する

l メリット
l 少ないコードで実装可能
l Javaコードを書かずにRESTサービスも実装可能（XML DSL）
l Restletは2008年からCamel部品として提供され、枯れてる
l デメリット
l JAX-RS準拠の⽅法ではない
l XML扱う場合が簡単だが、JSON扱う場合は追加の設定が必要
201927
Camel Context起動前に、以下のように、camel-jacksonコンポーネントを”fallback
type converter”として有効化する必要がある。
context.getProperties().put("CamelJacksonEnableTypeConverter", "true");
context.getProperties().put("CamelJacksonTypeConverterToPojo", "true");
⽅法1のように、RESTサービス定義
(RestOrderService.java)がないこと

JVM
l 仕組み
REST実装⽅式4. Camel CXF REST component
201928
Camelルート
REST
Client 振分⽤ルート
<Camel Route>
getOrder
<Camel Route>
createOrder
<Camel Route>
updateOrder
<Camel Route>
cancelOrder
<Camel Route>
Direct:xxx
例:
<from uri=“cxfrs:…”/>
<toD uri=“direct:${header.operationName}”>

201929
3. RESTサービスのJava Interfaceの定義(⽅法1と同様)

201930
• Cxf
• Logging
• log4j:log4j
• Camel
• org.apache.camel:camel-cxf

201931
JAX-RS準拠のRESTサービスの定義
• ベースパス情報
• 要求メッセージのコンテンツタイプ
• 応答メッセージのコンテンツタイプ
JAX-RS準拠のRESTサービスの定義
• Operation別の定義
• パラメータ情報

5. サービス中⾝(Camelルート)の実装（Camelルートで処理ロジックを実装）
201932
継承する
実際のRESTサービス処理を⾏う
Camel-cxfrsでリクエストを受付し
て、個々のCamel Routeへ振り分け
するルートの実装。

l メリット
l JAX-RS準拠の⽅法である
l デメリット
l Javaコーディングが必須
201933
JAX-RS準拠のRESTサービス定義が
Javaコーディング必要

JVM
l 仕組み
REST実装⽅式5. Camel REST DSL
201934
Camelルート
REST
Client REST DSL
getOrder
<Camel Route>
createOrder
<Camel Route>
updateOrder
<Camel Route>
cancelOrder
<Camel Route>
Direct:xxx
例:
<rest path="/orders">
<get uri="{id}" outType="camelinaction.Order">
<to uri=”direct:xxx"/>
</get>
</rest>

l メリット
l Javaコードを書かずにRESTサービスも実装可能（XML DSL）
l OpenAPI準拠、Swaggerと連携可能
l Http ServerとServletを選択可能
（例: Undertow, Spark-rest, JavaEE server）
l デメリット
l REST DSLの記述⽅法の習得
REST実装⽅式5. Camel REST DSL
201935

10.1 res tful services

Recommended

Recommended

More Related Content

Similar to 10.1 res tful services

Similar to 10.1 res tful services (20)

More from Jian Feng

More from Jian Feng (8)

Recently uploaded

Recently uploaded (9)

10.1 res tful services