使用cxf，spring，mybatis框架完成restful风格的webservice服务

2019-11-06 08:28:23

字体：大中小

来源：转载

供稿：网友

使用cxf，sPRing，mybatis框架完成restful风格的webservice服务：

使用maven管理项目的jar包，pom文件下载相关的jar

代码块

pom.xml

代码块语法遵循标准markdown代码，例如：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.bst.basisApi</groupId> <artifactId>basisApi</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>war</packaging> <name>basisApi Maven Webapp</name> <url>http://maven.apache.org</url> <properties>  <spring.version>4.1.2.RELEASE</spring.version>  <mybatis.version>3.4.1</mybatis.version>  <slf4j.version>1.7.7</slf4j.version> <log4j.version>2.7</log4j.version> <cxf.version>3.0.4</cxf.version> </properties> <dependencies>  <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-oxm</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aop</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>${spring.version}</version> </dependency>  <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.1</version> </dependency>    <dependency> <groupId>com.microsoft.sqlserver</groupId> <artifactId>sqljdbc4</artifactId> <version>4.0</version> </dependency>  <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>${log4j.version}</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>${mybatis.version}</version> </dependency>  <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.10</version> </dependency>  <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.1.41</version> </dependency>  <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>${slf4j.version}</version> </dependency>  <dependency> <groupId>commons-dbcp</groupId> <artifactId>commons-dbcp</artifactId> <version>1.2.2</version> </dependency>   <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-core</artifactId> <version>${cxf.version}</version> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-rs-service-description</artifactId> <version>${cxf.version}</version> </dependency>  <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-bindings-soap</artifactId> <version>${cxf.version}</version> </dependency>  <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-bindings-xml</artifactId> <version>${cxf.version}</version> </dependency>  <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-simple</artifactId> <version>${cxf.version}</version> </dependency>  <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-ws-addr</artifactId> <version>${cxf.version}</version> </dependency>  <dependency> <groupId>javax.ws.rs</groupId> <artifactId>javax.ws.rs-api</artifactId> <version>2.0</version> </dependency>  <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxws</artifactId> <version>${cxf.version}</version> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxrs</artifactId> <version>${cxf.version}</version> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http</artifactId> <version>${cxf.version}</version> </dependency> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-jaxrs</artifactId> <version>1.9.12</version> </dependency> </dependencies> <build> <finalName>basisApi</finalName> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.6</version> <configuration> <skipTests>true</skipTests> <includeEmptyDirectories>true</includeEmptyDirectories> </configuration> </plugin> </plugins> </build></project>

整个spring与mybatis

jdbc.properties 数据库信息配置文件

mysql_driver=com.mysql.jdbc.Drivermysql_url=jdbc:mysql://localhost:3306/zyqgmysql_username=rootmysql_passWord=root#定义初始连接数mysql_initialSize=0#定义最大连接数mysql_maxActive=20#定义最大空闲mysql_maxIdle=20#定义最小空闲mysql_minIdle=1#定义最长等待时间mysql_maxWait=60000#定义接口请求的用户和密码（做访问验证）webservice.webserviceId=testwebservice.webservicePasswd=MTIzIUAjZnNh

日志文件

