0

0

Java中AOP记录日志 解析切面编程

下次还敢

下次还敢

发布时间:2025-06-24 11:47:02

|

322人浏览过

|

来源于php中文网

原创

aop记录日志是通过定义切面、切点和通知,在不修改原有代码的情况下实现日志功能。1. 引入aop依赖,如spring项目使用spring-boot-starter-aop;2. 创建切面类,定义日志逻辑;3. 使用@pointcut定义切点,指定拦截的方法;4. 通过@before、@afterreturning等注解定义通知类型;5. 可使用@around记录方法执行时间;6. aop适用于多层通用逻辑,拦截器适用于特定框架请求处理。性能优化包括精确切点、异步日志、减少耗时操作等。

Java中AOP记录日志 解析切面编程

AOP记录日志,简单来说,就是用一种优雅的方式,在不修改原有代码的基础上,把日志记录功能“织入”到程序中。这能让代码更干净,更易于维护。

Java中AOP记录日志 解析切面编程

解决方案

Java中AOP记录日志 解析切面编程

AOP(Aspect-Oriented Programming,面向切面编程)在Java中用于记录日志,核心在于定义切面、切点和通知。

立即学习Java免费学习笔记(深入)”;

  1. 依赖引入: 首先,确保你的项目引入了AOP相关的依赖。如果是Spring项目,spring-boot-starter-aop 通常就足够了。对于非Spring项目,可以考虑AspectJ。

    Java中AOP记录日志 解析切面编程
    
    
        org.springframework.boot
        spring-boot-starter-aop
    
  2. 定义切面(Aspect): 切面是包含横切逻辑的类。它定义了在哪些地方(切点)以及何时(通知)应用这些逻辑。

    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;
    
    import java.util.Arrays;
    
    @Aspect
    @Component
    public class LoggingAspect {
    
        private final Logger logger = LoggerFactory.getLogger(this.getClass());
    
        // 定义切点:指定哪些方法需要被拦截
        @Pointcut("execution(* com.example.service.*.*(..))") // 拦截 service 包下的所有类的所有方法
        public void serviceMethods() {}
    
        // 前置通知:在方法执行前执行
        @Before("serviceMethods()")
        public void logMethodCall(JoinPoint joinPoint) {
            String methodName = joinPoint.getSignature().getName();
            Object[] args = joinPoint.getArgs();
            logger.info("调用方法: {},参数: {}", methodName, Arrays.toString(args));
        }
    
        // 后置通知:在方法成功执行后执行
        @AfterReturning(pointcut = "serviceMethods()", returning = "result")
        public void logMethodReturn(JoinPoint joinPoint, Object result) {
            String methodName = joinPoint.getSignature().getName();
            logger.info("方法 {} 返回值: {}", methodName, result);
        }
    
        // 异常通知:在方法抛出异常后执行 (可以省略,根据实际需求)
        // @AfterThrowing(pointcut = "serviceMethods()", throwing = "exception")
        // public void logMethodException(JoinPoint joinPoint, Throwable exception) {
        //     String methodName = joinPoint.getSignature().getName();
        //     logger.error("方法 {} 抛出异常: {}", methodName, exception.getMessage());
        // }
    }
  3. 定义切点(Pointcut): 切点定义了在哪里应用切面逻辑。可以使用表达式来精确匹配方法。execution(* com.example.service.*.*(..)) 这个表达式的意思是:拦截 com.example.service 包下所有类的所有方法。

  4. 定义通知(Advice): 通知定义了何时以及如何应用切面逻辑。常见的通知类型包括:

    • @Before: 在目标方法执行之前执行。
    • @AfterReturning: 在目标方法成功返回之后执行。
    • @AfterThrowing: 在目标方法抛出异常之后执行。
    • @After: 无论目标方法执行结果如何(成功或抛出异常),都会执行。
    • @Around: 环绕通知,可以完全控制目标方法的执行,包括是否执行、何时执行、以及修改输入和输出。
  5. 配置AOP: 如果是Spring Boot项目,通常不需要额外的配置,因为 spring-boot-starter-aop 会自动启用AOP。 如果是非Spring项目,可能需要手动配置AspectJ。

  6. 测试: 编写测试用例,验证日志记录是否正常工作。

AOP日志记录的性能影响有多大?如何优化?

Text-To-Song
Text-To-Song

免费的实时语音转换器和调制器

下载

AOP 引入的额外处理会带来一定的性能开销,但通常可以忽略不计,尤其是在 I/O 密集型应用中。不过,如果切点过于宽泛,拦截了大量的方法,或者通知中的逻辑过于复杂,性能影响就会变得明显。

优化策略:

  • 精确切点: 尽量使用精确的切点表达式,避免不必要的拦截。例如,只拦截需要记录日志的关键业务方法。
  • 异步日志: 将日志记录操作异步化,避免阻塞主线程。可以使用 java.util.concurrent 包中的线程池,或者使用专门的异步日志框架(如 Log4j2)。
  • 减少日志级别: 在生产环境中,将日志级别设置为 INFO 或 WARN,避免记录过多的 DEBUG 级别的日志。
  • 避免在通知中执行耗时操作: 尽量避免在通知中执行复杂的计算或 I/O 操作。如果必须执行,考虑使用缓存或其他优化手段。
  • 使用编译时 AOP: AspectJ 提供了编译时 AOP 的支持,可以在编译阶段将切面织入到代码中,避免运行时的性能开销。

如何使用AOP记录方法的执行时间?

使用 AOP 记录方法的执行时间,可以使用 @Around 通知。

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class ExecutionTimeAspect {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Pointcut("execution(* com.example.service.*.*(..))")
    public void serviceMethods() {}

    @Around("serviceMethods()")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();

        Object proceed = joinPoint.proceed(); // 执行目标方法

        long executionTime = System.currentTimeMillis() - start;

        logger.info("方法 {} 执行耗时: {} ms", joinPoint.getSignature().getName(), executionTime);

        return proceed;
    }
}

ProceedingJoinPoint 允许你控制目标方法的执行。 joinPoint.proceed() 会执行目标方法,并返回其结果。 通过计算方法执行前后时间差,可以得到方法的执行时间。

AOP和拦截器(Interceptor)有什么区别?什么时候使用AOP?什么时候使用拦截器?

AOP 和拦截器都是用于实现横切关注点的技术,但它们在实现方式和适用场景上有所不同。

  • AOP: 是一种通用的编程范式,可以用于解决各种横切关注点,如日志记录、安全检查、事务管理等。AOP 通常基于动态代理或字节码增强来实现。AOP 更加灵活,可以应用于更广泛的场景。
  • 拦截器: 通常是特定框架(如 Spring MVC、Servlet)提供的机制,用于拦截请求或方法调用。拦截器通常基于责任链模式来实现。拦截器通常用于处理与请求相关的横切关注点,如身份验证、授权、请求参数处理等。

选择:

  • AOP: 当需要解决通用的横切关注点,并且需要在多个层次(如服务层、数据访问层)应用相同的逻辑时,AOP 是一个更好的选择。
  • 拦截器: 当只需要处理与请求相关的横切关注点,并且只需要在特定的框架中使用时,拦截器可能更简单易用。

举例:

  • 如果需要在所有 Service 方法中记录日志,使用 AOP 更合适。
  • 如果只需要在 Controller 方法中进行身份验证,使用 Spring MVC 的拦截器可能更方便。

总之,选择 AOP 还是拦截器,取决于具体的应用场景和需求。没有绝对的优劣之分,只有更适合的选择。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

834

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

739

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

735

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

27

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 6.9万人学习

Java 教程
Java 教程

共578课时 | 46.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号