SpringBoot調(diào)用第三方WebService接口的兩種方法

更新時間：2023年06月28日 09:30:55 作者：代號diitich

本文主要介紹了SpringBoot調(diào)用第三方WebService接口的兩種方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

WebService簡介

WebService接口的發(fā)布通常一般都是使用WSDL（web service descriptive language）文件的樣式來發(fā)布的，該文檔包含了請求的參數(shù)信息，返回的結果信息，我們需要根據(jù)WSDL文檔的信息來編寫相關的代碼進行調(diào)用WebService接口。接下來我將采用常見的兩種方式調(diào)用WebService接口。

場景描述

目前我需要使用java調(diào)用C#系統(tǒng)的一個WebService接口，傳遞參數(shù)為一個表號，返回的是一個Xml的數(shù)據(jù)類型，需要實現(xiàn)調(diào)用接口，獲取到xml之后并解析為Json格式數(shù)據(jù)，并返回給前端。Java調(diào)用WebService接口，需要根據(jù)提供接口方的XSD文檔編寫相關代碼，Xsd文檔可以直接通過提供的接口地址進行查看。

WebServiceTemplate調(diào)用WebService接口實現(xiàn)

1.導入相關的依賴包，如下：

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web-services</artifactId>
  </dependency>

2.使用WebServiceTemplate實現(xiàn)調(diào)用WebService接口，需要編寫先關的解析類，根據(jù)提供的XSDL文檔編寫先關代碼，XSDL文檔信息如下：

POST /rootServiceFlow/EBoardService.asmx HTTP/1.1
Host: 10.200.0.74
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/AAFlow002x"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
   <AAFlow002x xmlns="http://tempuri.org/">
     <LotNo>string</LotNo>
   </AAFlow002x>
 </soap:Body>
</soap:Envelope>

上面的信息是包含請求所需要傳遞的參數(shù)，字段為LotNo。接下來XSDL的文檔信息為返回的數(shù)據(jù)格式，如下：

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AAFlow002xResponse xmlns="http://tempuri.org/">
      <AAFlow002xResult>string</AAFlow002xResult>
    </AAFlow002xResponse>
  </soap:Body>
</soap:Envelope>

需要根據(jù)以上信息編寫請求類AAFlow002x，響應接收解析類AAFlow002xResponse，和ObjectFactory類，這三個類可以使用Idea的終端通過命令的方式生成對應的java類，也可以通過自己編寫生成java類。通過命令的方式如下：

xjc -d /path/to/output http://example.com/sample.xsd

/path/to/output為生成類的目錄，http://example.com/sample.xsd為webServce的接口地址，生成的類如下：

AAFlow002x類編寫如下：
import lombok.Data;
import javax.xml.bind.annotation.*;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "",  propOrder = {
        "LotNo"
})
@XmlRootElement(name = "AAFlow002x", namespace = "http://tempuri.org/")
@Data
public class AAFlow002x {
    @XmlElement(name = "LotNo", namespace = "http://tempuri.org/", required = true)
    protected String LotNo;
}

AAFlow002xResponse類編寫如下：
import lombok.Data;
import javax.xml.bind.annotation.*;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AAFlow002xResponse", namespace = "http://tempuri.org/", propOrder = {
        "AAFlow002xResult"
})
@XmlRootElement(name = "AAFlow002xResponse")
@Data
public class AAFlow002xResponse {
    @XmlElement(name = "AAFlow002xResult", namespace = "http://tempuri.org/", required = true)
    private String AAFlow002xResult;
}

ObjectFatoty類編寫如下：
import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;
@XmlRegistry
public class ObjectFactory {
    private final static QName _AAFlow002_QNAME = new QName("http://tempuri.org/", "AAFlow002x");
    private final static QName _AAFlow002Response_QNAME = new QName("http://tempuri.org/", "AAFlow002xResponse");
    public ObjectFactory() {
    }
    public AAFlow002x createAAFlow002x() {
        return new AAFlow002x();
    }
    public AAFlow002xResponse createAAFlow002xResponse() {
        return new AAFlow002xResponse();
    }
    @XmlElementDecl(namespace = "http://tempuri.org/", name = "AAFlow002x")
    public JAXBElement<AAFlow002x> createAAFlow002x(AAFlow002x value) {
        return new JAXBElement<AAFlow002x>(_AAFlow002_QNAME, AAFlow002x.class, null, value);
    }
    @XmlElementDecl(namespace = "http://tempuri.org/", name = "AAFlow002yResponse")
    public JAXBElement<AAFlow002xResponse> createAAFlow002yResponse(AAFlow002xResponse value) {
        return new JAXBElement<AAFlow002xResponse>(_AAFlow002Response_QNAME, AAFlow002xResponse.class, null, value);
    }
}

編寫使用WebServiceTemplate進行調(diào)用

