使用CXF和Jersey框架來(lái)進(jìn)行Java的WebService編程
CXF
CXF是在xfire的基礎(chǔ)上實(shí)現(xiàn)的。
1)首先呢,還是包的問(wèn)題,在http://cxf.apache.org/download.html這里可以下到最新版的CXF,當(dāng)然,我用的是最新版的。接下來(lái)還是那句廢話,建WEB項(xiàng)目,放入JAR包。而JAR包我們就不選擇了,一堆全部放入。
我們會(huì)看到它包含了spring的JAR包,后面當(dāng)我們需要把CXF作為WEB項(xiàng)目部署時(shí),就需要用到spring的配置文件,這個(gè)后面再講。
還是接口類和實(shí)現(xiàn)類:
@WebService public interface IReaderService { public Reader getReader(@WebParam(name="name") String name,@WebParam(name="password") String password); public List<Reader> getReaders(); } @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; } }
這兩個(gè)類除了加入注解外,其他均和昨天講的webservice的一樣。這里就不多講了,對(duì)注解的解釋,大家可以看看JAVAEE的文檔。不過(guò)按意思應(yīng)該很容易理解的。
接下來(lái)就是JAVABEAN,還是那個(gè)Reader類:
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; } }
上面的已經(jīng)寫(xiě)完了。
2)我們要用做WEB項(xiàng)目嗎?不急,先不用,CXF自帶了一個(gè)輕量的容器服務(wù),相當(dāng)于spring自己提供了IOC容器一樣。我們可以先用它來(lái)測(cè)試一下我們部署成功沒(méi)。
直接來(lái)一個(gè)測(cè)試類:
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..."); }
簡(jiǎn)單得不得了吧。直接publish地址,然后指定接口或類就OK了。我這里用的是類,但盡量用接口,畢竟面向接口編程才是真正的面對(duì)對(duì)象思想。
我們啟動(dòng)看看結(jié)果:
我們看到啟動(dòng)已經(jīng)完成,接著啟動(dòng)瀏覽器看看是否成功了。
直接在瀏覽器輸入http://localhost:8080/readerService?wsdl,我們可以看到:
它生成了我們所需要的wsdl文件,說(shuō)明我們部署成功了。
3)部署成功后,我們就是要調(diào)用啦,它的調(diào)用也相當(dāng)簡(jiǎn)單,跟xfire類似,取得接口,然后就可以跟本地類一樣調(diào)用方法了。
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); }
這里很簡(jiǎn)單,也是取得一個(gè)工廠類,然后直接設(shè)接口和地址再create就可以得取相應(yīng)的接口了,這里跟xfire一樣,也是需要調(diào)用端先定義好接口原型,否則這些調(diào)用將無(wú)從說(shuō)起。
我們運(yùn)行得到結(jié)果:
沒(méi)問(wèn)題,跟我們預(yù)想的結(jié)果一致。
4)但很多情況下,我們并不希望我們的webservice和我們的應(yīng)用分開(kāi)兩個(gè)服務(wù)器,而希望他們?cè)谕粋€(gè)容器,tomcat或JBOSS或其他的,這樣我們就必須通過(guò)WEB來(lái)部署我們前面完成的webservice。
注意,我們這里需要用到spring定義文件。
首先看看web.xml:
<?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>
這里很簡(jiǎn)單,只是指定了spring的監(jiān)聽(tīng)器和相應(yīng)的配置文件路徑,并且指定了CXF的攔截方式。
接下來(lái)看看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="readerServicce2" implementor="com.cxf.servlet.ReaderService" address="/readerService2" /> </beans>
這里很簡(jiǎn)單,只是通過(guò)jaxws:endpoint定義了一個(gè)webservice,implementor是webservice的處理類,而address是它的訪問(wèn)路徑,跟我們前面寫(xiě)的readerService類似。
這時(shí)我們可以把它部署到tomcat中,通過(guò)http://localhost:8080/CXFWebservice/webservice/readerService2?wsdl可以直接訪問(wèn)。
有些朋友會(huì)問(wèn),為什么這次訪問(wèn)的URL跟前面的不一樣呢。其實(shí)前面的訪問(wèn)地址是我們自己定義的,而這里的webservice地址是我們?cè)谂渲梦募信渲煤玫?,并且是通過(guò)web項(xiàng)目來(lái)部署的,這里就需要用項(xiàng)目名稱,而且我們?cè)贑XFServlet那里配置了url-pattern是webservice,所以最后的URL就跟上面一致了。
我們可以看到效果:
這證明我們部署成功了。
可以再次用前面的測(cè)試類測(cè)試一下,注意,需要把a(bǔ)ddress修改成我們發(fā)布后的URL。
CXF相比xfire又更簡(jiǎn)潔了一些,雖然它增加了一些注解,但這些無(wú)傷大雅,它只是把以前的services.xml中的信息集中到類中,反而更方便維護(hù),但這還是見(jiàn)仁見(jiàn)智的,有些人就喜歡配置文件,而有些人就不喜歡。另外CXF的調(diào)用方式更加簡(jiǎn)潔,比起xfire它的代碼量更小了,是一個(gè)較大的進(jìn)步。
有些朋友在搭建的過(guò)程中出現(xiàn)了一些問(wèn)題,免去一個(gè)個(gè)回復(fù)了,這里放出代碼,有需要的朋友可以下載看看。
lib目錄下的所有包均沒(méi)有放入,把cxf的所有包放入即可。
注:所用IDE為idea,文件結(jié)構(gòu)跟eclipse不通用,如果需要在eclipse下使用的,可以直接復(fù)制代碼和文件到eclipse新建的項(xiàng)目即可。
Jersey
我們來(lái)看看它的基本用法。
直接來(lái)個(gè)項(xiàng)目看看。開(kāi)始項(xiàng)目之前大家還是先自己去下載包:https://maven.java.net/content/repositories/releases/com/sun/jersey/要運(yùn)行例子需要同時(shí)下載server和client。當(dāng)然不想找那么多,可以直接下這個(gè)zip包,https://maven.java.net/service/local/artifact/maven/redirect?r=releases&g=com.sun.jersey&a=jersey-archive&v=1.10&e=zip
1)直接來(lái)個(gè)JAVABEAN
@XmlRootElement public class Reader implements Serializable{ 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; } }
這里用到了一個(gè)標(biāo)簽,這里用到的表示它返回的時(shí)候的類型,即此Reader類可以用于XML返回。
2)來(lái)個(gè)service類,這時(shí)已經(jīng)不用像以前的CXF和xfire一樣要接口了,直接來(lái)個(gè)類就OK了。
@Path("/readerService/{name}/{password}") public class ReaderService { @GET @Produces(MediaType.APPLICATION_JSON) public Reader getReader(@PathParam("name") String name,@PathParam("password") String password) { return new Reader(name,password); } public static void main(String[] args) throws IllegalArgumentException, IOException, URISyntaxException { HttpServer server = HttpServerFactory.create("http://localhost:8080/"); server.start(); } }
這時(shí)用到了幾個(gè)標(biāo)簽,Path相信用過(guò)springMVC的朋友應(yīng)該知道這種寫(xiě)法,就是URL匹配,如果不清楚的,可以先去看看。Get標(biāo)簽表示這個(gè)方法只能通過(guò)Get方法來(lái)進(jìn)行訪問(wèn),而Produces表示生成的結(jié)果,它表示系統(tǒng)會(huì)把Reader對(duì)象封閉成JSON結(jié)果進(jìn)行返回。
如果不理解不要緊,等一下看結(jié)果就可以理解了。
而這時(shí)有一個(gè)main方法,相信有很大疑問(wèn)吧。這是jersey內(nèi)部提供的一個(gè)輕量級(jí)的內(nèi)部容器,它可以暫時(shí)供我們調(diào)試用,但真正使用肯定不能用這個(gè)。
3)我們寫(xiě)一個(gè)測(cè)試類
public class ReaderClient { public static void main(String[] args) { Client client = Client.create(); WebResource resource = client.resource("http://localhost:8080/readerService/shun/123213"); Reader reader = resource.get(Reader.class); System.out.println(reader); } }
很簡(jiǎn)單的代碼,應(yīng)該都看得懂的,一個(gè)client對(duì)象,請(qǐng)求webservice,返回一個(gè)resource,然后resource就直接調(diào)用相應(yīng)的方法,當(dāng)然這個(gè)方法是通過(guò)我們的URl來(lái)進(jìn)行匹配的。
這里我們先用它自帶的一個(gè)輕量級(jí)服務(wù)測(cè)試一下。直接運(yùn)行ReaderService,它里面有包含一個(gè)main方法,運(yùn)行后,我們?cè)龠\(yùn)行ReaderClient,我們可以看到結(jié)果為:
結(jié)果正確。
我們當(dāng)然不想就這樣用自帶的輕量級(jí)服務(wù)來(lái)作為我我們的服務(wù)器,我們需要放到和我們的項(xiàng)目在同一個(gè)服務(wù)器,比如tomcat,jboss等。
4)WEB項(xiàng)目當(dāng)然就少不了web.xml。
<?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"> <servlet> <servlet-name>Jersey Web Application</servlet-name> <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Jersey Web Application</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>
這時(shí)指定了rest路徑下的所有都將被jersey進(jìn)行攔截。
我們部署到tomcat下啟動(dòng)后再重新運(yùn)行readerClient,注意先要修改resource的路徑:
WebResource resource = client.resource("http://localhost:8080/jerseyWebService/rest/readerService/shun/123213");
我的項(xiàng)目名為jerseyWebService,請(qǐng)根據(jù)你的項(xiàng)目名進(jìn)行修改。
修改后,我們重新運(yùn)行,結(jié)果如下:
和上面的結(jié)果一致,說(shuō)明部署的效果是一樣的,也是正確的。
相關(guān)文章
詳解java一維數(shù)組及練習(xí)題實(shí)例
在本篇文章里小編給大家整理了關(guān)于java一維數(shù)組及練習(xí)題的相關(guān)知識(shí)點(diǎn)和實(shí)例代碼,有需要的朋友們跟著學(xué)習(xí)下。2019-07-07Spring?Cloud中Sentinel的兩種限流模式介紹
如何使用Sentinel做流量控制呢?這篇文章就來(lái)為大家詳細(xì)介紹了Spring?Cloud中Sentinel的兩種限流模式,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-05-05JavaWeb Servlet生命周期細(xì)枝末節(jié)處深究
Servlet指在服務(wù)器端執(zhí)行的一段Java代碼,可以接收用戶的請(qǐng)求和返回給用戶響應(yīng)結(jié)果,下面這篇文章主要給大家介紹了關(guān)于JavaWeb.servlet生命周期的相關(guān)資料,需要的朋友可以參考下2022-10-10springboot手動(dòng)動(dòng)態(tài)注入controller和service方式
這篇文章主要介紹了springboot手動(dòng)動(dòng)態(tài)注入controller和service方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03