it-roy-ru.com

Как сделать вызов веб-службы SOAP из класса Java?

Я относительно новичок в мире веб-сервисов, и мое исследование, кажется, смутило меня больше, чем просветило меня, моя проблема в том, что мне дали библиотеку (jar), которую я должен расширить с некоторыми функциональными возможностями веб-сервиса.

Эта библиотека будет предоставлена ​​другим разработчикам, и среди классов в jar будут классы, у которых есть метод, который вызывает веб-сервис (который, по сути, устанавливает атрибут класса, выполняет некоторую бизнес-логику, например, хранит объект в БД, и т.д. и отправляет обратно объект с этими изменениями). Я хочу сделать вызов к этому сервису как можно более простым, надеюсь, настолько простым, что разработчик, использующий этот класс, должен сделать только это.

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

Я изучал JAX-WS для использования на сервере, но мне кажется, что мне не нужно создавать wsimport на сервере или wsimport на клиенте, так как я знаю, что у обоих есть классы, мне просто нужно некоторое взаимодействие между классами, общими для сервера и клиента. Как вы думаете, имеет смысл сделать веб-сервис и вызов в классе?

106
jpz

Я понимаю, что ваша проблема сводится к тому, как вызвать SOAP (JAX-WS) веб-сервис из Java и ​​получить его возвращаемый объект . В этом случае у вас есть два возможных подхода:

  1. Сгенерируйте классы Java через wsimport и используйте их; или же
  2. Создайте клиента SOAP, который:
    1. Сериализует параметры сервиса в XML;
    2. Вызывает веб-метод посредством HTTP-манипуляции; а также
    3. Разобрать возвращаемый XML-ответ обратно в объект.


О первом подходе (используя wsimport):

Я вижу, что у вас уже есть бизнес-классы служб (сущностей или других), и фактом является то, что wsimport генерирует целый новый набор классов (которые каким-то образом являются дубликатами классов, которые у вас уже есть).

Боюсь, однако, в этом случае вы можете только:

  • Адаптируйте (отредактируйте) сгенерированный код wsimport, чтобы он использовал ваши бизнес-классы (это сложно и почему-то не стоит - имейте в виду каждый раз, когда WSDL изменяется вам нужно будет заново сгенерировать и перечитать код); или же
  • Откажитесь и используйте сгенерированные классы wsimport. (В этом решении ваш бизнес-код может "использовать" сгенерированные классы в качестве службы из другого архитектурного уровня.)

О втором подходе (создайте свой собственный SOAP клиент):

Для реализации второго подхода вам необходимо:

  1. Сделайте звонок:
    • Используйте SAAJ (SOAP с Attachments API для Java) (см. Ниже, он поставляется с Java SE 1.6 или выше) для выполнения вызовов; или же
    • Вы также можете сделать это с помощью Java.net.HttpUrlconnection (и некоторой обработки Java.io).
  2. Превратите объекты в и обратно из XML:
    • Используйте OXM (Object to XML Mapping) каркас, такой как JAXB, для сериализации/десериализации XML из/в объекты
    • Или, если необходимо, вручную создайте/проанализируйте XML (это может быть лучшим решением, если полученный объект немного отличается от отправленного).

Создание клиента SOAP с использованием классического Java.net.HttpUrlConnection не так сложно (но и не так просто), и вы можете найти в эта ссылка очень хороший начальный код.

Я рекомендую вам использовать фреймворк SAAJ:

API SOAP с вложениями для Java (SAAJ) в основном используется для непосредственного взаимодействия с SOAP Запрос/ответ сообщения, которые происходят за кулисами в любом API веб-службы. Это позволяет разработчикам напрямую отправлять и получать мыльные сообщения вместо использования JAX-WS.

Ниже приведен рабочий пример (запустите его!) Вызова веб-службы SOAP с использованием SAAJ. Он называет этот веб-сервис .

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/ .

255
acdcjunior

Или просто используйте Apache CXF wsdl2Java для генерации объектов, которые вы можете использовать.

Он входит в бинарный пакет, который вы можете скачать с их сайта. Вы можете просто запустить команду как это:

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

Он использует wsdl для генерации объектов, которые вы можете использовать как this (имена объектов также извлекаются из 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

4
szab.kel