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

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 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 实现记录方法调用日志的功能。在实际项目中,我们可以根据需求自定义不同的注解,比如在身份认证、接口访问控制、定时任务监控等方面,提高日志处理的灵活性和效率。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
目录
相关文章
|
3月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
429 0
|
3月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
298 12
|
11月前
|
XML Java 开发者
Spring Boot中的AOP实现
Spring AOP(面向切面编程)允许开发者在不修改原有业务逻辑的情况下增强功能,基于代理模式拦截和增强方法调用。Spring Boot通过集成Spring AOP和AspectJ简化了AOP的使用,只需添加依赖并定义切面类。关键概念包括切面、通知和切点。切面类使用`@Aspect`和`@Component`注解标注,通知定义切面行为,切点定义应用位置。Spring Boot自动检测并创建代理对象,支持JDK动态代理和CGLIB代理。通过源码分析可深入了解其实现细节,优化应用功能。
528 6
|
9月前
|
Java API 微服务
微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——Spring Boot 中的 AOP 处理
本文详细讲解了Spring Boot中的AOP(面向切面编程)处理方法。首先介绍如何引入AOP依赖,通过添加`spring-boot-starter-aop`实现。接着阐述了如何定义和实现AOP切面,包括常用注解如`@Aspect`、`@Pointcut`、`@Before`、`@After`、`@AfterReturning`和`@AfterThrowing`的使用场景与示例代码。通过这些注解,可以分别在方法执行前、后、返回时或抛出异常时插入自定义逻辑,从而实现功能增强或日志记录等操作。最后总结了AOP在实际项目中的重要作用,并提供了课程源码下载链接供进一步学习。
1084 0
|
9月前
|
Java 开发者 微服务
微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——什么是AOP
本文介绍了Spring Boot中的切面AOP处理。AOP(Aspect Oriented Programming)即面向切面编程,其核心思想是分离关注点。通过AOP,程序可以将与业务逻辑无关的代码(如日志记录、事务管理等)从主要逻辑中抽离,交由专门的“仆人”处理,从而让开发者专注于核心任务。这种机制实现了模块间的灵活组合,使程序结构更加可配置、可扩展。文中以生活化比喻生动阐释了AOP的工作原理及其优势。
524 0
|
11月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
793 8
|
监控 安全 Java
什么是AOP?如何与Spring Boot一起使用?
什么是AOP?如何与Spring Boot一起使用?
870 5
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
290 1
|
7月前
|
监控 容灾 算法
阿里云 SLS 多云日志接入最佳实践:链路、成本与高可用性优化
本文探讨了如何高效、经济且可靠地将海外应用与基础设施日志统一采集至阿里云日志服务(SLS),解决全球化业务扩展中的关键挑战。重点介绍了高性能日志采集Agent(iLogtail/LoongCollector)在海外场景的应用,推荐使用LoongCollector以获得更优的稳定性和网络容错能力。同时分析了多种网络接入方案,包括公网直连、全球加速优化、阿里云内网及专线/CEN/VPN接入等,并提供了成本优化策略和多目标发送配置指导,帮助企业构建稳定、低成本、高可用的全球日志系统。
816 54