Java Properties 与 ResourceBundle、ClassLoader 类加载器

落日映苍穹つ 2022-02-19 12:21 244阅读 0赞

**目录**

Properties 持久化属性概述

Properties 增删改查属性

ResourceBundle 读取资源文件内容

ClassLoader 类加载器

--------------------

# Properties 持久化属性概述 #

1、Properties 类表示一组持久的属性，Properties 可以保存到流中或从流中加载，属性列表中的每个键及其对应的值都是一个字符串。

class java.util.Properties extends Hashtable<Object,Object>

2、一个属性列表可包含另一个属性列表作为它的“默认值”，如果未能在原有的属性列表中搜索到属性键，则搜索第二个属性列表。

3、Properties 继承于 Hashtable，所以可对 Properties 对象应用 put 和 putAll 方法，但不建议使用这两个方法，因为它们允许调用者插入其键或值不是 String 的项，推荐使用 setProperty 方法。

4、Properties 类是线程安全的，多个线程可以共享一个 Properties 对象，而不需要外部同步。因为它的关键方法上加了 synchronized 关键字。

**一言以蔽之：java.util.Properties 是用于快捷操作 \*.properties 、\*.xml 等文件工具类，可以对它们进行增删改查，持久化到磁盘。**

**构造方法**

/**
         * Creates an empty property list with no default values.
         * 创建一个没有默认值的空属性列表。 
         */
        public Properties() {
            this(null);
        }
        /**
         * Creates an empty property list with the specified defaults.
         * 创建一个带有指定默认值的空属性列表。 
         * @param   defaults   the defaults.
         */
        public Properties(Properties defaults) {
            this.defaults = defaults;
        }

# Properties 增删改查属性 #

1、注意：.**properties** 属性文件一行就代表条数据；结尾不要又分号；不支持中文；使用 key=value；

version=1.1
    publishTime=2021-04-2
    author=wangMaoXiong

2、编码实例如下:

