WebService之CXF框架

我会带着你远行 2022-08-22 14:14 200阅读 0赞

### 本文主要包括以下内容 ###

1.  ant工具的使用
2.  利用cxf实现webservice
3.  cxf与spring整合
4.  ajax访问webservice

### ant 工具 ###

**1、为什么要用到ant这个工具呢？**

Ant做为一种工具已经广泛被使用，并且历史悠久。  
使用ant的内置命令，可以编译java源文件(javac),运行java文件（java），给class文件打包(jar、war、ear),  
也可以创建（mkdir）、删除（del）、拷贝（copy），甚至可以使用ant执行sql文件。  
由于ant是用xml语言写成的文件，并取默认名为build.xml文件。  
所以，今后大家应该在见到名为build.xml文件时知道这是一个ant的文件。

**ant 工具后面跟的是任务的名称**

*  ant server 运行了Server类，发布了一个webservice
 *  ant client 调用已经发布的webservice
 *  ant clean 清除已经生成的class 文件
 *  ant war 将java 项目打成一个war 包
 *  ant deploy -Dtomcat=true 把打成的war 拷贝到tomcat 的webapp 下面去。
 *  ant undeploy -Dtomcat=true; 卸载tomcat 下面的项目..

### CXF发布服务与调用服务 ###

**用cxf 框架提供的类发布一个服务**

**方法一**

使用cxf 提供 ServerFactoryBean 来发布webservice  
被发布的类当中可以不需要标注webservice 注解，类当中可以不包含有效的方法，  
如果没有包含有效的方法.它会提供一个空的服务.

//创建发布服务的类...
    ServerFactoryBean bean=new ServerFactoryBean();
    bean.setAddress("http://192.168.9.100:8080/server");//服务对外的访问地址
    bean.setServiceClass(CxfWebService.class);//设置服务类的接口类型，如果没有接口则为当前类..
    bean.setServiceBean(new CxfWebService());//设置服务类的实现
    bean.create();//发布服务

**有接口的情况**

package com.zj.server;
    
    import org.apache.cxf.interceptor.LoggingInInterceptor;
    import org.apache.cxf.interceptor.LoggingOutInterceptor;
    import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
    
    import cn.itcast.webservice.userService.UserService;
    import cn.itcast.webservice.userService.UserServiceImpl;
    
    /**
     * 
     * 使用cxf 提供的类 JaxWsServerFactoryBean 来发布一个带接口的webservice ...
     * 
     * @ 作者 zhuwu@itcast.cn
     *
     */
    public class PublishUserService {
    
        /**
         * @param args
         */
        public static void main(String[] args) {
            //创建发布服务的 类...
            JaxWsServerFactoryBean  bean=new JaxWsServerFactoryBean();
            //设置对外的访问地址
            bean.setAddress("http://10.129.69.114:7418/userService");
            bean.setServiceClass(UserService.class);//设置接口类型...
            bean.setServiceBean(new UserServiceImpl());//设置接口的实现类...
            //我们可以在发布服务的时候添加消息拦截器
            //拦截客户端往服务端 发送的请求的消息
            bean.getInInterceptors().add(new LoggingInInterceptor());
            //拦截服务端往客户端返回的消息...
            bean.getOutInterceptors().add(new LoggingOutInterceptor());
    
            bean.create();
        }
    
    }

**第二种发布方式**

使用cxf 框架提供的类 jaxWsServerFactoryBean 发布webService
    jaxWsServerFactoryBean 是 ServerFactoryBean 的子类... 
    
    jaxWsServerFactoryBean bean=new jaxWsServerFactoryBean();
    bean.setAddress("http://192.168.9.100:8080/server");//服务对外的访问地址
    bean.setServiceClass(CxfWebService.class);//设置服务类的接口类型，如果没有接口则为当前类..
    bean.setServiceBean(new CxfWebService());//设置服务类的实现
    bean.create();//发布服务

### 客户端： ###

**方法一**  
用cxf 框架提供的类调用服务.. (需要依赖一个接口，通过wsimport 生成的代码当中获取…)

//创建调用webservice 服务的类...
    ClientProxyFactoryBean bean=new ClientProxyFactoryBean();
    bean.setAddress("http://192.168.9.100:8080/server");//设置访问地址...
    bean.setServiceClass(CxfWebServicePortType.class);//设置服务的接口...
    //创建接口类型...
    CxfWebServicePortType cxfWebServicePortType=(CxfWebServicePortType) bean.create();
    cxfWebServicePortType.sayHello();

**方法二**

使用cxf 提供类 JaxWsProxyFactoryBean 来调用 webservice 的服务端…….

