05_项目集成飞书预警

05_项目集成飞书预警

一、切面类及请求上下文信息类

请求上下文信息类：

1. /**
2. * @desc: 请求上下文信息类
3. * @author: sqnugy
4. * @date: 2025/5/8
5. **/
6. @Data
7. @AllArgsConstructor
8. @NoArgsConstructor
9. public class ApiContext {
10.     private String methodName;
11.     private String className;
12.     private String argsJson;
13. }

复制代码

请求上下文信息保存类（通过 ThreadLocal 保存）

1. /**
2. * @desc: ThreadLocal 存储请求上下文信息（ApiContext）
3. * @author: sqnugy
4. * @date: 2025/5/8
5. **/
6. public class ApiContextHolder {
7.     private static final ThreadLocal<ApiContext> contextHolder = new ThreadLocal<>();
9.     public static void set(ApiContext context) {
10.         contextHolder.set(context);
11.     }
13.     public static ApiContext get() {
14.         return contextHolder.get();
15.     }
17.     public static void clear() {
18.         contextHolder.remove();
19.     }
20. }

复制代码

ApiOperation 注解切面类：

1. import cn.jcs.boot.video.review.util.JsonUtils;
2. import io.swagger.annotations.ApiOperation;
3. import lombok.extern.slf4j.Slf4j;
4. import org.aspectj.lang.ProceedingJoinPoint;
5. import org.aspectj.lang.annotation.Around;
6. import org.aspectj.lang.annotation.Aspect;
7. import org.aspectj.lang.annotation.Pointcut;
8. import org.aspectj.lang.reflect.MethodSignature;
9. import org.springframework.stereotype.Component;
10. import org.slf4j.MDC;
12. import java.lang.reflect.Method;
13. import java.util.Arrays;
14. import java.util.UUID;
15. import java.util.function.Function;
16. import java.util.stream.Collectors;
19. /**
20. * @desc: ApiOperation 注解的切面类，通过 ApiOperaton 注解进行织入切面，并将获取到的请求的类名、方法名、入参 保存到上下文中
21. * @author: sqnugy
22. * @date: 2025/5/8
23. **/
24. @Aspect
25. @Component
26. @Slf4j
27. public class ApiOperationAspect {
29.     /** 以 @ApiOperation 注解为切点，凡是添加 @ApiOperation 的方法，都会执行环绕中的代码 */
30.     @Pointcut("@annotation(io.swagger.annotations.ApiOperation)")
31.     public void apiOperation() {}
33.     /**
34.      * 环绕
35.      * @param joinPoint
36.      * @return
37.      * @throws Throwable
38.      */
39.     @Around("apiOperation()")
40.     public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
41.         try {
42.             long startTime = System.currentTimeMillis();
43.             MDC.put("traceId", UUID.randomUUID().toString());
45.             String className = joinPoint.getTarget().getClass().getSimpleName();
46.             String methodName = joinPoint.getSignature().getName();
47.             Object[] args = joinPoint.getArgs();
48.             String argsJsonStr = Arrays.stream(args).map(toJsonStr()).collect(Collectors.joining(", "));
49.             String description = getApiOperationDescription(joinPoint);
51.             log.info("====== 请求开始: [{}], 入参: {}, 请求类: {}, 请求方法: {} =================================== ",
52.                     description, argsJsonStr, className, methodName);
54.             // 保存上下文信息
55.             ApiContext apiContext = new ApiContext();
56.             apiContext.setClassName(className);
57.             apiContext.setMethodName(methodName);
58.             apiContext.setArgsJson(argsJsonStr);
59.             //将上下文信息保存到 ThreadLocal 内
60.             ApiContextHolder.set(apiContext);
62.             Object result = joinPoint.proceed();
64.             long executionTime = System.currentTimeMillis() - startTime;
65.             String resultJson = JsonUtils.toJsonString(result);
67.             log.info("====== 请求结束: [{}], 耗时: {}ms, 出参: {} =================================== ",
68.                     description, executionTime, resultJson);
70.             return result;
71.         } finally {
72.             MDC.clear();
73.         }
74.     }
76.     /**
77.      * 获取注解的描述信息
78.      * @param joinPoint
79.      * @return
80.      */
81.     private String getApiOperationDescription(ProceedingJoinPoint joinPoint) {
82.         // 1. 从 ProceedingJoinPoint 获取 MethodSignature
83.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
85.         // 2. 使用 MethodSignature 获取当前被注解的 Method
86.         Method method = signature.getMethod();
88.         // 3. 从 Method 中提取 LogExecution 注解
89.         ApiOperation apiOperatiog = method.getAnnotation(ApiOperation.class);
91.         // 4. 从 LogExecution 注解中获取 description 属性
92.         return apiOperatiog.value();
93.     }
95.     /**
96.      * 转 JSON 字符串
97.      * @return
98.      */
99.     private Function<Object, String> toJsonStr() {
100.         return arg -> JsonUtils.toJsonString(arg);
101.     }
103. }

