cxf-Springmvc-maven实现webservice教程

来源:互联网 发布:数据挖掘是算法吗 编辑:程序博客网 时间:2024/04/30 09:33

虽知道webservice,工作两年一直没使用过,最近不忙趁机研究了下,实现了简单的服务端及客户端调用。鉴于慕课网没有webservice的教程,大多又都是学生,就在这里跟大家分享下,内容比较详细。大神请忽略,如有错误之处,敬请指点。
第一步,下载cxf及配置环境变量。
Source Distribution为源码版,需要编译后使用,鄙人小白,没有搞过这种东西。我们下载Binary Distribution(可执行版),下载后解压即可。
图片描述

作为java常用工具,最好在环境变量里配置一下,另cxf-3.1.8需要jdk1.6以上
在系统变量里的Path中添加(注意两个变量之间要有分号)
图片描述

在cmd中输入wsdl2java -help输出一大堆
图片描述
证明配置成功
第二步,普通项目,java-api实现webservice
1.接口

@WebServicepublic 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服务端接口及实现类

@WebServicepublic 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));    }}