JaxWsProxyFactoryBean 是  ClientProxyFactoryBean  的子类...
    //创建调用服务的类...
    JaxWsProxyFactoryBean bean=new JaxWsProxyFactoryBean();
    //设置访问地址
    bean.setAddress("http://192.168.9.100:7418/userService");
    //设置接口类型...
    bean.setServiceClass(UserService.class);
    UserService us=(UserService) bean.create();
    
    String data=us.getUserById(1);
    
    System.out.println(data);

### 调用原则： 总结. ###

服务端： 客户端  
ServerFactoryBean ————ClientProxyFactoryBean  
JaxWsServerFactoryBean—————-JaxWsProxyFactoryBean

JaxWsServerFactoryBean 可以发布soap1.2 版本的协议….发布服务的时候，  
我们最好被发布的服务类要面向接口编程..

**命令：wsdl2java**

wsdl2java 是cxf 框架给我们提供的命令，这个命令的作用与wsimport 类似...

**拦截器:**

cxf 框架中提供了拦截器的机制，我们可以通过拦截器获取到客户端与服务端进行交互的时候的数据格式

//创建发布服务的 类...
        JaxWsServerFactoryBean  bean=new JaxWsServerFactoryBean();
        //设置对外的访问地址
        bean.setAddress("http://192.168.9.100:7418/userService");
        bean.setServiceClass(UserService.class);//设置接口类型...
        bean.setServiceBean(new UserServiceImpl());//设置接口的实现类...
        //我们可以在发布服务的时候添加消息拦截器
        //拦截客户端往服务端 发送的请求的消息
        bean.getInInterceptors().add(new LoggingInInterceptor());
        //拦截服务端往客户端返回的消息...
        bean.getOutInterceptors().add(new LoggingOutInterceptor());
        bean.create();

### cxf 与web 项目的整合 ###

由于cxf的web项目已经集成了Spring所以，cxf的服务类都是在spring的配置文件中完成的。以下是步骤：

*  第一步：建立一个web项目。
 *  第二步：准备所有jar包。将cxf\_home\\lib项目下的所有jar包全部copy到新项目的lib目录下，里面已经包含了spring3.0的jar包。
 *  第三步：在web.xml中配置cxf的核心servlet，CXFServlet。
 *  第四步：创建(最好是Copy)cxf-servlet.xml文件。这是一个spring的配置文件。

**服务器实现了**

发布一个不带接口的webservice

<jaxws:endpoint id="helloService" address="/helloService" implementor="cn.itcast.cxf.spring.HelloService"></jaxws:endpoint>

发布一个带接口的webservice

### web.xml配置如下 ###

<?xml version="1.0" encoding="UTF-8"?>
    <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
        
        <listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>
        <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/cxf-servlet.xml</param-value>
        </context-param>
    
    
        <servlet>
            
            <servlet-name>cxf</servlet-name>
            <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
            <init-param>
                
                <param-name>config-location</param-name>
                
                <param-value>/WEB-INF/cxf-servlet.xml</param-value>
                
    
            </init-param>
        </servlet>
        <servlet-mapping>
            <servlet-name>cxf</servlet-name>
            <url-pattern>/ws/*</url-pattern>
        </servlet-mapping>
        <welcome-file-list>
            <welcome-file>index.jsp</welcome-file>
        </welcome-file-list>
    </web-app>

### cxf-servlet.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"
        xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:cxf="http://cxf.apache.org/core"
        xsi:schemaLocation="http://www.springframework.org/schema/beans 
              http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
                http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
                http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
                http://cxf.apache.org/core http://cxf.apache.org/schemas/core.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="helloService" address="/helloService" implementor="cn.itcast.cxf.spring.HelloService"></jaxws:endpoint>
            
            
    
            <jaxws:server id="makeCallService" address="/makeCallService" serviceClass="cn.itcast.cxf.spring.call.CallService">
                <jaxws:serviceBean>
                
                    <bean class="cn.itcast.cxf.spring.call.CallServiceImpl"></bean>
                </jaxws:serviceBean>
                
                
                <jaxws:inInterceptors>
                    <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"></bean>
                </jaxws:inInterceptors>
    
                
                <jaxws:outInterceptors>
                     <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"></bean>
                </jaxws:outInterceptors>
    
            </jaxws:server>
    
    
    
    </beans>

### 客户端调用 ###

1.  用wsdl2java生成客户端代码
2.  编写spring配置文件
3.  调用

**spring配置文件**

### 调用 ###

package cn.itcast.spring.client;
    
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    import cn.itcast.cxf.spring.call.CallService;
    
    
    /**
     * 
     * 通过配置文件的方式调用webservice,
     * 同时也需要依赖一个接口....
     * 
     * @ 作者 zhuwu@itcast.cn
     *
     */
    public class SpringClientInvoke {
        
    
        /**
         * @param args
         */
        public static void main(String[] args) {
            //解析spring配置文件
            ApplicationContext context=new ClassPathXmlApplicationContext("bean.xml");
            //通过getBean 拿到接口 的实例对象...
            CallService callService=
            (CallService) context.getBean("itcast");
            boolean flag=callService.makeCaller("zj");
            System.out.println(flag);
    
    
        }
    
    }

