SpringBoot自定义注解实现方法调用前记录日志

"本文介绍了如何在Spring框架中使用自定义注解和Aspect实现特定功能，以一个简单的Spring Boot项目为例，逐步展示如何添加日志记录功能。" 在Spring框架中，自定义注解和AspectJ是两个强大的工具，它们可以帮助开发者实现更加灵活的代码组织和业务逻辑处理。本示例中，我们将学习如何通过这两个工具来实现在调用Controller方法前打印日志的功能。 1. 首先，项目准备阶段，创建了一个基础的Spring Boot应用，包括User实体类、UserDao、UserService以及UserController。这些组件共同构成了一个简单的用户查询系统，通过RESTful API（`/user/{id}`）获取用户信息。 2. 接下来，为了实现日志记录功能，我们不依赖传统的日志框架，而是利用Spring的AOP（面向切面编程）特性。AOP允许我们在程序运行时动态地插入代码，比如在方法执行前后插入日志打印。 3. 自定义注解：在项目中创建一个名为`@LogBefore`的自定义注解，用于标记需要在执行前打印日志的方法。注解的定义通常包含元数据，可以为空或包含一些属性，例如： ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface LogBefore { String value() default ""; } ``` 在这里，我们使用`@Target(ElementType.METHOD)`指定注解应用于方法，`@Retention(RetentionPolicy.RUNTIME)`确保注解在运行时可被解析。 4. 创建切面（Aspect）：接下来，创建一个名为`LoggingAspect`的类，该类将包含处理带有`@LogBefore`注解的方法的逻辑。我们需要使用`@Aspect`注解来声明这是一个切面，并使用`@Component`使其成为Spring管理的bean： ```java @Aspect @Component public class LoggingAspect { @Before("@annotation(logBefore)") public void logBefore(JoinPoint joinPoint, LogBefore logBefore) { // 获取方法名和参数 String methodName = joinPoint.getSignature().getName(); Object[] args = joinPoint.getArgs(); // 打印日志 System.out.println("Before calling method: " + methodName + " with arguments: " + Arrays.toString(args)); } } ``` 在`@Before`注解中，`@annotation(logBefore)`表示我们在寻找带有`@LogBefore`注解的方法。`joinPoint`提供了关于被拦截方法的信息，而`logBefore`则是被拦截方法上的`@LogBefore`注解实例。 5. 应用注解：现在，我们需要在UserService的`findUserById`方法上应用`@LogBefore`注解，以便在调用此方法之前触发日志打印： ```java @Service public class UserService { // ... @LogBefore public User findUserById(Integer id) { return userDao.findUserById(id); } } ``` 6. 最后，当我们通过`/user/6`访问Controller的`findUser`方法时，由于`findUserById`方法上有`@LogBefore`注解，所以`LoggingAspect`中的`logBefore`方法会在`findUserById`执行前被调用，从而在控制台打印出相应的日志信息。 通过这种方式，我们利用Spring的自定义注解和AOP特性，实现了在不修改原有业务代码的情况下，为特定方法添加日志记录的功能。这只是一个基础示例，实际开发中，自定义注解和AspectJ可以用于实现更多复杂的需求，如事务管理、性能监控等。