利用Java编写简单的WebService实例-转载

2022-10-24 22:14:09

使用Axis编写WebService比较简单，就我的理解，WebService的实现代码和编写Java代码其实没有什么区别，主要是将哪些Java类发布为WebService。下面是一个从编写测试例子到发布WebService，以及编写测试代码的过程介绍。

本例子的WebService提供了两个方法，分别是sayHello和sayHelloToPerson，第一个只是返回一个"Hello"字符串，没有参数，第二个函数接受一个字符串作为参数，返回"Hello 参数值"，该例子比较简单，但是清楚的说明了从编写代码到发布为WebService以及测试编写好的WebService全过程。

编写服务代码

服务代码提供了两个函数，分别为sayHello和sayHelloToPerson，源代码如下：

  1. /*
  2. * File name: HelloService.java
  3. *
  4. * Version: v1.0
  5. *
  6. * Created on Aug 2, 2008 9:40:20 AM
  7. *
  8. * Designed by Stephen
  9. *
  10. * (c)Copyright 2008
  11. */
  12. package com.sinosoft.webservice;
  13. /** *//**
  14. * @author Stephen
  15. *
  16. * Test web service
  17. */
  18. public class HelloService {
  19. /** *//**
  20. * 不带参数的函数
  21. *
  22. * @return 返回Hello字符串
  23. */
  24. public String sayHello() {
  25. return "Hello";
  26. }
  27. /** *//**
  28. * 带参数的函数
  29. *
  30. * @param name
  31. *            名称
  32. * @return 返回加上名称的欢迎词
  33. */
  34. public String sayHelloToPerson(String name) {
  35. if (name == null || name.equals("")) {
  36. name = "nobody";
  37. }
  38. return "Hello " + name;
  39. }
  40. }

发布WebService

要将上边写的HelloService类发布为WebService，需要先搭建Web应用。下面是在Tomcat下使用Axis（http://ws.apache.org/axis/）创建WebService服务的例子。

在Tomcat下创建Web应用

在该例子中，在Tomcat下创建了一个context path为ws的WEB应用。

1. 在myeclipse中创建WebServiceTest的webproject

