CXF+JAX-RS搭建RESTful风格的WebService

其他 2018-12-28 16:10:03 阅读次数: 0

概述

        因公司要实现两个不同项目之间的RESTful接口访问，技术选型是CXF和JAX-RS。接下来要解决的事情是：

        1，在两个项目中加入CXF和JAX-RS；

        2，测试，看是否能否访问成功。

        下面主要来说明这两个问题，如果说清楚了，基本使用应该不成问题了，当然过程中对CXF和JAX-RS有更多的理解，通过本次搭建项目能够理解使用和原理性的内容就非常好了。

项目搭建

        项目使用SpringMVC，在此基础加上CXF和JAX-RS。使用的是Idea工具。

        项目的整体目录如下：

        

        1，引入jar文件。pom.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>

<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.me</groupId>
   <artifactId>capabilityService</artifactId>
   <version>1.0-SNAPSHOT</version>
   <packaging>war</packaging>

   <name>capabilityService Maven Webapp</name>
   <!-- FIXME change it to the project's website -->
   <url>http://www.example.com</url>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <maven.compiler.source>1.7</maven.compiler.source>
      <maven.compiler.target>1.7</maven.compiler.target>
      <cxf.version>3.2.5</cxf.version>
      <logback.version>1.1.8</logback.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.11</version>
         <scope>test</scope>
      </dependency>

      <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-webmvc</artifactId>
         <version>4.2.5.RELEASE</version>
         <exclusions>
            <exclusion>
               <artifactId>commons-logging</artifactId>
               <groupId>commons-logging</groupId>
            </exclusion>
         </exclusions>
      </dependency>

      <dependency>
         <groupId>com.alibaba</groupId>
         <artifactId>fastjson</artifactId>
         <version>1.2.32</version>
      </dependency>

      <dependency>
         <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
         <version>1.16.12</version>
      </dependency>

      <dependency>
         <groupId>com.alibaba</groupId>
         <artifactId>druid</artifactId>
         <version>1.1.10</version>
      </dependency>

      <dependency>
         <groupId>javax.servlet.jsp</groupId>
         <artifactId>javax.servlet.jsp-api</artifactId>
         <version>2.3.1</version>
         <scope>provided</scope>
      </dependency>

      <dependency>
         <groupId>org.apache.commons</groupId>
         <artifactId>commons-lang3</artifactId>
         <version>3.5</version>
      </dependency>

      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-transports-http</artifactId>
         <version>${cxf.version}</version>
         <exclusions>
            <exclusion>
               <artifactId>stax2-api</artifactId>
               <groupId>org.codehaus.woodstox</groupId>
            </exclusion>
         </exclusions>
      </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-bundle-jaxrs</artifactId>-->
         <!--<version>2.7.0</version>-->
      <!--</dependency>-->
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-frontend-jaxrs</artifactId>
         <version>${cxf.version}</version>
      </dependency>
      <dependency>
         <groupId>org.codehaus.jettison</groupId>
         <artifactId>jettison</artifactId>
         <version>1.3.5</version>
      </dependency>
      <dependency>
         <!-- 如果CXF不集成到Web服务器中，必须添加该引用 -->
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-transports-http-jetty</artifactId>
         <version>${cxf.version}</version>
         <exclusions>
            <exclusion>
               <artifactId>slf4j-api</artifactId>
               <groupId>org.slf4j</groupId>
            </exclusion>
         </exclusions>
      </dependency>
      <dependency>
         <groupId>axis</groupId>
         <artifactId>axis</artifactId>
         <version>1.4</version>
         <exclusions>
            <exclusion>
               <artifactId>commons-logging</artifactId>
               <groupId>commons-logging</groupId>
            </exclusion>
         </exclusions>
      </dependency>
      <dependency>
         <groupId>org.codehaus.woodstox</groupId>
         <artifactId>stax2-api</artifactId>
         <version>3.1.1</version>
      </dependency>
      <dependency>
         <groupId>org.codehaus.jackson</groupId>
         <artifactId>jackson-jaxrs</artifactId>
         <version>1.9.13</version>
      </dependency>
      <dependency>
         <groupId>com.fasterxml.jackson.jaxrs</groupId>
         <artifactId>jackson-jaxrs-json-provider</artifactId>
         <version>2.5.0</version>
      </dependency>

      <dependency>
         <groupId>javax.ws.rs</groupId>
         <artifactId>jsr311-api</artifactId>
         <version>1.1.1</version>
      </dependency>

      <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>1.7.7</version>
      </dependency>
      <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>jcl-over-slf4j</artifactId>
         <version>1.7.25</version>
         <exclusions>
            <exclusion>
               <artifactId>slf4j-api</artifactId>
               <groupId>org.slf4j</groupId>
            </exclusion>
         </exclusions>
      </dependency>
      <dependency>
         <groupId>ch.qos.logback</groupId>
         <artifactId>logback-core</artifactId>
         <version>${logback.version}</version>
      </dependency>
      <dependency>
         <groupId>ch.qos.logback</groupId>
         <artifactId>logback-access</artifactId>
         <version>${logback.version}</version>
      </dependency>
      <dependency>
         <groupId>ch.qos.logback</groupId>
         <artifactId>logback-classic</artifactId>
         <version>${logback.version}</version>
         <exclusions>
            <exclusion>
               <artifactId>slf4j-api</artifactId>
               <groupId>org.slf4j</groupId>
            </exclusion>
         </exclusions>
      </dependency>
   </dependencies>

   <build>
      <finalName>capabilityService</finalName>
      <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
         <plugins>
            <plugin>
               <artifactId>maven-clean-plugin</artifactId>
               <version>3.0.0</version>
            </plugin>
            <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
            <plugin>
               <artifactId>maven-resources-plugin</artifactId>
               <version>3.0.2</version>
            </plugin>
            <plugin>
               <artifactId>maven-compiler-plugin</artifactId>
               <version>3.7.0</version>
               <configuration>
                  <source>1.8</source>
                  <target>1.8</target>
               </configuration>
            </plugin>
            <plugin>
               <artifactId>maven-surefire-plugin</artifactId>
               <version>2.20.1</version>
            </plugin>
            <plugin>
               <artifactId>maven-war-plugin</artifactId>
               <version>3.2.0</version>
            </plugin>
            <plugin>
               <artifactId>maven-install-plugin</artifactId>
               <version>2.5.2</version>
            </plugin>
            <plugin>
               <artifactId>maven-deploy-plugin</artifactId>
               <version>2.8.2</version>
            </plugin>
         </plugins>
      </pluginManagement>
   </build>

