Jersey初体验

最新推荐文章于 2024-07-16 17:18:30 发布

weixin_34097242

最新推荐文章于 2024-07-16 17:18:30 发布

阅读量92

点赞数

文章标签：前端 java python ViewUI

原文链接：https://my.oschina.net/wangbaofeng/blog/713847

版权

2019独角兽企业重金招聘Python工程师标准>>>

一、Jersey简介

Jersey是JAX-RS（JSR311）开源参考实现用于构建RESTful Web service。此外Jersey还提供一些额外的API和扩展机制，所以开发人员能够按照自己的需要对Jersey进行扩展。

二、项目搭建

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