WebService学习总结(三)——使用JDK开发WebService

WebService学习总结(三)——使用JDK开发WebService

一、WebService的开发手段

　　使用Java开发WebService时可以使用以下两种开发手段

　　　　1、 使用JDK开发(1.6及以上版本)

　　　　2、使用CXF框架开发(工作中)

二、使用JDK开发WebService

2.1、开发WebService服务器端

　　1、定义一个interface，使用

@WebService

注解标注接口，使用

@WebMethod

注解标注接口中定义的所有方法，如下所示：

package me.gacl.ws;

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

/**
* @author gacl
* 定义SEI(WebService EndPoint Interface(终端))
*/
//使用@WebService注解标注WebServiceI接口
@WebService
public interface WebServiceI {

//使用@WebMethod注解标注WebServiceI接口中的方法
@WebMethod
String sayHello(String name);

@WebMethod
String save(String name,String pwd);
}

　2、编写interface的实现类，使用@WebService注解标注实现类，实现接口中定义的所有方法，如下所示：

package me.gacl.ws;

import javax.jws.WebService;

/**
* @author gacl
* SEI的具体实现
*/
//使用@WebService注解标注WebServiceI接口的实现类WebServiceImpl
@WebService
public class WebServiceImpl implements WebServiceI {

@Override
public String sayHello(String name) {
System.out.println("WebService sayHello "+name);
return "sayHello "+name;
}

@Override
public String save(String name, String pwd) {
System.out.println("WebService save "+name+"， "+pwd);
return "save Success";
}
}

3、使用Endpoint(终端)类发布webservice，代码如下：

package me.gacl.ws.test;

import javax.xml.ws.Endpoint;

import me.gacl.ws.WebServiceImpl;

/**
* @author gacl
*
* 发布Web Service
*/
public class WebServicePublish {

public static void main(String[] args) {
//定义WebService的发布地址，这个地址就是提供给外界访问Webervice的URL地址，URL地址格式为：http://ip:端口号/xxxx
//String address = "http://192.168.1.100:8989/";这个WebService发布地址的写法是合法的
//String address = "http://192.168.1.100:8989/Webservice";这个WebService发布地址的是合法的
String address = "http://192.168.1.100:8989/WS_Server/Webservice";
//使用Endpoint类提供的publish方法发布WebService，发布时要保证使用的端口号没有被其他应用程序占用
Endpoint.publish(address , new WebServiceImpl());
System.out.println("发布webservice成功!");
}
}

运行WebServicePublish类，就可以将编写好的WebService发布好了，WebService的访问URL是：http://192.168.1.100:8989/WS_Server/Webservice ，如下图所示：



这里我们编写了一个WebServicePublish类来发布WebService，如果是Web项目，那么我们可以使用监听器或者Servlet来发布WebService，如下：

1、使用ServletContextListener监听器发布WebService

package me.gacl.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import javax.xml.ws.Endpoint;
import me.gacl.ws.WebServiceImpl;

/**
* @author gacl
* 用于发布WebService的监听器
*/
//使用Servlet3.0提供的@WebListener注解将实现了ServletContextListener接口的WebServicePublishListener类标注为一个Listener
@WebListener
public class WebServicePublishListener implements ServletContextListener {

@Override
public void contextDestroyed(ServletContextEvent sce) {

}

@Override
public void contextInitialized(ServletContextEvent sce) {
//WebService的发布地址
String address = "http://192.168.1.100:8080/WS_Server/WebService";
//发布WebService，WebServiceImpl类是WebServie接口的具体实现类
Endpoint.publish(address , new WebServiceImpl());
System.out.println("使用WebServicePublishListener发布webservice成功!");
}
}

将Web应用部署到服务器运行时，在初始化Web应用上下文时，就会发布WebService了。

　　接着我们可以使用发布的URL地址访问WebService，如下图所示：



　2、使用Servlet发布WebService

package me.gacl.web.controller;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.xml.ws.Endpoint;
import me.gacl.ws.WebServiceImpl;

