从springboot中的注解再次理解注解和反射

从springboot注解再次理解注解和反射

为了看懂源码的注解和反射

1、自述

​ 在日常的开发中，大家可能已经留意到注解的声影随处可见，特别是在看Springboot源码的时候，自动装配里面运用大量的注解，起初我看源码也是云里雾里的，现在我总结一下我浅薄的见解和理解吧。

2、注解的基础用法

2.1什么是注解？

对于很多初次接触的开发者来说应该都有这个疑问？ Annontation 是Java5开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

2.2注解的用处：

• 生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等
• 跟踪代码依赖性，实现替代配置文件功能。比如Dagger 2 依赖注入，未来java 开发，将大量注解配置，具有很大用处;
• 在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

2.3元注解：

java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：
@Documented – 注解是否将包含在JavaDoc中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解

1.）@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

2.）Target – 表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方。可用的ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性（包括enum实例）
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明

3.)@Documented – 一个简单的Annotations 标记注解，表示是否将注解信息添加在java 文档中。

4.)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class，则这个annotation 将被用于该class 的子类。

2.4常见标准的Annotation：

1.）Override
java.lang.Override 是一个标记类型注解，它被用作标注方法。它说明了被标注的方法重载了父类的方法，起到了断言的作用。如果我们使用了这种注解在一个没有覆盖父类方法的方法时，java 编译器将以一个编译错误来警示。
2.）Deprecated
Deprecated 也是一种标记类型注解。当一个类型或者类型成员使用@Deprecated 修饰的话，编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警。
3.）SuppressWarnings
SuppressWarning 不是一个标记类型注解。它有一个类型为String[] 的成员，这个成员的值为被禁止的警告名。对于javac 编译器来讲，被-Xlint 选项有效的警告名也同样对@SuppressWarings 有效，同时编译器忽略掉无法识别的警告名。
　　@SuppressWarnings(“unchecked”)

2.5自定义注解：

自定义注解类编写的一些规则:

1. Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
2. 参数成员只能用public 或默认(default) 这两个访问权修饰
3. 参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.
4. 要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法
5. 注解也可以没有定义成员,，不过这样注解就没啥用了
   PS:自定义注解需要使用到元注解

3、反射

myself：粗暴的理解反射就是一个程序正常运行，在运行的过程中，反射就动态的从程序插入或删除特定的代码（这些代码可以理解为环境的配置，在springboot中的自动装配等功能就是类似的，就一个@SpringBootApplication注解和反射就实现springboot的强大功能，具体源码怎么实现在这不深究）。

简单的角度理解：在类的加载、链接和初始化的过程中，我们可以在方法main调用class.forName（）获取某个特定类对象（PS：这里的类对象不是我们平时new出来的对象，它更像一个工厂，可以通过new创建很多个这个类的对象，这个工厂可以获得该类的名字、构造器、方法和属性等一切该类拥有的东西，当然获取这些东西需要参考javaAPI文档 https://tool.oschina.net/apidocs/apidoc?api=jdk_7u4 中class类。

4、注解和反射的结合

myself：注解只是简单地给类、方法、成员变量附加一些元信息，对代码的实际逻辑不会产生影响，只起到辅助作用。我们怎么让注解和反射结合在一起，实现加入注解就可以加入我们想要的环境和功能呢？下面从简单的例子说明一下。

/**
 * User
 *
 * @Description:
 * @Author: HongJie
 * @CreateTime: 2020-04-08
 */
@Table("db_user")  //表明
public class User {
	@AField(columnName = "db_id",type = "int",length = 10)
	private int id;
	@AField(columnName = "db_name",type = "varchar",length = 10)
	private String name;
	@AField(columnName = "db_sex",type = "varchar",length = 3)
	private String sex;
	//getter和setter，有参和无参构造方法，toString
}

// 类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table{
	String value();
}

// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface AField{
	String columnName();
	String type();
	int length();
}

package com.company;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;

public class Main {

	public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
		Class c1 = Class.forName("com.company.User");
		//通过反射获得注解
		Annotation[] annotations = c1.getAnnotations();
		for (Annotation annotation : annotations) {
			System.out.println(annotation);
		}
		System.out.println("===================");
		Table table = (Table) c1.getAnnotation(Table.class);
		String value = table.value();
		System.out.println(value);
		System.out.println("===================");
		// 获得类的指定的注解
		Field id = c1.getDeclaredField("sex");
		AField field = id.getAnnotation(AField.class);
		System.out.println(field.columnName());
		System.out.println(field.type());
		System.out.println(field.length());
	}
}

上面的注解是不是经常在运用框架DAO层看到。

自定义类的注解，和属性的注解，给实体类User标记数据库对应的表的名称和列名等属性。再通过反射获取User上的各种注解属性的值，进而进行我们想要的操作。

正是通过反射，我们可以在注解表明的简单元信息设置我们注解所拥有的功能。

5、总结

注解只是简单地给程序进行简单的说明，不会对程序有影响，但反射可以通过注解在原程序的基础上插入更为复杂的功能。

从我们查看注解的源代码就可以看到有大段注释对注解进行说明。

参考：B站大佬 狂神视频 注解和反射