史上最詳cxf-Springmvc-maven實現webservice教程(轉)

雖知道webservice，工做兩年一直沒使用過，最近不忙趁機研究了下，實現了簡單的服務端及客戶端調用。鑑於慕課網沒有webservice的教程，大多又都是學生，就在這裏跟你們分享下，內容比較詳細。大神請忽略，若有錯誤之處，敬請指點。
第一步，下載cxf及配置環境變量。
Source Distribution爲源碼版，須要編譯後使用，鄙人小白，沒有搞過這種東西。咱們下載Binary Distribution（可執行版），下載後解壓便可。

做爲java經常使用工具，最好在環境變量裏配置一下，另cxf-3.1.8須要jdk1.6以上
在系統變量裏的Path中添加（注意兩個變量之間要有分號）

在cmd中輸入wsdl2java -help輸出一大堆

證實配置成功
第二步，普通項目，java-api實現webservice
1.接口

@WebService public interface MyWebService { int add(int a, int b); int minus(int a, int b); }

2.實現類

@WebService(endpointInterface = "webservice.webserviceJAX.server.MyWebService") public class MyWebserviceImpl implements MyWebService { @Override public int add(int a, int b) { System.out.println(a+"+"+b+"="+(a+b)); return a+b; } @Override public int minus(int a, int b) { System.out.println(a+"-"+b+"="+(a-b)); return a-b; } }

3.發佈

public class MyServer { public static void main(String args[]) { String address = "http://localhost:8888/ms"; Endpoint.publish(address, new MyWebserviceImpl()); } }

錯誤信息：Cannot find any registered HttpDestinationFactory from the Bus.
解決辦法：添加cxf的jetty支持

<dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http-jetty</artifactId> <version>3.1.8</version> </dependency>

這時，能夠打開瀏覽器並輸入http://localhost:8888/ms?wsdl，能夠看到暴漏的wsdl

4.客戶端調用

