Java注解

2023-02-14 19:27:11

什么是注解：
Annotation(注解)是JDK1.5及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注解是以‘@注解名’在代码中存在的，根据注解参数的个数，我们可以将注解分为：标记注解、单值注解、完整注解三类。它们都不会直接影响到程序的语义，只是作为注解（标识）存在，我们可以通过反射机制编程实现对这些元数据（用来描述数据的数据）的访问。另外，你可以在编译时选择代码里的注解是否只存在于源代码级，或者它也能在class文件、或者运行时中出现（SOURCE/CLASS/RUNTIME)。
作用分类：

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

元注解
java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：

@Documented – 注解是否将包含在JavaDoc中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解

1.@Retention 定义该注解的生命周期

RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

2.@Target 表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方。可用的ElementType 参数包括

ElementType.CONSTRUCTOR: 用于描述构造器
ElementType.FIELD: 成员变量、对象、属性（包括enum实例）
ElementType.LOCAL_VARIABLE: 用于描述局部变量
ElementType.METHOD: 用于描述方法
ElementType.PACKAGE: 用于描述包
ElementType.PARAMETER: 用于描述参数
ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明

3.@Documented 一个简单的Annotations 标记注解，表示是否将注解信息添加在java文档中。
4.@Inherited 定义该注释和子类的关系
@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class，则这个annotation 将被用于该class 的子类。

自定义注解
规则：

Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
参数成员只能用public 或默认(default) 这两个访问权修饰
参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.
要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象

自定义注解实例

 @Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Name {
    enum computerName {LENOVO, DEll, MAC}

    computerName name() default computerName.LENOVO;
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Color {
    enum computerColor {BLACK, RED, WHITE}

    computerColor color() default computerColor.BLACK;
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Provide {
    String name() default "";

    String address() default "";
}

public class MyAnnotation {
    public void getComputerAnnoation(Class<?> cls) {
        Field[] fields = cls.getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(Name.class)) {
                Name name = field.getAnnotation(Name.class);
                System.out.println("电脑名称：" + name.name());
            } else if (field.isAnnotationPresent(Color.class)) {
                Color color = field.getAnnotation(Color.class);
                System.out.println("电脑颜色：" + color.color());
            } else if (field.isAnnotationPresent(Provide.class)) {
                Provide annotation = field.getAnnotation(Provide.class);
                System.out.println("供应商名称：" + annotation.name() + "\n" + "供应商地址：" + annotation.address());
            }
        }
    }

    class Computer {
        @Name(name = Name.computerName.LENOVO)
        String name;
        @Color(color = Color.computerColor.RED)
        String color;
        @Provide(name = "富士康", address = "中国*省台北市")
        String provide;
    }

    @Test
    public void test() {
        getComputerAnnoation(Computer.class);
    }
}

码农公寓

相关文章