概述

Jersey RESTful 框架是開源的RESTful框架, 實現(xiàn)了JAX-RS (JSR 311 & JSR 339) 規(guī)范。它擴展了JAX-RS 參考實現(xiàn)， 提供了更多的特性和工具， 可以進一步地簡化 RESTful service 和 client 開發(fā)。盡管相對年輕，它已經(jīng)是一個產(chǎn)品級的 RESTful service 和 client 框架。與Struts類似，它同樣可以和hibernate,spring框架整合。

jersey1.X使用的是sun的com.sun.jersey

jersey2.X使用的是glassfish的org.glassfish.jersey

Jersey與JAX-RS的關(guān)系：

Jersey是一個框架，實現(xiàn)了restful風格；JAX-RS也實現(xiàn)了restful風格。那么Jersey與JAX-RS是什么關(guān)系呢？我們可以這樣理解：JAX-RS是java自己的一個小的框架，實現(xiàn)了restful風格，只不過功能不是很強大；而Jersey呢，它是一個比較成熟的restful框架了，它在設(shè)計的時候，是基于JAX-RS的，它使用了java的JAX-RS的一些注解，當然了，他也有自己的特有注解，以及其他更強大的功能。

如果你更喜歡REST端點的JAX-RS編程模型，則可以使用可用的實現(xiàn)之一，而不是Spring MVC。Jersey和Apache CXF開箱即用就可以很好地工作。CXF要求你在應(yīng)用程序上下文中將其Servlet或過濾器注冊為@Bean。Jersey原生支持Spring，所以我們在Spring Boot中也為它提供了自動配置支持，還有一個starter。

要開始使用Jersey，需要把spring-boot-starter-jersey作為依賴，然后需要一個ResourceConfig類型的@Bean，用來注冊所有端點，如下面的例子所示:

示例：?

@Component
public class MyJerseyConfig extends ResourceConfig {
  public MyJerseyConfig() {
    register(MyEndpoint.class);
  }
}

Jersey對掃描可執(zhí)行檔案的支持相當有限。例如，當運行一個可執(zhí)行的war文件時，它不能掃描在完全可執(zhí)行的jar文件或WEB-INF/classes中找到的包中的端點。為了避免這種限制，不應(yīng)該使用packages方法，而應(yīng)該使用register方法單獨注冊端點，如上例所示。

對于更高級的定制，你還可以注冊任意數(shù)量實現(xiàn)了ResourceConfigCustomizer的bean。所有注冊的Endpoint都應(yīng)該是帶有HTTP資源注解的@Components (@GET等)，如下面的例子所示:?

@Component
@Path("/hello")
public class MyEndpoint {
  @GET
  public String message() {
    return "Hello";
  }
}

JAX-RS注解

一、@Path

一個Java類要能夠處理REST請求，則這個類必須至少添加一個@Path("/")的注解；對于方法，這個注解是可選的，如果不添加，則繼承類的定義。

@Path里的值可以是一個復雜的表達式，例如@Path("/{id}") ，其中 {id}表達式表示一個路徑請求的一部分。

@Path也支持正則表達式，例如： @Path("{id: \\d+}") ，其中 \\d+ 表示一個數(shù)字。

二、@Method

一個方法上只有添加了某個Http Method的注解，例如@GET，才會生效。

對于資源的具體操作類型，由HTTP動詞表示。

常用的HTTP動詞有下面五個：

GET（SELECT）：從服務(wù)器取出資源（一項或多項）

POST（CREATE）：在服務(wù)器新建一個資源

PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）

PATCH（UPDATE）：在服務(wù)器更新資源（客戶端提供改變的屬性）

DELETE（DELETE）：從服務(wù)器刪除資源

還有兩個不常用的Method。

HEAD：獲取資源的元數(shù)據(jù)

OPTIONS：一般由瀏覽器自動發(fā)起，用于描述目標資源的通信選項。

下面是一些例子：

GET /uses：列出所有用戶

POST /users：新建用戶

GET /users/ID：獲取指定id用戶的信息

PUT /users/ID：更新指定id用戶的信息

PATCH /users/ID：更新指定id用戶的信息

DELETE /users/ID：刪除指定id用戶

GET /users/ID/addresses：列出指定id用戶的所有住址信息

DELETE /users/ID/addresses/ID：刪除指定id用戶下的指定地址id信息

三：Accept和Content-Type的區(qū)別

Accept就表示接口要返回給客戶端的數(shù)據(jù)格式，

Content-Type表示客戶端發(fā)送給服務(wù)器端的數(shù)據(jù)格式。

四：@Produces

定義資源類或javax.ws.rs.ext.MessageBodyWriter的方法可以生成的媒體類型。如果沒有指定，那么容器將假定可以生成任何類型。方法級注釋覆蓋類級注釋。容器負責確保調(diào)用的方法能夠生成HTTP請求中請求的一種媒體類型。如果沒有這樣的方法可用，容器必須以RFC 2616指定的HTTP“406 Not accepted”作為響應(yīng)。

有幾種格式如下：

@Produces("text/plain") 文本類型

@Produces("text/html") Html類型

@Produces({"application/xml"}) Xml類型

@Produces({ "application/json"}) Json類型

