Web Service

一、是什么？

Web Services是由企业发布的完成其特定商务需求的在线应用服务,其他公司或应用软件能够通过Internet来访问并使用这项在线服务。用简单点的话说，就是系统对外的接口。

Web Services 是应用程序组件
Web Services 使用开放协议进行通信
Web Services 是独立的（self-contained）并可自我描述
Web Services 可通过使用UDDI来发现
Web Services 可被其他应用程序使用
XML 是 Web Services 的基础

二、如何工作？

基础的 Web Services 平台是 XML + HTTP。

HTTP 协议是最常用的因特网协议。

XML 提供了一种可用于不同的平台和编程语言之间的语言。

Web services 平台的元素：

SOAP (简易对象访问协议)
UDDI (通用描述、发现及整合)
WSDL (Web services 描述语言)

系列教程

Hello world

简单实例

本例子语言为 java，依赖于JDK1.6及以上。(本机为1.8)

一、创建服务类

HelloWorldService.java

import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.xml.ws.Endpoint;

/**
 * Created by bbhou on 2017/7/3.
 * @since 1.6
 */
@WebService
public class HelloWorldService {

    public String helloWorld(String name) {
        return "hello" + name;
    }

    /**
     * 此方法不会被发布
     * @param name
     * @return
     */
    @WebMethod(exclude = true)
    public String helloWorldTwo(String name) {
        return "hello" + name;
    }

    public static void main(String[] args) {
        System.out.println("WebService Start...");
        Endpoint.publish("http://127.0.0.1:12345/helloworld", new HelloWorldService());
    }

}

启动本服务，当命令行打印出WebService Start... 之后，在浏览器中输入：

http://127.0.0.1:12345/helloworld?wsdl

你可以看到网页内容如下：

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://core.webservice.ryo.com/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://core.webservice.ryo.com/" name="HelloWorldServiceService">
<types>
<xsd:schema>
<xsd:import namespace="http://core.webservice.ryo.com/" schemaLocation="http://127.0.0.1:12345/helloworld?xsd=1"/>
</xsd:schema>
</types>
<message name="helloWorld">
<part name="parameters" element="tns:helloWorld"/>
</message>
<message name="helloWorldResponse">
<part name="parameters" element="tns:helloWorldResponse"/>
</message>
<portType name="HelloWorldService">
<operation name="helloWorld">
<input wsam:Action="http://core.webservice.ryo.com/HelloWorldService/helloWorldRequest" message="tns:helloWorld"/>
<output wsam:Action="http://core.webservice.ryo.com/HelloWorldService/helloWorldResponse" message="tns:helloWorldResponse"/>
</operation>
</portType>
<binding name="HelloWorldServicePortBinding" type="tns:HelloWorldService">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
<operation name="helloWorld">
<soap:operation soapAction=""/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
</binding>
<service name="HelloWorldServiceService">
<port name="HelloWorldServicePort" binding="tns:HelloWorldServicePortBinding">
<soap:address location="http://127.0.0.1:12346/helloworld"/>
</port>
</service>
</definitions>

二、服务的发布

wsimport 是 JDK 自带的，可以根据 WSDL 文档生成客户端调用代码的工具。

wsimport.exe 命令参数：

-d: 生成class文件。默认参数。
-s：生成Java文件
-p：自定义包结构

在文件夹 /Users/houbinbin/IT/fork/webService/temp 中执行以下命令：

wsimport -s . -p com.ryo.webservice.core http://127.0.0.1:12346/helloworld?wsdl

则在文件夹 /Users/houbinbin/IT/fork/webService/temp/com/ryo/webservice/core 下可见如下文件：

houbinbindeMacBook-Pro:core houbinbin$ ls
HelloWorld.class                HelloWorldResponse.class        HelloWorldService.class         HelloWorldServiceService.class  ObjectFactory.class             package-info.class
HelloWorld.java                 HelloWorldResponse.java         HelloWorldService.java          HelloWorldServiceService.java   ObjectFactory.java              package-info.java

三、客户端调用

新建项目 webservice-client, 将上述java文件复制到源文件目录下。

创建客户端类：

WebServiceClient.java

public class WebServiceClient {

    public static void main(String[] args) {
        HelloWorldServiceService helloWorldServiceService = new HelloWorldServiceService();
        HelloWorldService helloWorldService = helloWorldServiceService.getHelloWorldServicePort();
        String result = helloWorldService.helloWorld("ryo");
        System.out.println(result);
    }

}

运行内容如下：

helloryo

文件目结构如下：

