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

旧城等待， 2022-05-20 04:13 195阅读 0赞

### 概述 ###

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

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

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

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

### 项目搭建 ###

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

项目的整体目录如下：

![70][]

**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>
       
       <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-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>
             
             <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>
             <plugins>
                <plugin>
                   <artifactId>maven-clean-plugin</artifactId>
                   <version>3.0.0</version>
                </plugin>
                
                <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>
    
       
       <listener>
          <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
       </listener>
       <listener>
          <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
       </listener>
    
       
       <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>
    
       
       <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**

**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="org.codehaus.jackson.jaxrs.JacksonJsonProvider"/>
          </jaxrs:providers>
          <jaxrs:extensionMappings>
             <entry key="json" value="application/json"/>
             <entry key="xml" value="application/xml"/>
          </jaxrs:extensionMappings>
          
             
          
       </jaxrs:server>
    
    
       
       <bean id="httpClientFactory" class="org.springframework.http.client.SimpleClientHttpRequestFactory">
          
          <property name="connectTimeout" value="4000"/>
          
          <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>
                
             </list>
          </property>
       </bean>
    
       
       
       <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>
          
          
    
          
       </bean>
    
       
       <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相关的代码结构如下图：

![70 1][]

具体代码如下：

<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，在最下方能看到。

![70 2][]

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

![70 3][]

[70]: /images/20220520/e03777b24fe0452ba994efa372787a00.png
[70 1]: /images/20220520/d6843f953ff74778a3d001e86ee75357.png
[70 2]: /images/20220520/a33e2c68e4a246e78557bc442af61e57.png
[70 3]: /images/20220520/4c0174fd744d4f988b4061f0abffe330.png