【Java 基础】Java Properties的用法

深藏阁楼爱情的钟 2024-05-04 08:05 72阅读 0赞

![在这里插入图片描述][4b7ba7d27b774fcb9db77011b66c3303.png]

> ?**博主介绍**： 博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：[个人社区][Link 1]  
? 个人主页：[个人主页][Link 2]  
? 专栏地址： ✅ [Java 进阶之路][Java]  
?八股文专题：[剑指大厂，手撕 Java 八股文][Java 1]

#### 文章目录 ####

*   *   *  一、Properties
         *  二、Properties 的应用场景
         *  三、Properties 的 API
         *  四、Properties 使用案例 - 配置文件管理

#### 一、Properties ####

Java Properties 是一个用于管理 Java 应用程序配置信息的类。它是一个键值对的集合，其中键和值都是字符串类型。Properties 类通常用于读取和写入配置文件，如 .properties 文件。通过使用 Properties 类，可以在应用程序中轻松地读取和修改配置信息，而不需要硬编码这些值。Properties 类提供了许多有用的方法，如 getProperty() 用于获取属性值，setProperty() 用于设置属性值，load() 和 store() 用于从文件中加载和保存属性等。在 Java 中，Properties 类是一个标准的类库，可以在任何 Java 应用程序中使用。

#### 二、Properties 的应用场景 ####

Properties 类在 Java 中有很多应用场景，以下是其中一些常见的应用场景：

1.  配置文件管理：Properties 类经常用于读取和写入配置文件，如 .properties 文件。配置文件中存储了应用程序的各种配置信息，例如数据库连接信息、日志级别、应用程序的默认设置等。通过使用 Properties 类，可以轻松地读取和修改配置文件中的属性值，而不需要修改源代码。
2.  多语言国际化：在多语言应用程序中，Properties 类可以用于存储不同语言对应的翻译文本。可以创建多个 .properties 文件，每个文件对应一种语言，然后使用 Properties 类来加载相应的文件，并根据当前语言环境获取对应的翻译文本。
3.  消息资源管理：Properties 类可以用于管理应用程序中的消息资源。可以将不同的消息文本存储在 .properties 文件中，然后使用 Properties 类加载文件，并根据需要获取相应的消息文本。
4.  动态配置：Properties 类可以用于动态配置应用程序的行为。可以将一些参数存储在 .properties 文件中，然后使用 Properties 类读取这些参数，并在应用程序中根据参数的值来决定不同的行为。
5.  缓存管理：Properties 类可以用于缓存管理。可以将一些常用的数据存储在 .properties 文件中，然后使用 Properties 类加载数据，并将其缓存在内存中，以提高数据的访问速度。

这些只是 Properties 类的一些常见应用场景，实际上它还可以根据具体需求灵活应用。无论是读取配置文件、管理资源、国际化还是其他用途，Properties 类都提供了简单而方便的方法来处理键值对数据。

#### 三、Properties 的 API ####

Properties 类是 Java 中用于操作属性文件的类，它提供了一组用于读取和写入属性的方法。下面是一些常用的 Properties 类的 API：

1.  创建 Properties 对象：

*  `Properties props = new Properties();` ：创建一个空的 Properties 对象。

1.  读取属性文件：

*  `props.load(InputStream inStream)` ：从输入流中加载属性文件。
 *  `props.load(Reader reader)` ：从字符流中加载属性文件。
 *  `props.loadFromXML(InputStream in)` ：从 XML 格式的输入流中加载属性文件。

1.  获取属性值：

*  `String value = props.getProperty(String key)` ：根据指定的键获取对应的属性值。
 *  `String value = props.getProperty(String key, String defaultValue)` ：根据指定的键获取对应的属性值，如果键不存在，则返回默认值。

1.  设置属性值：

*  `props.setProperty(String key, String value)` ：设置指定键的属性值。

1.  写入属性文件：

*  `props.store(OutputStream out, String comments)` ：将属性列表写入输出流。
 *  `props.store(Writer writer, String comments)` ：将属性列表写入字符流。
 *  `props.storeToXML(OutputStream os, String comment)` ：将属性列表以 XML 格式写入输出流。

1.  遍历属性：