#定义LOG输出级别log4j.rootLogger=INFO,Console,File#定义日志输出目的地为控制台log4j.logger.java.sql.PreparedStatement=INFOlog4j.appender.Console=org.apache.log4j.ConsoleAppenderlog4j.appender.Console.Target=System.out#可以灵活地指定日志输出格式，下面一行是指定具体的格式log4j.appender.Console.layout = org.apache.log4j.PatternLayoutlog4j.appender.Console.layout.ConversionPattern=[%c] - %m%n#文件大小到达指定尺寸的时候产生一个新的文件log4j.appender.File = org.apache.log4j.RollingFileAppender#指定输出目录log4j.appender.File.File = logs/ssm.log#定义文件最大大小log4j.appender.File.MaxFileSize = 10MB# 输出所以日志，如果换成DEBUG表示输出DEBUG以上级别日志log4j.appender.File.Threshold = ALLlog4j.appender.File.layout = org.apache.log4j.PatternLayoutlog4j.appender.File.layout.ConversionPattern =[%p] [%d{yyyy-MM-dd HH/:mm/:ss}][%c]%m%n

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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd ">  <context:component-scan base-package="com.bst.basis"/>  <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="${ms_driver}" /> <property name="url" value="${ms_url}" /> <property name="username" value="${ms_username}" /> <property name="password" value="${ms_password}" />  <property name="initialSize" value="${ms_initialSize}"></property>  <property name="maxActive" value="${ms_maxActive}"></property>  <property name="maxIdle" value="${ms_maxIdle}"></property>  <property name="minIdle" value="${ms_minIdle}"></property>  <property name="maxWait" value="${ms_maxWait}"></property> </bean>  <bean id="sqlsessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource" />  <property name="mapperLocations" value="classpath:com/bst/basis/mapping/*/*.xml"></property> </bean>  <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.bst.basis.dao" /> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property> </bean>  <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource" /> </bean> <bean id="sysparameter" class="com.bst.basis.common.util.SysParameter"> <property name="webserviceId" value="${webservice.webserviceId}" /> <property name="webservicePasswd" value="${webservice.webservicePasswd}" /> </bean> </beans>

web.xml

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0"> <display-name>basisApi</display-name>  <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring-*.xml</param-value> </context-param>  <filter> <filter-name>encodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <async-supported>true</async-supported> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>encodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>  <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener>  <listener> <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class> </listener>  <servlet> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup>    </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> </web-app>

好了至此我们就已经通过maven搭建好了spring+myBatis+cxf的整个框架了，放入tomcat测试一下是否可以正常启动。这里写图片描述可以正常启动，说明整合没有问题；接下来编写代码首先编写bean（伪代码）

package com.bst.basis.dto;/** * 驾驶员信息 * * @author henry * @date 2017年3月1日上午11:27:57 * @version 1.0.0 * */public class QueryDrvierDto { private static final long serialVersionUID = -7726421850126740662L; private String stationCode; private String code; private String name; private String gender; private String telephone; private String idCard; private String drivingLicence; private String drivingCarType; private String qualificationNo; private String companyCode; private String companyName; private String status; private String createdAt; private String updatedAt; private String remark; public String getStationCode() { return stationCode; } public void setStationCode(String stationCode) { this.stationCode = stationCode; } public String getCode() { return code; } public void setCode(String code) { this.code = code; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getGender() { return gender; } public void setGender(String gender) { this.gender = gender; } public String getTelephone() { return telephone; } public void setTelephone(String telephone) { this.telephone = telephone; } public String getIdCard() { return idCard; } public void setIdCard(String idCard) { this.idCard = idCard; } public String getDrivingLicence() { return drivingLicence; } public void setDrivingLicence(String drivingLicence) { this.drivingLicence = drivingLicence; } public String getDrivingCarType() { return drivingCarType; } public void setDrivingCarType(String drivingCarType) { this.drivingCarType = drivingCarType; } public String getQualificationNo() { return qualificationNo; } public void setQualificationNo(String qualificationNo) { this.qualificationNo = qualificationNo; } public String getCompanyCode() { return companyCode; } public void setCompanyCode(String companyCode) { this.companyCode = companyCode; } public String getCompanyName() { return companyName; } public void setCompanyName(String companyName) { this.companyName = companyName; } public String getStatus() { return status; } public void setStatus(String status) { this.status = status; } public String getCreatedAt() { return createdAt; } public void setCreatedAt(String createdAt) { this.createdAt = createdAt; } public String getUpdatedAt() { return updatedAt; } public void setUpdatedAt(String updatedAt) { this.updatedAt = updatedAt; } public String getRemark() { return remark; } public void setRemark(String remark) { this.remark = remark; }}

dao交互，这里的方法名（selectDriver（））需要与mybatis的mapper.xml中的必须完成一致，否则mybatis解析xml时将找不到

接口信息

package com.bst.basis.dao;import java.util.List;import java.util.Map;import com.bst.basis.dto.*;/** * * @author henry * @date 2017年2月28日下午2:13:20 * @version 1.0.0 * */public interface IStationBasisDao { /** * 驾驶员信息 * @return */ public List<QueryDrvierDto> selectDriver();}<?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="com.bst.basis.dao.IStationBasisDao">  <select id="selectDriver" statementType="CALLABLE" resultType="com.bst.basis.dto.QueryDrvierDto"> select *from test_table </select></mapper>**定义需要暴露的接口*方法***@GET 表示请求的方式 @Path("/driver") 定义当前暴露的服务类请求根路径@Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON}) 返回的格式，支持两种返回格式，但只在返回为对象或List时才支持xml格式，如果返回类型为String则只能支持jsonpackage com.bst.basis.restful;import java.sql.Date;import javax.ws.rs.FormParam;import javax.ws.rs.GET;import javax.ws.rs.POST;import javax.ws.rs.PUT;import javax.ws.rs.Path;import javax.ws.rs.PathParam;import javax.ws.rs.Produces;import javax.ws.rs.QueryParam;import javax.ws.rs.core.MediaType;public interface IBasisService { /** * 驾驶员信息 * @return */ @GET @Path("/driver") @Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON}) public String queryDriver();}

暴露接口业务实现

