top.xiajibagao.powerfulannotation.scanner

类 AbstractAnnotationScanner

java.lang.Object

top.xiajibagao.powerfulannotation.scanner.AbstractAnnotationScanner

所有已实现的接口:

AnnotationScanner

直接已知子类:

GenericAnnotationScanner

public abstract class AbstractAnnotationScanner
extends Object
implements AnnotationScanner

注解扫描器抽象类，用于从指定的AnnotatedElement及其可能存在的层级结构中获取注解对象。
扫描器支持通过ScanOptions对一些参数进行配置， 并且默认在AnnotationSearchMode中提供了一些预设了参数的常用扫描器。

注解索引

在AbstractAnnotationScanner以及AnnotationProcessor中提到的垂直索引与水平索引将遵循如下定义：
若以扫描的AnnotatedElement为原点建立坐标系， 以被扫描到的注解所在的类层级作为y轴，同一类层级中注解被扫描到的顺序作为x轴，则有：

• 垂直索引：即被扫描到的注解在y轴上的坐标， 用于反映注解与根节点所在层级结构的相对位置
  该索引总是从VERTICAL_INDEX_START_POINT开始递增；
• 水平索引：即被扫描到的注解在x轴上的坐标， 用于反映被扫描到的注解之间以根节点为参照物的相对位置关系。 若两个注解垂直索引相同，则通过水平索引可以区分两注解被扫描的先后顺序。
  该索引总是从HORIZONTAL_INDEX_START_POINT开始递增。

扫描器将可以通过两个坐标轴对应的索引该描述注解与被扫描的AnnotatedElement之间的位置关系。

扫描顺序

默认情况下，扫描器将按照广度优先遍历被扫描的AnnotatedElement的层级结构中的被注解元素。
同一层级中的注解，按照其所属AnnotatedElement的被扫描顺序(元素本身 -> 父类 -> 父接口)、 以及其在AnnotatedElement.getDeclaredAnnotations()返回的注解数组中的顺序决定。
若允许扫描元注解，则在获得注解对象时，将优先扫描该注解对象的层级结构， 然后再继续扫描该与该注解处于统一层级，但是顺序靠后的注解。

比如：现有类X，上有注解A，A又有元注解B； 类X存在父类Y，上有注解C，C又有元注解D， 现对X进行扫描，若不扫描元注解，则依次获得A，C； 若扫描元注解，则依次获得A，B，C，D。

覆盖实现

AbstractAnnotationScanner定义了根据配置项从待扫描元素的层级结构中获取注解的基本逻辑， 调用者需要在实现类中实现下述方法，以补全注解扫描相关功能的逻辑：
类的层级结构递归相关：

• collectAnnotationTypeIfNecessary(List, Class)：递归扫描到的注解的元注解层级结构；
• collectSuperTypeIfNecessary(List, Class)：递归注解接口类的层级结构；
• collectInterfaceTypeIfNecessary(List, Class)：递归父类的层级结构；

从层级结构中的类获取注解相关：

• getAnnotationFromType(Class, Class)：从类上获取注解；
• getAnnotationsFromTypeDeclaredMethod(Class, Method)：从类声明的方法上获取注解；
• getAnnotationsFromTypeDeclaredField(Class, Field)：从类声明的属性上获取注解；

作者:

huangchengxing

另请参阅:

AnnotationFilter, AnnotationProcessor, AnnotationSearchMode

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	AbstractAnnotationScanner.Context 扫描上下文，用于存储一次扫描动作中的一些共享信息

字段概要

字段

限定符和类型	字段和说明
static int	HORIZONTAL_INDEX_START_POINT 垂直索引起始点
protected ScanOptions	options 扫描配置
static int	VERTICAL_INDEX_START_POINT 水平索引起始点

构造器概要

构造器

限定符	构造器和说明
protected	AbstractAnnotationScanner(ScanOptions options) 构造一个通用注解扫描器

方法概要

