使用NetBeans5.0建立JAX-WS2.0服务

核心提示：这篇文章主要介绍如何使用NetBeans5.0的内置特征快速建立JAX-WS2.0服务，一旦创建了工程，使用NetBeans5.0建立JAX-WS2.0服务，就可以使用一个命令进行编译（和测试），NetBeans的新版本具有创建JAX-RPC1.x服务的能力，另外，还要在build.xml文件中增加新的<wsge

　　这篇文章主要介绍如何使用NetBeans5.0的内置特征快速建立JAX-WS2.0服务。一旦创建了工程，就可以使用一个命令进行编译（和测试）。NetBeans的新版本具有创建JAX-RPC1.x服务的能力，而JAX-WS2.0仍旧在开发中。使用JAX-WS2.0创建web service的步骤已经进行了简化，使用很少的步骤你就可以将NetBeans中的web应用转化为web service。

前两部分描述获得和设置NetBeans IDE以及JAX-WS代码。第三部分包含了关于创建一个包含web service的web工程以及要用到的示例代码的信息。最后一部分描述了利用这个工程你自己的web service的技巧，也是从WSDL开始创建一个服务的指导。注意JAX-WS2.0需要J2SE5.0。

这篇指南包含以下话题：

1、 设置环境

2、 使用JAX-WS2.0库创建一个新的Web应用

3、 建立一个服务

l 从 java创建一个服务

4、 测试和调试

l 在Web Services Registry中测试服务

l 创建一个单元测试

l 调试客户端

5、 技巧

l 从WSDL创建服务

l 编写你自己的JAX-WS2.0 Web Services

1、 设置环境

在开始编写代码前，你必须保证已经拥有所有的必须软件。

安装软件

开始之前，你需要在机器上安装以下软件：

l NetBeans IDE 5.0（下载）

l Java SDK 5.0（下载）

对于本文中的例子，只需要两个步骤对NetBeans进行设置。第一步（强烈建议）删除或者重命名包含在Tomcat（内置于NetBeans5.0中）中的JAXP jar文件。这些文件已经包含在了JDK5.0中了（JAX-WS必须）。在NetBeans中这些文件路径是<netbeans_home>/enterPRise2/jakarta-tomcat-5.5.9/common/endorsed。你可以修改.jar扩展名以至于不能加载或者完全删除。尽管双份的jar包不应该造成冲突，仍然强烈建议从Tomcat中删除它们。

从http://jax-ws.dev.java.net工程得到JAX-WS2.0二进制版本。从Downloads/Nightly页面下载JAX-WS2.0二进制安装文件，运行“java -jar JAXWS_SI_rrrrmmdd.jar”进行安装。

警告：不要使用最新的官方JAX-WS RI 2.0 EA2版本，因为它和例子要用到的wsimport和wsgen任务不兼容。下一个版本（JAX-WS RI 2.0 EA3）应该可以工作。

为了使Tomcat服务器能够访问JAX-WS2.0库，将所有的jar文件从<jaxws-ri>/lib Directory复制到<netbeans_home>/enterprise2/jakarta-tomcat-5.5.9/common/lib文件夹下。

2、 使用JAX-WS2.0库创建一个新的Web应用

选择File—〉New Project（Ctrl-Shift-N）。在Categories下选择Web，然后选择Web application。输入“JAX-WS20Project”作为Project Name，指定Project Location目录，确保在Server下拉框中Bundled Tomcat (5.5.9)服务器被选中。

点击Next，然后点击Finish。

点击菜单栏中的Tools，然后选择Library Manager。点击New Library按钮，输入“JAX-WS20”，点击OK。由于在New Library中ClassPath打开着，点击Add JAR/Folder，从<jaxws-ri>/lib文件夹下选择所有的jar文件。

JAX-WS20 jar文件列表：

点击查看大图

在Projects试图中打开JAX-WS20工程，在Libraries节点打开Add Library。选择JAX-WS20库，点击Add Library按钮。

正常情况下，所有的jar文件在编译过程中都会被放置在web工程的war文件中（WEB-INF/lib文件夹下）。因为我们已经把这些jar文件复制到Tomcat服务器中了，所以就不需要再作为可发布的war包的一部分了。

为了减小可发布war包的大小，我们将JAX-WS20库从war包中排除，通过去掉对Libraries节点→Properties对话框中Package复选框的选择。

不选择Package复选框：

点击查看大图

点击OK。

