最近接到了一个对外发布接口的需求,所以找到CXF写了一个简单例子仅供参考。考虑到方便调用,服务端数据采用JSONArray封装,这样不需要客户端创建相关实体类就可以拿到目标数据。
一、项目目录
二、pom.xml依赖引入
依赖查询:https://mvnrepository.com/
注意:
依赖版本不同,代码也会有不同之处:springboot版本2.0.1,CXF版本3.2.4,json-lib版本2.4
gson是客户端用来将接收到的JSONArray形式的String类转成List的依赖包
特别的,<classifier>jdk15</classifier>必须有,不然报错。
<!-- 集成cxf -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
<version>3.2.4</version>
</dependency>
<!-- 服务端:用来生成JSONArray -->
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
<classifier>jdk15</classifier>
<version>2.4</version>
</dependency>
<!-- 客户端:用来解析JSONArray -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
</dependency>
三、代码介绍
(1)需要两个项目分别部署在服务端和客户端,这里使用server包和client包代替,在本机中进行测试。
① 首先新建springboot项目,然后application.properties中自定义接口指定相关信息:
访问用户名、密码、访问路径前缀(有默认值,此处指定/mySoap)、站点(终端路径)
#####server and client######
webservices.username=admin
webservices.password=root
webservices.service.prefix=/mySoap
webservices.service.endpoint=/user
② 提供读取类Properties
package com.ccl.webservice.server.service;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class Properties {
@Value("${webservices.username}")
private String USERNAME;
@Value("${webservices.password}")
private String PASSWORD;
public String getUSERNAME() {
return USERNAME;
}
public String getPASSWORD() {
return PASSWORD;
}
}
(2)server包(对应服务端)
① 业务接口及实现类
package com.ccl.webservice.server.service;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
@WebService
public interface IMessageService {
@WebMethod
public String getMessary(@WebParam(name = "param") String param);
}
package com.ccl.webservice.server.service;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.jws.WebService;
import net.sf.json.JSONArray;
// name:暴露的服务名称;targetNamespace:命名空间,默认为本类包名倒写;endpointInterface:接口地址
@WebService(name="testCXF", targetNamespace="http://service.server.webservice.ccl.com/",
endpointInterface="com.ccl.webservice.server.service.IMessageService")
public class MessageServiceImpl implements IMessageService {
@Override
public String getMessary(String param) {
List<Map<String, String>> list = new ArrayList<Map<String, String>>();
Map<String, String> messaryMap1 = new HashMap<String, String>();
messaryMap1.put("param", param);
messaryMap1.put("name", "张三");
messaryMap1.put("sex", "男");
messaryMap1.put("age", "20");
Map<String, String> messaryMap2 = new HashMap<String, String>();
messaryMap2.put("param", param);
messaryMap2.put("name", "李四");
messaryMap2.put("sex", "女");
messaryMap2.put("age", "18");
list.add(messaryMap1);
list.add(messaryMap2);
// 返回JSON数组字符串
return JSONArray.fromObject(list).toString();
}
}
② CXF发布接口配置类CXFConfig,此处先编写拦截器AuthInterceptor用于访问用户验证:
完成后启动项目,可以在浏览器中输入下面地址来查看发布的wsdl: http://127.0.0.1:8080/mySoap/user?wsdl
package com.ccl.webservice.server.interceptor;
import java.util.List;
import javax.xml.soap.SOAPException;
import org.apache.cxf.binding.soap.SoapHeader;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
public class AuthInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
private String USERNAME;
private String PASSWORD;
public AuthInterceptor(String username, String password) {
// 定义在什么阶段进行拦截
super(Phase.PRE_PROTOCOL);
this.USERNAME = username;
this.PASSWORD = password;
}
@Override
public void handleMessage(SoapMessage soapMessage) throws Fault {
String username = null;
String password = null;
List<Header> headers = soapMessage.getHeaders();
if(headers == null) {
throw new Fault(new IllegalArgumentException("headers未取到,无法验证用户信息"));
}
// 获取客户端传递的用户名和密码
for (Header header : headers) {
SoapHeader soapHeader = (SoapHeader) header;
Element e = (Element) soapHeader.getObject();
NodeList usernameNode = e.getElementsByTagName("username");
NodeList passwordNode = e.getElementsByTagName("password");
username = usernameNode.item(0).getTextContent();
password = passwordNode.item(0).getTextContent();
if(StringUtils.isEmpty(username) || StringUtils.isEmpty(password)) {
throw new Fault(new IllegalArgumentException("用户信息为空!"));
}
}
// 校验客户端用户名密码是否和服务端一致
if(!(username.equals(USERNAME) && password.equals(PASSWORD))) {
throw new Fault(new SOAPException("用户信息认证失败!"));
}
}
}
package com.ccl.webservice.server.config;
import javax.xml.ws.Endpoint;
import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.transport.servlet.CXFServlet;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.ccl.webservice.server.interceptor.AuthInterceptor;
import com.ccl.webservice.server.service.IMessageService;
import com.ccl.webservice.server.service.MessageServiceImpl;
@Configuration
public class CXFConfig {
@Value("${webservices.service.prefix}")
private String prefix;
@Value("${webservices.service.endpoint}")
private String endpoint;
@Value("${webservices.username}")
private String username;
@Value("${webservices.password}")
private String password;
/**
* 作用:改变服务名的前缀名
* 此方法被注释后:wsdl访问(默认)地址为http://127.0.0.1:8080/services/user?wsdl
* 去掉注释后:wsdl访问地址为:http://127.0.0.1:8080/mySoap/user?wsdl
* @return
*/
@SuppressWarnings("all")
@Bean
public ServletRegistrationBean dispatcherServlet() {
return new ServletRegistrationBean(new CXFServlet(), prefix + "/*");
}
@Bean(name = Bus.DEFAULT_BUS_ID)
public SpringBus springbus() {
return new SpringBus();
}
@Bean
public IMessageService messageServiceImpl() {
return new MessageServiceImpl();
}
/**
* JAX-WS:EndpointImpl
* 站点服务:终端路径
* @return
*/
@Bean
public Endpoint endpoint() {
EndpointImpl endpointImpl = new EndpointImpl(springbus(), messageServiceImpl());
// 服务端添加自定义拦截器:用户密码
endpointImpl.getInInterceptors().add(new AuthInterceptor(username, password));
endpointImpl.publish(endpoint);
return endpointImpl;
}
}
(3)client包(对应客户端)
① 编写拦截器ClientInterceptor用于在请求头添加用户信息用于验证
package com.ccl.webservice.client;
import java.util.List;
import javax.xml.namespace.QName;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.helpers.DOMUtils;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
public class ClientInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
private String username;
private String password;
public ClientInterceptor(String username, String password) {
// 发送请求之前进行拦截
super(Phase.PREPARE_SEND);
this.username = username;
this.password = password;
}
@Override
public void handleMessage(SoapMessage soapMessage) throws Fault {
List<Header> headers = soapMessage.getHeaders();
Document doc = DOMUtils.createDocument();
Element auth = doc.createElement("authrity");
Element username = doc.createElement("username");
Element password = doc.createElement("password");
username.setTextContent(this.username);
password.setTextContent(this.password);
auth.appendChild(username);
auth.appendChild(password);
headers.add(0, new Header(new QName("tiamaes"), auth));
}
}
② 客户端进行访问
这里采用动态调用方式访问,并通过JSONArray传递数据,不需要客户端编写业务代码和相关实体类,比较方便。
package com.ccl.webservice.client;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
import com.google.gson.Gson;
public class ClientMain {
// 客户端访问服务端接口地址
private static String address = "http://127.0.0.1:8080/mySoap/user?wsdl";
/**
* 动态调用方式
*/
@SuppressWarnings("all")
public static void main(String[] args) {
// 创建动态客户端
JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
Client client = dcf.createClient(address);
// 添加用户信息验证
client.getOutInterceptors().add(new ClientInterceptor("admin", "root"));
// 取返回值
Object[] objects = new Object[0];
try {
// 接口方法、参数
objects = client.invoke("getMessary", "clientParam");
Map[] maps = new Gson().fromJson(objects[0].toString(),Map[].class);
List<Map<String, String>> list = Arrays.asList(maps);
System.out.println("返回的数据:");
System.out.println(list);
} catch (Exception e) {
System.out.println("客户端接口访问失败!!");
e.printStackTrace();
}
}
}
四、运行测试
先运行服务端,再运行客户端进行访问: