Skip to content

Latest commit

 

History

History
166 lines (132 loc) · 6.7 KB

README.md

File metadata and controls

166 lines (132 loc) · 6.7 KB
Raw

dingtalk-spring-boot-starter

钉钉群 机器人消息推送 封装

官方文档地址：https://open.dingtalk.com/document/group/custom-robot-access

  • 支持类型如下

文本 (text)

链接 (link)

markdown(markdown)

ActionCard

FeedCard

1 使用

1.1 maven

Maven Central

3.x 版本 适配 spring boot 3.x，也可在spring boot 2.x中使用

<dependency>
  <groupId>com.kangaroohy</groupId>
  <artifactId>dingtalk-spring-boot-starter</artifactId>
  <version>3.0.1</version>
</dependency>

1.2 默认机器人配置

无论单机器人还是多机器人，都必须配置

kangaroohy:
  ding-talk:
    access-token: d4a24b6ea884d5d3ec245fb95e9cdbc3630
    secret: SEC8cc743fc2286f5209f1162d72131f47515843fc0cea661152bd

1.3 单机器人使用

    @Autowired
    private IDingTalkSender talkSender;

    talkSender.send(TextArgs.builder().content("自定义封装测试").atMobiles(Lists.newArrayList("133xxxx7608")).build());

    talkSender.send(MarkdownArgs.builder().title("markdown测试")
        .text("### andon通知\n - 工位： station\n - 故障： content")
        .build());

    talkSender.send(LinkArgs.builder().title("link").text("这是一条link消息")
        .picUrl("https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/9977602461/p352641.png")
        .messageUrl("https://open.dingtalk.com/document/group/robot-overview")
        .pcSlide(true)
        .build());

    talkSender.send(ActionCardWholeArgs.builder()
        .singleTitle("测试")
        .text("消息内容")
        .title("ActionCard")
        .singleUrl("https://open.dingtalk.com/document/group/robot-overview").build());

    talkSender.send(ActionCardAloneArgs.builder()
        .btnOrientation(BtnOrientation.VERTICAL)
        .btns(Lists.newArrayList(
            CardButtonArgs.builder().title("测试1").actionUrl("https://open.dingtalk.com").pcSlide(true).build(),
            CardButtonArgs.builder().title("测试2").actionUrl("https://open.dingtalk.com").pcSlide(true).build(),
            CardButtonArgs.builder().title("测试2").actionUrl("https://open.dingtalk.com").pcSlide(true).build()
        ))
        .title("消息标题").text("消息内容").build());

    talkSender.send(FeedCardArgs.builder()
        .links(Lists.newArrayList(
            CardLinksArgs.builder().title("测试1").messageUrl("https://open.dingtalk.com").pcSlide(true)
                .picUrl("https://img.alicdn.com/imgextra/i4/O1CN01oWsqXJ1VSf8Bj1DVs_!!6000000002652-2-tps-588-200.png").build(),
            CardLinksArgs.builder().title("测试2").messageUrl("https://open.dingtalk.com").pcSlide(true)
                .picUrl("https://img.alicdn.com/imgextra/i4/O1CN01oWsqXJ1VSf8Bj1DVs_!!6000000002652-2-tps-588-200.png").build(),
            CardLinksArgs.builder().title("测试3").messageUrl("https://open.dingtalk.com").pcSlide(true)
                .picUrl("https://img.alicdn.com/imgextra/i4/O1CN01oWsqXJ1VSf8Bj1DVs_!!6000000002652-2-tps-588-200.png").build()
        ))
        .build());

1.4 多机器人动态配置，如 数据库查询

3.0.2 版本开始支持 yml 配置分组机器人，查看 1.5 节

多机器人使用时，需配置对应的机器人群组信息

这里采用ApplicationRunner，项目启动完成，查询数据库 并将机器人信息添加到配置

算法部分参考了项目：https://github.com/AnswerAIL/dingtalk-spring-boot-starter

@Component
public class RobotConfig implements ApplicationRunner {
    @Autowired
    private IMultipleRobot multipleRobot;
    
    //这里可以注入数据库查询service进行查询配置

    @Override
    public void run(ApplicationArguments args) throws Exception {
        multipleRobot.addGroupRobot(
                GroupArgs.builder()
                        .groupId("111")
                        .dingTalkArgs(Lists.newArrayList(
                                DingTalkArgs.builder().accessToken("d4a24b6ea8849ee30bb65638fc6e880d3ec245fb95e9cdbc3630")
                                        .secret("SEC8cc743fc2286f5209f11623a0bff18d131f47515843fc0cea661152bd").build(),
                                DingTalkArgs.builder().accessToken("421b36a2e9e3103ea41efef6458982526ca46f87f389753cdf5df")
                                        .secret("SEC3f1ed3e72a0582c40d27ab3a85cd3b8bd0710bd04be3de3fe0a2d6d").build(),
                                DingTalkArgs.builder().accessToken("15a2dba92b815a2fac9231622c8ae0c3d8e9d7cfe3ce5e2ee1549")
                                        .secret("SEC475ecf41acaa4f1dabe7d32f06e20d2e277307d967c05d4d50e52d69").build()
                        ))
                        //轮询算法处理消息发送
                        .algorithmHandler(new RoundRobinHandler())
                        .build()
        );
    }
}

调用与单机器人一样，注入IDingTalkSender即可，发送消息时指定群组ID即可

    @Autowired
    private IDingTalkSender talkSender;

        talkSender.send(TextArgs.builder().content("群组机器人测试1").build(), "111");
        talkSender.send(TextArgs.builder().content("群组机器人测试2").build(), "111");
        talkSender.send(TextArgs.builder().content("群组机器人测试3").build(), "111");
        talkSender.send(TextArgs.builder().content("群组机器人测试4").build(), "111");

1.5 多机器人yml配置

自3.0.2版本开始，支持 yml 种配置分组机器人，如下：

kangaroohy:
  ding-talk:
    access-token: d9b913ef5d9af4687f0dc764684ade17b504547e930ee5976ffd578
    secret: SEC650d8da822e681b0e8c5a3da71658a82e2f8c83e82f1378e66414
    groups:
      group1: # 分组名
        algorithm-handler: com.kangaroohy.dingtalk.multiple.algorithm.RoundRobinHandler # 发送算法，这里轮询，可自己实现相关算法
        robots:
          - access-token: d8074a31ae7cf539cdf204e1420e9653e63d8d7299d2286d93cee5
            secret: SECa93355b1e75f63b1159be3e66f6caf964430d104c6e77831da0618
          - access-token: 28f7ca656c91a010a7c52cd12a352541822dd8e4353cef1ac8aa53
            secret: SECa771faa5e9dde4bc884a596f6f39d42f341ef35513051ad305a67d330
      group2:
        algorithm-handler: com.kangaroohy.dingtalk.multiple.algorithm.DingTalkHandler
        robots:
          - access-token: d8074a31ae7cf539cdfd52e1420e9653e63d8d7299d2286d93cee5
            secret: SECa93355b1e75f63b1159be3e6c70d504474430d104c6e77831da0618
          - access-token: 28f7ca656c91a010a78d109f2cd12a352541822dd8e4353cef1ac8aa53
            secret: SECa771faa5e9dde4bc884a596f39d42f341ef35513051ad305a67d330