Spring 工具类 ——元数据接口

Spring对很多常用的基本对象进行了封装和扩充,其中部分适用于平时开发使。这里记录下Spring封装的何种元数据接口。需要注意,以下参数或者返回的结果中的类名都为全限定名。

ClassMetadata

Class的一层封装。

String getClassName();
boolean isInterface();
boolean isAnnotation();
boolean isAbstract();
//非接口非抽象类
boolean isConcrete();
boolean isFinal();
boolean isIndependent();
//是否有外部类,即本身是否是内部类
boolean hasEnclosingClass();
//外部类的全限定名
@Nullable
String getEnclosingClassName();
boolean hasSuperClass();
@Nullable
String getSuperClassName();
String[] getInterfaceNames();
//包含的所有内部类
String[] getMemberClassNames();

StandardClassMetadata是基于ClassAPI实现了该接口。

AnnotatedTypeMetadata

java的反射包里有一个接口AnnotatedElement,Spring对该接口做了进一步的封装,是AnnotationMetadata以及MethodMetadata的父接口。虽然没有直接继承的实现类,但该接口的实现都是调用工具类AnnotatedElementUtils的静态方法实现的。平时在处理注解的也可以用AnnotatedElementUtils或者AnnotationUtils提供的方法,这两个工具类会对结果进行缓存,稍微减少重复读取时反射调用的资源消耗。这两个工具方法的实现比较复杂,但public的静态方法的方法名都尽量做到了所见即所得,也有比较详细的注释,需要注意的是get和find两者语义的不同,get的查找范围仅限定于本身,而find则会在父类、实现的接口(对类而言);父类的方法、接口的方法、桥接方法(重载泛型方法会出现)查找。

//目标元素上是否有注解
boolean isAnnotated(String annotationName);
//目标元素上某注解的属性值
@Nullable
Map<String, Object> getAnnotationAttributes(String annotationName);
//目标元素上某注解的属性值
@Nullable
Map<String, Object> getAnnotationAttributes(String annotationName, boolean classValuesAsString);
@Nullable
MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationName);
@Nullable
MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationName, boolean classValuesAsString);

MethodMetadata

方法的元数据,接口继承了AnnotatedTypeMetadata从而可以获取方法上的注解信息。

String getMethodName();
//定义方法的类全限定名
String getDeclaringClassName();
//返回值的全限定名
String getReturnTypeName();
boolean isAbstract();
boolean isStatic();
boolean isFinal();
//也就是没有被标记为static final private
boolean isOverridable();

StandardMethodMetadata基于标准java反射以及AnnotatedElementUtils的方法实现了该接口。

AnnotationMetadata

接口继承了ClassMetadata以及AnnotatedTypeMetadata,提供类的元数据以及类的注解的元数据。

//获取所有注解的全限定名
Set<String> getAnnotationTypes();
//获取每个注解上的元注解
Set<String> getMetaAnnotationTypes(String annotationName);
boolean hasAnnotation(String annotationName);
//类上的注解中是否包含元注解
boolean hasMetaAnnotation(String metaAnnotationName);
boolean hasAnnotatedMethods(String annotationName);
Set<MethodMetadata> getAnnotatedMethods(String annotationName);

实现类是StandardAnnotationMetadata,同样是基于java反射API和AnnotatedElementUtils实现。

MetadataReader

该接口对Class的元数据做了一个get方法的封装,方便一次性获取所有需要的数据。

public interface MetadataReader {

Resource getResource();

ClassMetadata getClassMetadata();

AnnotationMetadata getAnnotationMetadata();
}

接口的实现是包类外部是不可见的,就不记录了。获取实例是通过工厂类获取的。Spring提供了两个工厂类的实现:SimpleMetadataReaderFactoryCachingMetadataReaderFactory,这两个工厂类实现类工厂接口MetadataReaderFactory

public interface MetadataReaderFactory {

/**
 * Obtain a MetadataReader for the given class name.
 * @param className the class name (to be resolved to a ".class" file)
 * @return a holder for the ClassReader instance (never {@code null})
 * @throws IOException in case of I/O failure
 */
MetadataReader getMetadataReader(String className) throws IOException;

/**
 * Obtain a MetadataReader for the given resource.
 * @param resource the resource (pointing to a ".class" file)
 * @return a holder for the ClassReader instance (never {@code null})
 * @throws IOException in case of I/O failure
 */
MetadataReader getMetadataReader(Resource resource) throws IOException;

}

顾名思义,CachingMetadataReaderFactory在读取的时候会做一次缓存,默认缓存256和实例,淘汰规则是FIFO。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容