CXF+Spring搭建webservice服務

    Apache CXF 是一個開源的 Services 框架，CXF 幫助您利用 Frontend 編程 API 來構建和開發 Services ，像 JAX-WS 。這些 Services 可以支持多種協議，比如：SOAP、XML/HTTP、RESTful HTTP 或者 CORBA ，並且可以在多種傳輸協議上運行，比如：HTTP、JMS 或者 JBI，CXF 大大簡化了 Services 的創建，同時它繼承了 XFire 傳統，一樣可以天然地和 Spring 進行無縫集成。

　　先貼出maven項目的pom.xml，這里使用了spring，而且有坑，spring的版本選用太新會啟動不了服務器，后改為3.X版本才好。

　　

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.bigbang</groupId>
    <artifactId>cxf</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>cxf Maven Webapp</name>
    <url>http://maven.apache.org</url>
    <properties>
        <cxf.version>3.1.11</cxf.version>
        <spring.version>3.1.0.RELEASE</spring.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </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-transports-http</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <!-- Jetty is needed if you're are not using the CXFServlet -->
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http-jetty</artifactId>
            <version>${cxf.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</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-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.mortbay.jetty</groupId>
                <artifactId>maven-jetty-plugin</artifactId>
                <version>6.1.26</version>
                <configuration>
                    <webAppConfig>
                        <contextPath>/</contextPath>
                    </webAppConfig>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
        <finalName>cxf</finalName>
    </build>
    
</project>

 　　項目web.xml文件的配置如下：

　　

 <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath*:/application*.xml</param-value>
  </context-param>
  <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>/service/*</url-pattern>
  </servlet-mapping>
  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

　　其中CXFServlet是要訪問的webservice入口配置。

　　Spring文件的相關配置如下：

　　

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

    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />
    
    <bean id="loginService"  class="com.bigbang.cxf.service.LoginServiceImpl"/>
    <jaxws:endpoint implementor="#loginService" address="/login"/>
</beans>

　　需要引入jax-ws的命名空間。並且引入兩個xml配置文件，這兩個文件在cxf的包里面，可以不用關心。 此處配置了一個bean，該bean是實現webservice服務的實現類。里面是具體的業務邏輯。

　　jaxws：endpoint是配置webservice端地址的，implementor指向一個實現類，address是webservice的訪問地址。結合web.xml里面的cxfServlet配置，訪問webservice的地址應該為：http://IP：端口/項目名/service/login?wsdl

　　webservice的接口和實現類如下：

　　接口類：

　　

package com.bigbang.cxf.service;

import javax.jws.WebParam;
import javax.jws.WebService;

/**
 * @author pzj
 *
 */
@WebService
public interface LoginService {
    
    String login(@WebParam(name="name")String name,@WebParam(name="password")String password);
}

　　@webservice注解說明這是一個webservice類，@WebParam是指明webservice接口方法的參數名稱。類似於springmvc的@requestParam注解。此處如果不指明參數名稱，webservice的wsdl文件里將使用arg0,arg1...代替，在寫客戶端代碼請求webservice的時候，將引起困擾，不易編寫代碼。　　

　　實現類為：

　　

package com.bigbang.cxf.service;

import javax.jws.WebService;

/**
 * @author pzj 2017年5月16日 下午4:58:43
 *
 */
@WebService(endpointInterface="com.bigbang.cxf.service.LoginService")
public class LoginServiceImpl implements LoginService {

    /* (non-Javadoc)
     * @see com.bigbang.cxf.LoginService#login(java.lang.String, java.lang.String)
     */
    @Override
    public String login(String name, String password) {
        return name+"登錄成功！密碼是："+password;
    }

}

 

　　和上面接口不同的是，此處需要指明終端接口類的地址（包名+類名）。

　　全部准備好之后，使用jetty啟動，會顯示如下啟動信息：

　　

五月 18, 2017 9:58:05 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
信息: Creating Service {http://service.cxf.bigbang.com/}LoginServiceImplService from class com.bigbang.cxf.service.LoginService
五月 18, 2017 9:58:06 上午 org.apache.cxf.endpoint.ServerImpl initDestination
信息: Setting the server's publish address to be /login
2017-05-18 09:58:06.173:INFO:oejs.AbstractConnector:Started SelectChannelConnector@0.0.0.0:8080

　　說明webservice發布成功了，訪問http://localhost:8080/service/login?wsdl，會生成xml頁面：

　　

This XML file does not appear to have any style information associated with it. The document tree is shown below.
<wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://service.cxf.bigbang.com/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" name="LoginServiceImplService" targetNamespace="http://service.cxf.bigbang.com/">
<wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://service.cxf.bigbang.com/" elementFormDefault="unqualified" targetNamespace="http://service.cxf.bigbang.com/" version="1.0">
<xs:element name="login" type="tns:login"/>
<xs:element name="loginResponse" type="tns:loginResponse"/>
<xs:complexType name="login">
<xs:sequence>
<xs:element minOccurs="0" name="name" type="xs:string"/>
<xs:element minOccurs="0" name="password" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="loginResponse">
<xs:sequence>
<xs:element minOccurs="0" name="return" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
</wsdl:types>
<wsdl:message name="login">
<wsdl:part element="tns:login" name="parameters"></wsdl:part>
</wsdl:message>
<wsdl:message name="loginResponse">
<wsdl:part element="tns:loginResponse" name="parameters"></wsdl:part>
</wsdl:message>
<wsdl:portType name="LoginService">
<wsdl:operation name="login">
<wsdl:input message="tns:login" name="login"></wsdl:input>
<wsdl:output message="tns:loginResponse" name="loginResponse"></wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="LoginServiceImplServiceSoapBinding" type="tns:LoginService">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="login">
<soap:operation soapAction="" style="document"/>
<wsdl:input name="login">
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output name="loginResponse">
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="LoginServiceImplService">
<wsdl:port binding="tns:LoginServiceImplServiceSoapBinding" name="LoginServiceImplPort">
<soap:address location="http://localhost:8080/service/login"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>