Idea調(diào)用WebService的關(guān)鍵步驟和注意事項

更新時間：2025年01月17日 08:35:36 作者：A.不愿起名字的人

這篇文章主要介紹了如何在Idea中調(diào)用WebService,包括理解WebService的基本概念、獲取WSDL文件、閱讀和理解WSDL文件、選擇對接測試工具或方式、發(fā)送請求和接收響應、處理響應結(jié)果以及錯誤處理,需要的朋友可以參考下

前言

? WebService是一種基于網(wǎng)絡(luò)的技術(shù)，它允許不同的應用程序在互聯(lián)網(wǎng)上相互通信。要進行WebService對接，以下是一些關(guān)鍵步驟和注意事項：

一、理解WebService的基本概念

定義：WebService是一種基于標準化協(xié)議和格式的應用程序接口（API），它使用XML和HTTP來進行通信。
特點：可以跨平臺、跨語言進行數(shù)據(jù)傳輸和應用程序集成。

二、獲取WSDL文件

WSDL定義：WSDL是Web服務描述語言（Web Services Description Language）的縮寫，是一種基于XML的語言，用于描述Web服務的接口、方法和數(shù)據(jù)類型。
獲取方式：通常，可以通過訪問WebService的WSDL地址來獲取WSDL文件。WSDL地址通常以“.wsdl”結(jié)尾，例如：http://localhost:8082/web/services/weather?wsdl。
Idea的操作過程，
首先建立一個webService文件夾在項目中

選擇此文件夾，點擊Tools中的XML webService,選擇Generate

輸入地址點擊確定就行

會生成多個類和方法名就直接可以調(diào)用

三、閱讀和理解WSDL文件

服務定義：WSDL文件包含一個或多個服務定義，每個服務定義描述了一個或多個相關(guān)的操作，以及它們接受和返回的消息的格式。
命名空間：WSDL中的命名空間用于唯一標識WSDL中包含的類型、元素和消息。
操作和方法：WSDL文件還描述了Web服務的地址、協(xié)議和傳輸機制等信息，以及具體的操作和方法。

四、選擇對接測試工具或方式

SOAP UI：一個流行的WebService測試工具，可以用于查看WebService的接口信息、發(fā)送請求和接收響應。
Postman：另一個常用的API測試工具，同樣可以用于WebService的對接測試。
編程方式：在代碼中，可以通過發(fā)送HTTP請求來調(diào)用WebService，請求參數(shù)需要按照WSDL文件中定義的格式封裝成XML格式。

五、發(fā)送請求和接收響應

請求格式：根據(jù)WSDL文件中的定義，構(gòu)造符合要求的SOAP請求報文。請求報文通常包含Envelope（信封）、Header（頭部）和Body（正文）等部分。
發(fā)送請求：使用選擇的對接工具或方式發(fā)送請求到WebService的服務端點。
接收響應：服務端點接收到請求后，會進行解析并調(diào)用相應的Web服務方法，然后將結(jié)果封裝成HTTP響應返回。響應報文同樣遵循SOAP協(xié)議，并包含Envelope、Header和Body等部分。

六、直接通過xml和http請求訪問

? 1. 引用包

        <!--
             使用apache的httpclient發(fā)送http,需要引入httpclient依賴;
             使用OMElement需要引入axis2-transport-http依賴;改以來本身帶有httpclient依賴,所以
                 我們不在需要單獨引入httpclient依賴了
         -->
        <dependency>
            <groupId>org.apache.axis2</groupId>
            <artifactId>axis2-transport-http</artifactId>
            <version>1.7.8</version>
        </dependency>

? 2.

package com.smart.util;

import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMXMLBuilderFactory;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.HttpHeaders;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.client.RestTemplate;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.stream.XMLStreamException;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.nio.charset.StandardCharsets;
import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest
public class AbcAxis2DemoApplicationUtils {
	public static String doPost(String partNo) throws  IOException {
		// webservice的wsdl地址
		final String wsdlURL = ""
		// 設(shè)置編碼。(因為是直接傳的xml,所以我們設(shè)置為text/xml;charset=utf8)
		final String contentType = "text/xml;charset=utf8";
		/// 拼接要傳遞的xml數(shù)據(jù)(注意:此xml數(shù)據(jù)的模板我們根據(jù)wsdlURL從SoapUI中獲得,只需要修改對應的變量值即可)
		StringBuffer xMLcontent = new StringBuffer("");
		xMLcontent.append("<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\"urn:DefaultNamespace\">\n");
		xMLcontent.append("   <soapenv:Header/>\n");
		xMLcontent.append("   <soapenv:Body>\n");
		xMLcontent.append("     <urn:字段1>Shanghai</urn:字段1>\n");
		xMLcontent.append("     <urn:字段2>" + "TAN2921" + "</urn:字段2>\n");
		xMLcontent.append("   </soapenv:Body>\n");
		xMLcontent.append("</soapenv:Envelope>");

		// 調(diào)用工具類方法發(fā)送http請求
		String responseXML = HttpSendUtil.doHttpPostByHttpClient(wsdlURL, contentType, xMLcontent.toString());
		// 當然我們也可以調(diào)用這個工具類方法發(fā)送http請求
		// String responseXML = HttpSendUtil.doHttpPostByRestTemplate(wsdlURL, contentType, xMLcontent.toString());

		// 利用axis2的OMElement,將xml數(shù)據(jù)轉(zhuǎn)換為OMElement
		OMElement omElement = OMXMLBuilderFactory
				.createOMBuilder(new ByteArrayInputStream(responseXML.getBytes()), "utf-8").getDocumentElement();
		try {
			DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
			factory.setNamespaceAware(true); // 設(shè)置為true以處理命名空間
			DocumentBuilder builder = factory.newDocumentBuilder();
			InputSource inputSource = new InputSource(new StringReader(responseXML));
			Document document = builder.parse(inputSource);

			// 獲取所有名為"OUTPUT_SHIPTOPARTYReturn"的元素，并考慮命名空間
			NodeList nodeList = document.getElementsByTagNameNS("urn:DefaultNamespace", "OUTPUT_SHIPTOPARTYReturn");

			for (int i = 0; i < nodeList.getLength(); i++) {
				Element element = (Element) nodeList.item(i);
				// 檢查元素是否有文本內(nèi)容（即非空且非自閉合標簽）
				if (element.hasChildNodes() && element.getFirstChild().getNodeType() == Node.TEXT_NODE) {
					String textContent = element.getTextContent();
					System.out.println("Extracted value: " + textContent);
					return textContent;
				}
			}

		} catch (ParserConfigurationException | SAXException | IOException e) {
			e.printStackTrace();
		}

		return null;
	}

