java语言开发之Annotation

灰太狼 2022-09-30 10:54 144阅读 0赞

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)。  
什么是Annotation，以及注解的作用?三个基本的 Annotation:

*  @Override: 限定重写父类方法, 该注解只能用于方法
 *  @Deprecated: 用于表示某个程序元素(类, 方法等)已过时
 *  @SuppressWarnings: 抑制编译器警告.

Annotation 其实就是代码里的特殊标记, 它用于替代配置文件，也就是说，传统方式通过配置文件告诉类如何运行，有了注解技术后，开发人员可以通过注解告诉类如何运行。在Java技术里注解的典型应用是：可以通过反射技术去得到类里面的注解，以决定怎么去运行类。

## JDK 的元 Annotation ##

元 Annotation指修饰Annotation的Annotation。JDK中定义了如下元Annotation：  
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留的域, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 通过这个变量指定域。

RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解. 这是默认值  
**RetentionPolicy.RUNTIME:编译器将把注释记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注解. 程序可以通过反射获取该注释**  
RetentionPolicy.SOURCE: 编译器直接丢弃这种策略的注释

**@Target**：指定注解用于修饰类的哪个成员. @Target 包含了一个名为 value，类型为ElementType(JDK6)的成员变量。  
@Target(\{

*  TYPE, 类
 *  FIELD, 字段
 *  METHOD, 方法
 *  PARAMETER, 参数
 *  CONSTRUCTOR, 构造器
 *  LOCAL\_VARIABLE 局部变量  
    \})

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。  
@Inherited: 被它修饰的 Annotation 将具有继承性.如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

--------------------

// 重写父类的方法
        @Override
        public String toString() {
            return super.toString();
        }
    
        // 抑制编译器警告
        @SuppressWarnings({
       "unused","unchecked"})
        private void save() {
            List list = null;
        }
    
        // 标记方法以及过时
        @Deprecated
        private void save1() {
        }

--------------------

## 自定义 Annotation ##

定义新的 Annotation 类型使用 @interface 关键字  
声明注解的属性  
注解属性的作用：原来写在配置文件中的信息，可以通过注解的属性进行描述。  
Annotation 的属性声明方式：String name()或String\[\] likes();  
属性默认值声明方式：String name() default “xxx”;  
特殊属性value：如果注解中有一个名称value的属性，那么使用注解时可以省略value=部分，如@MyAnnotation(“xxx”)  
特殊属性value\[\];  
枚举值之间使用逗号分隔  
@MyAnnotation(name=”jack”,age=30,likes=\{“唱歌”,”跳舞”\})

基本写法：

public @interface Author { 
    
        /** * 注解属性 * 1. 修饰为默认或public * 2. 不能有主体 */
        String name();
        int age();
    }

@Author(name = "Jet", age = 30)
        public void save() {
        }

带默认值的注解：

public @interface Author { 
    
        /** * 注解属性 * 1. 修饰为默认或public * 2. 不能有主体 */
        String name();
        int age() default 30;   // 带默认值的注解; 使用的时候就可以不写此属性值

默认名称的注解：

public @interface Author {
        // 如果注解名称为value,使用时候可以省略名称，直接给值
        // (且注解只有一个属性时候才可以省略名称)
        String value();
    }

使用：

@Author("Jet")
    @Author(value = "Jet")

注解反射：

@Author(remark = "12321", age = 12)
        public void save() throws Exception {
            // 获取注解信息
    
            // 1. 先获取代表方法的Method类型;
            Class clazz = test.class;
            Method m = clazz.getMethod("save");
    
            // 2. 再获取方法上的注解
            Author author = m.getAnnotation(Author.class);
            // 获取输出注解信息
            System.out.println(author.xxxx());
            System.out.println(author.yyy());
            System.out.println(author.zzzzzzz());
        }