Java发送SOAP请求与XML构造教程

文章小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《Java发送SOAP请求及XML构造方法》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

在Java中发送SOAP请求的核心方法是手动构造XML报文并通过HTTP客户端发送。1. 解析WSDL，明确服务地址、操作名、命名空间及报文结构；2. 使用DocumentBuilder构建包含Envelope、Header（可选）和Body的XML文档，并正确设置命名空间；3. 利用Transformer将XML文档转换为字符串；4. 使用HttpClient发送POST请求，设置Content-Type和SOAPAction头部，并发送XML字符串；5. 接收并解析响应XML，提取所需数据。代码示例展示了如何构建SOAP 1.1请求并发送，需引入Apache HttpClient依赖。SOAP报文由Envelope、Header、Body组成，Java通过createElementNS处理命名空间。调试时应检查HTTP状态码、解析SOAP Fault、打印请求响应报文，可借助SoapUI、Wireshark等工具。对于标准WSDL，推荐使用JAX-WS与wsimport生成客户端代码以简化开发。

在Java里发送SOAP请求报文，说实话，最直接也最能让你掌握细节的方式，就是自己动手构造XML报文，然后用HTTP客户端把它发送出去。这听起来可能有点“原始”，但对于那些WSDL不那么规矩，或者你需要精确控制报文内容的场景，它简直就是救命稻草。

解决方案

要实现这个，核心步骤无非就几点：先搞清楚你要调用的SOAP服务需要什么样的XML结构，接着在Java里把这个XML结构“画”出来，最后用HTTP请求把它扔给服务接口。

具体来说：

1. 解析WSDL，明确报文结构： 任何SOAP服务的起点都是WSDL（Web Services Description Language）。你需要仔细阅读它，找出服务地址（endpoint）、操作（operation）名称、输入参数的命名空间（namespace）和具体的元素结构。这是构建XML的基础。
2. 构造XML报文： 在Java里，你可以使用javax.xml.parsers.DocumentBuilder来创建XML Document对象，然后一层一层地添加Element。记住，SOAP报文有固定的信封（Envelope）、头部（Header，可选）和主体（Body）结构，你的业务数据是放在Body里的。命名空间（xmlns）在这里是重中之重，搞错了服务就认不出来。
3. 转换为字符串： 构造好的Document对象需要转换成字符串形式，才能通过HTTP发送。javax.xml.transform.Transformer能帮你完成这个。
4. 发送HTTP请求： 使用像Apache HttpClient这样的库（或者Java自带的HttpURLConnection也行，但HttpClient用起来更舒服些），创建一个POST请求。关键在于设置正确的Content-Type（通常是text/xml; charset=UTF-8或application/soap+xml for SOAP 1.2）以及SOAPAction头部（有些服务会强制要求这个，它通常是WSDL里定义的一个URI）。把你的XML字符串作为请求体发送出去。
5. 处理响应： 收到HTTP响应后，读取响应体，它通常也是一个XML。你需要再次使用DocumentBuilder来解析这个XML，从中提取你想要的数据。

这里有一段代码示例，展示了如何手动构建一个简单的SOAP 1.1请求并发送：

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.StringReader;
import java.io.StringWriter;

import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;

public class SoapClientManual {

