springboot自定义注解代码示例：创建一个自定义注解来实现日志的打印收集功能

淩亂°似流年 2023-10-16 14:15 10阅读 0赞

下面是一个示例，展示如何创建一个自定义注解来实现日志的打印收集功能：

首先，创建一个名为 `LogCollect` 的自定义注解：

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Target(ElementType.METHOD) // 指定注解的作用目标为方法
    @Retention(RetentionPolicy.RUNTIME) // 指定注解在运行时可见
    public @interface LogCollect {
        
    }

接下来，创建一个切面类 `LogCollectAspect`，用于捕获带有 `LogCollect` 注解的方法，并进行日志打印收集：

import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    @Aspect
    @Component
    public class LogCollectAspect {
        
    
        private Logger logger = LoggerFactory.getLogger(LogCollectAspect.class);
    
        @Pointcut("@annotation(LogCollect)")
        public void logCollectPointcut() {
        }
    
        @Before("logCollectPointcut()")
        public void beforeLogCollect(JoinPoint joinPoint) {
        
            String methodName = joinPoint.getSignature().getName();
            logger.info("Method '{}' is being executed.", methodName);
        }
    
        @AfterReturning(value = "logCollectPointcut()", returning = "result")
        public void afterLogCollect(JoinPoint joinPoint, Object result) {
        
            String methodName = joinPoint.getSignature().getName();
            logger.info("Method '{}' execution completed. Result: {}", methodName, result);
        }
    }

在上述代码中，`LogCollectAspect` 类使用 Spring AOP 的切面功能来捕获带有 `LogCollect` 注解的方法。在方法执行前和执行后，分别打印日志来收集方法的执行信息。

最后，在 Spring Boot 应用程序的入口类或配置类上添加 `@EnableAspectJAutoProxy` 注解，以启用 Spring AOP 的自动代理功能。

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.EnableAspectJAutoProxy;
    
    @SpringBootApplication
    @EnableAspectJAutoProxy // 启用自动代理
    public class MyApp {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(MyApp.class, args);
        }
    }

现在，您可以在任何希望进行日志打印收集的方法上添加 `@LogCollect` 注解，该方法的执行前和执行后将会打印相应的日志信息。

@LogCollect
    public void myMethod() {
        
        // 方法体
        // 日志将会被打印收集
    }

请注意，此示例仅展示了如何通过自定义注解和切面实现日志的打印收集功能。实际的日志记录和收集操作可能需要结合具体的日志框架（如 Logback、Log4j）或其他工具来实现。