【Java 基础篇】Java Properties 详解：配置文件和键值对存储

浅浅的花香味﹌ 2023-10-16 10:55 10阅读 0赞

![在这里插入图片描述][184548b62bc04683aeac17bcc1c31557.png]

在 Java 编程中，配置文件和键值对存储是非常常见的需求，用于存储应用程序的配置参数、用户首选项、国际化信息等。Java 提供了 `Properties` 类来处理这种类型的数据，它是一个轻量级的配置文件和键值对存储工具。本文将详细介绍 Java 的 `Properties` 类，向您展示如何使用它来管理配置数据。

## 什么是 Properties？ ##

`Properties` 是 Java 标准库中的一个类，用于处理配置文件和键值对存储。它继承自 `Hashtable` 类，因此可以存储一组键值对，其中键和值都是字符串类型。这使得 `Properties` 成为一种理想的配置文件格式，因为它是文本文件，易于创建、编辑和维护。

## 创建 Properties 对象 ##

要使用 `Properties` 类，首先需要创建一个 `Properties` 对象。以下是如何创建 `Properties` 对象的示例：

import java.util.Properties;
    
    public class PropertiesExample {
        
        public static void main(String[] args) {
        
            Properties properties = new Properties();
        }
    }

现在，我们有了一个名为 `properties` 的 `Properties` 对象，可以使用它来存储键值对数据。

## 添加和获取属性 ##

`Properties` 对象提供了多种方法来添加和获取属性。最常用的方法是 `setProperty` 和 `getProperty`。

### 添加属性 ###

使用 `setProperty` 方法可以向 `Properties` 对象中添加属性，如下所示：

properties.setProperty("database.url", "jdbc:mysql://localhost:3306/mydb");
    properties.setProperty("database.username", "user123");
    properties.setProperty("database.password", "secretpassword");

在上面的示例中，我们添加了三个属性，分别是数据库连接 URL、用户名和密码。

### 获取属性 ###

使用 `getProperty` 方法可以获取属性的值，如下所示：

String url = properties.getProperty("database.url");
    String username = properties.getProperty("database.username");
    String password = properties.getProperty("database.password");

现在，我们可以获取数据库连接 URL、用户名和密码的值。

## 从文件加载 Properties ##

通常，配置数据存储在文件中，我们可以使用 `load` 方法从文件加载 `Properties`。以下是如何从文件加载 `Properties` 的示例：

import java.io.FileInputStream;
    import java.io.IOException;
    
    public class LoadPropertiesFromFileExample {
        
        public static void main(String[] args) {
        
            Properties properties = new Properties();
            try (FileInputStream fis = new FileInputStream("config.properties")) {
        
                properties.load(fis);
            } catch (IOException e) {
        
                e.printStackTrace();
            }
        }
    }

在上面的示例中，我们使用 `FileInputStream` 打开一个配置文件（假设文件名为 `config.properties`），然后使用 `load` 方法加载文件中的属性。这将文件中的键值对数据加载到 `Properties` 对象中。

## 将 Properties 写入文件 ##

除了从文件加载 `Properties`，我们还可以使用 `store` 方法将 `Properties` 中的属性写入文件。以下是如何将 `Properties` 写入文件的示例：

import java.io.FileOutputStream;
    import java.io.IOException;
    
    public class StorePropertiesToFileExample {
        
        public static void main(String[] args) {
        
            Properties properties = new Properties();
            properties.setProperty("database.url", "jdbc:mysql://localhost:3306/mydb");
            properties.setProperty("database.username", "user123");
            properties.setProperty("database.password", "secretpassword");
    
            try (FileOutputStream fos = new FileOutputStream("config.properties")) {
        
                properties.store(fos, "Database Configuration");
            } catch (IOException e) {
        
                e.printStackTrace();
            }
        }
    }

在上面的示例中，我们首先将属性设置到 `Properties` 对象中，然后使用 `FileOutputStream` 打开一个文件（假设文件名为 `config.properties`），最后使用 `store` 方法将 `Properties` 写入文件。

## 默认值 ##

如果在尝试获取属性值时属性不存在，`getProperty` 方法将返回 `null`。为了避免 `null` 值，我们可以在 `getProperty` 方法中提供默认值，如下所示：

String url = properties.getProperty("database.url", "jdbc:mysql://localhost:3306/defaultdb");

在上面的示例中，如果 `database.url` 属性不存在，`url` 变量将包含默认值 `"jdbc:mysql://localhost:3306/defaultdb"`。

## 遍历 Properties ##

如果需要遍历 `Properties` 中的所有属性，可以使用 `propertyNames` 方法，如下所示：

Enumeration<?> propertyNames = properties.propertyNames();
    while (propertyNames.hasMoreElements()) {
        
        String key = (String) propertyNames.nextElement();
        String value = properties.getProperty(key);
        System.out.println(key + ": " + value);
    }

上面的代码将列出 `Properties` 中的所有属性和它们的值。

## 更多用法 ##

当使用 `Properties` 类时，还有一些有用的方法和技巧可以帮助您更好地管理配置数据。以下是一些 `Properties` 的更多用法：

1.  **默认属性值：** 您可以使用 `setProperty` 方法设置属性的默认值，以便在未找到属性时返回默认值。这对于确保配置的某些属性始终具有值非常有用。
    
        properties.setProperty("database.maxConnections", "10");