    public static void main(String[] args) {
        String soapEndpointUrl = "http://localhost:8080/your-service/MyService"; // 替换为你的服务地址
        String targetNamespace = "http://your.namespace.com/"; // 替换为你的业务命名空间
        String soapAction = "http://your.namespace.com/YourOperation"; // 替换为你的SOAPAction

        try {
            // 1. 构建XML SOAP请求报文
            DocumentBuilderFactory docFactory = DocumentBuilderFactory.newInstance();
            docFactory.setNamespaceAware(true); // 必须设置，处理命名空间
            DocumentBuilder docBuilder = docFactory.newDocumentBuilder();
            Document doc = docBuilder.newDocument();

            Element envelope = doc.createElementNS("http://schemas.xmlsoap.org/soap/envelope/", "soapenv:Envelope");
            doc.appendChild(envelope);

            Element header = doc.createElementNS("http://schemas.xmlsoap.org/soap/envelope/", "soapenv:Header");
            envelope.appendChild(header);

            Element body = doc.createElementNS("http://schemas.xmlsoap.org/soap/envelope/", "soapenv:Body");
            envelope.appendChild(body);

            // 实际的业务数据部分，例如调用一个名为 'sayHello' 的操作，带一个 'name' 参数
            Element operation = doc.createElementNS(targetNamespace, "ns:sayHello"); // ns: 是自定义前缀
            body.appendChild(operation);

            Element paramName = doc.createElementNS(targetNamespace, "ns:name");
            paramName.setTextContent("Java Developer"); // 设置参数值
            operation.appendChild(paramName);

            // 将Document转换为字符串
            TransformerFactory transformerFactory = TransformerFactory.newInstance();
            Transformer transformer = transformerFactory.newTransformer();
            transformer.setOutputProperty(OutputKeys.INDENT, "yes"); // 格式化输出，方便阅读
            StringWriter writer = new StringWriter();
            transformer.transform(new DOMSource(doc), new StreamResult(writer));
            String soapRequest = writer.toString();

            System.out.println("Generated SOAP Request:\n" + soapRequest);

            // 2. 使用HttpClient发送请求
            HttpClient httpClient = HttpClientBuilder.create().build();
            HttpPost httpPost = new HttpPost(soapEndpointUrl);

            // 设置Content-Type和SOAPAction头部
            httpPost.setHeader("Content-Type", "text/xml; charset=UTF-8"); // SOAP 1.1
            httpPost.setHeader("SOAPAction", soapAction);

            StringEntity requestEntity = new StringEntity(soapRequest, "UTF-8");
            httpPost.setEntity(requestEntity);

            HttpResponse response = httpClient.execute(httpPost);
            String responseString = EntityUtils.toString(response.getEntity(), "UTF-8");

            System.out.println("SOAP Response Status: " + response.getStatusLine().getStatusCode());
            System.out.println("SOAP Response:\n" + responseString);

            // 3. 解析SOAP响应（示例：查找某个元素）
            if (response.getStatusLine().getStatusCode() == 200) {
                Document responseDoc = docBuilder.parse(new InputSource(new StringReader(responseString)));
                // 假设响应中有一个 'greeting' 元素
                NodeList greetingNodes = responseDoc.getElementsByTagNameNS(targetNamespace, "greeting");
                if (greetingNodes.getLength() > 0) {
                    String greeting = greetingNodes.item(0).getTextContent();
                    System.out.println("Parsed Greeting: " + greeting);
                }
            } else {
                System.err.println("Error response from server. Check status code and response body for SOAP Fault.");
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

注意： 上述代码需要Apache HttpClient库的依赖，例如Maven项目中添加：

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.13</version>
</dependency>

SOAP报文结构解析及其在Java中的映射

SOAP报文，从骨子里看，就是一套严格的XML规范。理解它的结构对我们手动构造报文至关重要。它主要由三个部分组成：

• Envelope (信封): 这是整个SOAP报文的根元素，定义了报文的XML命名空间（http://schemas.xmlsoap.org/soap/envelope/ for SOAP 1.1, http://www.w3.org/2003/05/soap-envelope for SOAP 1.2）。它就像一个包裹的外包装，所有内容都装在里面。
• Header (头部): 这是一个可选元素，用于存放与业务逻辑无关但对消息处理很重要的信息，比如安全凭证、事务ID、路由信息等。如果服务需要认证或其他元数据，通常会放在这里。
• Body (主体): 这是SOAP报文的核心，承载了实际的业务数据。你的方法调用和参数信息都封装在这个元素内部。当服务返回响应时，响应数据也同样在Body里。

在Java中映射这些结构，我们主要依赖DocumentBuilder创建的Document和Element对象。createElementNS方法是关键，它允许你指定元素的命名空间URI和带前缀的本地名称，比如doc.createElementNS("http://schemas.xmlsoap.org/soap/envelope/", "soapenv:Envelope")。业务数据部分，也就是Body里面的内容，它的命名空间通常是WSDL中定义的targetNamespace，或者是某个具体的XML Schema命名空间。正确处理这些命名空间，才能确保服务端能正确解析你的请求。说实话，这部分经常是新手最容易踩坑的地方，一个命名空间错了，整个请求就崩了。

错误处理与调试SOAP请求的常见策略

手动构造和发送SOAP请求，调试起来可能确实比用框架生成客户端要麻烦点。但只要掌握一些策略，也能事半功倍。

1. 检查HTTP状态码： 最直接的判断就是HTTP响应的状态码。200 OK通常表示请求到达了服务，并且服务端处理了。如果返回500 Internal Server Error，那很可能服务端处理请求时出错了，响应体里很可能包含了SOAP Fault信息。其他像400 Bad Request、404 Not Found等，则可能意味着请求格式有问题或服务地址不对。
2. 解析SOAP Fault： 当服务端处理请求失败时，它通常会返回一个包含soapenv:Fault元素的SOAP响应。这个Fault元素里包含了错误码、错误描述、错误来源等详细信息。在Java里，你需要解析这个响应XML，提取Fault节点下的faultcode、faultstring等子元素来获取具体的错误信息。我个人觉得，很多时候服务端返回的错误信息非常模糊，需要结合日志和WSDL来推断。
3. 打印请求与响应报文： 这是最基本也是最有效的调试手段。在发送请求前打印出你构造的XML报文，接收到响应后也打印出来。对比你期望的报文格式和实际发送/接收到的报文，很多问题就能一目了然。
4. 使用SOAP测试工具： 像SoapUI、Postman（尤其是其SOAP插件）这样的工具，是调试SOAP服务的利器。你可以把WSDL导入到这些工具中，它们能自动生成请求模板，你只需填入参数就能发送。用这些工具成功发送后，对比它们生成的报文和你自己Java代码生成的报文，能很快发现差异。
5. 网络抓包： 遇到一些底层问题，比如连接超时、SSL握手失败等，或者报文在网络传输中是否被篡改，Wireshark这类网络抓包工具能提供最原始的数据流，帮助你定位问题。

自动化SOAP客户端生成的另一种选择：JAX-WS与wsimport

虽然我们上面详细讨论了手动构造SOAP请求，但说实话，在绝大多数情况下，Java开发者会选择使用更高级的API来简化这个过程。其中最主流的就是JAX-WS（Java API for XML Web Services）。

JAX-WS的核心思想是“代码优先”或“WSDL优先”。当你拿到一个WSDL文件时，可以使用JDK自带的wsimport工具（或者Maven/Gradle插件）来自动生成Java客户端代码。这个过程会根据WSDL中定义的各种操作、数据类型，为你生成对应的接口、类和方法。你不再需要关心XML报文的构造细节，只需要像调用普通Java方法一样去调用这些生成的客户端方法，JAX-WS运行时会自动帮你处理XML的序列化、HTTP传输以及响应的XML解析。

何时选择JAX-WS：

• WSDL文件是标准的、规范的，并且没有太多自定义的、非标准的扩展。

好了，本文到此结束，带大家了解了《Java发送SOAP请求与XML构造教程》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！