JAVA webservice之CXF

標籤：

昨天我們一起學習了一下xfire，今天我們來看一下CXF，為什麼學完那個接著學這個呢。因為CXF是在xfire的基礎上實現

的，所以我們學習它會比較簡單點，畢竟我們昨天剛看過了xfire的實現方法。廢話少說，直接來例子。

1）首先呢，還是包的問題，在http://cxf.apache.org/download.html這裡可以下到最新版的CXF，當然，我用的是最新版的。接下來還是那句廢話，建WEB項目，放入JAR包。而JAR包我們就不選擇了，一堆全部放入。

我們會看到它包含了spring的JAR包，後面當我們需要把CXF作為WEB項目部署時，就需要用到spring的設定檔，這個後面再講。

還是介面類和實作類別：

Java代碼  

1. @WebService   

2. public interface IReaderService {  

3.     public Reader getReader(@WebParam(name="name") String name,@WebParam(name="password") String password);  

4.     public List<Reader> getReaders();  

5. }  

@WebServicepublic interface IReaderService {public Reader getReader(@WebParam(name="name") String name,@WebParam(name="password") String password);public List<Reader> getReaders();}

Java代碼  

1. @WebService (endpointInterface="com.cxf.servlet.IReaderService",serviceName="readerService")  

2. public class ReaderService implements IReaderService{  

3.     public Reader getReader(@WebParam(name="name") String name,@WebParam(name="password") String password) {  

4.         return new Reader(name,password);  

5.     }  

6.       

7.     public List<Reader> getReaders(){  

8.         List<Reader> readerList = new ArrayList<Reader>();  

9.         readerList.add(new Reader("shun1","123"));  

10.         readerList.add(new Reader("shun2","123"));  

11.         return readerList;  

12.     }  

13. }  

@WebService(endpointInterface="com.cxf.servlet.IReaderService",serviceName="readerService")public class ReaderService implements IReaderService{public Reader getReader(@WebParam(name="name") String name,@WebParam(name="password") String password) {return new Reader(name,password);}public List<Reader> getReaders(){List<Reader> readerList = new ArrayList<Reader>();readerList.add(new Reader("shun1","123"));readerList.add(new Reader("shun2","123"));return readerList;}}

 這兩個類除了加入註解外，其他均和昨天講的webservice的一樣。這裡就不多講了，對註解的解釋，大家可以看看JAVAEE的文檔。不過按意思應該很容易理解的。

接下來就是JAVABEAN，還是那個Reader類：

Java代碼  

1. public class Reader{  

2.     private static final long serialVersionUID = 1L;  

3.     private String name;  

4.     private String password;  

5.       

6.     public Reader(){}  

7.     public Reader(String name,String password) {  

8.         this.name = name;  

9.         this.password = password;  

10.     }  

11.     //Get/Set方法省略  

12.     public String toString(){  

13.         return "Name:"+name+",Password:"+password;  

14.     }  

15.       

16. }  

public class Reader{private static final long serialVersionUID = 1L;private String name;private String password;public Reader(){}public Reader(String name,String password) {this.name = name;this.password = password;}//Get/Set方法省略public String toString(){return "Name:"+name+",Password:"+password;}}

 上面的已經寫完了。

2）我們要用做WEB項目嗎？不急，先不用，CXF內建了一個輕量的Container Service，相當於spring自己提供了IOC容器一樣。我們可以先用它來測試一下我們部署成功沒。

直接來一個測試類別：

Java代碼  

1. public static void main(String[] args) {  

2.         System.out.println("Server is starting...");  

3.         ReaderService readerService = new ReaderService();  

4.         Endpoint.publish("http://localhost:8080/readerService",readerService);  

5.         System.out.println("Server is started...");  

6.     }  

public static void main(String[] args) {System.out.println("Server is starting...");ReaderService readerService = new ReaderService();Endpoint.publish("http://localhost:8080/readerService",readerService);System.out.println("Server is started...");}

 簡單得不得了吧。直接publish地址，然後指定介面或類就OK了。我這裡用的是類，但盡量用介面，畢竟面向介面編程才是真正的面對對象思想。

我們啟動看看結果：

 我們看到啟動已經完成，接著啟動瀏覽器看看是否成功了。

直接在瀏覽器輸入http://localhost:8080/readerService?wsdl，我們可以看到：