*  `Enumeration<?> propertyNames = props.propertyNames()` ：获取属性文件中所有键的枚举。
 *  `Set<String> keySet = props.stringPropertyNames()` ：获取属性文件中所有键的集合。

这些是 Properties 类的一些常用方法。

#### 四、Properties 使用案例 - 配置文件管理 ####

Properties 类常用于管理配置文件。下面是一个使用 Properties 类的案例，展示如何读取和写入配置文件：

1.  创建配置文件（example.properties）：

username=admin
    password=123456

1.  读取配置文件：

import java.io.FileInputStream;
    import java.io.IOException;
    import java.util.Properties;
    /**
     *
     * @description:  ReadPropertiesFile 
     * @copyright: @Copyright (c) 2022
     * @company: Aiocloud
     * @author: pany
     * @version: 1.0.0
     * @createTime: 2023-07-07 17:35
     */
    public class ReadPropertiesFile {
        
        public static void main(String[] args) {
        
            Properties props = new Properties();
            try {
        
                FileInputStream fis = new FileInputStream("example.properties");
                props.load(fis);
                fis.close();
            } catch (IOException e) {
        
                e.printStackTrace();
            }
            
            String username = props.getProperty("username");
            String password = props.getProperty("password");
            System.out.println("Username: " + username);
            System.out.println("Password: " + password);
        }
    }

1.  输出结果：

Username: admin
    Password: 123456

1.  写入配置文件：

import java.io.FileOutputStream;
    import java.io.IOException;
    import java.util.Properties;
    /**
     *
     * @description:  WritePropertiesFile 
     * @copyright: @Copyright (c) 2022
     * @company: Aiocloud
     * @author: pany
     * @version: 1.0.0
     * @createTime: 2023-07-07 17:35
     */
    public class WritePropertiesFile {
        
        public static void main(String[] args) {
        
            Properties props = new Properties();
            props.setProperty("username", "admin");
            props.setProperty("password", "123456");
             try {
        
                FileOutputStream fos = new FileOutputStream("example.properties");
                props.store(fos, "Example Configuration");
                fos.close();
            } catch (IOException e) {
        
                e.printStackTrace();
            }
            
            System.out.println("Configuration saved successfully.");
        }
    }

1.  运行后，会在当前目录下生成一个新的配置文件 example.properties，内容如下：

// Example Configuration
    username=admin
    password=123456

>  精彩专栏推荐订阅：在下方专栏??

>  ✅ [2023年华为OD机试真题（A卷&B卷）+ 面试指导 ][2023_OD_A_B_ _]  
>  ✅ [ 精选100套 Java 项目案例 ][_100_ Java _]  
>  ✅ [面试需要避开的坑（活动）][Link 3]  
>  ✅ [你找不到的核心代码][Link 4]  
>  ✅ [带你手撕 Spring][Spring]

> ?? 本文由激流原创，原创不易，希望大家关注、点赞、收藏，给博主一点鼓励，感谢！！！

![在这里插入图片描述][7b7478e55aa24a948b358051ef941b6a.webp_pic_center]

[4b7ba7d27b774fcb9db77011b66c3303.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/04/106c29e00b46404da9d5920620476cc6.png
[Link 1]: https://bbs.csdn.net/forums/45c04d3f41cc4dadaf312be1d1379b45?category=10003
[Link 2]: https://jiliu.blog.csdn.net/
[Java]: https://blog.csdn.net/qq_37967783/category_9902143.html
[Java 1]: https://blog.csdn.net/qq_37967783/article/details/130940512
[2023_OD_A_B_ _]: https://blog.csdn.net/qq_37967783/category_12389634.html
[_100_ Java _]: https://blog.csdn.net/qq_37967783/category_12388267.html
[Link 3]: https://blog.csdn.net/qq_37967783/category_12380337.html
[Link 4]: https://blog.csdn.net/qq_37967783/category_12391346.html
[Spring]: https://blog.csdn.net/qq_37967783/category_12391987.html
[7b7478e55aa24a948b358051ef941b6a.webp_pic_center]: https://img-blog.csdnimg.cn/7b7478e55aa24a948b358051ef941b6a.webp#pic_center