Java 自定义注解&通过反射获取类、方法、属性上的注解

反射

JAVA中的反射是运行中的程序检查自己和软件运行环境的能力，它可以根据它发现的进行改变。通俗的讲就是反射可以在运行时根据指定的类名获得类的信息。
 

注解的定义

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

  1. /**
  2. * 自定义注解
  3. *
  4. * @author wangh
  5. *
  6. */
  7. public @interface TestAnnotation {
  8. }

它的形式跟接口很类似，不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解。

你可以简单理解为创建了一张名字为 TestAnnotation 的标签。

注解的应用

上面创建了一个注解，那么注解的的使用方法是什么呢。

  1. @TestAnnotation
  2. public class Test {
  3. }

创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了。

你可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

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

元注解

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

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

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

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

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

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

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

上面的代码中，我们指定 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 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。 
说的比较抽象。代码来解释。

  1. @Inherited
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @interface Test {}
  4.  
  5.  
  6. @Test
  7. public class A {}
  8.  
  9.  
  10. public class B extends A {}

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

可以这样理解：

老子非常贫穷，所以人们给他贴了一张标签叫做穷人。

老子的儿子长大后，只要没有和老子断绝父子关系，虽然别人没有给他贴标签，但是他自然也是穷人。

老子的孙子长大了，自然也是穷人。

这就是人们口中戏称的穷一代，穷二代，穷三代。虽然叫法不同，好像好多个标签，但其实事情的本质也就是他们有一张共同的标签，也就是老子身上的那张穷人的标签。

@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 ，大家不明白正常，马上就讲到注解的属性这一块。

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

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface TestAnnotation {
  4.  
  5. int id();
  6.  
  7. String msg();
  8.  
  9. }

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

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

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

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

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

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface TestAnnotation {
  4.  
  5. public int id() default -1;
  6.  
  7. public String msg() default "Hi";
  8.  
  9. }

TestAnnotation 中 id 属性默认值为 -1，msg 属性默认值为 Hi。 
它可以这样应用。

  1. @TestAnnotation()
  2. public class Test {}

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

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

  1. public @interface Check {
  2. String value();
  3. }

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

  1. @Check("hi")
  2. int a;

这和下面的效果是一样的

  1. @Check(value="hi")
  2. int a;

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

public @interface Perform {}

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

  1. @Perform
  2. public void testMethod(){}

Java 预置的注解

学习了上面相关的知识，我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

@Deprecated
这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

  1. public class Hero {
  2.  
  3. @Deprecated
  4. public void say(){
  5. System.out.println("Noting has to say!");
  6. }
  7.  
  8.  
  9. public void speak(){
  10. System.out.println("I have a dream!");
  11. }
  12.  
  13.  
  14. }

定义了一个 Hero 类，它有两个方法 say() 和 speak() ，其中 say() 被 @Deprecated 注解。然后我们在 IDE 中分别调用它们。 

可以看到，say() 方法上面被一条直线划了一条，这其实就是编译器识别后的提醒效果。

@Override

这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

  1. @SuppressWarnings("deprecation")
  2. public void test1(){
  3. Hero hero = new Hero();
  4. hero.say();
  5. hero.speak();
  6. }

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

  1. @SafeVarargs // Not actually safe!
  2. static void m(List<String>... stringLists) {
  3. Object[] array = stringLists;
  4. List<Integer> tmpList = Arrays.asList(42);
  5. array[0] = tmpList; // Semantically invalid, but compiles without warnings
  6. String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
  7. }

上面的代码中，编译阶段不会报错，但是运行时会抛出 ClassCastException 这个异常，所以它虽然告诉开发者要妥善处理，但是开发者自己还是搞砸了。

Java 官方文档说，未来的版本会授权编译器对这种不安全的操作产生错误警告。

@FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

比如

  1. @FunctionalInterface
  2. public interface Runnable {
  3. /**
  4. * When an object implementing interface <code>Runnable</code> is used
  5. * to create a thread, starting the thread causes the object's
  6. * <code>run</code> method to be called in that separately executing
  7. * thread.
  8. * <p>
  9. * The general contract of the method <code>run</code> is that it may
  10. * take any action whatsoever.
  11. *
  12. * @see java.lang.Thread#run()
  13. */
  14. public abstract void run();
  15. }

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，上面源码可以看到它就被 @FunctionalInterface 注解。

