Як здійснити виклик веб-служби SOAP з класу Java?


116

Я відносно новий у світі веб-сервісів, і мої дослідження, мабуть, збентежили мене більше, ніж просвітили, моя проблема полягає в тому, що мені дали бібліотеку (банку), яку мені потрібно розширити деякими функціоналами веб-сервісів.

Ця бібліотека буде надана іншим розробникам, і серед класів в банці будуть класи, у яких є метод, який викликає веб-сервіс (який по суті встановлює атрибут класу, виконує якусь ділову логіку, як зберігання об'єкта в db, тощо і повертає об'єкт із тими модифікаціями). Я хочу зробити дзвінок до цієї послуги якомога простішим, сподіваюся, таким же простим, що розробнику, що використовує клас, потрібно лише зробити.

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

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


Ваше запитання трохи незрозуміле. Метод, який ви хочете створити, (1) отримає об’єкт від веб-сервісу; (2) трохи попрацювати з об’єктом; та (3) розмістити його назад у веб-службі. Це все?
acdcjunior

Ні, об’єкт буде створений у клієнті, він буде відправлений ws у виклику, ws встановить змінну, наприклад currentTime, зробить якусь ділову логіку, як зберігати її в db, а потім відправить об'єкт повернутися до клієнта із встановленим поточним часом. Сподіваюся, я трохи краще пояснив себе. Дякую.
jpz

Відповіді:


273

Я розумію, що ваша проблема зводиться до того, як викликати веб-службу 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 (Object to XML Mapping), таку як 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/ .


Як встановити версію мила за допомогою вказаного вище способу?
Редоне

Я зміг використати ваш метод, і він працював, коли я використовував ваш URI, але на власний запит SOAP отримую відповідь, згідно з яким жодне зі значень не відображається як очікувалося, тобто <xsd:element name="Incident_Number" type="xsd:string"/>. Як бачите, елемент закритий, і інформація не формується з WS.
Мартін Ерліч

Це GetInfoByCityє 503Service Unavailable, це бачить. :(
Бред Турек

@BradTurek D * mn! Я просто його замінив. Дякую що дали мені знати! Я знайду ще одну і трохи її зміню.
acdcjunior

1
Для перехожого: Якщо вищевказаний код (приклад кінцевої точки веб-служби SOAP) перестане працювати або починає видавати помилки (наприклад, 500, 503 тощо), будь ласка, повідомте мене, щоб я можу його виправити.
acdcjunior

3

Або просто використовуйте 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


1
У мене в додатку 30+ wsdl. Готуючи ресурси для всього 1 wsdl (який містить 5 мильних дій), мій IDE Eclipse повісився та генерував близько 100+ Мб класів / об’єктів.
Manmohan_singh

-1

Я знайшов набагато простіший альтернативний спосіб генерування мильних повідомлень. Наданий об’єкт особі:

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);
      }
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.