Java高级特性———Java注解

 什么是注解(Annotation)?

注解是放在Java源码的类、方法、字段、参数上的一种标签,在Java SE 5.0版本中开始引入。注解同class和interface一样,也属于一种类型

如何定义注解?

通过关键字@interface去定义,基本的使用方法如下:

@interface +注解名{} //注解定义规则

//例:创建一个名称为testAnnotation的注解
public @interface testAnnotation{
}

通过定义注解,可观察到注解相比于接口类的定义,前面多了一个“@”符号。

以上的代码可以理解为:创建了一个名称为testAnnotation的注解。

如何应用注解?

上边创建完注解以后,如何去使用注解?根据注解的定义,我们可以了解到注解可以放置到类、方法、字段或者是参数上。下面是一个注解的使用案例:

 1 //在方法test上使用testAnnotation注解
 2 @testAnnotation
 3 public static void test() {
 4         
 5 }
 6     
 7 //定义名称为testAnnotation的注解    
 8 @interface testAnnotation{
 9         
10 }

 

要想注解能够正常的工作,我们还需要明白Java中的元注解。在讲元注解前,我们需要理解注解中如何定义注解的属性。

何为注解的属性?

注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。

如何定义注解属性?

属性的定义: 类型+属性名() +[default +"默认值"];(其中[  ]括号内的为可要可不要部分)

下面是定义注解的属性的案例:

  //定义名称为testAnnotation的注解
    @interface testAnnotation{
        /**
         * 注解的属性:
         *1.定义属性:类型+属性名();
         *2.为属性指定默认值:通过default关键字。(例如:int id() default 0)
         **/
    
        //定义属性名为id的属性,其默认值为0
        int id() default 0;   
        
    }

 

Tip:在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

思考如何使用带有属性的注解,且如何给属性赋值?

通常我们在使用注解的时候,在后边跟上一个英文括号,在括号里边给每个注解的属性赋值,然后使用逗号分隔各个属性值。赋值的方式我们通过:属性名=值。
例如:
 1     //使用注解,并为id属性赋值
 2     @testAnnotation(id=0)
 3     public static void test() {
 4         
 5     }
 6     
 7     
 8     //定义名称为testAnnotation的注解
 9     @interface testAnnotation{
10         /**
11          * 注解的属性:
12          *1.定义属性:类型+属性名();
13          *2.为属性指定默认值:通过default关键字。(例如:int id() default 0)
14          **/
15     
16         //定义属性名为id的属性,其默认值为0
17         int id() default 0;   
18         
19     }

 

 另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。
例如:
 1     //使用注解,并为value属性赋值
 2     @testAnnotation("hgqin")
 3     public static void test() {
 4         
 5     }
 6     
 7     
 8     //定义名称为testAnnotation的注解
 9     @interface testAnnotation{
10         /**
11          * 注解的属性:
12          *1.定义属性:类型+属性名();
13          *2.为属性指定默认值:通过default关键字。(例如:int id() default 0)
14          **/
15     
16         //定义属性名为id的属性,其默认值为0
17         int id() default 0;   
18         String value();
19         
20     }

何为元注解?

元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。

如果难于理解的话,你可以这样理解。元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。

元注解有 @Target、@Retention、@Documented、@Inherited、@Repeatable 5 种。(需要重点记忆)

逐个分析元注解:

@Target:Target 是目标的意思,@Target 指定了注解运用的范围。你可以简单的理解为@Target标签指定了自定义注解使用的场景(比如类上或者方法上等)。

@Target的取值有:

 

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

 

@Retention:Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

它的取值如下:

  • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

@Document:Document 的英文意为文档的意思。顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

 

@Inherit :Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。

@Repeatable:Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。

如何完整的定义一个注解?

例如:

 1 //使用注解,并为id属性赋值
 2     @testAnnotation("hgqin")
 3     public static void test() {
 4         
 5     }
 6     
 7     
 8     @Target(ElementType.METHOD)  //定义使用范围为方法上
 9     @Retention(RetentionPolicy.RUNTIME) //定义存活时间为运行时
10     @Documented  //可文档
11     @Inherited  //继承
12     //定义名称为testAnnotation的注解
13     @interface testAnnotation{
14         /**
15          * 注解的属性:
16          *1.定义属性:类型+属性名();
17          *2.为属性指定默认值:通过default关键字。(例如:int id() default 0)
18          **/
19     
20         //定义属性名为id的属性,其默认值为0
21         int id() default 0;   
22         String value();
23         
24     }

常见的内置注解有哪些?

1.@Override:定义在java.lang.Override包中,此注解只用于修饰方法,表示一个方法声明打算重写超类中的另一个方法声明。

2.@Deprecated:定义在java.lang.Deprecated包中,此注解可以用来修饰构造器、字段、类、方法、包、属性等。

  • 注释@Deprecated的程序元素是程序员不鼓励使用的程序元素,通常是因为它是危险的,或者因为存在更好的替代方法。 编译器在不被弃用的代码中使用或覆盖不推荐使用的程序元素时发出警告。

3.@SupressWarnings:定义在java.lang.SupressWarnings包中, 此注解可以用来修饰类、构造器、方法、字段等。用来抑制编译时的警告信息。

  >与前两个不同,需要传入一个参数才能使用,这些参数都是提前定义好的,使用方法有下面几种方式:

  (1)@SupressWarnings(“all”)

  (2)@SupressWarnings("unchecked")

  (3)@SupressWarnings(value="{"unchecked","deprecation"}")

  (4)等等...

posted @ 2020-08-09 11:33  Hgqin  阅读(388)  评论(0编辑  收藏  举报