自定义注解结合AOP

自定义注解结合AOP

在这次的web项目中发现对数据库的更新操作以及插入操作都不可避免的要修改操作时间并且此类操作的使用率也很频繁,可以考虑自定义注解+AOP切面编程简化代码编写

1. 实战

1.1 配置常量

在企业中将相关状变量定义为常量保存更加符合规范

/**
 * 公共字段自动填充相关常量
 */
public class AutoFillConstant {
    /**
     * 实体类中的方法名称
     */
    public static final String SET_CREATE_TIME = "setCreateTime";
    public static final String SET_UPDATE_TIME = "setUpdateTime";
    public static final String SET_CREATE_USER = "setCreateUser";
    public static final String SET_UPDATE_USER = "setUpdateUser";
}

/**
 * 数据库操作类型
 */
public enum OperationType {

    /**
     * 更新操作
     */
    UPDATE,

    /**
     * 插入操作
     */
    INSERT

}

1.2 自定义注解

/**
 * 自定义注解 用于标识某个方法需要进行公共字段处理
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AutoFill {
    //数据库操作类型
   OperationType value();
}

1.3 AOP切面编程

1.3.1 切点表达式

execution([修饰符] 返回值类型 包名.类名.方法名(参数))
	常用的书写格式：
	execution(* 包名.*.*(..))

• 访问修饰符可以省略
• 返回值类型、包名、类名、方法名可以使用星号* 代表任意
• 包名与类名之间一个点 . 代表当前包下的类，两个点 … 表示当前包及其子包下的类
• 参数列表可以使用两个点 … 表示任意个数，任意类型的参数列表

1.3.2 代码编写

package com.sky.aspect;

import com.sky.annotation.AutoFill;
import com.sky.constant.AutoFillConstant;
import com.sky.context.BaseContext;
import com.sky.enumeration.OperationType;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.time.LocalDateTime;

/**
 * 自定义切面编程.实现处理公共字段
 */
@Component
@Aspect
@Slf4j
public class AutoFillAspect {
    /**
     * 切入点 实际上就是匹配相对应的类以及带有这个注解的方法
     */
    @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill) ") //切入点匹配任意返回值 在com.sky.mapper包下的任意类所有方法任意参数切注解为AutoFill
    public void  autoFillPointCut(){}


    /**
     * 前置通知，在通知中进行公共字段的赋值
     */
    @Before("autoFillPointCut()")
    public void autoFill(JoinPoint joinPoint) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        log.info("Auto fill start");
        //获取到当前被拦截的方法上的数据库操作类型
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();//方法前面对象
        AutoFill autoFill = methodSignature.getMethod().getAnnotation(AutoFill.class);//获得方法上的注解对象
        OperationType operationType = autoFill.value();//获得数据库操作类型
        //获取到当前被拦截的方法的参数--实体对象
        Object [] args = joinPoint.getArgs();//获得参数数组
        if(args.length  == 0 ||args==null ){
            return;
        }
        Object entity = args[0];//默认参数的第一个为当前方法传递的实体对象
        //准备赋值的数据
        LocalDateTime now = LocalDateTime.now();
        long creadtedId = BaseContext.getCurrentId();
        //根据当前不同的操作类型，为对应的属性通过反射来赋值
        if(operationType==OperationType.INSERT){
            //插入操作 需要通过反射更新4个公共字段
            //通过字节码文件获取方法
            Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME,LocalDateTime.class);
            Method setCreateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_USER, Long.class);
            Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
            Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);
            //通过反射赋值
            setCreateTime.invoke(entity,now);
            setCreateUser.invoke(entity,creadtedId);
            setUpdateTime.invoke(entity,now);
            setUpdateUser.invoke(entity,creadtedId);
        }else if(operationType==OperationType.UPDATE){
            //更新2个公共字段
            Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
            Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);

            setUpdateTime.invoke(entity,now);
            setUpdateUser.invoke(entity,creadtedId);
        }


    }
}

测试

可以在mapper层的方法前加入注解并且指出对应的value值

    @AutoFill(value = OperationType.UPDATE)
    void update(Dish dish);

总结

这种方式对于一些常用且繁琐的的操作还是非常方便的!