Java注解经典使用场景-通过注解收集操作日志

一、Java注解的作用

定义

Java注解（Annotation），也叫元数据。一种代码级别的说明。是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。实际生产中我们可以通过反射机制编程实现对这些元数据（用来描述数据的数据）的访问

主要作用

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】
②代码分析：通过代码里标识的元数据对代码进行分析【使用反射】
③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

元注解

元注解，就是定义注解的注解，也就是说这些元注解是的作用就是专门用来约束其它注解的注解。
元注解有哪些呢，主要有四个@Target,@Retention,@Documented,@Inherited 描述如下

@Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括： 
 ElemenetType.CONSTRUCTOR 构造器声明 
 ElemenetType.FIELD 域声明（包括 enum 实例） 
 ElemenetType.LOCAL_VARIABLE 局部变量声明 
 ElemenetType.METHOD 方法声明 
 ElemenetType.PACKAGE 包声明 
 ElemenetType.PARAMETER 参数声明 
 ElemenetType.TYPE 类，接口（包括注解类型）或enum声明 
 
 @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括： 
 RetentionPolicy.SOURCE 注解将被编译器丢弃 
 RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃 
 RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 
 
@Documented 将此注解包含在 javadoc 中 
 
 @Inherited 允许子类继承父类中的注解 

自定义注解

自定义步骤大致分为两步：
① 通过@interface关键字(注意，不是interface，是@interace)声明注解名称，以及注解的成员属性或者叫做注解的参数。
② 使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制

通过注解自动记录操作日志

自定义注解 定义成员属性收集需要的元数据

package cn.xxx.modules.order.order.aop;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 订单日志AOP注解
 *
 * @author Chopper
 * @since 2020/11/17 7:22 下午
 */
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OrderLogPoint {

    /**
     * 日志名称
     *
     * @return
     */
    String description();

    /**
     * 订单编号
     *
     * @return
     */
    String orderSn();

}

使用注解

/**
     * 订单取消
     * @param orderSn
     * @param reason
     */
    @Override
    @OrderLogPoint(description = "'订单['+#orderSn+']取消，原因为：'+#reason", orderSn = "#orderSn")
    @Transactional(rollbackFor = Exception.class)
    public void cancel(String orderSn, String reason) {
        B2bOrder b2bOrder = this.getDetailBySn(orderSn).getB2bOrder();
        if (CharSequenceUtil.equalsAny(b2bOrder.getOrderStatus(),
                B2bOrderStatusEnum.UNPAID.name(),
                B2bOrderStatusEnum.FAIL.name())) {
            b2bOrder.setOrderStatus(B2bOrderStatusEnum.CANCEL.name());
            b2bOrder.setCancelReason(reason);
            //修改订单
            this.updateById(b2bOrder);
            //释放库存
            freeQuantity(b2bOrder);
            if (CharSequenceUtil.isNotEmpty(b2bOrder.getCouponId())) {
                //优惠券恢复正常状态
                if (CharSequenceUtil.isNotEmpty(b2bOrder.getCouponId())) {
                    discountCouponService.lambdaUpdate().set(DiscountCoupon::getCouponStatus, DiscountCouponStatusEnum.NORMAL.name())
                            .eq(DiscountCoupon::getId, b2bOrder.getCouponId()).update();
                }
            }
        } else {
            throw new ServiceException(ResultCode.ORDER_CAN_NOT_CANCEL);
        }
    }

AOP处理数据

@Slf4j
@Aspect
@Component
public class OrderOperationLogAspect {

    @Autowired
    private OrderLogService orderLogService;

    @After("@annotation(cn.yhtech.modules.order.order.aop.OrderLogPoint)")
    public void doAfter(JoinPoint joinPoint) {
        try {

            //日志对象拼接
            //默认操作人员，系统操作
            String userName = "系统操作", id = "-1", role = UserEnums.SYSTEM.getRole();
            if (UserContext.getCurrentUser() != null) {
                //日志对象拼接
                userName = UserContext.getCurrentUser().getUsername();
                id = UserContext.getCurrentUser().getId();
                role = UserContext.getCurrentUser().getRole().getRole();
            }
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        	OrderLogPoint orderLogPoint = signature.getMethod().getAnnotation(OrderLogPoint.class);
        	String description = SpelUtil.compileParams(joinPoint, orderLogPoint.description());
        	String orderSn = SpelUtil.compileParams(joinPoint, orderLogPoint.orderSn());
            OrderLog orderLog = new OrderLog(orderSn , id, role, userName, description);
            //调用线程保存
            ThreadPoolUtil.getPool().execute(new SaveOrderLogThread(orderLog, orderLogService));
        } catch (Exception e) {
            log.error("订单日志错误",e);
        }
    }
}

数据展示：