轉:CXF學習筆記二：如何在Tomcat中建立、發布和訪問基於CXF的服務

詳細介紹了在tomcat容器中建立、發布和訪問CXF服務的步驟和各種方法。

一、伺服器端

1．添加CXF包

1）基本包：

commons-logging-1.1.1.jar

geronimo-activation_1.1_spec-1.0.2.jar

geronimo-annotation_1.0_spec-1.1.1.jar

geronimo-javamail_1.4_spec-1.6.jar

geronimo-jaxws_2.1_spec-1.0.jar

geronimo-servlet_2.5_spec-1.2.jar

geronimo-stax-api_1.0_spec-1.0.1.jar

geronimo-ws-metadata_2.0_spec-1.1.2.jar

jaxb-api-2.1.jar

jaxb-impl-2.1.12.jar

jetty-6.1.21.jar

jetty-util-6.1.21.jar

neethi-2.0.4.jar

saaj-api-1.3.jar

saaj-impl-1.3.2.jar

wsdl4j-1.6.2.jar

wstx-asl-3.2.8.jar

xml-resolver-1.2.jar

XmlSchema-1.4.5.jar

2）jsf和jstl（非必要，用MyEclipse建立Web Project時會自動加入，無須再添加）

jsf-api.jar

jsf-impl.jar

jstl-1.2.jar

3）cxf

cxf-2.2.4.jar

4）Spring jars，為XML Configuration添加Spring支援。

aopalliance-1.0.jar

spring-core-2.5.5.jar

spring-beans-2.5.5.jar

spring-context-2.5.5.jar

spring-web-2.5.5.jar

2．服務介面及實現

1）介面類，如HelloWorld.java：

package cxf.test;

import javax.jws.WebService;

@WebService

public interface HelloWorld

{

  // 一個簡單的方法,返回一個字串

String say(String hello);

}

2）實作類別，如HelloWorldImpl.java：

package cxf.test;

import javax.jws.WebService;  

// WebService實作類別. 

// 使用@WebService指向Interface定義類即可.  

@WebService(endpointInterface = "cxf.test.HelloWorld")  

public class HelloWorldImpl implements HelloWorld  

{  

    public String say(String hello)  

    {  

        return "hello " + hello;  

    }  

} 

3．服務配置

1）web.xml

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

