【Jersey】基于Jersey构建Restful Web应用




环境说明

  • java: 1.6；
  • tomcat: 6.0.48；
  • Jersey：1.18；

Jersey介绍

主要用于构建基于Restful的Web程序；

构建基于Maven的Javaweb程序


说明：
Javaweb项目是作为maven模块项目进行创建的，这里仅给出相应的pom文件，具体的创建过程可google搜索；
Javaweb引用了Dependencies模块（该模块主要负责引入各种maven的Jar）
项目结构图：

主项目pom：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. 	<modelVersion>4.0.0</modelVersion>
  6. 	<groupId>com.ll</groupId>
  7. 	<artifactId>MyStudyProject</artifactId>
  8. 	<version>1.0.0</version>
  9. 	<packaging>pom</packaging>
  11. 	<distributionManagement>
  12. 		<site>
  13. 			<id>website</id>
  14. 			<url>scp://webhost.company.com/www/website</url>
  15. 		</site>
  16. 	</distributionManagement>
  18. 	<properties>
  19. 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  20. 	</properties>
  22. 	<modules>
  23. 		<module>MapReduce</module>
  24. 		<module>Lucene</module>
  25. 		<module>Dependencies</module>
  26. 		<module>DesignPattern</module>
  27. 		<module>Javaweb</module>
  28. 	</modules>
  30. </project>

Javaweb模块pom

Maven依赖

Spring相关Jar

  1. <properties>
  2. 	<springVersion>3.2.13.RELEASE</springVersion>
  3. </properties>
  5. <!-- Spring start -->
  6. <dependency>
  7. 	<groupId>org.springframework</groupId>
  8. 	<artifactId>spring-aop</artifactId>
  9. 	<version>${springVersion}</version>
  10. </dependency>
  11. <dependency>
  12. 	<groupId>org.springframework</groupId>
  13. 	<artifactId>spring-aspects</artifactId>
  14. 	<version>${springVersion}</version>
  15. </dependency>
  16. <dependency>
  17. 	<groupId>org.springframework</groupId>
  18. 	<artifactId>spring-beans</artifactId>
  19. 	<version>${springVersion}</version>
  20. </dependency>
  21. <dependency>
  22. 	<groupId>org.springframework</groupId>
  23. 	<artifactId>spring-context</artifactId>
  24. 	<version>${springVersion}</version>
  25. </dependency>
  26. <dependency>
  27. 	<groupId>org.springframework</groupId>
  28. 	<artifactId>spring-context-support</artifactId>
  29. 	<version>${springVersion}</version>
  30. </dependency>
  31. <dependency>
  32. 	<groupId>org.springframework</groupId>
  33. 	<artifactId>spring-core</artifactId>
  34. 	<version>${springVersion}</version>
  35. </dependency>
  36. <dependency>
  37. 	<groupId>org.springframework</groupId>
  38. 	<artifactId>spring-jdbc</artifactId>
  39. 	<version>${springVersion}</version>
  40. </dependency>
  41. <dependency>
  42. 	<groupId>org.springframework</groupId>
  43. 	<artifactId>spring-orm</artifactId>
  44. 	<version>${springVersion}</version>
  45. </dependency>
  46. <dependency>
  47. 	<groupId>org.springframework</groupId>
  48. 	<artifactId>spring-tx</artifactId>
  49. 	<version>${springVersion}</version>
  50. </dependency>
  51. <dependency>
  52. 	<groupId>org.springframework</groupId>
  53. 	<artifactId>spring-jms</artifactId>
  54. 	<version>${springVersion}</version>
  55. </dependency
  56. <dependency>
  57. 	<groupId>org.springframework</groupId>
  58. 	<artifactId>spring-web</artifactId>
  59. 	<version>${springVersion}</version>
  60. </dependency
  61. <dependency>
  62. 	<groupId>org.springframework</groupId>
  63. 	<artifactId>spring-webmvc</artifactId>
  64. 	<version>${springVersion}</version>
  65. </dependency>
  67. <dependency>
  68. 	<groupId>org.springframework</groupId>
  69. 	<artifactId>spring-test</artifactId>
  70. 	<version>${springVersion}</version>
  71. 	<type>jar</type>
  72. 	<scope>compile</scope>
  73. </dependency>
  74. <!-- spring end -->

