使用Aop实现自定义注解 - 实战篇（统一日志打印）

使用Aop实现自定义注解- 原理篇
使用Aop实现自定义注解 - 实战篇（统一日志打印）

统一日志打印

约定大于配置，系统提供对外的接口要有以下要求，这样的好处是我们可以对接口统一做定制化日志管理。比如只对更新接口打印入参。

1. 接口命名
   1. 单个查询接口，🌰 findById
   2. 批量查询接口，🌰 listByIds
   3. 单个更新接口，🌰 updateById
   4. 批量更新接口，🌰 batchUpdateById
   5. 单个新增接口，🌰 save
   6. 批量新增接口，🌰 batchSave
      

枚举定义

@Documented
@Inherited
@Retention(RUNTIME)
@Target({
   METHOD, TYPE})
public @interface TraceLogAnnotation {
   
    /**
     * 是否打印详细结果，有的结果非常大，影响性能
     */
    boolean isNeedPrintResult() default true;

    /**
     * 是否打印入参，有的参数非常大，影响性能
     */
    boolean isNeedPrintParam() default true;

    /**
     * 是否只在正常情况下打印
     */
    boolean isNeedPrintNormal() default false;


}

切面AOP实现

AOP实现，对所有对外提供服务的接口提供了默认实现：

• 默认扫描所有对外接口，如果发生异常，就会打印异常日志和traceID。
• 对于非查询类接口，还要打印出入参，作为操作流水。
• 支持使用注解对个别接口单独配置，整体优先级： 注解属性 > 默认属性

@Aspect
@Component
@Order(Ordered.LOWEST_PRECEDENCE)
public class TraceLogAspect {
   

    private static final org.slf4j.Logger LOGGER_RT = org.slf4j.LoggerFactory.getLogger("LOGGER_RT");
    /**
     * 默认参数
     */
    private static final boolean IS_NEED_PRINT_NORMAL = false;
    private static final boolean IS_NEED_PRINT_PARAM = true;
    private static final boolean IS_NEED_PRINT_RESULT = true;
    /**
     * 配置参数
     * 默认打印对外实现类bundle的非查询方法
     */
    private static final String[] PRINT_CLASS_CONDITION = {
   "bundle"};
    private static final String[] PRINT_METHOD_CONDITION = {
   "save"