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

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

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

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

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

Ответ 1

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

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


О первом подходе (с помощью wsimport):

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

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

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

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

Чтобы реализовать второй подход, вам необходимо:

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

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

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

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

Ответ 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, вы можете посмотреть на это: fooobar.com/questions/142316/...

Ответ 3

Я нашел гораздо более простой альтернативный способ создания мыльного сообщения. Данный объект 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
}

Ниже приведен простой генератор сообщений мыла:

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);
      }