Java内功修炼系列：注解（Annotation）
目录
一 注解的定义
二 如何自定义注解
三 元注解
3.1 @Retention
3.2 @Target
3.3 @Documented
3.4 @Inherited
3.5 @Repeatable
四 Java 预置的注解
4.1 @Deprecated
4.2 @Override
4.3 @SuppressWarnings
4.4 @SafeVarargs
4.5 @FunctionalInterface
五 注解的属性
5.1 属性的定义
5.2 注解的提取
六 注解的使用场景
七 注解实战之简易测试框架
补充1 ：元数据
参考文章：
一 注解的定义
Java 注解是从 Java5 开始添加到 Java 的，它用于为 Java 代码提供元数据。作为元数据（见补充1），注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。
注解即标签：如果把代码想象成一个具有生命的个体，注解就是给这些代码的某些个体打的标签。
注解API非常强大，被广泛应用于各种Java框架，如Spring，Hibernate，JUnit，还有Android中的Dagger2、ButterKnife、Retrofit等。
二 如何自定义注解
注解通过 @interface关键字进行定义。
public @interface Test {
}它的形式跟接口很类似，不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 Test 的注解。 你可以简单理解为创建了一张名字为 Test的标签。
使用注解
@Test
public class TestAnnotation {
}你可以简单理解为将 Test 这张标签贴到 TestAnnotation这个类上面。
创建一个类 TestAnnotation,然后在类定义的地方加上 @Test就可以用 Test注解这个类了。
三 元注解
元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。
难于理解的话可以这样说：元注解是一张特殊的标签，可以贴在其他的标签上，作用和目的就是给其他普通的标签进行解释说明。
元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。
3.1 @Retention
Retention译为保留期。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。
它的取值如下：
| RetentionPolicy.SOURCE | 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。 |
| RetentionPolicy.CLASS | 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。 |
| RetentionPolicy.RUNTIME | 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到。 |
3.2 @Target
Target 是目标的意思，@Target 指定了注解运用的地方 你可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。 类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。
@Target 有下面的取值：
| ElementType.ANNOTATION_TYPE | 可以给一个注解进行注解 |
| ElementType.CONSTRUCTOR | 可以给构造方法进行注解 |
| ElementType.FIELD | 可以给属性进行注解 |
| ElementType.LOCAL_VARIABLE | 可以给局部变量进行注解 |
| ElementType.METHOD | 可以给方法进行注解 |
| ElementType.PACKAGE | 可以给一个包进行注解 |
| ElementType.PARAMETER | 可以给一个方法内的参数进行注解 |
3.3 @Documented
顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举。
3.4 @Inherited
Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。
3.5 @Repeatable
Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。
什么样的注解会多次应用呢？通常是注解的值可以同时取多个。
四 Java 预置的注解
上面的知识已经可以让我们自己定义一个注解了，但其实 Java 中本身就已经提供了一些现成的注解。
4.1 @Deprecated
这个元素是用来标记过时的元素。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
public class Stu {@Deprecatedpublic void getNameOld(){System.out.println("这个方法是不推荐的：Deprecated!");}public void getName(){System.out.println("My name is Lucas");}在 IDE 中调用上面类的getNmaeOld方法时,可以看到getNmaeOld() 方法上面被一条直线划掉，这其实就是编译器识别后的提醒效果。
4.2 @Override
这个在开发者很常见了，提示子类要复写父类中被 @Override 修饰的方法。
4.3 @SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。
@SuppressWarnings("deprecation")
public void testSupressWarnings(){Stu stu = new Stu();stu.getNameOld();stu.getName();
}4.4 @SafeVarargs
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。
@SafeVarargs // Not actually safe!static void m(List<String>... stringLists) {Object[] array = stringLists;List<Integer> tmpList = Arrays.asList(42);array[0] = tmpList; // Semantically invalid, but compiles without warningsString s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}上面的代码中，编译阶段不会报错，但是运行时会抛出 ClassCastException 这个异常，所以它虽然告诉开发者要妥善处理，但是开发者自己还是搞砸了。
4.5 @FunctionalInterface
函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。比如：
@FunctionalInterface
public interface Runnable {/*** When an object implementing interface <code>Runnable</code> is used* to create a thread, starting the thread causes the object's* <code>run</code> method to be called in that separately executing* thread.* <p>* The general contract of the method <code>run</code> is that it may* take any action whatsoever.** @see java.lang.Thread#run()*/public abstract void run();
}我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，上面源码可以看到它就被 @FunctionalInterface 注解。
可能有人会疑惑，函数式接口标记有什么用，这个原因是函数式接口可以很容易转换为 Lambda 表达式。
五 注解的属性
5.1 属性的定义
注解的属性也叫做成员变量。注解只有成员变量，没有方法。 需要注意的是，在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组 注解中属性可以有默认值，默认值需要用 default 关键值指定。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{int id() default 1;String msg() default "hello world";
}上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。 赋值的方式是在注解的括号内以 value="" 形式，多个属性之前用 ，隔开
@Test(id=1, msg="hello annotation")
public class TestAnnotation {}5.2 注解的提取
注解与反射密不可分。 注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解：
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}然后通过 getAnnotation() 或者是 getAnnotations() 方法来获取 Annotation 对象，前一种方法返回指定类型的注解，后一种方法返回注解到这个元素上的所有注解：
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}public Annotation[] getAnnotations() {}如果获取到的 Annotation 如果不为 null，则就可以调用它们的属性方法了：
@Test()
public class TestDemo{public static void main(String[] args) {boolean hasAnnotation = TestDemo.class.isAnnotationPresent(Test.class);if ( hasAnnotation ) {TestAnnotation testAnnotation = TestDemo.class.getAnnotation(Test.class);System.out.println("id:"+testAnnotation.id());System.out.println("msg:"+testAnnotation.msg());}}}上面的例子中，只是检阅出了注解在类上的注解。其实属性、方法上的注解照样是可以的。同样还是要假手于反射。
@TestAnnotation(msg="hello world")
public class Test {@Check(value="this is local value")int tempValue;@Performpublic void testMethod(){}//不提示这是过时方法的ide提示@SuppressWarnings("deprecation")public void testSuppressWarnings(){Stu stu = new Stu();stu.getNameOld();stu.getName();}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 tempValue = Test.class.getDeclaredField("tempValue");tempValue.setAccessible(true);//获取一个成员变量上的注解Check check = tempValue.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 blocke.printStackTrace();System.out.println(e.getMessage());} catch (SecurityException e) {// TODO Auto-generated catch blocke.printStackTrace();System.out.println(e.getMessage());} catch (NoSuchMethodException e) {// TODO Auto-generated catch blocke.printStackTrace();System.out.println(e.getMessage());}}}运行结果：
id:1
msg:hello world
check value:hi
method testMethod annotation:Perform六 注解的使用场景
提供信息给编译器： 编译器可以利用注解来探测错误和警告信息
编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
运行时的处理： 某些注解可以在程序运行的时候接受代码的提取 值得注意的是，注解不是代码本身的一部分。
官方文档的解释上，注解主要针对的是编译器和其它工具软件(SoftWare tool)。当开发者使用了Annotation 修饰了类、方法、Field 等成员之后，这些 Annotation 不会自己生效，必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT（Annotation Processing Tool)。
所以注解有什么用？给谁用？答：给编译器 or APT 或者 其他工具类型的软件用的。值得注意的是，注解的提取需要 Java 的反射，而反射比较慢，所以注解使用时需要考虑时间成本的消耗。
七 注解实战之简易测试框架
有了注解，我们就可以在我们的代码中，侵入性很小的进行简单测试框架的编写。首先定义一个需要被测试时添加的注解：
@Retention(RetentionPolicy.RUNTIME)
public @interface SimpleTest {}接着，在我们需要被测试的代码段上，添加该注解，这里以方法测试为例：
public class BugCodeAutoTest {@SimpleTestpublic void divideZero(){System.out.println("1 / 0 = " + 1 / 0);}@SimpleTestpublic void normalFun(){System.out.println("1 + 1 = " + (1 +1) );}}
此时就可以进行测试工具类的编写了：
public class TestTool {public static void main(String[] args) {BugCodeAutoTest bugCodeAutoTest = new BugCodeAutoTest();Class clazz = bugCodeAutoTest.getClass();Method[] method = clazz.getDeclaredMethods();//用来记录测试产生的 log 信息StringBuilder log = new StringBuilder();// 记录异常的次数int errornum = 0;for ( Method m: method ) {// 对被 @SimlpeTest 标注过的方法进行测试if ( m.isAnnotationPresent( SimlpeTest.class )) {try {m.setAccessible(true);m.invoke(bugCodeAutoTest, null);} catch (Exception e) {//e.printStackTrace();errornum++;log.append(m.getName());log.append(" ");log.append("has error:");log.append("\n\r caused by ");//记录测试过程中，发生的异常的名称log.append(e.getCause().getClass().getSimpleName());log.append("\n\r");//记录测试过程中，发生的异常的具体信息log.append(e.getCause().getMessage());log.append("\n\r");} }}log.append(clazz.getSimpleName());log.append(" has ");log.append(errornum);log.append(" error.");// 生成测试报告System.out.println(log.toString());}}运行结果：
divideZero has error:caused by ArithmeticExceptionby zeroBugCodeAutoTest has 1 error.上述代码中有个invoke方法，Method中invoke（Object obj,Object...args）第一个参数为类的实例，第二个参数为相应函数中的参数。如果函数是一个多参数的函数，可以这样调用：method.invoke(object, new Object[][]{new Object[]{obj1, obj2}})，这样相当于object.method(obj1, obj2)：
method2.invoke(test, new String[][]{new String[]{"a", "b"}});补充1 ：元数据
| 术语 | 定义 |
| 元数据 | 关于数据的数据。JSR-175 的目标是在 Java 语言中提供元数据工具。 |
| 批注 | 一种特殊的 Java 结构，用来修饰类、方法、字段、参数、变量、构造器或包。它是 JSR-175 选择用来提供元数据的工具。 |
| 批注类型 | 具有特殊实施的各种命名批注 |
| 属性 | 由批注指定的一个特殊的元数据项目。有时可以和批注交替使用 |
例如：富士苹果有一个属性：它是红色的。假定有一个 FujiApple 类，您可以使用 @Color 批注类型的一个批注来指定它的颜色。通过这么做，您就提供了关于苹果的元数据。
元数据从metadata一词译来，就是“关于数据的数据”的意思，即描述数据的结构信息。元数据的功能作用有很多，比如：你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件。
在Java中元数据以标签的形式存在于Java代码中，元数据标签的存在并不影响程序代码的编译和执行，被用来生成其它的文件或只在运行时知道被运行代码的描述信息。
其作用如下:
①生成文档：这是最常见的，也是java 最早提供的注解。常用的有@param @return 等;
② 跟踪代码依赖性，实现替代配置文件功能。常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。;
③在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。
参考文章：
充分利用 Java 的元数据：充分利用 Java 的元数据
我觉得最好的一篇注解文章：秒懂，Java 注解 （Annotation）你可以这样学：秒懂，Java 注解 （Annotation）你可以这样学_frank 的专栏-CSDN博客
Java注解-元数据、注解分类、内置注解和自定义注解：https://juejin.im/post/5d3ac8d5e51d4577407b1e3a
Java内功修炼系列：注解（Annotation）相关推荐
- Java内功修炼系列：代理模式及动态代理
目录 一 代理模式 1.1 简介 1.2 代理模式角色定义 二 静态代理 2.1 介绍和实例 2.2 静态代理的缺点 三 动态代理 3.1 基于JDK原生动态代理实现 四 小结 一 代理模式 1.1 ...
- Java内功修炼系列一工厂模式
工厂模式是一种创建型模式,它提供了一种新的创建对象的方式,一般情况下我们都习惯用new关键字直接创建对象.有时候会遇到这种情况,我们需要根据具体的场景选择创建什么类型的对象,可能有多种类型都能选择,但 ...
- Java内功修炼系列一责任链模式
在上一节的拦截器中提到,程序的设计者一般会用拦截器替替代动态代理,将动态代理的逻辑隐藏起来,而把拦截器接口提供给开发者,使开发者不需要关系动态代理的具体实现过程,但是有时候需要多个拦截器,而且拦截器之 ...
- Java基础回归之注解Annotation【低仿ButterKnife实战篇】
前言 书接上回,上回说到库里对战湖人三分10投0中,真真气煞我库也,这下把气全撒在鹈鹕身上,一口气轰下破纪录的13记三分. 上回说到Java基础回归之注解Annotation[基础篇],这回我们来真刀 ...
- 一份很良心的JAVA内功修炼手册No.31
总有小伙伴说,啊机器学习什么鬼,一个字都看不懂,我要java的. 好嘛好嘛,我写嘛,给你们整个内功修炼手册好了. 总有人说我学习太泛,又不精.too young , too naive. 今天整理一下 ...
- Java内功修炼 - 23种设计模式
一个设计模式的出现一定有它特殊的价值 前段时间二刷Java设计模式 对于设计模式来说,这个东西是始终不变的,所以我把这方面知识归纳为Java内功. 一个技术超牛的程序员,也就和修仙类小说男主角一样.不 ...
- 程序员内功修炼系列：10 张图解谈 Linux 物理内存和虚拟内存
来源 | 后端技术学堂 责编 | Carol 封图 | CSDN 付费下载于视觉中国 我们都知道,程序可没这么好骗,任你内存管理把虚拟地址空间玩出花来,到最后还是要给程序实实在在的物理内存,不然程序就 ...
- 《IT十八掌大数据内功修炼到企业实战2.0》全套视频2
<IT十八掌大数据内功修炼到企业实战2.0课程>免费自学马拉松计划 1.关于十八掌 学了大数据,还是不敢找工作? 内功不够!跟随十八掌掌门徐培成炼内功! 十八掌教育努力打造一套地表最 ...
- Java设计模式-程序员内功修炼-目录
Java设计模式-内功修炼 关于招式和内功 我们的软件开发技术也包括一些招式和内功:Java.C#.C++等编程语言,Eclipse.Visual Studio等开发工具,JSP.ASP.net等开发 ...
最新文章
- Elasticsearch之倒排索引
- 用人铁律：高层看胸怀、中层看德行、基层看才能
- 拒绝DNN过拟合，谷歌准确预测训练集与测试集泛化差异，还开源了数据集 | ICLR 2019...
- 皮一皮：爸爸的地位...
- 微信小程序云开发 | 云函数安装依赖
- 反射工具类ReflectionUtils
- java面向对象三大特性：封装、继承、多态——举例说明
- sso和oauth2.0的简单了解学习
- [内核编程] 内核环境及其特殊性，驱动编程基础篇
- AngularJs ngIf、ngSwitch、ngHide/ngShow
- 【CodeForces - 507B】Amr and Pins（思维贪心，几何问题）
- python字符串批量替换、修改多个字符的方法实例
- VS2010 字体和背景设置
- Spring 整合 Disruptor 第一个版本
- PlSqlDev中执行INSERT SQL语句包含符号导致数据异常
- JSP→Javabean简介设计原则、JSP动作、Javabean三个动作、Javabean四个作用域范围、Model1简介弊端、JSP状态管理、include动作指令、forword动作、param
- php框架laravel手册,Laravel 5 框架入门（一）
- alexa/alexa-avs-sample-app Windows 安装教程
- 数据库mysql从入门到放弃
- python版js压缩工具