SpringBoot实现操作日志记录的完整指南

@Data
public class OperateLog {
    private Long id; //主键
    private Long userId; //操作人id
    private Date createTime; //创建时间
    private String description; //请求描述
    private String method; //请求方法 如：post、get
    private String ip; //操作人ip
    private String param; //请求参数：json格式
    private String result; //请求结果：json格式
    private Integer success; //操作是否成功
    private String errorMsg; //错误信息
}

create table operate_log(
	id BIGINT PRIMARY key AUTO_INCREMENT COMMENT '主键',
	user_id BIGINT DEFAULT 100 COMMENT '操作人id',
	create_time datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
	description VARCHAR(200) COMMENT '请求描述',
	method VARCHAR(20) COMMENT '请求方法 如：post、get',
	ip VARCHAR(32) COMMENT '操作人ip',
	param VARCHAR(2000) COMMENT '请求参数：json格式',
	result VARCHAR(2000) COMMENT '请求结果：json格式',
	success TINYINT DEFAULT 0 COMMENT '操作是否成功：1是、0否',
	error_msg VARCHAR(2000) COMMENT '错误消息'
) COMMENT '操作日志记录表';

//mapper接口
public interface OperateLogMapper extends BaseMapper<OperateLog> {}

//service接口
public interface OperateLogService extends IService<OperateLog> {}

//service实现类
@Service
public class OperateLogServiceImpl extends ServiceImpl<OperateLogMapper, OperateLog> implements OperateLogService {}

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

@Aspect
@Component
public class LogAspect {
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);
    @Autowired
    private OperateLogService logService;

    private final ExecutorService executor = Executors.newSingleThreadExecutor();

    /**
     * 请求前执行
     * @param aspLog
     */
    @Before(value = "@annotation(aspLog)")
    public void doBefore(Log aspLog){
        log.info("请求日志记录start");
    }

    /**
     * 请求后执行
     * @param aspLog
     * @param result
     */
    @AfterReturning(pointcut = "@annotation(aspLog)",returning = "result")
    public void doAfterReturning(JoinPoint joinPoint, Log aspLog, Object result){
        handleLog(joinPoint,aspLog,null,result);
    }

    /**
     * 请求异常执行
     * @param aspLog
     * @param e
     */
    @AfterThrowing(value = "@annotation(aspLog)", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint,Log aspLog,Exception e){
        handleLog(joinPoint,aspLog,e,null);
    }

    /**
     * 日志处理器-记录日志
     * @param aspLog
     * @param e
     * @param result
     */
    private void handleLog(JoinPoint joinPoint,Log aspLog,Exception e,Object result){
        ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
        OperateLog operateLog = new OperateLog();
        operateLog.setIp(attributes.getRequest().getRemoteAddr());
        operateLog.setMethod(attributes.getRequest().getMethod());
        String param = JSON.toJSONString(joinPoint.getArgs());
        operateLog.setParam(param);
        if(e != null){
            operateLog.setErrorMsg(e.getLocalizedMessage());
        }else{
            operateLog.setSuccess(1);
            operateLog.setResult(JSON.toJSONString(result));
        }
        operateLog.setDescription(aspLog.title());
        executor.submit(() -> logService.save(operateLog));
    }
}

@RestController
public class TestController {
    @Log(title = "测试操作")
    @GetMapping("/test")
    public String test(){
        return "没毛病";
    }

    @Log(title = "测试参数操作")
    @PostMapping("/testParam")
    public String testParam(@RequestBody String data){
        return data;
    }

    @Log(title = "测试异常操作")
    @GetMapping("/testExecption")
    public String testExecption(){
        return (1/0)+"";
    }
}