微信企业号开发入门(回调模式)java

最近在开发微信企业号,刚接触时云里雾里的,在摸索过程中终于清晰了一点。

刚开始我以为订阅号、服务号、企业号的接口差不多,就一直用订阅号的教程来入门,后来才发现差的挺多的。

首先,微信企业号不像订阅号和服务号,就一个主页面。企业号的开发其实是对应用的开发。

先附上微信企业号开发官方文档:https://qydev.weixin.qq.com/wiki/index.php

一、企业微信管理页面配置

网址:https://work.weixin.qq.com/wework_admin/frame


1、在注册完企业号后,先创建一个应用

微信企业号开发入门(回调模式)java

2、在应用管理--自建的应用中配置可信域名

微信企业号开发入门(回调模式)java

需要注意的是,微信公众号的开发测试需要访问到外网的服务器,且端口只能为80。

这里推荐使用 natapp进行配置,具体使用看 :https://blog.csdn.net/qq_33922980/article/details/90244160  (自备域名的可以忽略)

启动后,填写可信域名

微信企业号开发入门(回调模式)java

3、配置接收消息的api(这里我已经配好了)

微信企业号开发入门(回调模式)java

Token和EncodingAESKey可以使用随机获取,url填写刚刚配置的可信域名,及准备调用的接口。

微信企业号开发入门(回调模式)java

此时点击保存,会提示服务器异常,请稍后再试。

这是由于点击保存时,微信会向我们添加的url发送一个get请求,需要我们返回值。

附上官方说明:

微信企业号开发入门(回调模式)java

附上url检验代码:

 @RequestMapping(method = RequestMethod.GET)
@ResponseBody
public String checkToken(@RequestParam(name = "msg_signature") String signature, String timestamp, String nonce, String echostr) throws AesException {
//token和encoding_aeskey就是上诉随机获取的值,corp_id是企业id,在企业微信管理页面点击: 我的企业,拉到最下方可以看到
WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(TOTKN, ENCODING_AESKEY, CORP_ID);
String sEchoStr = wxcpt.VerifyURL(signature, timestamp,nonce, echostr);
System.out.println("-----签名校验通过-----");
return sEchoStr;
}

其中,WXBizMsgCrypt是官方提供的加解密库,下载地址:https://qydev.weixin.qq.com/download/java.zip

为方便使用,我直接打成了jar包,有需要的自取。链接: https://pan.baidu.com/s/1Xtzd69T8jVL3w8Kg1jnreQ 提取码: jeeu

再点击保存,就通过了。

此时后台管理的配置完成。

二、实际功能开发

1、回调模式

该url的调用有两个,一个是上述的url检验时调用,第二个是回调模式调用。不同点是回调模式是发post请求,且携带的参数不一样。

这里说明一下,第二个回调模式是说,成员发送消息或触发事件时都会调用该接口,我们根据逻辑处理后再进行反馈。

接收的信息使用XML数据格式、UTF8编码,并以AES方式加密

微信企业号开发入门(回调模式)java

这里我们封装一个类,来接收回调数据。

 import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name="xml")
@XmlAccessorType(XmlAccessType.FIELD)
public class InMsgEntity {
/**
* 接收的应用id,可在应用的设置页面获取
*/
@XmlElement(name = "AgentID")
private String agentID;
/**
* 经过加密的密文
*/
@XmlElement(name = "Encrypt")
private String encrypt;
/**
* 发送方帐号
*/
@XmlElement(name="ToUserName")
private String toUserName; public String getAgentID() {
return agentID;
} public void setAgentID(String agentID) {
this.agentID = agentID;
} public String getEncrypt() {
return encrypt;
} public void setEncrypt(String encrypt) {
this.encrypt = encrypt;
} public String getToUserName() {
return toUserName;
} public void setToUserName(String toUserName) {
this.toUserName = toUserName;
}
}

再写两个工具类,来转换格式。

(1)因为要调用官方的加解密库,所以要封装成他需要格式的字符串。

 import com.newland.bean.InMsgEntity;
public class FormatUtils {
/**
* 接收请求格式封装
* @param msg
* @return
*/
public static String getReqData(InMsgEntity msg){
return "<xml><ToUserName><![CDATA["+msg.getToUserName()+"]]></ToUserName><Encrypt><![CDATA[" +msg.getEncrypt()+
"]]></Encrypt><AgentID><![CDATA["+msg.getAgentID()+"]]></AgentID></xml>";
} /**
* 发送文字消息格式封装
* @param content
* @return
*/
public static String getTextRespData(String content){
return "<xml><MsgType><![CDATA[text]]></MsgType><Content><![CDATA["+content+"]]></Content></xml>";
}
}

(2)为方便处理xml格式的数据,写一个标签处理的工具类

 import org.w3c.dom.Document;
import org.w3c.dom.Element;
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 java.io.IOException;
import java.io.StringReader;
public class ElementUtils {
private Element root = null;
/**
* 根据xml格式的字符串建document
* @param sMsg
* @throws ParserConfigurationException
* @throws IOException
* @throws SAXException
*/
public ElementUtils(String sMsg) throws ParserConfigurationException, IOException, SAXException {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder db = dbf.newDocumentBuilder();
StringReader sr = new StringReader(sMsg);
InputSource is = new InputSource(sr);
Document document = db.parse(is);
root = document.getDocumentElement();
} /**
* 根据tagName获取内容
* @param tagName
* @return
*/
public String get(String tagName){
return root.getElementsByTagName(tagName).item(0).getTextContent();
}
}

最后回调模式代码:(这里没写太多,可以根据自身需要写逻辑)

 @RequestMapping(method = RequestMethod.POST,produces = {"application/xml;charset=UTF-8"})
@ResponseBody
public Object handlerMessage(@RequestBody InMsgEntity msg, @RequestParam(name = "msg_signature") String signature,
String timestamp, String nonce) throws Exception {
WXBizMsgCrypt wxcpt = new WXBizMsgCrypt(TOTKN, ENCODING_AESKEY, CORP_ID);
String sReqData = FormatUtils.getReqData(msg);
String sMsg = wxcpt.DecryptMsg(signature, timestamp, nonce, sReqData);
ElementUtils element = new ElementUtils(sMsg);
String msgType = element.get("MsgType");
String content = "";
switch (msgType){
/**
* 事件类型处理
*/
case "event":content = "触发事件";break;
/**
* 文字消息处理:这里是将用户发送的消息原样返回
*/
case "text": content = element.get("Content");break;
default:break;
}
String sRespData = FormatUtils.getTextRespData(content);
String sEncryptMsg = wxcpt.EncryptMsg(sRespData, timestamp, nonce);
return sEncryptMsg;
}

很奇怪的是,在企业微信官方文档里,并没有给出Encrypt解密之后的格式,要在微信公众号官方文档里看:https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Receiving_standard_messages.html

或者你也可以通过在上诉代码获得sMsg之后,打断点或输出sMsg的值来查看格式。

这里附上几种常用类型的数据格式。其中ToUserName、FromUserName、CreateTime、MsgType是公共标签。

(1)文字消息类型格式:

微信企业号开发入门(回调模式)java

(2)图片消息格式

微信企业号开发入门(回调模式)java

(3)关注取关事件数据格式:

微信企业号开发入门(回调模式)java

到这里,可以试着向应用发送消息了,或者尝试重新关注,看看是否有回复消息。

因为我目前这个企业号功能不多,所以只写了文字格式的回复,有需要的话可以自行去官方文档那对应消息格式进行改动~

上一篇:JMeter命令模式下动态设置线程组和持续时间等动态传参


下一篇:CloudBeaver docker 镜像试用