Jersey相关Jar

  1. <properties>
  2. 	<Dependency.version>1.0.0</Dependency.version>
  3. 	<Jersey.version>1.18</Jersey.version>
  4. </properties>
  7. <!-- Jersey start -->
  8. <dependency>
  9. 	<groupId>com.sun.jersey</groupId>
  10. 	<artifactId>jersey-server</artifactId>
  11. 	<version>${Jersey.version}</version>
  12. </dependency>
  13. <dependency>
  14. 	<groupId>com.sun.jersey</groupId>
  15. 	<artifactId>jersey-json</artifactId>
  16. 	<version>${Jersey.version}</version>
  17. </dependency>
  18. <dependency>
  19. 	<groupId>com.sun.jersey</groupId>
  20. 	<artifactId>jersey-client</artifactId>
  21. 	<version>${Jersey.version}</version>
  22. </dependency>
  23. <dependency>
  24. 	<groupId>com.sun.jersey.contribs</groupId>
  25. 	<artifactId>jersey-spring</artifactId>
  26. 	<version>${Jersey.version}</version>
  27. 	<exclusions>
  28. 		<exclusion>
  29. 			<groupId>org.springframework</groupId>
  30. 			<artifactId>spring</artifactId>
  31. 		</exclusion>
  32. 		<exclusion>
  33. 			<groupId>org.springframework</groupId>
  34. 			<artifactId>spring-core</artifactId>
  35. 		</exclusion>
  36. 		<exclusion>
  37. 			<groupId>org.springframework</groupId>
  38. 			<artifactId>spring-beans</artifactId>
  39. 		</exclusion>
  40. 		<exclusion>
  41. 			<groupId>org.springframework</groupId>
  42. 			<artifactId>spring-web</artifactId>
  43. 		</exclusion>
  44. 		<exclusion>
  45. 			<groupId>org.springframework</groupId>
  46. 			<artifactId>spring-context</artifactId>
  47. 		</exclusion>
  48. 		<exclusion>
  49. 			<groupId>org.springframework</groupId>
  50. 			<artifactId>spring-aop</artifactId>
  51. 		</exclusion>
  52. 	</exclusions>
  53. </dependency>
  54. <!-- Jersey end -->
说明：
因为jersey-spring.jar依赖spring包，而项目中其他模块也使用了通用的Spring模块，所以为避免jar包冲突，这里使用<exclusion>标签将spring相关jar包过滤掉；

Web.xml

配置Spring相关属性

这里没用到，可以不进行配置；
  1. <!--Spring 文件路径 -->
  2. <context-param>
  3. 	<param-name>contextConfigLocation</param-name>
  4. 	<param-value>classpath:conf/beans/beans-*.xml</param-value>
  5. </context-param>
  6. <!-- spring上下文监听器 -->
  7. <listener>
  8. 	<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  9. </listener>
  10. <listener>
  11. 	<listener-class>org.springframework.web.context.request.RequestContextListener<listener-class>
  12. </listener>

