jersey

時間  2019-12-09
標籤 jersey 简体版
原文   原文鏈接

Java Jersey使用總結

簡介

Jersey是JAX-RS（JSR311）開源參考實現用於構建RESTful Web service，它包含三個部分：html

  • 核心服務器（Core Server）：經過提供JSR 311中標準化的註釋和API標準化，能夠用直觀的方式開發RESTful Web服務。java

  • 核心客戶端(Core Client)：Jersey客戶端API可以幫助開發者與RESTful服務輕鬆通訊；git

  • 集成（Integration)：Jersey還提供能夠輕鬆繼承Spring、Guice、Apache Abdera的庫。github

在本次開發中使用Jersey2.0，而且僅使用了核心服務器。web

設置Jersey環境

Maven

01 <!--jersey-->
02 <dependency>
03     <groupId>org.glassfish.jersey.containers</groupId>
04     <artifactId>jersey-container-servlet-core</artifactId>
05     <version>2.0</version>
06 </dependency>
07  
08 <!--JAXB API-->
09 <dependency>
10     <groupId>javax.xml.ws</groupId>
11     <artifactId>jaxws-api</artifactId>
12     <version>2.1</version>
13 </dependency>
14  
15 <!-- Json支持 -->
16 <dependency>
17     <groupId>org.codehaus.jackson</groupId>
18     <artifactId>jackson-core-asl</artifactId>
19     <version>1.9.12</version>
20 </dependency>
21 <dependency>
22     <groupId>org.codehaus.jackson</groupId>
23     <artifactId>jackson-mapper-asl</artifactId>
24     <version>1.9.12</version>
25 </dependency>
26 <dependency>
27     <groupId>org.codehaus.jackson</groupId>
28     <artifactId>jackson-jaxrs</artifactId>
29     <version>1.9.12</version>
30 </dependency>

引入Jar文件方式

從Jersey開發包中將如下庫複製的WEB-INF下的庫目錄：json

  • 服務器：jersey-server.jar 、jersey-container-servlet-core.jar、jersey-container-servlet.jar、javax.ws.rs-api-2.0.jarapi

  • 客戶端：jersey-client.jar瀏覽器

  • common：jersey-common.jar服務器

  • json支持：在Jersey2.0中須要使用Jackson1.9才能支持json。app

Hello World

如下將展現一個Hello World

第一步：編寫一個名爲HelloResource的資源，它接受Http Get請求並響應「Hello Jersey」

1 @Path("/hello")
2 public class HelloResource {
3     @GET
4     @Produces(MediaType.TEXT_PLAIN)
5     public String sayHello() {
6         return "Hello Jersey";
7     }
8 }

第二步：編寫JAX-RS application

01 public class APIApplication extends ResourceConfig {
02     public APIApplication() {
03         //加載Resource
04         register(HelloResource.class);
05  
06         //註冊數據轉換器
07         register(JacksonJsonProvider.class);
08  
09         // Logging.
10         register(LoggingFilter.class);
11     }
12 }

第三步：在web.xml文件中定義servelt調度程序，目的是將全部REST請求發送到Jersey容器。除了聲明Jersey Servlet外，還需定義一個初始化參數，指定JAX-RS application。

