快速开始
欢迎阅读 Open-Starter-Alarm 文档！
如果你有任何与 Open-Starter-Alarm 相关的问题，欢迎随时在 GitHub Discussions 上向我们的社区寻求帮助。
1. 添加 Maven 依赖
<dependency>
<groupId>com.saucesubfresh</groupId>
<artifactId>open-starter-alarm</artifactId>
<version>1.0.4</version>
</dependency>
2. 配置参数
com:
saucesubfresh:
alarm:
ding-ding:
# 这里的 {xxxxxx} 替换成你的钉钉机器人的 secret
secret: xxxxxx
# 这里 {xxxxxxxx} 替换成你的钉钉机器人的 access_token
webhook: https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx
we-chat:
# 这里 {xxxxxxxx} 替换成你的企业微信机器人的 key
webhook: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx
3. 报警示例
钉钉自定义机器人
- @指定的人
public class DingDingTest {
public static void main(String[] args) {
// 接收者相关
DingDingRobotAlarmRequest.AtVO atVo = DingDingRobotAlarmRequest.AtVO.builder().build();
atVo.setAtMobiles(Collections.singletonList("182****6871"));
// 消息内容
DingDingRobotAlarmRequest.TextVO textVO = DingDingRobotAlarmRequest.TextVO.builder().content(contentModel.getContent()).build();
DingDingRobotAlarmRequest request = DingDingRobotAlarmRequest.builder().at(atVo).msgtype("text").text(textVO).build();
dingDingRobotAlarmExecutor.doAlarm(request);
}
}
- @所有人
public class DingDingTest {
public static void main(String[] args) {
// 接收者相关
DingDingRobotAlarmRequest.AtVO atVo = DingDingRobotAlarmRequest.AtVO.builder().build();
atVo.setIsAtAll(true);
// 消息内容
DingDingRobotAlarmRequest.TextVO textVO = DingDingRobotAlarmRequest.TextVO.builder().content(contentModel.getContent()).build();
DingDingRobotAlarmRequest request = DingDingRobotAlarmRequest.builder().at(atVo).msgtype("text").text(textVO).build();
dingDingRobotAlarmExecutor.doAlarm(request);
}
}
飞书自定义机器人
public class FeiShuTest {
public static void main(String[] args) {
FeiShuRobotAlarmRequest request = new FeiShuRobotAlarmRequest();
request.setMsgType("text");
FeiShuRobotAlarmRequest.ContentDTO contentDTO = new FeiShuRobotAlarmRequest.ContentDTO();
contentDTO.setText("test message");
request.setContent(contentDTO);
feiShuRobotAlarmExecutor.doAlarm(request);
}
}
企业微信自定义机器人
- 群发
public class WeChatTest {
public static void main(String[] args) {
WeChatRobotAlarmRequest request = new WeChatRobotAlarmRequest();
request.setMsgType("text");
WeChatRobotAlarmRequest.TextDTO textDTO = new WeChatRobotAlarmRequest.TextDTO();
textDTO.setContent("test-message");
request.setText(textDTO);
weChatRobotAlarmExecutor.doAlarm(request);
}
}
- @指定的人
public class WeChatTest {
public static void main(String[] args) {
WeChatRobotAlarmRequest request = new WeChatRobotAlarmRequest();
request.setMsgType("text");
WeChatRobotAlarmRequest.TextDTO textDTO = new WeChatRobotAlarmRequest.TextDTO();
List<String> mentionedList = new ArrayList<>();
mentionedList.add("30123132");
textDTO.setContent("test-message");
textDTO.setMentionedList(mentionedList);
request.setText(textDTO);
weChatRobotAlarmExecutor.doAlarm(request);
}
}
- @所有人
public class WeChatTest {
public static void main(String[] args) {
WeChatRobotAlarmRequest request = new WeChatRobotAlarmRequest();
request.setMsgType("text");
WeChatRobotAlarmRequest.TextDTO textDTO = new WeChatRobotAlarmRequest.TextDTO();
List<String> mentionedList = new ArrayList<>();
mentionedList.add("@all");
textDTO.setContent("test-message");
textDTO.setMentionedList(mentionedList);
request.setText(textDTO);
weChatRobotAlarmExecutor.doAlarm(request);
}
}
注意事项
1. 对于多机器人报警使用说明
你需要在 Request 的 Config 中配置你的报警配置，报警获取配置的原理是如果你在 Request 的 Config 配置了
报警配置，那么就会使用你 Request 中 Config 的配置，如果没有配置就会使用全局的 properties 配置。
2. 使用邮箱的话需要配置
### email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=2544054976@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
