Java實現企業(yè)微信回調配置的詳細步驟與測試

更新時間：2023年09月21日 09:07:27 作者：Xi-Yuan

這篇文章主要給大家介紹了關于Java實現企業(yè)微信回調配置的詳細步驟與測試,企業(yè)微信回調是指企業(yè)微信通過HTTP?POST請求將業(yè)務數據回調到指定的URL上,文中給出了詳細的代碼示例,需要的朋友可以參考下

一、配置回調服務

一、在企業(yè)微信管理后臺配置三個配置

分別是：URL, Token, EncodingAESKey。打開企業(yè)微信后臺-->管理工具-->通訊錄同步配置回調地址如下所示

1.1、URL為回調服務地址，由開發(fā)者搭建（直白點就是后臺回調域名地址，你給企業(yè)微信的URL，例如http://127.0.0.1:8085/qiyewx/getCallBack）服務器如果是云服務要配置域名

1.2、Token用于計算簽名，由英文或數字組成且長度不超過32位的自定義字符串。（可隨機獲取，但要復制到本地代碼，后面會用到）

1.3、EncodingAESKey用于消息內容加密，由英文或數字組成且長度為43位的自定義字符串。（可隨機獲取，但要復制到本地代碼，后面會用到）

二、在代碼中配置Token和EncodingAESKey

# 企業(yè)微信配置
qiyewx:
  url: 
  corpid: 
  corpsecret: 
  #回調配置
  token: XXXXXX
  encodingAESKey: XXXXXX

三、官方加解密庫下載

1、點擊如下鏈接自行下載，下載后結構如下圖所示：

有json版本和xml版本

json版本：

xml版本：

加解密庫下載與返回碼 - 接口文檔 - 企業(yè)微信開發(fā)者中心

2、將下載的示例代碼復制到你的項目代碼中

二、編碼實現

一、引入相關項目依賴

<!--企業(yè)微信相關-->
        <dependency>
            <groupId>commons-codec</groupId>
            <artifactId>commons-codec</artifactId>
        </dependency>
        <!-- 企業(yè)微信json格式包-->
        <dependency>
            <groupId>org.json</groupId>
            <artifactId>json</artifactId>
            <version>20200518</version>
        </dependency>
<!-- dom4j解析xml -->
        <dependency>
            <groupId>dom4j</groupId>
            <artifactId>dom4j</artifactId>
            <version>1.6.1</version>
        </dependency>

二、支持Http Get請求驗證URL有效性與支持Http Post請求接收業(yè)務數據

切記：將將下載的示例代碼復制到你的項目代碼中，下面的代碼中有使用。

1、coontroller

/**
     * 企業(yè)微信回調
     * 3.1 支持Http Get請求驗證URL有效性
     * 3.2 支持Http Post請求接收業(yè)務數據
     *
     * @return
     */
    @RequestMapping(value = "/getCallBack", method = {RequestMethod.GET, RequestMethod.POST})
    public Object CompanyWeChatChangeNotice(HttpServletRequest request, @RequestBody(required = false) String body) {
       Map<String, String[]> parameterMap = request.getParameterMap();
        String jsonString = JSONObject.toJSONString(parameterMap);
        log.info("企業(yè)微信回調參數：{},  解析參數：{}", jsonString, body);
        if (body == null) {
            Object result = qyWxService.verificationUrl(request);
            return result;
        }
        Map<String, String> resultMap = qyWxService.getRequestParameter(request, body);
        System.err.println(resultMap);
        return "success";
    }

