2019-08-03

摘抄参考:https://blog.csdn.net/u010634066/article/details/80384125
https://www.imooc.com/video/8870

Java注解的基本概念与作用:

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

使用Java注解,可以实现原程序中的元素关联任何信息和任何元数据,在实际开发中主要有下面三种应用:

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

注解的分类

按运行机制分:

1、源码注解:只在源码中存在,编译后不存在

2、编译时注解:源码和编译后的class文件都存在(如@Override,@Deprecated,@SuppressWarnings)

3、运行时注解:能在程序运行时起作用(如spring的依赖注入@Autowired)

按来源分:

1、来自JDK的注解

2、第三方的注解

3、自定义的注解

Java注解的定义:

注解通过 @interface 关键字进行定义。

public @interface TestAnnotation {
}

它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解。你可以简单理解为创建了一张名字为 TestAnnotation 的标签。

注解的使用方法

创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了。你可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

@TestAnnotation
public class Test {
}

不过,要想注解能够正常工作,还需要了解一个新的概念那就是元注解。

元注解

元注解是一种基本注解,它能够应用到其它的注解上面。可以这样理解,元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

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

它的取值如下:

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

我们可以这样的方式来加深理解,@Retention 去给一张标签解释的时候,它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间范围。

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码中,我们指定 TestAnnotation 可以在程序运行期被获取到,因此它的生命周期非常的长。

@Documented

顾名思义,这个元注解和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target

Target 是目标的意思,@Target 指定了注解运用的地方。可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。

类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。

@Target 有下面的取值:

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解

  • ElementType.CONSTRUCTOR 可以给构造方法进行注解

  • ElementType.FIELD 可以给属性进行注解

  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解

  • ElementType.METHOD 可以给方法进行注解

  • ElementType.PACKAGE 可以给一个包进行注解

  • ElementType.PARAMETER 可以给一个方法内的参数进行注解

  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

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

说的比较抽象,代码来解释。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

@Test
public class A {
}

public class B extends A {
}

注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

要注意的是,只有作用在类上的注解才能被继承,方法、字段等上的注解不会被继承。

@Repeatable

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

什么样的注解会多次应用呢?通常是注解的值可以同时取多个。

举个例子,一个人他既是程序员又是产品经理,同时他还是个画家。

public @interface Persons {    
  Person[]  value();
}

@Repeatable(Persons.class)
public @interface Person{    
  String role default "";
}

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}

注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。

我们再看看代码中的相关容器注解。

public @interface Persons {    
  Person[]  value();
}

按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。

如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。

注解的属性

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
  int id();    
  String msg();
}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 value="" 形式,多个属性之间用 ","隔开。

@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}

需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型、 类、接口、注解及它们的数组。

注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
  public int id() default  -1;
  public  String  msg()  default  "Hi";
}

TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。

它可以这样应用。

@TestAnnotation()
public class Test {
}

因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。

另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。

public @interface Check {
  String value();
}

上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。

@Check("hi")
int a;

这和下面的效果是一样的

@Check(value="hi")
int a;

最后,还需要注意的一种情况是一个注解没有任何属性。比如

public @interface Perform {
}

那么在应用这个注解的时候,括号都可以省略。

@Perform 
public void testMethod(){
}

注解与反射

注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

public boolean isAnnotationPresent(Class annotationClass) {
}

然后通过 getAnnotation() 方法来获取 Annotation 对象。

public  getAnnotation(Class annotationClass) {
}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {
}

前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。

如果获取到的 Annotation 不为 null,就可以调用它们的属性方法了。比如

@TestAnnotation()
public class Test {
  public static void main(String[] args) {
    boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
    if( hasAnnotation ) {            
      TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); 
      System.out.println("id:"+testAnnotation.id());
      System.out.println("msg:"+testAnnotation.msg());       
    }    
  }
}

程序的运行结果是:

id:-1
msg:

这个正是 TestAnnotation 中 id 和 msg 的默认值。

上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的。同样还是要假手于反射。

@TestAnnotation(msg="hello")
public class Test {
  @Check(value="hi")
  int a;
  @Perform
  public void testMethod(){
  }
  @SuppressWarnings("deprecation")
  public void test1(){       
    Hero hero =newHero();        
    hero.say();        
    hero.speak();   
  }

  public static void main(String[] args) {
    boolean has Annotation = Test.class.isAnnotationPresent(TestAnnotation.class);
    if( hasAnnotation ) {            
      TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);//获取类的注解
      System.out.println("id:"+testAnnotation.id());
      System.out.println("msg:"+testAnnotation.msg());        
     }
    try{            
      Field a = Test.class.getDeclaredField("a");           
      a.setAccessible(true);//获取一个成员变量上的注解
      Check check = a.getAnnotation(Check.class);
      if( check !=null) {               
        System.out.println("check value:"+check.value());            
      }            
      Method testMethod = Test.class.getDeclaredMethod("testMethod");
      if( testMethod !=null) {
        // 获取方法中的注解
        Annotation[] ans = testMethod.getAnnotations();
        for(inti =0;i < ans.length;i++) {                    
          System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
        }            
      }       
     }catch(NoSuchFieldException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
        System.out.println(e.getMessage());        
      }catch(SecurityException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
        System.out.println(e.getMessage());        
      }catch(NoSuchMethodException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();            
        System.out.println(e.getMessage());       
       }   
    }
 }

它们的结果如下:

id:-1
msg:
hellocheck 
value:himethod 
testMethod 
annotation:Perform

需要注意的是,如果一个注解要在运行时被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

注解的使用场景

我相信博文讲到这里大家都很熟悉了注解,但是有不少同学肯定会问,注解到底有什么用呢?

对啊注解到底有什么用?

我们不妨将目光放到 Java 官方文档上来。

文章开始的时候,我用标签来类比注解。但标签比喻只是我的手段,而不是目的。为的是让大家在初次学习注解时能够不被那些抽象的新概念搞懵。既然现在,我们已经对注解有所了解,我们不妨再仔细阅读官方最严谨的文档。

注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

注解有许多用处,主要如下:

  • 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息

  • 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。

  • 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取

值得注意的是,注解不是代码本身的一部分。

如果难于理解,可以这样看,标签只是某些人对于其他事物的评价,但是标签不会改变事物本身,标签只是特定人群的手段。所以,注解同样无法改变代码本身,注解只是某些工具的的工具。

还是回到官方文档的解释上,注解主要针对的是编译器和其它工具软件(SoftWare tool)。

当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。

现在,我们可以给自己答案了,注解有什么用?给谁用?给 编译器或者 APT 用的。

总结

如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。

  • 注解的基本语法,创建如同接口,但是多了个 @ 符号。

  • 注解的元注解。

  • 注解的属性。

  • 注解主要给编译器及工具类型的软件用的。

  • 注解的提取需要借助于 Java 的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。

你可能感兴趣的:(2019-08-03)