Web Service服务器端与三种客户端

前言

本文叙述了一个简单的Web Service 服务端以及三种客户端的开发。使用了传统Apache CXF，Spring容器作为载体，是本人在学习过程中所写的DEMO，有不足及改进之处希望批评指正。

Apache CXF简介：

Apache CXF一个开源的Service框架，它实现了JCP与Web Service中一些重要标准。CXF简化了构造，集成，面 向服务架构(SOA)业务组件与技术的灵活复用。在CXF中，Service使用WSDL标准定义并能够使用各种不同的消息 格式(或binding)和网络协议(transports)包括SOAP、XML（通过HTTP或JMS）进行访问。CXF同样支持多种model， 如：JAX-WS，JBI，SCA和CORBA service。CXF设计成可灵活部署到各种容器中包括Spring-based，JBI，SCA， Servlet和J2EE容器。¹
通过查阅官方API文档获取使用指南。²

关键词：Web Service；RPC风格微服务；CXF；

环境搭建

可使用传统项目构建方式，也可以使用Maven构建，只要具备依赖条件都可以进行开发。

项目依赖

Maven项目依赖如下：

        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.1.10</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.1.10</version>
        </dependency>

传统Jar包集apache官网下载：http://cxf.apache.org/download.html

服务端

1. 创建

创建一个普通Web工程，导依赖包。

2. web.xml配置：

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <!--配置Bean文件上下文-->
        <param-value>classpath:applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>

    <servlet>
        <servlet-name>cxfServlet</servlet-name>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>cxfServlet</servlet-name>
        <!--访问路径前缀-->
        <url-pattern>/services/*</url-pattern>
    </servlet-mapping>

3. 上下文配置Bean

web.xml文件全局配置中的applicationContext.xml文件配置Bean：

<!-- 暴露应用程序接口 -->
	<jaxws:endpoint id="productServiceImpl" 
                    implementor="test.service.ProductServiceImpl" 
                    address="/productService"/>

id: 接口的识别字段
implementor: 远程调用接口的实现类
address: 接口访问路径

4. 创建实体POJO类

创建实体POJO类,并给Get、Set方法，构造器等，篇幅原因这里只给出字段，前面的方法一键生成就好，注意实现Serializable 接口。

public class Product implements Serializable {
    private Integer id;
    private String name;
    private Double price;
    }

5. 接口定义

接口定义，使用 @WebService 注解。

@WebService
public interface ProductService {
    List<Product> getAllProduct();
    String findProductByJson();
}

6. 接口实现

实现前面接口定义的两个方法。第一个方法返回Product集合，第二个方法返回的是Product的Json数据。

public class ProductServiceImpl implements ProductService {

    @Override
    public List<Product> getAllProduct() {
        List<Product> products=new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            Product product=new Product(i,"产品"+i,3.3);
            products.add(product);
        }
        return products;
    }

    @Override
    public String findProductByJson() {
        List<Product> products=new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            Product product=new Product(i,"产品"+i,3.3);
            products.add(product);
        }
        String s = JSON.toJSONString(products);
        System.out.println(s);
        return s;
    }
}

客户端

这里记录三种客户端实现方式，这里使用普通Java工程实现。

传统客户端

1. 依赖spring-config.xml文件配置：

<!-- 暴露应用程序接口 -->
    <jaxws:client id="productServiceImpl" 
                  address="http://localhost:8080/services/productService" 
                  serviceClass="test.service.ProductService"/>

2. POJO与Service接口必须与服务器端同步(重要)
   这个类与接口可以直接使用服务端的程序，即上面的Product与ProductService。
3. 客户端编写

public class Client {
    public static void main(String[] args) {
        ApplicationContext context=new ClassPathXmlApplicationContext("spring-config.xml");
       ProductService service=(ProductService) context.getBean("productServiceImpl");
        List<Product> allProduct = service.getAllProduct();
        for (Product product : allProduct) {
            System.out.println(product.getId()+":name"+product.getName()+",price"+product.getPrice());
        }
    }
}

代理型客户端

不需要xml文件配置，只需要知道需要调用的远程接口地址以及接口类即可，使用setAddress()方法，设置地址。
factoryBean.create() 是远程调用接口的关键，它返回的是对应服务端的接口。

public class ClientProxy {
    public static void main(String[] args) {
        JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();
        factoryBean.setServiceClass(ProductService.class);
        factoryBean.setAddress("http://localhost:8080/services/productService");
        ProductService service=(ProductService) factoryBean.create();
        List<Product> allProduct = service.getAllProduct();
        for (Product product : allProduct) {
            System.out.println(product.getId()+":name"+product.getName()+",price"+product.getPrice());
        }
    }
}

动态调用型客户端

不需要xml配置，不需要知道接口类，通过接口方法获取数据。
JaxWsDynamicClientFactory实例通过已知的服务端接口描述wsdl返回客户端对象，同时指定服务端的实现方法名。由于前面设定返回的是String类型Json数据，使用fastjson解析成JSONObject 对象，再获取内容。

public class ClientJson {
    public static void main(String[] args) throws Exception {
        JaxWsDynamicClientFactory factory = JaxWsDynamicClientFactory.newInstance();
        Client client = factory.createClient("http://localhost:8080/webService_Service/services/productService?wsdl");
        String menthod="findProductByJson";
        Object[] objects = client.invoke(menthod);
        JSONArray jsonArray = JSON.parseArray(objects[0].toString());
        for (int i = 0; i < jsonArray.size(); i++) {
            JSONObject jsonObject = jsonArray.getJSONObject(i);
            System.out.println(jsonObject.getInteger("id")+":name"+jsonObject.getString("name")+",price"+jsonObject.getDouble("price"));
        }
    }
}

---

1. 开源中国： https://www.oschina.net/p/apache+cxf ↩︎

2. Apache cxf：http://cxf.apache.org/javadoc/latest/org/apache/cxf/jaxws/package-summary.html ↩︎