2.  **移除属性：** 如果要删除属性，可以使用 `remove` 方法。
    
        properties.remove("database.password");
3.  **获取属性名列表：** 如果需要获取所有属性名的列表，可以使用 `stringPropertyNames` 方法。
    
        Set<String> propertyNames = properties.stringPropertyNames();
4.  **注释：** 您可以为 `store` 方法提供注释，以使配置文件更易于理解。
    
        properties.store(outputStream, "Database Configuration");
5.  **默认属性：** `Properties` 对象可以有一个默认属性列表，这些属性将在没有在主属性列表中找到属性时返回。
    
        Properties defaults = new Properties();
        defaults.setProperty("database.maxConnections", "10");
        
        Properties properties = new Properties(defaults);
6.  **加载资源文件：** 除了从文件加载，您还可以使用 `ClassLoader` 加载资源文件中的属性。
    
        InputStream inputStream = getClass().getResourceAsStream("/config.properties");
        properties.load(inputStream);
7.  **保存和加载 XML 格式的 Properties：** 您可以使用 `storeToXML` 和 `loadFromXML` 方法来保存和加载 XML 格式的 `Properties`。
    
        properties.storeToXML(outputStream, "Database Configuration", "UTF-8");
        properties.loadFromXML(inputStream);
8.  **特殊字符转义：** 如果属性值中包含特殊字符（例如冒号、等号、换行符等），可以使用 `Properties` 的 `load` 方法来正确地转义和解析这些字符。
    
        properties.setProperty("specialChars", "This is a colon : and this is an equal sign =");
        properties.store(outputStream, "Properties with special characters");

这些技巧和方法可以帮助您更好地使用 `Properties` 类来管理和处理配置数据。根据您的具体需求，选择适合的方法和技巧，以便更有效地处理和维护您的配置文件和键值对数据。

## 注意事项 ##

当使用 `Properties` 类来处理配置文件时，有一些注意事项需要考虑，以确保您的应用程序能够正常运行并维护配置数据的一致性。以下是一些 `Properties` 使用的注意事项：

1.  **字符编码问题：** 默认情况下，`Properties` 使用 ISO 8859-1 字符编码。如果您的配置文件包含非拉丁字符集的字符，应该使用包含字符编码的 `Reader` 或 `InputStream` 来加载配置文件，以确保字符正确解析。例如：
    
        InputStreamReader reader = new InputStreamReader(inputStream, "UTF-8");
        properties.load(reader);
2.  **属性键和值的限制：** 属性键和值不能包含换行符或冒号等特殊字符，因为这些字符被用作属性文件的分隔符。如果需要在属性值中包含这些字符，可以进行适当的转义。
3.  **注释的保存：** 使用 `store` 方法保存属性文件时，注释会丢失。如果需要保留注释，可以考虑使用 XML 格式的配置文件，其中注释信息可以更容易地保留。
4.  **属性名的大小写敏感性：** `Properties` 类在默认情况下对属性名不区分大小写。这意味着 `getProperty("example")` 和 `getProperty("EXAMPLE")` 将返回相同的值。如果需要区分大小写，请使用 `setProperty` 和 `getProperty` 方法的重载版本来进行区分。
5.  **默认属性的使用：** 当创建 `Properties` 对象时，您可以指定默认属性。这些默认属性将在主属性列表中找不到属性时返回。确保仅将通用的默认属性添加到默认属性列表中，以避免混淆。
6.  **安全性考虑：** 在某些情况下，配置文件可能包含敏感信息，如密码。请确保配置文件的安全性，避免将敏感信息存储为纯文本。一种安全的方法是使用加密或其他安全措施来保护敏感信息。
7.  **线程安全性：** `Properties` 类不是线程安全的。如果多个线程同时访问和修改 `Properties` 对象，可能会导致并发问题。在多线程环境中使用时，请考虑使用同步机制或线程安全的集合来确保数据一致性。
8.  **异常处理：** 在加载配置文件或访问属性值时，请考虑异常处理。例如，在加载配置文件时，捕获 `IOException`；在访问属性值时，捕获 `NullPointerException` 或 `ClassCastException`，以避免应用程序崩溃。
9.  **备份和版本控制：** 定期备份您的配置文件，并使用版本控制工具来跟踪配置文件的更改。这有助于恢复以前的配置状态，并确保配置文件的历史记录。
10. **文档和注释：** 在配置文件中添加注释和文档，以帮助其他开发人员理解配置项的用途和取值范围。这将有助于维护和协作。

遵循这些注意事项将有助于确保您的 `Properties` 配置文件的可靠性和可维护性，同时提高应用程序的稳定性。

## 总结 ##

`Properties` 类是 Java 中处理配置文件和键值对存储的一种简单且强大的方式。通过创建 `Properties` 对象，我们可以轻松地添加、获取和管理属性。此外，我们还可以从文件加载 `Properties`，将 `Properties` 写入文件，并设置默认值，以满足各种配置需求。希望本文能帮助您更好地理解和使用 `Properties` 类，以便在 Java 应用程序中有效地管理配置数据。

[184548b62bc04683aeac17bcc1c31557.png]: https://img-blog.csdnimg.cn/184548b62bc04683aeac17bcc1c31557.png