SpringBoot怎么接入釘釘自定義機器人預警通知

SpringBoot怎么接入釘釘自定義機器人預警通知

1. 引言

在現代軟件開發中，監控和預警系統是確保系統穩定性和可靠性的重要組成部分。隨著微服務架構的普及，Spring Boot 成為了構建微服務的首選框架之一。而釘釘作為一款廣泛使用的企業通訊工具，其自定義機器人功能可以方便地集成到各種系統中，用于發送預警通知。

本文將詳細介紹如何在 Spring Boot 項目中接入釘釘自定義機器人，并通過代碼示例展示如何實現預警通知功能。我們將從釘釘機器人的創建、Spring Boot 項目的配置、消息發送的實現等方面進行詳細講解。

2. 釘釘自定義機器人簡介

釘釘自定義機器人是釘釘提供的一種消息推送服務，允許開發者通過 Webhook 將消息推送到釘釘群聊中。通過自定義機器人，可以實現自動化消息推送、預警通知、任務提醒等功能。

2.1 創建釘釘自定義機器人

1. 登錄釘釘開發者平臺：首先，登錄釘釘開發者平臺（https://open.dingtalk.com/）。
2. 創建機器人：在釘釘群聊中，點擊右上角的“群設置” -> “智能群助手” -> “添加機器人” -> “自定義機器人”。
3. 配置機器人：設置機器人名稱、頭像，并選擇需要發送消息的群聊。
4. 獲取Webhook地址：創建完成后，系統會生成一個 Webhook 地址，該地址用于發送消息到釘釘群聊。

2.2 釘釘機器人消息格式

釘釘機器人支持多種消息格式，包括文本、鏈接、Markdown、ActionCard、FeedCard 等。本文將重點介紹如何使用文本和 Markdown 格式發送預警通知。

2.2.1 文本消息格式

{
    "msgtype": "text",
    "text": {
        "content": "預警通知：系統出現異常，請及時處理！"
    },
    "at": {
        "atMobiles": [
            "138xxxx8888"
        ],
        "isAtAll": false
    }
}

2.2.2 Markdown 消息格式

{
    "msgtype": "markdown",
    "markdown": {
        "title": "預警通知",
        "text": "#### 預警通知 \n > 系統出現異常，請及時處理！ \n > ![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png) \n > ###### 10分鐘前發布 [查看詳情](https://www.dingtalk.com)"
    },
    "at": {
        "atMobiles": [
            "138xxxx8888"
        ],
        "isAtAll": false
    }
}

3. Spring Boot 項目配置

在 Spring Boot 項目中接入釘釘自定義機器人，首先需要配置相關的依賴和屬性。

3.1 添加依賴

在 pom.xml 中添加以下依賴：

<dependencies>
    <!-- Spring Boot Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Boot Actuator -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

    <!-- Spring Boot Configuration Processor -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- OkHttp -->
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.9.1</version>
    </dependency>

    <!-- Lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

3.2 配置釘釘機器人Webhook地址

在 application.yml 或 application.properties 中配置釘釘機器人的 Webhook 地址：

dingtalk:
  robot:
    webhook: https://oapi.dingtalk.com/robot/send?access_token=your_access_token

3.3 創建配置類

創建一個配置類來加載釘釘機器人的配置：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Data
@Configuration
@ConfigurationProperties(prefix = "dingtalk.robot")
public class DingTalkRobotConfig {
    private String webhook;
}

4. 實現釘釘機器人消息發送

4.1 創建消息發送工具類

創建一個工具類 DingTalkRobotUtil，用于發送消息到釘釘機器人：

import com.alibaba.fastjson.JSON;
import com.squareup.okhttp.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.IOException;

@Slf4j
@Component
public class DingTalkRobotUtil {

    @Autowired
    private DingTalkRobotConfig dingTalkRobotConfig;

    private static final MediaType JSON_MEDIA_TYPE = MediaType.parse("application/json; charset=utf-8");

    public void sendTextMessage(String content, String[] atMobiles, boolean isAtAll) {
        TextMessage textMessage = new TextMessage(content, atMobiles, isAtAll);
        sendMessage(textMessage);
    }

    public void sendMarkdownMessage(String title, String text, String[] atMobiles, boolean isAtAll) {
        MarkdownMessage markdownMessage = new MarkdownMessage(title, text, atMobiles, isAtAll);
        sendMessage(markdownMessage);
    }

