webService第一天
看了网上好多关于webservice的例子,基本上对初学者来说都是模棱两可云里雾里,现在,我将网上关于webservice的讲解提炼出来,通过一个最简单使用并且方便的例子,告诉大家什么是webservice。
简单来说,webservice就是远程调用技术,也叫XML Web Service WebService是一种可以接收从Internet或者Intranet上的其它系统中传递过来的请求,轻量级的独立的通讯技术。是:通过SOAP在Web上提供的软件服务,使用WSDL文件进行说明,并通过UDDI进行注册。
XML:(Extensible Markup Language)扩展型可标记语言。面向短期的临时数据处理、面向万维网络,是Soap的基础。
Soap:(Simple Object Access Protocol)简单对象存取协议。是XML Web Service 的通信协议。当用户通过UDDI找到你的WSDL描述文档后,他通过可以SOAP调用你建立的Web服务中的一个或多个操作。SOAP是XML文档形式的调用方法的规范,它可以支持不同的底层接口,像HTTP(S)或者SMTP。
WSDL:(Web Services Description Language) WSDL 文件是一个 XML 文档,用于说明一组 SOAP 消息以及如何交换这些消息。大多数情况下由软件自动生成和使用。
如何发布一个webservice:
1. 创建一个web项目
为了简单明了,我一共创建了三个类,一个接口,一个接口实现类,一个发布类(main方法)。具体如下:
这是WebService接口,其中定义了一个sayHello(String name)的方法
记住一定要在类上加上@WebService注解
@WebMethod注解声明了这个方法是要发布出去的方法
这个类是WebService接口的实现类,写明了sayHello(String name)方法的方法体。
最后我们在服务器端运行WebServicePublish类中的main方法 ”控制台打印出发布webservice成功!“在浏览器中输入我们在WebServicePublish类中定义的address?wsdl(注意一定要加wsdl),浏览器显示如下,那么我们这个WebService就发布成功了。
下面,我们来看一下客户端怎么调用(这也是版本最多最杂的一步,大多数人前面都很明白,但是到了这里就直接懵逼了)
首先我们先创建一个client11客户端的项目,然后我们通过Win+R组合键调出cmd,在cmd中输入wsimport -s 我们这个项目的src路径 -keep 我们发布的webservice地址 例如:
然后去eclipse中刷新我们的项目,就会发现系统自动帮我们生成了许多类。
当然WSclient是我在系统生成之后自己写的一个客户端的测试类
我们就来重点看一下这个测试类是怎么写的:
运行过后控制台输出如下:
可以看到’hahahaha‘是服务器中写的,所以到此我们这个简单又实用的webservice服务器客户端就算完成了。
第二天又看见一个WebService发布的另两个方法
这里我们编写了一个WebServicePublish类来发布WebService,如果是Web项目,那么我们可以使用监听器或者Servlet来发布WebService,如下:
1、使用ServletContextListener监听器发布WebService
1 package me.gacl.listener; 2 3 import javax.servlet.ServletContextEvent; 4 import javax.servlet.ServletContextListener; 5 import javax.servlet.annotation.WebListener; 6 import javax.xml.ws.Endpoint; 7 import me.gacl.ws.WebServiceImpl; 8 9 /** 10 * @author gacl 11 * 用于发布WebService的监听器 12 */ 13 //使用Servlet3.0提供的@WebListener注解将实现了ServletContextListener接口的WebServicePublishListener类标注为一个Listener 14 @WebListener 15 public class WebServicePublishListener implements ServletContextListener { 16 17 @Override 18 public void contextDestroyed(ServletContextEvent sce) { 19 20 } 21 22 @Override 23 public void contextInitialized(ServletContextEvent sce) { 24 //WebService的发布地址 25 String address = "http://192.168.1.100:8080/WS_Server/WebService"; 26 //发布WebService,WebServiceImpl类是WebServie接口的具体实现类 27 Endpoint.publish(address , new WebServiceImpl()); 28 System.out.println("使用WebServicePublishListener发布webservice成功!"); 29 } 30 }
将Web应用部署到服务器运行时,在初始化Web应用上下文时,就会发布WebService了。
接着我们可以使用发布的URL地址访问WebService,如下图所示:
2、使用Servlet发布WebService
1 package me.gacl.web.controller; 2 3 import javax.servlet.ServletException; 4 import javax.servlet.annotation.WebServlet; 5 import javax.servlet.http.HttpServlet; 6 import javax.xml.ws.Endpoint; 7 import me.gacl.ws.WebServiceImpl; 8 9 /** 10 * @author gacl 11 * 用于发布WebService的Servlet 12 */ 13 //使用Servlet3.0提供的@WebServlet注解将继承HttpServlet类的普通Java类标注为一个Servlet 14 //将value属性设置为空字符串,这样WebServicePublishServlet就不提供对外访问的路径 15 //loadOnStartup属性设置WebServicePublishServlet的初始化时机 16 @WebServlet(value="",loadOnStartup=0) 17 public class WebServicePublishServlet extends HttpServlet { 18 19 /* (non-Javadoc) 20 * @see javax.servlet.GenericServlet#init() 21 * 在WebServicePublishServlet初始化时发布WebService 22 */ 23 public void init() throws ServletException { 24 //WebService的发布地址 25 String address = "http://192.168.1.100:8888/WebService"; 26 //发布WebService,WebServiceImpl类是WebServie接口的具体实现类 27 Endpoint.publish(address , new WebServiceImpl()); 28 System.out.println("使用WebServicePublishServlet发布webservice成功!"); 29 } 30 }
将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文件的路径)生成客户端代码。
创建一个WebService客户端测试项目,如下图所示:
打开命令行窗口,切换到src目录,执行"wsimport -keep http://192.168.1.100:8888/WebService?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 }
客户端调用服务器端的WebService方法运行结果如下:
从调用返回的结果显示,借助wsimport工具生成的客户端代码已经成功调用到了WebService中的方法。以上就是使用JDK开发WebService的相关内容。