如何从Java类进行SOAP Web服务调用?


116

我对Web服务领域还比较陌生,我的研究似乎给我带来的启发比困惑更多,我的问题是给了我一个库(jar),我必须对其进行扩展以提供一些Web服务功能。

该库将与其他开发人员共享,并且jar中的类之间将包含具有调用Web服务的方法的类(本质上是设置类的属性,执行一些业务逻辑,例如将对象存储在db中,等等,然后将这些修改发送回对象)。我想使对该服务的调用尽可能简单,希望尽可能简单,以便使用该类的开发人员只需这样做。

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

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


您的问题还不清楚。您要创建的方法将(1)从Web服务获取对象;(2)稍微处理一下物体;(3)将其发布回Web服务。是吗
acdcjunior 2013年

不,对象将在客户端中创建,它将在调用中发送给ws,ws将设置一个变量,例如currentTime,执行一些业务逻辑,例如将其存储在db中,然后发送该对象现在设置为currentTime的客户端返回客户端。希望我能更好地解释自己。谢谢。
2013年

Answers:


273

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

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


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

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

但是,在这种情况下,恐怕您只能:

  • 调整(编辑)wsimport生成的代码以使其使用您的业务类(这很困难,而且不值得这样做-每次WSDL更改时都要记住,您必须重新生成和重新适应代码);要么
  • 放弃并使用wsimport生成的类。(在该解决方案中,您的业务代码可以将生成的类作为另一个架构层的服务“使用”。)

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

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

  1. 拨打电话:
    • 使用SAAJ(带有Java的带有附件API的SOAP)框架(请参阅下面的内容,它随Java SE 1.6或更高版本一起提供)进行调用;要么
    • 您也可以通过java.net.HttpUrlconnection(和一些java.io处理)做到这一点。
  2. 将对象与XML相互转换:
    • 使用OXM(对象到XML映射)框架(例如JAXB)将XML从对象序列化/反序列化到对象
    • 或者,如果需要,请手动创建/解析XML(如果接收到的对象与发送的对象只有一点点差异,这可能是最好的解决方案)。

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

我建议您使用SAAJ框架:

带有Java附件API的SOAP(SAAJ)主要用于直接处理任何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/


如何使用上述方法设置肥皂版本?
重做

我可以使用您的方法,并且在使用URI时可以使用,但是对于我自己的SOAP请求,我得到了一个响应,其中没有显示任何值,即<xsd:element name="Incident_Number" type="xsd:string"/>。如您所见,该元素已关闭,并且WS没有生成任何信息。
马丁·埃里奇

GetInfoByCity503Service Unavailable,它seeems。:(
布拉德·图瑞克

@BradTurek D * mn!我只是更换了它。谢谢你让我知道!我会找到另一个,然后稍作更改。
acdcjunior

1
给路人:如果上面的代码(示例SOAP Web Service端点)停止工作或出现错误(例如500、503等),请告诉我,以便对其进行修复。
acdcjunior

3

或者只是使用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


1
我的应用程序中有30多个wsdl。在仅为1个wsdl(有5个soapActions)准备资源的同时,我的Eclipse IDE挂起并生成了大约100+ MB的类/对象。
Manmohan_singh

-1

我找到了一种生成肥皂消息的简单得多的替代方法。给定一个人物对象:

import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class Person {
  private String name;
  private int age;
  private String address; //setter and getters below
}

下面是一个简单的Soap Message Generator:

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

@Slf4j
public class SoapGenerator {

  protected static final ObjectMapper XML_MAPPER = new XmlMapper()
      .enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL)
      .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
      .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)
      .registerModule(new JavaTimeModule());

  private static final String SOAP_BODY_OPEN = "<soap:Body>";
  private static final String SOAP_BODY_CLOSE = "</soap:Body>";
  private static final String SOAP_ENVELOPE_OPEN = "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">";
  private static final String SOAP_ENVELOPE_CLOSE = "</soap:Envelope>";

  public static String soapWrap(String xml) {
    return SOAP_ENVELOPE_OPEN + SOAP_BODY_OPEN + xml + SOAP_BODY_CLOSE + SOAP_ENVELOPE_CLOSE;
  }

  public static String soapUnwrap(String xml) {
    return StringUtils.substringBetween(xml, SOAP_BODY_OPEN, SOAP_BODY_CLOSE);
  }
}

您可以通过以下方式使用:

 public static void main(String[] args) throws Exception{
        Person p = new Person();
        p.setName("Test");
        p.setAge(12);

        String xml = SoapGenerator.soapWrap(XML_MAPPER.writeValueAsString(p));
        log.info("Generated String");
        log.info(xml);
      }
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.