1. 快速集成

  • 引入依赖 
    1. <dependency>
    2.      <groupId>com.pig4cloud.plugin</groupId>
    3.      <artifactId>dinger-spring-boot-starter</artifactId>
    4.      <version>0.0.1</version>
    5. </dependency>
  • 修改配置文件 
    1. spring:
    2. dinger:
    3.  project-id: ${spring.application.name}
    4.  dingers:
    5.    # 使用钉钉机器人, 请根据自己机器人配置信息进行修改
    6.    dingtalk:
    7.      tokenId: tokenId 
    8.      secret: secret

  • 使用 

    1. @Component
    2. public class AppInit implements InitializingBean {
    3.  @Autowired
    4.  private DingerSender dingerSender;
    5.  @Override
    6.  public void afterPropertiesSet() throws Exception {
    7.      // 发送text类型消息
    8.      dingerSender.send(
    9.              MessageSubType.TEXT,
    10.              DingerRequest.request("Hello World, Hello Dinger")
    11.      );
    13.      // 发送markdown类型消息
    14.      dingerSender.send(
    15.              MessageSubType.MARKDOWN,
    16.              DingerRequest.request("Hello World, Hello Dinger", "启动通知")
    17.      );
    18.  }
    19. }

2. 混合使用钉钉机器人与企业微信机器人

  • 修改配置文件 
    1. spring:
    2. dinger:
    3.  project-id: ${spring.application.name}
    4.  # 默认使用企业微信
    5.  default-dinger: wetalk
    6.  dingers:
    7.    # 使用钉钉机器人, 请根据自己机器人配置信息进行修改
    8.    dingtalk:
    9.      tokenId: tokenId
    10.      secret: secret
    11.    # 使用企业微信机器人, 请根据自己机器人配置信息进行修改
    12.    wetalk:
    13.      token-id: token-id
  • 使用 
    1. @Component
    2. public class AppInit implements InitializingBean {
    3.  @Autowired
    4.  private DingerSender dingerSender;
    5.  @Override
    6.  public void afterPropertiesSet() throws Exception {
    7.      // 指定发送给默认Dinger(详见配置spring.dinger.default-dinger参数值)
    8.      dingerSender.send(MessageSubType.TEXT, DingerRequest.request("Hello World, Hello Dinger"));
    9.      // 指定发送给钉钉
    10.      dingerSender.send(DingerType.DINGTALK, MessageSubType.MARKDOWN, DingerRequest.request("Hello World, Hello Dinger", "启动通知"));
    11.  }
    12. }

3. 动态配置机器人

场景说明： 对于同一个消息体， 发送给钉钉机器人的同时也需要发送给企业微信机器人。

  • 配置文件 
    1. spring:
    2. dinger:
    3.  project-id: ${spring.application.name}
    4.  # 默认使用钉钉
    5.  default-dinger: dingtalk
    6.  dingers:
    7.    # 使用钉钉机器人, 请根据自己机器人配置信息进行修改
    8.    dingtalk:
    9.      tokenId: tokenId
    10.      secret: secret
    11.    # 使用企业微信机器人, 请根据自己机器人配置信息进行修改
    12.    wetalk:
    13.      token-id: token-id

  • 使用 

    1. @RestController
    2. @Slf4j
    3. public class DemoController {
    4.  @Autowired
    5.  private UserDinger userDinger;
    7.  @Value("${spring.dinger.dingers.wetalk.tokenId}")
    8.  private String wetalkToken;
    10.  @GetMapping("/send")
    11.  public Response send() {
    12.      // 发送给钉钉群
    13.      DingerResponse dingSuccess = userDinger.success("pig");
    14.      log.info(objectMapper.writeValueAsString(dingSuccess));
    16.      // 动态配置企业微信机器人信息
    17.      DingerHelper.assignDinger(DingerType.WETALK, wetalkToken, false);
    18.      // 发送给企业微信群
    19.      DingerResponse weSuccess = userDinger.success("pig");
    20.      log.info(objectMapper.writeValueAsString(weSuccess));
    22.      return Repsonse.success();
    23.  }
    24. }

