java 注解学习记录

1.什么是java注解


Java 注解用于为 Java 代码提供元数据。作为元数据,注解不直接影响你的代码执行,但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。

2.什么是元数据


元数据(Metadata)是描述其它数据的数据(data about other data),或者说是用于提供某种资源的有关信息的结构数据(structured data)。

也就可以说java的注解 是 用来 描述 java代码的 注解本身是没有任何作用的。注解需要通过一种手段才能让使用注解的目标达到你想要的目的(反射

3.注解怎么定义


注解的定义通过使用 @interface 关键字定义 注意有

代码如下:

1 public @interface TestAnnotation {
2 }

这样就定义了一个java注解

4.注解怎么使用


注解的使用很简单 在你要使用的java代码的上方,不是代码块里面,是代码上方 通过@+注解的名称 比如我的注解名称是 TestAnnotation 那么我要使用的话 就是在要使用的代码上方 加上一句 @TestAnnotation 即可

代码如下:

1 @TestAnnotation()
2 public class Main {
3 }

这样就完成了注解的使用,然而这并没有什么卵用

5.元注解(基本注解)


刚才说了元数据是描述数据的一种数据 那么 元注解 就是 描述 其他注解的 一种注解

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

@Retention

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

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

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

@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 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。你没有钱,但是你老子有钱,也就间接的你也有钱。

@Repeatable

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

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

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

 1 @interface Persons {
 2     Person[]  value();
 3 }
 4 
 5 
 6 @Repeatable(Persons.class)
 7 @interface Person{
 8     String role default "";
 9 }
10 
11 
12 @Person(role="artist")
13 @Person(role="coder")
14 @Person(role="PM")
15 public class SuperMan{
16 
17 }

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

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

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

1 @interface Persons {
2     Person[]  value();
3 }

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

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

我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM 。如果不明白,就多看几遍 注意了 persons 和 persons是有关联的 

 

以上部分内容转载自:http://blog.csdn.net/briblue/article/details/73824058 原作者写的很好。 以上内容如果有不对请指出 

原文地址:https://www.cnblogs.com/dzxczx666/p/8596640.html