黑马程序员之Java--了解注解及其应用

最新推荐文章于 2024-06-19 11:00:59 发布

原创最新推荐文章于 2024-06-19 11:00:59 发布 · 425 阅读

0 ·

CC 4.0 BY-SA版权

注解专栏收录该内容

1 篇文章

订阅专栏

本文介绍了Java注解的基本概念，包括注解的作用、可标记的元素。详细讲解了自定义注解，包括Retention策略的三种类型：SOURCE、CLASS、RUNTIME，并通过示例展示了如何设置注解的保留周期。此外，还探讨了注解的Target元注解用于限制注解的使用范围。最后，文章讨论了注解类的属性设定，包括默认值和不同类型的属性，以及如何通过反射获取注解及属性值。

------- android培训、 java培训、期待与您交流！ ----------

一、注解基本了解和应用

1、何为注解？
注解就是一种标记，在程序中加了注解就等于加了标记，没加，就没有标记。

2、注解有何作用？
加了注解，java编译器、开发工具或是其他程序可以通过反射技术了解你的类或各种元素是否有标记，有什么标记就做什么样的事情。比如：子类重写父类的方法，方法上必须有@override标记；若一个方法已过时不用了，就该方法添加注解@Deprecated，调用者反射时就明白这方法已过时

3、注解在哪标记，也就是说能为哪些元素标记？

可以在包、类、字段、方法、局部变量

二、自定义注解及其应用

1、先定义个注解类，如下代码：

  /**
   * 自定义注解类
   * @author Administrator
   *
   */
public @interface AnimTest {
}

2、将这个注解类应用到某个类上，然后用反射查看判断该类是否被这个注解类所标记

package com.itcast.test;
import com.itcast.zhujie.AnimTest;
@AnimTest   //这是自定义的注解
public class ZhujieTest {
    /**
     * @param args
     */
    public static void main(String[] args) {
        boolean isAnim  = ZhujieTest.class.isAnnotationPresent(AnimTest.class);
        if(isAnim)
            System.out.println("it  has one");
        else
            System.out.println("no have");
    }
}

输出的结果是：no have ；表示该类没有找到注解标记，这是为何呢？不是在类上已经使用了注解了嘛？

回答这问题之前，我们先学习一个东西，Retention元注释类，指的是注释类型的注释要留多久。如果某个注释类型没有声明Retention元注释，则保留策略为默认的RetentionPolicy.CLASS，表示保留到编译时，运行时就会被剔除。

RetentionPolicy 是一个枚举类型，有三个值：SOURCE、CLASS 、 RUNTIME 分别对应着Java源文件、class文件、内存中的字节码

我们在重新看下上个代码，AnimTest 没有声明Retention，故保留默认的CLASS，只保留到编译时期。所以内存中加载类文件时，注解类已被清除，所以才会找不到AnimTest注解类的标记。要想在反射中能找到该标记，只要设置下注解类的保留周期，所以接着改下这个注解类

  /**
   * 自定义注解类
   * @author Administrator
   *
   */
@Retention(value = RetentionPolicy.RUNTIME)     //表示运行时也保留该注解类
public @interface AnimTest {
}

在执行代码，结果是：it has one

3、现在有个问题，就是注解类的使用范围是怎样的呢？只能在类上么？

其实有个元注释Tagert来限定范围的。Tagert 指的是注释类型所适用的程序元素的种类。如果注释类没有声明Tagert元注释，则可以适用于任何元素上，如果声明了，编译器就会强制实施指定的范围

如果要使AnimTest只作用于方法上，则在注释类声明Tagert

  /**
   * 自定义注解类
   * @author Administrator
   *
   */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.METHOD})    //限定范围，作用于方法
public @interface AnimTest {
}

那么这个注解类就不能作用于类上了，否则会编译异常，只能作用于方法上，代码如下：

public class ZhujieTest {
    /**
     * @param args
     */
    @AnimTest  //作用于方法上
    public static void main(String[] args) {
         
        boolean isAnim  = ZhujieTest.class.isAnnotationPresent(AnimTest.class);
        if(isAnim)
            System.out.println("it  has one");
        else
            System.out.println("no have");
    }
}

如果注释类既可以使用类上也可以作用于方法上，只要修改为 @Target (value = {ElementType.METHOD,ElementType.TYPE})，type是表示类型

三、为注解增加各种属性

1、现在给注解类添加各种属性，类似接口形式，只提供方法

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.itcast.classdemo.WeekDay;
  /**
   * 自定义注解类
   * @author Administrator
   *
   */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.ANNOTATION_TYPE})
public @interface AnimTest {
    String color();   //字符串
    int count();    //整型
    int[] arr();   //数组
    MetaAnnotation meta() default @MetaAnnotation("very food");  //注释类型
    WeekDay day() default WeekDay.MON;   //枚举类型
}  
//注释类
public @interface MetaAnnotation {
   String value() default "heollo";    //提供默认值
}
//枚举类
public enum WeekDay {
    SUN,MON
}

2、以下是测试注释类调用属性

import com.itcast.zhujie.AnimTest;
@AnimTest (color ="red",count =1,arr=234)   //这是自定义的注解,并为其属性赋值
public class ZhujieTest {
    /**
     * @param args
     */
    @AnimTest (color ="blue",count=2,arr={3,21})
    public static void main(String[] args) {
        //是否含有AnimTest注释标记
        boolean isAnim  = ZhujieTest.class.isAnnotationPresent(AnimTest.class);
        if(isAnim){
            //获取AnimTest注释标记对象
            AnimTest an = ZhujieTest.class.getAnnotation(AnimTest.class);
            //以下都是获取AnimTest注释标记对象的属性
            System.out.println(an.color());  // red
            System.out.println(an.count());   //1
            System.out.println(Arrays.toString(an.arr()));   //[234]
            System.out.println(an.meta().value());   //very good
            System.out.println(an.day());            //MON
            System.out.println("it  has one");
        }else
            System.out.println("no have");
    }
}

经上述测试总结：

1）注释类的属性可以有String、int、数组、枚举和注解

2）注释类的属性可以设置默认值，如String color() default "red";

3）在使用注释类时，有属性，但没默认值，这时必须要赋值，否则编译不通过 @AnimTest (color ="blue",count=2,arr={3,21})

4）获取类上的注释对象，用反射技术AnimTest an = ZhujieTest.class.getAnnotation(AnimTest.class);

5）获取注释上的属性，类似调用方法一样，需要带括号；

6）如果注释类只有一个属性要赋值，且属性名为value，则赋值时属性名和等号都可以省略，如：@MetaAnnotation("very food")

------- android培训、 java培训、期待与您交流！ ----------