微信小程序客服消息

清疚 2022-11-26 07:38 290阅读 0赞

### 验签 ###

在下面一步微信小程序后台开发设置的时候前提是此接口已经完成、否则微信小程序会验签失败！

package com.cong.controller;
    
    import java.security.MessageDigest;
    import java.util.Arrays;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("open/weixin")
    public class OpenWeiXinController { 
    	private String token="yourtoken";
    
    	@GetMapping("reply")
    	public String verify(HttpServletRequest request, HttpServletResponse response) { 
    		// 微信加密签名
    		String signature = request.getParameter("signature");
    		// 时间戳
    		String timestamp = request.getParameter("timestamp");
    		// 随机数
    		String nonce = request.getParameter("nonce");
    		// 随机字符串
    		String echostr = request.getParameter("echostr");
    		// 通过检验signature对请求进行校验，若校验成功则原样返回echostr，表示接入成功，否则接入失败
    		if (this.checkSignature(signature, timestamp, nonce)) { 
    			return echostr;
    		}
    		return null;
    	}
    
    	private boolean checkSignature(String signature, String timestamp, String nonce) { 
    		String[] arr = new String[] {  token, timestamp, nonce };
    		// 将token、timestamp、nonce三个参数进行字典序排序
    		Arrays.sort(arr);
    		StringBuilder content = new StringBuilder();
    		for (int i = 0; i < arr.length; i++) { 
    			content.append(arr[i]);
    		}
    		MessageDigest md = null;
    		String tmpStr = null;
    		try { 
    			md = MessageDigest.getInstance("SHA-1");
    			// 将三个参数字符串拼接成一个字符串进行sha1加密
    			byte[] digest = md.digest(content.toString().getBytes());
    			tmpStr = byteToStr(digest);
    		} catch (Exception e) { 
    			e.printStackTrace();
    		}
    		content = null;
    		// 将sha1加密后的字符串可与signature对比，标识该请求来源于微信
    		return tmpStr != null ? tmpStr.equals(signature.toUpperCase()) : false;
    	}
    
    	private static String byteToStr(byte[] byteArray) { 
    		String strDigest = "";
    		for (int i = 0; i < byteArray.length; i++) { 
    			strDigest += byteToHexStr(byteArray[i]);
    		}
    		return strDigest;
    	}
    
    	private static String byteToHexStr(byte mByte) { 
    		char[] Digit = {  '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
    		char[] tempArr = new char[2];
    		tempArr[0] = Digit[(mByte >>> 4) & 0X0F];
    		tempArr[1] = Digit[mByte & 0X0F];
    		String s = new String(tempArr);
    		return s;
    	}
    }

就是一个验签方法，微信那边要确保这是你自己的服务器。（过于简单就没有封装）

### 开发设置 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmdsZV9jb25n_size_16_color_FFFFFF_t_70]  
1、URL地址填写上面编写的url，注意要是GET方法且不要被你自己项目的安全框架拦截掉。  
2、Token令牌设置要和代码里面设置的一样  
3、加密秘钥可以自行设置，只要下面代码中配置的一样就行。  
4、建议采取明文+安全模式，便于调试，数据类型选择哪一种看你的开发语言。  
5、只支持域名访问，所以需要使用内网穿透工具，如果有服务器可以测更好，不过代码部署麻烦。

设置成功之后就可以编写消息加解密接口了。如果设置失败需要根据失败原因继续调试。

### 消息获取并解密 ###

##### 参数说明 #####

本文中数据传输采用加密模式。  
数据解密需要用到三个参数：

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>含义</th> 
   <th>获取</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>token</td> 
   <td>公众平台上，开发者设置的token</td> 
   <td>可随意变更、上一步自己设置的</td> 
  </tr> 
  <tr> 
   <td>AesKey</td> 
   <td>公众平台上，开发者设置的EncodingAESKey</td> 
   <td>可随意变更、上一步自己设置的</td> 
  </tr> 
  <tr> 
   <td>appId</td> 
   <td>公众平台appid</td> 
   <td>开发设置第一个就是</td> 
  </tr> 
 </tbody> 
</table>

[示例代码下载][Link 1] 点击下载在最后，真的有点小！！！！

##### 消息获取 #####

@PostMapping("reply")
    public void reply(@RequestBody Map<String, Object> msg) { 
    	String encrypt = msg.get("Encrypt").toString();
    	String data = decrypt(encrypt);
    	log.info("微信用户发送消息为:[{}]------消息解密:[{}]", msg, data);
    	if (StringUtils.isNotBlank(data)) { 
    		// 消息回复
    		weiXinMiniService.reply(data);
    	} else { 
    		log.info("客服信息解密失败,不作处理");
    	}
    }
    
    
    private String decrypt(String text) { 
    	String token = "token";
    
    	String appId = "appId";
    
    	String aesKey = "aesKey";
    
    	try { 
    		WXBizMsgCrypt wxBizMsgCrypt = new WXBizMsgCrypt(token, aesKey, appId);
    		return wxBizMsgCrypt.decrypt(text);
    	} catch (AesException e) { 
    		e.printStackTrace();
    	}
    	return null;
    }

##### 解密工具类WXBizMsgCrypt #####

微信文档中提供了当前工具类，下载即可，下面的工具类只保留了最基础的：

package com.cong.util;
    
    import java.nio.charset.Charset;
    import java.util.Arrays;
    import java.util.Random;
    
    import javax.crypto.Cipher;
    import javax.crypto.spec.IvParameterSpec;
    import javax.crypto.spec.SecretKeySpec;
    
    import org.apache.commons.codec.binary.Base64;
    
    public class WXBizMsgCrypt { 
    	static Charset CHARSET = Charset.forName("utf-8");
    	Base64 base64 = new Base64();
    	byte[] aesKey;
    	String token;
    	String appId;
    
    	/** * 构造函数 * * @param token * 公众平台上，开发者设置的token * @param encodingAesKey * 公众平台上，开发者设置的EncodingAESKey * @param appId * 公众平台appid * * @throws AesException * 执行失败，请查看该异常的错误码和具体的错误信息 */
    	public WXBizMsgCrypt(String token, String encodingAesKey, String appId) throws AesException { 
    		if (encodingAesKey.length() != 43) { 
    			throw new AesException(AesException.IllegalAesKey);
    		}
    
    		this.token = token;
    		this.appId = appId;
    		aesKey = Base64.decodeBase64(encodingAesKey + "=");
    	}
    
    	// 生成4个字节的网络字节序
    	byte[] getNetworkBytesOrder(int sourceNumber) { 
    		byte[] orderBytes = new byte[4];
    		orderBytes[3] = (byte) (sourceNumber & 0xFF);
    		orderBytes[2] = (byte) (sourceNumber >> 8 & 0xFF);
    		orderBytes[1] = (byte) (sourceNumber >> 16 & 0xFF);
    		orderBytes[0] = (byte) (sourceNumber >> 24 & 0xFF);
    		return orderBytes;
    	}
    
    	// 还原4个字节的网络字节序
    	int recoverNetworkBytesOrder(byte[] orderBytes) { 
    		int sourceNumber = 0;
    		for (int i = 0; i < 4; i++) { 
    			sourceNumber <<= 8;
    			sourceNumber |= orderBytes[i] & 0xff;
    		}
    		return sourceNumber;
    	}
    
    	// 随机生成16位字符串
    	String getRandomStr() { 
    		String base = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
    		Random random = new Random();
    		StringBuffer sb = new StringBuffer();
    		for (int i = 0; i < 16; i++) { 
    			int number = random.nextInt(base.length());
    			sb.append(base.charAt(number));
    		}
    		return sb.toString();
    	}
    
    	/** * 对密文进行解密. * * @param text * 需要解密的密文 * @return 解密得到的明文 * @throws AesException * aes解密失败 */
    	public String decrypt(String text) throws AesException { 
    		byte[] original;
    		try { 
    			// 设置解密模式为AES的CBC模式
    			Cipher cipher = Cipher.getInstance("AES/CBC/NoPadding");
    			SecretKeySpec key_spec = new SecretKeySpec(aesKey, "AES");
    			IvParameterSpec iv = new IvParameterSpec(Arrays.copyOfRange(aesKey, 0, 16));
    			cipher.init(Cipher.DECRYPT_MODE, key_spec, iv);
    
    			// 使用BASE64对密文进行解码
    			byte[] encrypted = Base64.decodeBase64(text);
    
    			// 解密
    			original = cipher.doFinal(encrypted);
    		} catch (Exception e) { 
    			e.printStackTrace();
    			throw new AesException(AesException.DecryptAESError);
    		}
    
    		String xmlContent, from_appid;
    		try { 
    			// 去除补位字符
    			byte[] bytes = PKCS7Encoder.decode(original);
    
    			// 分离16位随机字符串,网络字节序和AppId
    			byte[] networkOrder = Arrays.copyOfRange(bytes, 16, 20);
    
    			int xmlLength = recoverNetworkBytesOrder(networkOrder);
    
    			xmlContent = new String(Arrays.copyOfRange(bytes, 20, 20 + xmlLength), CHARSET);
    			from_appid = new String(Arrays.copyOfRange(bytes, 20 + xmlLength, bytes.length), CHARSET);
    		} catch (Exception e) { 
    			e.printStackTrace();
    			throw new AesException(AesException.IllegalBuffer);
    		}
    
    		// appid不相同的情况
    		if (!from_appid.equals(appId)) { 
    			throw new AesException(AesException.ValidateAppidError);
    		}
    		return xmlContent;
    	}
    }

上述消息解密成功进入下面的消息回复接口，解密失败请先看文章最后部分。

### 消息回复 ###

##### 获取access\_token #####

这个是服务端调用微信小程序的接口凭证，但是需要注意以下几点：

*  有效期：有效期为7200秒，所以服务端要定时刷新这个token
 *  有效性：token唯一且全局使用，意味着一旦上了生产环境，生产上获取了这个Token并且正在使用，如果你的开发测试预发布等环境也获取了Token极易造成生产环境Token不可用！！需要注意容错。

String url = String.format(WXConstant.GET_ACCESS_TOKEN_URL, "appId", "appSecret");
    String result = restTemplate.getForObject(url, String.class);
    JSONObject strj = (JSONObject) JSONObject.parseObject(result);
    String accessToken = strj.getString("access_token");
    redisTemplate.opsForValue().set("weixinToken", accessToken, 7000, TimeUnit.SECONDS);
    return accessToken;

这个很简单，就不说了，WXConstant在上一篇文章中。

##### 消息回复 #####

weiXinMiniService.reply(data)接口实现

@Override
    public void reply(String msg) { 
    	JSONObject strj = (JSONObject) JSONObject.parseObject(msg);
    	// 用户openID
    	String openID = strj.getString("FromUserName");
    	// 消息类型
    	String msgType = strj.getString("MsgType");
    	log.info("日志:---用户:[{}]在:[{}]时间发送类型[{}]消息:[{}]", openID, strj.getString("CreateTime"), msgType,
    			strj.getString("Content"));
    	if ("event".equals(msgType)) { 
    		// 用户点击进入客服时不发送消息
    		return;
    	}
    	Map<String, String> contentMap = new HashMap<String, String>();
    	contentMap.put("title", "标题");
    	contentMap.put("description", "描述");
    	contentMap.put("url", "连接");
    	contentMap.put("thumb_url", "展示图地址");
    	// getToken()方法为获取token信息，因为会存在token不存在的情况，所以封装了一下
    	sendMessage(openID, "link", contentMap, getToken());
    }
    
    private void sendMessage(String opendId, String msgtype, Map<String, String> contentMap, String token) { 
    	Map<String, Object> replyMessageMap = new HashMap<String, Object>();
    	replyMessageMap.put("touser", opendId);
    	replyMessageMap.put("msgtype", msgtype);
    	replyMessageMap.put(msgtype, contentMap);
    	String messageJson = JSONObject.toJSONString(replyMessageMap);
    	try { 
    		messageJson = new String(messageJson.getBytes(), "UTF-8");
    	} catch (UnsupportedEncodingException e) { 
    		log.info("数据编码异常,个别用户受影响");
    	}
    	String url = WXConstant.SEND_MSG + token;
    	// 解决文字进入前端乱码问题
    	restTemplate.getMessageConverters().set(0, new StringHttpMessageConverter(StandardCharsets.UTF_8));
    	restTemplate.postForObject(url, messageJson, String.class);
    }

示例为返回图文链接、当然返回文本、图片、小程序卡片都可以，具体请查看[官网][Link 2]。

此处有很大空间，获取到用户消息可以存储到自己的数据库，也可以根据用户输入的文字模糊匹配关键字返回不同类型的信息，自行扩展。

###### 问题解决 ######

java.security.InvalidKeyException:illegal Key Size

到官网下载jar包覆盖本地的即可，[8的下载地址][8]，其他版本网上搜一下就出来了。  
之后覆盖本地的jdk安装目录和jre安装目录下security文件夹下对应的两个jar包即可。

没有oracle账户或者下载慢的可以去我的资源中下载。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmdsZV9jb25n_size_16_color_FFFFFF_t_70]: /images/20221124/cb6773400dbb4bb2958389c17c8696fb.png
[Link 1]: https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Message_encryption_and_decryption_instructions.html
[Link 2]: https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/customer-message/customerServiceMessage.send.html
[8]: https://www.oracle.com/java/technologies/javase-jce8-downloads.html