使用aop实现日志管理

1.引入依赖

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

2.SQL的表结构

CREATE TABLE `operate_log` (
  `id` varchar(32) NOT NULL,
  `create_time` datetime DEFAULT NULL COMMENT '调用时间',
  `type` varchar(20) DEFAULT NULL COMMENT '接口类型',
  `request_value` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求值',
  `return_value` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '返回值',
  `caller` varchar(32) DEFAULT NULL COMMENT '调用者',
  `description` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '描述',
  `tenant_id` varchar(32) DEFAULT NULL COMMENT '租户id',
  `branch_code` varchar(32) DEFAULT NULL COMMENT '车间编码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='操作日志';

3.依次写入entity，dao，service

@TableName(value ="operate_log")
//@Data
public class OperateLog implements Serializable {
    /**
     * 
     */
    @TableId(type = IdType.ASSIGN_UUID)
    private String id;

    /**
     * 调用时间
     */
    private Date createTime;

    /**
     * 接口类型
     */
    private String type;

    /**
     * 请求值
     */
    private String requestValue;

    /**
     * 返回值
     */
    private String returnValue;

    /**
     * 调用者
     */
    private String caller;

    /**
     * 描述
     */
    private String description;

    /**
     * 租户id
     */
    private String tenantId;

    /**
     * 车间编码
     */
    private String branchCode;

    @TableField(exist = false)
    private static final long serialVersionUID = 1L;

    public OperateLog() {}

    public OperateLog(String desc, String result,String caller, String value,String type) {
        this.id = UUID.randomUUID().toString().replaceAll("-", "");
        this.createTime = new Date();
        this.description = desc;
        this.caller = caller;
        this.returnValue = result;
        this.requestValue = String.valueOf(value);
        this.type = type;
    }

public interface OperateLogMapper extends BaseMapper<OperateLog> {
}

public interface OperateLogService extends IService<OperateLog> {
}

@Service
public class OperateLogServiceImpl extends ServiceImpl<OperateLogMapper, OperateLog>
    implements OperateLogService {
}

4.定义切面，并实现自定义注解

@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行s
@Documented //生成文档
public @interface OperationLog {

    /**
     * 描述
     * @return
     */
    String desc() default "";

    /**
     * 调用者
     * @return
     */
    String caller() default "";
}

@Aspect
@Component
public class OperationLogAspect {

    @Autowired
    private OperateLogService operateLogService;

    /**
     * 定义切点 在注解的位置切入代码
     */
    @Pointcut("@annotation(OperationLog)")
    public void logsPoinCut() {
    }

    /**
     * 切面 配置通知
     */
    @Around(value = "logsPoinCut()")
    public Object saveLog(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        Object proceed = proceedingJoinPoint.proceed();
        try {
            MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();
            OperationLog annotation = methodSignature.getMethod().getAnnotation(OperationLog.class);
            // 请求类型
            String type = annotation.desc();
            // 调用者
            String caller = annotation.caller();
            // 结果
            Result result = (Result) proceed;
            // 调用结果
            String returnValue =String.valueOf(result.getMsg());
            // 详情
            String desc = String.valueOf(result.getData());
            // 获取参数名及参数值
            Map<String, Object> map = new HashMap<String, Object>(5);
            Object[] values = proceedingJoinPoint.getArgs();
            String[] names = ((CodeSignature) proceedingJoinPoint.getSignature()).getParameterNames();
            for (int i = 0; i < names.length; i++) {
                map.put(names[i], values[i]);
            }
            String value = String.valueOf(map);
            OperateLog operateLog = new OperateLog(desc, returnValue, caller, value, type);
            operateLogService.save(operateLog);
        } catch (Exception e) {
            e.printStackTrace();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return proceed;
    }

5.在controller层添加自定义注解，实现代码无侵入，满足开闭原则

 @OperationLog(desc = "login" , caller = "admin")
    @PostMapping("/login")
    public Result<User> userLogin(@RequestBody User userParam) {
        if (userParam == null) {
            return Result.error("-1", "用户未输入值");
        }
        User user = userService.userLogin(userParam.getUsername(), userParam.getPassword());
        if (user == null) {
            return Result.error("-1", "用户名或密码错误");
        }
        return Result.success(user);
    }

结果展示