Jersey で Restful API をつくる

Jersey で Restful な API を作成する。

前提知識として、JAX-RS をさらっと認識しておくと良い。
何故 REST なのか、REST の何がうれしいかを見ておく。

JAX-RS 1 について ： http://www.coppermine.jp/docs/programming/2012/12/jaxrs1.html

JAX-RS 2 について ： http://www.coppermine.jp/docs/programming/2012/12/jaxrs2.html


JAX-RS 2 を見るにあたっては、CDI も見ておくと良い。

CDI ：: https://blogs.oracle.com/nishigaya/entry/javaee6_understanding_cdi_part_1


1 と 2 どちらを用いるかは、作成するアプリケーションの API の複雑性・多様性によって決めると良い。

テキストのみを扱うシンプルな API に JAX-RS 2 の仕様を実装するのもどうかと思う。

Jersey1

ここでは、JAX-RS 1 の実装である、Jersey 1系 を使って、Servlet 環境を作成する。

Jersey 1系の最新 1.18 を以下からダウンロードできる。

https://jersey.java.net/download.html


ダウンロードしたファイルを解凍して、以下を Tomcat プロジェクトのライブラリとして登録する。

• asm-3.1.jar
• jersey-client-1.18.jar
• jersey-core-1.18.jar
• jersey-json-1.18.jar
• jersey-server-1.18.jar
• jersey-servlet-1.19.jar
• jsr311-api-1.1.1.jar

次に、web.xml を準備する。WEB-INF/web.xml を以下の様に作成する。

servlet タグには、servlet-name と対応する servlet-class を記載する。

これは、jerseyのクラスを設定する。init-paramには、jerseyを使うパッケージを設定する。

ここでは「jp.masazdream.scryi.server.api」である。
load-on-startup で、アプリケーションがコンテナにロードされるときに、初期化するよう設定する。

servlet-mapping では、servlet-name が一致した servlet にアクセスする url-patternを設定する。

ここでは、<アプリケーションコンテキスト名>/api/～ でアクセスする。

～ は、Jerseyによってアノテーションで記述する。

次に、jp.masazdream.scryi.server.api パッケージにクラスを記述する。



アノテーション「@Path」に続けて書いたのが、～部分である。
また、Doma を使った DAO 部分の記述をテストとして記述しているが、適当な文字列を返すほうがはじめの一歩の検証に良いだろう。


アプリケーションコンテキスト名は、Eclipse で作成したプロジェクトの場合、通常プロジェクト名がデフォルトで設定されるが、以下の手順で変更が可能である。

[プロジェクトプロパティ]-[Tomcat]-[全般タブ]-コンテキスト名

である。例えば、「test」と設定したとする。


Tomcatプロジェクト全般の設定については、以下が参考になる。

http://seesaawiki.jp/salyu/d/Eclipse%A4%CB%A4%AA%A4%B1%A4%EBTomcat%A4%CE%C0%DF%C4%EA

以上で、以下のURLからAPIをたたくことが可能である。

http://localhost:8080/test/api/communication

Doma gen で dao と entity を自動生成する

Doma に付属するツール Doma Gen で、dao と entity を自動生成する方法。

以下のチュートリアルが参考になります。

http://doma.seasar.org/extension/doma_gen.html

doma-genをダウンロードしたら、必要なファイルをプロジェクトにコピーします。

• doma-gen-build.xml ： プロジェクトトップに配置
• doma-gen-1.xx.x.jar ： WEB-INF/lib に設置(アプリケーションとしては不要なので、別の場所の方が良いのかも)
• freemaker-2.x.xx.jar ： 同上

後は、接続するDBに対応したドライバーを準備します。ここでは、MySQLを使いました。

• mysql-connector-java-x.x.xx-bin.jar ： WEB-INF/lib に設置

ant でビルドしますので、適当に ant をインストールしておきましょう。バージョンの制限は見た限りありませんでした。

ビルドしたいプロジェクトに合わせて、doma-gen-build.xml を編集します。

今回は tomcat プロジェクトに設置しました。

ant はコマンドラインから実行します。

ant -f doma-gen-build.xml

これで、WEB-INF/src 配下に DAO、Entityクラスが自動生成出来ます。

Doma を使って Java の DAO を楽にする。

○javaアプリケーション の DAO に何を使うか？ Doma が良さそう。

How to use doma ? ということで、

JavaのDaoフレームワークである、Doma（ここでは Doma1 を）を導入します。
Domaは2waysql方式で、発行したSQLがわかりやすく、ローカルトランザクションをサポートしています。

大きな連続した命令を行う必要がないアプリケーションであれば、十分な機能を有しています。

また、他のライブラリへの依存が無いこともよいです。

Doma -----------

データ型：http://doma.seasar.org/reference/basic.html
エンティティ定義：http://doma.seasar.org/reference/entity.html
トランザクション：http://doma.seasar.org/reference/transaction.html
アノテーション：http://doma.seasar.org/reference/apt.html
Daoインターフェース：http://doma.seasar.org/reference/dao.html

■DB生成

MySQLにテーブルを構築します。
今回は、テスト用に1つテーブルを作成しました。

ex)
○テーブル

use beta_doma_table;
CREATE TABLE `beta_doma_table`.`beta_doma` (
  `beta_doma_id` INT NOT NULL AUTO_INCREMENT,
  `beta_doma_message` VARCHAR(255) NULL,
  `beta_doma_number` INT NULL,
  `beta_doma_created_at` TIMESTAMP NULL,
  `beta_doma_updated_at` TIMESTAMP NULL,
  `beta_doma_deleted_flag` TINYINT NULL DEFAULT 0,
  `beta_doma_deleted_at` TIME NULL DEFAULT NULL,
  PRIMARY KEY (`beta_doma_id`),
  UNIQUE INDEX `beta_doma_id_UNIQUE` (`beta_doma_id` ASC))
ENGINE = InnoDB
COMMENT = 'test for doma table';

○テスト用データ

use beta_doma_table;
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test1こんにちは', 101, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test2ありがとう', 102, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test3すばらしい！', 103, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test4確かに', 104, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test5緩やかに', 105, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test6そうですね', 106, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test7反対です', 107, now(), now());
insert into beta_doma (beta_doma_message, beta_doma_number, beta_doma_created_at, beta_doma_updated_at) values('test8。。。888888', 108, now(), now());

■データソースの生成
以下の用にDBへのアクセス情報を保持しておきます。
MySQLの方言も吸収します。

■Entityの生成
テーブルに対応したEntityを生成します。
自動生成するツール Doma Gen もあるようなので、後日試します。


■Entityに対するDaoを生成
Entityに対する操作をDaoに定義します。
引数をカラム名と等しくする必要があります。


■コンパイル時のアノテーションプロセス
プロジェクトプロパティの[JavaCompiler]-[Annotation Processing]-[Enable project specific settings]をonにします。

Generated source directoryには「.apt_generated」とします。

[Factory Path]には、domaのライブラリ(doma-1.XX.X.jar)を指定します。

■プロジェクトビルド
antでdomaをビルドします。
destにはビルド先を指定します。Daoインターフェースの実装クラス(Impl)がDomaによって生成されます。
targetには、jarが出来ます。



■生成jarをビルドパスに追加
targetに生成したjarをビルドパスに追加します。
JavaのアプリケーションからdomaのDAO機能を使うことが出来ます。


■テスト用コード
以下の用にEntityを取得し、更新が可能です。

以上で、Domaの基本的な操作は完了です。
大きなデータベースの場合、Entityを手動で書くことが難しくなります。
そのため、Doma gen が力を発揮するのでしょう。