    private void sendMessage(Message message) {
        OkHttpClient client = new OkHttpClient();
        String json = JSON.toJSONString(message);
        RequestBody body = RequestBody.create(JSON_MEDIA_TYPE, json);
        Request request = new Request.Builder()
                .url(dingTalkRobotConfig.getWebhook())
                .post(body)
                .build();

        try {
            Response response = client.newCall(request).execute();
            if (response.isSuccessful()) {
                log.info("消息發送成功：{}", json);
            } else {
                log.error("消息發送失?。簕}", response.body().string());
            }
        } catch (IOException e) {
            log.error("消息發送異常：", e);
        }
    }

    @Data
    private static class TextMessage {
        private String msgtype = "text";
        private Text text;
        private At at;

        TextMessage(String content, String[] atMobiles, boolean isAtAll) {
            this.text = new Text(content);
            this.at = new At(atMobiles, isAtAll);
        }

        @Data
        private static class Text {
            private String content;

            Text(String content) {
                this.content = content;
            }
        }

        @Data
        private static class At {
            private String[] atMobiles;
            private boolean isAtAll;

            At(String[] atMobiles, boolean isAtAll) {
                this.atMobiles = atMobiles;
                this.isAtAll = isAtAll;
            }
        }
    }

    @Data
    private static class MarkdownMessage {
        private String msgtype = "markdown";
        private Markdown markdown;
        private At at;

        MarkdownMessage(String title, String text, String[] atMobiles, boolean isAtAll) {
            this.markdown = new Markdown(title, text);
            this.at = new At(atMobiles, isAtAll);
        }

        @Data
        private static class Markdown {
            private String title;
            private String text;

            Markdown(String title, String text) {
                this.title = title;
                this.text = text;
            }
        }

        @Data
        private static class At {
            private String[] atMobiles;
            private boolean isAtAll;

            At(String[] atMobiles, boolean isAtAll) {
                this.atMobiles = atMobiles;
                this.isAtAll = isAtAll;
            }
        }
    }
}

4.2 發送文本消息

在需要發送預警通知的地方，調用 DingTalkRobotUtil 的 sendTextMessage 方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class AlertService {

    @Autowired
    private DingTalkRobotUtil dingTalkRobotUtil;

    public void sendAlert(String message) {
        String[] atMobiles = {"138xxxx8888"};
        dingTalkRobotUtil.sendTextMessage(message, atMobiles, false);
    }
}

4.3 發送Markdown消息

如果需要發送更復雜的消息，可以使用 sendMarkdownMessage 方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class AlertService {

    @Autowired
    private DingTalkRobotUtil dingTalkRobotUtil;

    public void sendAlert(String title, String message) {
        String[] atMobiles = {"138xxxx8888"};
        dingTalkRobotUtil.sendMarkdownMessage(title, message, atMobiles, false);
    }
}

5. 集成到Spring Boot Actuator

為了在系統出現異常時自動發送預警通知，可以將釘釘機器人集成到 Spring Boot Actuator 中。

5.1 配置Actuator

在 application.yml 中配置 Actuator：

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always

5.2 創建HealthIndicator

創建一個自定義的 HealthIndicator，用于監控系統健康狀態，并在出現異常時發送預警通知：

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class CustomHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        // 模擬系統異常
        boolean systemError = true;

        if (systemError) {
            return Health.down().withDetail("Error Code", "500").build();
        } else {
            return Health.up().build();
        }
    }
}

5.3 監聽Health事件

創建一個事件監聽器，監聽 Health 事件，并在系統健康狀態變化時發送預警通知：

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthEndpoint;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class HealthEventListener {

    @Autowired
    private HealthEndpoint healthEndpoint;

    @Autowired
    private AlertService alertService;

    @EventListener
    public void onHealthEvent(Health health) {
        if (health.getStatus().equals(Health.down().build().getStatus())) {
            alertService.sendAlert("系統健康狀態異常", "系統健康狀態已變為 DOWN，請及時處理！");
        }
    }
}

6. 測試與驗證

6.1 啟動Spring Boot項目

啟動 Spring Boot 項目，并訪問 Actuator 的 /actuator/health 端點，查看系統健康狀態。

6.2 模擬系統異常

在 CustomHealthIndicator 中模擬系統異常，觀察釘釘群聊中是否收到預警通知。

6.3 驗證消息發送

確保釘釘群聊中收到了正確的預警通知，并且消息格式符合預期。

7. 總結

通過本文的介紹，我們詳細講解了如何在 Spring Boot 項目中接入釘釘自定義機器人，并實現預警通知功能。通過集成 Spring Boot Actuator，我們可以實時監控系統健康狀態，并在出現異常時自動發送預警通知，確保系統的穩定性和可靠性。

釘釘自定義機器人提供了豐富的消息格式和靈活的配置選項，可以滿足不同場景下的需求。希望本文能夠幫助讀者更好地理解和應用釘釘自定義機器人，提升系統的監控和預警能力。