	public static String getNodeValue(Document document, String nodePaht) {
		XPathFactory xpfactory = XPathFactory.newInstance();
		XPath path = xpfactory.newXPath();
		String servInitrBrch = "";
		try {
			servInitrBrch = path.evaluate(nodePaht, document);
		} catch (XPathExpressionException e) {
			e.printStackTrace();
		}
		return servInitrBrch;
	}



	public static Document StringTOXml(String str) {

		StringBuilder sXML = new StringBuilder();
		sXML.append(str);
		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
		Document doc = null;
		try {
			InputStream is = new ByteArrayInputStream(sXML.toString().getBytes("utf-8"));
			doc = dbf.newDocumentBuilder().parse(is);
			is.close();
		} catch (Exception e) {
			e.printStackTrace();
		}
		return doc;
	}
}
/**
 * HTTP工具類
 *
 * @author JustryDeng
 * @DATE 2018年9月22日 下午10:29:08
 */
class HttpSendUtil {

	/**
	 * 使用apache的HttpClient發(fā)送http
	 *
	 * @param wsdlURL
	 *            請求URL
	 * @param contentType
	 *            如:application/json;charset=utf8
	 * @param content
	 *            數(shù)據(jù)內(nèi)容
	 * @DATE 2018年9月22日 下午10:29:17
	 */
	static String doHttpPostByHttpClient(final String wsdlURL, final String contentType, final String content)
			throws ClientProtocolException, IOException {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 創(chuàng)建Post請求
		HttpPost httpPost = new HttpPost(wsdlURL);
		StringEntity entity = new StringEntity(content.toString(), "UTF-8");
		// 將數(shù)據(jù)放入entity中
		httpPost.setEntity(entity);
		httpPost.setHeader("Content-Type", contentType);
		// 響應模型
		CloseableHttpResponse response = null;
		String result = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Post請求
			response = httpClient.execute(httpPost);
			// 從響應模型中獲取響應實體
			// 注意:和doHttpPostByRestTemplate方法用的不是同一個HttpEntity
			org.apache.http.HttpEntity responseEntity = response.getEntity();
			System.out.println("響應ContentType為:" + responseEntity.getContentType());
			System.out.println("響應狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				result = EntityUtils.toString(responseEntity);
				System.out.println("響應內(nèi)容為:" + result);
			}
		} finally {
			// 釋放資源
			if (httpClient != null) {
				httpClient.close();
			}
			if (response != null) {
				response.close();
			}
		}
		return result;
	}

	/**
	 * 使用springframework的RestTemplate發(fā)送http
	 *
	 * @param wsdlURL
	 *            請求URL
	 * @param contentType
	 *            如:application/json;charset=utf8
	 * @param content
	 *            數(shù)據(jù)內(nèi)容
	 * @DATE 2018年9月22日 下午10:30:48
	 */
	static String doHttpPostByRestTemplate(final String wsdlURL, final String contentType, final String content) {
		// http使用無參構(gòu)造;https需要使用有參構(gòu)造
		RestTemplate restTemplate = new RestTemplate();
		// 解決中文亂碼
		List<HttpMessageConverter<?>> converterList = restTemplate.getMessageConverters();
		converterList.remove(1);
		HttpMessageConverter<?> converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
		converterList.add(1, converter);
		restTemplate.setMessageConverters(converterList);
		// 設(shè)置Content-Type
		HttpHeaders headers = new HttpHeaders();
		headers.remove("Content-Type");
		headers.add("Content-Type", contentType);
		// 數(shù)據(jù)信息封裝
		// 注意:和doHttpPostByHttpClient方法用的不是同一個HttpEntity
		org.springframework.http.HttpEntity<String> formEntity = new org.springframework.http.HttpEntity<String>(
				content, headers);
		String result = restTemplate.postForObject(wsdlURL, formEntity, String.class);
		return result;
	}
}