Spring ResourcePropertySource

  • Author: HuiFer

  • 源码阅读仓库: SourceHot-spring

  • 全路径: org.springframework.core.io.support.ResourcePropertySource

  • source 依然是 map 结构

getNameForResource

  1. private static String getNameForResource(Resource resource) {
  2.    // 获取 resource 的介绍
  3.    String name = resource.getDescription();
  4.    if (!StringUtils.hasText(name)) {
  5.       // 短类名+@+hashcode
  6.       name = resource.getClass().getSimpleName() + "@" + System.identityHashCode(resource);
  7.    }
  8.    return name;
  9. }

withName

  • 创建 ResourcePropertySource 对象, 根据 name 属性
  1. public ResourcePropertySource withName(String name) {
  2.    if (this.name.equals(name)) {
  3.       return this;
  4.    }
  5.    // Store the original resource name if necessary...
  6.    if (this.resourceName != null) {
  7.       if (this.resourceName.equals(name)) {
  8.          return new ResourcePropertySource(this.resourceName, null, this.source);
  9.       }
  10.       else {
  11.          return new ResourcePropertySource(name, this.resourceName, this.source);
  12.       }
  13.    }
  14.    else {
  15.       // Current name is resource name -> preserve it in the extra field...
  16.       return new ResourcePropertySource(name, this.name, this.source);
  17.    }
  18. }

构造函数

  • 通过 location 字符串读取 resource
  1. public ResourcePropertySource(String name, String location, ClassLoader classLoader) throws IOException {
  2.    // 默认资源读取器读取 location 转换成 resource
  3.    this(name, new DefaultResourceLoader(classLoader).getResource(location));
  4. }
  • 读取 resource 信息进行存储
  1. public ResourcePropertySource(String name, EncodedResource resource) throws IOException {
  2.    // 设置 name + map 对象
  3.    // map 对象是 资源信息
  4.    super(name, PropertiesLoaderUtils.loadProperties(resource));
  5.    // 获取 resource name
  6.    this.resourceName = getNameForResource(resource.getResource());
  7. }

