SpringBoot中集成企业微信机器人实现运维报警的示例

2024-02-14 06:19:42

在企业运营中，为了实现工作效率和执行效率的提升，往往会选择在社群中使用群聊机器人进行协助管理。机器人可以定时或者按照一定的规则给群里发信息并@群成员等。群聊机器人可以活跃气氛，关怀员工比如根据天气情况提醒员工注意天气变化，发送节日、生日祝福等。它也可以进行工作提醒，帮助员工更好的做系统化的回报总结，机器人可以依托业务系统，每天定时发送工作总结给对应负责人，帮助员工更好地复盘工作。

1、注册企业微信

注册地址：https://work.weixin.qq.com/wework_admin/register_wx?from=myhome

这里的注册企业微信，不一定需要你有企业信息，可以任意填写，不需要审核

2、添加群机器人

加入企业微信后，会有一个该企业的全员群，我们可以在群内添加机器人：

填写机器人名称

添加成功后，得到机器人的 Webhook 地址，我们需要用到它，特别特别要注意：一定要保护好机器人的 webhook 地址，避免泄漏！不要分享到 github、博客等可被公开查阅的地方，否则坏人就可以用你的机器人来发垃圾消息了。

3、引入 forest 依赖

<!-- http请求工具 -->
<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-spring-boot-starter</artifactId>
    <version>1.5.14</version>
</dependency>

forest 是声明式 HTTP 客户端 API 框架，让 Java 发送 HTTP/HTTPS 请求不再难。它比 OkHttp 和 HttpClient 更高层，是封装调用第三方 restful api client 接口的好帮手，是 retrofit 和 feign 之外另一个选择。通过在接口上声明注解的方式配置 HTTP 请求接口，Gitee 地址：https://gitee.com/dromara/forest

文档地址：https://forest.dtflyx.com/

4、请求方法

import com.dtflys.forest.annotation.JSONBody;
import com.dtflys.forest.annotation.Post;
import com.dtflys.forest.annotation.Var;

import java.util.Map;

public interface WechatClient {

    @Post(
            url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key={key}",
            headers = {
                    "Accept-Charset: utf-8",
                    "Content-Type: application/json"
            },
            dataType = "json")
    void sendWechatMsg(@Var("key") String key, @JSONBody Map<String, Object> body);
}

使用 forest 做 http 请求非常方便，只需要使用注解的方式轻松完成请求

5、发送消息

注入请求接口：

@Resource
private WechatClient wechatClient;

1、发送文本消息

/**
 * 发送文本消息
 */
public void sendTextMsg() {
    Map<String, Object> map = new HashMap<>();
    map.put("msgtype", "text");
    Map<String, String> content = new HashMap<>();
    content.put("content", "hello world!");
    map.put("text", content);
    wechatClient.sendWechatMsg("xxxxxxxxxxxxxxxxxx", map);
}

其中：xxxxxxxxxxxxxx 为你的机器人的 Webhook 地址的 key

如果我们想 @某人时，我们可以在 content 中这样写：

content.put("content", "hello world!<@zhangsan>");

这样就可以 @zhangsan 了，仅支持 text、markdown 类型的消息

2、发送 MD 消息

/**
 * 发送md消息
 */
public void sendMarkdownMsg() {
    Map<String, Object> map = new HashMap<>();
    map.put("msgtype", "markdown");
    Map<String, String> content = new HashMap<>();
    content.put("content", "实时新增用户反馈<font color=\\\"warning\\\">132例</font>，请相关同事注意。\\n\n" +
            "         >类型:<font color=\\\"comment\\\">用户反馈</font>\n" +
            "         >普通用户反馈:<font color=\\\"comment\\\">117例</font>\n" +
            "         >VIP用户反馈:<font color=\\\"comment\\\">15例</font>");
    map.put("markdown", content);
    wechatClient.sendWechatMsg("xxxxxxxxxxxxxxxxxx", map);
}

markdown 语法教程见：https://mp.weixin.qq.com/s/uvxdj4tdWePkGbdD5I9iLQ

3、发送图片消息

/**
 * 发送图片消息
 */
public void sendImageMsg() {
    String url = "C:\\Users\\admin\\Desktop\\test.png";
    Map<String, Object> map = new HashMap<>();
    map.put("msgtype", "image");
    Map<String, String> content = new HashMap<>();
    content.put("md5", getMd5(url));
    content.put("base64", getBase64(url));
    map.put("image", content);
    wechatClient.sendWechatMsg("xxxxxxxxxxxxxxxxxx", map);
}

我们需要图片的 base64 编码和 MD5 值，方法如下：

/**
 * 图片转为base64编码
 */
public static String getBase64(String imgFile) {
    InputStream in = null;
    byte[] data = null;
    //  读取图片字节数组
    try {
        in = new FileInputStream(imgFile);
        data = new byte[in.available()];
        in.read(data);
        in.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
    // 对字节数组Base64编码
    BASE64Encoder encoder = new BASE64Encoder();
    // 返回Base64编码过的字节数组字符串
    return encoder.encode(data);
}

/**
 * 获取文件的MD5值
 *
 * @param path
 * @return
 */
public static String getMd5(String path) {
    try {
        MessageDigest md5 = MessageDigest.getInstance("MD5");
        FileInputStream fis = new FileInputStream(path);
        byte[] buffer = new byte[1024];
        int len;
        while ((len = fis.read(buffer)) != -1) {
            md5.update(buffer, 0, len);
        }
        fis.close();
        byte[] byteArray = md5.digest();
        StringBuilder sb = new StringBuilder();
        for (byte b : byteArray) {
            sb.append(String.format("%02x", b));
        }
        return sb.toString();
    } catch (IOException | NoSuchAlgorithmException e) {
        e.printStackTrace();
    }
    return null;
}

这里会有一个坑，发送请求后，返回的请求码是 200，但是收不到消息，会看到提示信息：

{"errcode":301019,"errmsg":"media md5 not match, hint: [1651825628340383128465893], from ip: 218.201.194.160, more info at https://open.work.weixin.qq.com/devtool/query?e=301019"}

提示我们：媒体md5不匹配

其实，并不是 MD5 的问题，是 base64 的问题，转化出来的 base64 编码存在 \r\n，我们需要将其替换掉，这样写：

content.put("base64", getBase64(url).replaceAll("\r|\n", ""));

4、发送图文消息

/**
 * 发送图文消息
 */
public void sendNewsMsg() {
    Map<String, Object> map = new HashMap<>();
    map.put("msgtype", "news");
    Map<String, Object> content = new HashMap<>();
    List<Map<String, Object>> list = new ArrayList<>();
    Map<String, Object> obj = new HashMap<>();
    obj.put("title", "中秋节礼品领取");
    obj.put("description", "今年中秋节公司有豪礼相送");
    obj.put("url", "www.qq.com");
    obj.put("picurl", "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png");
    list.add(obj);
    content.put("articles", list);
    map.put("news", content);
    wechatClient.sendWechatMsg("xxxxxxxxxxxxxxxxxx", map);
}

6、测试