spring boot 整合 resteasy+fastjson

时间:2022-07-26 07:28:30

一、resteasy简介

RESTEasy是JBoss的一个开源项目,提供各种框架帮助你构建RESTful Web Services和RESTful Java应用程序。它是JAX-RS规范的一个完整实现并通过JCP认证。作为一个JBOSS的项目,它当然能和JBOSS应用服务器很好地集成在一起。但是,它也能在任何运行JDK5或以上版本的Servlet容器中运行。RESTEasy还提供一个RESTEasy JAX-RS客户端调用框架。能够很方便与EJB、Seam、Guice、Spring和Spring MVC集成使用。支持在客户端与服务器端自动实现GZIP解压缩。

RESTEasy 项目是 JAX-RS 的一个实现,集成的一些亮点: 
•不需要配置文件,只要把JARs文件放到类路径里面,添加 @Path 标注就可以了。 
•完全的把 RESTEeasy 配置作为Seam 组件来看待。 
•HTTP 请求由Seam来提供,不需要一个额外的Servlet。 
•Resources 和providers可以作为 Seam components (JavaBean or EJB),具有全面的Seam injection,lifecycle, interception, 等功能支持。 
•支持在客户端与服务器端自动实现GZIP解压缩。 
名词解释: 
JAX-RS: Java API for RESTful Web Services是一个Java编程语言的应用程序接口,支持按照 表象化状态转变 (REST)架构风格创建Web服务Web服务[1]. JAX-RS使用了Java SE 5引入的Java 标注来简化Web服务客户端和服务端的开发和部署。 
规范内容 
JAX-RS提供了一些标注将一个资源类,一个POJOJava类,封装为Web资源。标注包括: 
@Path,标注资源类或方法的相对路径 
@GET,@PUT,@POST,@DELETE,标注方法是用的HTTP请求的类型 
@Produces,标注返回的MIME媒体类型 
@Consumes,标注可接受请求的MIME媒体类型 
@PathParam,@QueryParam,@HeaderParam,@CookieParam,@MatrixParam,@FormParam,分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。

二、spring集成resteasy的4种方式

1、集成在servlet3.0以下版本

2、集成在servlet3.0以上版本

3、spring mvc集成

4、使用第三方插件集成

1:

pom.xml依赖:

<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>jaxrs-api</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency>  
<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>resteasy-jaxrs</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency>  
<!-- Resteasy 集成 Jackson2 工具包 方便JSON 转换。 -->  
<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>resteasy-jackson2-provider</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency>  
<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>resteasy-jaxb-provider</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency>  
<!-- Reasteasy 集成Spring g工具包-->  
<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>resteasy-spring</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency> 

web.xml配置:

<servlet>
    <servlet-name>Resteasy</servlet-name>
    <servlet-class>
        org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
    </servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>com.restfully.shop.services.ShoppingApplication</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>Resteasy</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

2:

在1的基础上添加pom.xml

<dependency>  
    <groupId>org.jboss.resteasy</groupId>  
    <artifactId>resteasy-servlet-initializer</artifactId>  
    <version>${project.dependency.jboss.resteasy}</version>  
</dependency> 

web.xml配置

<!-- Start Resteasy   -->  
<listener>  
    <listener-class>org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap</listener-class>  
</listener>  
<!-- load Spring Context  -->  
<listener>  
    <listener-class>org.jboss.resteasy.plugins.spring.SpringContextLoaderListener</listener-class>  
</listener> 

3:

web.xml配置

<servlet>  
   <servlet-name>Spring</servlet-name>  
   <servlet-class>org.springframework.web.servlet.DispatcherServlet;</servlet-class>  
</servlet>  
<servlet-mapping>  
   <servlet-name>Spring</servlet-name>  
   <url-pattern>/*</url-pattern>  
</servlet-mapping>

4:

使用com.paypal.springboot集成插件

pom.xml

<dependency>
  <groupId>com.paypal.springboot</groupId>
  <artifactId>resteasy-spring-boot-starter</artifactId>
  <version>${resteasy-spring-boot-starter.version}</version>
</dependency>


三、集成fastjson

1.去掉默认的jackson-provider以及jaxb-provider依赖

默认情况下,resteasy使用jackson和jaxb来实现json及xml格式的序列化。应用启动时,会自动扫描带@Provider的包,找到最合适的provider。fastjson也提供了jax-rs的Provider实现,如果希望使用fastjson来替换默认的jackson,可以按如下步骤操作:

例如:

<dependency>
  <groupId>com.paypal.springboot</groupId>
  <artifactId>resteasy-spring-boot-starter</artifactId>
  <version>${resteasy-spring-boot-starter.version}</version>
  <exclusions>
    <exclusion>
      <groupId>org.jboss.resteasy</groupId>
      <artifactId>resteasy-jackson-provider</artifactId>
    </exclusion>
    <exclusion>
      <groupId>org.jboss.resteasy</groupId>
      <artifactId>resteasy-jackson2-provider</artifactId>
    </exclusion>
    <exclusion>
      <groupId>org.jboss.resteasy</groupId>
      <artifactId>resteasy-jaxb-provider</artifactId>
    </exclusion>
    <exclusion>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </exclusion>
  </exclusions>
</dependency>

2.修改web.xml或者修改application.properties

web.xml例如:

<context-param>
  <param-name>resteasy.scan.providers</param-name>
  <param-value>false</param-value>
</context-param>
<context-param>
  <param-name>resteasy.providers</param-name>
  <param-value>com.alibaba.fastjson.support.jaxrs.FastJsonProvider</param-value>
</context-param>

application.properties例如:

server.context-parameters.resteasy.scan.providers=false
server.context-parameters.resteasy.providers=com.alibaba.fastjson.support.jaxrs.FastJsonProvider