/**
* @author gacl
* 用于发布WebService的Servlet
*/
//使用Servlet3.0提供的@WebServlet注解将继承HttpServlet类的普通Java类标注为一个Servlet
//将value属性设置为空字符串，这样WebServicePublishServlet就不提供对外访问的路径
//loadOnStartup属性设置WebServicePublishServlet的初始化时机
@WebServlet(value="",loadOnStartup=0)
public class WebServicePublishServlet extends HttpServlet {

/* (non-Javadoc)
* @see javax.servlet.GenericServlet#init()
* 在WebServicePublishServlet初始化时发布WebService
*/
public void init() throws ServletException {
//WebService的发布地址
String address = "http://192.168.1.100:8888/WebService";
//发布WebService，WebServiceImpl类是WebServie接口的具体实现类
Endpoint.publish(address , new WebServiceImpl());
System.out.println("使用WebServicePublishServlet发布webservice成功!");
}
}

将Web应用部署到服务器运行时，在初始化WebServicePublishServlet时，就会发布WebService了。如下图所示：



接着我们可以使用发布的URL地址访问WebService，如下图所示：



关于发布WebService主要就是通过javax.xml.ws.Endpoint类提供的静态方法publish进行发布，如果是普通的java项目，那么可以专门写一个类用于发布WebService，如果是Web项目，那么可以使用ServletContextListener或者Servlet进行发布。

2.2、开发WebService客户端

1、借助jdk的wsimort.exe工具生成客户端代码，wsimort.exe工具位于Jdk的bin目录下，如下图所示：



执行命令：wsimport -keep url(url为wsdl文件的路径)生成客户端代码。



打开命令行窗口，切换到src目录，执行”wsimport -keep http://192.168.1.100:8888/WebService?wsdl“生成客户端代码，如下图所示：



执行命令的过程中没有出现任何错误，那么代码就生成成功了，刷新一下src目录，就可以看到生成的代码了，如下图所示：



这里不得不提一点的是，生成webservice客户端代码可以有多种方式呢：

1、jdk方式

2、利用Apache的cxf也是可以生成客户端代码的

3、借助eclipse也是可以生成客户端代码的呢。

这里我之前就遇到这个坑了，使用jdk和apache生成客户端代码都无法正常运行，最后借助eclipse开发工具生成的就可以，原因我也不是很清楚，可能是jdk版本问题。我当时使用的是jdk1.8和jdk1.7都是不行的。之后发现它们生成的代码有细微的差别。接着往后面看，我会指出它们生成代码的区别的。。。。。。。

生成的客户端代码有以下文件：

1.ObjectFactory.java

2.package-info.java

3.Save.java

4.SaveResponse.java

5.SayHello.java

6.SayHelloResponse.java

7.WebServiceImpl.java

8.WebServiceImplService.java

附上客户端文件代码：

1.ObjectFactory.java

package com.zeng.client;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;

