如何在Spring Web Services中为SOAP Fault元素设置自定义命名空间前缀

问题分析 #

你当前的代码中，尽管调用了fault.setPrefix("s")，但Fault元素仍未显示s前缀，核心原因是：

• 原有Fault（或新创建的Fault）自动添加了xmlns="http://schemas.xmlsoap.org/soap/envelope/"的命名空间声明，解析器会优先使用这个默认声明，而非你设置的前缀。
• faultcode和faultstring元素出现空xmlns=""，是命名空间冲突导致的冗余声明。

解决方案 #

通过移除原有Fault、重新创建带指定前缀的Fault，并清理冗余命名空间声明来解决：

@Override
public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception {
    SaajSoapMessage soapResponse = (SaajSoapMessage) messageContext.getResponse();
    SOAPMessage saajMessage = soapResponse.getSaajMessage();
    SOAPEnvelope envelope = saajMessage.getSOAPPart().getEnvelope();
    SOAPBody body = envelope.getBody();
    SOAPHeader header = saajMessage.getSOAPHeader();

    // 替换默认SOAP-ENV前缀为s
    envelope.removeNamespaceDeclaration("SOAP-ENV");
    envelope.addNamespaceDeclaration("s", "http://schemas.xmlsoap.org/soap/envelope/");
    
    // 为信封、体、头设置前缀s
    envelope.setPrefix("s");
    body.setPrefix("s");
    if (header != null) {
        header.setPrefix("s");
    }

    // 移除原有Fault（如果存在），避免默认命名空间干扰
    if (body.getFault() != null) {
        body.removeBodyElement(body.getFault());
    }
    // 创建新的Fault，直接指定带s前缀的命名空间和错误信息
    SOAPFault fault = body.addFault(
        new QName("http://schemas.xmlsoap.org/soap/envelope/", "Client", "s"),
        "403 Forbidden: Access forbidden. Please check your permissions."
    );

    // 设置Fault前缀为s，并移除自动添加的冗余命名空间声明
    fault.setPrefix("s");
    if (fault.getAttributeNode("xmlns") != null) {
        fault.removeAttributeNode(fault.getAttributeNode("xmlns"));
    }

    // 清理faultcode、faultstring的空xmlns属性
    NodeList faultChildren = fault.getChildNodes();
    for (int i = 0; i < faultChildren.getLength(); i++) {
        Node node = faultChildren.item(i);
        if (node.getNodeType() == Node.ELEMENT_NODE) {
            Element elem = (Element) node;
            if ("".equals(elem.getAttribute("xmlns"))) {
                elem.removeAttribute("xmlns");
            }
        }
    }

    saajMessage.saveChanges();
    return true;
}

关键修改点 #

• 移除原有Fault：避免原有Fault的默认命名空间声明干扰新创建的Fault。
• 指定QName创建Fault：直接使用带s前缀的QName创建Fault，确保其命名空间与Envelope一致。
• 清理冗余命名空间：移除Fault自身的xmlns属性，让它复用Envelope上的s前缀命名空间；同时清理子元素的空xmlns声明。

预期输出 #

修改后生成的SOAP响应将符合你的需求：

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header/>
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en">403 Forbidden: Access forbidden. Please check your permissions.</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>

内容的提问来源于stack exchange，提问作者tguclu