Jersey配置Servlet

  1. <!-- jersey Servlet -->
  2. <servlet>
  3. 	<servlet-name>rest-inside</servlet-name>
  4. 	<servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
  5. 	<init-param>
  6. 		<param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
  7. 		<param-value>true</param-value>
  8. 	</init-param>
  9. 	<init-param>
  10.            <param-name>com.sun.jersey.config.property.packages</param-name>
  11.            <param-value>com.ll.rest</param-value>
  12.        </init-param>
  13. 	<load-on-startup>1</load-on-startup>
  14. </servlet>
  15. <servlet-mapping>
  16. 	<servlet-name>rest-inside</servlet-name>
  17. 	<url-pattern>/i/rest/*</url-pattern>
  18. </servlet-mapping>
配置说明：
  • 使用SpringServlet；
  • POJOMappingFeature： 用于Json和Pojo对象的转换；
  • com.sun.jersey.config.property.packages： 代表服务器端路径；

完整的Web.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. 	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
  4. 	version="2.4">
  5. 	<display-name>Java Web</display-name>
  6. 	<welcome-file-list>
  7. 		<welcome-file>index.jsp</welcome-file>
  8. 	</welcome-file-list>
  10. 	<!--Spring 文件路径 -->
  11. 	<context-param>
  12. 		<param-name>contextConfigLocation</param-name>
  13. 		<param-value>classpath:conf/beans/beans-*.xml</param-value>
  14. 	</context-param>
  16. 	<!-- spring上下文监听器 -->
  17. 	<listener>
  18. 		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  19. 	</listener>
  20. 	<listener>
  21. 		<listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
  22. 	</listener>
  24. 	<!-- 解决中文乱码 -->
  25. 	<filter>
  26. 		<filter-name>SetCharacterEncoding</filter-name>
  27. 		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  28. 		<init-param>
  29. 			<param-name>encoding</param-name>
  30. 			<param-value>UTF-8</param-value>
  31. 		</init-param>
  32. 		<init-param>
  33. 			<param-name>forceEncoding</param-name>
  34. 			<param-value>false</param-value>
  35. 		</init-param>
  36. 	</filter>
  37. 	<filter-mapping>
  38. 		<filter-name>SetCharacterEncoding</filter-name>
  39. 		<url-pattern>/*</url-pattern>
  40. 	</filter-mapping>
  42. 	<!-- jersey Servlet -->
  43. 	<servlet>
  44. 		<servlet-name>rest-inside</servlet-name>
  45. 		<servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
  46. 		<init-param>
  47. 			<param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
  48. 			<param-value>true</param-value>
  49. 		</init-param>
  50. 		<init-param>
  51.             <param-name>com.sun.jersey.config.property.packages</param-name>
  52.             <param-value>com.ll.rest</param-value>
  53.         </init-param>
  54. 		<load-on-startup>1</load-on-startup>
  55. 	</servlet>
  56. 	<servlet-mapping>
  57. 		<servlet-name>rest-inside</servlet-name>
  58. 		<url-pattern>/i/rest/*</url-pattern>
  59. 	</servlet-mapping>
  61. </web-app>

Jersey服务端代码

代码如下：
  1. package com.ll.rest;
  3. import javax.ws.rs.Consumes;
  4. import javax.ws.rs.GET;
  5. import javax.ws.rs.Path;
  6. import javax.ws.rs.PathParam;
  7. import javax.ws.rs.Produces;
  8. import javax.ws.rs.core.MediaType;
  10. import com.ll.model.Student;
  12. @Path("/student")
  13. public class JerseyServerTest {
  14. 	@Path("get/{name}")
  15. 	@GET
  16. 	@Produces(MediaType.APPLICATION_JSON)
  17. 	@Consumes(MediaType.APPLICATION_JSON)
  18. 	public Student status(@PathParam("name") String name) {
  19. 		System.out.println("get Student, name: "+name);
  20. 		Student student = new Student();
  21. 		student.setAge(25);
  22. 		student.setName(name);
  23. 		student.setSchool("SuZhou");
  24. 		return student;
  25. 	}
  26. }

Student.java代码如下：


安装tomcat，并部署Javaweb

从官网下载tomcat后，解压缩，配置好环境变量即可使用，这里不做详述；

配置Javaweb为tomcat默认项目

tomcat默认项目位于Root下，为了让我们的Javaweb成为默认项目，需要修改配置文件；
  • 配置文件名称：server.xml
修改如下内容：
  1.  <Context path="" docBase="C:xxxJavaweb" debug="0" reloadable="true"/>

启动tomcat

说明：启动前需要对javaweb进行 mvn install(或package)
每一次修改javaweb相关程序，都需要先对javaweb进行重新编译；

测试Jersey

方式1： 使用postman插件测试（Chrome的一个插件，专门用于发送http请求的）；
方式2： 编写Jersey的Client程序进行测试；

方式1： 使用postman插件测试



方式2： 编写Jersey的Client程序进行测试

客户端程序：
完整程序：
  1. import javax.ws.rs.core.MediaType;
  2. import javax.ws.rs.core.MultivaluedMap;
  4. import com.sun.jersey.api.client.Client;
  5. import com.sun.jersey.api.client.config.ClientConfig;
  6. import com.sun.jersey.api.client.config.DefaultClientConfig;
  7. import com.sun.jersey.api.json.JSONConfiguration;
  9. public class StudentDao {
  10. 	private Client client;
  12. 	public void init() {
  13. 		if (client == null) {
  14. 			ClientConfig config = new DefaultClientConfig();
  15. 			config.getFeatures().put(JSONConfiguration.FEATURE_POJO_MAPPING,
  16. 					true);
  17. 			client = Client.create(config);
  18. 			client.setConnectTimeout(3000);
  19. 		}
  20. 	}
  22. 	public Student get(String url, String path,
  23. 			MultivaluedMap<String, String> queryParams) {
  24. 		try {
  25. 			return queryParams == null ? client.resource(completeUrl(url))
  26. 					.path(path)
  27. 					.type(MediaType.APPLICATION_JSON)
  28. 					.get(Student.class) 
  29. 					: client.resource(completeUrl(url))
  30. 					.queryParams(queryParams)
  31. 					.path(path)
  32. 					.type(MediaType.APPLICATION_JSON)
  33. 					.get(Student.class);
  34. 		} catch (Exception e) {
  35. 			return null;
  36. 		}
  37. 	}
  39. 	private String completeUrl(String url) {
  40. 		url = url.toLowerCase();
  41. 		if (url.startsWith("http://")) {
  42. 			return url;
  43. 		} else {
  44. 			return "http://" + url;
  45. 		}
  46. 	}
  48. 	public static void main(String[] args) {
  49. 		StudentDao dao = new StudentDao();
  50. 		dao.init();
  51. 		Student ret = dao.get("http://127.0.0.1:8080/",
  52. 				"i/rest/student/get/Tom", null);
  53. 		System.out.println("请求返回：");
  54. 		System.out.println(ret);
  55. 	}
  56. }
测试结果：






【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/ssslinppp/p/6223038.html