使用 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"}