houbinbindeMacBook-Pro:client houbinbin$ ls
HelloWorld.java                 HelloWorldService.java          ObjectFactory.java              package-info.java
HelloWorldResponse.java         HelloWorldServiceService.java   WebServiceClient.java

如何发布到服务器

有2个办法，

一是：在本机上通过myeclipse自带的直接deploy，然后到tomcat安装目录下把编译后的项目文件夹拷到服务器上的tomcat webApps。再启动tomcat

二是：打包部署，myeclipse中右击项目，有个导出功能，选择war包。先把服务器上的tomcat停止，然后把前面导出的war包拷到服务器上tomcat webApps目录下，启动tomcat服务，就会自动部署了。

其实第二个方法打包部署昨天就试过了不行，估计是那时tomcat没停止再启动吧。至于拷整个目录，我之前也都是拷错了，一直拷编译前的webroot目录，所以有很多问题。

Idea 创建 webService

利用IDEA创建Web Service服务端和客户端

一、服务端的创建

此处省略不讲。

二、客户端创建

1、File => New => Project

new web service

输入对应的项目名称，完成即可。

会自动下载需要的jar包等文件。

2、Generator code

项目右键=》webService=》Generate java Code From Wsdl。

保证引入的 web service 可访问，直接在 Web service wsdl url 输入对应的 wsdl 全路径。

如：

http://localhost:12345/hell?wsdl

可以勾选 Generate TestCase, 会生成对应的测试代码。需要引入 junit 的代码。

Attention

1、不可在同一个地址上发布不同的服务。

比如这样：

public static void main(String[] args) {
    Endpoint.publish("http://127.0.0.1:12345/helloworld", new HelloWorldService());
    Endpoint.publish("http://127.0.0.1:12345/helloworld", new MyDogService());
}

(我就进行了这样的测试)

否则迎接你的将是：

Exception in thread "main" com.sun.xml.internal.ws.server.ServerRtException: 服务器运行时错误: java.net.BindException: Address already in use: bind
	at com.sun.xml.internal.ws.transport.http.server.ServerMgr.createContext(ServerMgr.java:117)
	at com.sun.xml.internal.ws.transport.http.server.HttpEndpoint.publish(HttpEndpoint.java:64)
	at com.sun.xml.internal.ws.transport.http.server.EndpointImpl.publish(EndpointImpl.java:232)
	at com.sun.xml.internal.ws.spi.ProviderImpl.createAndPublishEndpoint(ProviderImpl.java:126)
	at javax.xml.ws.Endpoint.publish(Endpoint.java:240)
	at com.ryo.webservice.core.HelloWorldService.main(HelloWorldService.java:29)
Caused by: java.net.BindException: Address already in use: bind
	at sun.nio.ch.Net.bind0(Native Method)
	at sun.nio.ch.Net.bind(Net.java:433)
	at sun.nio.ch.Net.bind(Net.java:425)
	at sun.nio.ch.ServerSocketChannelImpl.bind(ServerSocketChannelImpl.java:223)
	at sun.nio.ch.ServerSocketAdaptor.bind(ServerSocketAdaptor.java:74)
	at sun.net.httpserver.ServerImpl.<init>(ServerImpl.java:100)
	at sun.net.httpserver.HttpServerImpl.<init>(HttpServerImpl.java:50)
	at sun.net.httpserver.DefaultHttpServerProvider.createHttpServer(DefaultHttpServerProvider.java:35)
	at com.sun.net.httpserver.HttpServer.create(HttpServer.java:130)
	at com.sun.xml.internal.ws.transport.http.server.ServerMgr.createContext(ServerMgr.java:86)
	... 5 more

2、如果是异构系统。(比如java X C#)，建议所有的字段全部使用 String 类型。

否则SOAP在被不同的系统解析之后，字段类型方面会出现问题。

With SpringAop

当 @WebService 和 Spring Aop 增强一起使用时，是会报错的。

其实解决起来也简单，对于 @WebService 只是生成了对应的 xml 信息，便于生成对应的 bean、方法等信息。

所以可以如下使用：

String address = "http://127.0.0.1:12345/facade";
Endpoint.publish(address, new Facade());

即：需要发布的 Facade 类直接 new()，不需要 spring 注入。这样会导致直接调用的方法没有spring注入。

如果实在想同时使用 aop 和 webService，可以将 aop 这一层进行封装。最外层不要涉及到 aop 即可。

长度限制

在异构系统中。比如 c# 调用 Java。可能对返回值的长度有限制(默认为 65535 字节长度。)

在本地测试，Java 调用 Java 是没有这个限制的。

Web Service
Hello world
如何发布到服务器
Idea 创建 webService
With SpringAop
长度限制