复制代码

二、使用小呆板人推送普通消息

使用小呆板人发送普通消息，实际上就是将想要发送的消息封装为字符串进行发送。
2.1 推送信息格式：

2.2 全局非常处理类

1. package cn.jcs.boot.video.review.exception;
3. import cn.jcs.boot.video.review.common.CommonResult;
4. import cn.jcs.boot.video.review.util.FeishuUtil;
5. import lombok.extern.slf4j.Slf4j;
6. import org.springframework.validation.FieldError;
7. import org.springframework.validation.ObjectError;
8. import org.springframework.web.bind.MethodArgumentNotValidException;
9. import org.springframework.web.bind.annotation.ExceptionHandler;
10. import org.springframework.web.bind.annotation.RestControllerAdvice;
11. import org.springframework.web.method.HandlerMethod;
13. import java.util.HashMap;
14. import java.util.Map;
16. /**
17. * @desc:
18. * @author: sqnugy
19. * @date: 2025/5/8
20. **/
21. @RestControllerAdvice
22. @Slf4j
23. public class GlobalExceptionHandler {
25.     @ExceptionHandler(BusinessException.class)
26.     public CommonResult<?> handlerMallServiceException(BusinessException e) {
27.         log.error("业务异常", e);
28.         IErrorCode errorCode = e.getErrorCode();
29.         if (errorCode != null) {
30.             return CommonResult.failed(errorCode);
31.         }
32.         try {
33.             FeishuUtil.sendTextMsg("业务异常", e);
34.         } catch (Exception ignored) {}
35.         return CommonResult.failed(e.getMessage());
36.     }
38.     @ExceptionHandler(MethodArgumentNotValidException.class)
39.     public CommonResult<?> handlerValidException(MethodArgumentNotValidException e) {
40.         log.error("表单校验异常", e);
41.         Map<String, String> message = new HashMap<>();
42.         for (ObjectError error : e.getBindingResult().getAllErrors()) {
43.             FieldError fe = (FieldError) error;
44.             message.put(fe.getField(), error.getDefaultMessage());
45.         }
46.         try {
47.             FeishuUtil.sendTextMsg("参数校验异常", e);
48.         } catch (Exception ignored) {}
49.         return CommonResult.validateFailed("表单数据错误", message);
50.     }
52.     @ExceptionHandler(Exception.class)
53.     public CommonResult<?> handlerException(Exception e, HandlerMethod handlerMethod) {
54.         log.error("报错方法名字 [{}]", handlerMethod.getMethod().getName(), e);
55.         try {
56.             FeishuUtil.sendTextMsg("全局异常", e);
57.         } catch (Exception ignored) {}
58.         return CommonResult.failed("系统异常，请稍后重试");
59.     }
60. }

复制代码

2.3 飞书关照工具类

[code]import cn.hutool.http.HttpUtil;
import cn.jcs.boot.video.review.common.aspect.ApiContext;
import cn.jcs.boot.video.review.common.aspect.ApiContextHolder;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Map;

/**
* @desc:
* @author: sqnugy
* @date: 2025/5/8
**/
public class FeishuUtil {

    private static final String URL = "https://open.feishu.cn/open-apis/bot/v2/hook/xxx";

    /**
     * @param title 异常类型，如“业务异常”、“全局异常”
     * @param e     异常对象
     */
    public static void sendTextMsg(String title, Exception e) {
        ApiContext context = ApiContextHolder.get();
        String methodName = context != null ? context.getMethodName() : "未知方法";
        String className = context != null ? context.getClassName() : "未知类";
        String argsJson = context != null ? context.getArgsJson() : "无入参";

        // 使用 JsonUtils 格式化入参 JSON 并缩进
        String formattedArgs = JsonUtils.toJsonPrettyString(JsonUtils.parseObject(argsJson, Object.class));

        // 获取异常堆栈
        StringWriter sw = new StringWriter();
        e.printStackTrace(new PrintWriter(sw));
        String stackTrace = sw.toString();

        String msg = String.format(
                "❗ %s 异常告警\n" +
                        "