@Service
@Slf4j
public class TestWebService {
    private static final String ENDPOINT_URL = "這里填寫你調(diào)用的WebService接口地址";
    private static final String SOAP_ACTION = "http://tempuri.org/AAFlow002x";
    public  String  getDataTable(String LotNo) {
         //         創(chuàng)建WebServiceTemplate對象
        WebServiceTemplate webServiceTemplate = new WebServiceTemplate();
        Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
        // 設置解析類，這里填寫包的路徑為AAFlow002xResponse類所在路徑
        marshaller.setContextPath("org.test.parse");
        webServiceTemplate.setMarshaller(marshaller);
        webServiceTemplate.setUnmarshaller(marshaller);
        // 封裝請求參數(shù)
        AAFlow002x aaFlow002 = new ObjectFactory().createAAFlow002x();
        aaFlow002.setLotNo("22113102");
        // 創(chuàng)建SOAP請求回調(diào)對象，這里的SOAP_ACTION指定你調(diào)用的接口的哪個方法
        SoapActionCallback soapActionCallback = new SoapActionCallback(SOAP_ACTION);
        // 調(diào)用WebService接口，發(fā)送請求并返回數(shù)據(jù)
        JAXBElement<AAFlow002xResponse> aaFlow002xResponse = (JAXBElement<AAFlow002xResponse>) webServiceTemplate.marshalSendAndReceive(ENDPOINT_URL, aaFlow002, soapActionCallback);
        String result = aaFlow002xResponse.getValue().getAAFlow002xResult();
        // 輸出響應結果
        System.out.println(aaFlow002xResponse.getValue().getAAFlow002xResult());
        return result;
         }
    }

編寫完成之后，Debug啟動項目。出現(xiàn)如下圖所示證明調(diào)用接口成功：

我們可以針對以上代碼進行優(yōu)化，寫一個WebServiceConfig類，專門對WebServiceTemplate進行配置，這里就不在贅述。采用WebServiceTemplate接口調(diào)用WebService接口,雖然可以采用命令的方式生成對應的Java代碼，但是其缺點是如果請求的參數(shù)和返回的參數(shù)數(shù)據(jù)結構很復雜，生成的java類代碼就很復雜。

