Jersey初體驗

1、Jersey簡介

Jersey是JAX-RS（JSR311）開源參考實現用於構建RESTful Web service。此外Jersey還提供一些額外的API和擴展機制，因此開發人員可以按照本身的須要對Jersey進行擴展。

2、項目搭建

MyEclipse2014, JDK1.7, Maven3, Jersey2.23.1

1. 新建一個web service項目，並加入maven支持

2. 配置pom.xml文件，加入jersey2.23.1的依賴包以及jetty插件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.wbf</groupId>
	<artifactId>jerseyDemo</artifactId>
	<packaging>war</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>jersey demo</name>
	<url>http://maven.apache.org</url>
	
	<properties>
		<jersey.version>2.23.1</jersey.version>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<jdk.version>1.7</jdk.version>
	</properties>
	
	<dependencies>
		<!-- jersey -->
		<dependency>
			<groupId>org.glassfish.jersey.containers</groupId>
			<artifactId>jersey-container-servlet</artifactId>
			<version>${jersey.version}</version>
		</dependency>

		<dependency>
			<groupId>org.glassfish.jersey.media</groupId>
			<artifactId>jersey-media-multipart</artifactId>
			<version>${jersey.version}</version>
		</dependency>

		<dependency>
			<groupId>org.glassfish.jersey.media</groupId>
			<artifactId>jersey-media-json-jackson</artifactId>
			<version>${jersey.version}</version>
		</dependency>

		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-annotations</artifactId>
			<version>2.8.0</version>
		</dependency>


	</dependencies>
	<build>
		<finalName>jerseyDemo</finalName>

		<plugins>

			<!-- 編譯的時候使用JDK7和UTF8編碼 -->
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<configuration>
					<source>${jdk.version}</source>
					<target>${jdk.version}</target>
					<encoding>${project.build.sourceEncoding}</encoding>
				</configuration>
			</plugin>

			<!-- 配置Maven插件(mvn jetty:run能夠運行項目) -->
			<plugin>
				<groupId>org.mortbay.jetty</groupId>
				<artifactId>maven-jetty-plugin</artifactId>
				<version>6.1.26</version>
				<configuration>
					<connectors>
						<connector implementation="org.mortbay.jetty.nio.SelectChannelConnector">
							<port>8888</port>
						</connector>
					</connectors>
				</configuration>
			</plugin>

		</plugins>
	</build>
</project>

3. 編寫POJO類User

package com.wbf.jersey;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class User {
	private String name;
	private String age;
	private String sex;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getAge() {
		return age;
	}

	public void setAge(String age) {
		this.age = age;
	}

	public String getSex() {
		return sex;
	}

	public void setSex(String sex) {
		this.sex = sex;
	}
	
	@Override
	public String toString() {
		return "name: " + this.getName() + ", age: " + this.getAge() + ", sex: " + this.getSex();
	}
}

User是一個POJO類，其重寫了父類的toString()方法，加上了@XmlRootElement註解以支持向前端返回xml格式的值

4. 編寫資源類RESTService

package com.wbf.jersey;

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

@Path("/restService")
public class RESTService {
	@GET
	@Produces(MediaType.TEXT_HTML)
	public String getUserHello() {
		return "hello!";
	}
	
	@GET
	@Path("/getUserText")
	@Produces(MediaType.TEXT_PLAIN)
	public String getUserText() {
		User user = new User();
		user.setName("snail");
		user.setAge("22");
		user.setSex("male");
		return user.toString();
	}

	@GET
	@Path("/getUserXml")
	@Produces(MediaType.APPLICATION_XML)
	public User getUserXml() {
		User user = new User();
		user.setName("snail");
		user.setAge("22");
		user.setSex("male");
		return user;
	}

	@GET
	@Path("/getUserJson")
	@Produces(MediaType.APPLICATION_JSON)
	public User getUserJson() {
		User user = new User();
		user.setName("snail");
		user.setAge("22");
		user.setSex("male");
		return user;
	}
}

這個類是先後端交互的類，類和方法上都有對應的JAX-RS註解，如@Path, @Get, @Produces, @Consumes。

5. 編寫Application類：RestApplication

package com.wbf.jersey;

import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.server.ResourceConfig;

public class RestApplication extends ResourceConfig {

	public RestApplication() {
		// 服務類所在的包路徑
		packages("com.wbf.jersey");
		// 打印訪問日誌，便於跟蹤調試，正式發佈可清除
		register(LoggingFilter.class);
	}

}

這個類繼承了jersey的資源管理類ResourceConfig，在這個類中初始化的時候，咱們會註冊一些信息到jersey容器，好比：告訴jersey容器應該掃描哪些包下面的類，看看這些包下哪些類是有對應JAX-RS註解的，以便管理起來

6. 配置web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
	<display-name>RestDemo</display-name>
	<servlet>
		<servlet-name>jerseyServlet</servlet-name>
		<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
		<init-param>
			<param-name>javax.ws.rs.Application</param-name>
			<param-value>com.wbf.jersey.RestApplication</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>

	<servlet-mapping>
		<servlet-name>jerseyServlet</servlet-name>
		<url-pattern>/*</url-pattern>
	</servlet-mapping>

</web-app>

這個文件中配置了jersey的核心類ServletContainer，它是個servlet。

<servlet-mapping>
	<servlet-name>jerseyServlet</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>

上訴servlet-mapping中的信息表示前端全部的訪問都交給jerseyServlet處理，也就是交給org.glassfish.jersey.servlet.ServletContainer統一處理分配。

<init-param>
	<param-name>javax.ws.rs.Application</param-name>
	<param-value>com.wbf.jersey.RestApplication</param-value>
</init-param>

上訴init-param中的信息表示加載jersey核心容器ServletContainer時，加載用戶自定義的類RestApplication，這個自定義類的是將一些必要的信息注入到jersey核心容器中，如：哪些類是資源類

6. 將項目部署到jetty，經過mvn jetty:run來啓動

mvn compile

mvn jetty:run

經過瀏覽器訪問

(1) http://localhost:8888/jerseyDemo/restService/

訪問的最終會轉到getUserHello方法上

@GET
@Produces(MediaType.TEXT_HTML)
public String getUserHello() {
	return "hello!";
}

getUserHello方法容許get方式的訪問，返回值類型是TEXT_HTML，當前方法返回"hello!"

(2) http://localhost:8888/jerseyDemo/restService/getUserXml

訪問最終會轉到getUserXml方法上

@GET
@Path("/getUserXml")
@Produces(MediaType.APPLICATION_XML)
public User getUserXml() {
	User user = new User();
	user.setName("snail");
	user.setAge("22");
	user.setSex("male");
	return user;
}

getUserXml方法容許get方式的訪問，返回值類型是APPLICATION_XML，當前方法返回user，user對象會被解析成xml格式的值，最後return給前端。

(3) http://localhost:8888/jerseyDemo/restService/getUserJson

getUserJson方法容許get方式的訪問，返回值類型是APPLICATION_JSON，當前方法返回user，user對象會被解析成json格式的值，最後return給前端 。