WebService 入门

WebService 入门

WebService 可以将应用程序转换为 Web 应用程序。通过 Web 进行发布、查找和使用。

基本的 WebService 平台是 XML + HTTP。

WebService 遵循 SOAP 协议通过 XML 封装数据，然后由 HTTP 协议来传输数据。

WebService 平台的元素：

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

WSDL 文档解析，从下往上读
Types ：数据类型定义的容器，它使用某种类型系统(一般地使用 XML Schema 中的类型系统)。（入参和出参的数据类型）
Message ：通信消息的数据结构的抽象类型化定义。使用 Types 所定义的类型来定义整个消息的数据结构（入参和出参）。
Operation ：对服务中所支持的操作的抽象描述，一般单个Operation描述了一个访问入口的请求/响应消息对（方法）。
PortType ：对于某个访问入口点类型所支持的操作的抽象集合，这些操作可以由一个或多个服务访问点来支持（服务类）。
Binding ：特定服务访问点与具体服务类的绑定（不看内容，看关系）。
Port ：定义为 WebService 单个服务访问点。
Service：相关服务访问点的集合。

规范

1. JAX-WS（JSR 224）
JAX-WS（Java API For XML-WebService）是 JAX-RPC（Java API For XML-Remote Procedure Call） 的演进版本，但 JAX-WS 并不完全向后兼容 JAX-RPC 。JAX-WS规范的 API 位于 javax.xml.ws 包，其中大部分都是注解，提供 API 操作 Web 服务。

2. JAX-RS（JSR 311）
JAX-RS（Java API for RESTful Web Services） 是 JAVA 针对 REST（Representation State Transfer）风格制定的一套 Web 服务规范。

注解

通过注解，可以更加形像的描述 Web 服务。对自动生成的 WSDL 文档进行修改，让使用者更加清晰。

注解都位于 javax.jws 包下。

@WebService

定义服务，用于类上
targetNamespace ：命名空间
name：服务类的名称
portName：端口名称
serviceName：服务访问点集合名称
endpointInterface：SEI 接口地址，如果一个服务类实现了多个接口，只需要发布一个接口的方法，可通过此注解指定要发布服务的接口。

@WebMethod

定义方法，用于方法上
operationName：方法名
exclude：true 表示此方法不是 WebService 方法；反之则表示是 WebService 方法，默认是 false

@WebResult

定义返回值，用于方法返回值
name：返回值的元素的父标签名字

@WebParam

定义参数，用于方法参数
name：传入参数的元素的父标签名字

注意事项

1. 给类添加上 @WebService 注解后，类中所有的非静态方法都将会对外公布。不支持静态方法，final 方法。
2. 如果希望某个方法(非 static ,非 final )不对外公开，可以在方法上添加 @WebMethod(exclude=true)，阻止对外公开。
3. 如果一个类上，被添加了 @WebService 注解，则必须此类至少有一个可以公开的方法，否则将会启动失败。

常用发布 WebService 框架

1. Apache CXF：既支持 contract-last （从 Java 代码开始），也支持 contract-first（从 WSDL 开始）
2. Spring-WS：仅支持 contract-first（从 XSD Schema 开始）
3. Dubbo：基于 Apache CXF 的 frontend-simple 和 transports-http 实现。可以和原生 WebService 服务互操作，即：提供者用 Dubbo 的 WebService 协议暴露服务，消费者直接用标准 WebService 接口调用，或者提供方用标准 WebService 暴露服务，消费方用 Dubbo 的 WebService 协议调用。

发布 WebService 服务示例

定义接口

@WebService(targetNamespace = "http://service.webservice.chen.com")
public interface HelloService {

    @WebMethod
    String hello(@WebParam(name = "msg") String msg);
}

定义接口的实现类

@Service("helloService")
@WebService(serviceName = "HelloService",
        targetNamespace = "http://service.webservice.chen.com",
        endpointInterface = "com.chen.webservice.service.HelloService")
public class HelloServiceImpl implements HelloService {

    @Override
    public String hello(String msg) {
        return "Hello " + msg;
    }
}

配置 CXF 的 Endpoint

@Configuration
public class CxfConfig {

    @Autowired
    private Bus bus;
    @Autowired
    private HelloService helloService;

    @Bean
    public ServletRegistrationBean cxfDispatcherServlet() {
        return new ServletRegistrationBean(new CXFServlet(), "/services/*");
    }

    @Bean
    public Endpoint helloEndpoint() {
        EndpointImpl endpoint = new EndpointImpl(bus, helloService);
        endpoint.publish("/hello");
        return endpoint;
    }
}

启动应用，可查看已经创建的基于 SOAP 的 WebService 服务：

参考

1. GitHub 代码
2. Apache CXF
3. Spring-WS Reference
4. Producing a SOAP web service
5. Consuming a SOAP web service
6. Dubbo 的 WebService 协议实现