可以一次注解兩種或多種的MIME類型，格式如：{"application/xml", "application/json"}這表示兩者都可以使用，但是選擇的時候一般會選擇前者，即application/xml,因為它第一次出現(xiàn)。

五：@Consumes

定義資源類或javax.ws.rs.ext.MessageBodyReader的方法可以接受的媒體類型。如果沒有指定，容器將假定任何媒體類型都是可接受的。方法級注釋覆蓋類級注釋。容器負責確保所調(diào)用的方法能夠使用HTTP請求實體的媒體類型。如果沒有這樣的方法可用，容器必須按照RFC 2616的規(guī)定，以HTTP“415 Unsupported Media Type”作為響應(yīng)。

六：@QueryParam與@PathParam區(qū)別

@QueryParam：指定的是URL中的參數(shù)是以鍵值對的形式出現(xiàn)的,而在程序中

@QueryParam("id") Integer id獲取請求參數(shù)id

如：URL輸入為:/api/users?id=1

@PathParam：參數(shù)作為路徑的一部分

如：/api/users/1

Jersey詳細配置

在SpringBoot中引入如下依賴?

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-jersey</artifactId>
</dependency>

引入上面的依賴后，接下來我們只需要定義繼承ResourceConfig類型的Bean即可。Jersey的自動配置其中有一個條件就是當前的CLASSPATH中有ResourceConfig類型的Bean才生效，如下：?

@Configuration(proxyBeanMethods = false)
@ConditionalOnBean(type = "org.glassfish.jersey.server.ResourceConfig")
@EnableConfigurationProperties(JerseyProperties.class)
public class JerseyAutoConfiguration implements ServletContextAware {
}

其中@ConditionalOnBean條件限制了只有當前容器中有ResourceConfig類型的Bean該自動配置才會生效。

注冊繼承ResourceConfig后請求又是如何被匹配的？

當上面的自動配置生效后，默認情況下會注冊一個Servlet：?

public class JerseyAutoConfiguration implements ServletContextAware {
  @Bean
  @ConditionalOnMissingBean
  public JerseyApplicationPath jerseyApplicationPath() {
    return new DefaultJerseyApplicationPath(this.jersey.getApplicationPath(), this.config);
  }
  @Bean
  @ConditionalOnMissingBean(name = "jerseyFilterRegistration")
  @ConditionalOnProperty(prefix = "spring.jersey", name = "type", havingValue = "filter")
  public FilterRegistrationBean<ServletContainer> jerseyFilterRegistration(JerseyApplicationPath applicationPath) {
    FilterRegistrationBean<ServletContainer> registration = new FilterRegistrationBean<>();
    registration.setFilter(new ServletContainer(this.config));
    // ...
    return registration;
  }
  @Bean
  @ConditionalOnMissingBean(name = "jerseyServletRegistration")
  @ConditionalOnProperty(prefix = "spring.jersey", name = "type", havingValue = "servlet", matchIfMissing = true)
  public ServletRegistrationBean<ServletContainer> jerseyServletRegistration(JerseyApplicationPath applicationPath) {
    ServletRegistrationBean<ServletContainer> registration = new ServletRegistrationBean<>(
      new ServletContainer(this.config), applicationPath.getUrlMapping());
    addInitParameters(registration);
    registration.setName(getServletRegistrationName());
    registration.setLoadOnStartup(this.jersey.getServlet().getLoadOnStartup());
    return registration;
  }
}

上面列出了Filter及Servlet，根據(jù)上面的配置知道，在沒有手動在配置文件中設(shè)置spring.jersey.type=filter，那么默認就是servlet生效。

向容器注冊了ServletContainer Servlet程序，該Servlet程序傳入了自定義的ResourceConfig及默認的該Servlet請求Mapping地址默認是/*。

ServletContainer

該Servlet傳入了ResourceConfig：?

public class JerseyAutoConfiguration implements ServletContextAware {
  // 通過構(gòu)造函數(shù)注入ResourceConfig類型的Bean
  private final ResourceConfig config;
  public JerseyAutoConfiguration(JerseyProperties jersey, ResourceConfig config,
    ObjectProvider<ResourceConfigCustomizer> customizers) {
    this.jersey = jersey;
    this.config = config;
    customizers.orderedStream().forEach((customizer) -> customizer.customize(this.config));
  }
}

個性化配置ResourceConfig

要想個性化定制配置，可以注冊任意數(shù)量的實現(xiàn)ResourceConfigCustomizer的bean。?

@Component
public class CustomResourceConfigCustomizer implements ResourceConfigCustomizer {

  @Override
  public void customize(ResourceConfig config) {
    // 個性化定制配置
  }

}

配置應(yīng)用請求路徑

@Component
// 添加此注解所有的api接口都需要添加/api前綴
@ApplicationPath("/api")
public class JerseyConfig extends ResourceConfig {
}

配置文件方式?

spring:
  jersey:
    type: servlet
    # 該配置會覆蓋@ApplicationPath
    application-path: /api-a

示例：?

@Component
@Path("/users")
public class UserEndpoint {

  @Path("/{id}")
  @GET
  @Produces({"application/json"})
  public User queryUser(@PathParam("id") Integer id) {
    return new User(id, "姓名 - " + id, 6 + id) ;
  }
  
}

完畢?。?！