### ajax调用webService实现 ###

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
        <%
    String path = request.getContextPath();
    String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
    System.out.println(basePath);
    %>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
      <head>
        <base href="<%=basePath%>">
    
        <title>My JSP 'index.jsp' starting page</title>
        <meta http-equiv="pragma" content="no-cache">
        <meta http-equiv="cache-control" content="no-cache">
        <meta http-equiv="expires" content="0">    
        <meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
        <meta http-equiv="description" content="This is my page">
        <script type="text/javascript" src="js/jquery-1.6.2.js"></script>
        <script type="text/javascript">
        /**
            ajax  的xmlHttpRequest 对象可以发送一个http 请求
            我们可以把服务端需要的xml 格式的数据传送到服务端。
            模拟soap 请求。
    
        **/
        var itcast;
        itcast={
                sendMessage:function(){
         
                var data='<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:q0="http://call.spring.cxf.itcast.cn/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">';
                data+='<soapenv:Body><q0:makeCaller><arg0>itcast</arg0></q0:makeCaller></soapenv:Body></soapenv:Envelope>';
                $.ajax({
                  url: "ws/makeCallService",
                  data:data,
                  contentType:'text/xml;charset=utf-8',
                  type:"POST",
                  dataType:"xml",
                  success: function(data, textStatus, jqXHR){
         
                     var text=$(data).find("return").text();
                     $(".message").html(text);
                    // $(".message").show(3000);
                    $(".message").slideDown(3000);
                  }
                });
                },
                hide:function(){
         
    
                     $(".message").slideUp(3000);
    
                }
        }
    
    
    
        </script>
    
      </head>
    
      <body>
    
            <input type="button" value="显示" onclick="itcast.sendMessage()"/>
            <input type="button" value="隐藏" onclick="itcast.hide()"/>
            <div class="message" style="border-width: 4xp;border-style: solid;border-color: red;width: 400px;height: 400px;display: none;">
    
    
            </div>
      </body>
    </html>

### 使用JS访问WebService跨域 ###

通过js来访问webservice有两种不同的形式  
1、通过SOAP协议进行访问。  
发送的全部是XML数据，且必须是POST请求。  
2、通过HTTP的get/post方式进行访问。  
此种情况又分成不同的形式，此种情况必要在cxf下发布。因为jdk1.6基本的发布不支持Http,soap1.2。  
1、发送和接收XML数据。

**JS一直存在跨域访问的问题**

目前的jQuery不支持跨域访问。如果要进行访问必须使用jQuery的jsonp数据形式。  
但原始的ajax可以通过get/post方式跨域访问http上的资源。  
以下是通过jaxb发布的webservice。并通过js实现访问webService.

*  第一步：书写一个webService，通过Endpoint端点服务发布。
 *  第二步：书写XMLHttpRequest的ajax对像。
 *  第三步：设法获取请求webService的XML数据和WebService返回的数据，以便于数据解析。
 *  第四步：书写代码

**第一步：书写webService的服务：**

![这里写图片描述][20160530132844670]

**第二步：创建XMLHttpRequest对像：**

![这里写图片描述][20160530132914842]

**第三步：设法获取SOAP协议的文本，并在JS中做为发出的XML数据**

![这里写图片描述][20160530132946452]

**CRUD-Server：**

![这里写图片描述][20160530133121249]

**CRUD－Client:**  
![这里写图片描述][20160530133031014]

![这里写图片描述][20160530133153171]

### 总结 ###

分布与接收webService的方法

![这里写图片描述][20160530133219202]

[20160530132844670]: /images/20220722/a054a1c346ba4dc1b30e80205d717629.png
[20160530132914842]: /images/20220722/ba8b8d2617d94df9b51e77b0e52c488c.png
[20160530132946452]: /images/20220722/78db82da5ed0419cbba9ae662b7fffdc.png
[20160530133121249]: /images/20220722/486b5efe444748848ac32c0a0a714fa2.png
[20160530133031014]: /images/20220722/9798eb72d5dd435583a6d0762b78a6d6.png
[20160530133153171]: /images/20220722/ef85ec4df89249e99ecc6927261aa96f.png
[20160530133219202]: /images/20220722/ada4927ec4504473991fe2368ec5fa24.png