/**
* This object contains factory methods for each
* Java content interface and Java element interface
* generated in the com.zeng.service package.
* <p>An ObjectFactory allows you to programatically
* construct new instances of the Java representation
* for XML content. The Java representation of XML
* content can consist of schema derived interfaces
* and classes representing the binding of schema
* type definitions, element declarations and model
* groups.  Factory methods for each of these are
* provided in this class.
*
*/
@XmlRegistry
public class ObjectFactory {

private final static QName _Save_QNAME = new QName("http://service.zeng.com/", "save");
private final static QName _SaveResponse_QNAME = new QName("http://service.zeng.com/", "saveResponse");
private final static QName _SayHello_QNAME = new QName("http://service.zeng.com/", "sayHello");
private final static QName _SayHelloResponse_QNAME = new QName("http://service.zeng.com/", "sayHelloResponse");

/**
* Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.zeng.service
*
*/
public ObjectFactory() {
}

/**
* Create an instance of {@link Save }
*
*/
public Save createSave() {
return new Save();
}

/**
* Create an instance of {@link SaveResponse }
*
*/
public SaveResponse createSaveResponse() {
return new SaveResponse();
}

/**
* Create an instance of {@link SayHelloResponse }
*
*/
public SayHelloResponse createSayHelloResponse() {
return new SayHelloResponse();
}

/**
* Create an instance of {@link SayHello }
*
*/
public SayHello createSayHello() {
return new SayHello();
}

/**
* Create an instance of {@link JAXBElement }{@code <}{@link Save }{@code >}}
*
*/
@XmlElementDecl(namespace = "http://service.zeng.com/", name = "save")
public JAXBElement<Save> createSave(Save value) {
return new JAXBElement<Save>(_Save_QNAME, Save.class, null, value);
}

/**
* Create an instance of {@link JAXBElement }{@code <}{@link SaveResponse }{@code >}}
*
*/
@XmlElementDecl(namespace = "http://service.zeng.com/", name = "saveResponse")
public JAXBElement<SaveResponse> createSaveResponse(SaveResponse value) {
return new JAXBElement<SaveResponse>(_SaveResponse_QNAME, SaveResponse.class, null, value);
}

/**
* Create an instance of {@link JAXBElement }{@code <}{@link SayHello }{@code >}}
*
*/
@XmlElementDecl(namespace = "http://service.zeng.com/", name = "sayHello")
public JAXBElement<SayHello> createSayHello(SayHello value) {
return new JAXBElement<SayHello>(_SayHello_QNAME, SayHello.class, null, value);
}

/**
* Create an instance of {@link JAXBElement }{@code <}{@link SayHelloResponse }{@code >}}
*
*/
@XmlElementDecl(namespace = "http://service.zeng.com/", name = "sayHelloResponse")
public JAXBElement<SayHelloResponse> createSayHelloResponse(SayHelloResponse value) {
return new JAXBElement<SayHelloResponse>(_SayHelloResponse_QNAME, SayHelloResponse.class, null, value);
}

}

2.package-info.java

@javax.xml.bind.annotation.XmlSchema(namespace = "http://service.zeng.com/")
package com.zeng.client;

3.Save.java

package com.zeng.client;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlType;

/**
* <p>Java class for save complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="save">
*   <complexContent>
*     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
*       <sequence>
*         <element name="arg0" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
*         <element name="arg1" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
*       </sequence>
*     </restriction>
*   </complexContent>
* </complexType>
* </pre>
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "save", propOrder = {
"arg0",
"arg1"
})
public class Save {

protected String arg0;
protected String arg1;

/**
* Gets the value of the arg0 property.
*
* @return
*     possible object is
*     {@link String }
*
*/
public String getArg0() {
return arg0;
}

/**
* Sets the value of the arg0 property.
*
* @param value
*     allowed object is
*     {@link String }
*
*/
public void setArg0(String value) {
this.arg0 = value;
}

/**
* Gets the value of the arg1 property.
*
* @return
*     possible object is
*     {@link String }
*
*/
public String getArg1() {
return arg1;
}

/**
* Sets the value of the arg1 property.
*
* @param value
*     allowed object is
*     {@link String }
*
*/
public void setArg1(String value) {
this.arg1 = value;
}

}

4.SaveResponse.java

package com.zeng.client;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
* <p>Java class for saveResponse complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="saveResponse">
*   <complexContent>
*     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
*       <sequence>
*         <element name="return" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
*       </sequence>
*     </restriction>
*   </complexContent>
* </complexType>
* </pre>
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "saveResponse", propOrder = {
"_return"
})
public class SaveResponse {

@XmlElement(name = "_return")
protected String _return;

/**
* Gets the value of the return property.
*
* @return
*     possible object is
*     {@link String }
*
*/
public String getReturn() {
return _return;
}

/**
* Sets the value of the return property.
*
* @param value
*     allowed object is
*     {@link String }
*
*/
public void setReturn(String value) {
this._return = value;
}

}

5.SayHello.java

package com.zeng.client;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlType;

