【Java八股文之基础篇（六）】注解的面试高频问题

注解

简介

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和注释不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

用途

• 编译格式检查 @override
• 反射中解析，实现替代配置文件的功能，文末有案例
• 生成帮助文档 如：@param @return
• 跟踪代码依赖 Spring中的@Controller @Resource
• 等等

原理

注解的本质是一个继承了Annotation的特殊接口，其具体实现类是Java运行时生成的动态代理类。

重点

• 概念
• 语法和用法
• 如何使用内置注解
• 如何使用自定义注解
• 反射中怎么获取注解内容

元注解

作用在其他注解的注解，一共只有4个

注解	解释
@Retention	标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问
@Documented	标记这些注解是否包含在用户文档中 javadoc
@Target	标记这个注解应该是哪种 Java 成员
@Inherited	标记这个注解是自动继承的

1. 子类会继承父类使用的注解中被@Inherited修饰的注解
2. 接口继承关系中，子接口不会继承父接口中的任何注解，不管父接口中使用的注解有没有
   被@Inherited修饰
3. 类实现接口时不会继承任何接口中定义的注解

在 java.lang.annotation包中有两个枚举类如下：

package java.lang.annotation;
public enum ElementType {
	TYPE, /* 类、接口（包括注释类型）或枚举声明 */
	FIELD, /* 字段声明（包括枚举常量） */
	METHOD, /* 方法声明 */
	PARAMETER, /* 参数声明 */
	CONSTRUCTOR, /* 构造方法声明 */
	LOCAL_VARIABLE, /* 局部变量声明 */
	ANNOTATION_TYPE, /* 注释类型声明 */
	PACKAGE /* 包声明 */
}

这里面的常量的作用是作为@Target()注解的属性值传进去的，比如：@Target（ElementType.TYPE），被这个注解修饰的注解只能用在类、接口、枚举上。