4. 配置多机器人

由于钉钉和企业微信有消息发送频率限制-每个机器人每分钟最多发送20条，这种限制可能导致消息发送失败的问题，而多机器人配置就是为了解决这种情况的。

目前提供两种方式多机器人配置支持，大家可以根据实际情况选择合适的配置方式，相对于全局配置方式，Dinger级别是更细粒度的配置方式。

  • 全局启用多机器人配置功能 

    1. @SpringBootApplication
    2. // 启用多机器人配置功能
    3. @EnableMultiDinger(
    4.      // 启用钉钉多机器人配置
    5.      @MultiDinger(
    6.          dinger = DingerType.DINGTALK, 
    7.          handler = DingTalkMultiHandler.class
    8.      )
    9. )
    10. public class DemoApplication {
    11.  public static void main(String[] args) {
    12.      SpringApplication.run(DemoApplication.class, args);
    13.  }
    14. }


    配置机器人信息及多机器人使用算法
    DingerConfigHandler中支持@Autowire注解来注入bean对象。

  • Dinger级别开启多机器人配置 

    1. @SpringBootApplication
    2. @DingerScan(basePackages = "com.pig4cloud.pig.admin.dinger")
    3. // 启用多机器人配置功能
    4. @EnableMultiDinger
    5. public class DemoApplication {
    6.  public static void main(String[] args) {
    7.      SpringApplication.run(DemoApplication.class, args);
    8.  }
    9. }


    Dinger层配置 

    1. // 为UserDinger配置多机器人功能
    2. @MultiHandler(
    3.      @MultiDinger(
    4.          dinger = DingerType.DINGTALK, 
    5.          handler = DingTalkMultiHandler.class)
    6. )
    7. public interface UserDinger {
    8.  @DingerText(value = "恭喜用户${loginName}登录成功!")
    9.  DingerResponse success(@Parameter("loginName") String userName);
    11.  @DingerMarkdown(
    12.          value = "#### 用户登录通知\n - 用户Id： ${userId}\n - 用户名： ${userName}",
    13.          title = "用户登录反馈"
    14.  )
    15.  DingerResponse failed(long userId, String userName);
    16. }


    @Dinger中指定的Dinger类型如果和@MultiHandler中不一致会致使多机器配置失效而选择默认配置发送

  • 系统默认四种AlgorithmHandler算法

    • DefaultHandler： 返回默认使用的机器人账号
    • DingerHandler： 消息频率限制-每个机器人每分钟最多发送20条算法
      • 每分钟发送次数可通过启动参数进行更改-Dmulti.dinger.minute.limit.count=10
      • eg：java -Dmulti.dinger.minute.limit.count=10 -jar service.jar
    • RandomHandler： 随机选择算法
    • RoundRobinHandler： 轮询算法
    • 自定义算法
      1. public class CustomAlgorithmHandler implements AlgorithmHandler {
      2. @Override
      3. public DingerConfig handler(List<DingerConfig> dingerConfigs, DingerConfig defaultDingerConfig) {
      4.    // 多机器人使用逻辑代码...
      5.    return dingerConfigs.get(1);
      6. }
      7. }

5. 统一消息管理体

  • 引入依赖 
    1. <dependency>
    2.      <groupId>com.pig4cloud.plugin</groupId>
    3.      <artifactId>dinger-spring-boot-starter</artifactId>
    4.      <version>0.0.1</version>
    5. </dependency>
  • 启动类引入DingerScan注解 
    1. @SpringBootApplication
    2. // 标识Dinger层扫描路径
    3. @DingerScan(basePackages = "com.pig4cloud.pig.admin.dinger")
    4. public class DemoApplication {
    5.  public static void main(String[] args) {
    6.      SpringApplication.run(DemoApplication.class, args);
    7.  }
    8. }

