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提供了两个工厂类的实现：SimpleMetadataReaderFactory、CachingMetadataReaderFactory,这两个工厂类实现类工厂接口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。

使用方法：

1、ClassMetadata

public interface BaseInterface {

    public String getType();

}

public interface AInterface extends BaseInterface{

    public String getName();

}

public class AInterfaceTest {

    public static void main(String[] args){

        StandardClassMetadata standardClassMetadata = new StandardClassMetadata(AInterface.class);
        System.out.println(standardClassMetadata.isInterface());
        String[] interfaceNames = standardClassMetadata.getInterfaceNames();
        for(String s:interfaceNames){
            System.out.print(s);
        }



    }

}

2、AnnotationMetadata

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Annoa {

    String name();

    String[] value();

}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Annob {

    String name();

    String[] value();
}

public class AnnoaTest {

    public static void main(String[] args) throws Exception {

        MetadataReaderFactory metadataReaderFactory = new SimpleMetadataReaderFactory();
        AnnotationMetadata annotationMetadata = metadataReaderFactory.getMetadataReader(AnnoaTest.class.getName()).getAnnotationMetadata();
        System.out.println(annotationMetadata.getAllAnnotationAttributes(Annoa.class.getName()).get("name"));

    }
}

3、MethodMetadata

public class MethodMataTest {

    public String getName(String name){
        return name;
    }

    public static void main(String[] args) throws Exception{

        StandardMethodMetadata standardMethodMetadata = new StandardMethodMetadata(MethodMataTest.class.getMethod("getName",String.class));
        System.out.println(standardMethodMetadata.getMethodName());
    }


}