JAX-RS(基于Jersey) + Spring 4.x + MyBatis构建REST服务架构

迈不过友情╰ 2021-12-24 13:27 170阅读 0赞

**0. 大背景**

众所周知，REST架构已经成为现代服务端的趋势。

很多公司，已经采用REST作为App, H5以及其它客户端的服务端架构。

**1. 什么是[JAX-RS][]?**

JAX-RS是JAVA EE6 引入的一个新技术。 JAX-RS即Java API for RESTful Web Services，是一个Java 编程语言的应用程序接口，支持按照表述性状态转移（REST）架构风格创建Web服务。

JAX-RS使用了Java SE5引入的Java标注来简化Web服务的客户端和服务端的开发和部署。  
Roy Fielding也参与了JAX-RS的制订，他在自己的博士论文中定义了REST。

对于那些想要构建RESTful Web Services的开发者来说，JAX-RS给出了不同于JAX-WS（JSR-224）的另一种解决方案。

JAX-RS提供了一些标注将一个资源类，一个POJO Java类，封装为Web资源。

基于JAX-RS实现的框架有Jersey，RESTEasy等。这两个框架创建的应用可以很方便地部署到Servlet 容器中，比如Tomcat，JBoss等。

值得一提的是RESTEasy是由JBoss公司开发的，所以将用RESTEasy框架实现的应用部署到JBoss服务器上，可以实现很多额外的功能。

目前共有4种JAX-RS实现，所有这些实现都支持Spring，Jersey则是JAX-RS的参考实现，也是本文所用的实现。

JAX-RS常用标注:  
@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。

**2. 为什么使用Spring + MyBatis?**

Spring我想就不必介绍了，做Java的都知道。

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。

2013年11月迁移到Github。  
MyBatis 是支持普通 SQL查询，存储过程和高级映射的优秀持久层框架。  
MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。

MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。

**目前Java EE开发的现状是：Hibernate的数据访问层地位已经在逐步下降，而更加轻量级的MyBati正在逐渐在中小型项目中崭露头角。**

**3. 开发前的准备工作**

首先，你要下载2个必须的jar, 一个是jersey, 另一个则是jersey-spring,由于jersey默认没有整合Spring，因此后一个jar特别重要。

如果，你还不知道从哪里下载，那么本博主提供了下载地址:

