概念
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规范。
术语
- 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。两种开发过程最终形成的文件包括:
- SEI(对应WSDL中的一个Web Service port,在Java中表现为一个接口);
- SEI实现类;
- WSDL和XSD文件;
从Java开始的开发步骤:
- 声明某个类为@WebService,即将它声明为SEI实现类,然后对需要暴露的方法标注为@WebMethod;
- 运行wsgen命令生成其他所需文件;
- 发布Web Service;
SEI实现类
最简单的SEI实现类:
package com.lee.server; import javax.jws.WebMethod; import javax.jws.WebService; @WebService public class Hello { @WebMethod public String SayHello(String name){ return "Hello" + name; } }
此时的目录结构如下:
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文件)
使用wsgen命令生成所需文件
进入项目目录,执行wsgen命令
G:\leeWorkspace\jax_ws3>
wsgen -cp ./bin -r ./wsdl -s ./src -d ./bin -wsdl com.lee.server.Hello
执行中可能出现“directory
not found: wsdl”,手动建立wsdl目录。
发布Web Service
在应用程序中发布,JDK停工非常方便的API:Enndpoint.publish
package com.lee.publish; import javax.xml.ws.Endpoint; import com.lee.server.Hello; public class Main { /** * @param args * lee */ public static void main(String[] args) { // TODO Auto-generated method stub Endpoint.publish("http://localhost:8888/HelloService", new Hello()); } }
注意问号
根据wsdl文件生成客户端:
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 定义生成类的包名
wsimport -d ./bin -s ./src -p com.lee.client http://localhost:8888/HelloService?wsdl
package com.lee.publish; import javax.xml.ws.Endpoint; import com.lee.server.Hello; public class Main { /** * @param args * lee */ public static void main(String[] args) { // TODO Auto-generated method stub Endpoint.publish("http://localhost:8888/HelloService", new Hello()); } }
测试一下:
package com.lee.client.test; import com.lee.client.Hello; import com.lee.client.HelloService; public class ClientTest { public static void main(String[] args) { HelloService hs = new HelloService(); Hello hello = hs.getHelloPort(); System.out.println(hello.sayHello("lee")); } }
代码详见资源文件中jaxws的demo
下面介绍的是第二种方法发布:
wsgen -cp G:\leeWorkspace\jax_ws\build\classes -r ./wsdl -s ./src -d build -wsdl com.lee.Hello
布署webservice
在工程的WEB-INF目录下建立“sun-jaxws.xml”文件,内容如下:
<?xml version="1.0" encoding="UTF-8"?> <endpoints xmlns='http://java.sun.com/xml/ns/jax-ws/ri/runtime' version='2.0'> <endpoint name='Hello' implementation='com.lee.Hello' url-pattern='/HelloService' /> </endpoints>
web.xml文件:
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>jax_ws</display-name> <welcome-file-list> <welcome-file>index.html</welcome-file> <welcome-file>index.htm</welcome-file> <welcome-file>index.jsp</welcome-file> <welcome-file>default.html</welcome-file> <welcome-file>default.htm</welcome-file> <welcome-file>default.jsp</welcome-file> </welcome-file-list> <listener> <listener-class> com.sun.xml.ws.transport.http.servlet.WSServletContextListener </listener-class> </listener> <servlet> <servlet-name>Hello</servlet-name> <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class> <load-on-startup>2</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Hello</servlet-name> <url-pattern>/HelloService</url-pattern> </servlet-mapping> </web-app>
开始布署:
1. 在tomcat的webapps目录下建立一个目录叫“D:\tomcat2\webapps\JaxWSSample”
2. 把eclipse工程JaxWSSample下WebContent目录下所有的东西copy至该目录下
3. 重启tomcat
在ie中输入:
http://localhost:9090/JaxWSSample/HelloService?wsdl