public class MyClient { public static void main(String args[]) { try { URL url = new URL("http://localhost:8888/ms?wsdl"); //命名空間 及 名稱 QName qName = new QName("http://server.webserviceJAX.webservice/","MyWebserviceImplService"); Service service = Service.create(url, qName); MyWebService myWebservice = service.getPort(MyWebService.class); System.out.println(myWebservice.add(2, 3)); System.out.println(myWebservice.minus(2, 3)); } catch (MalformedURLException e) { e.printStackTrace(); } } }

控制檯輸出正確結果 5和 -1
第三部，spring spring-mvc cxf結合
1.建立項目並添加spring spring-mvc cxf的依賴

<properties> <spring.version>4.3.3.RELEASE</spring.version> </properties> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> <!--spring--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</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-webmvc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http</artifactId> <version>3.1.8</version> </dependency> <!--web service 如下都是cxf必備的--> <!--org.apache.cxf.transport.servlet.CXFServlet--> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http</artifactId> <version>3.1.8</version> </dependency> <!--不加這個包會報錯Unable to locate spring NamespaceHandler for XML schema namespace [http://cxf.apache.org/jaxws]--> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxws</artifactId> <version>3.1.8</version> </dependency> <!--java實現webservice，不部署到tomcat，須要jetty包支持--> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http-jetty</artifactId> <version>3.1.8</version> </dependency> </dependencies>

2.webservice服務端接口及實現類

@WebService public interface MyWebService { int add(@WebParam(name = "firstA")int a, @WebParam(name = "firstB")int b); int minus(@WebParam(name = "secondA")int a, @WebParam(name = "secondB")int b); }

@WebService(endpointInterface = "com.lida.dream_webservice.server.MyWebService") public class MyWebserviceImpl implements MyWebService { @Override public int add(int a, int b) { System.out.println(a+"+"+b+"="+(a+b)); return a+b; } @Override public int minus(int a, int b) { System.out.println(a+"-"+b+"="+(a-b)); return a-b; } }

3.配置spring-web.xml及spring-webservice.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:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd"> <!--配置springmvc--> <!--1.開啓springmvc註解模式--> <!--簡化配置： (1)主動註冊DefaultAnnotationHandlerMapping,AnnotationMethodHandlerAdapter (2)提供一系列功能：數據綁定，數字和日期的format @NumberFormt @DataTimeFormat，xml json默認的讀寫支持--> <mvc:annotation-driven/> <!--servlet-mapping--> <!--2靜態資源默認的servlet配置，（1）容許對靜態資源的處理：js，gif （2）容許使用「/」作總體映射--> <!-- 容器默認的DefaultServletHandler處理 全部靜態內容與無RequestMapping處理的URL--> <mvc:default-servlet-handler/> <!--3:配置jsp 顯示viewResolver--> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/> <property name="prefix" value="/WEB-INF/views/"/> <property name="suffix" value=".jsp"/> </bean> <!-- 4自動掃描且只掃描@Controller --> <context:component-scan base-package="com.lida.dream_webservice" /> <!-- 定義無需Controller的url<->view直接映射 --> <mvc:view-controller path="/" view-name="redirect:/index"/> </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://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd" default-lazy-init="true"> <!-- 引入CXF Bean定義以下,早期的版本中使用 --> <!--<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" />--> <!--發佈webservice--> <!-- WebService的實現Bean定義 --> <!--web.xml配置了webservice的訪問路徑/server/*，那麼/server/web-publish?wsdl就是該webservice的訪問路徑--> <bean id="webserviceServer" class="com.lida.dream_webservice.server.MyWebserviceImpl" /> <!-- jax-ws endpoint定義 --> <jaxws:endpoint id="myService" implementor="#webserviceServer" address="/web-publish" > </jaxws:endpoint> <!--發佈webservice--> </beans>

4.配置web.xml

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5"> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> <context-param> <param-name>contextConfigLocation</param-name> <param-value> classpath:spring/spring-webservice.xml </param-value> </context-param> <servlet> <servlet-name>springServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/spring-web.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>springServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <filter> <filter-name>characterEncodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>forceEncoding</param-name> <param-value>true</param-value> </init-param> </filter> <filter-mapping> <filter-name>characterEncodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <!--Spring MVC是經過DispatcherServlet來加載Spring配置文件的，所以不須要在web.xml中配置ContextLoaderListener。 可是CXF卻須要經過ContextLoaderListener來加載Spring。--> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!-- 配置CXF框架的核心Servlet --> <servlet> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>2</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/server/*</url-pattern> </servlet-mapping> </web-app>

這裏必定要注意spring-mvc與cxf使用不一樣的容器加載，不然會報錯：
springmvc是不須要ContextLoaderListener來加載管理bean的，DispatcherServlet它有本身的容器，主要用於加載除控制器層的bean,DispatcherServlet屬於子容器。
cxf須要ContextLoaderListener，cxf須要ContextLoaderListener是spring管理bean的父容器，通常用於加載非控制器層的bean。
子容器能夠訪問父容器中的bean，而父容器不能訪問子容器。
能夠把基本web請求的controller等這些bean放到spring-web.xml中，讓DispatcherServlet去加載管理spring-web.xml。
把webservice相關配置到另一個xml文件中,好比spring-webservice.xml,
讓ContextLoaderListener去加載管理spring-webservice.xml和其餘spring文件（）spring-mysql.xml,spring-jpa.xml等），
這樣，就互不影響了。
並且：ContextLoaderListene默認會加載applicationContext.xml這個名字的文件，若是定義爲spring-context.xml會報錯，重命名須要context-param
此時配置tomcat啓動項目後便暴露了wsdl，在瀏覽器訪問http://localhost:8080/server/web-publish?wsdl
4.調用

public class ClientForCXF { public static MyWebService getInterFace(){ JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean(); factoryBean.setServiceClass(MyWebService.class); factoryBean.setAddress("http://localhost:8080/server/web-publish"); return (MyWebService) factoryBean.create(); } public static void main(String[] args) { MyWebService myWebService = getInterFace(); System.out.println("client: "+myWebService.add(1,3)); } }

以上兩種實現webservice的方法僅適用於本身有java的webservice的服務端，本身調用。而每每服務端可能由別的語言實現，或者服務端並不是咱們本身實現，咱們沒有服務端接口，咱們只能得到暴漏的wsdl，並進行調用，這就須要使用wsdl2java生成該wsdl的java客戶端並調用了
第四步：wsdl2java生成客戶端代碼並調用
打開cmd（由於咱們配置了環境變量，因此能夠直接使用wedl2java命令）
輸入
wsdl2java -encoding utf-8 -d F:\IdeaProjects\dream-webservice\wsdl2javatest http://localhost:8080/server/web-publish?wsdl
遍在wsdl2javatest生成了該wsdl的客戶端代碼

這時，咱們變能夠寫客戶端並調用了

public class Client { public static void main(String args[]) { MyWebserviceImplService service = new MyWebserviceImplService(); MyWebService myWebService = service.getMyWebserviceImplPort(); System.out.println(myWebService.add(1,2)); } }

附上git源碼，你們能夠fork下來學習一下，大神勿噴，請多指教。

https://github.com/dreamSmile/dream-webservice.git

做者： 時間丶思考  連接：http://www.imooc.com/article/14635 來源：慕課網 本文原創發佈於慕課網 ，轉載請註明出處，謝謝合做！