可能有人会疑惑，函数式接口标记有什么用，这个原因是函数式接口可以很容易转换为 Lambda 表达式。这是另外的主题了，有兴趣的同学请自己搜索相关知识点学习。

注解的提取

博文前面的部分讲了注解的基本语法，现在是时候检测我们所学的内容了。

我通过用标签来比作注解，前面的内容是讲怎么写注解，然后贴到哪个地方去，而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来，然后检阅上面的内容信息。

要想正确检阅注解，离不开一个手段，那就是反射。

注解与反射。

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

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

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

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

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

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

  1. @TestAnnotation()
  2. public class Test {
  3.  
  4. public static void main(String[] args) {
  5.  
  6. boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
  7.  
  8. if ( hasAnnotation ) {
  9. TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
  10.  
  11. System.out.println("id:"+testAnnotation.id());
  12. System.out.println("msg:"+testAnnotation.msg());
  13. }
  14.  
  15. }
  16.  
  17. }

程序的运行结果是：

  1. id:-1
  2. msg:

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

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

  1. @TestAnnotation(msg="hello")
  2. public class Test {
  3.  
  4. @Check(value="hi")
  5. int a;
  6.  
  7.  
  8. @Perform
  9. public void testMethod(){}
  10.  
  11.  
  12. @SuppressWarnings("deprecation")
  13. public void test1(){
  14. Hero hero = new Hero();
  15. hero.say();
  16. hero.speak();
  17. }
  18.  
  19.  
  20. public static void main(String[] args) {
  21.  
  22. boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
  23.  
  24. if ( hasAnnotation ) {
  25. TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
  26. //获取类的注解
  27. System.out.println("id:"+testAnnotation.id());
  28. System.out.println("msg:"+testAnnotation.msg());
  29. }
  30.  
  31.  
  32. try {
  33. Field a = Test.class.getDeclaredField("a");
  34. a.setAccessible(true);
  35. //获取一个成员变量上的注解
  36. Check check = a.getAnnotation(Check.class);
  37.  
  38. if ( check != null ) {
  39. System.out.println("check value:"+check.value());
  40. }
  41.  
  42. Method testMethod = Test.class.getDeclaredMethod("testMethod");
  43.  
  44. if ( testMethod != null ) {
  45. // 获取方法中的注解
  46. Annotation[] ans = testMethod.getAnnotations();
  47. for( int i = 0;i < ans.length;i++) {
  48. System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
  49. }
  50. }
  51. } catch (NoSuchFieldException e) {
  52. // TODO Auto-generated catch block
  53. e.printStackTrace();
  54. System.out.println(e.getMessage());
  55. } catch (SecurityException e) {
  56. // TODO Auto-generated catch block
  57. e.printStackTrace();
  58. System.out.println(e.getMessage());
  59. } catch (NoSuchMethodException e) {
  60. // TODO Auto-generated catch block
  61. e.printStackTrace();
  62. System.out.println(e.getMessage());
  63. }
  64.  
  65.  
  66.  
  67. }
  68.  
  69. }

它们的结果如下：

  1. id:-1
  2. msg:hello
  3. check value:hi
  4. method testMethod annotation:Perform

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

注解的使用场景

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

注解有许多用处，主要如下： 
- 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息 
- 编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。 
- 运行时的处理： 某些注解可以在程序运行的时候接受代码的提取

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

如果难于理解，可以这样看。罗永浩还是罗永浩，不会因为某些人对于他“傻x”的评价而改变，标签只是某些人对于其他事物的评价，但是标签不会改变事物本身，标签只是特定人群的手段。所以，注解同样无法改变代码本身，注解只是某些工具的的工具。

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

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

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

如果，你还是没有搞清楚的话，我亲自写一个好了。

亲手自定义注解完成某个目的

我要写一个测试框架，测试程序员的代码有无明显的异常。

—— 程序员 A : 我写了一个类，它的名字叫做 NoBug，因为它所有的方法都没有错误。 
—— 我：自信是好事，不过为了防止意外，让我测试一下如何？ 
—— 程序员 A: 怎么测试？ 
—— 我：把你写的代码的方法都加上 @Jiecha 这个注解就好了。 
—— 程序员 A: 好的。

