如何从 Java 类执行 SOAP Web Service 调用?

2022-08-31 09:12:24

我对Web服务世界相对较新,我的研究似乎让我感到困惑,而不是启发我,我的问题是我得到了一个库(jar),我必须使用一些Web服务功能进行扩展。

这个库将共享给其他开发人员,在jar中的类中,将有一个调用Web服务的方法的类(它基本上设置类的属性,执行一些业务逻辑,例如将对象存储在数据库中等,并通过这些修改发回对象)。我想使对此服务的调用尽可能简单,希望尽可能简单,以便使用该类的开发人员只需要这样做。

Car c = new Car("Blue");
c.webmethod();

我一直在研究在服务器上使用的JAX-WS,但在我看来,我不需要在服务器和客户端上创建一个,因为我知道两者都有类,我只需要在服务器和客户端中共享的类之间进行一些交互。您认为在课堂上执行Web服务和调用有何意义?wsimportwsimport


答案 1

我知道你的问题归结为如何从Java调用SOAP(JAX-WS)Web服务并获取其返回对象。在这种情况下,您有两种可能的方法:

  1. 生成Java类并使用它们;或wsimport
  2. 创建一个 SOAP 客户端,该客户端:
    1. 将服务的参数序列化为 XML;
    2. 通过HTTP操作调用Web方法;和
    3. 将返回的 XML 响应解析回对象。


关于第一种方法(使用wsimport):

我看到你已经有了服务的(实体或其他)业务类,事实上,它们生成了一组全新的类(在某种程度上是你已经拥有的类的副本)。wsimport

