使用 Jersey 和 Apache Tomcat 7 構建 JAX-RS 環境

前兩天開始看Web Service方面的資料，項目中使用的是Axis，Axis支持的是JAX-WS的API。如今比較流行RESTful，就順便學習一下JAX-RS。

選擇的框架是Jersey 1.13。比較了一下Apache CXF和Jersey，以爲Jersey比較簡潔，符合我帶點強迫症的心理。

在讓Tomcat支持Annotation的過程當中走了很多彎路，Jersey官方文檔這方面作得至關糟糕。

主要參考資料：

• Configuring Tomcat 7 as a JAX-RS server with Jersey
• 使用 Jersey 和 Apache Tomcat 構建 RESTful Web 服務
• 使用 JAX-RS 簡化 REST 應用開發

最終搭建完成時候發現是至關的簡單。。。

1.核心功能只用到了4個jar包，將它們放到WEB-INF/lib中：

asm.jar
jersey-core.jar
jersey-server.jar
jersey-servlet.jar

2.在WEB-INF/web.xml中添加

<servlet>
	<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
	<load-on-startup>1</load-on-startup>
</servlet>

這就是配置的關鍵。它的做用是「Scanning for root resource and provider classes in the Web app resource paths」，這樣代碼中的Annotation配置就會生效。

 3.實現

JAX-RS 沒有定義 Component 或是 VirtualHost，只是用 Application 來存放全部的 REST 資源。

package canghailan.jaxrs;

import java.util.HashSet;
import java.util.Set;

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("/services")
public class MyApplication extends Application {
	@Override
	public Set<Class<?>> getClasses() {
		Set<Class<?>> classes = new HashSet<>();
		classes.add(HelloWorldService.class);
		return classes;
	}
}

package canghailan.jaxrs;

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

@Path("/")
public class HelloWorldService {
	@Path("/welcome/{name}")
	@GET 
	@Produces(MediaType.TEXT_PLAIN)
	public String welcome(@PathParam("name") String name) {
		return "Welcome, " + name + "!";
	}
}

啓動Tomcat時，日誌輸出：「Root resource classes found」。 

訪問http://localhost:8080/jaxrs/services/welcome/baby：

Welcome, baby!

 4.添加json支持

jackson-core-asl.jar
jackson-jaxrs.jar
jackson-mapper-asl.jar
jackson-xc.jar

啓動Tomcat時，日誌輸出：「Provider classes found」。

在Application中添加Provider：

public Set<Class<?>> getClasses() {
		Set<Class<?>> classes = new HashSet<>();
		classes.add(JacksonJsonProvider.class);
		classes.add(HelloWorldService.class);
		return classes;
	}

  在HelloWorldService中添加：

@Path("/auth/{name}")
	@GET 
	@Produces(MediaType.APPLICATION_JSON)
	public User auth(@PathParam("name") String name) {
		return new User(name, "123456");
	}

public class User {
	private String name;
	private String password;
...
}

訪問 http://localhost:8080/jaxrs/services/auth/baby：

{"name":"baby","password":"123456"}