</project>

        2，配置web.xml文件。文件内容如下： 

        其中， cxf的访问路径是/itil/*，这样在访问的时候输入的路径就是http:localhost:port/itil/了，当然现在还访问，但是先确定的基本访问的URL，后面则在此基础上进行补充。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
       version="3.1">

   <display-name>Archetype Created Web Application</display-name>
   <context-param>
      <param-name>webAppRootKey</param-name>
      <param-value>com.woxing.root</param-value>
   </context-param>
   <context-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring-mvc.xml</param-value>
   </context-param>

   <!-- spring context listener -->
   <listener>
      <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
   </listener>
   <listener>
      <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
   </listener>

   <!-- SpringMVC -->
   <servlet>
      <servlet-name>spring</servlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
      <init-param>
         <param-name>contextConfigLocation</param-name>
         <param-value>classpath:spring-mvc.xml</param-value>
      </init-param>
      <load-on-startup>1</load-on-startup>
   </servlet>
   <servlet-mapping>
      <servlet-name>spring</servlet-name>
      <url-pattern>/</url-pattern>
   </servlet-mapping>

   <!--webservice-->
   <servlet>
      <servlet-name>CXFService</servlet-name>
      <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
      <init-param>
         <param-name>hide-service-list-page</param-name>
         <param-value>false</param-value>
      </init-param>
   </servlet>
   <servlet-mapping>
      <servlet-name>CXFService</servlet-name>
      <url-pattern>/itil/*</url-pattern>
   </servlet-mapping>

   <!-- 避免乱码 -->
   <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>
      <init-param>
         <param-name>forceEncoding</param-name>
         <param-value>true</param-value>
      </init-param>
   </filter>
   <filter-mapping>
      <filter-name>encodingFilter</filter-name>
      <url-pattern>/*</url-pattern>
   </filter-mapping>

</web-app>

        3，配置springMVC

        

<?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.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd">

   <!-- 配置包扫描器 -->
   <context:component-scan base-package="com.woxing.capability.interfaces.impl,
         com.woxing.capability.engine,com.woxing.capability.execute" />

   <!-- 配置注解驱动 -->
   <mvc:annotation-driven/>

   <!-- 视图解析器 -->
   <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
      <property name="prefix" value="/WEB-INF/view/"/>
      <property name="suffix" value=".jsp"/>
   </bean>

   <mvc:resources location="/js/" mapping="/js/**"/>
   <mvc:resources location="/css/" mapping="/css/**"/>
   <mvc:resources location="/plugins/bootstrap3.3.5/" mapping="/bootstrap3.3.5/**"/>
   <mvc:resources location="/plugins/assets/" mapping="/assets/**"/>
   <mvc:resources location="/plugins/ztree/" mapping="/ztree/**"/>
   <!--<mvc:resources location="/json/" mapping="/json/**"/>-->

   <import resource="classpath:spring-ws.xml" />

</beans>

        4，配置cxf和JAX-RS

        配置的地址是/capabilityWs，访问的时候就需要加上这个地址。注意address不能配置为/或者“”，否则会访问不了。

<?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:jaxrs="http://cxf.apache.org/jaxrs"
      xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">

   <import resource="classpath:META-INF/cxf/cxf.xml" />

   <jaxrs:server id="capabilityWs" address="/capabilityWs">
      <jaxrs:serviceBeans>
         <ref bean="capabilityServiceInterface"/>
      </jaxrs:serviceBeans>
      <jaxrs:providers>
         <!--<bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"/>-->
         <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>


   <!--Http client Factory-->
   <bean id="httpClientFactory" class="org.springframework.http.client.SimpleClientHttpRequestFactory">
      <!-- 连接超时时间，ms -->
      <property name="connectTimeout" value="4000"/>
      <!-- 读写超时时间，ms -->
      <property name="readTimeout" value="9000"/>
   </bean>

   <bean id="fastJsonHttpMessageConverter"
        class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
      <property name="supportedMediaTypes">
         <list>
            <value>application/json;charset=UTF-8</value>
            <value>text/html;charset=utf-8</value>
         </list>
      </property>
      <!-- 定义输出时的格式转换 -->
      <property name="features">
         <list>
            <value>WriteMapNullValue</value>
            <!-- 空值是否输出 -->
            <value>QuoteFieldNames</value>
            <!-- 序列化输出字段，使用引号 -->
            <value>WriteNullStringAsEmpty</value>
            <!-- 字符类型字段如果为null，输出为"" -->
         </list>
      </property>
   </bean>

   <!-- 配置RestTemplate -->
   <!--RestTemplate-->
   <bean id="restTemplate" class="org.springframework.web.client.RestTemplate">
      <constructor-arg ref="httpClientFactory"/>
      <property name="messageConverters">
         <list>
            <ref bean="fastJsonHttpMessageConverter"/>
            <bean id="stringHttpMessageConverter" class="org.springframework.http.converter.StringHttpMessageConverter">
               <constructor-arg value="UTF-8"/>
            </bean>
            <bean id="formHttpMessageConverter" class="org.springframework.http.converter.FormHttpMessageConverter"/>
         </list>
      </property>
      <!-- 拦截器 -->
      <!--<property name="interceptors">-->

      <!--</property>-->
   </bean>

   <!--RestTemplate-->
   <bean id="asyncRestTemplate" class="org.springframework.web.client.AsyncRestTemplate">
      <constructor-arg ref="httpClientFactory"/>
      <property name="messageConverters">
         <list>
            <ref bean="fastJsonHttpMessageConverter"/>
         </list>
      </property>
   </bean>

</beans>

        5，编写代码。与CXF和JAX-RS相关的代码结构如下图：

        

        具体代码如下：

<strong>CapabilityServiceInterface.java</strong>
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

/**
 * @Author: Qinc
 * @Description:
 * @Date: Created
 * @Modified By:
 */