不过,恐怕在这种情况下,你只能:

  • 调整(编辑)生成的代码以使其使用您的业务类(这很困难,并且以某种方式不值得 - 请记住,每次WSDL更改时,您都必须重新生成并重新读取代码);或wsimport
  • 放弃并使用生成的类。(在此解决方案中,业务代码可以将生成的类“使用”为来自另一个体系结构层的服务。wsimport

关于第二种方法(创建自定义 SOAP 客户端):

为了实现第二种方法,您必须:

  1. 拨打电话:
    • 使用 SAAJ(SOAP with Attachment API for Java)框架(见下文,它与 Java SE 1.6 或更高版本一起提供)来进行调用;或
    • 您也可以通过(和一些处理)来完成它。java.net.HttpUrlconnectionjava.io
  2. 将对象转换为 XML 或从 XML 返回:
    • 使用 OXM(对象到 XML 映射)框架(如 JAXB)将 XML 从对象序列化/反序列化到对象
    • 或者,如果必须,手动创建/解析 XML(如果接收的对象与发送的对象只有一点点不同,这可能是最佳解决方案)。

使用 classic 创建 SOAP 客户端并不难(但也不是那么简单),您可以在此链接中找到一个非常好的起始代码。java.net.HttpUrlConnection

我建议您使用SAAJ框架:

SOAP with Attachments API for Java (SAAJ) 主要用于直接处理 SOAP Request/Response 消息,这些消息在任何 Web Service API 的幕后发生。它允许开发人员直接发送和接收 soap 消息,而不是使用 JAX-WS。

请参阅下面的一个工作示例(运行它!)使用 SAAJ 的 SOAP Web 服务调用。它调用此 Web 服务

import javax.xml.soap.*;

public class SOAPClientSAAJ {

    // SAAJ - SOAP Client Testing
    public static void main(String args[]) {
        /*
            The example below requests from the Web Service at:
             https://www.w3schools.com/xml/tempconvert.asmx?op=CelsiusToFahrenheit


            To call other WS, change the parameters below, which are:
             - the SOAP Endpoint URL (that is, where the service is responding from)
             - the SOAP Action

            Also change the contents of the method createSoapEnvelope() in this class. It constructs
             the inner part of the SOAP envelope that is actually sent.
         */
        String soapEndpointUrl = "https://www.w3schools.com/xml/tempconvert.asmx";
        String soapAction = "https://www.w3schools.com/xml/CelsiusToFahrenheit";

        callSoapWebService(soapEndpointUrl, soapAction);
    }

    private static void createSoapEnvelope(SOAPMessage soapMessage) throws SOAPException {
        SOAPPart soapPart = soapMessage.getSOAPPart();

        String myNamespace = "myNamespace";
        String myNamespaceURI = "https://www.w3schools.com/xml/";

        // SOAP Envelope
        SOAPEnvelope envelope = soapPart.getEnvelope();
        envelope.addNamespaceDeclaration(myNamespace, myNamespaceURI);

            /*
            Constructed SOAP Request Message:
            <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:myNamespace="https://www.w3schools.com/xml/">
                <SOAP-ENV:Header/>
                <SOAP-ENV:Body>
                    <myNamespace:CelsiusToFahrenheit>
                        <myNamespace:Celsius>100</myNamespace:Celsius>
                    </myNamespace:CelsiusToFahrenheit>
                </SOAP-ENV:Body>
            </SOAP-ENV:Envelope>
            */

        // SOAP Body
        SOAPBody soapBody = envelope.getBody();
        SOAPElement soapBodyElem = soapBody.addChildElement("CelsiusToFahrenheit", myNamespace);
        SOAPElement soapBodyElem1 = soapBodyElem.addChildElement("Celsius", myNamespace);
        soapBodyElem1.addTextNode("100");
    }

    private static void callSoapWebService(String soapEndpointUrl, String soapAction) {
        try {
            // Create SOAP Connection
            SOAPConnectionFactory soapConnectionFactory = SOAPConnectionFactory.newInstance();
            SOAPConnection soapConnection = soapConnectionFactory.createConnection();

            // Send SOAP Message to SOAP Server
            SOAPMessage soapResponse = soapConnection.call(createSOAPRequest(soapAction), soapEndpointUrl);

            // Print the SOAP Response
            System.out.println("Response SOAP Message:");
            soapResponse.writeTo(System.out);
            System.out.println();

            soapConnection.close();
        } catch (Exception e) {
            System.err.println("\nError occurred while sending SOAP Request to Server!\nMake sure you have the correct endpoint URL and SOAPAction!\n");
            e.printStackTrace();
        }
    }

    private static SOAPMessage createSOAPRequest(String soapAction) throws Exception {
        MessageFactory messageFactory = MessageFactory.newInstance();
        SOAPMessage soapMessage = messageFactory.createMessage();

        createSoapEnvelope(soapMessage);

        MimeHeaders headers = soapMessage.getMimeHeaders();
        headers.addHeader("SOAPAction", soapAction);

        soapMessage.saveChanges();

        /* Print the request message, just for debugging purposes */
        System.out.println("Request SOAP Message:");
        soapMessage.writeTo(System.out);
        System.out.println("\n");

        return soapMessage;
    }

}

关于使用 JAXB 进行序列化/反序列化,很容易找到有关它的信息。你可以从这里开始:http://www.mkyong.com/java/jaxb-hello-world-example/


答案 2

或者只是使用Apache CXF的wsdl2java来生成你可以使用的对象。

它包含在您可以从其网站下载的二进制包中。您可以简单地运行如下命令:

$ ./wsdl2java -p com.mynamespace.for.the.api.objects -autoNameResolution http://www.someurl.com/DefaultWebService?wsdl

它使用 wsdl 来生成对象,你可以像这样使用它(对象名称也是从 wsdl 中获取的,所以你的会有所不同):

DefaultWebService defaultWebService = new DefaultWebService();
String res = defaultWebService.getDefaultWebServiceHttpSoap11Endpoint().login("webservice","dadsadasdasd");
System.out.println(res);

甚至还有一个Maven插件可以生成源:https://cxf.apache.org/docs/maven-cxf-codegen-plugin-wsdl-to-java.html

注意:如果您使用 CXF 和 IDEA 生成源代码,则可能需要查看以下内容:https://stackoverflow.com/a/46812593/840315


推荐