2. 在WEB-INF文件夹下web.xml文件，该文件的内容如下：

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web
  3. Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
  4. <web-app>
  5. <display-name>Apache-Axis</display-name>
  6. <listener>
  7. <listener-class>org.apache.axis.transport.http.AxisHTTPSessionListener</listener-class>
  8. </listener>
  9. <servlet>
  10. <servlet-name>AxisServlet</servlet-name>
  11. <display-name>Apache-Axis Servlet</display-name>
  12. <servlet-class>
  13. org.apache.axis.transport.http.AxisServlet
  14. </servlet-class>
  15. </servlet>
  16. <servlet>
  17. <servlet-name>AdminServlet</servlet-name>
  18. <display-name>Axis Admin Servlet</display-name>
  19. <servlet-class>
  20. org.apache.axis.transport.http.AdminServlet
  21. </servlet-class>
  22. <load-on-startup>100</load-on-startup>
  23. </servlet>
  24. <servlet>
  25. <servlet-name>SOAPMonitorService</servlet-name>
  26. <display-name>SOAPMonitorService</display-name>
  27. <servlet-class>
  28. org.apache.axis.monitor.SOAPMonitorService
  29. </servlet-class>
  30. <init-param>
  31. <param-name>SOAPMonitorPort</param-name>
  32. <param-value>5001</param-value>
  33. </init-param>
  34. <load-on-startup>100</load-on-startup>
  35. </servlet>
  36. <servlet-mapping>
  37. <servlet-name>AxisServlet</servlet-name>
  38. <url-pattern>/servlet/AxisServlet</url-pattern>
  39. </servlet-mapping>
  40. <servlet-mapping>
  41. <servlet-name>AxisServlet</servlet-name>
  42. <url-pattern>*.jws</url-pattern>
  43. </servlet-mapping>
  44. <servlet-mapping>
  45. <servlet-name>AxisServlet</servlet-name>
  46. <url-pattern>/services/*</url-pattern>
  47. </servlet-mapping>
  48. <servlet-mapping>
  49. <servlet-name>SOAPMonitorService</servlet-name>
  50. <url-pattern>/SOAPMonitor</url-pattern>
  51. </servlet-mapping>
  52. <!-- uncomment this if you want the admin servlet -->
  53. <!--
  54. <servlet-mapping>
  55. <servlet-name>AdminServlet</servlet-name>
  56. <url-pattern>/servlet/AdminServlet</url-pattern>
  57. </servlet-mapping>
  58. -->
  59. <session-config>
  60. <!-- Default to 5 minute session timeouts -->
  61. <session-timeout>5</session-timeout>
  62. </session-config>
  63. <!-- currently the W3C havent settled on a media type for WSDL;
  64. http://www.w3.org/TR/2003/WD-wsdl12-20030303/#ietf-draft
  65. for now we go with the basic 'it's XML' response -->
  66. <mime-mapping>
  67. <extension>wsdl</extension>
  68. <mime-type>text/xml</mime-type>
  69. </mime-mapping>
  70. <mime-mapping>
  71. <extension>xsd</extension>
  72. <mime-type>text/xml</mime-type>
  73. </mime-mapping>
  74. <welcome-file-list id="WelcomeFileList">
  75. <welcome-file>index.jsp</welcome-file>
  76. <welcome-file>index.html</welcome-file>
  77. <welcome-file>index.jws</welcome-file>
  78. </welcome-file-list>
  79. </web-app>

在上面的web.xml中主要是配置了axis的相关配置。

axis的相关配置

在上述的web.xml文件中已经对axis进行了配置，但是还需要进行额外的配置。

复制axis相关的jar文件

将axis的相关jar文件复制到WEB-INF\lib文件夹下。这些文件包括：

activation.jar
axis.jar
axis-ant.jar
commons-discovery-0.2.jar
commons-logging-1.0.4.jar
jaxrpc.jar
log4j-1.2.8.jar
saaj.jar
wsdl4j-1.5.1.jar

测试发布的Web应用

启动Tomcat服务，打开IE浏览器，访问地址http://127.0.0.1:8080/WebServiceTest/services，如果看到如下界面就说明AXIS部署成功了。

利用Java编写简单的WebService实例-转载

发布WebService

发布WebService需要使用现有的AdminService来实现，这里我写了一个批处理文件来发布WebService，以后如果需要发布其他文件，只需要修改相应的参数就可以了。

创建deploy.wsdd文件

文件deploy.wsdd内容如下所示：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <deployment xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">
  3. <service name="HelloServices" provider="java:RPC">
  4. <parameter name="className" value="com.sinosoft.webservice.HelloService"/>
  5. <parameter name="allowedMethods" value="*"/>
  6. </service>
  7. </deployment>

创建发布WebService服务的批处理文件

批处理文件deploywebservice.bat内容如下：

  1. java -cp axis-ant.jar;axis-schema.jar;axis.jar;commons-discovery-0.2.jar;commons-logging-1.0.4.jar;jaxrpc.jar;log4j-1.2.8.jar;saaj.jar;wsdl4j-1.5.1.jar;xmlsec-1.3.0.jar org.apache.axis.client.AdminClient -lhttp://localhost:8080/WebServiceTest/services/AdminService deploy.wsdd
  2. pause

其中上面的jar包我都拷到和bat文件在同一个目录，现在将所有的jar文件都加入到classpath中进行执行。

-l后的参数是本地要发布WebService的AdminService对应的访问地址。

最后deploy.wsdd是对应的配置文件名称。

发布WebService服务

将deploy.wsdd文件和deploywebservice.bat文件复制到同一个文件夹下，执行deploywebservice.bat批处理文件，就可以将deploy.wsdd中描述的Java类发布为WebService。发布完成之后在访问http://host:port/ws/services如下图所示：

利用Java编写简单的WebService实例-转载
 

从上图可以看出，发布成功后，多了一个HelloServices的服务。这样就说明HelloService发布成功了。

查看HelloServices的wsdl

访问http://127.0.0.1:8080/WebServiceTest/services/HelloServices?wsdl可以看到如下wsdl的内容：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <wsdl:definitions targetNamespace="http://127.0.0.1:8080/WebServiceTest/services/HelloServices" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://127.0.0.1:8080/WebServiceTest/services/HelloServices" xmlns:intf="http://127.0.0.1:8080/WebServiceTest/services/HelloServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  3. <!--WSDL created by Apache Axis version: 1.4
  4. Built on Apr 22, 2006 (06:55:48 PDT)-->
  5. <wsdl:message name="sayHelloToPersonRequest">
  6. <wsdl:part name="name" type="soapenc:string"/>
  7. </wsdl:message>
  8. <wsdl:message name="sayHelloRequest">
  9. </wsdl:message>
  10. <wsdl:message name="sayHelloToPersonResponse">
  11. <wsdl:part name="sayHelloToPersonReturn" type="soapenc:string"/>
  12. </wsdl:message>
  13. <wsdl:message name="sayHelloResponse">
  14. <wsdl:part name="sayHelloReturn" type="soapenc:string"/>
  15. </wsdl:message>
  16. <wsdl:portType name="HelloService">
  17. <wsdl:operation name="sayHello">
  18. <wsdl:input message="impl:sayHelloRequest" name="sayHelloRequest"/>
  19. <wsdl:output message="impl:sayHelloResponse" name="sayHelloResponse"/>
  20. </wsdl:operation>
  21. <wsdl:operation name="sayHelloToPerson" parameterOrder="name">
  22. <wsdl:input message="impl:sayHelloToPersonRequest" name="sayHelloToPersonRequest"/>
  23. <wsdl:output message="impl:sayHelloToPersonResponse" name="sayHelloToPersonResponse"/>
  24. </wsdl:operation>
  25. </wsdl:portType>
  26. <wsdl:binding name="HelloServicesSoapBinding" type="impl:HelloService">
  27. <wsdlsoap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
  28. <wsdl:operation name="sayHello">
  29. <wsdlsoap:operation soapAction=""/>
  30. <wsdl:input name="sayHelloRequest">
  31. <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://webservice.sinosoft.com" use="encoded"/>
  32. </wsdl:input>
  33. <wsdl:output name="sayHelloResponse">
  34. <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://127.0.0.1:8080/WebServiceTest/services/HelloServices" use="encoded"/>
  35. </wsdl:output>
  36. </wsdl:operation>
  37. <wsdl:operation name="sayHelloToPerson">
  38. <wsdlsoap:operation soapAction=""/>
  39. <wsdl:input name="sayHelloToPersonRequest">
  40. <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://webservice.sinosoft.com" use="encoded"/>
  41. </wsdl:input>
  42. <wsdl:output name="sayHelloToPersonResponse">
  43. <wsdlsoap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="http://127.0.0.1:8080/WebServiceTest/services/HelloServices" use="encoded"/>
  44. </wsdl:output>
  45. </wsdl:operation>
  46. </wsdl:binding>
  47. <wsdl:service name="HelloServiceService">
  48. <wsdl:port binding="impl:HelloServicesSoapBinding" name="HelloServices">
  49. <wsdlsoap:address location="http://127.0.0.1:8080/WebServiceTest/services/HelloServices"/>
  50. </wsdl:port>
  51. </wsdl:service>
  52. </wsdl:definitions>

用Java调用WebService实例

下面是用Java调用刚发布的WebService例子。

    1. /*
    2. * File name: TestHelloService.java
    3. *
    4. * Version: v1.0
    5. *
    6. * Created on Aug 2, 2008 9:54:10 AM
    7. *
    8. * Designed by Stephen
    9. *
    10. * (c)Copyright 2008
    11. */
    12. package test.com.sinosoft.webservice;
    13. import java.io.IOException;
    14. import java.net.MalformedURLException;
    15. import javax.xml.namespace.QName;
    16. import javax.xml.rpc.ServiceException;
    17. import org.apache.axis.client.Call;
    18. import org.apache.axis.client.Service;
    19. import org.apache.commons.logging.Log;
    20. import org.apache.commons.logging.LogFactory;
    21. /**
    22. * @author Stephen
    23. *
    24. * 测试调用WebService
    25. */
    26. public class TestHelloService {
    27. private static final Log log = LogFactory.getLog(TestHelloService.class);
    28. private static final String HELLO_SERVICE_ENDPOINT = "http://127.0.0.1:8080/WebServiceTest/services/HelloServices?wsdl";
    29. public static void main(String[] args) {
    30. TestHelloService tester = new TestHelloService();
    31. // tester.callSayHello();
    32. tester.callSayHelloToPerson();
    33. }
    34. public void callSayHello() {
    35. try {
    36. Service service = new Service();
    37. Call call = (Call) service.createCall();
    38. call.setTargetEndpointAddress(new java.net.URL(
    39. HELLO_SERVICE_ENDPOINT));
    40. //下面名字查询的http://127.0.0.1:8080/WebServiceTest/services/HelloServices?wsdl文件里有
    41. call.setOperationName(new QName("http://webservice.sinosoft.com/",
    42. "sayHello"));
    43. call.setReturnType(org.apache.axis.Constants.XSD_STRING);
    44. try {
    45. //远程调用发布的方法
    46. String ret = (String) call.invoke(new Object[] {});
    47. System.out.println("The return value is:" + ret);
    48. return;
    49. } catch (IOException e) {
    50. e.printStackTrace();
    51. }
    52. } catch (MalformedURLException e) {
    53. e.printStackTrace();
    54. } catch (ServiceException e) {
    55. e.printStackTrace();
    56. }
    57. log.error("call sayHello service error!");
    58. }
    59. public void callSayHelloToPerson() {
    60. try {
    61. Service service = new Service();
    62. Call call = (Call) service.createCall();
    63. call.setTargetEndpointAddress(new java.net.URL(HELLO_SERVICE_ENDPOINT));
    64. call.setOperationName(new QName("http://webservice.sinosoft.com/",
    65. "sayHelloToPerson"));
    66. call.addParameter("name", org.apache.axis.Constants.XSD_STRING,
    67. javax.xml.rpc.ParameterMode.IN);
    68. call.setReturnType(org.apache.axis.Constants.XSD_STRING);
    69. try {
    70. String ret = (String) call.invoke(new Object[] { "Stephen" });
    71. System.out.println("The return value is:" + ret);
    72. return;
    73. } catch (IOException e) {
    74. e.printStackTrace();
    75. }
    76. } catch (MalformedURLException e) {
    77. e.printStackTrace();
    78. } catch (ServiceException e) {
    79. e.printStackTrace();
    80. }
    81. log.error("call sayHello service error!");
    82. }
    83. }
上一篇：Linux sed命令 以行为单位编辑文本，或替换文本中的文字


下一篇：MicroPython教程之TPYBoard v102 CAN总线通信