01 <!--用於定義 RESTful Web Service 接口-->
02 <servlet>
03     <servlet-name>JerseyServlet</servlet-name>
04     <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
05     <init-param>
06         <param-name>javax.ws.rs.Application</param-name>
07         <param-value>cn.com.mink.resource.APIApplication</param-value>
08     </init-param>
09  
10     <load-on-startup>1</load-on-startup>
11 </servlet>
12 <servlet-mapping>
13     <servlet-name>JerseyServlet</servlet-name>
14     <url-pattern>/services/*</url-pattern>
15 </servlet-mapping>

第四步：測試程序

在命令終端中輸入如下命令，將會看到「Hello Jersey」。

curl http://host:port/services/hello

或者在瀏覽器中輸入如下URL，將會看到「Hello Jersey」

http://host:port/services/hello

使用

資源

Root Resource And Sub-Resource

資源是組成RESTful服務的關鍵部分，能夠使用HTTP方法（如：GET、POST、PUT和DELETE）操做資源。在JAX-RX中，資源經過POJO實現，使用@Path 註釋組成其標識符。資源能夠有子資源，父資源是資源集合，子資源是成員資源。

在如下樣例代碼中，

Resources是」/services」 URI組成是集合資源，UserResource是「/services/user」 URI組成的成員資源;

01 @Path("/services")
02 public class Resources {
03  
04     @Path("/user")
05     public UserResource getUserResource() {
06         ...
07     }
08  
09     @Path("/book")
10     public BookResource getBookResource() {
11         ...
12     }
13 }

UserResource是「/user」 URI組成的集合資源，getUser是「/user/{username}」 URI組成的資源方法

1 @Path("/user")
2 public class UserResource {
3     @GET
4     @Path("{username"})
5     @Produces("application/json")
6     public User getUser(@PathParam("username") String userName) {
7         ...
8     }
9 }
HTTP Methods

HTTP方法映射到資源的CRUD（建立、讀取、更新和刪除）操做，基本模式以下：

  • HTTP GET：讀取/列出/檢索單個或資源集合。
  • HTTP POST：新建資源。
  • HTTP PUT：更新現有資源或資源集合。
  • HTTP DELETE：刪除資源或資源集合。
@Produces

@Produces註釋用來指定將要返回給client端的數據標識類型（MIME）。@Produces能夠做爲class註釋，也能夠做爲方法註釋，方法的@Produces註釋將會覆蓋class的註釋。

  • 指定一個MIME類型

    @Produces(「application/json」)

  • 指定多個MIME類型

    @Produces({「application/json」,「application/xml」})

@Consumes

@Consumes與@Produces相反，用來指定能夠接受client發送過來的MIME類型，一樣能夠用於class或者method，也能夠指定多個MIME類型，通常用於@PUT，@POST 。

參數（Parameter Annotations）

Parameter Annotations用於獲取client發送的數據。本文只介紹經常使用的註解，更多詳見Jersey用戶手冊

@PathParam

使用@PathParam能夠獲取URI中指定規則的參數，好比：

1 @GET
2 @Path("{username"})
3 @Produces(MediaType.APPLICATION_JSON)
4 public User getUser(@PathParam("username") String userName) {
5     ...
6 }

當瀏覽器請求http://localhost/user/jack時，userName值爲jack。

@QueryParam

@QueryParam用於獲取GET請求中的查詢參數，如：

1 @GET
2 @Path("/user")
3 @Produces("text/plain")
4 public User getUser(@QueryParam("name") String name,
5                     @QueryParam("age") int age) {
6     ...
7 }

當瀏覽器請求http://host:port/user?name=rose&age=25時，name值爲rose，age值爲25。若是須要爲參數設置默認值，能夠使用@DefaultValue，如：

1 @GET
2 @Path("/user")
3 @Produces("text/plain")
4 public User getUser(@QueryParam("name") String name,
5                     @DefaultValue("26") @QueryParam("age") int age) {
6     ...
7 }

當瀏覽器請求http://host:port/user?name=rose時，name值爲rose，age值爲26。

@FormParam

@FormParam，顧名思義，從POST請求的表單參數中獲取數據。如：

1 @POST
2 @Consumes("application/x-www-form-urlencoded")
3 public void post(@FormParam("name") String name) {
4     // Store the message
5 }
@BeanParam

當請求參數不少時，好比客戶端提交一個修改用戶的PUT請求，請求中包含不少項用戶信息。這時能夠用@BeanParam。

1 @POST
2 @Consumes("application/x-www-form-urlencoded")
3 public void update(@BeanParam User user) {
4     // Store the user data
5 }

User Bean定義以下：

01 @XmlRootElement(name = "user")
02 public class User {
03     @PathParam("userName)
04     private String userName;
05  
06     @FormParam("name")
07     private String name;
08  
09     @FormParam("telephone")
10     private String telephone;
11  
12     @FormParam("email")
13     private String email;
14  
15     public String getUserName() {
16         return userName;
17     }
18  
19     public void setUserName(String userName) {
20         this.userName = userName;
21     }
22     ...
23 }
使用Map

在一個大型的server中，由於參數的多變，參數結構的調整都會由於以上幾種方式而遇到問題，這時能夠考慮使用@Context 註釋，並獲取UriInfo實例，以下：

1 @GET
2 public String get(@Context UriInfo ui) {
3     MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
4     MultivaluedMap<String, String> pathParams = ui.getPathParameters();
5 }

一樣還能夠經過@Context 註釋獲取ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等，以下：

01 @Path("/")
02 public class Resource {
03  
04     @Context
05     HttpServletRequest req;
06  
07     @Context
08     ServletConfig servletConfig;
09  
10     @Context
11     ServletContext servletContext;
12  
13     @GET
14     public String get(@Context HttpHeaders hh) {
15         MultivaluedMap<String, String> headerParams = hh.getRequestHeaders();
16         Map<String, Cookie> pathParams = hh.getCookies();
17     }
18 }

Jersey返回Json和Xml

JAX-RS支持使用JAXB（Java API for XML Binding）將JavaBean綁定到XML或JSON，反之亦然。JavaBean必須使用@XmlRootElement標註，沒有@XmlElement註釋的字段將包含一個名稱與之相同的XML元素，以下：

01 @XmlRootElement
02 public class OptionResult {
03     @XmlElement(name = "code")
04     private String result;
05  
06     private String errorMsg;
07  
08     public String getResult() {
09         return result;
10     }
11  
12     public void setResult(String result) {
13         this.result = result;
14     }
15  
16     public String getErrorMsg() {
17         return errorMsg;
18     }
19  
20     public void setErrorMsg(String errorMsg) {
21         this.errorMsg = errorMsg;
22     }
23 }

而後在REST服務中使用：

1 @Path("/user")
2 public class UserResource {
3     @POST
4     @Produces("application/json")
5     public OptionResult create(@BeanParam User user) {
6         ...
7     }
8 }

最後，要註冊數據轉換器，該轉換器會自動將JavaBean轉換爲json數據：

01 public class APIApplication extends ResourceConfig {
02     public APIApplication() {
03         //加載Model
04         register(OptionResult.class);
05  
06         //加載與OptionResult同一個packge的Model
07
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程