迹忆客 专注技术分享

本文将教我们如何从 Java 类进行 SOAP WebService 调用。

SOAP 网络服务

SOAP 代表简单对象访问协议。 可以通过这个基于 XML 的接口来访问 Web 服务。

W3C 建议使用 SOAP 在两个应用程序之间进行通信。 SOAP 协议是基于XML 的。

它对任何特定平台或语言没有偏好。 您可以使用 SOAP 与其他编程语言应用程序进行通信。

从 Java 类调用 SOAP Web 服务

在某些情况下，使用 Java 类而不是 Web 服务库来调用 SOAP 服务可能更快、更有帮助。 例如，当使用 Web 服务库生成客户端代理时，或者如果您想要响应的一些小的、专门的部分时，您可能会遇到问题。

它只是通过 HTTP 或 HTTPS 协议从一段简单的 Java 代码发出的 SOAP 请求，无需使用任何 Java 库。

以下是从 Java 类调用 SOAP Web 服务的步骤。

WSDL

首先，打开 WSDL 文件以从 Java 类进行 SOAP Web 服务调用。 检查 WSDL 文件中的 XSD、SOAP 操作和 SOAP 地址位置。

SOAP 请求和响应的名称分别为 getUserDetailsRequest 和 getUserDetailsResponse。 此外，还有请求的输入参数。

这里只有一个参数，名称，它是一个字符串。

...
<xs:element name="getUserDetailsRequest">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="name" type="xs:string" />
        </xs:sequence>
    </xs:complexType>
</xs:element>
<xs:element name="getUserDetailsResponse">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="users" type="tns:user" minOccurs="0"
                maxOccurs="unbounded" />
        </xs:sequence>
    </xs:complexType>
</xs:element>
...

请求 XML

创建响应 XML 结构不需要 Java 代码，因为我们将从服务器获取它。 但是，需要 Java 代码来创建请求 XML 结构，因为我们必须将其作为输入提交到 SOAP 服务。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
    <getUserDetailsRequest xmlns="https://roytuts.com/UserService">
        <name>User Name</name>
    </getUserDetailsRequest>
</soapenv:Body>
</soapenv:Envelope>

SOAP 地址

查找 SOAP 地址位置，该位置充当 SOAP 服务的端点 URL。 我们将使用 Java 的 HttpURLConnection API 连接到此端点。

#@## SOAP 操作 然后必须找到将用作 SOAP 操作的操作名称。 getUserDetails 位于此处。

创建 SOAP 客户端

我们已经确定了所有必要条件并准备开发自定义 Java 类。

package com.roytuts.soap.client;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.nio.charset.Charset;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
public class SoapClient {
    public static void main(String[] args) throws IOException {
        // Webservice HTTP request configurations
        String wsEndPoint = "http://localhost:9999/ws";
        URL url = new URL(wsEndPoint);
        URLConnection connection = url.openConnection();
        HttpURLConnection http = (HttpURLConnection) connection;
        ByteArrayOutputStream bout = new ByteArrayOutputStream();

        String xmlInput = "<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Header/><soapenv:Body><getUserDetailsRequest xmlns="https://roytuts.com/UserService"><name>User Name</name></getUserDetailsRequest></soapenv:Body></soapenv:Envelope>";
        byte[] buffer = new byte[xmlInput.length()];
        buffer = xmlInput.getBytes();
        bout.write(buffer);
        byte[] b = bout.toByteArray();

        String stringResponse = "";
        String stringOutput = "";
        String SOAPAction = "getUserDetails";

        http.setRequestProperty("Content-Length", String.valueOf(b.length));
        http.setRequestProperty("Content-Type", "text/xml; charset=utf-8");
        http.setRequestProperty("SOAPAction", SOAPAction);
        http.setRequestMethod("POST");
        http.setDoOutput(true);
        http.setDoInput(true);

        OutputStream out = http.getOutputStream();

        out.write(b);
        out.close();

        InputStreamReader isr = new InputStreamReader(http.getInputStream(), Charset.forName("UTF-8"));
        BufferedReader in = new BufferedReader(isr);

        while ((stringResponse = in.readLine()) != null) {
                        stringOutput = stringOutput + stringResponse;
        }

        String formattedSOAPResponse = formatXML(stringOutput);
        System.out.println(formattedSOAPResponse);
    }

    private static String formatXML(String unformattedXml) {
        try {
            Document document = parseXmlFile(unformattedXml);
            TransformerFactory transformerFactory = TransformerFactory.newInstance();
            transformerFactory.setAttribute("indent-number", 3);
            Transformer transformer = transformerFactory.newTransformer();
            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
            DOMSource source = new DOMSource(document);
            StreamResult xmlOutput = new StreamResult(new StringWriter());
            transformer.transform(source, xmlOutput);
            return xmlOutput.getWriter().toString();
        } catch (TransformerException e) {
            throw new RuntimeException(e);
        }
    }

    private static Document parseXmlFile(String in) {
        try {
            DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
            DocumentBuilder db = dbf.newDocumentBuilder();
            InputSource is = new InputSource(new StringReader(in));
            return db.parse(is);
        } catch (IOException | ParserConfigurationException | SAXException e) {
            throw new RuntimeException(e);
        }
    }
}

HTTPS 调用

使用下面代码示例中的想法通过 HTTPS 连接调用 SOAP Web 服务。 此示例演示如何使用 GET 和 POST 方法从普通 Java 代码联系 SOAP Web 服务。

下面的代码演示了如何使用HTTPS协议。 因此，在为应用程序开发代码时尝试考虑所有编程标准。

package com.roytuts.java.soap.https.connection;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;

import javax.net.ssl.HttpsURLConnection;

public class JavaSoapHttpsClient {

    public static void main(String[] args) throws Exception {
        invokeSoapService("https://postman-echo.com/post", "POST", "<xml><body>SAOP request</body></xml>");

        invokeSoapService("https://www.google.com", "GET", null);
    }

    public static void invokeSoapService(final String url, final String httpMethod, final String requestXML)
            throws IOException {
        URL myUrl = new URL(url);

        HttpURLConnection http = (HttpsURLConnection) myUrl.openConnection();
        http.setDoOutput(true);
        http.setRequestMethod(httpMethod);

        OutputStreamWriter out = null;
        if ("POST".equals(httpMethod) && requestXML != null) {
            out = new OutputStreamWriter(conn.getOutputStream());
            out.append(requestXML);
        }

        BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream()));

        String inputLine;

        System.out.println("Response Code: " + conn.getResponseCode());
        System.out.print("Response Text: ");

        while ((inputLine = br.readLine()) != null) {
            System.out.println(inputLine);
        }

        if (out != null) {
            out.flush();
            out.close();
        }

        br.close();
    }

}

本文教我们如何从 Java 类进行 SOAP Web 服务调用。 本文讨论了各个步骤。

用户可以按照以下步骤从 Java 类调用 SOAP Web 服务。