一、开发工具与环境
1、 jdk1.6版本以上(jdk1.6.0_21及以上版本)
2 、eclipse4.5版本
3、与Web服务相关的类,都位于Javax.jws.*包中
@WebService——此注解用在类上指定将此类发布成一个WebService;
@WebMethod——此注解用在类中所定义的方法上,将方法发布成一个WebService服务;可省略,但要将发布服务的方法设置为public;
EndPoint——此类为端点服务类,其中publish()方法用于将一个已经添加了@WebService注解对象绑定到一个地址的端口上,用于发布。
4、使用jdk的EndPoint发布web服务要点
4.1.在要发布服务的类上添加@WebService注解。将要发布服务的方法设置为public。
4.2.调用EndPoint.publish(,)发布服务
其他注意事项:
1.给类添加上@WebService注解后,类中所有的非静态方法都将会对外公布。
2.不支持静态方法,final方法。
3.如果希望某个方法(非static,非final)不对外公开,可以在方法上添加@WebMethod(exclude=true),阻止对外公开。
4.被添加了@WebService注解的类至少要有一个可以公开的方法,否则将会启动失败。
二、JDK开发webservice
1、定义一个interface,使用@WebService注解标注接口,使用@WebMethod注解标注接口中定义的所有方法,如下所示:
package com.me.ws;
import javax.jws.WebMethod;
import javax.jws.WebService;
/**
*
* @author Administrator
* 使用@WebService注解将接口注解为一个webservice服务
*/
@WebService
public interface WebServiceInterface {
/*
* 使用@WebMethod注解标注WebServiceInterface接口中的方法
*/
@WebMethod
public String sayHello(String name);
@WebMethod
public String save( String name);
}
2、定义一个实现类实现接口中所有方法,并用@WebService注解将实现类也注解成一个webservice服务,如下所示:
package com.me.ws;
import javax.jws.WebService;
/**
*
* @author Administrator
* 使用@WebService注解标注实现类,将实现类注解成为一个webservice服务
*/
//
@WebService
public class WebServiceImpl implements WebServiceInterface {
@Override
public String sayHello(String name) {
System.out.println("hello world "+name);
return "hello world "+name;
}
@Override
public String save(String name) {
System.out.println("save "+name);
return "save "+name;
}
}
3、发布服务
3.1 、使用Endpoint(终端)类发布webservice,如下所示:
package com.me.ws;
import javax.xml.ws.Endpoint;
/**
*
* @author Administrator
* 发布webservice服务(JDK是使用Endpoint(终端)类发布webservice服务的)
*/
public class WebServicePublish {
public static void main(String[] args) {
/**
*1、先提供一个给别人访问的url地址
*/
String address = "http://192.168.1.72:8089/ws_service/hello";
// 2、使用Endpoint的publish方法来发布这个服务
//Endpoint.publish(address, 接口实现类)
Endpoint.publish(address, new WebServiceImpl());
System.out.println("发布webservice成功!");
}
}
运行WebServicePublish 类 后,就可以将编写好的WebService发布好了,它的WSDL访问地址是http://192.168.1.72:8089/ws_service/hello?wsdl。
以上是java工程的webservice发布,如果是web项目,则我们可以使用监听器或者Servlet来发布WebService(在这里就需要注意一点,项目中引用的servlet包必须是3.0及以上版本才行),
3.2 、使用监听器发布webservice,代码如下:
package com.me.ws;
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.72:8089/ws_service/hello";
//发布WebService,WebServiceImpl类是WebServie接口的具体实现类
Endpoint.publish(address , new WebServiceImpl());
System.out.println("使用WebServicePublishListener发布webservice成功!");
}
}
在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>ws_service</display-name>
<!-- 加载自定义监听器 -->
<listener>
<listener-class> com.me.ws.webServicePublishLinster</listener-class>
</listener>
</web-app>
将Web应用部署到服务器运行时,在初始化Web应用上下文时,就会发布WebService了。
接着我们可以使用发布的URL地址访问WebService
3.3、使用servlet发布webservice,代码如下:
package com.me.ws;
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.72:8089/ws_service/hello";
//发布WebService,WebServiceImpl类是WebServie接口的具体实现类
Endpoint.publish(address , new WebServiceImpl());
System.out.println("使用WebServicePublishServlet发布webservice成功!");
}
}
在web.xml上不再需要对servlet进行配置,如下(因为servlet3.0中的@WebServlet注解已经将该类注解为了servlet类,所以不需要另外在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>ws_service</display-name>
</web-app>
将Web应用部署到服务器运行时,在初始化WebServicePublishServlet时,就会发布WebService了。如下图所示:
接着我们可以使用发布的URL地址访问WebService
以上是webservice服务开发,下面讲它的客户端的开发
三、开发WebService客户端
1、借助jdk的wsimport.exe工具生成客户端代码,wsimport.exe工具位于Jdk的bin目录下,如下图所示:
执行命令:wsimport -keep url(url为wsdl文件的路径)生成客户端代码。
创建一个WebService客户端测试项目,如下图所示:
打开命令行窗口,切换到src目录,执行"wsimport -keep http://192.168.1.72:8089/ws_service/hello?wsdl"生成客户端代码,如下图所示:
执行命令的过程中没有出现任何错误,那么代码就生成成功了,刷新一下src目录,就可以看到生成的代码了,如下图所示:
2、 借助生成的代码编写调用WebService对外提供的方法
wsimport工具帮我们生成了好几个java类,但我们只需要关心WebServiceImplService类和WebServiceImpl接口的使用即可,如下所示:
1 package me.gacl.ws.client;
2
3 import me.gacl.ws.WebServiceImpl;
4 import me.gacl.ws.WebServiceImplService;
5
6 /**
7 * @author gacl
8 * 调用WebService的客户端
9 */
10 public class WSClient {
11
12 public static void main(String[] args) {
13 //创建一个用于产生WebServiceImpl实例的工厂,WebServiceImplService类是wsimport工具生成的
14 WebServiceImplService factory = new WebServiceImplService();
15 //通过工厂生成一个WebServiceImpl实例,WebServiceImpl是wsimport工具生成的
16 WebServiceImpl wsImpl = factory.getWebServiceImplPort();
17 //调用WebService的sayHello方法
18 String resResult = wsImpl.sayHello("孤傲苍狼");
19 System.out.println("调用WebService的sayHello方法返回的结果是:"+resResult);
20 System.out.println("---------------------------------------------------");
21 //调用WebService的save方法
22 resResult = wsImpl.save("孤傲苍狼","123");
23 System.out.println("调用WebService的save方法返回的结果是:"+resResult);
24 }
25 }
从调用返回的结果显示,借助wsimport工具生成的客户端代码已经成功调用到了WebService中的方法。以上就是使用JDK开发WebService的相关内容。