JavaクラスからSOAP Webサービスを呼び出す方法は?


116

私はウェブサービスの世界に比較的新しいので、私の研究は私を啓蒙する以上に私を混乱させたようです、私の問題は私がいくつかのウェブサービス機能で拡張しなければならないライブラリ(jar)を与えられたことです。

このライブラリは他の開発者と共有され、jar内のクラスの中には、Webサービスを呼び出すメソッド(基本的にはクラスの属性を設定し、dbにオブジェクトを格納するなどのビジネスロジックを実行する)を持つクラスがあります。など、それらの変更を含むオブジェクトを送り返します)。このサービスの呼び出しをできるだけ簡単にしたいのですが、できればクラスを使用している開発者が実行するだけでよいように、できるだけ簡単にしたいと思います。

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

私はサーバーで使用するJAX-WSを研究していますがwsimport、サーバーにもwsimportクライアントにもを作成する必要はないようです。両方にクラスがあることがわかっているので、クラス間の相互作用が必要なだけです。サーバーとクライアントの両方で共有されます。クラスでWebサービスと呼び出しを行うことはどのように意味があると思いますか?


あなたの質問は少し不明瞭です。作成するメソッドは、(1)Webサービスからオブジェクトを取得します。(2)オブジェクトを少し操作します。(3)それをWebサービスにポストバックします。それですか?
acdcjunior 2013

いいえ、オブジェクトはクライアントで作成され、呼び出しでwsに送信され、wsはcurrentTimeなどの変数を設定し、dbに格納するなどのビジネスロジックを実行してから、オブジェクトを送信しますcurrentTimeが設定された状態でクライアントに戻ります。私は自分のことをもう少しよく説明したいと思います。ありがとうございました。
jpz 2013

回答:


273

あなたの問題は、JavaからSOAP(JAX-WS)Webサービスを呼び出し、その戻りオブジェクトを取得する方法に要約されると理解しています。その場合、2つの可能なアプローチがあります。

  1. Javaクラスを生成してwsimport使用します。または
  2. 次のSOAPクライアントを作成します。
    1. サービスのパラメーターをXMLにシリアル化します。
    2. HTTP操作を通じてWebメソッドを呼び出します。そして
    3. 返されたXML応答を解析してオブジェクトに戻します。


最初のアプローチについて(を使用wsimport):

サービス(エンティティまたはその他)のビジネスクラスが既にあることを確認しました。これにより、wsimportによってまったく新しいクラスのセットが生成されます(これは、既に持っているクラスの複製です)。

申し訳ありませんが、このシナリオでは、次のいずれかしか行えません。

  • wsimport生成されたコードを調整(編集)してビジネスクラスを使用できるようにします(これは難しく、何とかして価値がありません。WSDLが変更されるたびに、コードを再生成して再調整する必要があることに注意してください)。または
  • wsimport生成されたクラスをあきらめて使用します。(このソリューションでは、ビジネスコードは、生成されたクラスを別のアーキテクチャレイヤーのサービスとして「使用」できます。)

2番目のアプローチ(カスタムSOAPクライアントの作成)について:

2番目のアプローチを実装するには、次のことを行う必要があります。

  1. 電話をかける:
    • SAAJ(SOAP with Attachments API for Java)フレームワーク(以下を参照。JavaSE 1.6以降に同梱)を使用して呼び出しを行います。または
    • また、それを行うこともできますjava.net.HttpUrlconnection(およびいくつかのjava.io処理)。
  2. オブジェクトをXMLに変換したり、XMLから戻したりします。
    • JAXBなどのOXM(オブジェクトからXMLへのマッピング)フレームワークを使用して、XMLをオブジェクトから/オブジェクトにシリアライズ/デシリアライズします
    • または、必要に応じて、手動でXMLを作成/解析します(受信したオブジェクトが送信したオブジェクトと少しだけ異なる場合は、これが最良の解決策になる可能性があります)。

classicを使用してSOAPクライアントを作成するjava.net.HttpUrlConnectionことはそれほど難しくありません(しかし、それほど単純ではありません)。このリンクから、非常に優れた開始コードを見つけることができます。

SAAJフレームワークを使用することをお勧めします。

SOAP with Attachments API for Java(SAAJ)は主に、任意のWebサービスAPIの背後で発生するSOAP要求/応答メッセージを直接処理するために使用されます。開発者は、JAX-WSを使用する代わりにSOAPメッセージを直接送受信できます。

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/


上記の方法を使用して石鹸のバージョンを設定するにはどうすればよいですか?
2016年

私はあなたのメソッドを使用することができ、URIを使用したときにそれは機能しましたが、私自身のSOAPリクエストでは、期待どおりに値が表示されないという応答が返され<xsd:element name="Incident_Number" type="xsd:string"/>ます。ご覧のとおり、要素は閉じており、WSから情報は生成されません。
Martin Erlic 2016年

GetInfoByCity503Service Unavailable、それがseeems。:(
Brad Turek

@BradTurek D * mn!私はちょうどそれを置き換えます。知らせてくれてありがとうございます!別のものを見つけて、少し変更します。
acdcjunior 2017

1
通行人へ:上記のコード(SOAP Webサービスのエンドポイントの例)が機能しなくなったり、エラー(500、503など)が発生したりする場合は、修正できるようにお知らせください。
acdcjunior 2017

3

または、Apache CXFのwsdl2javaを使用して、使用できるオブジェクトを生成します。

それは彼らのウェブサイトからダウンロードできるバイナリパッケージに含まれています。次のようなコマンドを実行するだけです。

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

それはあなたが同じように使用できるオブジェクト、生成するWSDLを使用して、これを(あなたが異なるAの少しとなりますので、オブジェクト名も、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

soapメッセージを生成するより簡単な代替方法を見つけました。Personオブジェクトを考える:

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メッセージジェネレータです。

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);
      }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.