jersey restful服务Hello World

最近，在eclipse中使用maven web项目搭建了jersey restful服务的一个例子，步骤记录如下。

1. 在eclipse中新建maven web项目

               

2. 修改pom文件，设置jersey restful服务的依赖项。pom文件如下

<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.johnf.app</groupId>
  <artifactId>jersy-rest-first</artifactId>
  <packaging>war</packaging>
  <version>0.0.1-SNAPSHOT</version>
  <name>jersy-rest-first Maven Webapp</name>
  <url>http://maven.apache.org</url>
  
  <properties>
  	<jersey.version>1.19</jersey.version>
  	<spring.version>4.1.4.RELEASE</spring.version>
  </properties>
  
  <dependencies>
  	<!-- junit -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.4</version>
      <scope>test</scope>
    </dependency>
    <!-- jersey  -->
    <dependency>
    	<groupId>com.sun.jersey</groupId>
    	<artifactId>jersey-core</artifactId>
    	<version>${jersey.version}</version>
    </dependency>
    <dependency>
    	<groupId>com.sun.jersey</groupId>
    	<artifactId>jersey-server</artifactId>
    	<version>${jersey.version}</version>
    </dependency>
    <dependency>
    	<groupId>com.sun.jersey</groupId>
    	<artifactId>jersey-json</artifactId>
    	<version>${jersey.version}</version>
    </dependency>
    <!-- jersey-spring -->
	<dependency>
		<groupId>com.sun.jersey.contribs</groupId>
		<artifactId>jersey-spring</artifactId>
		<version>${jersey.version}</version>
		<!-- 去除jersey自带的低版本spring -->
		<exclusions>
			<exclusion>
				<groupId>org.springframework</groupId>
				<artifactId>spring-core</artifactId>
			</exclusion>
			<exclusion>
				<groupId>org.springframework</groupId>
				<artifactId>spring-context</artifactId>
			</exclusion>
			<exclusion>
				<groupId>org.springframework</groupId>
				<artifactId>spring-web</artifactId>
			</exclusion>
			<exclusion>
				<groupId>org.springframework</groupId>
				<artifactId>spring-beans</artifactId>
			</exclusion>
			<exclusion>
				<groupId>org.springframework</groupId>
				<artifactId>spring-aop</artifactId>
			</exclusion>
		</exclusions>
	</dependency>    
	<!-- spring -->
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-core</artifactId>
		<version>${spring.version}</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-context</artifactId>
		<version>${spring.version}</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>${spring.version}</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-beans</artifactId>
		<version>${spring.version}</version>
	</dependency>
  </dependencies>
  
  <build>
    <finalName>jersy-rest-first</finalName>
  </build>
</project>

3. 新建实体类

package com.johnfnash.app.jersey.domain;

import java.io.Serializable;

/**
 * 用户实体类  
 */
public class User implements Serializable {
	private static final long serialVersionUID = -6935225465000396223L;
	
	/** id */
	private int id;
	
	/** 姓名 */
	private String name;
	
	public User() {
		super();
	}

	public User(int id, String name) {
		super();
		this.id = id;
		this.name = name;
	}

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

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

4. 新建Restful服务类

package com.johnfnash.app.jersey.rest;

import java.util.ArrayList;
import java.util.List;

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;

import org.springframework.stereotype.Component;

import com.johnfnash.app.jersey.domain.User;

@Component //定义此类为spring组件,即bean类
@Path("/user")
public class UserServiceRest {
	@GET
	@Path("{id}")
	@Produces(MediaType.APPLICATION_JSON)
	public User getUserById(@PathParam("id") int id) {
		User user = new User(id, "zs");
		return user;
	}

	@GET
	@Path("list")
	@Produces(MediaType.APPLICATION_JSON)
	public List<User> getUserList() {
		List<User> userList = new ArrayList<User>();
		userList.add(new User(1, "zs"));
		userList.add(new User(2, "ls"));
		return userList;
	}
	
}

5. 修改web.xml文件，添加jersey restful配置

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  
  <!-- spring -->
  <listener>
  	<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>
  <context-param>
  	<param-name>contextConfigLocation</param-name>
  	<param-value>classpath:applicationContext.xml</param-value>
  </context-param>
  
  <!-- jersey 配置 -->
  <servlet>
  	<servlet-name>jersey</servlet-name>
  	<servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
  	<!-- rest服务所在包路径 -->
  	<init-param>
  		<param-name>com.sun.jersey.config.property.packages</param-name>
  		<param-value>com.johnfnash.app.jersey.rest</param-value>
  	</init-param>
  	<!-- 开启POJO和JSON支持 -->
  	<init-param>
        <param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
        <param-value>true</param-value>
    </init-param>
  	<load-on-startup>1</load-on-startup>
  </servlet>
  
  <servlet-mapping>
  	<servlet-name>jersey</servlet-name>
  	<url-pattern>/rest/*</url-pattern>
  </servlet-mapping>
</web-app>

由于使用了spring，需要在src/main/resources下建一个空的spring配置文件：applicationContext.xml

6. 工程的整体结构如下：

                                              

7. 将项目部署到tomcat之后，就可以在浏览器里进行访问了

在浏览器地址栏中输入: http://localhost:8080/jersy-rest-first/rest/user/1

在浏览器地址栏中输入: http://localhost:8080/jersy-rest-first/rest/user/list