SpringBoot实战：轻松使用AOP+注解实现操作日志记录

2024-11-29 19:39

短信预约 -IT技能 免费直播动态提醒

AOP简介

AOP（Aspect Oriented Programming）面向切面编程，是对OOP（Object-Oriented Programming）的一种补充。它允许开发者在不修改源代码的情况下增加额外的功能，如日志记录、事务管理、权限控制等。在SpringBoot中，AOP通过注解和动态代理实现，极大地简化了横切关注点的管理。

环境准备

JDK版本：JDK 17
Spring Boot版本：Spring Boot 3.2.2
MySQL版本：8.0.37
构建工具：Maven

确保项目中包含Spring AOP的依赖：


    org.springframework.boot
    spring-boot-starter-aop

数据库设计

首先，需要创建一个操作日志记录表，用于存储日志信息。以下是一个简单的操作日志表结构示例：

CREATE TABLE `sys_oper_log` (
  `id` bigint NOT NULL AUTO_INCREMENT,
  `title` varchar(50) DEFAULT NULL COMMENT '模块',
  `business_type` varchar(20) DEFAULT NULL COMMENT '业务类型',
  `method` varchar(100) DEFAULT NULL COMMENT '方法名称',
  `request_method` varchar(10) DEFAULT NULL COMMENT '请求方式',
  `operator_type` varchar(10) DEFAULT NULL COMMENT '操作类别',
  `oper_name` varchar(50) DEFAULT NULL COMMENT '操作人员',
  `oper_url` varchar(255) DEFAULT NULL COMMENT '请求URL',
  `oper_ip` varchar(50) DEFAULT NULL COMMENT '主机地址',
  `oper_param` text COMMENT '请求参数',
  `json_result` text COMMENT '返回参数',
  `status` int DEFAULT NULL COMMENT '操作状态',
  `error_msg` varchar(200) DEFAULT NULL COMMENT '错误消息',
  `oper_time` datetime DEFAULT NULL COMMENT '操作时间',
  `execute_time` bigint DEFAULT NULL COMMENT '执行时长',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='操作日志记录';

创建实体类

对应上述数据库表，创建一个系统日志实体类SysOperLog，使用Lombok简化代码：

@Data
@Schema(description = "操作日志记录")
@TableName(value = "sys_oper_log")
public class SysOperLog implements Serializable {
    // 省略字段定义，参考数据库表结构
}

创建注解

定义一个自定义注解@Log，用于标记需要记录日志的方法：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    String title() default "";
    BusinessType businessType() default BusinessType.OTHER;
    boolean isSaveRequestData() default true;
    boolean isSaveResponseData() default true;
    String[] excludeParamNames() default {};
}

// 业务操作类型枚举
public enum BusinessType {
    OTHER, INSERT, UPDATE, DELETE
    // 可根据实际需要扩展
}

创建切面类

使用@Aspect注解定义一个切面类LogAspect，用于拦截带有@Log注解的方法，并记录日志：

@Aspect
@Component
public class LogAspect {

    @Autowired
    private SysOperLogService sysOperLogService; // 假设的日志服务

    @Pointcut("@annotation(com.example.demo.annotation.Log)")
    public void logPointcut() {}

    @Around("logPointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = joinPoint.proceed();
        long executeTime = System.currentTimeMillis() - startTime;

        // 收集日志信息，这里仅为示例
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Log logAnnotation = signature.getMethod().getAnnotation(Log.class);
        // 省略日志信息组装过程

        // 保存日志
        sysOperLogService.saveLog(log); // 假设的保存日志方法

        return result;
    }
}

注意：这里的saveLog方法需要根据实际业务逻辑进行实现，包括日志信息的详细组装和数据库保存操作。

使用注解

在需要记录日志的方法上添加@Log注解：

@Service
public class SomeService {

    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    public void updateUserInfo(UserInfo userInfo) {
        // 业务逻辑
    }
}