2、驗證URL有效性

 /**
     * 驗證回調URL
     *
     * @param request
     * @return
     */
    public Object verificationUrl(HttpServletRequest request) {
        log.info("=========驗證URL有效性開始=========");
        String sEchoStr; //需要返回的明文
        try {
            WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(qyWxConfig.getToken(), qyWxConfig.getEncodingAESKey(), qyWxConfig.getCorpid());
            String msgSignature = request.getParameter("msg_signature");
            String timeStamp = request.getParameter("timestamp");
            String nonce = request.getParameter("nonce");
            String echostr = request.getParameter("echostr");
            log.info("企業(yè)微信加密簽名: {},時間戳: {},隨機數: {},加密的字符串: {}", msgSignature, timeStamp, nonce, echostr);
            sEchoStr = wxcpt.VerifyURL(msgSignature,
                    timeStamp,
                    nonce,
                    echostr);
            log.info("給企業(yè)微信返回的明文,{}", sEchoStr);
            log.info("=========驗證URL有效性結束=========");
            return sEchoStr;
        } catch (AesException e) {
            log.error("驗證URL失敗，錯誤原因請查看異常:{}", e.getCode());
            throw new AesException(e.getCode());
        }
    }

3、回調參數解析

 /**
     * 企業(yè)微信回調參數解析
     *
     * @param request
     * @param body
     * @return
     */
    public Map<String, String> getRequestParameter(HttpServletRequest request, String body) {
        log.info("=========參數解析開始=========");
        try {
            WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(qyWxConfig.getToken(), qyWxConfig.getEncodingAESKey(), qyWxConfig.getCorpid());
            String msgSignature = request.getParameter("msg_signature");
            String timeStamp = request.getParameter("timestamp");
            String nonce = request.getParameter("nonce");
            log.info("企業(yè)微信加密簽名: {},時間戳: {},隨機數: {}", msgSignature, timeStamp, nonce);
            String sMsg = wxcpt.DecryptMsg(msgSignature, timeStamp, nonce, body);
            Map<String, String> resultMap = new HashMap<String, String>(16);
            resultMap = ConstantUtil.parseXmlToMap(sMsg, resultMap);
            log.info("decrypt密文轉為map結果為{}", resultMap);
            log.info("=========參數解析結束=========");
            return resultMap;
        } catch (AesException e) {
            log.error("密文參數解析失敗，錯誤原因請查看異常:{}", e.getMessage());
            throw new AesException(e.getCode());
        }
    }

4、XML轉map工具

package com.ruoyi.system.qiwechat.utils;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.StringReader;
import java.util.Iterator;
import java.util.Map;
/**
 * @author XiYuan
 * @date 2023/2/20
 * @Description: XML轉換Map
 */
public class ConstantUtil {
    /**
     * 將xml轉換為Map。 支持xml標簽多層嵌套，并以"."分隔多級標簽（不包括根節(jié)點）。 不支持XML標簽重復時的情況
     *
     * @param xml
     * @param map
     * @return
     */
    public static Map<String, String> parseXmlToMap(String xml, Map<String, String> map) {
        try {
            SAXReader reader = new SAXReader();
            Document doc = reader.read(new StringReader(xml));
            Element root = doc.getRootElement();
            String path = "";
            if (map.containsKey(root.getName().trim())) {
                path = map.get(root.getName().trim());
                map.remove(root.getName().trim());
            }
            for (Iterator i = root.elementIterator(); i.hasNext();) {
                Element element = (Element) i.next();
                if (element.isTextOnly()) {
                    if (path.length() > 0) {
                        map.put(path + element.getName().trim(), element.getTextTrim());
                    } else {
                        map.put(element.getName().trim(), element.getTextTrim());
                    }
                } else {
                    map.put(element.getName().trim(), path+ element.getName().trim() + ".");
                    parseXmlToMap(element.asXML(), map);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return map;
    }
}

5、配置文件config

package com.ruoyi.common.config;
import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
@Data
@Configuration
public class QyWxConfig {
    /**
     *  請求路徑
     */
    @Value("${qiyewx.url}")
    private String url;
    /**
     * 企業(yè)微信ID
     */
    @Value("${qiyewx.corpid}")
    private String corpid;
    /**
     * 企業(yè)應用的憑證密鑰
     */
    @Value("${qiyewx.corpsecret}")
    private String corpsecret;
    /**
     * 開發(fā)者設置的token
     */
    @Value("${qiyewx.token}")
    private String token;
    /**
     * 開發(fā)者設置的EncodingAESKey
     */
    @Value("${qiyewx.encodingAESKey}")
    private String encodingAESKey;
}