[http://www.coolbaba.net/Upload/Jar/Jersey-Jax.zip][http_www.coolbaba.net_Upload_Jar_Jersey-Jax.zip]

然后，新建一个空的Java Web项目，将下载的2个jar拷贝到你的项目并添加对它们的引用。

**4. 配置文件编辑**

需要准备2个配置文件，一个是spring-mybatis.xml,

它是Spring和MyBatis的整合配置文件。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:mvc="http://www.springframework.org/schema/mvc"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
                            http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
                            http://www.springframework.org/schema/context
                            http://www.springframework.org/schema/context/spring-context-3.1.xsd
                            http://www.springframework.org/schema/mvc
                            http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    
        
        <context:component-scan base-package="bbc" />
        
        <bean id="propertyConfigurer"
              class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
            <property name="location" value="classpath:jdbc.properties" />
        </bean>
    
        <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
              destroy-method="close">
            <property name="driverClassName" value="com.mysql.jdbc.Driver" />
            <property name="url" value="${jdbc.url}" />
            <property name="username" value="${jdbc.username}" />
            <property name="password" value="${jdbc.password}" />
            
            <property name="initialSize" value="${initialSize}"></property>
            
            <property name="maxActive" value="${maxActive}"></property>
            
            <property name="maxIdle" value="${maxIdle}"></property>
            
            <property name="minIdle" value="${minIdle}"></property>
            
            <property name="maxWait" value="${maxWait}"></property>
        </bean>
    
        
        <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
            <property name="dataSource" ref="dataSource" />
            
            <property name="mapperLocations" value="classpath:bbc/mapping/*.xml"></property>
            <property name="typeAliasesPackage" value="bbc.domain"/>
        </bean>
    
        
        <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
            <property name="basePackage" value="bbc.dao" />
            <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
        </bean>
    
        
        <bean id="transactionManager"
              class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
            <property name="dataSource" ref="dataSource" />
        </bean>
    
        
    </beans>

jdbc.properties配置如下：

jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8
    jdbc.username=your_username
    jdbc.password=your_password
    initialSize=0
    #定义最大连接数
    maxActive=20
    #定义最大空闲
    maxIdle=20
    #定义最小空闲
    minIdle=1
    #定义最长等待时间
    maxWait=60000

最后是web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://java.sun.com/xml/ns/javaee"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
              http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
               version="3.0">
        
        <filter>
            <filter-name>characterEncodingFilter</filter-name>
            <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
            <init-param>
                <param-name>encoding</param-name>
                <param-value>UTF-8</param-value>
            </init-param>
            <init-param>
                <param-name>forceEncoding</param-name>
                <param-value>true</param-value>
            </init-param>
        </filter>
        <filter-mapping>
            <filter-name>characterEncodingFilter</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>
    
        <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mybatis.xml</param-value>
        </context-param>
        <listener>
            <listener-class>
                org.springframework.web.context.ContextLoaderListener
            </listener-class>
        </listener>
    
        <servlet>
            <servlet-name>ComicJaxServlet</servlet-name>
            <servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
            <init-param>
                <param-name>com.sun.jersey.config.property.packages</param-name>
                <param-value>bbc.resource</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>ComicJaxServlet</servlet-name>
            <url-pattern>/resources/*</url-pattern>
        </servlet-mapping>
    </web-app>

上面有两处需要特别注意：

一是 servlet的配置处，class需要改成

**com.sun.jersey.spi.spring.container.servlet.SpringServlet**

而不是原来的

com.sun.jersey.spi.container.servlet.ServletContainer (错误！！)

二是init-param中bbc.resource是我的REST服务所在的包名，这里你可以改成你自己的。

**5. 编写domain pojo**

Series.java

package bbc.domain;
    
    /**
     * Created by KG on 16/11/24.
     */
    public class Series extends BaseDomain {
        private int id;
        private int sourceId;
        private String name;
        private String brief;
        private String address;
        private String folder;
        private String cover;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public int getSourceId() {
            return sourceId;
        }
    
        public void setSourceId(int sourceId) {
            this.sourceId = sourceId;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public String getBrief() {
            return brief;
        }
    
        public void setBrief(String brief) {
            this.brief = brief;
        }
    
        public String getAddress() {
            return address;
        }
    
        public void setAddress(String address) {
            this.address = address;
        }
    
        public String getFolder() {
            return folder;
        }
    
        public void setFolder(String folder) {
            this.folder = folder;
        }
    
        public String getCover() {
            return cover;
        }
    
        public void setCover(String cover) {
            this.cover = cover;
        }
    }

**6. 编写dao和映射文件**

SeriesDao.java

package bbc.dao;
    
    import bbc.domain.Series;
    
    import java.util.List;
    
    /**
     * Created by KG on 16/11/24.
     */
    public interface SeriesDao {
        List<Series> selectAllRecords();
    }

SeriesDao.xml

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    
    <mapper namespace="bbc.dao.SeriesDao" >
        <resultMap type="Series" id="SeriesResult">
            <id property="id" column="id" />
            <result property="sourceId" column="source_id" />
            <result property="name" column="name" />
            <result property="brief" column="brief" />
            <result property="address" column="address" />
            <result property="folder" column="folder" />
            <result property="cover" column="cover" />
            <result property="createTime" column="create_time" />
            <result property="lastUpda" column="last_upda" />
        </resultMap>
    
        <select id="selectAllRecords" resultType="Series" resultMap="SeriesResult">
    
            select *
            from series
    
        </select>
    </mapper>

**7. 编写REST服务，并将dao通过Spring注入服务**

SeriesResource.java

package bbc.resource;
    
    import bbc.dao.SeriesDao;
    import bbc.domain.Series;
    import bbc.service.SeriesService;
    import com.sun.jersey.api.core.InjectParam;
    import com.sun.jersey.spi.inject.Inject;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Scope;
    import org.springframework.stereotype.Component;
    import org.springframework.stereotype.Service;
    
    import javax.annotation.Resource;
    import javax.ws.rs.GET;
    import javax.ws.rs.Path;
    import javax.ws.rs.Produces;
    import java.util.List;
    
    /**
     * Created by KG on 16/11/24.
     */
    @Path("/series/")
    @Component
    @Scope("prototype")
    public class SeriesResource {
        @Autowired
        private SeriesDao seriesDao;
    
        @GET
        @Produces("application/json")
        public String getAllSeries() {
            List<Series> seriesList = seriesDao.selectAllRecords();
    
           ....
        }
    }

上面通过Autowired自动绑定dao接口的实现。

一般我们服务端中用的最多的是POST请求，如果是post的话也很简单，如下：

@Path("/some/")
    @Component
    public class SomeResource {
        @POST
        @Path("/testpost")
        @Produces("application/json")
        public String testPost(String request) {
            return "Response: " + request;
        }
    }

上面中参数request会自动收到客户端传过来的json字符串，然后你可以选择解析该json并且反序列化为pojo对象，进行后一步的操作，

最后把结果序列化成json丢回给客户端。

好了，一切大功告成！！

启动tomcat，你可以通过如下地址访问你的服务：

http://localhost:8080/resources/series

转载于:https://www.cnblogs.com/davidgu/p/6098911.html

[JAX-RS]: http://jcp.org/en/jsr/detail?id=311
[http_www.coolbaba.net_Upload_Jar_Jersey-Jax.zip]: http://www.coolbaba.net/Upload/Jar/Jersey-Jax.zip