DingerScan的basePackages属性值注意更改为实际项目中定义的dinger接口层包路径

  • 定义消息体
    有两种方式进行Dinger消息体定义，分别是注解方式和XML配置方式，两种方式任选一种使用即可 。

    • 注解方式
      修改配置文件 

      1. spring:
      2. dinger:
      3. project-id: ${spring.application.name}
      4. dingers:
      5. # 使用钉钉机器人, 请根据自己机器人配置信息进行修改
      6. dingtalk:
      7.   tokenId: tokenId
      8.   secret: secret


      Dinger接口类
      ``java public interface UserDinger { //@`群里指定成员 @DingerText(value = “恭喜用户${userName}登录成功!”, phones = “13520200906”) DingerResponse success(String userName);

      @DingerMarkdown(

      1.   value = "#### 用户登录通知\n - 用户Id： ${userId}\n - 用户名： ${userName}",
      2.   title = "用户登录反馈"

      ) DingerResponse failed(long userId, String userName);

      // @群里全部成员 @DingerText(value = “恭喜用户${loginName}登录成功!”, atAll = true) DingerResponse login(@Parameter(“loginName”) String userName);

  1. // wetalk不支持markdown格式的`@`功能
  2. @DingerMarkdown(
  3.         value = "#### 注销登录 @13520200906 @13520200908 \n - 用户Id： ${uId}\n - 用户名： ${loginName}",
  4.         title = "用户登录反馈",
  5.         phones = {"13520200906", "13520200908"}
  6. )
  7. DingerResponse logout(@Parameter("uId") long userId, @Parameter("loginName") String userName);

}

  2.    -  xml配置<br />修改配置文件 
  3. ```yaml
  4. spring:
  5.   dinger:
  6.     project-id: ${spring.application.name}
  7.     dingers:
  8.       # 使用钉钉机器人, 请根据自己机器人配置信息进行修改
  9.       dingtalk:
  10.         tokenId: tokenId
  11.         secret: secret
  12.     # 使用xml配置方式时， 必填        
  13.     dinger-locations: classpath*:dinger/*.xml


Dinger接口类 

  1. public interface UserDinger {
  2.     DingerResponse success(String userName);
  4.     DingerResponse failed(long userId, String userName);
  6.     DingerResponse login(@Parameter("loginName") String userName);
  8.     DingerResponse logout(@Parameter("uId") long userId, @Parameter("loginName") String userName);
  9. }


Dinger消息XML定义 

  1. <message id="success" type="TEXT">
  2.   <body>
  3.     <content>
  4.       恭喜用户${userName}登录成功!
  5.     </content>
  7.     <!-- `@`群里指定成员 -->
  8.     <phones>
  9.       <phone value="13520200906"/>
  10.     </phones>
  11.   </body>
  12. </message>
  14. <message id="failed" type="MARKDOWN">
  15.   <body>
  16.     <content title="用户登录反馈">
  17.       #### 用户登录通知
  18.       - 用户Id： ${userId}
  19.       - 用户名： ${userName}
  20.     </content>
  21.   </body>
  22. </message>
  24. <message id="login" type="TEXT">
  25.   <body>
  26.     <content>
  27.       恭喜用户${loginName}登录成功!
  28.     </content>
  30.     <!-- `@`群里全部成员 -->
  31.     <phones atAll="true" />
  32.   </body>
  33. </message>
  35. <!-- wetalk不支持markdown格式的`@`功能 -->
  36. <message id="logout" type="MARKDOWN">
  37.   <body>
  38.     <content title="用户登录反馈">
  39.       #### 注销登录 @13520200906 @13520200908
  40.       - 用户Id： ${uId}
  41.       - 用户名： ${loginName}
  42.     </content>
  44.     <!-- `@`群里指定成员 -->
  45.     <phones>
  46.       <phone value="13520200906"/>
  47.       <phone value="13520200908"/>
  48.     </phones>
  49.   </body>
  50. </message>

  • 使用 ```java @RestController @Slf4j public class DemoController { @Autowired private UserDinger userDinger;

    @GetMapping(“/success”) public Response success() {

    1.  return Response.success(
    2.          userDinger.success("Jaemon")
    3.  );

    }

    @GetMapping(“/failed”) public Response failed() {

    1.  return Response.success(
    2.          userDinger.failed(1, "AnswerAIL")
    3.  );

    }

    @GetMapping(“/login”) public Response login() {

    1.  return Response.success(
    2.          userDinger.login("Jaemon")
    3.  );

    } @GetMapping(“/logout”) public Response logout() {

    1.  return Response.success(
    2.          userDinger.logout(1,"AnswerAIL")
    3.  );

    }

}

  3. <a name="09ba03c5"></a>
  4. #### 6. 支持的消息类型
  5. | 消息类型/Dinger类型 | DingTalk(钉钉) | WeTalk(企业微信) |
  6. | --- | --- | --- |
  7. | TEXT | √ | √ |
  8. | MARKDOWN | √ | √ |
  9. | IMAGETEXT | √ | √ |
  10. | LINK | √ | × |
  13. **图文、link方式使用**
  15. -  修改配置文件 
  16. ```yaml
  17. spring:
  18.   dinger:
  19.     project-id: ${spring.application.name}
  20.     default-dinger: dingtalk
  21.     dinger-locations: classpath*:dinger/*.xml # xml方式下必须配置
  22.     dingers:
  23.       dingtalk:
  24.         tokenId: tokenId
  25.         secret: secret
  26.       wetalk:
  27.         tokenId: tokenId
  • 启动类引入DingerScan注解 
    1. @SpringBootApplication
    2. @DingerScan(basePackages = "com.pig4cloud.pig.admin.dinger")
    3. public class DemoApplication {
    4.  public static void main(String[] args) {
    5.      SpringApplication.run(DemoApplication.class, args);
    6.  }
    7. }

  • 定义Dinger

    • 注解方式 ```java public interface UserDinger { // 图文类型 @DingerImageText DingerResponse imageText(List images);

      // link类型, 只支持Dingtalk @DingerLink DingerResponse link(LinkDeo link);

}

  3.    -  xml方式<br />xml方式**必须**配置`dinger-locations`配置项 
  4. ```java
  5. public interface UserDinger {
  6.     DingerResponse imageText(List<ImageTextDeo> images);
  8.     DingerResponse link(LinkDeo link);
  9. }

  • 使用 

    1. @Component
    2. public class AppInit implements InitializingBean {
    3.  @Autowired
    4.  private UserDinger userDinger;
    5.  @Override
    6.  public void afterPropertiesSet() throws Exception {
    7.      String picUrl = "http://pigx.pig4cloud.com/img/logo.png";
    8.      List<ImageTextDeo> images = new ArrayList<>();
    9.      images.add(
    10.              ImageTextDeo.instance(
    11.                      "pig", "https://gitee.com/log4j/pig", picUrl
    12.              )
    13.      );
    14.      // 发送图文类型消息
    15.      userDinger.imageText(images);
    17.      // 发送link类型消息， 只支持钉钉
    18.      userDinger.link(
    19.              LinkDeo.instance(
    20.                      "pig",
    21.                      "pig4cloud",
    22.                      "https://gitee.com/log4j/pig",
    23.                      picUrl
    24.              )
    25.      );
    26.  }
    27. }

7. 个性化拓展配置

  • 独立配置

    1. 手动发送方式消息自定义 

      1. @Component
      2. @Slf4j
      3. public class AppInit implements InitializingBean {
      4. @Autowired
      5. private DingerSender dingerSender;
      6. @Override
      7. public void afterPropertiesSet() throws Exception {
      8.  // 发送text类型消息
      9.  dingerSender.send(
      10.          MessageSubType.TEXT,
      11.          DingerRequest.request("Hello World, Hello Dinger")
      12.  );
      14.  // 发送markdown类型消息
      15.  dingerSender.send(
      16.          MessageSubType.MARKDOWN,
      17.          DingerRequest.request("Hello World, Hello Dinger", "启动通知")
      18.  );
      19. }
      20. }


      b. 其他扩展配置
      以下个性化配置项均可适用于手动发送和消息体统一管理方式 ```java @Configuration @Slf4j public class MyDingerConfiguration { // 自定义异步回调函数-用于异步发送时 @Bean public DingerAsyncCallback dingerAsyncCallback() { return (dingerId, result) -> {

      1.  log.info("dingerId={}, response result={}.", dingerId, result);

      }; }

  1. // 自定义DingerId生成器， dingerId为每次调用返回体中的logid值
  2. @Bean
  3. public DingerIdGenerator dingerIdGenerator() {
  4.     return () -> UUID.randomUUID().toString();
  5. }
  8. // 自定义异常回调函数
  9. @Bean
  10. public DingerExceptionCallback dingerExceptionCallback() {
  11.     return dingerCallback -> {
  12.         log.error("dingerId={}, message={}.", 
  13.                   dingerCallback.getDkid(), dingerCallback.getMessage());
  14.     };
  15. }
  18. // 自定义异步执行线程池
  19. @Bean
  20. public Executor dingerExecutor() {
  21.     ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  22.     executor.setThreadNamePrefix("DingerAsync-");
  23.     executor.setCorePoolSize(30);
  24.     executor.setMaxPoolSize(30);
  25.     executor.initialize();
  26.     return executor;
  27. }
  30. // 自定义restTemplate客户端
  31. @Bean
  32. public RestTemplate dingerRestTemplate() {
  33.     SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
  34.     factory.setReadTimeout(100 * 1000);
  35.     factory.setConnectTimeout(100 * 1000);
  36.     return new RestTemplate(factory);
  37. }

}

  2. -  整体配置 
  3. ```java
  4. @Configuration
  5. @Slf4j
  6. public class MyDingerConfiguration extends DingerConfigurerAdapter {
  8.     @Override
  9.     public void configure(DingerManagerBuilder config) throws Exception {
  10.         config
  11.                 .textMessage(...)
  12.                 .markDownMessage(...)
  13.                 .dingerAsyncCallback(...)
  14.                 .dingerIdGenerator(...)
  15.                 .dingerExceptionCallback(...)
  16.                 .dingTalkExecutor(...)
  17.                 .dingerRestTemplate(...);
  19.     }
  20. }

8. 注解说明

注解 功能描述 使用说明
@DingerScan 标识Dinger层扫描路径 在SpringBoot启动类中定义使用
@Dinger 指定当前XXXDinger使用的机器人类型 在XXXDinger.java接口类上
@DingerClose 用于关闭 XXXDinger.java 或者指定其中的一个至多个方法 XXXDinger.java接口层(接口类或接口方法上均可) - 作用于Dinger类上，关闭Dinger类中所有方法通知； - 作用于方法上， 关闭当前方法通知；
@AsyncExecute 用于 XXXDinger.java 层(注解和XML)级别异步发送 在XXXDinger.java接口类上
@DingerConfiguration 用于 XXXDinger.java 层(注解和XML)级别机器人信息配置 XXXDinger.java接口类上
@DingerText 注解方式定义Text消息体 XXXDinger.java接口层接口方法上
@DingerMarkdown 注解方式定义Markdown消息体 XXXDinger.java接口层接口方法上
@DingerImageText 注解方式定义图文类型消息体 XXXDinger.java接口层接口方法上
@DingerLink 注解方式定义Link类型消息体 XXXDinger.java接口层接口方法上
@Parameter 如果消息体中使用的参数变量和方法定义的参数名称不一致
，可使用该注解进行个性化设置参数变量名称		 XXXDinger.java接口层接口方法参数上
@EnableMultiDinger 启动多钉钉机器人配置 在SpringBoot启动类中定义使用
@MultiHandler 为Dinger层指定对应的多机器人处理器 XXXDinger.java接口类上

❤ 问题咨询

手势点击蓝字求关注简约风动态引导关注__2022-09-07+23_18_38.gif