目录
一、背景概述
二、客户端文档
1、接口服务界说
2、响应格式界说
三、客户端文档使用流程
1、补充服务端地址配置
2、生成服务端代码
3、优化初始代码并实现接口
4、服务发布
4.1、添加依赖
4.2、完善CxfConfig，以实现自动发布服务
4.3、补充日志监控
5、测试
5.1、访问服务端文档
5.2、测试数据接入
5.2.1、通过curl命令调试本地测试
5.2.2、SoapUI调试
6、wsdl文档关键配置简述
6.1、服务端地址
6.2、命名空间
6.3、portName
6.4、入参
6.5、响应体界说
四、踩坑历程
1、请求乐成但拿不到响应信息xml
2、生产情况请求服务端地址404
3、甲方ERP体系需要我们自动推送响应信息，并且需要鉴权
五、附录
一、背景概述
基于WebService SOAP实现用于第三方ERP推送数据的接口。该接口要支持第三方体系通过Http协议的请求将发货单数据推送到我们的物流体系，因此我们需要开发一个相应webservice服务端和客户端来吸收发货单数据以及推送响应信息。
二、客户端文档
第三方提供的，用于界说公共参数，包括命名空间、portName、portType、服务接口名称、接口传参等信息。
1、接口服务界说
2、响应格式界说
- <?xml version="1.0" encoding="UTF-8"?>
- <wsdl:definitions name="SI_LOAD_DEOR_OUTBOUND_REBACK" targetNamespace="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:p1="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
- xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
- xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
- <wsdl:documentation/>
- <wsp:UsingPolicy wsdl:required="true"/>
- <wsp:Policy wsu:Id="OP_SI_LOAD_DEOR_OUTBOUND_REBACK"/>
- <wsdl:types>
- <xsd:schema targetNamespace="http://qhyhgf.com.cn/sd/Invoice"
- xmlns="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="MT_LOAD_DEOR_REBACK" type="DT_LOAD_DEOR_REBACK"/>
- <xsd:complexType name="DT_LOAD_DEOR_REBACK">
- <xsd:annotation>
- <xsd:appinfo source="http://sap.com/xi/VersionID">33e74ebc0b5b11e6b0e100000044d356</xsd:appinfo>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="ITEM" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:appinfo source="http://sap.com/xi/TextID">2637a7160b5b11e6bf1e00ff9ec07684</xsd:appinfo>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="VBELN" type="xsd:string">
- <xsd:annotation>
- <xsd:appinfo source="http://sap.com/xi/TextID">27758e2f079111e693f700ff9ec07684</xsd:appinfo>
- <xsd:documentation>发货单号</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="ZJCBS" type="xsd:string">
- <xsd:annotation>
- <xsd:appinfo source="http://sap.com/xi/TextID">27758e30079111e6b00800ff9ec07684</xsd:appinfo>
- <xsd:documentation>接收方成功标识</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="ZJSXX" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:appinfo source="http://sap.com/xi/TextID">27758e31079111e6842c00ff9ec07684</xsd:appinfo>
- <xsd:documentation>接收方信息</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:schema>
- </wsdl:types>
- <wsdl:message name="MT_LOAD_DEOR_REBACK">
- <wsdl:documentation/>
- <wsdl:part name="MT_LOAD_DEOR_REBACK" element="p1:MT_LOAD_DEOR_REBACK"/>
- </wsdl:message>
- <wsdl:portType name="SI_LOAD_DEOR_OUTBOUND_REBACK">
- <wsdl:documentation/>
- <wsdl:operation name="SI_LOAD_DEOR_OUTBOUND_REBACK">
- <wsdl:documentation/>
- <wsp:Policy>
- <wsp:PolicyReference URI="#OP_SI_LOAD_DEOR_OUTBOUND_REBACK"/>
- </wsp:Policy>
- <wsdl:input message="p1:MT_LOAD_DEOR_REBACK"/>
- </wsdl:operation>
- </wsdl:portType>
- <wsdl:binding name="SI_LOAD_DEOR_OUTBOUND_REBACKBinding" type="p1:SI_LOAD_DEOR_OUTBOUND_REBACK">
- <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
- <wsdl:operation name="SI_LOAD_DEOR_OUTBOUND_REBACK">
- <soap:operation soapAction="http://sap.com/xi/WebService/soap1.1"
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
- <wsdl:input>
- <soap:body use="literal"
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
- </wsdl:input>
- </wsdl:operation>
- </wsdl:binding>
- <wsdl:service name="SI_LOAD_DEOR_OUTBOUND_REBACKService">
- <wsdl:port name="HTTP_Port" binding="p1:SI_LOAD_DEOR_OUTBOUND_REBACKBinding">
- <soap:address location="http://ip:port/XISOAPAdapter/MessageServlet?senderParty=&senderService=BC_LOAD_SYSTEM&receiverParty=&receiverService=&interface=SI_LOAD_DEOR_OUTBOUND_REBACK&interfaceNamespace=http%3A%2F%2Fqhyhgf.com.cn%2Fsd%2FInvoice"
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
- </wsdl:port>
- <wsdl:port name="HTTPS_Port" binding="p1:SI_LOAD_DEOR_OUTBOUND_REBACKBinding">
- <soap:address location="https://ip:port/XISOAPAdapter/MessageServlet?senderParty=&senderService=BC_LOAD_SYSTEM&receiverParty=&receiverService=&interface=SI_LOAD_DEOR_OUTBOUND_REBACK&interfaceNamespace=http%3A%2F%2Fqhyhgf.com.cn%2Fsd%2FInvoice"
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
- </wsdl:port>
- </wsdl:service>
- </wsdl:definitions>
1、补充服务端地址配置
需要先补充服务端服务地址配置。其中 <wsdl:service name="SI_LOAD_DEOR_OUTBOUND"> 与 <wsdl:port binding="tns:SI_LOAD_DEOR_OUTBOUNDSoapBinding" name="SI_LOAD_DEOR_OUTBOUNDBinding"> 要与客户端内的配置保持同等，location地址可以自行界说，我目前界说为：http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices。
- <wsdl:service name="SI_LOAD_DEOR_OUTBOUND">
- <wsdl:port binding="tns:SI_LOAD_DEOR_OUTBOUNDSoapBinding" name="SI_LOAD_DEOR_OUTBOUNDBinding">
- <soap:address location="http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices"/>
- </wsdl:port>
- </wsdl:service>
使用 wsimport 命令（jdk1.8会自带，浅提一嘴，wsimport 在Java 9中就已经被标记为废弃，在Java 11中则不再包罗在尺度的JDK中）。
- wsimport -keep -s D:\projectMenu\mg-logistics-back\mg-logistics\src\main\java -p com.example.server D:\testData\SI_LOAD_DEOR_OUTBOUND2.wsdl
- [ERROR] 元素 "soap:address" 的前缀 "soap" 未绑定。 file:/D:/testData/镁业/SI_LOAD_DEOR_OUTBOUNDService.wsdl的第 140 行 [ERROR] 元素 "soap:address" 的前缀 "soap" 未绑定。 无法读取 WSDL 文档: file:/D:/testData/镁业/SI_LOAD_DEOR_OUTBOUNDService.wsdl, 原因为 1) 找不到文档; 2) 无法读取文档; 3) 文档的根元素不是 <wsdl:definitions>。 [WARNING] 忽略端口 "SI_LOAD_DEOR_OUTBOUNDBinding": 未指定 SOAP 地址。请尝试运行带 -extension 开关的 wsimport。 file:/D:/testData/镁业/SI_LOAD_DEOR_OUTBOUNDService.wsdl的第 139 行 [WARNING] 服务 "SI_LOAD_DEOR_OUTBOUND" 不包含任何可用端口。请尝试运行带 -extension 开关的 wsimport。 file:/D:/testData/镁业/SI_LOAD_DEOR_OUTBOUNDService.wsdl的第 138 行
- xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
SILOADDEOROUTBOUND为服务接口，SILOADDEOROUTBOUND_Service是接口实现类，类名都可以按照Java规范自行修改。
3、优化初始代码并实现接口
类名、冗余方法界说等都可以自行修改和删除。
SILOADDEOROUTBOUND_Service 需实现接口 SILOADDEOROUTBOUND，并清除默认继续的Service类。
- /**
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.2.9-b130926.1035
- * Generated source version: 2.2
- *
- */
- @WebService(name = "SI_LOAD_DEOR_OUTBOUND", targetNamespace = "http://qhyhgf.com.cn/sd/Invoice")
- @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
- @XmlSeeAlso({
- ObjectFactory.class
- })
- public interface SILOADDEOROUTBOUND {
- /**
- *
- * @param mtLOADDEOR
- * @return
- * returns com.example.server.MtLoadDeorReback
- */
- @WebMethod(operationName = "SI_LOAD_DEOR_OUTBOUND", action = "http://sap.com/xi/WebService/soap1.1")
- @WebResult(name = "SI_LOAD_DEOR_OUTBOUNDResponse", targetNamespace = "http://qhyhgf.com.cn/sd/Invoice", partName = "SI_LOAD_DEOR_OUTBOUNDResponse")
- public MtLoadDeorReback siLOADDEOROUTBOUND(
- @WebParam(name = "MT_LOAD_DEOR", targetNamespace = "http://qhyhgf.com.cn/sd/Invoice", partName = "MT_LOAD_DEOR")
- DTLOADDEOR mtLOADDEOR);
- }
- /**
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.2.9-b130926.1035
- * Generated source version: 2.2
- *
- */
- @WebServiceClient(name = "SI_LOAD_DEOR_OUTBOUND", targetNamespace = "http://qhyhgf.com.cn/sd/Invoice", wsdlLocation = "file:/D:/testData/server.wsdl")
- public class SILOADDEOROUTBOUND_Service
- extends Service
- {
- private final static URL SILOADDEOROUTBOUND_WSDL_LOCATION;
- private final static WebServiceException SILOADDEOROUTBOUND_EXCEPTION;
- private final static QName SILOADDEOROUTBOUND_QNAME = new QName("http://qhyhgf.com.cn/sd/Invoice", "SI_LOAD_DEOR_OUTBOUND");
- static {
- URL url = null;
- WebServiceException e = null;
- try {
- url = new URL("file:/D:/testData/server.wsdl");
- } catch (MalformedURLException ex) {
- e = new WebServiceException(ex);
- }
- SILOADDEOROUTBOUND_WSDL_LOCATION = url;
- SILOADDEOROUTBOUND_EXCEPTION = e;
- }
- public SILOADDEOROUTBOUND_Service() {
- super(__getWsdlLocation(), SILOADDEOROUTBOUND_QNAME);
- }
- public SILOADDEOROUTBOUND_Service(WebServiceFeature... features) {
- super(__getWsdlLocation(), SILOADDEOROUTBOUND_QNAME, features);
- }
- public SILOADDEOROUTBOUND_Service(URL wsdlLocation) {
- super(wsdlLocation, SILOADDEOROUTBOUND_QNAME);
- }
- public SILOADDEOROUTBOUND_Service(URL wsdlLocation, WebServiceFeature... features) {
- super(wsdlLocation, SILOADDEOROUTBOUND_QNAME, features);
- }
- public SILOADDEOROUTBOUND_Service(URL wsdlLocation, QName serviceName) {
- super(wsdlLocation, serviceName);
- }
- public SILOADDEOROUTBOUND_Service(URL wsdlLocation, QName serviceName, WebServiceFeature... features) {
- super(wsdlLocation, serviceName, features);
- }
- /**
- *
- * @return
- * returns SILOADDEOROUTBOUND
- */
- @WebEndpoint(name = "SI_LOAD_DEOR_OUTBOUNDBinding")
- public SILOADDEOROUTBOUND getSILOADDEOROUTBOUNDBinding() {
- return super.getPort(new QName("http://qhyhgf.com.cn/sd/Invoice", "SI_LOAD_DEOR_OUTBOUNDBinding"), SILOADDEOROUTBOUND.class);
- }
- /**
- *
- * @param features
- * A list of {@link javax.xml.ws.WebServiceFeature} to configure on the proxy. Supported features not in the <code>features</code> parameter will have their default values.
- * @return
- * returns SILOADDEOROUTBOUND
- */
- @WebEndpoint(name = "SI_LOAD_DEOR_OUTBOUNDBinding")
- public SILOADDEOROUTBOUND getSILOADDEOROUTBOUNDBinding(WebServiceFeature... features) {
- return super.getPort(new QName("http://qhyhgf.com.cn/sd/Invoice", "SI_LOAD_DEOR_OUTBOUNDBinding"), SILOADDEOROUTBOUND.class, features);
- }
- private static URL __getWsdlLocation() {
- if (SILOADDEOROUTBOUND_EXCEPTION!= null) {
- throw SILOADDEOROUTBOUND_EXCEPTION;
- }
- return SILOADDEOROUTBOUND_WSDL_LOCATION;
- }
- }
- @WebService(name = "SI_LOAD_DEOR_OUTBOUND",
- targetNamespace = "http://qhyhgf.com.cn/sd/Invoice")
- @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
- @XmlSeeAlso({
- ServerFactory.class
- })
- public interface SILoadDeorOutboundService {
- /**
- * 推送数据
- *
- * @param mtLoadDeor
- */
- @WebMethod(operationName = "SI_LOAD_DEOR_OUTBOUND", action = "http://sap.com/xi/WebService/soap1.1")
- @WebResult(name = "MT_LOAD_DEOR_REBACK")
- MTLoadDeorReback siLoadDeorOutbound(
- @WebParam(name = "MT_LOAD_DEOR", partName = "MT_LOAD_DEOR")
- MtLoadDeor mtLoadDeor);
- }
- /**
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.2.9-b130926.1035
- * Generated source version: 2.2
- */
- @Slf4j
- @WebService(
- serviceName = "SI_LOAD_DEOR_OUTBOUNDService", // 必须与 WSDL 中的服务名称相同
- portName = "SI_LOAD_DEOR_OUTBOUNDBinding",
- endpointInterface = "com.zhejuedata.webService.service.webservice.server.SILoadDeorOutboundService" // SEI 接口的全限定名
- )
- @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE, style = SOAPBinding.Style.DOCUMENT)
- @Service
- public class SILoadDeorOutboundServiceImpl implements SILoadDeorOutboundService {
- @Resource
- private OmniRedisTemplate omniRedisTemplate;
- @Override
- @Transactional(rollbackFor = Exception.class)
- public MTLoadDeorReback siLoadDeorOutbound(MtLoadDeor mtLoadDeor) {
- String key = "ERP_DATA_PUSH_" + DateUtils.dateTimeNow("yyyy-MM-dd HH:mm");
- Boolean hasClock = omniRedisTemplate.opsForValue().setIfAbsent(key, 1, Duration.ofSeconds(30));
- if (Boolean.TRUE.equals(hasClock)) {
- MTLoadDeorReback mtLoadDeorReback = saveDispatchListData(mtLoadDeor);
- log.info("成功接收数据：{}", JSONObject.toJSONString(mtLoadDeor));
- // 回调，推送响应信息
- try {
- log.info("开始回调接口推送响应数据: {}", JSONObject.toJSONString(mtLoadDeorReback));
- sendCallback(mtLoadDeorReback);
- } catch (Exception e) {
- // 错误处理
- log.error("回调ERP接口，推送响应信息失败", e);
- }
- omniRedisTemplate.delete(key);
- return mtLoadDeorReback;
- } else {
- List<String> dispatchListCodes = mtLoadDeor.getItem().stream().map(Item::getDispatchListCode)
- .collect(Collectors.toList());
- log.info("未抢到锁，即未成功接收数据。待重发数据：{}", dispatchListCodes);
- omniRedisTemplate.delete(key);
- return MTLoadDeorReback.fail(dispatchListCodes);
- }
- }
- private void sendCallback(MTLoadDeorReback response) {
- try {
- // 创建一个JAXB上下文用于序列化响应对象
- Class<?>[] classes = new Class<?>[]{
- MTLoadDeorReback.class,
- ResponseItem.class,
- ClientFactory.class,
- };
- JAXBContext jaxbContext = JAXBContext.newInstance(classes);
- Marshaller marshaller = jaxbContext.createMarshaller();
- marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
- // 使用ClientFactory创建JAXBElement
- ClientFactory clientFactory = new ClientFactory();
- JAXBElement<MTLoadDeorReback> jaxbElement = clientFactory.createMTLoadDeorReback(response);
- // 创建SOAP连接并发送请求
- SOAPConnectionFactory soapConnectionFactory = SOAPConnectionFactory.newInstance();
- SOAPConnection soapConnection = soapConnectionFactory.createConnection();
- MessageFactory messageFactory = MessageFactory.newInstance();
- SOAPMessage soapMessage = messageFactory.createMessage();
- SOAPPart soapPart = soapMessage.getSOAPPart();
- SOAPEnvelope envelope = soapPart.getEnvelope();
- SOAPBody soapBody = envelope.getBody();
- // 直接将JAXBElement序列化到SOAP Body中
- marshaller.marshal(jaxbElement, soapBody);
- // 设置SOAP Action头
- MimeHeaders headers = soapMessage.getMimeHeaders();
- headers.addHeader("SOAPAction", "http://sap.com/xi/WebService/soap1.1");
- // headers.addHeader("Authorization", "Basic WlBJQVBQTFVTRVI6emFxMXhzdzI=");
- headers.addHeader("Authorization", "Basic " + Base64Encoder.encode("ZPIAPPLUSER:zaq1xsw2"));
- // 回调推送
- URL endpoint = new URL(WebServiceConf.wsCallBackUrl);
- log.info("回调接口地址: {}", WebServiceConf.wsCallBackUrl);
- SOAPMessage soapResponse = soapConnection.call(soapMessage, endpoint);
- // 获取SOAP Body
- SOAPBody body = soapResponse.getSOAPBody();
- // 检查是否有SOAP Fault
- if (body.hasFault()) {
- SOAPFault fault = body.getFault();
- log.error("回调失败！！！");
- log.error("SOAP Fault: {}", fault.getFaultString());
- } else {
- log.info("回调成功...");
- }
- // 关闭连接
- soapConnection.close();
- } catch (Exception e) {
- log.error("调用回调方法异常...url:{}", WebServiceConf.wsCallBackUrl, e);
- throw new RuntimeException(e);
- }
- }
- @NotNull
- private MTLoadDeorReback saveDispatchListData(MtLoadDeor mtLoadDeor) {
- List<Item> itemList = mtLoadDeor.getItem();
- log.info("此次访问未接受到任何数据。mtLoadDeor：{}", JSONArray.toJSONString(mtLoadDeor));
- if (CollectionUtils.isEmpty(itemList)) {
- return MTLoadDeorReback.success(new ArrayList<>());
- }
- log.info("推送时间【{}】 此次推送数据: mtLoadDeor.itemList：{}", DateUtils.getTime(), JSONArray.toJSONString(itemList));
- List<String> dispatchListCodes = itemList.stream().map(Item::getDispatchListCode).collect(Collectors.toList());
- // 去除前后空格、回车等内容
- itemList = itemList.stream().peek(Item::trimAllStrings).collect(Collectors.toList());
- try {
- // todo: 具体业务实现
-
- return MTLoadDeorReback.success(dispatchListCodes);
- } catch (Exception e) {
- log.error("此次推送出现异常", e);
- dispatchListCodes = itemList.stream().map(Item::getDispatchListCode).collect(Collectors.toList());
- log.error("数据集体回滚, 发货单号：{}", JSONArray.toJSONString(dispatchListCodes));
- return MTLoadDeorReback.fail(dispatchListCodes);
- }
- }
- }
4、服务发布
我这里选择的是集成CXF框架，自动发布Web服务的方式。具体实现如下：
4.1、添加依赖
- <dependency>
- <groupId>org.apache.cxf</groupId>
- <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.cxf</groupId>
- <artifactId>cxf-rt-transports-http</artifactId>
- </dependency>
- <!-- 统一管理cxf版本，以确保项目中所有CXF相关依赖都使用一致的版本 -->
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.apache.cxf</groupId>
- <artifactId>cxf-bom</artifactId>
- <version>3.5.5</version>
- <type>pom</type>
- <scope>import</scope>
- </dependency>
- </dependencies>
- </dependencyManagement>
/rest/erp 为统一服务前缀，ZJLogisticsWebServices为实际服务地址配置好后，服务端访问地址即为：http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices
- @Configuration
- @Slf4j
- public class CxfConfig {
- @Bean(name = Bus.DEFAULT_BUS_ID)
- public SpringBus springBus() {
- SpringBus bus = new SpringBus();
- // 启用日志记录
- bus.getInInterceptors().add(new WebserviceLoggingInInterceptor());
- bus.getOutInterceptors().add(new WebserviceLoggingOutInterceptor());
- return bus;
- }
- /**
- * webservice下的请求将由CXFServlet处理
- */
- @Bean
- public ServletRegistrationBean<CXFServlet> cxfServlet() {
- return new ServletRegistrationBean<>(new CXFServlet(), "/rest/erp/*");
- }
- @Bean
- public Endpoint siLoadDeorOutboundEndpoint() {
- EndpointImpl endpoint = new EndpointImpl(springBus(), new SILoadDeorOutboundServiceImpl());
- // 设置服务名称和端口名称
- endpoint.setServiceName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsInterfaceName));
- endpoint.setEndpointName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsPortName));
- endpoint.publish("/ZJLogisticsWebServices");
- // 注册动态地址拦截器替换WSDL 的地址
- endpoint.getInInterceptors().add(new DynamicSoapAddressInterceptor());
- return endpoint;
- }
- @Bean
- public Endpoint callbackReceiverEndpoint() {
- EndpointImpl endpoint = new EndpointImpl(springBus(), new CallbackReceiverServicesImpl());
- // 设置服务名称和端口名称
- endpoint.setServiceName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsCallBackInterfaceName));
- endpoint.setEndpointName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsCallBackPortName));
- endpoint.publish("/XISOAPAdapter/MessageServlet");
- return endpoint;
- }
- }
在总线配置中补充日志拦截器
- @Bean(name = Bus.DEFAULT_BUS_ID)
- public SpringBus springBus() {
- SpringBus bus = new SpringBus();
- // 启用日志记录
- bus.getInInterceptors().add(new WebserviceLoggingInInterceptor());
- bus.getOutInterceptors().add(new WebserviceLoggingOutInterceptor());
- return bus;
- }
- import org.apache.cxf.message.Message;
- import org.apache.cxf.phase.AbstractPhaseInterceptor;
- import org.apache.cxf.phase.Phase;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class WebserviceLoggingInInterceptor extends AbstractPhaseInterceptor<Message> {
- private static final Logger LOG = LoggerFactory.getLogger(WebserviceLoggingInInterceptor.class);
- public WebserviceLoggingInInterceptor() {
- super(Phase.RECEIVE);
- }
- @Override
- public void handleMessage(Message message) {
- // 记录输入消息内容
- String input = message.getContent(String.class);
- if (input != null) {
- LOG.info("Incoming Message: {}", input);
- }
- }
- }
- import org.apache.cxf.message.Message;
- import org.apache.cxf.phase.AbstractPhaseInterceptor;
- import org.apache.cxf.phase.Phase;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class WebserviceLoggingOutInterceptor extends AbstractPhaseInterceptor<Message> {
- private static final Logger LOG = LoggerFactory.getLogger(WebserviceLoggingOutInterceptor.class);
- public WebserviceLoggingOutInterceptor() {
- super(Phase.PRE_PROTOCOL);
- }
- @Override
- public void handleMessage(Message message) {
- // 记录输出消息内容
- String output = message.getContent(String.class);
- if (output != null) {
- LOG.info("Outgoing Message: {}", output);
- }
- }
- }
- <!-- 设置 CXF 日志-->
- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <encoder>
- <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
- </encoder>
- </appender>
- <!-- 日志级别 -->
- <logger name="org.apache.cxf" level="INFO"/>
- <root level="info">
- <appender-ref ref="STDOUT"/>
- </root>
到 3.4 为止，我的服务端根本搭建完毕，可以开测啦！
5.1、访问服务端文档
启动后假如无报错，那么你将可以通过 3.1 中配置的服务端地址来访问你的服务端文档，这个服务端文档就是用来提供给三方客户端用来解析和推送数据的。即搭建完毕后你只需要提供一个服务端地址就ok了。
这里我配置的地址是 http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices 以是我可以在浏览器访问
http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices?wsdl来预览我的服务端文档：
- <wsdl:definitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://qhyhgf.com.cn/sd/Invoice" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" name="SI_LOAD_DEOR_OUTBOUND" targetNamespace="http://qhyhgf.com.cn/sd/Invoice"> <wsdl:types> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://qhyhgf.com.cn/sd/Invoice" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://qhyhgf.com.cn/sd/Invoice" version="1.0"> <xs:element name="MT_LOAD_DEOR" type="tns:DT_LOAD_DEOR"/> <xs:element name="MT_LOAD_DEOR_REBACK" type="tns:mtLoadDeorReback"/> <xs:complexType name="DT_LOAD_DEOR"> <xs:sequence> <xs:element maxOccurs="unbounded" name="ITEM"> <xs:complexType> <xs:sequence> <xs:element name="VBELN" type="xs:string"/> <xs:element name="POSNR" type="xs:string"/> <xs:element name="WADAT_IST" type="xs:string"/> <xs:element minOccurs="0" name="ZCYDW" nillable="true" type="xs:string"/> <xs:element name="PARTNER" type="xs:string"/> <xs:element name="ZCH" type="xs:string"/> <xs:element name="MATNR" type="xs:string"/> <xs:element name="ARKTX" type="xs:string"/> <xs:element name="KWMENG" type="xs:string"/> <xs:element name="CHARG" type="xs:string"/> <xs:element name="ZSJXM" type="xs:string"/> <xs:element name="ZLXDH" type="xs:string"/> <xs:element name="ZSJSFZ" type="xs:string"/> <xs:element minOccurs="0" name="ZBZ" nillable="true" type="xs:string"/> <xs:element name="VRKME" type="xs:string"/> <xs:element name="VSBED" type="xs:string"/> <xs:element name="ZDJCJR" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="mtLoadDeorReback"> <xs:sequence> <xs:element maxOccurs="unbounded" name="ITEM" type="tns:DT_ITEM"/> </xs:sequence> </xs:complexType> <xs:complexType name="DT_ITEM"> <xs:sequence> <xs:element name="VBELN" type="xs:string"/> <xs:element name="ZJCBS" type="xs:string"/> <xs:element name="ZJSXX" type="xs:string"/> </xs:sequence> </xs:complexType> <xs:element name="SI_LOAD_DEOR_OUTBOUNDResponse" nillable="true" type="tns:mtLoadDeorReback"/> </xs:schema> </wsdl:types> <wsdl:message name="SI_LOAD_DEOR_OUTBOUNDResponse"> <wsdl:part element="tns:SI_LOAD_DEOR_OUTBOUNDResponse" name="SI_LOAD_DEOR_OUTBOUNDResponse"></wsdl:part> </wsdl:message> <wsdl:message name="SI_LOAD_DEOR_OUTBOUND"> <wsdl:part element="tns:MT_LOAD_DEOR" name="MT_LOAD_DEOR"></wsdl:part> </wsdl:message> <wsdl:portType name="SI_LOAD_DEOR_OUTBOUND"> <wsdl:operation name="SI_LOAD_DEOR_OUTBOUND"> <wsdl:input message="tns:SI_LOAD_DEOR_OUTBOUND" name="SI_LOAD_DEOR_OUTBOUND"></wsdl:input> <wsdl:output message="tns:SI_LOAD_DEOR_OUTBOUNDResponse" name="SI_LOAD_DEOR_OUTBOUNDResponse"></wsdl:output> </wsdl:operation> </wsdl:portType> <wsdl:binding name="SI_LOAD_DEOR_OUTBOUNDSoapBinding" type="tns:SI_LOAD_DEOR_OUTBOUND"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="SI_LOAD_DEOR_OUTBOUND"> <soap:operation soapAction="http://sap.com/xi/WebService/soap1.1" style="document"/> <wsdl:input name="SI_LOAD_DEOR_OUTBOUND"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="SI_LOAD_DEOR_OUTBOUNDResponse"> <soap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="SI_LOAD_DEOR_OUTBOUND">
- <wsdl:port binding="tns:SI_LOAD_DEOR_OUTBOUNDSoapBinding" name="SI_LOAD_DEOR_OUTBOUNDBinding">
- <soap:address location="http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices"/>
- </wsdl:port>
- </wsdl:service></wsdl:definitions>
5.2.1、通过curl命令调试本地测试
测试文件内容如下，注意需将以下内容保存为xml文件。
- <?xml version="1.0" encoding="utf-8"?>
- <soapenv:Envelope
- xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
- xmlns:sil="http://qhyhgf.com.cn/sd/Invoice">
- <soapenv:Header/>
- <soapenv:Body>
- <sil:MT_LOAD_DEOR>
- <ITEM>
- <VBELN>0080000405</VBELN>
- <POSNR>900001</POSNR>
- <WADAT_IST>20241204</WADAT_IST>
- <ZCYDW>郭六运输公司</ZCYDW>
- <PARTNER>上海英济塑料有限公司</PARTNER>
- <ZCH>新A66601</ZCH>
- <MATNR>350</MATNR>
- <ARKTX>轻质纯碱优等品</ARKTX>
- <KWMENG>40.000</KWMENG>
- <CHARG>1602230193</CHARG>
- <ZSJXM>张五</ZSJXM>
- <ZLXDH>13138542156</ZLXDH>
- <ZSJSFZ>632128198902052117</ZSJSFZ>
- <ZBZ>大换小</ZBZ>
- <VRKME>吨</VRKME>
- <VSBED>自提</VSBED>
- <ZDJCJR>张晓瑜</ZDJCJR>
- </ITEM>
- <ITEM>
- <VBELN>0080000405</VBELN>
- <POSNR>900002</POSNR>
- <WADAT_IST>20241204</WADAT_IST>
- <ZCYDW>郭六运输公司</ZCYDW>
- <PARTNER>上海英济塑料有限公司</PARTNER>
- <ZCH>青C3DR3N</ZCH>
- <MATNR>350</MATNR>
- <ARKTX>轻质纯碱优等品</ARKTX>
- <KWMENG>40.000</KWMENG>
- <CHARG>1602230193</CHARG>
- <ZSJXM>李四</ZSJXM>
- <ZLXDH>13876526374</ZLXDH>
- <ZSJSFZ>673273198801221111</ZSJSFZ>
- <ZBZ>大换小</ZBZ>
- <VRKME>吨</VRKME>
- <VSBED>自提</VSBED>
- <ZDJCJR>张晓瑜</ZDJCJR>
- </ITEM>
- <ITEM>
- <VBELN>0080000406</VBELN>
- <POSNR>000010</POSNR>
- <WADAT_IST>20241204</WADAT_IST>
- <ZCYDW>个体</ZCYDW>
- <PARTNER>上海英济塑料有限公司</PARTNER>
- <ZCH>青H33331</ZCH>
- <MATNR>60340431</MATNR>
- <ARKTX>PP专用纯碱 轻质纯碱优等品 标准GB210.1-2004Ⅱ类(≥99.2%)</ARKTX>
- <KWMENG>10.000</KWMENG>
- <CHARG/>
- <ZSJXM>理财</ZSJXM>
- <ZLXDH>18800023332</ZLXDH>
- <ZSJSFZ>123456789009876543</ZSJSFZ>
- <ZBZ/>
- <VRKME>吨</VRKME>
- <VSBED>自提</VSBED>
- <ZDJCJR>李志山</ZDJCJR>
- </ITEM>
- <ITEM>
- <VBELN>0080000406</VBELN>
- <POSNR>000020</POSNR>
- <WADAT_IST>20241204</WADAT_IST>
- <ZCYDW>个体</ZCYDW>
- <PARTNER>上海英济塑料有限公司</PARTNER>
- <ZCH>青H33331</ZCH>
- <MATNR>60340431</MATNR>
- <ARKTX>PP专用纯碱 轻质纯碱优等品 标准GB210.1-2004Ⅱ类(≥99.2%)</ARKTX>
- <KWMENG>11.000</KWMENG>
- <CHARG/>
- <ZSJXM>下滑</ZSJXM>
- <ZLXDH>18800023332</ZLXDH>
- <ZSJSFZ>123456789009876555</ZSJSFZ>
- <ZBZ/>
- <VRKME>吨</VRKME>
- <VSBED>自提</VSBED>
- <ZDJCJR>李志山</ZDJCJR>
- </ITEM>
- </sil:MT_LOAD_DEOR>
- </soapenv:Body>
- </soapenv:Envelope>
- curl -X POST http://localhost:8081/rest/erp/ZJLogisticsWebServices/services/SILoadDeorOutbound ^ -H "Content-Type: text/xml; charset=utf-8" ^ -H "SOAPAction: "http://sap.com/xi/WebService/soap1.1"" ^ --data @testERPData.xml
具体使用方式可以参照工具使用指南
在左边copy测试参数，即测试文件的内容。点击绿色三角启动按钮，右边是来自我们服务端的响应信息。
响应示例：
- HTTP/1.1 200
- Vary: Origin
- Vary: Access-Control-Request-Method
- Vary: Access-Control-Request-Headers
- X-Content-Type-Options: nosniff
- X-XSS-Protection: 1; mode=block
- Content-Type: text/xml;charset=UTF-8
- Content-Length: 374
- Date: Tue, 10 Dec 2024 08:35:05 GMT
- Keep-Alive: timeout=60
- Connection: keep-alive
- <soap:Envelope
- xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- <soap:Body>
- <ns2:SI_LOAD_DEOR_OUTBOUNDResponse
- xmlns:ns2="http://qhyhgf.com.cn/sd/Invoice">
- <ITEM>
- <VBELN>0080000406</VBELN>
- <ZJCBS>S</ZJCBS>
- <ZJSXX>成功</ZJSXX>
- </ITEM>
- <ITEM>
- <VBELN>0080000405</VBELN>
- <ZJCBS>S</ZJCBS>
- <ZJSXX>成功</ZJSXX>
- </ITEM>
- </ns2:SI_LOAD_DEOR_OUTBOUNDResponse>
- </soap:Body>
- </soap:Envelope>
6.1、服务端地址
<soap:address location 标签为服务端地址，即客户端访问地址，实际使用时会通过加?wsdl来访问服务端文档。127.0.0.1:8081 为实际后端服务的ip端口，实际生产情况需要配置nginx代理。
- http://localhost:8081/rest/erp/ZJLogisticsWebServices?wsdl
用于唯一标识Web服务的接口和数据类型。它们资助克制名称辩论，并且为XML元素提供上下文信息。命名空间通常由URI（统一资源标识符）表现，尽管这个URI不一定要指向实际存在的资源，它只是作为一个唯一的标识符。
- Target Namespace: http://qhyhgf.com.cn/sd/Invoice
- <wsdl:definitions name="SI_LOAD_DEOR_OUTBOUND"
- targetNamespace="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:p1="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
- xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
- xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
portName 是WSDL（Web Services Description Language）文档中的一个重要概念。它用于界说一个特定的服务端点（endpoint），该端点是客户端与服务交互的具体位置。portName 通常由两部分组成：服务名称和端口名称，它们共同标识了一个唯一的操作集合。
portName 在WSDL中是由<port>元素指定的，它是<service>元素的一部分。每个<service>可以包罗多个<port>，每个<port>对应于一种访问服务的方式（即绑定）。portName 是这个端口的唯一标识符，并且它资助区分同一个服务的不同端点。
比方，在我的服务端文档中可以看到如下界说：
- <wsdl:service name="SI_LOAD_DEOR_OUTBOUND">
- <wsdl:port binding="tns:SI_LOAD_DEOR_OUTBOUNDSoapBinding" name="SI_LOAD_DEOR_OUTBOUNDBinding">
- <soap:address location="http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices"/>
- </wsdl:port>
- </wsdl:service>
- name="SI_LOAD_DEOR_OUTBOUND" 界说了服务的名称。
- name="SI_LOAD_DEOR_OUTBOUNDBinding" 界说了端口的名称。
- binding="tns:SI_LOAD_DEOR_OUTBOUNDSoapBinding" 指定了这个端口使用哪种绑定（协媾和数据格式）。
- <soap:address location="http://127.0.0.1:8081/rest/erp/ZJLogisticsWebServices"/> 提供了访问该端点的实际URL。
在Java代码中的界说，通过@WebService注解来指定serviceName和portName。如：
- @WebService(name = "SI_LOAD_DEOR_OUTBOUND",
- targetNamespace = "http://qhyhgf.com.cn/sd/Invoice")
- @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
- @XmlSeeAlso({
- ServerFactory.class
- })
- public interface SILoadDeorOutboundService {
- }
- @Slf4j
- @WebService(
- serviceName = "SI_LOAD_DEOR_OUTBOUNDService", // 必须与 WSDL 中的服务名称相同
- portName = "SI_LOAD_DEOR_OUTBOUNDBinding",
- endpointInterface = "com.zhejuedata.logistics.service.webservice.server.SILoadDeorOutboundService" // SEI 接口的全限定名
- )
- @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE, style = SOAPBinding.Style.DOCUMENT)
- @Service
- public class SILoadDeorOutboundServiceImpl implements SILoadDeorOutboundService {
- }
- @Bean
- public Endpoint siLoadDeorOutboundEndpoint() {
- EndpointImpl endpoint = new EndpointImpl(springBus(), new SILoadDeorOutboundServiceImpl());
- // 设置服务名称和端口名称
- endpoint.setServiceName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsInterfaceName));
- endpoint.setEndpointName(new QName(WebServiceConf.wsNamespace, WebServiceConf.wsPortName));
- endpoint.publish("/ZJLogisticsWebServices");
- return endpoint;
- }
- public class WebServiceConf {
- public final static String wsServerUrl = OmniConf.getString("ws.server.url", "/rest/erp/ZJLogisticsWebServices");
- public final static String wsNamespace = OmniConf.getString("ws.namespace", "http://qhyhgf.com.cn/sd/Invoice");
- public final static String wsPortName = OmniConf.getString("ws.port.name", "SI_LOAD_DEOR_OUTBOUNDBinding");
- public final static String wsInterfaceName = OmniConf.getString("ws.interface.name", "SI_LOAD_DEOR_OUTBOUND");
- }
服务接口的入参界说。
- MT_LOAD_DEOR: 包罗要推送的数据。
- name：MT_LOAD_DEOR
- 类型：DT_LOAD_DEOR
- 命名空间：http://qhyhgf.com.cn/sd/Invoice
6.5、响应体界说
详细见2、响应格式界说
- <xsd:element name="MT_LOAD_DEOR_REBACK" type="DT_LOAD_DEOR_REBACK"/>
- name：MT_LOAD_DEOR_REBACK
- 类型：DT_LOAD_DEOR_REBACK
- 命名空间：http://qhyhgf.com.cn/sd/Invoice
响应对象wsdl文档界说：
- <xsd:schema targetNamespace="http://qhyhgf.com.cn/sd/Invoice"
- xmlns:xsd="http://www.w3.org/2001/XMLSchema"
- xmlns="http://qhyhgf.com.cn/sd/Invoice">
- <xsd:element name="MT_LOAD_DEOR_REBACK" type="DT_LOAD_DEOR_REBACK"/>
- <xsd:complexType name="DT_LOAD_DEOR_REBACK">
- <xsd:sequence>
- <xsd:element name="ITEM" maxOccurs="unbounded">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="VBELN" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>发货单号</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="ZJCBS" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>接收方成功标识</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="ZJSXX" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>接收方信息</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:schema>
- @XmlAccessorType(XmlAccessType.FIELD)
- @XmlRootElement(name = "MT_LOAD_DEOR_REBACK")
- @Getter
- @Setter
- public class MTLoadDeorReback {
- @XmlElement(name = "ITEM", required = true)
- private ArrayList<ResponseItem> responseItem;
- public static MTLoadDeorReback success(List<String> dispatchListCodes) {
- MTLoadDeorReback response = new MTLoadDeorReback();
- response.setResponseItem(new ArrayList<>(dispatchListCodes.stream()
- .map(ResponseItem::success)
- .collect(Collectors.toList())));
- return response;
- }
- public static MTLoadDeorReback fail(List<String> dispatchListCodes) {
- MTLoadDeorReback response = new MTLoadDeorReback();
- response.setResponseItem(new ArrayList<>(dispatchListCodes.stream()
- .map(ResponseItem::fail)
- .collect(Collectors.toList())));
- return response;
- }
- }
- @XmlAccessorType(XmlAccessType.FIELD)
- @XmlType(name = "DT_ITEM", propOrder = {
- "dispatchListCode", "code", "msg"}
- , namespace = "http://qhyhgf.com.cn/sd/Invoice")
- @Getter
- @Setter
- public class ResponseItem {
- /**
- * 发货单号
- */
- @XmlElement(name = "VBELN", required = true)
- private String dispatchListCode;
- /**
- * 接收方成功标识
- * S/E
- */
- @XmlElement(name = "ZJCBS", required = true)
- private String code;
- /**
- * 接收方信息
- * 成功/错误
- */
- @XmlElement(name = "ZJSXX", required = true)
- private String msg;
- public static ResponseItem success(String dispatchListCode) {
- ResponseItem item = new ResponseItem();
- item.setDispatchListCode(dispatchListCode);
- item.setCode("S");
- item.setMsg("成功");
- return item;
- }
- public static ResponseItem fail(String dispatchListCode) {
- ResponseItem item = new ResponseItem();
- item.setDispatchListCode(dispatchListCode);
- item.setCode("E");
- item.setMsg("失败");
- return item;
- }
- }
1、请求乐成但拿不到响应信息xml
误用了@OneWay注解，这个注解只有在实际业务场景不需要思量和处置处罚响应信息的时候才会需要使用，即单向通信。方法无需返回内容时才会需要。
2、生产情况请求服务端地址404
经排查发现是因为webservice在后台服务启动后。默认以服务ip:port/rest/erp/ZJLogisticsWebServices方式提供访问，但我们生产情况的nginx做了代理会在ip:port后增长后缀/api，于是我们提供出去的服务地址就成了ip:port/api/rest/erp/ZJLogisticsWebServices，而实际服务端文档内的地址仍然为：ip:port/rest/erp/ZJLogisticsWebServices。导致第三方使用我们的服务端文档解析出来的地址时会404。
解决方案：修改nginx配置文件：
- location /api/ {
- proxy_pass http://ip:port/;
- proxy_http_version 1.1;
- proxy_set_header Upgrade $http_upgrade;
- proxy_set_header Connection 'upgrade';
- proxy_set_header Host $host;
- proxy_cache_bypass $http_upgrade;
- # 设置超时时间
- proxy_connect_timeout 60s;
- proxy_send_timeout 60s;
- proxy_read_timeout 60s;
- }
甲方仅提供了鉴权需要使用的用户名密码，访问吸收响应信息接口服务地址发现，需要以雷同代填表单方式完成用户名密码的填写。颠末一系列排查测试，发现甲方服务端实际使用的鉴权认证方式是 www-authenticate。 一种通过BASE-64加密的简单认证技术。
- headers.addHeader("Authorization", "Basic " + Base64Encoder.encode("用户名:密码"));
彻底理解Webservice SOAP WSDL
SoapUI使用指南
www-authenticate与BASE-64认证技术
Apache CXF：简化SOA集成的开源框架
Apache CXF 开发指南
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。 |