NoBug.java

  1. package ceshi;
  2. import ceshi.Jiecha;
  3.  
  4.  
  5. public class NoBug {
  6.  
  7. @Jiecha
  8. public void suanShu(){
  9. System.out.println("1234567890");
  10. }
  11. @Jiecha
  12. public void jiafa(){
  13. System.out.println("1+1="+1+1);
  14. }
  15. @Jiecha
  16. public void jiefa(){
  17. System.out.println("1-1="+(1-1));
  18. }
  19. @Jiecha
  20. public void chengfa(){
  21. System.out.println("3 x 5="+ 3*5);
  22. }
  23. @Jiecha
  24. public void chufa(){
  25. System.out.println("6 / 0="+ 6 / 0);
  26. }
  27.  
  28. public void ziwojieshao(){
  29. System.out.println("我写的程序没有 bug!");
  30. }
  31.  
  32. }

上面的代码，有些方法上面运用了 @Jiecha 注解。

这个注解是我写的测试软件框架中定义的注解。

  1. package ceshi;
  2.  
  3. import java.lang.annotation.Retention;
  4. import java.lang.annotation.RetentionPolicy;
  5.  
  6. @Retention(RetentionPolicy.RUNTIME)
  7. public @interface Jiecha {
  8.  
  9. }

然后，我再编写一个测试类 TestTool 就可以测试 NoBug 相应的方法了。

  1. package ceshi;
  2.  
  3. import java.lang.reflect.InvocationTargetException;
  4. import java.lang.reflect.Method;
  5.  
  6.  
  7.  
  8. public class TestTool {
  9.  
  10. public static void main(String[] args) {
  11. // TODO Auto-generated method stub
  12.  
  13. NoBug testobj = new NoBug();
  14.  
  15. Class clazz = testobj.getClass();
  16.  
  17. Method[] method = clazz.getDeclaredMethods();
  18. //用来记录测试产生的 log 信息
  19. StringBuilder log = new StringBuilder();
  20. // 记录异常的次数
  21. int errornum = 0;
  22.  
  23. for ( Method m: method ) {
  24. // 只有被 @Jiecha 标注过的方法才进行测试
  25. if ( m.isAnnotationPresent( Jiecha.class )) {
  26. try {
  27. m.setAccessible(true);
  28. m.invoke(testobj, null);
  29.  
  30. } catch (Exception e) {
  31. // TODO Auto-generated catch block
  32. //e.printStackTrace();
  33. errornum++;
  34. log.append(m.getName());
  35. log.append(" ");
  36. log.append("has error:");
  37. log.append("\n\r caused by ");
  38. //记录测试过程中，发生的异常的名称
  39. log.append(e.getCause().getClass().getSimpleName());
  40. log.append("\n\r");
  41. //记录测试过程中，发生的异常的具体信息
  42. log.append(e.getCause().getMessage());
  43. log.append("\n\r");
  44. }
  45. }
  46. }
  47.  
  48.  
  49. log.append(clazz.getSimpleName());
  50. log.append(" has ");
  51. log.append(errornum);
  52. log.append(" error.");
  53.  
  54. // 生成测试报告
  55. System.out.println(log.toString());
  56.  
  57. }
  58.  
  59. }

测试结果是：

  1. 1234567890
  2. 1+1=11
  3. 1-1=0
  4. 3 x 5=15
  5. chufa has error:
  6.  
  7. caused by ArithmeticException
  8.  
  9. / by zero
  10.  
  11. NoBug has 1 error.
  1. 提示 NoBug 类中的 chufa() 这个方法有异常，这个异常名称叫做 ArithmeticException，原因是运算过程中进行了除 0 的操作。
  2.  
  3. 所以，NoBug 这个类有 Bug。
  4.  
  5. 这样，通过注解我完成了我自己的目的，那就是对别人的代码进行测试。
  6.  
  7. 所以，再问我注解什么时候用？我只能告诉你，这取决于你想利用它干什么用。

总结


（1）如果注解难于理解，你就把它类同于标签，标签为了解释事物，注解为了解释代码。
（2）注解的基本语法，创建如同接口，但是多了个 @ 符号。
（3）注解的元注解。
（4）注解的属性。
（5）注解主要给编译器及工具类型的软件用的。
（6）注解的提取需要借助于 Java 的反射技术，反射比较慢，所以注解使用时也需要谨慎计较时间成本。

demo

https://download.csdn.net/download/qq_28016751/10756012

posted @ 2019-07-20 16:07  天涯海角路  阅读(22613)  评论(1)  编辑  收藏  举报