Springboot接口项目如何使用AOP记录日志

Springboot 接口项目如何使用 AOP 记录日志 在软件开发中，日志记录是一项非常重要的任务，它可以帮助我们追踪程序的执行过程， debug 错误，优化性能等。但是，传统的日志记录方式通常需要在代码中添加大量的日志语句，这不仅增加了代码的复杂度，还可能会影响程序的性能。为了解决这个问题，我们可以使用 AOP（Aspect-Oriented Programming，面向切面编程）技术来实现日志记录。 AOP 是一种编程范式，它可以将横切关注点与业务逻辑分离，从而提高代码的可维护性和可扩展性。在 Spring Boot 项目中，我们可以使用 AOP 来记录日志，从而实现统一的日志收集系统。 下面我们将详细介绍如何使用 AOP 在 Spring Boot 项目中记录日志。 背景 在软件开发中，日志记录是一项非常重要的任务，它可以帮助我们追踪程序的执行过程， debug 错误，优化性能等。但是，传统的日志记录方式通常需要在代码中添加大量的日志语句，这不仅增加了代码的复杂度，还可能会影响程序的性能。为了解决这个问题，我们需要构建一个统一的日志收集系统，使用 AOP 技术来实现日志记录。 环境 本文基于 Spring Boot 项目，使用 MySQL 5.7.9 版本作为数据库，JDK 版本为 1.8。 说明 在本文中，我们将使用数据库来存储日志信息，后续考虑使用 Elasticsearch 等工具来存储日志信息。 内容 ### 构建日志采集实体类 我们需要构建一个日志采集实体类，用于存储日志信息。该类名为 `BaseLogMessage`： ```java public class BaseLogMessage { private String serverIP; private String appName; private String method; private String type; private String userCode; private String uri; private String operationName; private String operationStatus; private long startTime; private Object parameter; private Object result; private int SpendTime; // 此处省略 get、set } ``` ### 构建配置文件读取类 我们需要构建一个配置文件读取类，用于读取配置文件中的系统名称。该类名为 `SystemPropetiesUtil`： ```java @Configuration public class SystemPropetiesUtil { @Value("${spring.application.name}") private String sysName; // 系统名称 // 此处省略 get、set } ``` ### 构建 AOP 类 我们需要构建一个 AOP 类，用于记录日志信息。该类名为 `LogAspect`： ```java @Aspect @Component public class LogAspect { @Autowired private SystemPropetiesUtil systemPropetiesUtil; // 定义切点方法 @Pointcut("execution(public * cq..campus.prevented.controller.*.*(..))") public void controllerLog() { } public static final Logger LOGGER = LoggerFactory.getLogger(LogAspect.class); @Around("controllerLog()") public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable { long startTime = System.currentTimeMillis(); // 获取当前请求对象 ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 记录请求信息 BaseLogMessage baseLogMessage = new BaseLogMessage(); // 1. 获取到所有的参数值的数组 Object[] args = joinPoint.getArgs(); Signature signature = joinPoint.getSignature(); MethodSignature methodSignature = (MethodSignature) signature; // 2. 获取到方法的所有参数名称的字符串数组 String[] parameterNames = methodSignature.getParameterNames(); Object result = joinPoint.proceed(); Method method = methodSignature.getMethod(); if (method.isAnnotationPresent(ApiOperation.class)) { // 记录日志信息 baseLogMessage.setAppName(systemPropetiesUtil.getSysName()); baseLogMessage.setMethod(method.getName()); baseLogMessage.setType("INFO"); baseLogMessage.setUserCode(request.getHeader("UserCode")); baseLogMessage.setUri(request.getRequestURI()); baseLogMessage.setOperationName(method.getAnnotation(ApiOperation.class).value()); baseLogMessage.setOperationStatus("SUCCESS"); baseLogMessage.setStartTime(startTime); baseLogMessage.setSpendTime(System.currentTimeMillis() - startTime); // 保存日志信息 // ... } return result; } } ``` 在上面的代码中，我们使用 `@Aspect` 注解来定义 AOP 类，并使用 `@Pointcut` 注解来定义切点方法。然后，我们使用 `@Around` 注解来定义环绕通知，在该通知中，我们可以记录日志信息。 使用 AOP 技术可以帮助我们轻松地记录日志信息，从而实现统一的日志收集系统。在本文中，我们只是简单地介绍了使用 AOP 记录日志的基本思路和实现方式，希望可以帮助大家更好地理解和应用 AOP 技术。