 它產生了我們所需要的wsdl檔案，說明我們部署成功了。

3）部署成功後，我們就是要調用啦，它的調用也相當簡單，跟xfire類似，取得介面，然後就可以跟本地類一樣調用方法了。

Java代碼  

1. public static void main(String[] args) {  

2.         JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();  

3.         factoryBean.setServiceClass(IReaderService.class);  

4.         factoryBean.setAddress("http://localhost:8080/readerService");  

5.           

6.         IReaderService readerService = (IReaderService)factoryBean.create();  

7.         Reader reader = readerService.getReader("shun","123");  

8.         System.out.println("Reader:"+reader);  

9.     }  

public static void main(String[] args) {JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();factoryBean.setServiceClass(IReaderService.class);factoryBean.setAddress("http://localhost:8080/readerService");IReaderService readerService = (IReaderService)factoryBean.create();Reader reader = readerService.getReader("shun","123");System.out.println("Reader:"+reader);}

 這裡很簡單，也是取得一個工廠類，然後直接設介面和地址再create就可以得取相應的介面了，這裡跟xfire一樣，也是需要調用端先定義好介面原型，否則這些調用將無從說起。

我們運行得到結果：

 沒問題，跟我們預想的結果一致。

 

4）但很多情況下，我們並不希望我們的webservice和我們的應用分開兩個伺服器，而希望他們在同一個容器，tomcat或JBOSS或其他的，這樣我們就必須通過WEB來部署我們前面完成的webservice。

注意，我們這裡需要用到spring定義檔案。

首先看看web.xml:

Java代碼  

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

2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

3.     xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"  

4.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"  

5.     id="WebApp_ID" version="3.0">  

6.       

7.     <context-param>  

8.         <param-name>contextConfigLocation</param-name>  

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

10.     </context-param>  

11.       

12.     <listener>  

13.         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  

14.     </listener>  

15.       

16.     <servlet>  

17.         <servlet-name>CXFServlet</servlet-name>  

18.         <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>  

19.     </servlet>  

20.     <servlet-mapping>  

21.         <servlet-name>CXFServlet</servlet-name>  

22.         <url-pattern>/webservice/*</url-pattern>  

23.     </servlet-mapping>  

24. </web-app>  

<?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" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"id="WebApp_ID" version="3.0"><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>/webservice/*</url-pattern></servlet-mapping></web-app>

 這裡很簡單，只是指定了spring的監聽器和相應的設定檔路徑，並且指定了CXF的攔截方式。

接下來看看beans.xml:

Java代碼  

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

2. <beans xmlns="http://www.springframework.org/schema/beans"  

3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

4.     xmlns:jaxws="http://cxf.apache.org/jaxws"  

5.     xsi:schemaLocation="  

6.         http://www.springframework.org/schema/beans  

7.         http://www.springframework.org/schema/beans/spring-beans.xsd  

8.         http://cxf.apache.org/jaxws  

9.         http://cxf.apache.org/schemas/jaxws.xsd">  

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

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

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

13.       

14.     <jaxws:endpoint id="readerServicce2"  

15.         implementor="com.cxf.servlet.ReaderService" address="/readerService2" />  

16. </beans>  

<?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="readerServicce2"        implementor="com.cxf.servlet.ReaderService" address="/readerService2" /></beans>

 這裡很簡單，只是通過jaxws:endpoint定義了一個webservice，implementor是webservice的處理類，而address是它的訪問路徑，跟我們前面寫的readerService類似。

這時我們可以把它部署到tomcat中，通過http://localhost:8080/CXFWebservice/webservice/readerService2?wsdl可以直接存取。

 

有些朋友會問，為什麼這次訪問的URL跟前面的不一樣呢。其實前面的訪問地址是我們自己定義的，而這裡的webservice地址是我們在設定檔中配置好的，並且是通過web項目來部署的，這裡就需要用項目名稱，而且我們在CXFServlet那裡配置了url-pattern是webservice，所以最後的URL就跟上面一致了。

我們可以看到效果：

 這證明我們部署成功了。

 

可以再次用前面的測試類別測試一下，注意，需要把address修改成我們發布後的URL。

CXF相比xfire又更簡潔了一些，雖然它增加了一些註解，但這些無傷大雅，它只是把以前的services.xml中的資訊集中到類中，反而更方便維護，但這還是見仁見智的，有些人就喜歡設定檔，而有些人就不喜歡。另外CXF的調用方式更加簡潔，比起xfire它的代碼量更小了，是一個較大的進步。

 

有些朋友在搭建的過程中出現了一些問題，免去一個個回複了，這裡放出代碼，有需要的朋友可以下載看看。

lib目錄下的所有包均沒有放入，把cxf的所有包放入即可。

註：所用IDE為idea，檔案結構跟eclipse不通用，如果需要在eclipse下使用的，可以直接複製代碼和檔案到eclipse建立的項目即可。

JAVA webservice之CXF