JAX-WS20Project就完成了创建一个JAX-WS20服务的准备工作了。

3、 建立一个服务

从Java创建一个服务

增加服务类。在Projects视图中右键点击JAX-WS20Project节点，选择New和Java Class。输入“ServiceImpl”到Class Name栏中，“my.sample.server”到Package栏中，点击Finish。实现一个web service hello(java.lang.String)操作，利用JAX-WS2.0注释指定portType名称、服务名称和目标命名空间：

package my.sample.server;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.jws.WebMethod;

/**
* A simple java class that will become a web service.
*/
@WebService(name="Hello", serviceName="HelloService", targetNamespace="http://example.com")
public class ServiceImpl {

@WebMethod
public String hello(@WebParam(name="name") String s) {
System.out.println("Service received: " + s);
return "Hello "+s;
}

}

编译（F9）ServiceImpl类。

警告：为了使注释能够支持，JAX-WS20Project中的Source Level应该设置为1.5（在JAX-WS20Project节点调用Properties动作）：

点击查看大图

修改在Web Pages/WEB-INF文件夹下的发布描述符（web.xml），指定JAX-WS servlet类和ServletContextListener：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4"
xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<listener>
<listener-class>com.sun.xml.ws.transport.http.servlet.WSServletContextListener</listener-class>
</listener>
<servlet>
<servlet-name>my_service</servlet-name>
<servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>my_service</servlet-name>
<url-pattern>/hello</url-pattern>
</servlet-mapping>
<session-config>
<session-timeout>
30
</session-timeout>
</session-config>
<welcome-file-list>
<welcome-file>
index.jsp
</welcome-file>
</welcome-file-list>
</web-app>

在Web Pages/WEB-INF目录下创建sun-jaxws.xml文件（在WEB-INF节点下创建新的XML文档，在File Name栏中输入sun-jaxws）。sun-jaxws.xml文件被JAX-WS运行时用到，并且指定了服务终端实现类和相对URL：

<?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='my.sample.server.ServiceImpl'
url-pattern='/hello'/>
</endpoints>

最后一不是添加下面的xml片段到JAX-WS20Project/build.xml文件。为了编辑工程的build.xml文件，你可以使用菜单栏中的File→Open File或者打开Files选项卡而不是Projects，打开JAX-WS20Project节点，双击build.xml。这个target在编译服务类后将要被NetBeans调用，却是在创建war文件前。wsgen ant任务将会创建服务需要的JAXB和JAX-WS文件。关于wsgen工具的更多信息参见JAX-WS文档。

<!-- Overrides build-impl.xml target to create the server
artifacts that will be included in the war file. -->
<target name="-pre-dist">
<taskdef name="wsgen" classname="com.sun.tools.ws.ant.WsGen">
<classpath path="${javac.classpath}"/>
</taskdef>
<wsgen
debug="true"
keep="true"
destdir="build/web/WEB-INF/classes"
resourcedestdir="build/web/WEB-INF/classes"
sei="my.sample.server.ServiceImpl">
<classpath>
<pathelement path="${javac.classpath}"/>
<pathelement location="${java.home}/../lib/tools.jar"/>
<pathelement location="build/web/WEB-INF/classes"/>
</classpath>
</wsgen>
</target>

为了创建和启动服务，从菜单栏中选择Run和Run Main Project，或者使用快捷键F6。作为可选的（但是很有帮助）步骤，右键点击工程名称，选择Properties。选择“Run”节点，在右面的“Relative URL”栏中输入“/hello”。通过设置这个值，当你运行这个工程时，NetBeans会在浏览器中产生“http://localhost:8084/JAX-WS20Project/hello”地址。这就允许你在发布服务时进行确认，并且如果愿意你也可以查看wsdl文件。你可以修改服务类，只需要点击F6重新编译和发布服务，就可以看到在wsdl中发生了什么变化。

正常情况下，hello服务信息应该在浏览器窗口中出现。这就标志着服务发布成功。

端口名称

状态

信息

Hello

活动（ACTIVE）

地址：http://localhost:8084/JAX-WS20Project/hello

WSDL：http://localhost:8084/JAX-WS20Project/hello?wsdl

