SpringBoot調用.asmx後綴的webservice接口

一、簡介

最近在項目中，在與其他公司做對接中需要回調一個對方的接口，根據對方提供的接口地址，

發現是webservice的接口，而且接口後綴名爲.asmx，因爲現在webservice接口基本上都是wsdl這種形式，所以使用wsdl調用方式不能用，得使用其他方法。

WebService是一個SOA（面向服務的編程）的架構，它是不依賴於語言，不依賴於平臺，可以實現不同的語言間的相互調用，通過Internet進行基於Http協議的網絡應用間的交互。其實WebService並不是什麼神祕的東西，它就是一個可以遠程調用的類，或者說是組件，把你本地的功能開放出去供別人調用。

二、示例

下面通過一個示例說明如何在SpringBoot中調用.asmx後綴的webservice接口。

【a】加入pom.xml的依賴

<!--WebService接口依賴-->
        <dependency>
            <groupId>org.apache.axis</groupId>
            <artifactId>axis</artifactId>
            <version>1.4</version>
        </dependency>

        <dependency>
            <groupId>org.apache.axis</groupId>
            <artifactId>axis-jaxrpc</artifactId>
            <version>1.4</version>
        </dependency>

        <dependency>
            <groupId>org.apache.axis</groupId>
            <artifactId>axis-saaj</artifactId>
            <version>1.4</version>
        </dependency>

        <dependency>
            <groupId>commons-discovery</groupId>
            <artifactId>commons-discovery</artifactId>
            <version>0.2</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

【b】定義WebService客戶端參數字段類

package com.ly.cloud.common.webservice;

/**
 * @Description: WebService客戶端參數字段類
 * @author: weishihuai
 * @Date: 2020/6/20 14:40
 */
public class ClientField {
    /**
     * 參數名稱
     */
    private String paramName;
    /**
     * 參數類型
     */
    private Class<?> paramType;
    /**
     * 參數值
     */
    private Object paramValue;

    public ClientField() {
        super();
    }

    public ClientField(String paramName, Class<?> paramType, Object paramValue) {
        super();
        this.paramName = paramName;
        this.paramType = paramType;
        this.paramValue = paramValue;
    }

    public String getParamName() {
        return paramName;
    }

    public void setParamName(String paramName) {
        this.paramName = paramName;
    }

    public Class<?> getParamType() {
        return paramType;
    }

    public void setParamType(Class<?> paramType) {
        this.paramType = paramType;
    }

    public Object getParamValue() {
        return paramValue;
    }

    public void setParamVaule(Object paramValue) {
        this.paramValue = paramValue;
    }
}

【c】定義WebService客戶端實體類

package com.ly.cloud.common.webservice;

import java.util.List;

/**
 * @Description: WebService客戶端實體類
 * @author: weishihuai
 * @Date: 2020/6/20 14:39
 */
public class ClientBean {
    /**
     * WebService接口請求地址
     */
    private String endpointUrl;
    /**
     * WebService接口請求的命名空間
     */
    private String targetNamespace;
    /**
     * WebService接口請求actionUrl
     */
    private String actionUrl;
    /**
     * WebService接口請求方法名稱
     */
    private String methodName;
    /**
     * WebService請求參數集合
     */
    private List<ClientField> clientFields;

    public ClientBean() {
        super();
    }

    public ClientBean(String endpointUrl, String targetNamespace,
                      String actionUrl, String methodName, List<ClientField> clientFields) {
        super();
        this.endpointUrl = endpointUrl;
        this.targetNamespace = targetNamespace;
        this.actionUrl = actionUrl;
        this.methodName = methodName;
        this.clientFields = clientFields;
    }

    public String getEndpointUrl() {
        return endpointUrl;
    }

    public void setEndpointUrl(String endpointUrl) {
        this.endpointUrl = endpointUrl;
    }

    public String getTargetNamespace() {
        return targetNamespace;
    }

    public void setTargetNamespace(String targetNamespace) {
        this.targetNamespace = targetNamespace;
    }

    public String getActionUrl() {
        return actionUrl;
    }

    public void setActionUrl(String actionUrl) {
        this.actionUrl = actionUrl;
    }

    public String getMethodName() {
        return methodName;
    }

    public void setMethodName(String methodName) {
        this.methodName = methodName;
    }

