JAX-RS与Jersey简介
1. JAX-RS简介
在Java EE 6 中引入了对 JSR-311 的支持。JSR-311(也就是JAX-RS:Java API for RESTful Web Services)旨在定义一个统一的规范,它的核心概念是resource,也就是面向资源。JAX-RS使得 Java 程序员可以使用一套固定的接口来开发 REST 应用,避免了依赖于第三方框架。同时,JAX-RS 使用 POJO 编程模型和基于注解的配置,并集成了 JAXB,从而可以有效缩短 REST 应用的开发周期。
JAX-RS 定义的 API 位于 jakarta.ws.rs 包中,其中一些主要的接口、注解和抽象类如下图所示。
可以把 JAX-RS 理解为是一套开发协议,该协议具体的实现由第三方来完成,例如 Sun 的实现 Jersey框架、Apache 的 CXF框架 以及 JBoss 的 RESTEasy框架。
其中Jersey,RESTEasy这两个框架创建的应用,可以很方便地部署到Servlet 容器中,比如Tomcat,JBoss等。
2. Jersey框架简介
ersey是对JAX-RS(JSR311)协议的实现,用于构建RESTful Web Service,可以进一步地简化 RESTful service 和 client 的开发。
也就是说Jersey是一个RESTful框架,与SpringMVC框架类似,但是使用上面和SpringMVC又有不同。此外Jersey还提供一些额外的API和扩展机制,所以我们可以按照自己的需要对Jersey进行扩展。
Jersey的一大特点就是,基于Jersey的REST应用,可以运行在Servlet环境下面,也可以脱离该环境。
常用注解
注解 | 说明 |
---|---|
@Consumes | 注释代表的是一个资源可以接受的 MIME 类型。 |
@Produces | 注释代表的是一个资源可以返回的 MIME 类型。 |
@PathParam | 获取url中指定参数名称 |
@QueryParam | 获取get请求中的查询参数 |
@DefaultValue | 参数设置默认值 |
@FormParam | 用于提取请求中媒体类型为”application/x-www-form-urlencoded” 的参数,根据相应的表单类型提取其中的参数。 |
@BeanParam | 获取请求参数中的数据,用实体Bean进行封装 |
@GET, @PUT, @POST, @DELETE, @HEAD | resource method designator,与HTTP规范中定义的方法一致。这些方法决定资源的行为。 |
@MatrixParam | 从url片段中提取参数,即url中冒号后面的参数。 |
@HeaderParam | 从请求的头部提取Header。 |
@CookieParam | 提取cookie。 |
@Context | Context注解一般用于获取request或者response相关的上下文,例如UriInfo。 |
spring boot 使用jersey
引入jersey的依赖包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jersey</artifactId>
</dependency>
对Jersey进行配置
Springboot中对Jersey的配置有三种方式:
- 第一种方式创建一个自定义的ResourceConfig;
- 第二种方式,返回一个ResourceConfig类型的@Bean;
- 第三种方式,配置一组ResourceConfigCustomizer对象
第一种配置方式来讲解如何实现配置
import a.y.z.web.HelloResource;
import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.context.annotation.Configuration;
import javax.ws.rs.ApplicationPath;
/**
* @Description Description
* @Author 一一哥Sun
* @Date Created in 2020/3/28
* @ApplicationPath("shop")资源根路径。
*/
@Configuration
@ApplicationPath("shop")
public class JerseyConfig extends ResourceConfig {
public JerseyConfig() {
register(HelloResource.class);
}
}
Springboot默认把Jersey的根路径映射在/*上;如果要更改默认的根路径设置,对于自定义的ResourceConfig方式来说,可以在类上面添加一个@ApplicationPath注解即可。
我们也可以在application.properties中添加配置来改变项目的根路径:
spring.jersey.application-path=shop
另外,Spring Boot建议在使用ResourceConfig添加资源类的时候,不要使用ResourceConfig类的packages方法去自动扫描,建议还是手动添加。
Jersey和Springboot的集成有两种方式,一种是使用Filter的方式注册,一种是使用Servlet的方式注册,默认使用的是Servlet的方式,也可以通过spring.jersey.type=filter或者通过spring.jersey.type=servlet来控制。
spring.jersey.type=servlet
如果使用Servlet的方式启动,默认是使用的延迟启动。 jerseyServletRegistration方法的代码就可以看出来:
egistration.setName(getServletRegistrationName());
registration.setLoadOnStartup(this.jersey.getServlet().getLoadOnStartup());
return registration;
第二句代码setLoadOnStartup方法,调用的是this.jersey.getServlet().getLoadOnStartup(),而这个地方的jersey就是JerseyProperties对象:
@ConfigurationProperties(prefix = "spring.jersey")
public class JerseyProperties {...}
其中servlet的类代码为:
public static class Servlet {
/**
* Load on startup priority of the Jersey servlet.
*/
private int loadOnStartup = -1;
public int getLoadOnStartup() {
return this.loadOnStartup;
}
public void setLoadOnStartup(int loadOnStartup) {
this.loadOnStartup = loadOnStartup;
}
}
可以看到,默认值为-1。 那么我们只需要在application.properties中配置spring.jersey.servlet.loadOnStartup=1即可立即让Jersey的Servlet实例化。
spring.jersey.servlet.loadOnStartup=1