端口 QName：{http://example.com}HelloPort

实现类：my.sample.server.ServiceImpl

如果与上不同，在Output Window中查看Bundlet Tomcat（5.5.9）日志文件查看问题的源头。

4、 测试和调试

在Web Service Registry中测试服务

测试服务最简单的方法就是使用包含在NetBeans5.0中的Web Services Resgistry。在Runtime选项卡中右键点击Web Services，选择Add WebService。在“URL”栏中，输入web service WSDL文件的地址，在这里是“http://localhost:8084/JAX-WS20Project/hello?wsdl”，点击Get Web Service Description。这将会产生web service的信息。为了测试hello()操作，点击操作名称旁边的Test Operation。然后输入一个发送值，观察返回了什么（在这里，修改服务实现类为返回字符串增加一些文本也许是有用的）。点击Close退出测试。

在Web Service Registry中测试服务：

点击查看大图

如果愿意你可以通过点击Add按钮添加服务到注册器中：

那么，你可以在任何时候打开注册器，双击hello节点测试hello操作。

创建一个单元测试

对于一个包含web应用的完整应用程序，你可以正常的为这个应用创建一个新的工程。为了简单地为测试我们的新web service创建一个客户端，可以用NetBeans的单元测试功能。

由创建一个新的JUnit测试用例开始。在Projects选项卡中右键点击Test Packages节点，选择New→File/Folder→JUnit→Empty Test。在Class Name中输入“Service Test”，Package中输入“my.sample.test”，点击Finish。按照下面的方法实现testService()方法：

package my.sample.test;

import junit.framework.*;
import my.sample.test.generated.Hello;
import my.sample.test.generated.HelloService;

public class ServiceTest extends TestCase {

public ServiceTest(String testName) {
super(testName);
}

protected void setUp() throws Exception {
}

protected void tearDown() throws Exception {
}

// TODO add test methods here. The name must begin with 'test'. For example:
public void testService() {
HelloService service = new HelloService();
Hello proxy = service.getHelloPort();

String request = "Apples and Pears";
String response = proxy.hello(request);
System.out.println(response);
}

}

在运行前，添加这段xml代码到build.xml文件中。NetBeans会在编译和运行测试客户端前调用这个target。当这个target运行时，它确保服务被编译和发布（若需要就重新编译）。关于wsimport工具的更多信息参见JAX-WS文档。

<!-- Overrides build-impl.xml target to start server and
generate client artifacts before building test. -->
<target name="-pre-compile-test">
<taskdef name="wsimport" classname="com.sun.tools.ws.ant.WsImport">
<classpath path="${javac.classpath}"/>
</taskdef>

<!-- Use "debug" or "run" here. -->
<antcall target="run"/>

<echo>running wsimport</echo>
<wsimport
debug="true"
keep="true"
destdir="test"
package="my.sample.test.generated"
wsdl="http://localhost:8084/JAX-WS20Project/hello?wsdl"/>
</target>

为了运行测试，从菜单栏中选择Run，然后选择Test“JAX-WS20Project”。或者使用快捷键Alt-F6。在输出窗口，你应该可以看到从服务返回的“Hello Apples and Pears”：

调试客户端

单步执行应用程序中的代码（和JAX-WS代码）是比较简单的。由在ServiceImpl.java（15行）System.out.println("Service received: " + s);上放置断点开始。最快的方式就是打开文件，在适当的行上点击编辑器的左边框。或者将鼠标放在这一个行上，使用Ctrl-F8（关于使用调试器的完整信息参见NetBeans用户向导）。

当前你可以通过Run→Debug Main Project在调试模式下启动服务器，然而也可以一步运行客户端代码，在工程的build.xml文件中，修改“-pre-compile-test”target的“antcall”行，由<antcall target="run"/>到<antcall target="debug"/>。

<!-- Use "debug" or "run" here. -->
<antcall target="debug"/>

现在再次运行客户端进行测试（例如，按下Alt-F6）。在编译之前，NetBeans会以调试模式启动Tomcat服务器。当客户端启动后，调试器应该停止在ServiceImpl适当的行上，你可以单步执行服务器代码。注意：如果你在JAX-WS工作空间中在某一行上添加了断点，Alt-F6不会执行直到你将焦点移回到SampleApp工程中某个文件上，可以通过在编辑器中产生一个文件，点击Projects选项卡中的工程，等等完成。如果你对应用作了修改，当再一次运行时所有的东西都回根据需要重新编译。记住要停止调试，可以选择菜单栏中的Run，然后点击Finish Debugger Session，或者点击工具栏上的停止按钮。

点击查看大图

为了在客户端调试代码，由在ServiceTest.java的test1（）方法中放置断点开始。然后在Project视图中右键点击这个文件，选择Debug File（在编辑器中将这个作为活动文件，然后使用Ctrl-Shift-F5）。这会在调试器中启动客户端以及服务。

点击查看大图

5、 技巧

从WSDL创建服务

对于这个例子你可以使用JAX-WS20“<jaxws-ri>/samples/fromwsdl”文件夹下的AddNumbers.wsdl。首先复制这个文件到“JAX-WS20Project/web/WEB-INF/wsdl”文件夹下。

然后添加新的<servlet-mapping>到web.xml文件中：

<servlet-mapping>
<servlet-name>my_service</servlet-name>
<url-pattern>/addNumbers</url-pattern>
</servlet-mapping>

（注意<servlet-name>的值和Hello服务中的一样）。

添加新的<endpoint>到sun-jaxws.xml文件中：

<endpoint name="AddNumbers"
implementation="my.sample.server.AddNumbersImpl"
wsdl="WEB-INF/wsdl/AddNumbers.wsdl"
service='{http://duke.org}AddNumbersservice'
port='{http://duke.org}AddNumbersPort'
url-pattern="/addNumbers"/>

你还需要创建包含wsimport任务的“-pre-compile”target，它会在执行compile target之前被运行。我们的target会调用<wsimport>任务产生WSDL文件（和引用的schema文件）中所有必须的java artifact。

<!-- Overrides -pre-compile target in build.xml to create jax-ws
java artifacts that will created and compiled to WEB-INF/classes directory. -->
<target name="-pre-compile">
<taskdef name="wsimport" classname="com.sun.tools.ws.ant.WsImport">
<classpath path="${javac.classpath}"/>
</taskdef>

<echo>running wsimport</echo>
<!-- wsdl attribute is absolute path, so ${basedir} is included -->
<wsimport
debug="true"
keep="true"
destdir="build/web/WEB-INF/classes"
package="wsimport.generated.addnumbers"
wsdl="${basedir}/web/WEB-INF/wsdl/AddNumbers.wsdl"/>
</target>

注意：java artifact会生成到“WEB-INF/classes”文件下的“wsimport.generated.addnumbers”包中。

最后，你应该创建一个服务实现类（可以创建在同一个包中而非ServiceImpl）：

package my.sample.server;

import javax.jws.WebService;
import wsimport.generated.addnumbers.*;

/**
* A simple java class to implement a web service. Until the
* endpoint interface has been generated, the class declaration
* below will show up as a compiler error.
*/
@WebService(endpointInterface="wsimport.generated.addnumbers.AddNumbersPortType")
public class AddNumbersImpl implements AddNumbersPortType {

public void oneWayInt(int arg0) {
System.out.println("received value "+arg0);
}

public int addNumbers(int arg0,int arg1) throws AddNumbersFault_Exception {
if (arg0<0 arg1<0) throw new AddNumbersFault_Exception("negative number",new AddNumbersFault());
return arg0+arg1;
}

}

（实现类必须实现由wsimport任务生成的服务终端接口）

现在可以进行编译和发布这个工程了。

如果你运行工程，接下来的页面在浏览器中出现：

端口名称

Status（状态）

Information（信息）

Hello

ACTIVE

地址：http://localhost:8084/JAX-WS20Project/hello

WSDL：http://localhost:8084/JAX-WS20Project/hello?wsdl

端口QName：{http://example.com}HelloPort

实现类：my.sample.server.ServiceImpl

AddNumbers

ACTIVE

地址：http://localhost:8084/JAX-WS20Project/addNumbers

WSDL：http://localhost:8084/JAX-WS20Project/addNumbers?wsdl

端口QName：{http://duke.com}AddNumbersPort

实现类：my.sample.server.AddNumbersImpl

你也可以使用和Hello服务同样的方式测试和调试AddNumbers服务。这是从NetBeans Web Service Registry的一个屏幕截图：

点击查看大图

编写你自己的JAX-WS20 Web Services

为了编写你自己的服务，你可以添加另外一个服务实现类到这个工程中或者新建一个工程。你还需要添加新的<servlet-mapping>元素到web.xml中，新的<endpoint>元素到sun-jaxws.xml中。另外，还要在build.xml文件中增加新的<wsgen>任务（用来从java类生成web service）或者新的<wsimport>任务（用来从WSDL生成web service）。

更多的帮助请参考JAX-WS Project文档。

（出处：http://www.cncms.com）