package java.lang.annotation;
public enum RetentionPolicy {
	SOURCE, /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该
Annotation信息了 */
	CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */
	RUNTIME /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

这里面的常量的作用是作为@RetentionPolicy()注解的属性值传进去的，比如：@RetentionPolicy（RetentionPolicy.SOURCE），被这个注解修饰的注解只存在于源代码，编译器编译完就没有了。
每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n个。

内置注解举例

注解	解释
@Override	重写，定义在java.lang.Override
@Deprecated	废弃，定义在java.lang.Deprecated
@SafeVarargs	Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告
@FunctionalInterface	Java 8 开始支持，标识一个匿名函数或函数式接口。
@Repeatable	Java 8 开始支持，标识某注解可以在同一个声明上使用多次
@SuppressWarnings	抑制编译时的警告信息，定义在java.lang.SuppressWarnings

自定义注解

注解的架构
不管是元注解、内置注解、自定注解，他们都自动的继承了Annotation接口。

自定义注解的定义格式

@Inherited//子类会继承父类使用的注解中被@Inherited修饰的注解
@Documented//标记这个注解可以包含在用户文档中 javadoc，例如：@reteurn和@param
@Target(ElementType.TYPE)//标记这个注解只能使用在类、接口、枚举上
@Retention(RetentionPolicy.RUNTIME)//标记这个注解可以存在在源代码，字节码，和被JVM识别
public @interface MyAnnotation1 {
	参数类型 参数名() default 默认值;
}

注意事项

• 定义格式：@interface 自定义注解名{}
• 定义的注解，自动继承了java.lang,annotation.Annotation接口
• 注解中的每一个方法，实际是声明的注解配置参数
• 方法的名称就是 ：配置参数的名称
• 方法的返回值类型，就是配置参数的类型，只能是：8个基本类型/Class/String/enum/annotation,以及这些类型的数组。
• 方法只能用public修饰
• 可以通过default来声明参数的默认值
• 如果只有一个参数成员，一般参数名为value
• 注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0作为默认值。

案例：

@MyAnnotation(value={"zhangsan","lisi"})
public class Demo{
	public static void main(String[] args){
	}
}
@Inherited//子类会继承父类使用的注解中被@Inherited修饰的注解
@Documented//标记这个注解可以包含在用户文档中 javadoc，例如：@reteurn和@param
@Target(ElementType.TYPE)//标记这个注解只能使用在类、接口、枚举上
@Retention(RetentionPolicy.RUNTIME)//标记这个注解可以存在在源代码，字节码，和被JVM识别
public @interface MyAnnotation{
	String[] value() default "lisi";
	int num() default 1;
}

上面的作用是定义一个 Annotation，我们可以在代码中通过 “@MyAnnotation” 来使用它。
@Documented, @Target, @Retention, @interface 都是来修饰 MyAnnotation1的。含义：

1. @interface
   使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。定义 Annotation 时，@interface 是必须的。
   注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。
2. @Documented
   类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该Annotation，则表示它可以出现在 javadoc 中。定义 Annotation 时，@Documented 可有可无；若没有定义，则 Annotation 不会出现在 javadoc中。
3. @Target(ElementType.TYPE)
   前面我们说过，ElementType 是 Annotation 的类型属性。而 @Target 的作用，就是来指定
   Annotation 的类型属性。@Target(ElementType.TYPE) 的意思就是指定该 Annotation 的类型是ElementType.TYPE。这就意味着，MyAnnotation1 是来修饰"类、接口（包括注释类型）或枚举声明"的注解。定义 Annotation 时，@Target 可有可无。若有 @Target，则该 Annotation 只能用于它所指定的地方；若没有 @Target，则该 Annotation 可以用于任何地方。
4. @Retention(RetentionPolicy.RUNTIME)
   前面我们说过，RetentionPolicy 是 Annotation 的策略属性，而 @Retention 的作用，就是指定Annotation 的策略属性。@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是RetentionPolicy.RUNTIME。这就意味着，编译器会将该 Annotation 信息保留在 .class 文件中，并且能被虚拟机读取。定义 Annotation 时，@Retention 可有可无。若没有 @Retention，则默认是RetentionPolicy.CLASS。

注解与反射的结合

注解的很大作用就是简化配置文件的编写，本来需要写配置文件的，随着框架更加友好的封装，可以用注解替代写大量的配置文件，但是写配置文件的好处在于可以随时修改，写注解就意味这后续要改的话只能去改代码，改代码一般是不被允许的。

下面举一个简单的例子，这个例子的实现的需求就是将实体类与数据表对应起来，这种需求一般可以通过配置文件实现，也可以通过写注解实现。除了这个例子，注解和反射在框架里还能有更多的应用，这些知识就留到学框架底层再学，现在只是告诉你有这么一个东西。

比如框架里就写了下面这样一个注解

@Inherited//子类会继承父类使用的注解中被@Inherited修饰的注解
@Documented//标记这个注解可以包含在用户文档中 javadoc，例如：@reteurn和@param
@Target(ElementType.TYPE)//标记这个注解只能使用在类、接口、枚举上
@Retention(RetentionPolicy.RUNTIME)//标记这个注解可以存在在源代码，字节码，和被JVM识别
public @interface TableAnnotation{
	//用于标注类对应的表格名称
	String value();
}

@Documented//标记这个注解可以包含在用户文档中 javadoc，例如：@reteurn和@param
@Target(ElementType.FIELD)//标记这个注解只能使用在类、接口、枚举上
@Retention(RetentionPolicy.RUNTIME)//标记这个注解可以存在在源代码，字节码，和被JVM识别
public @interface ColumnAnnotation{
	//描述列名
	String columnName();
	//描述类型
	String type();
	//描述数据的长度
	String length();
}

@TableAnnotation("test_Book")
public class Book{
	@ColumnAnnotation(columnName = "id",type = "int",length = "11")
	private int id;
	@ColumnAnnotation(columnName = "name",type = "varchar",length = "50")
	private String name;
	@ColumnAnnotation(columnName = "info",type = "varchar",length = "1000")
	private String info;
}

参考资料：代码随想录的思维导图，某机构的课件，面试重点没有这块内容（略）