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. }  

@WebService
public 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自帶了一個輕量的容器服務，至關於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新建的項目便可。