<web-app version="2.5"

     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_2_5.xsd">

     <context-param>

        <param-name>contextConfigLocation</param-name>

        <param-value>WEB-INF/beans.xml</param-value>

    </context-param>

    <listener>

        <listener-class>

            org.springframework.web.context.ContextLoaderListener

        </listener-class>

    </listener>

     <servlet>

         <servlet-name>CXFServlet</servlet-name>

         <servlet-class>

              org.apache.cxf.transport.servlet.CXFServlet

         </servlet-class>

     </servlet>

     <servlet-mapping>

         <servlet-name>CXFServlet</servlet-name>

         <url-pattern>/services/*</url-pattern>

     </servlet-mapping>

</web-app>

2）beans.xml

<?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-extension-soap.xml" />

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

     <jaxws:endpoint id="webServiceHelloWorld"

         address="/HelloWorld"

         implementor="cxf.test.HelloWorldImpl"/>

</beans>

註：服務無需諸如index.jsp之類的配置，MyEclipse自動加入的可刪除，對服務及配置無任何影響。

4．服務發布（到Tomcat）

方法一：通過MyEclipse發布

點擊工具列  表徵圖，或者按右鍵項目 → MyEclipse → Add and Remove Project Deployments。

方法二：使用Ant。

二、用戶端

建立Web Project，執行下列步驟即可。無須設定web.xml。

1．添加CXF包

針對不同的方法，需要的包不盡相同。如下面“3．服務調用”的方法三，需要如下包：

commons-logging-1.1.1.jar

cxf-2.2.4.jar

neethi-2.0.4.jar

spring-core-2.5.5.jar

spring-beans-2.5.5.jar

spring-context-2.5.5.jar

wsdl4j-1.6.2.jar

XmlSchema-1.4.5.jar

2．擷取服務服務介面類（類似於C/C++中的.h標頭檔）

方法一：直接從原項目中copy

這當然是最簡單的方法，也是最“難”的方法（如果服務不是自己做的，顯然沒法獲得）。

方法二：從wsdl文檔中產生。

需要先安裝cxf程式包。產生步驟如下：

1）    安裝cxf，設定環境變數，如：D:\Apache\apache-cxf-2.2.4；同時，PATH後加上“;%CXF_HOME%\bin”（可選）。wsdl2java的用法如下：
wsdl2java –p 包名 –d 目錄名 wsdl路徑
如：wsdl2java –p demo.service.client –d e:\src htt://localhost:8080/helloWorld?wsdl
-p           指定其wsdl的命名空間，也就是要產生代碼的包名
-d           指定要產生代碼所在目錄
-client     產生用戶端測試web service的代碼
-server    產生伺服器啟動web service的代碼
-impl       產生web service的實現代碼
-ant         產生build.xml檔案
-compile  產生代碼後編譯
-quient    靜默模式，不輸出警告與錯誤資訊
-all          產生所有開始端點代碼：types,service proxy,service interface, server mainline, client mainline, implementation object, and an Ant build.xml file.

2）    執行wsdl2java批次程式，如：
wsdl2java -p cxf.test -d d:\src -server http://localhost:8080/CXFTomcat/services/ HelloWorld?wsdl

3）    將java介面類匯入項目。
上一步產生的java類檔案很多，一般的應用中只要將說明介面的那個類檔案匯入項目即可，如上例產生的HelloWorld.java檔案。

3．服務調用

方法一：使用jws的高層封裝，如：

package cxf.test;

import javax.xml.namespace.QName;

import javax.xml.ws.Service;

import javax.xml.ws.soap.SOAPBinding;

import cxf.test.HelloWorld;     // necessary

public final class Client {

    private static final QName SERVICE_NAME

        = new QName("http://test.cxf/", "HelloWorld");  // 首參為介面實作類別包名的反綴

    private static final QName PORT_NAME

        = new QName("http://test.cxf/", "HelloWorldPort");

    private Client() { }

    public static void main(String args[]) throws Exception {

        Service service = Service.create(SERVICE_NAME);

        // Endpoint Address

        String endpointAddress = "http://localhost:8080/CXFTomcat/services/HelloWorld";

        // Add a port to the Service

        service.addPort(PORT_NAME, SOAPBinding.SOAP11HTTP_BINDING, endpointAddress);

        HelloWorld hw = service.getPort(HelloWorld.class);

        System.out.println(hw.say("World"));

    }

}

方法二：使用較下層的代碼更加精確的控製程序的行為，如：

package cxf.test;

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

import cxf.test.HelloWorld;     // necessary

public final class Client {

    private Client() { }

    public static void main(String args[]) throws Exception {

      JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();

        factoryBean.getInInterceptors().add(new LoggingInInterceptor());（可選）

        factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());（可選）

      factoryBean.setServiceClass(cxf.test.HelloWorld.class);

      factoryBean.setAddress("http://localhost:8080/CXFTomcat/services/HelloWorld");

      HelloWorld client = (HelloWorld)factoryBean.create();

      System.out.println(client.say("God"));

      System.exit(0);

    }

}

備忘：LoggingInInterceptor和LoggingOutInterceptor是日誌攔截器，用於輸入和輸出時顯示日誌。使用與否並不影響程式的行為。

方法三：使用Spring，例如：

package cxf.test;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import cxf.test.HelloWorld; // necessary

public final class Client {

    private Client() { }

    public static void main(String args[]) throws Exception {

        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(new String[] {"cxf/test/client-beans.xml"});

        HelloWorld client = (HelloWorld)context.getBean("client");

        String response = client.say("Joe");

        System.out.println("Response: " + response);

        System.exit(0);

    }

}

注意：要想使用Spring來完成，在cxf.test包中必須有client-beans.xml存在，內容如下：

<?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/schema/jaxws.xsd">

    <bean id="client" class="cxf.test.HelloWorld"

      factory-bean="clientFactory" factory-method="create"/>

    <bean id="clientFactory" class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">

       <property name="serviceClass" value="cxf.test.HelloWorld"/>

       <property name="address" value="http://localhost:8080/CXFTomcat/services/HelloWorld"/>

     </bean>

</beans>

4．執行

Run As Java Application