วิธีการเรียก SOAP Web Service จากคลาส Java

ฉันเพิ่งรู้จักกับโลกบริการเว็บและงานวิจัยของฉันดูเหมือนจะทำให้ฉันสับสนมากกว่าที่จะให้ความกระจ่างแก่ฉันปัญหาของฉันคือฉันได้รับไลบรารี (jar) ซึ่งฉันต้องขยายด้วยฟังก์ชันการทำงานของบริการเว็บ

ไลบรารีนี้จะถูกแชร์ให้กับนักพัฒนาคนอื่น ๆ และในบรรดาคลาสใน jar จะเป็นคลาสที่มีเมธอดที่เรียกใช้บริการเว็บ (ซึ่งโดยพื้นฐานแล้วจะตั้งค่าแอตทริบิวต์ของคลาสโดยใช้ตรรกะทางธุรกิจบางอย่างเช่นการจัดเก็บอ็อบเจ็กต์ในฐานข้อมูล ฯลฯ และส่งกลับวัตถุด้วยการปรับเปลี่ยนเหล่านั้น) ฉันต้องการโทรหาบริการนี้อย่างง่ายที่สุดหวังว่าจะง่ายที่สุดเพื่อให้นักพัฒนาที่ใช้คลาสต้องทำเท่านั้น

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

ฉันเรียน JAX-WS เพื่อใช้บนเซิร์ฟเวอร์ แต่สำหรับฉันแล้วฉันไม่จำเป็นต้องสร้างwsimportในเซิร์ฟเวอร์หรือwsimportบนไคลเอนต์เนื่องจากฉันรู้ว่าทั้งสองมีคลาสฉันแค่ต้องการการโต้ตอบระหว่างคลาส แชร์ทั้งในเซิร์ฟเวอร์และไคลเอนต์ คุณคิดว่าการทำเว็บเซอร์และการโทรในชั้นเรียนมีเหตุผลอย่างไร

ผมเข้าใจปัญหาของคุณเดือดลงไปวิธีการเรียกสบู่ (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 สำหรับ Java) (ดูด้านล่างซึ่งมาพร้อมกับ Java SE 1.6 ขึ้นไป) เพื่อทำการโทร หรือ
   • คุณสามารถทำได้ผ่านjava.net.HttpUrlconnection(และการjava.ioจัดการบางอย่าง)
2. เปลี่ยนวัตถุเข้าและกลับจาก XML:
   • ใช้เฟรมเวิร์ก OXM (Object to XML Mapping) เช่น JAXB เพื่อทำให้เป็นอนุกรม / deserialize XML จาก / ลงในอ็อบเจ็กต์
   • หรือหากคุณต้องสร้าง / แยกวิเคราะห์ XML ด้วยตนเอง (นี่อาจเป็นวิธีแก้ปัญหาที่ดีที่สุดหากวัตถุที่ได้รับแตกต่างจากวัตถุที่ส่งไปเพียงเล็กน้อย)

การสร้างไคลเอนต์ SOAP โดยใช้แบบคลาสสิกjava.net.HttpUrlConnectionนั้นไม่ใช่เรื่องยาก (แต่ก็ไม่ใช่เรื่องง่ายเช่นกัน) และคุณจะพบโค้ดเริ่มต้นที่ดีมากในลิงค์นี้

ฉันขอแนะนำให้คุณใช้กรอบงาน SAAJ:

SOAP ที่มี Attachments API สำหรับ Java (SAAJ)ส่วนใหญ่จะใช้สำหรับจัดการโดยตรงกับ SOAP Request / Response ข้อความซึ่งเกิดขึ้นเบื้องหลังใน Web Service 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

ฉันพบวิธีอื่นที่ง่ายกว่ามากในการสร้างข้อความสบู่ ให้วัตถุบุคคล:

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