最近在做公司项目的一个功能需要写WebSerice接口,为了系统得学习WebService,决定写一个测试接口的例子。
测试项目中使用的是SpringBoot(spring整合cxf需添加cxf-rt-frontend-jaxws,cxf-rt-transports-http依赖)
添加依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wyj</groupId>
<artifactId>wyj-interface-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>wyj-interface-service</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.9.RELEASE</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- http -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.4</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.1.41</version>
</dependency>
<!-- 热部署模块 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional> <!-- 这个需要为 true 热部署才有效 -->
</dependency>
<!-- CXF webservice -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
<version>3.1.11</version>
</dependency>
<!-- CXF webservice -->
<dependency>
<groupId>org.scala-lang</groupId>
<artifactId>scala-library</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
服务端接口
package com.wyj.webservice;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
/**
* webservice测试接口
*
*
* @author:WangYuanJun
* @date:2017年12月19日 下午9:36:49
*/
@WebService(name = "TestService", // 暴露服务名称
targetNamespace = "http://service.wyj.com"// 命名空间,一般是接口的包名倒序
)
public interface TestService {
@WebMethod
@WebResult(name = "String", targetNamespace = "")
String sendMessage(@WebParam(name = "username") String username);
}
服务端接口实现
package com.wyj.webservice;
import javax.jws.WebService;
import org.springframework.stereotype.Component;
/**
* webservice测试接口实现
*
*
* @author:WangYuanJun
* @date:2017年12月19日 下午9:37:20
*/
@WebService(serviceName = "TestService", // 与接口中指定的name一致
targetNamespace = "http://service.wyj.com", // 与接口中的命名空间一致,一般是接口的包名倒
endpointInterface = "com.wyj.webservice.TestService"// 接口地址
)
@Component
public class TestServiceImpl implements TestService {
@Override
public String sendMessage(String username) {
return "hello "+username;
}
}
cxf配置
package com.wyj.webservice;
import javax.xml.ws.Endpoint;
import org.apache.cxf.Bus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* cxf配置
*
*
* @author:WangYuanJun
* @date:2017年12月19日 下午9:38:24
*/
@Configuration
public class CxfConfig {
@Autowired
private Bus bus;
@Autowired
private TestService testService;
@Bean
public Endpoint endpoint(){
EndpointImpl endpoint = new EndpointImpl(bus, testService);
endpoint.publish("/TestService");
return endpoint;
}
}
默认服务在Host:port/services/*路径下
将TestService接口发布在了路径/services/TestService下,wsdl文档路径为,http://localhost:8080/services/TestService?wsdl
TestService的wsdl信息
<?xml version='1.0' encoding='UTF-8'?><wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://service.wyj.com" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" name="TestService" targetNamespace="http://service.wyj.com">
<wsdl:types>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://service.wyj.com" elementFormDefault="unqualified" targetNamespace="http://service.wyj.com" version="1.0">
<xs:element name="sendMessage" type="tns:sendMessage"/>
<xs:element name="sendMessageResponse" type="tns:sendMessageResponse"/>
<xs:complexType name="sendMessage">
<xs:sequence>
<xs:element minOccurs="0" name="username" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="sendMessageResponse">
<xs:sequence>
<xs:element minOccurs="0" name="String" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
</wsdl:types>
<wsdl:message name="sendMessage">
<wsdl:part element="tns:sendMessage" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:message name="sendMessageResponse">
<wsdl:part element="tns:sendMessageResponse" name="parameters">
</wsdl:part>
</wsdl:message>
<wsdl:portType name="TestService">
<wsdl:operation name="sendMessage">
<wsdl:input message="tns:sendMessage" name="sendMessage">
</wsdl:input>
<wsdl:output message="tns:sendMessageResponse" name="sendMessageResponse">
</wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="TestServiceSoapBinding" type="tns:TestService">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="sendMessage">
<soap:operation soapAction="" style="document"/>
<wsdl:input name="sendMessage">
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output name="sendMessageResponse">
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="TestService">
<wsdl:port binding="tns:TestServiceSoapBinding" name="TestServiceImplPort">
<soap:address location="http://localhost:8080/services/TestService"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
基于cxf的客户端调用webservice接口
package webservice;
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
import org.junit.Test;
/**
* webservice客户端
*
*
* @author:WangYuanJun
* @date:2017年12月19日 下午9:39:49
*/
public class WebServiceTest {
@Test
public void testSend1(){
// 创建动态客户端
JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
Client client = dcf.createClient("http://localhost:8080/services/TestService?wsdl");
// 需要密码的情况需要加上用户名和密码
// client.getOutInterceptors().add(new ClientLoginInterceptor(USER_NAME,PASS_WORD));
Object[] objects = new Object[0];
try {
// invoke("方法名",参数1,参数2,参数3....);
objects = client.invoke("sendMessage", "wyj");
System.out.println("返回数据:" + objects[0]);
} catch (java.lang.Exception e) {
e.printStackTrace();
}
}
}
调用后返回结果输出为
项目地址
SpringBoot整合cxf的WebService客户端地址
SpringBoot整合cxf的WebService服务端地址