AOP实现操作日志

本文介绍如何通过AOP(面向切面编程)来实现系统操作日志的记录,包括创建注解定义切面以及配置切面和切入点的详细步骤。

创建注解(也可以不创建,作用是定义切面)

package com.fccy.gallery.sys.log;

import java.lang.annotation.*;

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {

    String obj() default "";
    String type() default "";
}

配置切面和切入信息

/**
     * 将所有使用到@LogAnnotation注解的地方定义为切面(也可以指定别的切面)
     */
    @Pointcut("@annotation(com.fccy.gallery.sys.log.LogAnnotation)")
    public void logPointCut(){}

    /**
     * 给切面绑定最终事件
     * 添加操作日志
     */
    @After("logPointCut()")
    public void logSave(JoinPoint pjp){
    	//日志入库操作
    }
<think>好的,我现在需要帮助用户了解如何使用AOP实现操作日志记录的最佳实践和示例代码。首先,我得回忆一下AOP的基本概念,确保自己理解正确。AOP,面向切面编程,主要用于将横切关注点(如日志、安全、事务等)与核心业务逻辑分离。用户的问题集中在操作日志的记录上,所以需要围绕这个展开。 接下来,我需要整理最佳实践。根据用户提供的引用内容,引用[2]提到了性能优化,比如禁用高频方法的参数日志,使用合适的日志级别,优化大型对象的toString方法。这些都是需要考虑的点。引用[4]提到了使用切面来拦截服务方法,并在方法调用前记录日志。此外,可能还需要考虑日志的格式统一、异常处理、异步记录等。 然后,示例代码部分。用户给的引用中有Python的快速排序示例,但Spring AOP通常用Java,所以示例代码应该是Java的。需要确保代码符合Spring AOP的写法,比如使用@Aspect注解,定义切点,编写通知方法。同时,代码中要展示如何记录方法名、参数、执行时间、结果和异常,这点在引用[4]的示例中有类似的结构,可以借鉴。 另外,用户提供的引用[3]提到AOP与IoC的结合,所以在代码示例中需要体现Spring管理的Bean,比如使用@Component注解的切面类,以及通过Spring IoC容器来管理依赖。 还要考虑如何自然地引用用户提供的参考资料。比如在提到性能优化时,引用[2]中的建议;在切面示例时,引用[4]的代码结构。需要确保引用标识正确,比如[^2]、[^4]等。 最后,生成相关问题。根据用户之前的示例,问题应该围绕在AOP日志记录的细节、优化、与其他技术的整合等方面。比如如何防止日志过多影响性能,如何与具体业务结合,或者如何扩展日志功能等。 现在需要检查是否所有要点都覆盖到了:最佳实践的几个方面,示例代码的正确性,引用标注的位置,以及相关问题的合理性。确保回答结构清晰,分步骤说明,并且语言自然,符合中文表达习惯。</think>### 通过 AOP 实现操作日志记录的最佳实践 #### 1. **核心实现步骤** - **切面定义**:通过注解`@Aspect`声明切面类,定义日志记录规则。 - **切点选择**:使用`@Pointcut`指定需要拦截的方法(如标记自定义注解或按包路径筛选)。 - **通知逻辑**:通过`@Around`或`@AfterReturning`等通知类型记录方法参数、返回值、执行时间等信息。 - **异步处理**:结合异步线程池避免日志记录阻塞主流程。 #### 2. **最佳实践** 1. **性能优化** - 高频方法禁用参数日志(`logParams = false`) - 使用`INFO`级别以上日志(生产环境) - 对复杂对象重写`toString()`避免序列化开销 2. **解耦设计** - 通过自定义注解(如`@Loggable`)标记需记录的方法,而非硬编码包路径 - 分离日志格式生成逻辑(如使用`LogFormatter`工具类) 3. **容错处理** - 在通知方法内捕获异常,避免影响主流程 - 添加降级策略(如日志写入本地文件备用) --- ### 示例代码(Spring AOP + Java) ```java @Aspect @Component public class OperationLogAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); // 定义切点:标记@Loggable注解的方法 @Pointcut("@annotation(com.example.annotation.Loggable)") public void loggableMethods() {} @Around("loggableMethods()") public Object logOperation(ProceedingJoinPoint joinPoint) throws Throwable { long startTime = System.currentTimeMillis(); Object result = null; try { // 执行原方法 result = joinPoint.proceed(); // 记录成功日志 logger.info("[操作日志] 方法: {}, 参数: {}, 耗时: {}ms, 结果: {}", joinPoint.getSignature().getName(), Arrays.toString(joinPoint.getArgs()), System.currentTimeMillis() - startTime, result); } catch (Exception e) { // 记录异常日志 logger.error("[操作日志] 方法: {} 异常: {}", joinPoint.getSignature().getName(), e.getMessage()); throw e; } return result; } } ``` #### 自定义注解 `@Loggable` ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Loggable { boolean logParams() default true; // 是否记录参数 String module() default ""; // 模块分类 } ``` --- ### 关键优化点 1. **动态开关参数日志** 通过`@Loggable(logParams=false)`控制敏感或高频方法的参数输出。 2. **模块分类标识** 利用`module()`字段区分业务模块(如`module="用户管理"`)。 3. **异步记录** 添加`@Async`注解并配置线程池,将日志写入操作异步化: ```java @Async("logThreadPool") public void saveLog(LogRecord record) { // 持久化到数据库或文件 } ``` ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值