package com.bst.basis.restful;import java.sql.Date;import java.util.HashMap;import java.util.List;import java.util.Map;import javax.annotation.Resource;import javax.ws.rs.PathParam;import javax.ws.rs.ext.Provider;import org.apache.log4j.Logger;import org.springframework.stereotype.Component;import com.alibaba.fastjson.JSON;import com.bst.basis.common.constant.ErrorCodeConstant;import com.bst.basis.common.util.Result;import com.bst.basis.dto.QueryDrvierDto;/** * * 小件对接，接口实现 * @author henry * @date 2017年2月28日下午2:25:48 * @version 1.0.0 * */@Component("basisService")@Provider public class BasisService implements IBasisService{ protected Logger log = Logger.getLogger(getClass()); @Resource private IStationBasisDao stationBasisDao;//通过注解注入dao public String queryDriver() { log.info("queryDriver"); List<QueryDrvierDto> list = null; String result = ""; try { list = stationBasisDao.selectDriver(); result = String.format(Result.RESULT_SUCCEED, JSON.toJSON(list)); } catch (Exception e) { e.printStackTrace(); log.error("queryDriver :"+e.getMessage()); result = String.format(Result.RESULT_FAIL, "001"); } return result; }}package com.bst.basis.common.util;/** * 统一定义所有服务接口返回格式 * * @author henry * @date 2017年2月28日下午8:19:45 * @version 1.0.0 * */public class Result { /**成功：{/"success/":true,/"error_code/":/"/",/"data/":%s}**/ public static final String RESULT_SUCCEED ="{/"success/":true,/"error_code/":/"/",/"data/":%s}"; /**失败：{/"success/":true,/"error_code/":/"/",/"data/":%s}**/ public static final String RESULT_FAIL = "{/"success/":false,/"error_code/":/"%s/",/"data/":[]}"; /**失败,带错误信息：{/"success/":true,/"error_code/":/"/",/"data/":%s}**/ public static final String RESULT_FAIL_MS = "{/"success/":false,/"error_code/":/"%s/",/"data/":[{message:/"%s/"}]}";}

参数读取类

package com.bst.basis.common.util;public class SysParameter { public static final int CODE_OK=0; public static final int CODE_USERNAMEPWD_ERROR=10; public static final int CODE_USERTOKEN_ERROR=11; public static final int CODE_FORMAT_ERROR=12; private static String stationId; private static String stationName; private static String webserviceId; private static String webservicePasswd; public static String getStationId() { return stationId; } public static void setStationId(String stationId) { SysParameter.stationId = stationId; } public static String getStationName() { return stationName; } public static void setStationName(String stationName) { SysParameter.stationName = stationName; } public static String getWebserviceId() { return webserviceId; } public static void setWebserviceId(String webserviceId) { SysParameter.webserviceId = webserviceId; } public static String getWebservicePasswd() { return webservicePasswd; } public static void setWebservicePasswd(String webservicePasswd) { SysParameter.webservicePasswd = webservicePasswd; }}

权限拦截（最简单实现）

package com.bst.basis.restful.interceptor;import java.util.List;import java.util.Map;import org.apache.cxf.interceptor.Fault;import org.apache.cxf.message.Message;import org.apache.cxf.phase.Phase;import org.apache.cxf.phase.AbstractPhaseInterceptor;import org.apache.log4j.Logger;import com.bst.basis.common.util.SysParameter;/** * 接口访问认证拦截器 * @author henry * @date 2017年2月28日下午8:21:44 * @version 1.0.0 * */public class AuthInterceptor extends AbstractPhaseInterceptor<Message>{ private final Logger logger = Logger.getLogger(getClass()); public AuthInterceptor() { super(Phase.PRE_INVOKE); } public void handleMessage(Message message) throws Fault { logger.info("AuthInterceptor Message=="+message); Map<String,List<String>> headers = (Map<String, List<String>>) message.get(Message.PROTOCOL_HEADERS); List<String> account = headers.get("AgentAccount"); List<String> key = headers.get("AgentKey"); if(account == null || key == null){ throw new Fault(new IllegalArgumentException("未填写认证信息")); }else if(!account.get(0).equals(SysParameter.getWebserviceId()) || !key.get(0).equals(SysParameter.getWebservicePasswd())){ throw new Fault(new IllegalArgumentException("认证信息填写错误，请联系接口服务商！")); } }}

restful服务暴露配置

<?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:jaxws="http://cxf.apache.org/jaxws" xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd"> <import resource="classpath:META-INF/cxf/cxf.xml" /> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />   <context:component-scan base-package="com.bst.basis"/> <bean id="inMessageInterceptor" class="org.apache.cxf.interceptor.LoggingInInterceptor" /> <bean id="outMessageInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>  <bean id="authInterceptor" class="com.bst.basis.restful.interceptor.AuthInterceptor"/>  <jaxrs:server id="brServices" address="/services/carStation"> <jaxrs:serviceBeans> <ref bean="basisService" /> </jaxrs:serviceBeans> <jaxrs:inInterceptors> <ref bean="inMessageInterceptor"/> <ref bean="authInterceptor"/> </jaxrs:inInterceptors>  <jaxrs:outInterceptors> <ref bean="outMessageInterceptor"/> </jaxrs:outInterceptors> <jaxrs:providers> <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider" /> </jaxrs:providers> <jaxrs:extensionMappings> <entry key="json" value="application/json"/> <entry key="xml" value="application/xml"/> </jaxrs:extensionMappings> <jaxrs:languageMappings> <entry key="en" value="en-gb"/> </jaxrs:languageMappings> </jaxrs:server> </beans>

到此我们就已完成所有编码工作，下面部署到tomcat进行测试；

启动如图