    public List<ClientField> getClientFields() {
        return clientFields;
    }

    public void setClientFields(List<ClientField> clientFields) {
        this.clientFields = clientFields;
    }
}

【d】創建NHWebServiceUtils.java工具類

package com.ly.cloud.common.webservice;

import org.apache.axis.client.Call;
import org.apache.axis.client.Service;

import javax.xml.namespace.QName;
import javax.xml.rpc.ParameterMode;
import javax.xml.rpc.encoding.XMLType;

/**
 * @description: WebService接口統一調用工具類
 * @author: weishihuai
 * @mail: [email protected]
 * @Date: 2020/6/20 14:39
 * @version: 1.0
 */
public class NHWebServiceUtils {

    /**
     * WebService請求發送方法
     *
     * @param clientBean 客戶端請求發送實體類(包含一些請求參數、webservice接口地址等)
     * @return 通常返回XML格式的文本
     * <p>
     * 使用示例:
     * List<ClientField> clientFields = new ArrayList<>();
     * // 設置請求參數
     * ClientField field = new ClientField("strCardno", String.class, xh);
     * clientFields.add(field);
     * <p>
     * ClientBean clientBean = new ClientBean(
     * "http://202.192.41.136:8090/Service.asmx",
     * "ilasIII OpenAPI", "ilasIII OpenAPI/GetRdrFin",
     * "GetRdrFin", clientFields);
     * //返回XML
     * String returnXml = NHWebServiceUtils.sendWebServiceRequest(clientBean);
     */
    public static String sendWebServiceRequest(ClientBean clientBean) {
        try {
            Object[] paramValues;
            //實例化訪問對象
            Service service = new Service();
            //實例化調用對象
            Call call = (Call) service.createCall();
            //在調用對象中添加WebService地址
            call.setTargetEndpointAddress(new java.net.URL(clientBean.getEndpointUrl()));
            paramValues = new Object[clientBean.getClientFields().size()];
            int i = 0;
            //設置入參，第一個參數是命名空間以及參數名，這兩個參數是採用一個Qname變量打包傳入的，第二個參數是入參的類型（字符或者數字）第三個參數是入參種類
            for (ClientField field : clientBean.getClientFields()) {
                QName qn = new QName(clientBean.getTargetNamespace(), field.getParamName());
                if (field.getParamType() == String.class) {
                    call.addParameter(qn, XMLType.XSD_STRING, ParameterMode.IN);
                } else if (field.getParamType() == int.class) {
                    call.addParameter(qn, XMLType.XSD_INT, ParameterMode.IN);
                } else if (field.getParamType() == Integer.class) {
                    call.addParameter(qn, XMLType.XSD_INTEGER, ParameterMode.IN);
                } else if (field.getParamType() == Double.class) {
                    call.addParameter(qn, XMLType.XSD_DOUBLE, ParameterMode.IN);
                } else if (field.getParamType() == Float.class) {
                    call.addParameter(qn, XMLType.XSD_FLOAT, ParameterMode.IN);
                } else if (field.getParamType() == Long.class) {
                    call.addParameter(qn, XMLType.XSD_LONG, ParameterMode.IN);
                } else {
                    throw new Exception("請確定傳入參數類型是否正確，或者該參數類型還沒有被註冊。");
                }
                //獲取參數值
                paramValues[i] = field.getParamValue();
                i++;
            }
            //設置返回值格式（字符串或者組裝對象）
            call.setReturnType(XMLType.XSD_STRING);
            //是否是SOAPAction這裏需要看WebService是否要求如下格式，如果沒有要求可以不添加此設置
            call.setUseSOAPAction(true);
            //如果前面要求是SOAPAction的話需要添加下面設置，指定訪問那個命名空間上的那個方法
            call.setSOAPActionURI(clientBean.getActionUrl());
            //在調用對象中添加WebService對應的命名空間，以及將要調用的函數名
            call.setOperationName(new QName(clientBean.getTargetNamespace(), clientBean.getMethodName()));
            String ret;
            //調用目標方法,設置參數值將返回值轉換爲String類型
            ret = (String) call.invoke(paramValues);
            return ret;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

}

【e】調用示例

package com.ly.cloud.ws2;

import com.ly.cloud.common.webservice.ClientBean;
import com.ly.cloud.common.webservice.ClientField;
import com.ly.cloud.common.webservice.NHWebServiceUtils;
import com.ly.cloud.vo.interfacemng.InterfaceVO;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.dom4j.Node;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.reflect.Method;
import java.util.*;

/**
 * @description: 圖書館還書WebService接口
 * @author: weishihuai
 * @date: 2020-06-19 19:59:44
 * @version: 1.0
 */
public class LibraryReturnBooksServiceImpl {

    private static final Logger logger = LoggerFactory.getLogger(LibraryReturnBooksServiceImpl.class);

    /**
     * 根據學號遠程調用WebService接口查詢學生圖書館還書情況
     *
     * @param xh     學號
     * @param params 參數
     * @return
     */
    @SuppressWarnings("unchecked")
    public static InterfaceVO getLxzt(String xh, Map<String, Object> params) {
        InterfaceVO resultMsg = new InterfaceVO();
        try {
            List<ClientField> clientFields = new ArrayList<>();
            // 設置參數
            ClientField field = new ClientField("strCardno", String.class, xh);
            clientFields.add(field);
            //圖書館還書
            ClientBean clientBean = new ClientBean(
                    "http://202.192.41.136:8090/Service.asmx",
                    "ilasIII OpenAPI", "ilasIII OpenAPI/RdrLoanSrch",
                    "RdrLoanSrch", clientFields);

            String returnXml = NHWebServiceUtils.sendWebServiceRequest(clientBean);
            logger.error("【圖書館還書】【" + xh + "】WebService接口返回XML: {}", returnXml);
            StringBuilder ddString = new StringBuilder("");
            if (StringUtils.isNotBlank(returnXml)) {
                resultMsg.success();
                //解析返回的XML數據
                Map<String, String> fieldXmlPaths = new HashMap<>();
                fieldXmlPaths.put("Title", "//RdrLoanInfo/Title");
                fieldXmlPaths.put("Callno", "//RdrLoanInfo/Callno");
                fieldXmlPaths.put("Barcode", "//RdrLoanInfo/Barcode");
                fieldXmlPaths.put("Local", "//RdrLoanInfo/Local");
                fieldXmlPaths.put("Author", "//RdrLoanInfo/Author");
                fieldXmlPaths.put("Loandate", "//RdrLoanInfo/Loandate");
                fieldXmlPaths.put("Returndate", "//RdrLoanInfo/Returndate");
                List<JSXX> studentBooksList = (List<JSXX>) parserXmlToEntity(returnXml, JSXX.class, fieldXmlPaths);
                logger.error("【圖書館還書】【" + xh + "】解析XML爲studentBooksList: {}", studentBooksList);
                if (CollectionUtils.isNotEmpty(studentBooksList)) {
                    String bookTitle;
                    for (JSXX jsxx : studentBooksList) {
                        bookTitle = jsxx.getTitle();
                        if (!ddString.toString().contains(bookTitle)) {
                            ddString.append("《").append(bookTitle).append("》");
                        }
                    }
                    resultMsg.setMessage("未還書籍：" + ddString + "");
                    resultMsg.setBlzt("0");
                    logger.info("學生(" + xh + ")}的任務{圖書館還書}未完成!所借書籍{" + studentBooksList.get(0).getTitle() + "}");
                } else {
                    resultMsg.setBlzt("1");
                    resultMsg.setMessage("沒有找到學號爲{" + xh + "}的借還書記錄!系統默認通過！");
                    logger.error("沒有找到學號爲{" + xh + "}的借還書記錄!系統默認通過！");
                }
            } else {
                resultMsg.setBlzt("1");
                resultMsg.setMessage("沒有找到學號爲{" + xh + "}的借還書記錄!系統默認通過！");
                logger.error("沒有找到學號爲{" + xh + "}的借還書記錄!系統默認通過！");
            }
            resultMsg.setBlts(StringUtils.isNotBlank(ddString.toString()) ? "未還書籍：" + ddString + "" : "請求成功");
        } catch (Exception e) {
            resultMsg.failed();
            resultMsg.setBlts("請求出錯，請與管理員聯繫! ");
            resultMsg.setMessage(e.getMessage());
            e.printStackTrace();
        }
        return resultMsg;
    }

    /**
     * 解析XML文本映射到實體類
     *
     * @param returnXml     XML文本
     * @param cls           解析生成後映射的Class類對象
     * @param fieldXmlPaths XMLPaths集合(XML中的標籤路徑) 如:
     * @return
     * @throws DocumentException
     */
    public static List<?> parserXmlToEntity(String returnXml, Class cls, Map<String, String> fieldXmlPaths) throws DocumentException {
        Document document;
        document = DocumentHelper.parseText(returnXml);
        try {
            //單獨用來存屬性
            List<String> filedNames = new ArrayList<>();
            //存放<屬性,values>
            Map<String, List<Node>> map = new HashMap<>();
            if (fieldXmlPaths != null && fieldXmlPaths.size() > 0) {
                Iterator it = fieldXmlPaths.entrySet().iterator();
                while (it.hasNext()) {
                    Map.Entry entry = (Map.Entry) it.next();
                    Object key = entry.getKey();
                    Object value = entry.getValue();
                    List<Node> nodes = document.selectNodes(value.toString());
                    List<Node> list = new ArrayList<>();
                    for (Node node : nodes) {
                        list.add(node);
                    }
                    //循環放入屬性-> 對應的節點
                    map.put(key.toString(), list);
                    filedNames.add(key.toString());
                }
            }

            List list = new ArrayList();
            //循環將節點的值放入到對象中，然後放入到list
            for (int i = 0; i < map.get(filedNames.get(0)).size(); i++) {
                Object instance = cls.newInstance();
                for (String fieldName : filedNames) {
                    String methodName = "set" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
                    Method method = cls.getMethod(methodName, String.class);
                    method.invoke(instance, map.get(fieldName).get(i).getText());
                }
                list.add(instance);
            }
            return list;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    public static void main(String[] args) {

        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100; i++) {
            InterfaceVO interfaceVO = getLxzt("1607300009", null);
            System.out.println(interfaceVO);
        }
        long endTime = System.currentTimeMillis();
        System.out.println(endTime - startTime);
    }

}

/**
 * 借書信息類
 */
class JSXX {
    private String Title;
    private String Callno;
    private String Barcode;
    private String Local;
    private String Author;
    private String Loandate;
    private String Returndate;

    public String getTitle() {
        return Title;
    }

    public void setTitle(String title) {
        Title = title;
    }

    public String getCallno() {
        return Callno;
    }

    public void setCallno(String callno) {
        Callno = callno;
    }

    public String getBarcode() {
        return Barcode;
    }

    public void setBarcode(String barcode) {
        Barcode = barcode;
    }

    public String getLocal() {
        return Local;
    }

    public void setLocal(String local) {
        Local = local;
    }

    public String getAuthor() {
        return Author;
    }

    public void setAuthor(String author) {
        Author = author;
    }

    public String getLoandate() {
        return Loandate;
    }

    public void setLoandate(String loandate) {
        Loandate = loandate;
    }

    public String getReturndate() {
        return Returndate;
    }

    public void setReturndate(String returndate) {
        Returndate = returndate;
    }

    @Override
    public String toString() {
        return "JSXX{" +
                "Title='" + Title + '\'' +
                ", Callno='" + Callno + '\'' +
                ", Barcode='" + Barcode + '\'' +
                ", Local='" + Local + '\'' +
                ", Author='" + Author + '\'' +
                ", Loandate='" + Loandate + '\'' +
                ", Returndate='" + Returndate + '\'' +
                '}';
    }
}

【f】啓動main方法進行測試

 public static void main(String[] args) {

        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100; i++) {
            InterfaceVO interfaceVO = getLxzt("1607300009", null);
            System.out.println(interfaceVO);
        }
        long endTime = System.currentTimeMillis();
        System.out.println(endTime - startTime);
    }

運行結果：

可見，調用webservice遠程接口成功。

小總結：

添加axis相關的依賴包；
定義WebService客戶端參數字段類；
定義WebService客戶端實體類；
定義WebService接口統一調用工具類；
調用接口；

SpringBoot調用.asmx後綴的webservice接口

一、簡介

二、示例

Oracle如何選擇合適的列作爲索引？

手機端或PC端利用高德地圖和騰訊地圖獲取用戶當前位置信息

SpringBoot調用.asmx後綴的webservice接口

XML解析成實體類統一工具類

Oracle表連接方式總結

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結