如何更改 "SOAP-ENV" 默认前缀 Spring-WS
How to change "SOAP-ENV" default prefix of Spring-WS
我使用 Spring-WS 创建了一个网络服务。
为了保持与旧系统的兼容性,我需要将命名空间前缀从 SOAP-ENV
更改为 soap
.
我知道 SOAP-ENV
和 soap
只是名称空间前缀。
只要它们引用正确的命名空间 ("http://schemas.xmlsoap.org/soap/envelope/"
),就应该没问题。
但是旧系统将解析器代码硬编码为仅期望 soap
名称空间前缀。
当前回复:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
...
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
预期响应:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
...
</soap:Body>
</soap:Envelope>
这是我到目前为止尝试过的方法
创建 EndpointInterceptorAdapter
子类。这将拦截 SOAP response/fault 并更改 SOAP 信封。
这可行,但在性能方面并不理想。
public class CustomEndpointInterceptor extends EndpointInterceptorAdapter {
private static final String DEFAULT_NS = "xmlns:SOAP-ENV";
private static final String SOAP_ENV_NAMESPACE = "http://schemas.xmlsoap.org/soap/envelope/";
private static final String PREFERRED_PREFIX = "soap";
private static final String HEADER_LOCAL_NAME = "Header";
private static final String BODY_LOCAL_NAME = "Body";
private static final String FAULT_LOCAL_NAME = "Fault";
@Override
public boolean handleResponse(MessageContext messageContext, Object endpoint) throws Exception {
SaajSoapMessage soapResponse = (SaajSoapMessage) messageContext.getResponse();
alterSoapEnvelope(soapResponse);
return super.handleResponse(messageContext, endpoint);
}
@Override
public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception {
SaajSoapMessage soapResponse = (SaajSoapMessage) messageContext.getResponse();
alterSoapEnvelope(soapResponse);
return super.handleFault(messageContext, endpoint);
}
private void alterSoapEnvelope(SaajSoapMessage soapResponse) {
Document doc = soapResponse.getDocument();
Element rootElement = doc.getDocumentElement();
rootElement.setPrefix(PREFERRED_PREFIX);
// Remove default SOAP namespace
rootElement.removeAttribute(DEFAULT_NS);
NodeList headerNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, HEADER_LOCAL_NAME);
NodeList bodyNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, BODY_LOCAL_NAME);
NodeList faultNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, FAULT_LOCAL_NAME);
// Remove Header node.
if (headerNodes.getLength() != 0) {
rootElement.removeChild(headerNodes.item(0));
}
// Change Body's SOAP namespace prefix.
if (bodyNodes.getLength() != 0) {
Element bodyElement = (Element) bodyNodes.item(0);
bodyElement.setPrefix(PREFERRED_PREFIX);
}
if (faultNodes.getLength() != 0) {
Element faultElement = (Element) faultNodes.item(0);
faultElement.setPrefix(PREFERRED_PREFIX);
}
}
}
更改 package-info.java
包中包含生成的 WSDL 类。
我已经使用我公司的名称空间前缀成功完成了此操作,但它不适用于 SOAP-ENV
前缀。
@javax.xml.bind.annotation.XmlSchema(namespace = "http://www.example.com/ns/2008/02/02/webservices/blah",
xmlns = {
@javax.xml.bind.annotation.XmlNs(namespaceURI = "http://www.example.com/ns/2008/02/02/webservices/blah", prefix = ""),
@javax.xml.bind.annotation.XmlNs(namespaceURI = "http://schemas.example.com/ns/2007/10/blah", prefix = "ns2"),
@javax.xml.bind.annotation.XmlNs(namespaceURI = "http://example.com/ns/2007/23/05/blah/fundamental", prefix = "ns3"),
@javax.xml.bind.annotation.XmlNs(namespaceURI = "http://schemas.xmlsoap.org/soap/envelope/", prefix = "soap") // doesn't work
},
elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
package com.thomsonreuters.ts.ets.interdayws.soap.webservice;
在Spring-WS中,有没有一种理想的方法可以将SOAP-ENV
更改为soap
?
顺便说一句,这是设置这个前缀的代码。
StroapElement.java
更好的解决方案
使用 SOAPMessage API 而不是 DOM。
private void alterSoapEnvelope(SaajSoapMessage soapResponse) {
try {
SOAPMessage soapMessage = soapResponse.getSaajMessage();
SOAPPart soapPart = soapMessage.getSOAPPart();
SOAPEnvelope envelope = soapPart.getEnvelope();
SOAPHeader header = soapMessage.getSOAPHeader();
SOAPBody body = soapMessage.getSOAPBody();
SOAPFault fault = body.getFault();
envelope.removeNamespaceDeclaration(envelope.getPrefix());
envelope.addNamespaceDeclaration(PREFERRED_PREFIX, SOAP_ENV_NAMESPACE);
envelope.setPrefix(PREFERRED_PREFIX);
header.setPrefix(PREFERRED_PREFIX);
body.setPrefix(PREFERRED_PREFIX);
if (fault != null) {
fault.setPrefix(PREFERRED_PREFIX);
}
} catch (SOAPException e) {
e.printStackTrace();
}
}
现在快多了。
我用SAAJ。试试这个。
- soapEnvelope.removeNamespaceDeclaration("SOAP-ENV");
- soapEnvelope.addNamespaceDeclaration("soapenv", "http://schemas.xmlsoap.org/soap/envelope/");
- soapEnvelope.setPrefix("soapenv");
- soapHeader.setPrefix("soapenv");
- soapBody.setPrefix("soapenv");
别忘了:
soapMessage.saveChanges();
参考:Changing the default XML namespace prefix generated with JAXWS
补充点:
您必须使用 WsConfigurationAdapter 扩展 Web 服务配置 class,并在 Web 服务配置 class 中添加您的 CustomEndpointInterceptor,如下所述。
那么只有拦截器起作用了。
更多详情请参阅下文link
https://memorynotfound.com/spring-ws-intercept-request-response-soap-messages/
我使用 Spring-WS 创建了一个网络服务。
为了保持与旧系统的兼容性,我需要将命名空间前缀从 SOAP-ENV
更改为 soap
.
我知道 SOAP-ENV
和 soap
只是名称空间前缀。
只要它们引用正确的命名空间 ("http://schemas.xmlsoap.org/soap/envelope/"
),就应该没问题。
但是旧系统将解析器代码硬编码为仅期望 soap
名称空间前缀。
当前回复:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
...
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
预期响应:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
...
</soap:Body>
</soap:Envelope>
这是我到目前为止尝试过的方法
创建
EndpointInterceptorAdapter
子类。这将拦截 SOAP response/fault 并更改 SOAP 信封。 这可行,但在性能方面并不理想。public class CustomEndpointInterceptor extends EndpointInterceptorAdapter { private static final String DEFAULT_NS = "xmlns:SOAP-ENV"; private static final String SOAP_ENV_NAMESPACE = "http://schemas.xmlsoap.org/soap/envelope/"; private static final String PREFERRED_PREFIX = "soap"; private static final String HEADER_LOCAL_NAME = "Header"; private static final String BODY_LOCAL_NAME = "Body"; private static final String FAULT_LOCAL_NAME = "Fault"; @Override public boolean handleResponse(MessageContext messageContext, Object endpoint) throws Exception { SaajSoapMessage soapResponse = (SaajSoapMessage) messageContext.getResponse(); alterSoapEnvelope(soapResponse); return super.handleResponse(messageContext, endpoint); } @Override public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception { SaajSoapMessage soapResponse = (SaajSoapMessage) messageContext.getResponse(); alterSoapEnvelope(soapResponse); return super.handleFault(messageContext, endpoint); } private void alterSoapEnvelope(SaajSoapMessage soapResponse) { Document doc = soapResponse.getDocument(); Element rootElement = doc.getDocumentElement(); rootElement.setPrefix(PREFERRED_PREFIX); // Remove default SOAP namespace rootElement.removeAttribute(DEFAULT_NS); NodeList headerNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, HEADER_LOCAL_NAME); NodeList bodyNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, BODY_LOCAL_NAME); NodeList faultNodes = doc.getElementsByTagNameNS(SOAP_ENV_NAMESPACE, FAULT_LOCAL_NAME); // Remove Header node. if (headerNodes.getLength() != 0) { rootElement.removeChild(headerNodes.item(0)); } // Change Body's SOAP namespace prefix. if (bodyNodes.getLength() != 0) { Element bodyElement = (Element) bodyNodes.item(0); bodyElement.setPrefix(PREFERRED_PREFIX); } if (faultNodes.getLength() != 0) { Element faultElement = (Element) faultNodes.item(0); faultElement.setPrefix(PREFERRED_PREFIX); } } }
更改
package-info.java
包中包含生成的 WSDL 类。 我已经使用我公司的名称空间前缀成功完成了此操作,但它不适用于SOAP-ENV
前缀。@javax.xml.bind.annotation.XmlSchema(namespace = "http://www.example.com/ns/2008/02/02/webservices/blah", xmlns = { @javax.xml.bind.annotation.XmlNs(namespaceURI = "http://www.example.com/ns/2008/02/02/webservices/blah", prefix = ""), @javax.xml.bind.annotation.XmlNs(namespaceURI = "http://schemas.example.com/ns/2007/10/blah", prefix = "ns2"), @javax.xml.bind.annotation.XmlNs(namespaceURI = "http://example.com/ns/2007/23/05/blah/fundamental", prefix = "ns3"), @javax.xml.bind.annotation.XmlNs(namespaceURI = "http://schemas.xmlsoap.org/soap/envelope/", prefix = "soap") // doesn't work }, elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED) package com.thomsonreuters.ts.ets.interdayws.soap.webservice;
在Spring-WS中,有没有一种理想的方法可以将SOAP-ENV
更改为soap
?
顺便说一句,这是设置这个前缀的代码。 StroapElement.java
更好的解决方案
使用 SOAPMessage API 而不是 DOM。
private void alterSoapEnvelope(SaajSoapMessage soapResponse) {
try {
SOAPMessage soapMessage = soapResponse.getSaajMessage();
SOAPPart soapPart = soapMessage.getSOAPPart();
SOAPEnvelope envelope = soapPart.getEnvelope();
SOAPHeader header = soapMessage.getSOAPHeader();
SOAPBody body = soapMessage.getSOAPBody();
SOAPFault fault = body.getFault();
envelope.removeNamespaceDeclaration(envelope.getPrefix());
envelope.addNamespaceDeclaration(PREFERRED_PREFIX, SOAP_ENV_NAMESPACE);
envelope.setPrefix(PREFERRED_PREFIX);
header.setPrefix(PREFERRED_PREFIX);
body.setPrefix(PREFERRED_PREFIX);
if (fault != null) {
fault.setPrefix(PREFERRED_PREFIX);
}
} catch (SOAPException e) {
e.printStackTrace();
}
}
现在快多了。
我用SAAJ。试试这个。
- soapEnvelope.removeNamespaceDeclaration("SOAP-ENV");
- soapEnvelope.addNamespaceDeclaration("soapenv", "http://schemas.xmlsoap.org/soap/envelope/");
- soapEnvelope.setPrefix("soapenv");
- soapHeader.setPrefix("soapenv");
- soapBody.setPrefix("soapenv");
别忘了: soapMessage.saveChanges();
参考:Changing the default XML namespace prefix generated with JAXWS
补充点:
您必须使用 WsConfigurationAdapter 扩展 Web 服务配置 class,并在 Web 服务配置 class 中添加您的 CustomEndpointInterceptor,如下所述。
那么只有拦截器起作用了。
更多详情请参阅下文link
https://memorynotfound.com/spring-ws-intercept-request-response-soap-messages/