spring-boot-route（十七）使用aop記錄操作日志

本文轉載自查看原文 2020-10-17 10:54 569 spring-boot-route

在上一章內容中——使用logback管理日志，我們詳細講述了如何將日志生成文件進行存儲。但是在實際開發中，使用文件存儲日志用來快速查詢問題並不是最方便的，一個優秀系統除了日志文件還需要將操作日志進行持久化，來監控平台的操作記錄。今天我們一起來學習一下如何通過apo來記錄日志。

為了讓記錄日志更加靈活，我們將使用自定義的注解來實現重要操作的日志記錄功能。

一日志記錄表

日志記錄表主要包含幾個字段，業務模塊，操作類型，接口地址，處理狀態，錯誤信息以及操作時間。數據庫設計如下：

CREATE TABLE `sys_oper_log` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '日志主鍵',
   `title` varchar(50) CHARACTER SET utf8 DEFAULT '' COMMENT '模塊標題',
   `business_type` int(2) DEFAULT '0' COMMENT '業務類型（0其它 1新增 2修改 3刪除）',
   `method` varchar(255) CHARACTER SET utf8 DEFAULT '' COMMENT '方法名稱',
   `status` int(1) DEFAULT '0' COMMENT '操作狀態（0正常 1異常）',
   `error_msg` varchar(2000) CHARACTER SET utf8 DEFAULT '' COMMENT '錯誤消息',
   `oper_time` datetime DEFAULT NULL COMMENT '操作時間',
   PRIMARY KEY (`id`)
 ) ENGINE=InnoDB CHARSET=utf8mb4 CHECKSUM=1 COMMENT='操作日志記錄'

對應的實體類如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class SysOperLog implements Serializable {
    private static final long serialVersionUID = 1L;

    /** 日志主鍵 */
    private Long id;

    /** 操作模塊 */
    private String title;

    /** 業務類型（0其它 1新增 2修改 3刪除） */
    private Integer businessType;

    /** 請求方法 */
    private String method;

    /** 錯誤消息 */
    private String errorMsg;

    private Integer status;

    /** 操作時間 */
    private Date operTime;
}

二自定義注解及處理

自定義注解包含兩個屬性，一個是業務模塊title，另一個是操作類型businessType。

@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 模塊
     */
    String title() default "";

    /**
     * 功能
     */
    BusinessType businessType() default BusinessType.OTHER;
}

使用aop對自定義的注解進行處理

@Aspect
@Component
@Slf4j
public class LogAspect {

    @Autowired
    private AsyncLogService asyncLogService;

    // 配置織入點
    @Pointcut("@annotation(com.javatrip.aop.annotation.Log)")
    public void logPointCut() {}

    /**
     * 處理完請求后執行
     *
     * @param joinPoint 切點
     */
    @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
    public void doAfterReturning(JoinPoint joinPoint, Object jsonResult) {
        handleLog(joinPoint, null, jsonResult);
    }

    /**
     * 攔截異常操作
     * 
     * @param joinPoint 切點
     * @param e 異常
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
        handleLog(joinPoint, e, null);
    }

    protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult) {
        try {
            // 獲得注解
            Log controllerLog = getAnnotationLog(joinPoint);
            if (controllerLog == null) {
                return;
            }

            SysOperLog operLog = new SysOperLog();
            operLog.setStatus(0);
            if (e != null) {
                operLog.setStatus(1);
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 設置方法名稱
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            // 處理設置注解上的參數
            getControllerMethodDescription(joinPoint, controllerLog, operLog);
            // 保存數據庫
            asyncLogService.saveSysLog(operLog);
        } catch (Exception exp) {
            log.error("==前置通知異常==");
            log.error("日志異常信息 {}", exp);
        }
    }

    /**
     * 獲取注解中對方法的描述信息 用於Controller層注解
     * 
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, SysOperLog operLog) {
        // 設置action動作
        operLog.setBusinessType(log.businessType().ordinal());
        // 設置標題
        operLog.setTitle(log.title());
    }

    /**
     * 是否存在注解，如果存在就獲取
     */
    private Log getAnnotationLog(JoinPoint joinPoint) {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method != null) {
            return method.getAnnotation(Log.class);
        }
        return null;
    }
}

操作類型的枚舉類：

public enum BusinessType {
    /**
     * 其它
     */
    OTHER,

    /**
     * 新增
     */
    INSERT,

    /**
     * 修改
     */
    UPDATE,

    /**
     * 刪除
     */
    DELETE,
}

使用異步方法將操作日志存庫，為了方便我直接使用jdbcTemplate在service中進行存庫操作。

@Service
public class AsyncLogService {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    /**
     * 保存系統日志記錄
     */
    @Async
    public void saveSysLog(SysOperLog log) {

        String sql = "INSERT INTO sys_oper_log(title,business_type,method,STATUS,error_msg,oper_time) VALUES(?,?,?,?,?,?)";
        jdbcTemplate.update(sql,new Object[]{log.getTitle(),log.getBusinessType(),log.getMethod(),log.getStatus(),log.getErrorMsg(),new Date()});
    }
}

三編寫接口測試

將自定義注解寫在業務方法上，測試效果

@RestController
@RequestMapping("person")
public class PersonController {
    @GetMapping("/{name}")
    @Log(title = "system",businessType = BusinessType.OTHER)
    public Person getPerson(@PathVariable("name") String name, @RequestParam int age){
        return new Person(name,age);
    }

    @PostMapping("add")
    @Log(title = "system",businessType = BusinessType.INSERT)
    public int addPerson(@RequestBody Person person){
        if(StringUtils.isEmpty(person)){
            return -1;
        }
        return 1;
    }

    @PutMapping("update")
    @Log(title = "system",businessType = BusinessType.UPDATE)
    public int updatePerson(@RequestBody Person person){
        if(StringUtils.isEmpty(person)){
            return -1;
        }
        return 1;
    }

    @DeleteMapping("/{name}")
    @Log(title = "system",businessType = BusinessType.DELETE)
    public int deletePerson(@PathVariable(name = "name") String name){
        if(StringUtils.isEmpty(name)){
            return -1;
        }
        return 1;
    }
}

當然，還可以在數據庫中將請求參數和響應結果也進行存儲，這樣就能看出具體接口的操作記錄了。