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


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

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

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

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

2 101

2 ответа:

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

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


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

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

Я боюсь, хотя, в этом случае, вы можете только либо:

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

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

чтобы реализовать второй подход, вам придется:

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

создание клиента SOAP с помощью classic java.net.HttpUrlConnection - это не так сложно (но и не так просто), и вы можете найти в этой ссылке a очень хороший стартовый код.

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

SOAP с вложениями API для Java (SAAJ) в основном используется для работы непосредственно с SOAP-запросами / ответными сообщениями, которые происходят за кулисами в любом API веб-службы. Это позволяет разработчикам напрямую отправлять и получать сообщения soap вместо использования 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/.

или просто использовать Wsdl2java от Apache CXF для создания объектов можно использовать.

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

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