java 注解的了解和使用 （例:针对不同实体的添加方法 验证传入参数是否符合验证规则）

首先我们先了解一下注解的分类:

1. 按照运行的机制来说分为源码注解，编译时注解，运行时注解。

2. 按照来源分为：java 自带注解(比如过时的：@Deprecated和 忽略某警告：@SuppressWarnings)
   ，第三方注解(spring 的@Component)，自定义注解。

3. 元注解:注解上使用的注解。

我们主要说一下自定义注解下面我看一段代码

@Target({ElementType.METHOD , ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DeleteRedis {
}

@target 属于元注解 ElementType代表运用在什么地方
ElementType.TYPE : 标明该注解可以用于类、接口（包括注解类型）或enum声明
ElementType.FIELD: 标明该注解可以用于字段(域)声明，包括enum实例
ElementType.METHOD: 标明该注解可以用于方法声明
ElementType.PARAMETER: 标明该注解可以用于参数声明
ElementType.CONSTRUCTOR: 标明注解可以用于构造函数声明
ElementType.LOCAL_VARIABLE: 标明注解可以用于局部变量声明
ElementType.PACKAGE: 标明注解可以用于包声明
ElementType.TYPE_PARAMETER: 标明注解可以用于类型参数声明（1.8新加入）
ElementType.TYPE_USE: 标明类型使用声明（1.8新加入)

可以 一个，@Target(ElementType.METHOD ) 也可以多个@Target({ElementType.METHOD , ElementType.TYPE})

@Retention是注解的运行范围，也相当月声明周期，分为源码级别（SOURCE），类文件级别（CLASS ），运行时级别（RUNTIME ）

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。 
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。默认是此类别  如:@Deprecated、@SuppressWarnning等
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

@Documented是运用在Javadoc 将注解中的元素包含到 Javadoc 中去

@Repeatable
Repeatable 注解可以重复使用（同一个地方出现多个相同注解）。@Repeatable 是 Java 1.8 才加进来的
@Inherited 此注解标识可以被继承 比如A类继承了B类 如果A类的注解带@Inherited B类也可以获得此注解的值

注解的属性
注解的属性也叫做成员变量。注解只有成员变量，没有方法。其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。如下: 就有三个属性reg value isNull

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyValidate {
    String reg();
    String value();
    boolean isNull() default true;
}

下面我们做一个 针对不同实体的添加方法 验证传入参数是否符合验证规则
首先我们定义实体

public class User {

	@MyValidate(reg ="[0-9A-Za-z_]{5,24}",value = "用户名长度5-24位",isNull = false)
    private String userName;//用户名
    @MyValidate(reg ="[0-9A-Za-z_]{6,50}",value = "密码长度6-50位",isNull = false)
    private String password;//密码
}

开启验证的注解

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

利用aop 对有该注解的方法进行验证

	@Aspect
@Component
public class InsertValidateAspect {
    @Pointcut("@annotation(com.txby.common.annotation.InsertValidate)")
    public void validate(){
    }

    @Around("validate()")
    public Object process(ProceedingJoinPoint point) throws Throwable {
        Object[] args = point.getArgs();//参数
        if(args.length == 0){//如果没有参数 我这边设置的是返回异常
            return ResultUtil.error(ExceptionEnum.INSERT_NULL_ERROR);
        }
        //传入的参数，用实体接收的，所以取得第一个参数是一个实体
        Class clz = args[0].getClass();
        Field[] fields = clz.getDeclaredFields();
        for(Field field : fields){
	        //获取该属性的指定注解
            MyValidate myValidate = field.getAnnotation(MyValidate.class);
            if(myValidate != null){//存在验证注解
                field.setAccessible(true); // 设置些属性是可以访问的
                if(!Tools.checkReg(field.get(args[0]),myValidate.reg(),myValidate.isNull())){//正则验证
					 //验证不通过，返回错误
                    return ResultUtil.error(30041,myValidate.value());
                }
            }
        }
		//验证通过，执行方法
        return point.proceed(args);
    }
}

controller 方法里

	@InsertValidate() //验证注解
    @PostMapping("/insert")
    @Override
    public Result insert(T entity) { //参数是一个实体类
	    //执行添加方法
        return Tools.handleData(baseService.insert(entity), ExceptionEnum.INSERT_ERROR);
    }

上面就是利用aop 对一个有InsertValidate注解的controller 方法 进行验证传入参数是否合法。

以上是对注解的一些小应用。