为什么Java要用注解，那么这些注解有哪些作用呢

　　注解的英文名叫Annotation，是Java中给类、方法以及成员变量等元素增加元数据的方式。换言之注解就是用于描述这些元素的。
　　元数据一词从单词metadata译来，意为描述数据的数据。
　　注解和注释不同的是，注解会被Java编译器处理而非跳过。
　　注解是在JDK5。0版本开始引入的，它可以在编译期使用预编译工具进行处理，也可以在运行期使用Java反射机制进行处理。注释可以用于创建Javadoc，跟踪代码中的依赖性，甚至执行基本编译时检查。本质上，Annotion是一种特殊的接口，程序可以通过反射来获取指定程序元素的Annotion对象，通过Annotion对象来获取注解里面的元数据。
　　相比上来就给大家介绍注解的各种概念，它都有哪些作用外，我更希望把自己带入到一个Java小白的身份从零开始了解注解。我们通过认识注解、使用注解开始了解注解，随后带出Java原生自带的注解以及如何自定义注解，在编写自定义注解的时候顺便通过使用元注解把元注解的概念介绍一下，最后再来说注解都有哪些作用，以及使用注解带来的收益时需要付出什么代价。
　　本文内容大纲如下：
　　初识注解
　　Java注解的简写形式如下：Entity复制代码
　　符号告诉编译器这是一个注解，字符后面的名称是注解的名称。在上面的示例中，注解名称是Entity。
　　注解还可以包含为其设置值的元素，类似注解的一个属性。下面是一个带元素的PostMapping注解示例。PostMapping（path）复制代码
　　上面的PostMapping注解包含一个名为path的元素，我们为其赋值为。设置元素值的语法是在注解名称后的括号内进行设置。
　　一个注解可以包含多个元素，比如PostMapping注解就可以通过consumes元素，指定接收的请求体的格式为applicationjsonPostMapping（path，consumesMediaType。APPLICATIONJSONVALUE）复制代码
　　当然，PostMapping注解能设置哪些元素的值，也是根据PostMapping注解的定义来的。publicinterfacePostMapping｛省略其他元素的定义。。。。。。AliasFor（annotationRequestMapping。class）String〔〕path（）default｛｝；AliasFor（annotationRequestMapping。class）String〔〕consumes（）default｛｝；。。。。。。｝复制代码
　　如果注解只包含一个元素，那么按照约定惯例，会把该元素命名成value：InsertNew（valueyes）复制代码
　　当注解只包含一个名为value的元素时，使用注解时我们可以省略元素名称，只提供元素值。InsertNew（yes）复制代码使用注解
　　Java的注解可以应用在类、接口、方法、方法的参数、成员变量和方法内的局部变量之上，比如在类上应用注解，就是把注解放在类声明之上。EntityTable（namecoffees）publicclassCoffeeimplementsSerializable｛。。。。。。｝复制代码
　　下面这个例子在类、成员变量、成员方法、方法参数上都应用了注解。RestControllerRequestMapping（order）Slf4jpublicclassCoffeeOrderController｛AutowiredprivateCoffeeOrderServiceorderService；AutowiredprivateCoffeeServicecoffeeService；创建Coffee订单paramnewOrderreturnCoffeeOrderPostMapping（path，consumesMediaType。APPLICATIONJSONVALUE）publicCoffeeOrdercreate（RequestBodyNewOrderRequestnewOrder）｛。。。｝｝复制代码
　　上面是一个典型的SpringMVC的ControllerAPI处理方法，如果你对Spring框架还不太熟悉，可以先不管这些注解什么意思，这里主要是演示一下注解可以用在哪里。在Java程序的这些成员上都可以加上注解，为成员添加元数据。Java内置的注解
　　Java带有三个内置注解，可以直接被编译器处理，用于为Java编译器提供指令。这些注解是：OverrideDeprecatedSupressWarningOverride
　　Override注解用于标注方法，它说明了被标注的方法重载了父类的方法，起到了断言的作用。如果我们在一个没有覆盖父类方法的方法上应用Override注解时，Java编译器会告警。publicclassMySuperClass｛publicvoiddoTheThing（）｛System。out。println（Dothething）；｝｝publicclassMySubClassextendsMySuperClass｛OverridepublicvoiddoTheThing（）｛System。out。println（Doitdifferently）；｝｝复制代码
　　在覆盖了父类方法的子类方法上使用Override注解并不是必需的。不过，使用了Override注解的方法，编译器在编译时会去父类找相同的方法签名，验证方法覆盖是否真实存在。
　　使用Override注解的一个好处是比如说有人在项目里修改了父类的被子类覆盖的方法，子类覆盖方法上不使用Override注解的话编译器是不会提示出子类方法未覆盖父类方法的，可能会导致调用方无法正确调用到子类方法的问题，这时就显出Override的重要性了。Deprecated
　　Deprecated注解用于将类、方法或字段标记为已弃用，这意味着不推荐再使用它。如果你的代码使用了不推荐使用的类、方法或字段，编译器在编译时会产生一条Warning级别的告警。DeprecatedpublicclassMyComponent｛｝复制代码
　　在类声明上方使用Deprecated注解将该类标记为已弃用。还可以在方法和字段声明上方使用Deprecated注解，将方法或字段标记为已弃用。当使用Deprecated注解时，最好也使用相应的deprecated注解，该注解用于JavaDoc，一般使用它来解释为什么不推荐使用以及应该改用什么。DeprecateddeprecatedUseMyNewComponentinstead。publicclassMyComponent｛DeperecateddeprecatedUseMyNewComponentsprintComponentNameinstead。publicvoidprintComponentName（）｛System。out。println（MyComponent）｝｝复制代码SupressWarning
　　SuppressWarnings用于关闭对类、方法、成员编译时产生的特定警告。SuppressWarnings不是一个标记注解。它有一个类型为String〔〕的数组成员，这个数组中存储的是要关闭的告警类型。对于javac编译器来讲，对Xlint选项有效的警告名也同样对SuppressWarings有效，同时编译器会忽略掉无法识别的警告名。SuppressWarnings（｛rawtypes，unchecked｝）publicclassSuppressWarningsAnnotationDemo｛staticclassSuppressDemoT｛privateTvalue；publicTgetValue（）｛returnthis。value；｝publicvoidsetValue（Tvar）｛this。valuevar；｝｝SuppressWarnings（｛deprecation｝）publicstaticvoidmain（String〔〕args）｛SuppressDemodnewSuppressDemo（）；d。setValue（London）；System。out。println（Place：d。getValue（））；｝｝复制代码自定义注解
　　下面让我们自己定义一个注解。publicinterfaceMyAnnotation｛Stringvalue（）；Stringname（）；intage（）；String〔〕newNames（）；｝复制代码
　　使用interface关键字来声明一个注解，注解的声明有点类似于接口声明，其中的每一个方法实际上是声明了一个注解的元素。方法的名称就是元素的名称，返回值类型就是元素的值类型（返回值类型只能是基本类型、Class、String、enum）。这个例子定义了一个名为MyAnnotation的注解，它有四个元素。MyAnnotation（value123，nameJacob，age37，newNames｛Jenkov，Peterson｝）publicclassMyClass｛。。。｝复制代码
　　现在使用MyAnnotation必须像上面这个例程中的这样，为其的所有元素指定值。但其实是可以在声明注解时给元素设置默认值的。注解元素的默认值
　　在定义注解的时候可以为元素指定默认值。这样元素就变成了可选的，在使用的时候被省略则直接使用其默认值。下面是在注解定义里如何给元素指定默认值的例子：interfaceMyAnnotation｛Stringvalue（）default；Stringname（）；intage（）；String〔〕newNames（）；｝复制代码
　　现在我们可以在使用MyAnnotation注解时选择省略value元素，这样注解会默认使用value元素的默认值。如下所示：MyAnnotation（nameJakob，age37，newNames｛Jenkov，Peterson｝）publicclassMyClass｛｝复制代码
　　像上面这个例子，在注解的使用中我们并没有指定其value元素的值。元注解
　　元注解是用于修饰注解的注解，在注解的定义中使用，例如：Target（ElementType。METHOD）Retention（RetentionPolicy。SOURCE）publicinterfaceOverride｛｝复制代码
　　这是Override注解的定义，可以看到其中的Target，Retention两个注解就是元注解，元注解一般用于指定注解的生命周期以及作用目标等信息。Java中有以下几个元注解：Retention：注解的生命周期或者叫保留策略Target：注解的作用目标Inherited：是否允许子类继承该注解Documented：注解是否应当被包含在JavaDoc文档中Retention
　　我们可以为上面自定义的注解MyAnnotation指定它是否在运行时可用，以便能通过反射进行检查。通过在注解MyAnnotation的定义中使用Retention元注解来做到这一点。importjava。lang。annotation。Retention；importjava。lang。annotation。RetentionPolicy；Retention（RetentionPolicy。RUNTIME）interfaceMyAnnotation｛Stringvalue（）default；｝复制代码
　　添加到MyAnnotation定义上的元注解。Retention（RetentionPolicy。RUNTIME）复制代码
　　会指示Java编译器和JVM当前注解在运行时可以通过反射获取到。RetentionPolicy类表示注解的保留策略，包含三个两个可以使用的值：RetentionPolicy。RUNTIME表示注解永久保存，在运行时可以通过反射获取。RetentionPolicy。CLASS表示注解存储在。class文件中，在类加载阶段被丢弃，运行时不可用。RetentionPolicy。SOURCE表示注解仅在源代码中可用，在。class文件和运行时中不可用。
　　在定义注解时如果不指定注解的任何保留策略，RetentionPolicy。CLASS就是默认的保留策略。如果创建的注解是与扫描代码的构建工具一起使用，则可以使用保留策略RetentionPolicy。SOURCE，这样就会避免。class文件受到不必要的污染。Target
　　上面例子第一的MyAnnotation注解并没有标明该注解的作用目标，是能作用在类上，方法上，还是字段上。如果要限制注解的可作用目标的话，就需要在注解定义中使用Target元注解来进行限制。
　　下面我们给自己定义的MyAnnotation加上Target，限制它只能注解方法上。importjava。lang。annotation。ElementType；importjava。lang。annotation。Target；Target（｛ElementType。METHOD｝）publicinterfaceMyAnnotation｛Stringvalue（）；｝复制代码
　　ElementType包含以下可用的枚举值：ElementType。TYPE：允许被修饰的注解作用在类、接口和枚举上ElementType。FIELD：允许作用在属性字段上ElementType。METHOD：允许作用在方法上ElementType。PARAMETER：允许作用在方法参数上ElementType。CONSTRUCTOR：允许作用在构造器上ElementType。LOCALVARIABLE：允许作用在本地局部变量上ElementType。ANNOTATIONTYPE：允许作用在注解上ElementType。PACKAGE：允许作用在包上
　　大部分枚举值的名称都是自解释的，可以通过字面单词意思看出来。有两个需要额外说明下，ElementType。ANNOTATIONTYPE表示注解只能用于注解其他注解。在Target和Retention这些元注解的定义里我们能看到使用的正式这个枚举值。DocumentedRetention（RetentionPolicy。RUNTIME）Target（ElementType。ANNOTATIONTYPE）publicinterfaceTarget｛ElementType〔〕value（）；｝复制代码
　　ElementType。TYPE表示注解能用于任何类型，可以是类、接口、枚举，包括注解。Inherited
　　Inherited表示自动继承注解类型。如果注解声明中存在Inherited元注解，则注解所修饰类的所有子类都将会继承此注解。java。lang。annotation。InheritedInheritedpublicinterfaceMyAnnotation｛｝MyAnnotationpublicclassMySuperClass｛。。。｝publicclassMySubClassextendsMySuperClass｛。。。｝复制代码
　　在这个例子中，MySubClass会从父类MySuperClass自动继承MyAnnotation注解。Documented
　　Documented元注解被用于告知JavaDoc生成工具，当前注解需要在使用它的类的文档中显示。importjava。lang。annotation。Documented；DocumentedpublicinterfaceMyAnnotation｛｝复制代码MyAnnotationpublicclassMySuperClass｛。。。｝复制代码
　　当为MySuperClass生成JavaDoc的时候，MyAnnotation注解会被包含其中。Documented这个元注解并不会经常用到，当我们看源码的时候遇到它后，能知道它是干什么用的就行了。Java里注解的用途
　　在Java里注解有许多用途，可以归纳为三类：编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查，编译器可以使用注解来检测错误或抑制警告。编译时和部署时的处理：程序可以处理注解信息以生成代码，XML文件等。运行时处理：可以在运行时检查某些注解并处理。
　　作为Java程序员，尤其是编程十几年年的老手，多多少少都曾经历过被各种配置文件（xml、properties）支配的恐惧。过多的配置文件会使得项目难以维护。使用注解可以减少配置文件或代码，是注解最大的用处，现在Spring家族的SpringBoot就是靠注解维护各种Bean组件的，让开发中者不再用XML指定各种JavaBean的路径、名称等属性，减少了不少项目配置的步骤，从而让Java项目的开发提速了不少。
　　原文：https：juejin。cnpost7164655191201939486