JAX-WS使用wsgen和wsimport从Java创建WebService

概念

JAX-WS2.0的全称Java API for XML-Based Web Service 2.0.JAX-WS2.0是对JAX-RPC1.0规范的扩展，是JAX-RPC1.1的后续版本，JAX-RPC2.0标准发布不久后就被重命名为JAX-WS2.0.

JAX-WS2.0是Sun新的Web service协议栈，是一个完全基于标准实现的。在binding层，使用的是the Java Architecture for XML Binding(JAXB)，在parsing层，使用的是the Streaming API for XML(StAX),同时它还完全支持schema规范。

官网下载地址：http://jax-ws.java.net/2.1.1/index.html
术语

• SEI：Service Endpoint Interface
• JAX：Java API for XML Web Servcie
• JAX-WS RI：JAX-WS Reference Implementation
• SAAJ：SOAP with Attachments API for Java

创建 Web Service方式

JAX-WS 2.0有两种创建Web Service的开发过程：自顶向下和自定向上。自顶向下方式指通过一个WSDL文件来创建Web Service；自底向上是从Java类出发创建Web Service。两种开发过程最终形成的文件包括：

1. SEI(对应WSDL中的一个Web Service port，在Java中表现为一个接口)；
2. SEI实现类；
3. WSDL和XSD文件；

从Java开始的开发步骤：

1. 声明某个类为@WebService，即将它声明为SEI实现类，然后对需要暴露的方法标注为@WebMethod；
2. 运行wsgen命令生成其他所需文件；
3. 发布Web Service；

SEI实现类

最简单的SEI实现类：

  
  
package net.oseye;
 
import javax.jws.WebMethod;
import javax.jws.WebService;
 
@WebService
public class Hello {
	@WebMethod
	public String SayHello(String name){
		return String.format("Hello，%s",name);
	}
}

此时的目录结构如下：

使用wsgen命令生成所需文件

1. 进入JAX-WS-Java-Server项目目录如：

      
      
   D:\MyTemp\workspace\JAX-WS-Java-Server>

2. 执行wsgen命令：

      
      
    wsgen -cp ./bin -r ./wsdl -s ./src -d ./bin -wsdl net.oseye.Hello

3. 执行中可能出现“directory not found: wsdl”，手动建立wsdl目录。
4. 成功后可在bin、src目录的命名空间net.oseye里看到生成的jaxws文件夹，以及在wsdl目录中的HelloService.wsdl和HelloService_schema1.xsd。

此时的目录结构如下：

发布Web Service

在应用程序中发布,JDK停工非常方便的API：Enndpoint.publish

  
  
package net.oseye;
 
import javax.xml.ws.Endpoint;
 
public class Main {
 
	/**
	 * @param args
	 */
	public static void main(String[] args) {
		Endpoint.publish("http://localhost:8808/HelloService", new Hello());
	}
 
}

运行应用程序，地址栏输入：http://localhost:8808/HelloService，接客预览：

wsgen工具简介

wsgen 是在JDK的bin目录下的一个exe文件（Windows版），该命 令的主要功能是用来生成合适的JAX-WS。它读取Web Service的终端类文件，同时生成所有用于发布Web Service所依赖的源代码文件和经过编译过的二进制类文件。这里要特别说明的是，通常在Web Service Bean中用到的异常类会另外生成一个描述Bean，如果Web Service Bean中的方法有申明抛出异常，这一步是必需的，否则服务器无法绑定该对像。此外，wsgen 还能辅助生成WSDL和相关的xsd文件。wsgen 从资源文件生成一个完整的操作列表并验证web service是否合法，可以完整发布。

命令参数说明：

• -cp 定义classpath
• -r 生成 bean的wsdl文件的存放目录
• -s 生成发布Web Service的源代码文件的存放目录（如果方法有抛出异常，则会生成该异常的描述类源文件）
• -d 生成发布Web Service的编译过的二进制类文件的存放目录（该异常的描述类的class文件）

客户端开发的通常过程是从已有的WSDL处罚，创建辅助类JAXB对象和Service代理类，然后基于这些类开发自己的客户端应用。

开发步骤：

1. 创建eclipse项目；
2. 运行wsimport命令生成客户端代码；
3. 通过代理调用服务；

创建Ecplise项目

使用Eclipse创建客户端项目JAX-WS-Client，目录结构如下：

运行wsimport工具

使用上篇博文创建的Web Service地址，命令行进入JAX-WS-Client项目目录，运行：

 
 
wsimport -d ./bin -s ./src http://localhost:8808/HelloService?wsdl

此时的目录结构如下：

通过代理调用服务

  
  
package net.oseye;
 
public class Main {
 
	/**
	 * @param args
	 */
	public static void main(String[] args) {
		HelloService helloService=new HelloService();
		String helloStr=helloService.getHelloPort().sayHello("oseye");
		System.out.println(helloStr);
	}
}

wsimport简介

wsimport也是在JDK的bin目录下的一个exe文件（Windows版），主要功能是根据服务端发布的wsdl文件生成客户端存根及框架，负责 与Web Service 服务器通信，并在将其封装成实例，客户端可以直接使用，就像使用本地实例一样。对Java而言，wsimport帮助程序员生存调用web service所需要的客户端类文件.java和.class。要提醒指出的是，wsimport可以用于非Java的服务器端，如：服务器端也许是C# 编写的web service，通过wsimport则生成Java的客户端实现。

命令参数说明：

• -d 生成客户端执行类的class文件的存放目录
• -s 生成客户端执行类的源文件的存放目录
• -p 定义生成类的包名