/**
* <p>Java class for sayHello complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="sayHello">
*   <complexContent>
*     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
*       <sequence>
*         <element name="arg0" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
*       </sequence>
*     </restriction>
*   </complexContent>
* </complexType>
* </pre>
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "sayHello", propOrder = {
"arg0"
})
public class SayHello {

protected String arg0;

/**
* Gets the value of the arg0 property.
*
* @return
*     possible object is
*     {@link String }
*
*/
public String getArg0() {
return arg0;
}

/**
* Sets the value of the arg0 property.
*
* @param value
*     allowed object is
*     {@link String }
*
*/
public void setArg0(String value) {
this.arg0 = value;
}

}

6.SayHelloResponse.java

package com.zeng.client;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
* <p>Java class for sayHelloResponse complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="sayHelloResponse">
*   <complexContent>
*     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
*       <sequence>
*         <element name="return" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
*       </sequence>
*     </restriction>
*   </complexContent>
* </complexType>
* </pre>
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "sayHelloResponse", propOrder = {
"_return"
})
public class SayHelloResponse {

@XmlElement(name = "_return")
protected String _return;

/**
* Gets the value of the return property.
*
* @return
*     possible object is
*     {@link String }
*
*/
public String getReturn() {
return _return;
}

/**
* Sets the value of the return property.
*
* @param value
*     allowed object is
*     {@link String }
*
*/
public void setReturn(String value) {
this._return = value;
}

}

7.WebServiceImpl.java

package com.zeng.client;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.Action;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;

/**
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.2.4-b01
* Generated source version: 2.2
*
*/
@WebService(name = "WebServiceImpl", targetNamespace = "http://service.zeng.com/")
//@XmlSeeAlso({ObjectFactory.class})
public interface WebServiceImpl {

/**
*
* @param arg1
* @param arg0
* @return
*     returns java.lang.String
*/
@WebMethod
@WebResult(targetNamespace = "")
@RequestWrapper(localName = "save", targetNamespace = "http://service.zeng.com/", className = "com.zeng.service.Save")
@ResponseWrapper(localName = "saveResponse", targetNamespace = "http://service.zeng.com/", className = "com.zeng.service.SaveResponse")
@Action(input = "http://service.zeng.com/WebServiceImpl/saveRequest", output = "http://service.zeng.com/WebServiceImpl/saveResponse")
public String save(
@WebParam(name = "arg0", targetNamespace = "")
String arg0,
@WebParam(name = "arg1", targetNamespace = "")
String arg1);

/**
*
* @param arg0
* @return
*     returns java.lang.String
*/
@WebMethod
@WebResult(targetNamespace = "")
@RequestWrapper(localName = "sayHello", targetNamespace = "http://service.zeng.com/", className = "com.zeng.service.SayHello")
@ResponseWrapper(localName = "sayHelloResponse", targetNamespace = "http://service.zeng.com/", className = "com.zeng.service.SayHelloResponse")
@Action(input = "http://service.zeng.com/WebServiceImpl/sayHelloRequest", output = "http://service.zeng.com/WebServiceImpl/sayHelloResponse")
public String sayHello(
@WebParam(name = "arg0", targetNamespace = "")
String arg0);

}

这里就要注意了，WebServiceImpl接口生成的时候会有这个注解:@XmlSeeAlso({ObjectFactory.class})，这个注解是需要注释掉的，不然启动报错的哟，我就被这个坑了很久才找到。。。。。。。

8.WebServiceImplService.java

package com.zeng.client;

import java.net.MalformedURLException;
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import javax.xml.ws.WebEndpoint;
import javax.xml.ws.WebServiceClient;
import javax.xml.ws.WebServiceException;
import javax.xml.ws.WebServiceFeature;

