引入：

虽然已经用了Apache CXF一段时间了，但是毕竟只是在项目中运用其部分能力，没有系统的学习，其实CXF还有许多强大的功能，这里我准备用一些文章系统的介绍Apache CXF的各个特征。


例子介绍：

演示用Apache CXF对JAX-WS的支持来创建“code first”的web service.


实践

首先我们进行架构设计，我们假设按照传统惯例，搭建一个maven应用，所以它的pom.xml应该如下：


    4.0.0
    com.charles.cxfstudy
    cxf_jaxws_server
    war
    CXF demo using JAX-WS APIs
    >CXF demo using JAX-WS APIs
    1.0.0
    
        ${project.version}
        ${basedir}/../..
        3.0.7.RELEASE
    
    
        
            
                maven-compiler-plugin
                
                    1.6
                    1.6
                
            
            
                maven-war-plugin
                2.1
                
                    src/main/webapp/WEB-INF/web.xml
                
            
                                                                       
        
        cxf_jaxws_server
    
                                                                
    
        
            org.apache.cxf
            cxf-rt-frontend-jaxws
            2.7.10
        
        
            org.apache.cxf
            cxf-rt-transports-http
            2.7.10
        
        
            org.springframework
            spring-web
            ${spring.version}


这里没什么技术含量，主要就是添加一些Apache CXF的依赖的jar包的支持，当然了，我们还考虑到用了spring web(接下来会讲），所以也添加了对spring web的支持。


因为是web应用，所以我们去编辑web.xml，这里特别要注意的是，我们的Apache CXF框架的入口Servlet是CXFServlet,它是一个基于Spring框架的Servlet,它符合拦截和转发web service的请求，并且调用业务方法进行服务，按照国际惯例，我们还必须为其配置url-pattern，从而让系统知道它会拦截何种请求。（我们这里设为拦截所有 /services/开头的请求）：



    cxf demo for "code first" webservice
    
        Apache CXF Endpoint
        cxf-endpoint
        
        org.apache.cxf.transport.servlet.CXFServlet
        1
    
    
        cxf-endpoint
        /services/*
    
    
        60



下面我们要写一个spring 配置文件，叫WEB-INF/cxf-servlet.xml，为什么要写这个文件呢？我们来看下Apache CXF的核心Servlet ,CXFServlet的实现：

public class CXFServlet extends CXFNonSpringServlet
    implements ApplicationListener {
    private static final long serialVersionUID = -5922443981969455305L;
    private static final String BUS_PARAMETER = "bus";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
    private boolean busCreated;
    private XmlWebApplicationContext createdContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
    public CXFServlet() {
    }
    @Override
    protected void loadBus(ServletConfig servletConfig) {
        ApplicationContext wac = WebApplicationContextUtils.
            getWebApplicationContext(servletConfig.getServletContext());
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
        if (wac instanceof AbstractApplicationContext) {
            addListener((AbstractApplicationContext)wac);
        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
        String configLocation = servletConfig.getInitParameter("config-location");
        if (configLocation == null) {
            try {
                InputStream is = servletConfig.getServletContext().getResourceAsStream("/WEB-INF/cxf-servlet.xml");
                if (is != null && is.available() > 0) {
                    is.close();
                    configLocation = "/WEB-INF/cxf-servlet.xml";
                }
            } catch (Exception ex) {
                //ignore
            }
        }
        if (configLocation != null) {
            wac = createSpringContext(wac, servletConfig, configLocation);
        }


可以看出，它会去读取config-location的配置文件路径，默认为/WEB-INF/cxf-servlet.xml，从而创建Spring的上下文。所以我们可以想象，这个cxf-servlet.xml（或者其他名字的配置文件）肯定是配置了关于web服务的定义 ,并且将这些服务定义为spring的bean,如下：


所以我们这里就用jaxws的名字空间来声明提供服务的服务全限定接口，服务的地址和服务的实现全限定类，所以一旦web service部署在spring容器中，就可以为外界提供服务了。


接下来就是编码工作，我们必须让我们的代码和我们在cxf-servlet.xml中的配置一样。所以，我们定义了IGreetingService的接口：

/**
 *  这是 web service的接口
 */
package com.charles.cxfstudy.server.services;
import javax.jws.WebService;
import com.charles.cxfstudy.server.vo.Person;
/**
 * @author charles.wang
 *
 */
@WebService
public interface IGreetingService {
                                                                                                                                                                                                                                                                                                                                                                                                                             
    /**
     * 对某个Person发起问候
     */
    String sayGreetingToPerson(Person person);
}

并且在这个接口中提供业务方法。因为我们的服务是Web服务，所以必须用@WebService注解将其标示。 我们的接口中可以出现非java内定类型的类，比如自定义类（这里的Person类），他们会被JAXB框架（Apache CXF默认支持的绑定框架）来转为对应的xml类型定义。


所以我们的 Person 类就如下：

/**
 * 这个一个VO,我们定义了一个Person类型，接下来，我们会用JAXB框架将其映射为wsdl文件中的类型定义
 */
package com.charles.cxfstudy.server.vo;
import javax.xml.bind.annotation.XmlType;
/**
 * 我们定义一个有姓名(name)和年龄(age)的Person类
 * @author charles.wang
 *
 */
@XmlType(name="person")
public class Person {
                                                                                                                                                                                                                                                                                                                                                                 
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
                                                                                                                                                                                                                                                                                                                                                                 
}

可以看出，这个Person类和一般的Bean没有区别，唯一区别在于我们用了注解@XmlType,它会被JAXB识别并且把这个类转为对应的xml格式的类型定义。


接下来我们就来编写服务实现bean了，根据我们在cxf-servlet.xml中的定义，我们开发了GreetingServiceImpl的实现类：

/**
 * 这是web service的实现类
 */
package com.charles.cxfstudy.server.services;
import javax.jws.WebService;
import com.charles.cxfstudy.server.vo.Person;
/**
 * @author charles.wang
 *
 */
@WebService (endpointInterface="com.charles.cxfstudy.server.services.IGreetingService", serviceName="GreetingService")
public class GreetingServiceImpl implements IGreetingService {
    /**
     * 对某个Person发起问候
     */
    public String sayGreetingToPerson(Person person) {
        System.out.println("calling SayGreetingToPerson(Person) method");
        String name = person.getName();
        int    age  = person.getAge();
        return "Hello ,this is greeting from Charles to: "+name+", and his age is: "+age;
    }
}

从这里看出，它也和一般具体类没区别，就是多了一个@WebService注解来表示自己是一个服务实现类。这里看到其中还有endpointInterface和serviceName属性，他们都会映射到最终的wsdl文件。


开发完了之后，就足够了（因为我们的逻辑太简单了），我们maven构建war包，然后部署在tomcat容器上（或者其他web容器）， 就可以通过URL来测试我们的应用了。从服务器日志可以清楚的看到发布Web服务的过程：

Apache CXF学习- 利用jaxws创建一个


比如访问http://localhost:8080/cxf_jaxws_server/services/greeting?wsdl  （因为/services请求会被CXFServlet拦截作为web service请求， /greeting是我们开发的web service的具体请求，定义在cxf-servlet.xml中）

Apache CXF学习- 利用jaxws创建一个


从上图可以看出，这个wsdl文件上部分的 中就包含person类型的定义，它是通过JAXB完成的。而下部分则是对我们的业务方法的定义，其中业务方法中用的入参，返回值类型都有在中定义。


对于我们生成的这个wsdl,我们可以很容易用各种工具（比如soapUI)测试其正确性，这里就不描述了,大家都会。