Java注解入门

太过爱你忘了你带给我的痛 2021-12-19 15:09 178阅读 0赞

*  # 注解的概念 #

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释；

概念描述：

*   *  注解是JDK1.5的新特性；
     *  注解相当一种标记，是类的组成部分，可以给类携带一些额外的信息；
     *  标记(注解)可以加在包，类，字段，方法，方法参数以及局部变量上；
     *  注解是给编译器或JVM看的，编译器或JVM可以根据注解来完成对应的功能；
     *   使用注解：@注解名称；

*  # 注解的作用 #

注解的作用就是给程序带入参数；

常用的几种注解：

*   *  生成帮助文档：@author和@version

*   *   *  **@author**：用来标识作者姓名；
         *  **@version**：用于标识对象的版本号，适用范围：文件、类、方法；

使用**@author和@version**注解就是告诉**Javadoc工具**在生成帮助文档时把作者姓名和版本号也标记在文档中；

*   *  编译检查：@Override

**　　　　　　　　@Override**：用来修饰方法声明；

*   *   *  用来告诉编译器该方法是重写父类中的方法，如果父类不存在该方法，则编译失败；

*   *  框架的配置(框架=代码+配置)
     *  **作为标记，**如Junit单元测试中:@Test;

*  # 自定义注解 #
    
     *  定义格式：

public @interface 注解名{
    }

注解本质上就是一个接口，该接口默认继承Annotation接口，可以通过反编译生成的.java文件查看；如下面的示例中，MyAnno是自定义的注解，将这个.java文件反编译后得到下面的；

//自定义的注解
    public @interface MyAnno {
    }
    
    //通过反编译生成的
    public interface MyAnno extends java.lang.annotation.Annotation {
    }

*   *  注解的属性

1.属性的作用：在使用注解时传递参数；

2.属性格式：

格式1：数据类型 属性名();
    格式2：数据类型 属性名() default 默认值;

3.属性示例

// 该注解就有了三个属性：name，age，gender
    public @interface Student {
      String name(); // 姓名
      int age() default 18; // 年龄
      String gender() default "男"; // 性别
    }

4.属性的返回值类型有下列取值

*   *   *  基本数据类型
         *  String
         *  枚举
         *  注解
         *  以上类型的数组

注意：

1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值；  
　　　　　　　　　　2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可；  
　　　　　　　　　　3. 数组赋值时，值使用\{\}包裹。如果数组中只有一个值，则\{\}可以省略；

*  # 元注解　 #

*   *  Java API提供的注解；
     *  专门用来定义注解的注解；
     *  任何Java官方提供的非元注解的定义中都使用到了元注解；

@Target：描述注解能够作用的位置
    	ElementType取值：
    	TYPE：可以作用于类上
    	METHOD：可以作用于方法上
    	FIELD：可以作用于成员变量上
    	
    @Retention：描述注解被保留的阶段
    	SOURCE：注解只存在于Java源代码中，编译生成的字节码文件中就不存在了；
    	CLASS：注解存在于Java源代码、编译以后的字节码文件中，运行的时候内存中没有，默认值；
    	RUNTIME：注解存在于Java源代码中、编译以后的字节码文件中、运行时内存中，程序可以通过反射获取该注解；
    
    @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到；
    @Documented：描述注解是否被抽取到api文档中；
    @Inherited：描述注解是否被子类继承；

其中@Target，@Retention为常用注解；

*  # 注解解析 #

通过Java技术获取注解数据的过程则称为注解解析；

与注解解析相关的接口：

*   *  **Anontation**：所有注解类型的公共接口，类似所有类的父类是Object；
     *  **AnnotatedElement**：定义了与注解解析相关的方法，常用方法以下四个：

boolean isAnnotationPresent(Class annotationClass); 判断当前对象是否有指定的注解，有则返回true，否则返回false；
    T getAnnotation(Class<T> annotationClass);  获得当前对象上指定的注解对象；
    Annotation[] getAnnotations(); 获得当前对象及其从父类上继承的所有的注解对象；
    Annotation[] getDeclaredAnnotations();获得当前对象上所有的注解对象，不包括父类的；

获取注解中的属性值：注解作用在那个成员上，就通过反射获得该成员的解定义的位置的对象 (Class,Method,Field)；

*   *  如注解作用在方法上，就通过Method对象获取它的注解

// 定义注解Book
    public @interface Book {
            String value();
            double price() default 100;
            String[] authors();
    }
    
     // 得到方法对象
     Method method = class.getDeclaredMethod("方法名"); 
     // 根据注解名得到方法上的注解对象
     Book book = method.getAnnotation(Book.class);

*   *  如注解作用在类上，就通过Class对象获取它的注解

// 定义注解Book
    public @interface Book {
            String value();
            double price() default 100;
            String[] authors();
    }
    
    // 获得Class对象
    Class c = 类名.class;
    // 根据注解的Class获得使用在类上的注解对象
    Book book = c.getAnnotation(Book.class);

转载于:https://www.cnblogs.com/coder-zyc/p/10404372.html