/**
         * 向类路径下的某个属性文件添加/修改单个属性值，如果想一次添加多个，只需要在此基础上修改即可
         * 第 1 步先加载属性文件（load）、
         * 第 2 步设置属性值 （setProperty）、
         * 第 3 步保存到磁盘（store）
         * setProperty 底层因为是 Map 的 put 方法，所以如果 key 已经存在，则会进行覆盖
         *
         * @param classPath     如类路径下的 config.properties
         * @param propertyName  属性 key 值
         * @param propertyValue 属性的值
         * @throws IOException
         */
        public static void addPropertyToClassPath(String classPath, String propertyName, String propertyValue) {
            Logger logger = Logger.getAnonymousLogger();
            if (classPath == null || classPath.equals("")) {
                logger.warning("参数错误：" + classPath);
                return;
            }
            if (propertyName == null || propertyName.equals("") || propertyValue == null || propertyValue.equals("")) {
                logger.warning("参数错误：propertyName=" + propertyName + ",propertyValue=" + propertyValue);
                return;
            }
            InputStream inputStream = null;
            OutputStream outputStream = null;
            try {
                //如果 classPath 不存在，则获取的输入流会为 null
                inputStream = PropertiesUtils.class.getClassLoader().getResourceAsStream(classPath);
                if (inputStream == null) {
                    logger.warning("类路径错误" + classPath);
                    return;
                }
                Properties properties = new Properties();
                /**
                 * 从输入字节流读取属性列表（键和元素对）,此方法返回后，指定的流仍保持打开状态。
                 * 输入流按 load(Reader) 中所指定的、简单的面向行的格式，并假定使用 ISO 8859-1 字符编码
                 * 还有一个重载方法： load(Reader reader) 字符流
                 */
                properties.load(inputStream);
                /**
                 * 底层调用的是 Hashtable 的方法 put。之所以不推荐直接使用 put 方法，是因为 put 可以添加 String 以外的类型
                 * 而 setProperty 是强制要求为属性的键和值使用字符串。返回值是 Hashtable 调用 put 的结果
                 * 如果 key 已经存在，则会进行覆盖
                 */
                properties.setProperty(propertyName, propertyValue);
                /**
                 * setProperty 只是修改了内存中的值，磁盘文件并未修改
                 * store(OutputStream out, String comments) ：将内容持久化到磁盘，显然底层也是 I/O 操作
                 * 将此属性列表（键和元素对）写入此Properties表中，以适合于使用load(InputStream)方法加载到Properties表中的格式输出流。
                 * comments - 属性列表的描述，也就是注释
                 */
                URL url = PropertiesUtils.class.getClassLoader().getResource(classPath);
                outputStream = new FileOutputStream(url.getPath());
                properties.store(outputStream, "修改");
                logger.info("添加属性成功：" + url.getPath());
            } catch (IOException e) {
                e.printStackTrace();
            } finally {
                try {
                    //关闭流
                    if (outputStream != null) {
                        outputStream.flush();
                        outputStream.close();
                    }
                    if (inputStream != null) {
                        inputStream.close();
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

![20210402161930294.gif][]

<table> 
 <tbody> 
  <tr> 
   <td> <p>在线演示源码：</p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/main/resources/config/config.properties" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/main/resources/config/config.properties</a></p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/main/java/org/example/uitls/PropertiesUtils.java" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/main/java/org/example/uitls/PropertiesUtils.java</a></p> </td> 
  </tr> 
 </tbody> 
</table>

# ResourceBundle 读取资源文件内容 #

1、public abstract class java.util.**ResourceBundle 主要用于读取类路径下的 \*.properties 资源文件**，实现语言国际化。

2、比如全世界都在用 weChat(微信)，那么就需要有一个功能，对日本人显示的是日本文，对韩国人显示的是韩文，英国人显示英文，中国人显示中文，而 ResourceBundle 资源绑定就是解决这个问题，通过绑定不同的资源文件(即语言)来达到不同语言的显示。

3、ResourceBundle 直接子类：ListResourceBundle ， PropertyResourceBundle

4、单纯就读取 \*.properties 资源文件内容，ResourceBundle 比 Properties 更加方便快捷，但是 Properties 功能更强大。

5、ResourceBundle 是抽象类，使用 public static final ResourceBundle getBundle(String baseName) 方法创建实例，baseName 是 classpath 下的 xxx.properties 的文件名称，不用带后缀名 ".properties"。

6、ResourceBundle 常用方法如下：

public static final void clearCache()：从使用调用者的类加载器加载的缓存中删除所有资源绑定
    public static final void clearCache(ClassLoader loader)：从使用给定的类加载器加载的缓存中删除所有资源绑定
    public boolean containsKey(String key)：确定给定的 key是否包含在此 ResourceBundle或其父包中。如果 key 为 null，则抛异常。
    public String getBaseBundleName()：如果已知，则返回此包的基本名称，如果未知，则返回 null     
    public static final ResourceBundle getBundle(String baseName)：根据资源文件名(不含后缀)创建实例
    public static final ResourceBundle getBundle(String baseName,Locale locale)：根据资源文件名以及区域设置(Locale) 创建实例，这是做国际化的常用方法。
    public abstract Enumeration<String> getKeys()：返回键的枚举
    public final String getString(String key):从此资源包或其父项之一获取给定 key 的值。//如果 key 不存在，则抛出异常
    public final Object getObject(String key)：从此资源束或其父项之一获取给定 key 的值。//如果 key 不存在，则抛出异常

<table> 
 <tbody> 
  <tr> 
   <td> <p>在线演示源码：</p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/test/resources/data/config.properties" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/test/resources/data/config.properties</a></p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/test/java/org/example/utils/ResourceBundleTest.java" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/test/java/org/example/utils/ResourceBundleTest.java</a></p> </td> 
  </tr> 
 </tbody> 
</table>

# ClassLoader 类加载器 #

1.    类加载器是负责加载类的对象

2.    ClassLoader 类是一个抽象类

3.    如果给定类的二进制名称，那么类加载器会试图查找或生成构成类定义的数据。一般策略是将名称转换为某个文件名，然后从文件系统读取该名称的“类文件”。

4.    ClassLoader 类使用委托模型来搜索类和资源。每个 ClassLoader 实例都有一个相关的父类加载器。需要查找类或资源时，ClassLoader 实例会在试图亲自查找类或资源之前，将搜索类或资源的任务委托给其父类加载器。

5.    类加载器读取：读取类路径下任意位置中的任意资源，可以直接拿到文件的输入流，或者文件的绝对地址url，而且可以读又可以写。但是不适合读取特别大的资源。

最常用就是两个方法：

URL url = classLoader.getResource("data/config.properties");  
InputStream inputStream = classLoader.getResourceAsStream("data/config.properties");

<table> 
 <tbody> 
  <tr> 
   <td> <p>在线演示源码：</p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/test/resources/data/config.properties" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/test/resources/data/config.properties</a></p> <p><a href="https://gitee.com/wangmx1993/java-se/blob/master/src/test/java/org/example/utils/ClassLoaderTest.java" rel="nofollow">https://gitee.com/wangmx1993/java-se/blob/master/src/test/java/org/example/utils/ClassLoaderTest.java</a></p> </td> 
  </tr> 
 </tbody> 
</table>

![2021040220330775.gif][]

[20210402161930294.gif]: /images/20220219/2ab535423fca4e1895e989c0226b5c1e.png
[2021040220330775.gif]: /images/20220219/39e6c623ea164180b43ca9b67f4bf19e.png