WebService之JAX-WS、CXF、Spring3.0+

　　前言：

          面对工作的需要，web服务这一块一直都在身边转悠着。既然工作中需要这些，作为程序员就应该去了解和学习。下面主要简述采用CXF+Spring+JAX-WS来发布WebService服务，以及创建客户端调用服务。

     准备工作：

         1、先了解关于WebService的相关概念以及一些专有名词的解释：

　　   WEBSERVICE　

         W3C的定义是webservice是一个软件系统，用以支持网络间不同机器的互动操作。

　　   受外部环境和实现技术影响，目前普遍认为webservice的技术核心是

　　   soap,wsdl(一个XML格式文档，用以描述服务端口访问方式和使用协议的细节。通常用来辅助生成服务器和客户端代码及配置信息),uddi(一个用来发布和搜索WEB服务的协议，应用程序可借由　　　此协议在设计或运行时找到目标WEB服务)

　　   这些标准由这些组织制订：W3C负责XML、SOAP及WSDL；OASIS负责UDDI。

         JAX-WS

　　  JAX-WS规范是一组XML web services的JAVA API。JAX-WS允许开发者可以选择RPC-oriented或者message-oriented 来实现自己的web services。

         CXF

         Apache CXF 是一个开源的 Services 框架,主要是帮助开发者来快速构建web服务。

 

　　　webservice三种最普遍的实现方式是：

　　　远程过程调用（RPC）

　　　面向服务架构（SOA）

　　　表述性状态转移（REST）

      我在这里说的实现方式并不是说 这三种方式是包含于webservice，个人理解它们之间应该是存在交集，即它们是有联系的同时它们也是有不同的，应该不是从属的关系。

 

       2、相关的开发环境与依赖的jar()    
          A、CXF官方网址：http://cxf.apache.org/
          B、Jar包下载地址：http://www.apache.org/dyn/closer.cgi?path=/cxf/2.3.3/apache-cxf-2.3.3.zip
           将下来的jar包解压后，目录大概就这样
           bin目录提供的是常用的dos控制台命令工具
           docs 帮助文档
           lib jar包、依赖库
           lib-samples 也是jar包，有jetty、httpclients、junit等jar包
           modules 打包好的WebService模块
           samples示例demo
          C、源码下载：http://www.apache.org/dyn/closer.cgi?path=/cxf/2.3.3/apache-cxf-2.3.3-src.zip
            有时候你可以看看源码，对你了解和学习CXF WebService都会有作用。
          D、CXF的特性
           有代码生成工具：Java to WSDL；WSDL to Java；XSD to WSDL；WSDL to XML；WSDL to SOAP；WSDL to Service；
           支持 JAX-WS、 JAX-WSA、JSR-181 和 SAAJ；支持 SOAP 1.1、1.2、WS-I BasicProfile、WS-Security、WS-Addressing、WS-RM 和 WS-Policy；支持 WSDL 1.1 、2.0；支持 MTOM；通过 Yoko 支持 CORBA；通过 Tuscany 支持 SCA；通过 ServiceMix 支持 JBI；内置Jetty应用服务器（Jetty服务器也是当今web开发的一款比较好用的服务器）；

 

      开发：

         开发需要的jar如下：

         

              1、首先创建一个web项目，将得到的包拷贝到lib目录下

               既然是想发布自己的服务，首先创建一个接口

package com.chh.service;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;
import com.chh.entity.User;

/**
 * 定制客户端请求WebService所需要的接口
 * @author chh
 *
 */
@WebService
@SOAPBinding(style=Style.RPC)
public interface IComplexUserService {
    
    public User getUserByName(@WebParam(name = "name") String name);

    public void setUser(User user);

}

           接口只是用来定义，具体操作要在它下面的实现类中得以体现

package com.chh.service;

import java.util.Date;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

import com.chh.entity.User;
/**
 * WebService传递复杂对象，如JavaBean、Array、List、Map等
 * @author chh
 *
 */
@WebService
@SOAPBinding(style=Style.RPC)
@SuppressWarnings("deprecation")
public class ComplexUserService implements IComplexUserService {

    @Override
    public User getUserByName(@WebParam(name = "name") String name) {
        User user = new User();

        user.setId(new Date().getSeconds());
        user.setName(name);
        user.setAddress("china");
        user.setEmail(name + "@hoo.com");

        return user;
    }

    @Override
    public void setUser(User user) {
        System.out.println("############Server setUser###########");
        System.out.println("setUser:" + user);
    }

}

          实体

package com.chh.entity;

import java.io.Serializable;
/**
 * 序列化user实体
 * @author chh
 * 
 */
public class User implements Serializable {

    private static final long serialVersionUID = 677484458789332877L;
    private int id;
    private String name;
    private String email;
    private String address;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public static long getSerialversionuid() {
        return serialVersionUID;
    }
    
    @Override
    public String toString() {
        return this.id + "#" + this.name + "#" + this.email + "#" + this.address;
    }

}

package com.chh.entity;

import java.util.HashMap;
import java.util.List;

/**
 * 
 * @author chh
 * 
 */
public class Users {
    private List<User> users;
    private User[] userArr;
    private HashMap<String, User> map;

    public List<User> getUsers() {
        return users;
    }

    public void setUsers(List<User> users) {
        this.users = users;
    }

    public User[] getUserArr() {
        return userArr;
    }

    public void setUserArr(User[] userArr) {
        this.userArr = userArr;
    }

    public HashMap<String, User> getMap() {
        return map;
    }

