Spring Boot 源码分析 —— AutoConfigurationMetadataLoader

1. 概述

本文，我们来补充 《精尽 Spring Boot 源码分析 —— 自动配置》 文章，并未详细解析的 AutoConfigurationMetadataLoader 。在 SpringApplication 中，我们可以看到 AutoConfigurationImportSelector.AutoConfigurationGroup#loadMetadata(ClassLoader classLoader, String path) 方法中，加载自动配置类（AutoConfiguration）的元数据，是如下一段代码：

// AutoConfigurationImportSelector.AutoConfigurationGroup.java

/**
 * @return 获得 AutoConfigurationMetadata 对象
 */
private AutoConfigurationMetadata getAutoConfigurationMetadata() {
    // 不存在，则进行加载
    if (this.autoConfigurationMetadata == null) {
        this.autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
    }
    // 存在，则直接返回
    return this.autoConfigurationMetadata;
}

• 在内部，会调用 AutoConfigurationMetadataLoader#loadMetadata(ClassLoader classLoader) 方法，加载 AutoConfigurationMetadata 对象。
• 而我们知道，后续会基于返回的 AutoConfigurationMetadata 对象，进行 AutoConfiguration 类的过滤，从而避免不符合条件的 AutoConfiguration 类的字节码，加载到 JVM 中。那么是怎么做到的呢？我们接着来看 「2. AutoConfigurationMetadataLoader」 。

2. AutoConfigurationMetadataLoader

org.springframework.boot.autoconfigure.AutoConfigurationMetadataLoader ，AutoConfigurationMetadata 加载器。其类上的注释如下：

/**
 * Internal utility used to load {@link AutoConfigurationMetadata}.
 */

2.1 loadMetadata

#loadMetadata(ClassLoader classLoader) 静态方法，加载 AutoConfigurationMetadata 。代码如下：

// AutoConfigurationMetadataLoader.java

protected static final String PATH = "META-INF/" + "spring-autoconfigure-metadata.properties";

public static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader) {
    return loadMetadata(classLoader, PATH);
}

static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader, String path) {
    try {
        // <1> 获得 PATH 对应的 URL 们
        Enumeration<URL> urls = (classLoader != null) ? classLoader.getResources(path) : ClassLoader.getSystemResources(path);
        // <2> 遍历 URL 数组，读取到 properties 中
        Properties properties = new Properties();
        while (urls.hasMoreElements()) {
            properties.putAll(PropertiesLoaderUtils.loadProperties(new UrlResource(urls.nextElement())));
        }
        // <3> 将 properties 转换成 PropertiesAutoConfigurationMetadata 对象
        return loadMetadata(properties);
    } catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load @ConditionalOnClass location [" + path + "]", ex);
    }
}

• <1> 处，获得 PATH 对应的 URL 们，而 PATH 就是 "META-INF/spring-autoconfigure-metadata.properties" 文件。这样，我们就可以避免去 AutoConfiguration 类上，读取其 Condition 条件了，从而避免将不符合条件的 AutoConfiguration 类的字节码，加载到 JVM 中。那么，此时就会有一个疑问，"META-INF/spring-autoconfigure-metadata.properties" 是怎么来的呢？答案我们在 「3. AutoConfigureAnnotationProcessor」 中说。
• <2> 处，遍历 URL 数组，读取到 properties 中。

• <3> 处，调用 #loadMetadata(Properties properties) 方法，将 properties 转换成 PropertiesAutoConfigurationMetadata 对象。代码如下：

  // AutoConfigurationMetadataLoader.java
  
  static AutoConfigurationMetadata loadMetadata(Properties properties) {
  	return new PropertiesAutoConfigurationMetadata(properties);
  }

  • 关于 PropertiesAutoConfigurationMetadata 类，在 「2.2 」 中看。

2.2 PropertiesAutoConfigurationMetadata

PropertiesAutoConfigurationMetadata ，是 AutoConfigurationMetadataLoader 的内部静态类，实现 AutoConfigurationMetadata 接口，代码如下：

// AutoConfigurationMetadataLoader#PropertiesAutoConfigurationMetadata.java

/**
 * {@link AutoConfigurationMetadata} implementation backed by a properties file.
 */
private static class PropertiesAutoConfigurationMetadata implements AutoConfigurationMetadata {

    /**
     * Properties 对象
     */
    private final Properties properties;

    PropertiesAutoConfigurationMetadata(Properties properties) {
        this.properties = properties;
    }

    @Override
    public boolean wasProcessed(String className) {
        return this.properties.containsKey(className);
    }

    @Override
    public Integer getInteger(String className, String key) {
        return getInteger(className, key, null);
    }

    @Override
    public Integer getInteger(String className, String key, Integer defaultValue) {
        String value = get(className, key);
        return (value != null) ? Integer.valueOf(value) : defaultValue;
    }

    @Override
    public Set<String> getSet(String className, String key) {
        return getSet(className, key, null);
    }

    @Override
    public Set<String> getSet(String className, String key, Set<String> defaultValue) {
        String value = get(className, key);
        return (value != null) ? StringUtils.commaDelimitedListToSet(value) : defaultValue;
    }

    @Override
    public String get(String className, String key) {
        return get(className, key, null);
    }

    @Override
    public String get(String className, String key, String defaultValue) {
        String value = this.properties.getProperty(className + "." + key);
        return (value != null) ? value : defaultValue;
    }

}

3. AutoConfigureAnnotationProcessor

在 Spring Boot 的源码中，我们如果去检索 "spring-autoconfigure-metadata.properties" 文件，然而并找不到。是不是感觉很奇怪。于是乎，艿艿在搜索了一些网络的上的资料，原来是需要引入 spring-boot-autoconfigure-processor 依赖。这样，它的 AutoConfigureAnnotationProcessor 类，就会自动根据 AutoConfiguration 类的条件，生成 "META-INF/spring-autoconfigure-metadata.properties" 文件。

那么，此时又会有一个疑惑，那是什么时候生成呢？AutoConfigureAnnotationProcessor 继承自 javax.annotation.processing.AbstractProcessor 类，它可以在编译时，扫描和处理注解（Annotation），从而生成 "META-INF/spring-autoconfigure-metadata.properties" 文件。

分享到：

精尽 MyBatis 面试题 | Spring Boot 源码分析 —— SpringFactori ...

• 2019-08-18 06:15
• 浏览 587
• 评论(0)
• 分类:编程语言
• 查看更多