/**
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.2.4-b01
* Generated source version: 2.2
*
*/
@WebServiceClient(name = "WebServiceImplService", targetNamespace = "http://service.zeng.com/", wsdlLocation = "http://127.0.0.1:10000/WS_Server/Webservice?wsdl")
public class WebServiceImplService
extends Service
{

private final static URL WEBSERVICEIMPLSERVICE_WSDL_LOCATION;
private final static WebServiceException WEBSERVICEIMPLSERVICE_EXCEPTION;
private final static QName WEBSERVICEIMPLSERVICE_QNAME = new QName("http://service.zeng.com/", "WebServiceImplService");

static {
URL url = null;
WebServiceException e = null;
try {
url = new URL("http://127.0.0.1:10000/WS_Server/Webservice?wsdl");
} catch (MalformedURLException ex) {
e = new WebServiceException(ex);
}
WEBSERVICEIMPLSERVICE_WSDL_LOCATION = url;
WEBSERVICEIMPLSERVICE_EXCEPTION = e;
}

public WebServiceImplService() {
super(__getWsdlLocation(), WEBSERVICEIMPLSERVICE_QNAME);
}

public WebServiceImplService(WebServiceFeature... features) {
super(__getWsdlLocation(), WEBSERVICEIMPLSERVICE_QNAME, features);
}

public WebServiceImplService(URL wsdlLocation) {
super(wsdlLocation, WEBSERVICEIMPLSERVICE_QNAME);
}

public WebServiceImplService(URL wsdlLocation, WebServiceFeature... features) {
super(wsdlLocation, WEBSERVICEIMPLSERVICE_QNAME, features);
}

public WebServiceImplService(URL wsdlLocation, QName serviceName) {
super(wsdlLocation, serviceName);
}

public WebServiceImplService(URL wsdlLocation, QName serviceName, WebServiceFeature... features) {
super(wsdlLocation, serviceName, features);
}

/**
*
* @return
*     returns WebServiceImpl
*/
@WebEndpoint(name = "WebServiceImplPort")
public WebServiceImpl getWebServiceImplPort() {
return super.getPort(new QName("http://service.zeng.com/", "WebServiceImplPort"), WebServiceImpl.class);
}

/**
*
* @param features
*     A list of {@link javax.xml.ws.WebServiceFeature} to configure on the proxy.  Supported features not in the <code>features</code> parameter will have their default values.
* @return
*     returns WebServiceImpl
*/
@WebEndpoint(name = "WebServiceImplPort")
public WebServiceImpl getWebServiceImplPort(WebServiceFeature... features) {
return super.getPort(new QName("http://service.zeng.com/", "WebServiceImplPort"), WebServiceImpl.class, features);
}

private static URL __getWsdlLocation() {
if (WEBSERVICEIMPLSERVICE_EXCEPTION!= null) {
throw WEBSERVICEIMPLSERVICE_EXCEPTION;
}
return WEBSERVICEIMPLSERVICE_WSDL_LOCATION;
}

}

2、 借助生成的代码编写调用WebService对外提供的方法

　　wsimport工具帮我们生成了好几个java类，但我们只需要关心WebServiceImplService类和WebServiceImpl接口的使用即可，如下所示：

package me.gacl.ws.client;

import me.gacl.ws.WebServiceImpl;
import me.gacl.ws.WebServiceImplService;

/**
* @author gacl
* 调用WebService的客户端
*/
public class WSClient {

public static void main(String[] args) {
//创建一个用于产生WebServiceImpl实例的工厂，WebServiceImplService类是wsimport工具生成的
WebServiceImplService factory = new WebServiceImplService();
//通过工厂生成一个WebServiceImpl实例，WebServiceImpl是wsimport工具生成的
WebServiceImpl wsImpl = factory.getWebServiceImplPort();
//调用WebService的sayHello方法
String resResult = wsImpl.sayHello("孤傲苍狼");
System.out.println("调用WebService的sayHello方法返回的结果是："+resResult);
System.out.println("---------------------------------------------------");
//调用WebService的save方法
resResult = wsImpl.save("孤傲苍狼","123");
System.out.println("调用WebService的save方法返回的结果是："+resResult);
}
}

客户端调用服务器端的WebService方法运行结果如下：



从调用返回的结果显示，借助wsimport工具生成的客户端代码已经成功调用到了WebService中的方法。以上就是使用JDK开发WebService的相关内容。

本文出处:http://www.cnblogs.com/xdp-gacl/p/4259481.html