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

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

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

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

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

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

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

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

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

Боюсь, что в этом сценарии вы можете только:

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

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

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

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

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

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

SOAP с API вложений для 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/ .

Или просто используйте 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

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