WebService使用笔记

一、基本概念

• WebService是一种跨编程语言和跨操作系统平台的远程调用技术。
• 远程调用，就是一台计算机a上的一个程序可以调用到另外一台计算机b上的一个对象的方法。
• 从表面上看，WebService就是一个应用程序向外界暴露出一个能通过Web进行调用的API，也就是说能用编程的方法通过Web来调用这个应用程序。我们把调用这个WebService的应用程序叫做客户端，而把提供这个WebService的应用程序叫做服务端。

二、使用场景

常见的使用场景有：
* 公司内部不同平台之间系统的调用。
* 不同公司不同平台之间的调用。
* 提供聚合服务。（如天气预报等）

三、相关术语

WSDL

Web Service描述语言WSDL（Web Service Definition Language）就是用机器能阅读的方式提供的一个正式描述文档而基于XML（标准通用标记语言下的一个子集）的语言，用于描述Web Service及其函数、参数和返回值。因为是基于XML的，所以WSDL既是机器可阅读的，又是人可阅读的。

SOAP

SOAP即简单对象访问协议(Simple Object Access Protocol)，它是用于交换XML（标准通用标记语言下的一个子集）编码信息的轻量级协议。它有三个主要方面：XML-envelope为描述信息内容和如何处理内容定义了框架，将程序对象编码成为XML对象的规则，执行远程过程调用(RPC)的约定。SOAP可以运行在任何其他传输协议上。

SEI

SEI（Web Service EndPoint Interface）是Web Service服务器端用来处理请求的接口。

UDDI

UDDI 的目的是为电子商务建立标准；UDDI是一套基于Web的、分布式的、为Web Service提供的、信息注册中心的实现标准规范，同时也包含一组使企业能将自身提供的Web Service注册，以使别的企业能够发现的访问协议的实现标准。

Jax-ws

JAX-WS(Java API for XML Web Services)规范是一组XML Web Services的JAVA API；也即JDK内置的Web Service实现，用来开发和发布Web Service服务。

CXF

Apache的用于开发webservice服务器端和客户端的框架。
实现Web Service的框架有：Axis，Axis2，Xfire，CXF以及JAXWS-ri(JAX Web Service参考实现)。

---

本文只说明CXF使用相关的内容

---

以下是一个简单的例子

服务端接口及测试

接口：

@WebService
public interface ReportInterface {

    @WebMethod
    public String sendReport(String reportMsg);

}```
实现类：

public class ReportImpl implements ReportInterface {

@Override
public String sendReport(String reportMsg) {
    return "hello ------------------------- world" + reportMsg;
}

}“`

webservice接口服务发布：

public class ReportServer {
private static final String ADDRESS = "http://127.0.0.1:8082/alo/webservice/sendReport";

    public static void main(String[] args) {
        System.out.println("发布服务中");
        JaxWsServerFactoryBean factoryBean = new JaxWsServerFactoryBean();
        factoryBean.setServiceClass(ReportInterface.class);
        factoryBean.setServiceBean(new ReportImpl());
        factoryBean.setAddress(ADDRESS);
        factoryBean.create();
        System.out.println("发布成功");
    }
}

如果服务端编写成功,在浏览器中访问http://127.0.0.1:8082/alo/webservice/sendReport?wsdl
可以看到如图所示xml片段:

其中xml内各标签含义可参考此文章:
http://www.cnblogs.com/ywx-vashon/p/5355422.html

客户端代码生成及测试

请去官网下载apache-cxf,并添加配置到环境变量Path
客户端代码使用wsdl2java指令根据接口连接内容在控制台上生成,指令如下
wsdl2java生成客户端指令:

wsdl2java -encoding utf-8 -p com.todaytech.platform.esb.ws.client.test -d . http://127.0.0.1:8082/alo/webservice/sendReport?wsdl

-encoding 指编码
-p 指包名
-d 指目录,在此用 . 表示当前目录
大概来说,格式为:
wsdl2java -encoding 编码 -p 包名 -d 目录 接口URL
根据刚刚发布的服务接口生成的客户端代码如下:

客户端测试代码:

public class TestClient {
private static final String ADDRESS = "http://127.0.0.1:8082/alo/webservice/sendReport";
    public static void main(String[] args) {
        JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();
        factoryBean.setServiceClass(ReportInterface.class);
        factoryBean.setAddress(ADDRESS);
        ReportInterface reportInterface = factoryBean.create(ReportInterface.class);
        String msg = reportInterface.sendReport("   123123123");
        System.out.println(msg);
    }
}

注意,这里的ReportInterface是client包内的,不是服务端包内的,在测试时服务端和客户端在同一个工程内容易搞混,不过在实际项目中不会有混淆的,因为服务端和客户端不在同一工程

调用服务端观测到输出

此时说明生成的客户端代码及带参数调用服务端已成功

Spring配置

<jaxws:endpoint id="sendReportService" implementor="com.ry.platform.esb.webService.server.report.impl.ReportHandleImpl" address="/sendReport"  />