JAX-RSを始める
これは Java EE Advent Calendar 2014 の1日目です。
今回は参照実装であるJerseyを使ってJAX-RSを始めるための環境構築などをだらだら書こうと思います。
ビルドツール
昨今はGradleが人気のような雰囲気漂っていますが、Mavenを使いましょう。
JerseyはMavenのprofileという機能を使っていてGradleではその辺のサポートがないっぽいのでたぶんしんどいです。
......と書きましたが最近のGradleはprofile対応してるようです。
というわけでサンプルにGradleのビルドファイルも追加しました。
Mavenのインストールはバイナリを任意の場所にダウンロードしてbinディレクトリにパスを通せばおkです。
ビルドファイルの準備
Mavenの場合
まず、mvn archetype:generateしてください。
それから出来たpom.xmlを編集します。
次のdependencyManagement要素を追加してください。
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.glassfish.jersey</groupId>
<artifactId>jersey-bom</artifactId>
<version>2.13</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
それからjersey-bomのpom.xmlを見ながら好きなものを選んでdependency要素に追加します。
とはいえJerseyはサーバ側のAPI、クライアント側のAPI、MVC拡張など多数のJARに別れて提供されているので何を追加すれば良いのか最初は分からないと思います。
今回はサーバ側のコードを書きたいので、jersey-serverを追加します。
また、JerseyはGrizzlyやJettyなどのコンテナ上で動きますが、今回はJDK付属のHttpServerで動かしたいのでjersey-container-jdk-httpを追加します。
どんなコンテナが使えるかは http://repo1.maven.org/maven2/org/glassfish/jersey/containers/ を参照ください。
最後にJUnitでサクッと走らせてテストするためjersey-test-framework-provider-jdk-httpを追加します。
<dependencies>
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-server</artifactId>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-jdk-http</artifactId>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.test-framework.providers</groupId>
<artifactId>jersey-test-framework-provider-jdk-http</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
とまあ、こんな感じで良いでしょう。
でもこんなことチンタラやってられないと思うので https://github.com/backpaper0/sandbox/tree/77d7f587077a741973057d236cc3f6582d10bd38 をcloneしてjersey-blankディレクトリ内のpom.xmlをご利用ください。
私も大抵、自分が過去に書いたビルドファイルをコピります。
Gradleの場合
こんな感じ？
dependencies {
compile 'org.glassfish.jersey.core:jersey-server:2.13'
compile 'org.glassfish.jersey.containers:jersey-container-jdk-http:2.13'
testCompile 'org.glassfish.jersey.test-framework.providers:jersey-test-framework-provider-jdk-http:2.13'
}
コードを書く
まあ、この辺は適当に、足し算する簡単なやつで。
src/main/java/app/Calc.javaを作ります。
package app;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
@Path("calc")
public class Calc {
@Path("add")
@GET
@Produces(MediaType.TEXT_PLAIN)
public int add(@QueryParam("a") int a, @QueryParam("b") int b) {
return a + b;
}
}
で、JUnitテストです。src/test/java/app/CalcTest.javaを作ります。
package app;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import javax.ws.rs.core.Application;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
public class CalcTest extends JerseyTest {
@Test
public void test() throws Exception {
int c = target("calc/add").queryParam("a", 2)
.queryParam("b", 3)
.request()
.get(int.class);
assertThat(c, is(5));
}
@Override
protected Application configure() {
return new ResourceConfig(Calc.class);
}
}
test-frameworkを使うととても簡単にJUnitテストを書ける事が分かると思います。
テスト走らせる
IDEから実行するかMavenで。
mvn test
簡単ですね！
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running app.CalcTest
11 30, 2014 10:55:12 午後 org.glassfish.jersey.test.jdkhttp.JdkHttpServerTestContainerFactory$JdkHttpServerTestContainer <init>
情報: Creating JdkHttpServerTestContainer configured at the base URI http://localhost:9998/
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 5.109 sec
Results :
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
mainメソッドでサーバーを立てる
JUnitテストを走らせている事からもお分かり頂けると思いますが、簡単にサーバーを立てる事もできます。
こんな感じ。
package app;
import java.io.IOException;
import java.net.URI;
import org.glassfish.jersey.jdkhttp.JdkHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;
import com.sun.net.httpserver.HttpServer;
public class Server {
public static void main(String[] args) throws IOException {
URI uri = URI.create("http://localhost:8080/rest/");
ResourceConfig rc = new ResourceConfig();
rc.register(Calc.class);
HttpServer httpServer = JdkHttpServerFactory.createHttpServer(uri, rc);
Runtime.getRuntime().addShutdownHook(new Thread(() -> httpServer.stop(0)));
System.out.println("JAX-RS started");
}
}
アプリケーションサーバにデプロイする
GlassFishにデプロイする場合はdependencyのscopeをprovidedにしてWARファイルを作ってそれをデプロイすれば良いと思います。
Tomcatにデプロイする場合はjersey-container-jdk-httpを消して、jersey-container-servletを追加してWARファイルを作りましょう。
こんな感じです。
<dependencies>
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-server</artifactId>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-servlet</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
私はServlet APIに依存しないよう作る方がポータビリティが高そうで好きなのでscopeをruntimeにしています。
Servlet APIじゃんじゃん使いたい場合はscopeをcompileにしてください。
まとめ
というわけでJerseyを使用したJAX-RSの導入部分、如何でしたでしょうか？
簡単ですよね？ 特にJava EEの一部なのにアプリケーションサーバがなくても簡単に使えるのが良いですよね！ね！
最後に、手前味噌ですがJAX-RSの参考資料を挙げておきます。
はー、これらの資料もJAX-RS 2.0にアップデートしないといけないなー（しろめ
簡単ですが、以上。
Discussion