    public void setMap(HashMap<String, User> map) {
        this.map = map;
    }

}

         自定义消息拦截器(如果在你的项目中不需要用到拦截器的时候，可以撤掉不用)

package com.chh.interceptor;

import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.AbstractPhaseInterceptor;

/**
 * 自定义消息拦截器
 * @author chh
 *
 */
public class MessageInterceptor extends AbstractPhaseInterceptor<Message> {

    //至少要有一个带参的构造方法
    public MessageInterceptor(String phase) {
        super(phase);
    }
    
    public void handleMessage(Message message) throws Fault {
        System.out.println("############handleMessage##########");
        System.out.println(message);
        
        if(message.getDestination() != null){
             System.out.println(message.getId() + "#" + message.getDestination().getMessageObserver());
        }
        
        if(message.getExchange() != null){
            System.out.println(message.getExchange().getInMessage() + "#" + message.getExchange().getInFaultMessage());
            System.out.println(message.getExchange().getOutMessage() + "#" + message.getExchange().getOutFaultMessage());
        }
        
    }

}

         用xml配置服务端(applicationContext-service.xml)

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.0.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"/>
    
    <bean id="userServiceBean" class="com.chh.service.ComplexUserService"/>

    <bean id="inMessageInterceptor" class="com.chh.interceptor.MessageInterceptor">
        <constructor-arg  value="receive"/>
    </bean>

    <bean id="outLoggingInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
    
    <!-- 注意下面的address，这里的address的名称就是访问的WebService的name -->
    <jaxws:server id="userService" serviceBean="#userServiceBean" address="/Users">
        <jaxws:inInterceptors>
            <ref bean="inMessageInterceptor"/>
        </jaxws:inInterceptors>
    
        <jaxws:outInterceptors>
            <ref bean="outLoggingInterceptor"/>
        </jaxws:outInterceptors>
    </jaxws:server>
    
</beans>

        注意于此同时web.xml中要加在Spring容器

<?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">
  <display-name>CXFWebService</display-name>
      
  <!-- 加载Spring容器配置 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    
    <!-- 设置Spring容器加载配置文件路径 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath*:applicationContext-server.xml</param-value>
    </context-param>
    
    <listener>
        <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>CXFService</servlet-name>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>CXFService</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>    
</web-app>

到这一步为止，我们web服务端开发完成！可以启动项目测试一下自己的web服务有没有发布成功，其中成功与否第一要看项目启动时是否报错，如果报错看具体报什么错误，是包冲突，还是包的版本太低等。启动项目不报错，那么输入地址查看你的这个web服务的wsdl信息：http://localhost:8080/CXFWebService/Users，如果能够看到看到xml格式的信息，则说明你成功发布了web服务。

有了web服务端，但是如果我在程序中想通过别人提供的web服务地址得到自己想要的数据，这一步又该怎么做呢？下面将继续采用CXF+Spring3.0+ 定制开发web服务客户端。其实到这一步已经很简单了，我们可以通过wsdl中的信息来定制客户端(具体有怎样的规则与细节，可以参看http://blog.csdn.net/qjyong/article/details/2148558   这篇博客下面的几个段落)。

       根据服务端定制客户端

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"

    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.0.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"/>

    <!-- serviceClass写定制客户接口的全路径 -->
    <jaxws:client id="userWsClient" serviceClass="com.chh.service.IComplexUserService" 
        address="http://localhost:8080/CXFWebService/Users"/>
    
</beans>

      利用客户端得到服务端的数据。值得说的是，以前发布WebService是用Endpoint的push方法。这里用的是JaxWsServerFactoryBean和客户端调用的代码JaxWsProxyFactoryBean有点不同。

package com.chh.client;

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.chh.entity.User;
import com.chh.service.IComplexUserService;

/**
 * 请求Spring整合CXF的WebService客户端
 * @author chh
 *
 */
public class SpringUsersWsClient {
    
    public static void clientFirst(){
        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
        factory.setServiceClass(IComplexUserService.class);
        factory.setAddress("http://localhost:8080/CXFWebService/Users");
        
        IComplexUserService service = (IComplexUserService) factory.create();
        
        System.out.println("#############Client getUserByName##############");
        User user = service.getUserByName("chh");
        System.out.println(user);

        user.setAddress("China-Guangzhou");
        service.setUser(user);
    }
    
    public static void clientToXML(){
        ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-client.xml");

        IComplexUserService service = ctx.getBean("userWsClient", IComplexUserService.class);
        
        System.out.println("#############Client getUserByName##############");
        User user = service.getUserByName("chh");
        System.out.println(user);

        user.setAddress("China-Guangzhou");
        service.setUser(user);
    }

    public static void main(String[] args) {
        clientToXML();
    }
}

      这样下来，只要项目还启动着web服务还没有停，我们可以运行SpringUserWsClient这个文件的main方法就可以调用到服务端的数据。

    项目目录结构图：

   

整个服务的发布与调用都是采用xml形式开发的，其实如果你不习惯用的话可以文件中用代码实现，这样也是可以的。

到这里，让我想起了公司里面的那套框架的发布服务与调用服务，如果一个web服务想要加密以及MAC校验、设置访问的最大数、超时时间、描述等等，采用现在

这种发布服务的方式那该如何实现，客户端又该如何调用？或者说有没有更加简单的方式来实现这一切功能呢？这样的一些想法还都在摸索着前进，如果有那位热

心肠有高见的话，希望大家知识共享！