Spring Boot 高级用法 AOP 自定义注解实现日志

简介: Spring Boot 高级用法 AOP 自定义注解实现日志

Spring Boot AOP 自定义注解实现日志:

在实际开发中,我们经常需要对某些方法进行分类,例如,有些方法需要记录日志,有些则不需要记录日志。使用 AOP ,我们可以通过自定义注解,来标注需要记录日志的方法,以达到只记录需要监控的方法的效果。这种方法可以避免对整个应用程序的日志方式进行改变,做到减少误操作,提高代码复用率。

以下是使用自定义注解实现接口调用日志打印的步骤:

步骤一:定义注解

首先,我们需要定义一个注解 @Log,我们可以在需要监控的方法上添加这个注解,来标记这个方法需要对其进行记录日志操作。

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
    /**
     * 日志描述信息
     */
    String value() default "";
}

步骤二:定义切面

@Log 所在的目录下,我们定义一个切面类 LogAspect,当在方法上添加了 @Log 注解时,切面就会自动织入。切面中的逻辑依然是在方法之前和方法之后打印一行文本信息。

@Aspect
@Component
@Slf4j
public class LogAspect {
    @Pointcut("@annotation(com.example.demo.annotation.Log)")
    private void logPointCut() {
    }
    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        Log logAnnotation = method.getAnnotation(Log.class);
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        String logDesc = StrUtil.isBlank(logAnnotation.value()) ? "未知方法" : logAnnotation.value();
        log.info("【日志注解】开始执行 -- {}:{} {}", className, methodName, logDesc);
        Object result = joinPoint.proceed();
        log.info("【日志注解】执行结束 -- {}:{} {}", className, methodName, logDesc);
        return result;
    }
}

在上面的代码中,我们通过 @Pointcut@Around 注解指定了织入的切点和通知类型,使其织入被注解的方法中。

步骤三:定义 Controller 类和测试接口

Controller 类中,我们在方法上添加了 @Log 注解,将这个方法打上需要记录日志的标签。

@RestController
public class DemoController {
    @GetMapping("/demo1")
    @Log("测试一")
    public String demo1() {
        return "demo1";
    }
    @GetMapping("/demo2")
    public String demo2() {
        return "demo2";
    }
}

结语

到这里,我们就实现了使用自定义注解 @Log 搭配 AOP 实现记录方法调用日志的功能。在实际项目中,我们可以根据需求自定义不同的注解,比如在身份认证、接口访问控制、定时任务监控等方面,提高日志处理的灵活性和效率。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
1天前
|
监控 Java Spring
自定义注解+AOP切面日志+源码
自定义注解+AOP切面日志+源码
10 1
|
1天前
|
XML 监控 Java
Java一分钟之-Spring AOP:基于Spring的AOP
【6月更文挑战第13天】Spring框架集成AOP支持,便于实现如日志、监控和事务管理等关注点的集中管理。本文探讨Spring AOP的核心概念(切面、切入点、通知和代理),常见问题(代理对象理解不清、切入点表达式错误、通知类型混淆和事务管理配置不当)及其对策,并提供注解式日志记录代码示例。通过学习和实践,开发者能更好地运用Spring AOP提升代码质量。
14 2
|
5天前
|
Java 调度 Spring
SpringBoot多个@Scheduled注解的方法,会阻塞吗
【6月更文挑战第9天】SpringBoot多个@Scheduled注解的方法,会阻塞吗
17 5
|
8天前
|
Java Spring
自定义注解+AOP
自定义注解+AOP
14 1
|
9天前
|
缓存 Java 数据库连接
探究Spring Boot中@PostConstruct注解的使用场景
【6月更文挑战第2天】在Spring Boot开发过程中,了解和合理利用@PostConstruct注解是非常重要的。这个简单却强大的注解能够帮助开发者在依赖注入完成之后执行初始化逻辑,从而确保组件在使用前已经完全准备就绪。
20 4
|
11天前
|
Java Spring
【JavaEE进阶】 Spring AOP源码简单剖析
【JavaEE进阶】 Spring AOP源码简单剖析
|
11天前
|
Java Spring
【JavaEE进阶】 Spring AOP详解
【JavaEE进阶】 Spring AOP详解
|
11天前
|
数据采集 Java 程序员
【JavaEE进阶】 Spring AOP快速上手
【JavaEE进阶】 Spring AOP快速上手
|
16天前
|
Java Spring
|
17天前
|
Java Spring

热门文章

最新文章