//@Path("")
@Produces({MediaType.APPLICATION_JSON + ";charset=UTF-8", MediaType.APPLICATION_XML})
public interface CapabilityServiceInterface {

    @GET
    @Path(value = "/getTest")
    @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
    String test();

}
<strong>CapabilityServiceInterfaceImpl.java</strong>
import com.alibaba.druid.support.json.JSONUtils;
import com.woxing.capability.interfaces.CapabilityServiceInterface;
import org.springframework.stereotype.Service;

import java.util.HashMap;

/**
 * @Author: Qinciwen
 * @Description:
 * @Date: Created in 17:47 2018/7/12
 * @Modified By:
 */

@Service("capabilityServiceInterface")
public class CapabilityServiceInterfaceImpl implements CapabilityServiceInterface{


    @Override
    public String test(){
        System.out.print("00000");
        HashMap<String, String> map = new HashMap<>();
        map.put("name", "小明");
        map.put("sex", "男");
        return JSONUtils.toJSONString(map);
    }

}

        这里的代码写的很简单，主要是为了测试。下面开始测试。

测试

        Idea自带的有测试工具，所以测试很方便。点击Tools——>Test RESTful Web Service，在最下方能看到。

        

        如下图所示，测试成功！！

猜你喜欢

转载自blog.csdn.net/qinxian20120/article/details/81011339
今日推荐
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
报告：Django 仍然是 74% 开发者的首选
《2024 年一季度互联网投融资运行情况》研究报告
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
面壁智能发布 Eurux-8x22B 开源大模型 —— 堪称「理科状元」
开源日报 | 谷歌扶持鸿蒙上位；开源Rabbit R1；Docker加持的安卓手机；微软的焦虑和野心；海尔电器把开放平台关了
周排行
计算机组成与设计（七）—— 除法器
Integer Approximation(分治+枚举)
大话数据库索引
windows10系统JDK的配置及下载地址
mysql实现秒值转换中原六仔平台搭建
Codeforces Round #556 (Div. 1)
百练1064 网线主管
Codeforces 995F Cowmpany Cowmpensation
子集生成之增量构造法，位向量法，二进制法
ERROR: cmd.exe failed with args /c "/APK\gradle\rungradle.bat...
每日归档
更多
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022