jersey+maven构建restful服务--入门篇

Myth丶恋晨 2022-06-10 02:28 463阅读 0赞

# jersey+maven构建restful服务--入门篇  #

标签： [ jersey][jersey][maven][][Restful][]

2016-10-21 10:31  2269人阅读 评论(0) 收藏 举报

![category_icon.jpg][] 分类：

jersey*（2）* ![arrow_triangle_20_down.jpg][] ![arrow_triangle_up.jpg][]

[作者同类文章][Link 1] *X*

maven*（1）* ![arrow_triangle_20_down.jpg][] ![arrow_triangle_up.jpg][]

[作者同类文章][Link 2] *X*

一、新建一个Maven Web项目

a) 新建一个简单的Maven项目

![Center][]

![Center 1][]

![Center 2][]

建好之后的项目工程结构如下：

![Center 3][]

b) 将简单的Maven项目转成Web项目

![Center 4][]

![Center 5][]

注意勾选生成web.xml文件

![Center 6][]

最终的项目结构如下：

![Center 7][]

![Center 8][]

c) 添加Maven依赖

![Center 9][]

![Center 10][]

![Center 11][]

二、修改pom文件，添加jersey依赖

**\[html\]**  view plain  copy

print ?

1.  <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/xsd/maven-4.0.0.xsd">  
2.    <modelVersion>4.0.0</modelVersion>  
3.    <groupId>com.chhliu</groupId>  
4.    <artifactId>jersey-restful</artifactId>  
5.    <version>0.0.1-SNAPSHOT</version>  
6.    <packaging>war</packaging>  
7.    <name>jersey-restful</name>  
8.    <description>jersey构建restful服务入门</description>  
9.      
10.   <dependencies>  
11.         <dependency>  
12.             <groupId>org.glassfish.jersey.containers</groupId>  
13.             <artifactId>jersey-container-servlet</artifactId>  
14.             <version>2.17</version>  
15.         </dependency>  
16.         <dependency>  
17.             <groupId>org.glassfish.jersey.core</groupId>  
18.             <artifactId>jersey-client</artifactId>  
19.             <version>2.17</version>  
20.         </dependency>  
21.         <dependency>  
22.             <groupId>org.glassfish.jersey.media</groupId>  
23.             <artifactId>jersey-media-json-jackson</artifactId>  
24.             <version>2.17</version>  
25.         </dependency>  
26.     </dependencies>  
27. </project>

<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/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.chhliu</groupId>
      <artifactId>jersey-restful</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <packaging>war</packaging>
      <name>jersey-restful</name>
      <description>jersey构建restful服务入门</description>
      
      <dependencies>
    		<dependency>
    			<groupId>org.glassfish.jersey.containers</groupId>
    			<artifactId>jersey-container-servlet</artifactId>
    			<version>2.17</version>
    		</dependency>
    		<dependency>
    			<groupId>org.glassfish.jersey.core</groupId>
    			<artifactId>jersey-client</artifactId>
    			<version>2.17</version>
    		</dependency>
    		<dependency>
    			<groupId>org.glassfish.jersey.media</groupId>
    			<artifactId>jersey-media-json-jackson</artifactId>
    			<version>2.17</version>
    		</dependency>
    	</dependencies>
    </project>

三、修改 web.xml 文件

**\[html\]**  view plain  copy

print ?

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <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/javaee http://java.sun.com/xml/ns/javaee/web-app\_3\_0.xsd" id="WebApp\_ID" version="3.0">  
3.    <display-name>jersey-restful</display-name>  
4.    <servlet>    
5.        <servlet-name>jersey-restful</servlet-name>    
6.        <servlet-class>    
7.            org.glassfish.jersey.servlet.ServletContainer    
8.        </servlet-class>    
9.        <init-param>    
10.           <param-name>jersey.config.server.provider.packages</param-name>    
11.           <param-value>com.chhliu</param-value>    
12.       </init-param>    
13.       <load-on-startup>1</load-on-startup>    
14.   </servlet>    
15.   <servlet-mapping>    
16.       <servlet-name>jersey-restful</servlet-name>    
17.       <url-pattern>/rest/\*</url-pattern>    
18.   </servlet-mapping>  
19. </web-app>

