Webservice介绍
以下概念来源于网络:
Web service是一个平台独立的,松耦合的、自包含的、基于可编程的web的应用程序,可使用开放的XML标准来描述、发布、发现、协调和配置这些应用程序,用于开发分布式的互操作的应用程序。
通过使用WebService,我们能够像调用本地方法一样去调用远程服务器上的方法。我们并不需要关心远程的那个方法是Java写的,还是PHP或C#写的;我们并不需要关心远程的方法是基于Unix平台,还是Windows平台,也就是说WebService与平台和语言无关。
axis2框架实现webservice服务端
环境
- IntelligentJ idea
- jdk1.8
- maven项目
maven依赖
<!--servlet依赖-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<!--服务端-->
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-transport-http</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-transport-local</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>org.apache.xmlbeans</groupId>
<artifactId>xmlbeans</artifactId>
<version>2.4.0</version>
</dependency>
<!--axis2 客户端-->
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-adb</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-kernel</artifactId>
<version>1.6.2</version>
</dependency>
项目结构
注意:在WEB-INF下创建services文件夹然后创建——xxxx—-Meta-INF—-services.xml
配置文件以及服务端接口demo
首先找到web.xml文件,将其中加上,其实就是对请求进行servlet拦截:
<servlet>
<servlet-name>AxisServlet</servlet-name>
<servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>AxisServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>
在java下创建如下类,此类相当于服务端提供的服务类,在名为TestService 的类中,有一个test(String test)方法:
public class TestService {
public String test(String param) {
System.out.println("服务端被请求了一次....");
return "axis2服务端(TestService)返回:"+param;
}
}
打开我们创建的services.xml,对其编写:
<?xml version="1.0" encoding="UTF-8"?>
<serviceGroup>
<!-- 指定服务名,随便定义 -->
<service name="ZipKinService">
<!-- 服务的作用说明,可写可不写 -->
<description>测试axis2webservices</description>
<!-- 指定要发布的类路径 自定义name-->
<parameter name="ServiceClass">
com.axis2.TestService
</parameter>
<!-- 类里面的方法名 ,若有多个方法,可以新增operation标签 -->
<operation name="test">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
</operation>
</service>
</serviceGroup>
运行axis2-webservice服务端
启动tomcat,我改了端口,所以启动项目的端口是18080,此时访问如下地址:
http://localhost:18080/services/ZipKinService?wsdl
地址的构成路径是:ip + 端口 + 项目名字 + web.xml中你配置的serlvet映射的名称 + services.xml(自己创建的)中的service name属性 + ?wsdl
若看到下图,说明服务端成功启动:
webservice客户端的两种实现形式
axis2框架实现客户端
依然在我们上面的项目中,maven依赖已经导入好。
客户端的axis2写法非常容易,不用配置任何东西,只需要写一个java类即可:
public class WebserviceClient {
public static void main(String[] args) {
try {
//本机tomcat端口为18080,参数是wsdl网址的一部分
EndpointReference targetEPR = new EndpointReference("http://localhost:18080/services/ZipKinService");
RPCServiceClient sender = new RPCServiceClient();
Options options = sender.getOptions();
//超时时间20s
options.setTimeOutInMilliSeconds(2 * 20000L);
options.setTo(targetEPR);
/** * 参数: * 1:在网页上执行 wsdl后xs:schema标签的targetNamespace路径 * <xs:schema targetNamespace="http://axis2.com"> * 2:<xs:element name="test"> ======这个标签中name的值 */
QName qname = new QName("http://axis2.com","test");
//方法的入参
String str = "我是客户端";
Object[] param = new Object[]{str};
//这是针对返值类型的
Class<?>[] types = new Class[]{String.class};
/** * RPCServiceClient类的invokeBlocking方法调用了WebService中的方法。 * invokeBlocking方法有三个参数 * 第一个参数的类型是QName对象,表示要调用的方法名; * 第二个参数表示要调用的WebService方法的参数值,参数类型为Object[]; * 第三个参数表示WebService方法的返回值类型的Class对象,参数类型为Class[]。 * 当方法没有参数时,invokeBlocking方法的第二个参数值不能是null,而要使用new Object[]{}。 */
Object[] response = sender.invokeBlocking(qname,param,types);
System.out.println(response[0]);
} catch (AxisFault e) {
e.printStackTrace();
}
}
}
虽然注释说的很明白了,但是还是用图来说话,有几个需要注意的点:
EndpointReference 中的url就是验证服务端那个地址去掉?wsdl的地址,即http://localhost:18080/services/ZipKinService
axis2客户端运行结果
客户端console
服务端console
cxf框架实现客户端
相对axis2的客户端来说,个人觉得cxf实现客户端相对麻烦一些。
引入对应的pom.xml中的依赖
<!--jaxrs 的依赖,对webservice注解的相关包-->
<dependency>
<groupId>javax.ws.rs</groupId>
<artifactId>javax.ws.rs-api</artifactId>
<version>2.1</version>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>javax.inject</groupId>
<artifactId>javax.inject</artifactId>
<version>1</version>
</dependency>
<!--cxf 客户端-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>3.2.2</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxrs</artifactId>
<version>3.2.2</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http-jetty</artifactId>
<version>3.2.2</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-core</artifactId>
<version>3.2.2</version>
</dependency>
与axis2不同的是,我们需要先自己定一个接口,定义如下:
/** * ZipKinService:webservice服务端提供的服务名-------->service.xml <service name="ZipKinService"> * targetNamespace:对应webservice服务端wsdl?中的targetNamespace */
@WebService(name = "ZipKinService",targetNamespace = "http://axis2.com")
public interface ZipKinServiceTest {
/** * CXF客户端本地接口调用端,参数param * @param test @WebMethod(operationName = "test")服务端方法名字,@WebParam(name = "param")参数名字 * @return @WebResult客户端返回的结果类型--->String */
@WebMethod(operationName = "test")
@WebResult(targetNamespace="http://axis2.com") String getServiceTest(@WebParam(name = "param",targetNamespace = "http://axis2.com")String test);
}
此时,定义完webservice的客户端接口,开始写我们的cxf客户端,其中需要实现上面的接口才能完成cxf客户端调用:
public class CxfClient {
@Test
public void testCxfClient() {
//结果
String result = "";
//axis2服务端地址
String url = "http://localhost:18080/services/ZipKinService";
//创建工厂
final JaxWsProxyfactorybean sf = new JaxWsProxyfactorybean();
//对工厂对象附加属性,服务端地址,客户端接口
sf.setServiceClass(ZipKinServiceTest.class);
sf.setAddress(url);
//通过工厂方法创建具体实现的实例,也就是上面定义的接口
ZipKinServiceTest zipKinServiceTest = (ZipKinServiceTest) sf.create();
//调用接口方法,接收返回值
result = zipKinServiceTest.getServiceTest("Hello!This's Client!");
System.out.println(result.toString());
}
}
客户端console
服务端console
总结
对比一下axis2和cxf的客户端,从写法上来说,代码量而言,axis2框架的客户端占优势,但是从代码的灵活性而言,cxf更胜一筹。
记一篇此博客的目的是对webservice理解更深一层,因为公司的大部分客户端是用axis2写的,而最近研究的zipkin监控链路官方却没有提供axis2相应的装配工具,对于cxf客户端倒是提供了与brave的整合!所以记录一下两者的客户端…..