限定符和类型	方法和说明
protected abstract void	collectAnnotationTypeIfNecessary(List<Class<?>> nextTypeHierarchies, Class<?> type) 若ScanOptions#isEnableScanMetaAnnotation为true，则将目标类元注解也添加到队列
protected abstract void	collectInterfaceTypeIfNecessary(List<Class<?>> nextTypeHierarchies, Class<?> type) 若ScanOptions#isEnableScanInterface为true，则将目标类的父接口也添加到队列
protected abstract void	collectSuperTypeIfNecessary(List<Class<?>> nextTypeHierarchies, Class<?> type) 若ScanOptions#isEnableScanSuperClass为true，则将目标类的父类也添加到队列
ScanOptions	copyOptions() 获取与当前扫描器相同的配置类
protected abstract Annotation[]	getAnnotationFromType(Class<?> type, Class<?> element) 从类获取注解对象
protected abstract Annotation[]	getAnnotationsFromTypeDeclaredField(Class<?> type, Field element) 从类中的指定属性获取注解对象
protected abstract Annotation[]	getAnnotationsFromTypeDeclaredMethod(Class<?> type, Method element) 从类中的指定方法获取注解对象
void	scan(AnnotatedElement element, AnnotationProcessor processor, AnnotationFilter filter) 扫描指定元素上的注解

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

VERTICAL_INDEX_START_POINT

public static final int VERTICAL_INDEX_START_POINT

水平索引起始点

另请参阅:

常量字段值

HORIZONTAL_INDEX_START_POINT

public static final int HORIZONTAL_INDEX_START_POINT

垂直索引起始点

另请参阅:

常量字段值

options

protected final ScanOptions options

扫描配置

构造器详细资料

AbstractAnnotationScanner

protected AbstractAnnotationScanner(ScanOptions options)

构造一个通用注解扫描器

参数:

options - 扫描配置

方法详细资料

copyOptions

public ScanOptions copyOptions()

获取与当前扫描器相同的配置类

返回:

配置类

scan

public void scan(AnnotatedElement element,
                 AnnotationProcessor processor,
                 AnnotationFilter filter)

扫描指定元素上的注解

指定者:

scan 在接口中 AnnotationScanner

参数:

element - 待扫描的元素

processor - 注解处理器

filter - 过滤器，若为空则不过滤任何注解

collectAnnotationTypeIfNecessary

protected abstract void collectAnnotationTypeIfNecessary(List<Class<?>> nextTypeHierarchies,
                                                         Class<?> type)

若ScanOptions#isEnableScanMetaAnnotation为true，则将目标类元注解也添加到队列

参数:

nextTypeHierarchies - 下一层级待处理的类队列

type - 当前正在处理的类对象

collectInterfaceTypeIfNecessary

protected abstract void collectInterfaceTypeIfNecessary(List<Class<?>> nextTypeHierarchies,
                                                        Class<?> type)

若ScanOptions#isEnableScanInterface为true，则将目标类的父接口也添加到队列

参数:

nextTypeHierarchies - 下一层级待处理的类队列

type - 当前正在处理的类对象

collectSuperTypeIfNecessary

protected abstract void collectSuperTypeIfNecessary(List<Class<?>> nextTypeHierarchies,
                                                    Class<?> type)

若ScanOptions#isEnableScanSuperClass为true，则将目标类的父类也添加到队列

参数:

nextTypeHierarchies - 下一层级待处理的类队列

type - 当前正在处理的类对象

getAnnotationsFromTypeDeclaredField

protected abstract Annotation[] getAnnotationsFromTypeDeclaredField(Class<?> type,
                                                                    Field element)

从类中的指定属性获取注解对象

参数:

type - 当前正在处理的类对象

element - 最开始扫描的对象

返回:

注解对象

getAnnotationsFromTypeDeclaredMethod

protected abstract Annotation[] getAnnotationsFromTypeDeclaredMethod(Class<?> type,
                                                                     Method element)

从类中的指定方法获取注解对象

参数:

type - 当前正在处理的类对象

element - 最开始扫描的对象

返回:

注解对象

getAnnotationFromType

protected abstract Annotation[] getAnnotationFromType(Class<?> type,
                                                      Class<?> element)

从类获取注解对象

参数:

type - 当前正在处理的类对象

element - 最开始扫描的对象

返回:

注解对象