java基础之注解

注解是JDK1.5版本开始引入的一个特性，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。它是框架学习和设计者必须掌握的基础。
作用：

1. 生成文档，通过代码里标识的元数据生成javadoc文档。
2. 编译检查，通过代码里标识的元数据让编译器在编译期间进行检查验证。
3. 编译时动态处理，编译时通过代码里标识的元数据动态处理，例如动态生成代码。
4. 运行时动态处理，运行时通过代码里标识的元数据动态处理，例如使用反射注入实例。

1.java自带的注解

@Override、@Deprecated和 @SuppressWarnings 分别代表的是表明方法被重写、忽视过时的方法或者类和忽略警告。用这些注解标明后编译器就会进行检查。

/**
 * java自带的注解：@Override、@Deprecated**和**@SuppressWarnings**分别代表的是表明方法被重写、忽视过时的方法或者类和忽略警告。用这些注解标明后编译器就会进行检查。
 */
public class JavaTest {

    private String name;

    @Deprecated
    public void test() {
        System.out.println("方法过时了，不建议使用");
    }

    // 表示关闭编译器警告信息
    @SuppressWarnings("null")
    public List test2() {
        List list = new ArrayList();
        return list;
    }

    // 表明方法被重写
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        JavaTest javaTest = (JavaTest) o;
        return Objects.equals(name, javaTest.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }

    public static void main(String[] args) {
        JavaTest test = new JavaTest();
        test.test();
    }
}

2.元注解

元注解是用于定义注解的注解，包括@Retention、@Target、@Inherited、@Documented，@Retention用于标明注解被保留的阶段，@Target用于标明注解使用的范围，@Inherited用于标明注解可继承，@Documented用于标明是否生成javadoc文档。

2.1元注解 - @Target

Target注解用来说明那些被它所注解的注解类可修饰的对象范围：注解可以用于修饰 packages、types（类、接口、枚举、注解类）、类成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数），在定义注解类时使用了@Target 能够更加清晰的知道它能够被用来修饰哪些对象，它的取值范围定义在ElementType 枚举中。

public enum ElementType {
 
    TYPE, // 类、接口、枚举类
 
    FIELD, // 成员变量（包括：枚举常量）
 
    METHOD, // 成员方法
 
    PARAMETER, // 方法参数
 
    CONSTRUCTOR, // 构造方法
 
    LOCAL_VARIABLE, // 局部变量
 
    ANNOTATION_TYPE, // 注解类
 
    PACKAGE, // 可用于修饰：包
 
    TYPE_PARAMETER, // 类型参数，JDK 1.8 新增
 
    TYPE_USE // 使用类型的任何地方，JDK 1.8 新增
 
}

2.2元注解 - @Retention & @RetentionTarget

Reteniton注解的作用是：描述注解保留的时间范围（即：被描述的注解在它所修饰的类中可以被保留到何时） 。

public enum RetentionPolicy {
 
    SOURCE,    // 源文件保留
    CLASS,       // 编译期保留，默认值
    RUNTIME   // 运行期保留，可通过反射去获取注解信息
}

@Retention(RetentionPolicy.SOURCE)
public @interface SourcePolicy {
 
}
@Retention(RetentionPolicy.CLASS)
public @interface ClassPolicy {
 
}
@Retention(RetentionPolicy.RUNTIME)
public @interface RuntimePolicy {
 
}

2.3 元注解 - @Documented

Documented注解的作用是：描述在使用 javadoc 工具为类生成帮助文档时是否要保留其注解信息。

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
 
@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface TestDocAnnotation {
 
	public String value() default "default";
}

3.自定义注解

可以根据自己的需求定义注解，并可用元注解对自定义注解进行注解。

/**
 * 自定义注解
 */
public @interface MyAnnotion {

    // 定义变量,定义了变量后再调用的时候必须赋值
    public String name();
    public String info();

    // 设置了默认值可以不用赋值
    public String init() default "null";

}

@MyAnnotion(name="name", info="info")
public class MyAnnotationTest {

    public static void main(String[] args) {

    }
}

3.注解与反射

3.1通过反射去校验字段长度

1.自定义字段注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotationFiled {

    public String value();
    public int length();
}

2.在User类中使用改注解

public class User {

    @AnnotationFiled(value = "user1", length = 20)
    private String name;
    
    @AnnotationFiled(value = "181", length = 2)
    private String age;
}

3.通过反射给字段赋值并且判断字段长度是否超过定义的长度

 Class<?> c1 = Class.forName("com.macro.mall.test.User");
 Constructor<?> constructor = c1.getConstructor();
 User user = (User)constructor.newInstance();
 // 获取指定的注解
 Field[] declaredFields = c1.getDeclaredFields();
 for (Field field : declaredFields) {
     AnnotationFiled annotation = field.getAnnotation(AnnotationFiled.class);
     // 给字段赋值
     field.setAccessible(true); // 授权
     field.set(user, annotation.value()); // 赋值
     if (field.get(user).toString().length()  > annotation.length() ) {
         throw new Exception(field.getName() + "的长度已经超出了" + annotation.length());
     }
 }

因为年龄为181超过了指定的长度