钉钉开放平台开发-事件订阅实战java版

使用场景

在你的业务对数据的实时性要求较高时。例如：在新员工入职或者离职时，应用需要第一时间变更用户数据时，钉钉会向应用推送订阅的事件。通过订阅这些事件，可以更好地与钉钉集成。你只需告诉钉钉当某个事件发生时，钉钉需要推送消息到哪个URL，钉钉会以HTTP POST请求的方式将事件内容以JSON格式推送给你。

官方文档地址

我这边根据我的实际情况，概括下这个教程，如下

一、创建后台接口

我这里的平台使用的是springboot。

创建一个controller，copy上述官方文档中给出的示例代码，如：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.jeecg.modules.dingtalk.util.DingCallbackCrypto;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.jeecg.modules.dingtalk.config.AppConfig;
import java.util.Map;
@RestController
@RequestMapping("/dingtalkevent")
@Slf4j
public class EventSubController {
    @Autowired
    private AppConfig appConfig;
    @PostMapping(value = "/getCallBack")
    public Map<String, String> callBack(@RequestParam(value = "msg_signature", required = false) String msg_signature,
                                        @RequestParam(value = "timestamp", required = false) String timeStamp,
                                        @RequestParam(value = "nonce", required = false) String nonce,
                                        @RequestBody(required = false) JSONObject json) {
        try {
            // 1. 从http请求中获取加解密参数
            // 2. 使用加解密类型
            // Constant.OWNER_KEY 说明：
            // 1、开发者后台配置的订阅事件为应用级事件推送，此时OWNER_KEY为应用的APP_KEY。
            // 2、调用订阅事件接口订阅的事件为企业级事件推送，
            //      此时OWNER_KEY为：企业的appkey（企业内部应用）或SUITE_KEY（三方应用）
            DingCallbackCrypto callbackCrypto = new DingCallbackCrypto(appConfig.getAesToken(), appConfig.getAesKey(), appConfig.getAppKey());
            String encryptMsg = json.getString("encrypt");
            String decryptMsg = callbackCrypto.getDecryptMsg(msg_signature, timeStamp, nonce, encryptMsg);
            // 3. 反序列化回调事件json数据
            JSONObject eventJson = JSON.parseObject(decryptMsg);
            String eventType = eventJson.getString("EventType");
            // 4. 根据EventType分类处理
            if ("check_url".equals(eventType)) {
                // 测试回调url的正确性
                log.info("测试回调url的正确性");
            } else if ("user_add_org".equals(eventType)) {
                // 处理通讯录用户增加事件
                log.info("发生了：" + eventType + "事件");
            } else {
                // 添加其他已注册的
                log.info("发生了：" + eventType + "事件");
            }
            // 5. 返回success的加密数据
            Map<String, String> successMap = callbackCrypto.getEncryptedMap("success");
            return successMap;
        } catch (DingCallbackCrypto.DingTalkEncryptException e) {
            e.printStackTrace();
        }
        return null;
    }
}

以上代码大部分为官方示例代码，其中 appconfig 请根据实际情况设置。

2.创建DingCallbackCrypto工具类

代码地址：工具类地址（官方文档中也有给出地址）

直接创建一个DingCallbackCrypto类，并将上述工具类代码拷贝即可。

3.上述接口创建完成后，如果使用了类似Shiro验证框架，需要将上述接口设置白名单（不需要token验证）

4.上述代码中 if ("check_url".equals(eventType)) 代码段，就是根据实际订阅的事件代码，来进行判断，开发者可以根据实际情况，增加自己更多的判断和后续的处理程序。

事件对应代码：