HttpClientBuilder調(diào)用WebService接口實現(xiàn)

  @Override
    public JSONObject getDataFromMESSystem(String deviceNumber)  {
       // 根據(jù)上面的XSDL文檔封裝請求參數(shù)
       String strParameter = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
               "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n" +
               "  <soap:Body>\n" +
               "    <AAFlow002y xmlns=\"http://tempuri.org/\">\n" +
               "  <LotNo>" + deviceNumber + "</LotNo>\n" +
               "    </AAFlow002y>\n" +
               "   </soap:Body>\n" +
               " </soap:Envelope>";
        // 獲取數(shù)據(jù)，返回的是一個xml格式數(shù)據(jù)
        String xmlData = doPostSoap(UrlConstant.MES_SERVICE_URL, strParameter, UrlConstant.MES_SOAP_URI);
        JSONObject jsonObject = null;
        try {
            // 將請求結果轉換成json類型
            if(StringUtils.isNotBlank(xmlData)){
                jsonObject = xml2Json(xmlData);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return jsonObject;
    }
/**
     * 發(fā)送Soap請求，并返回數(shù)據(jù)
     * @param url  WebService接口地址
     * @param soap 封裝的請求參數(shù)
     * @param SOAPAction 對應的調(diào)用方法uri
     * @return 返回xml數(shù)據(jù)，用一個字符串接收
     */
    public static String doPostSoap(String url, String soap, String SOAPAction) {
        // 請求體
        String retStr = "";
        // 創(chuàng)建HttpClientBuilder
        HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
        // HttpClient
        CloseableHttpClient closeableHttpClient = httpClientBuilder.build();
        HttpPost httpPost = new HttpPost(url);
        try {
            httpPost.setHeader("Content-Type", "text/xml;charset=UTF-8");
            httpPost.setHeader("SOAPAction", SOAPAction);
            StringEntity data = new StringEntity(soap,
                    Charset.forName("UTF-8"));
            httpPost.setEntity(data);
            CloseableHttpResponse response = closeableHttpClient
                    .execute(httpPost);
            HttpEntity httpEntity = response.getEntity();
            if (httpEntity != null) {
                // 打印響應內(nèi)容
                retStr = EntityUtils.toString(httpEntity, "UTF-8");
                System.err.println("response:" + retStr);
            }
            // 釋放資源
            closeableHttpClient.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return retStr;
    }

接下來需要根據(jù)返回的xml格式數(shù)據(jù)解析為Json格式，我們可以用Postman測試WebService接口，查看數(shù)據(jù)返回格式，如下圖所示：

點擊Send，返回的數(shù)據(jù)格式如下圖所示：

數(shù)據(jù)太多，這里我給出返回的縮減的結構數(shù)據(jù)，如下

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <AAFlow002yResponse xmlns="http://tempuri.org/">
            <AAFlow002yResult>
                <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
                    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="AAFlow002" msdata:UseCurrentLocale="true">
                        <xs:complexType>
                            <xs:choice minOccurs="0" maxOccurs="unbounded">
                                <xs:element name="AAFlow002">
                                    <xs:complexType>
                                        <xs:sequence>
                                            <xs:element name="F1000" type="xs:string" minOccurs="0" />
                                        </xs:sequence>
                                    </xs:complexType>
                                </xs:element>
                            </xs:choice>
                        </xs:complexType>
                    </xs:element>
                </xs:schema>
                <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
                    <DocumentElement xmlns="">
                        <AAFlow002 diffgr:id="AAFlow0021" msdata:rowOrder="0">
                                                   <F1000>2596</F1000>
                        </AAFlow002>
                    </DocumentElement>
                </diffgr:diffgram>
            </AAFlow002yResult>
        </AAFlow002yResponse>
    </soap:Body>
</soap:Envelope>

根據(jù)上面的信息，編寫解析xml數(shù)據(jù)轉換為Json格式數(shù)據(jù)代碼如下：

 /**
     * 解析webservice的返回結果,將xml解析為json格式數(shù)據(jù)
     * @param xmlStr xml內(nèi)容
     * @return
     */
    public static JSONObject xml2Json(String xmlStr) throws DocumentException {
        Document doc = DocumentHelper.parseText(xmlStr);
        Element root = doc.getRootElement();
        Element body = root.element("Body");
        Element response = body.element("AAFlow002yResponse");
        Element result = response.element("AAFlow002yResult");
        Element diffgram = result.element(new QName("diffgram", Namespace.get("urn:schemas-microsoft-com:xml-diffgram-v1")));
        Element documentElement = diffgram.element("DocumentElement");
        Element aaFlow002 = documentElement.element("AAFlow002");
        JSONObject jsonObject = new JSONObject();
        Iterator<Element> iterator = aaFlow002.elementIterator();
        while (iterator.hasNext()) {
            Element element = iterator.next();
            jsonObject.put(element.getName(), element.getText());
        }
        return jsonObject;
    }

通過HttpClient的方式調(diào)用WebService接口，缺點是需要自己編寫解析xml的代碼，而WebServiceTemplate的方式可以自動解析為對應的Java類，但是個人更偏向于使用HttpClient的方式調(diào)用WebService接口，WebServiceTemplate方式，代碼復雜度比較高，耦合性太強。

到此這篇關于SpringBoot調(diào)用第三方WebService接口的兩種方法的文章就介紹到這了,更多相關SpringBoot調(diào)用WebService接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

解決java.net.SocketTimeoutException: Read timed out的問題
這篇文章主要介紹了解決java.net.SocketTimeoutException: Read timed out的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-06-06
java怎樣動態(tài)獲取泛型參數(shù)的類型
在Java中,泛型信息在編譯時會被擦除,但可以通過特定API獲取運行時的泛型參數(shù)類型,主要API包括Class的getGenericSuperclass()和getGenericInterfaces()方法,以及ParameterizedType的getActualTypeArguments()方法
2024-09-09
Java中常見的文件拷貝方式小結
這篇文章主要為大家詳細介紹了JAVA?四種拷貝文件的方式,分析一下他們對內(nèi)存使用的方式和各自應用的場景,其實也是對之前學過的知識做一個回顧吧,快跟隨小編一起學習起來吧
2024-03-03
SpringBoot?啟動流程追蹤方法分享
這篇文章主要介紹了SpringBoot?啟動流程追蹤方法分享的相關資料,需要的朋友可以參考下
2023-08-08
SpringCloud之監(jiān)控數(shù)據(jù)聚合Turbine的實現(xiàn)
這篇文章主要介紹了SpringCloud之監(jiān)控數(shù)據(jù)聚合Turbine的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2019-08-08
springboot整合security和vue的實踐
本文主要介紹了springboot整合security和vue的實踐，文中通過示例代碼介紹的非常詳細,具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-09-09
linux配置java環(huán)境變量詳細過程
這篇文章主要介紹了linux配置java環(huán)境變量詳細過程，需要的朋友可以參考下
2015-09-09
詳解ssh框架原理及流程
在本文中小編給大家整理的是關于ssh框架原理及流程的相關知識點內(nèi)容，有此需要的朋友們可以學習下。
2019-07-07
SpringBoot使用過濾器、攔截器和監(jiān)聽器的案例代碼(Springboot搭建java項目)
這篇文章主要介紹了SpringBoot使用過濾器、攔截器和監(jiān)聽器(Springboot搭建java項目),本文是基于Springboot搭建java項目，結合案例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2023-02-02
詳談Array和ArrayList的區(qū)別與聯(lián)系
下面小編就為大家?guī)硪黄斦凙rray和ArrayList的區(qū)別與聯(lián)系。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-06-06