# Java注解 ## 一、注解介绍 简单的说注解可以理解为标签，其实同class和interface一样，注解也是一种类型。下面的这个就是一个注解的定义： ```java public @interface TestAnnotation { } ``` 可以看到，它的形式和接口类似，不放前面多了一个@符号。定义了一个注解就可以使用了，如下： ```java @TestAnnotation public class Test { } ``` 不过要想正常工作，还需要元注解，可以理解为解释标签的标签。元标签有5种： * @Retention * @Documented * @Target * @Inherited * @Repeatable ## 二、元注解介绍 ### 2.1 @Retention Retention英文名为保留期的意思，当@Retention应用到一个注解的时候，它解释说明了这个注解的存活时间。它的取值如下： * RetentionPolicy.SOURCE：注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。 * RetentionPolicy.CLASS：注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。 * RetentionPolicy.RUNTIME：注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。 **需要注意的是，如果一个注解要在运行时被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。** 比如下面这个注解可以在程序运行期被获取到，因此它的生命周期特别的长。 ```java @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { } ``` ### 2.2 @Documented 这个元注解和文档有关，它的作用是能够将注解中的元素包含到Javadoc中去。 ### 2.3 @Target @Target指定了注解运用的地方。比如智能用到方法上，类上，方法参数上等等。它的取值如下： * ElementType.ANNOTATION\_TYPE 可以给一个注解进行注解 * ElementType.CONSTRUCTOR 可以给构造方法进行注解 * ElementType.FIELD 可以给属性进行注解 * ElementType.LOCAL\_VARIABLE 可以给局部变量进行注解 * ElementType.METHOD 可以给方法进行注解 * ElementType.PACKAGE 可以给一个包进行注解 * ElementType.PARAMETER 可以给一个方法内的参数进行注解 * ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举 ### 2.4 @Inherited Inherited是继承的意思，表明如果一个超类被@Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。 说的比较抽象。代码来解释。 ```java @Inherited @Retention(RetentionPolicy.RUNTIME) @interface Test {} @Test public class A {} public class B extends A {} ``` 注解 Test 被 @Inherited 修饰，之后类 A 被 Test 注解，类 B 继承 A,类 B 也拥有 Test 这个注解。 ### 2.5 @Repeatable Repeatable是可重复的意思，Java 8 引进来的。什么样的注解会多次应用呢？通常是注解的值可以同时取多个。 举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。 ```java //按照规定，它里面必须要有一个 value 的属性，属性类型是一个被 @Repeatable 注解过的注解数组，注意它是数组 @interface Persons { Person[] value(); } //Persons.class 相当于一个容器注解，容器注解就是存放其他注解的地方 @Repeatable(Persons.class) @interface Person{ String role default ""; } @Person(role="artist") @Person(role="coder") @Person(role="PM") public class SuperMan{ } ``` ## 三、注解的属性 注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。 比如： ```java @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { int id(); String msg(); } ``` 上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。 赋值的方式是在注解的括号内以 value="" 形式，多个属性之前用 ，隔开。 ```java @TestAnnotation(id=3,msg="hello annotation") public class Test { } ``` 需要注意的是，在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。 注解中属性可以有默认值，默认值需要用 default 关键值指定。比如： ```java @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { public int id() default -1; public String msg() default "Hi"; } ``` 另外，还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内。 ```java public @interface Check { String value(); } ``` 上面代码中，Check 这个注解只有 value 这个属性。所以可以这样应用。 ```java @Check("hi") int a; ``` 这和下面的效果是一样的： ```java @Check(value="hi") int a; ``` ## 四、Java预置的注解 ### 4.1 @Deprecated 这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。 ### 4.2 @Override 这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法 ### 4.3 @SuppressWarnings 阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。 ### 4.4 @SafeVarargs 参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。 ### 4.5 @FunctionalInterface 函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。 **函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。** 比如 ```java @FunctionalInterface public interface Runnable { public abstract void run(); } ``` 我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，上面源码可以看到它就被 @FunctionalInterface 注解。 可能有人会疑惑，函数式接口标记有什么用，这个原因是函数式接口可以很容易转换为 Lambda 表达式。 ## 五、注解的提取 前面的部分讲了注解的基本语法，现在是时候检测我们所学的内容了。 我通过用标签来比作注解，前面的内容是讲怎么写注解，然后贴到哪个地方去，而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来，然后检阅上面的内容信息。 要想正确检阅注解，离不开一个手段，那就是反射。 * 首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解； * 然后通过 getAnnotation() 方法来获取 Annotation 对象； * 或者是 getAnnotations() 方法可以获取这个元素上所有的注解。 比如： ```java @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: ``` 上面的例子中，只是检阅出了注解在类上的注解，其实属性、方法上的注解照样是可以的。同样还是要借助反射。 ```java @TestAnnotation(msg="hello") public class Test { @Check(value="hi") int a; @Perform public void testMethod(){} @SuppressWarnings("deprecation") public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); } 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()); } 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( int i = 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:hello check value:hi method testMethod annotation:Perform ``` ## 六、注解的作用 * 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息； * 编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理； * 运行时的处理： 某些注解可以在程序运行的时候接受代码的提取。 当开发者使用了Annotation 修饰了类、方法、Field 等成员之后，这些 Annotation 不会自己生效，必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT（Annotation Processing Tool)。 > 转自： > > --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://jun-wang.gitbook.io/learnjava/ji-shu-xue-xi/java-xue-xi/java-zhu-jie.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.