完整代码

  1. public class ResourcePropertySource extends PropertiesPropertySource {
  3.    /** The original resource name, if different from the given name. */
  4.    @Nullable
  5.    private final String resourceName;
  8.    /**
  9.     * Create a PropertySource having the given name based on Properties
  10.     * loaded from the given encoded resource.
  11.     */
  12.    public ResourcePropertySource(String name, EncodedResource resource) throws IOException {
  13.       // 设置 name + map 对象
  14.       // map 对象是 资源信息
  15.       super(name, PropertiesLoaderUtils.loadProperties(resource));
  16.       // 获取 resource name
  17.       this.resourceName = getNameForResource(resource.getResource());
  18.    }
  20.    /**
  21.     * Create a PropertySource based on Properties loaded from the given resource.
  22.     * The name of the PropertySource will be generated based on the
  23.     * {@link Resource#getDescription() description} of the given resource.
  24.     */
  25.    public ResourcePropertySource(EncodedResource resource) throws IOException {
  26.       // 设置 key: name, resource 的 name
  27.       // 设置 value: resource 资源信息
  28.       super(getNameForResource(resource.getResource()), PropertiesLoaderUtils.loadProperties(resource));
  29.       this.resourceName = null;
  30.    }
  32.    /**
  33.     * Create a PropertySource having the given name based on Properties
  34.     * loaded from the given encoded resource.
  35.     */
  36.    public ResourcePropertySource(String name, Resource resource) throws IOException {
  37.       super(name, PropertiesLoaderUtils.loadProperties(new EncodedResource(resource)));
  38.       this.resourceName = getNameForResource(resource);
  39.    }
  41.    /**
  42.     * Create a PropertySource based on Properties loaded from the given resource.
  43.     * The name of the PropertySource will be generated based on the
  44.     * {@link Resource#getDescription() description} of the given resource.
  45.     */
  46.    public ResourcePropertySource(Resource resource) throws IOException {
  47.       super(getNameForResource(resource), PropertiesLoaderUtils.loadProperties(new EncodedResource(resource)));
  48.       this.resourceName = null;
  49.    }
  51.    /**
  52.     * Create a PropertySource having the given name based on Properties loaded from
  53.     * the given resource location and using the given class loader to load the
  54.     * resource (assuming it is prefixed with {@code classpath:}).
  55.     */
  56.    public ResourcePropertySource(String name, String location, ClassLoader classLoader) throws IOException {
  57.       // 默认资源读取器读取 location 转换成 resource
  58.       this(name, new DefaultResourceLoader(classLoader).getResource(location));
  59.    }
  61.    /**
  62.     * Create a PropertySource based on Properties loaded from the given resource
  63.     * location and use the given class loader to load the resource, assuming it is
  64.     * prefixed with {@code classpath:}. The name of the PropertySource will be
  65.     * generated based on the {@link Resource#getDescription() description} of the
  66.     * resource.
  67.     */
  68.    public ResourcePropertySource(String location, ClassLoader classLoader) throws IOException {
  69.       this(new DefaultResourceLoader(classLoader).getResource(location));
  70.    }
  72.    /**
  73.     * Create a PropertySource having the given name based on Properties loaded from
  74.     * the given resource location. The default thread context class loader will be
  75.     * used to load the resource (assuming the location string is prefixed with
  76.     * {@code classpath:}.
  77.     */
  78.    public ResourcePropertySource(String name, String location) throws IOException {
  79.       this(name, new DefaultResourceLoader().getResource(location));
  80.    }
  82.    /**
  83.     * Create a PropertySource based on Properties loaded from the given resource
  84.     * location. The name of the PropertySource will be generated based on the
  85.     * {@link Resource#getDescription() description} of the resource.
  86.     */
  87.    public ResourcePropertySource(String location) throws IOException {
  88.       this(new DefaultResourceLoader().getResource(location));
  89.    }
  91.    private ResourcePropertySource(String name, @Nullable String resourceName, Map<String, Object> source) {
  92.       super(name, source);
  93.       this.resourceName = resourceName;
  94.    }
  96.    /**
  97.     * Return the description for the given Resource; if the description is
  98.     * empty, return the class name of the resource plus its identity hash code.
  99.     * @see org.springframework.core.io.Resource#getDescription()
  100.     */
  101.    private static String getNameForResource(Resource resource) {
  102.       // 获取 resource 的介绍
  103.       String name = resource.getDescription();
  104.       if (!StringUtils.hasText(name)) {
  105.          // 短类名+@+hashcode
  106.          name = resource.getClass().getSimpleName() + "@" + System.identityHashCode(resource);
  107.       }
  108.       return name;
  109.    }
  111.    /**
  112.     * Return a potentially adapted variant of this {@link ResourcePropertySource},
  113.     * overriding the previously given (or derived) name with the specified name.
  114.     * @since 4.0.4
  115.     */
  116.    public ResourcePropertySource withName(String name) {
  117.       if (this.name.equals(name)) {
  118.          return this;
  119.       }
  120.       // Store the original resource name if necessary...
  121.       if (this.resourceName != null) {
  122.          if (this.resourceName.equals(name)) {
  123.             return new ResourcePropertySource(this.resourceName, null, this.source);
  124.          }
  125.          else {
  126.             return new ResourcePropertySource(name, this.resourceName, this.source);
  127.          }
  128.       }
  129.       else {
  130.          // Current name is resource name -> preserve it in the extra field...
  131.          return new ResourcePropertySource(name, this.name, this.source);
  132.       }
  133.    }
  135.    /**
  136.     * Return a potentially adapted variant of this {@link ResourcePropertySource},
  137.     * overriding the previously given name (if any) with the original resource name
  138.     * (equivalent to the name generated by the name-less constructor variants).
  139.     * @since 4.1
  140.     */
  141.    public ResourcePropertySource withResourceName() {
  142.       if (this.resourceName == null) {
  143.          return this;
  144.       }
  145.       return new ResourcePropertySource(this.resourceName, null, this.source);
  146.    }
  148. }