<?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/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
      <display-name>jersey-restful</display-name>
      <servlet>  
          <servlet-name>jersey-restful</servlet-name>  
          <servlet-class>  
              org.glassfish.jersey.servlet.ServletContainer  
          </servlet-class>  
          <init-param>  
              <param-name>jersey.config.server.provider.packages</param-name>  
              <param-value>com.chhliu</param-value>  
          </init-param>  
          <load-on-startup>1</load-on-startup>  
      </servlet>  
      <servlet-mapping>  
          <servlet-name>jersey-restful</servlet-name>  
          <url-pattern>/rest/*</url-pattern>  
      </servlet-mapping>
    </web-app>

四、构建RestFul服务

a) 新建一个VO类

**\[java\]**  view plain  copy

print ?

1.  public class User implements Serializable \{  
2.      private static final long serialVersionUID = 1L;  
3.    
4.      private int id;  
5.      private String name;  
6.  \}

public class User implements Serializable {
    	private static final long serialVersionUID = 1L;
    
    	private int id;
    	private String name;
    }

b) 构建服务

**\[java\]**  view plain  copy

print ?

1.  @Path("/helloworld")  
2.  public class RestfulHelloWorld \{  
3.      @GET  
4.      @Produces(MediaType.TEXT\_PLAIN)  
5.      public String sayHelloWorld() \{  
6.          return "Hello World!";  
7.      \}  
8.    
9.      @GET  
10.     @Path("/\{param\}")  
11.     @Produces("text/plain;charset=UTF-8")  
12.     public String sayHello2UserByText(@PathParam("param") String username) \{  
13.         return "Hello " + username;  
14.     \}  
15.   
16.     @GET  
17.     @Path("/get")  
18.     @Produces(MediaType.APPLICATION\_JSON)  
19.     public User sayHelloToUserByJson(@QueryParam("username") String username) \{  
20.         User user = new User();  
21.         user.setId(1);  
22.         user.setName(username);  
23.         return user;  
24.     \}  
25. \}

@Path("/helloworld")
    public class RestfulHelloWorld {
    	@GET
    	@Produces(MediaType.TEXT_PLAIN)
    	public String sayHelloWorld() {
    		return "Hello World!";
    	}
    
    	@GET
    	@Path("/{param}")
    	@Produces("text/plain;charset=UTF-8")
    	public String sayHello2UserByText(@PathParam("param") String username) {
    		return "Hello " + username;
    	}
    
    	@GET
    	@Path("/get")
    	@Produces(MediaType.APPLICATION_JSON)
    	public User sayHelloToUserByJson(@QueryParam("username") String username) {
    		User user = new User();
    		user.setId(1);
    		user.setName(username);
    		return user;
    	}
    }

c) 发布服务

![Center 12][]

d) [测试][Link 3]服务

**\[java\]**  view plain  copy

print ?

1.  http://localhost:8080/jersey-restful/rest/helloworld  
2.  http://localhost:8080/jersey-restful/rest/helloworld/chhliu  
3.  http://localhost:8080/jersey-restful/rest/helloworld/get?username=chhliu

http://localhost:8080/jersey-restful/rest/helloworld
    http://localhost:8080/jersey-restful/rest/helloworld/chhliu
    http://localhost:8080/jersey-restful/rest/helloworld/get?username=chhliu

测试结果如下：

**\[java\]**  view plain  copy

print ?

1.  Hello World!  
2.  Hello chhliu  
3.  \{ "id":1,"name":"chhliu"\}

Hello World!
    Hello chhliu
    {"id":1,"name":"chhliu"}

[jersey]: http://www.csdn.net/tag/jersey
[maven]: http://www.csdn.net/tag/maven
[Restful]: http://www.csdn.net/tag/Restful
[category_icon.jpg]: /images/20220610/434d5784b57645c68d01ac77d58008d8.png
[arrow_triangle_20_down.jpg]: http://static.blog.csdn.net/images/arrow_triangle%20_down.jpg
[arrow_triangle_up.jpg]: /images/20220610/97549152a0e446a9ae48a9ac48d9110e.png
[Link 1]: http://blog.csdn.net/liuchuanhong1/article/category/6474349
[Link 2]: http://blog.csdn.net/liuchuanhong1/article/category/6474350
[Center]: /images/20220610/ce978548e9ac423fb8b5804eea6a005a.png
[Center 1]: /images/20220610/9009df5e83794c4c9306f7e8c84d6d22.png
[Center 2]: /images/20220610/eff6bfcb52e34d9b9a165c56f5872fa1.png
[Center 3]: /images/20220610/0a880ed30409430a81e2ab50caba9f77.png
[Center 4]: /images/20220610/6ee7b9cd4e7f4d6b98070ab7b01de117.png
[Center 5]: /images/20220610/19095861c57c497bb9e30a5debf9cab8.png
[Center 6]: /images/20220610/ba5a302a8a214a58beeaa9221b1c77b3.png
[Center 7]: /images/20220610/2607466f31254e32beb12f48fe39442b.png
[Center 8]: /images/20220610/8d03c04fab2c4fdfbfc589bdea8aafa8.png
[Center 9]: /images/20220610/396967d277ae489aa9ea748882fef071.png
[Center 10]: /images/20220610/9892d8008ceb4486a4dcee765cf7b652.png
[Center 11]: /images/20220610/c5df6a71f0be436cb767d54cc0479b61.png
[Center 12]: /images/20220610/16e21d94abc14af7ae45bbee21f15f84.png
[Link 3]: http://lib.csdn.net/base/softwaretest