Java中的Properties

在 Java 中，Properties 是一个专门用于存储键值对（key-value pairs）的数据结构，通常用于配置文件的读取和写入。它是 Hashtable 的子类，因此继承了 Hashtable 的许多特性，同时针对字符串键和值进行了优化。

以下是关于 Properties 数据结构的详细说明：

---

1. Properties 的定义

• Properties 是 Java 标准库中的一个类，位于 java.util 包中。
• 它是一个键值对集合，其中键和值都必须是字符串类型（String）。
• 主要用于存储配置信息，例如数据库连接参数、应用程序设置等。

---

2. Properties 的继承关系

Properties 继承自 Hashtable<Object, Object>，但对其进行了限制：

• 键和值只能是 String 类型。
• 提供了一些额外的方法，专门用于加载和保存属性文件。

继承关系图：

Object
    ↳ Hashtable<Object, Object>
        ↳ Properties

---

3. 主要特点

(1) 键值对存储

• Properties 是一个键值对集合，类似于 Map<String, String>。
• 每个键和值都必须是字符串类型。

(2) 线程安全

• 因为 Properties 继承自 Hashtable，而 Hashtable 是线程安全的，所以 Properties 也是线程安全的。
• 线程安全性是通过同步方法实现的，但这可能会带来性能开销。

(3) 配置文件支持

• Properties 提供了专门的方法来加载和保存属性文件（通常是 .properties 文件）。

• 属性文件的内容以键值对的形式存储，格式如下：

  key=value
  

(4) 默认值支持

• Properties 提供了一个 defaults 属性，可以指定默认的属性值。如果某个键在当前 Properties 实例中不存在，则会从默认属性中查找。

---

4. 常用方法

以下是一些常用的 Properties 方法：

(1) 加载属性

• load(InputStream inStream)：从输入流中加载属性。
• load(Reader reader)：从字符流中加载属性。

示例：

Properties props = new Properties();
try (FileInputStream in = new FileInputStream("config.properties")) {
    props.load(in); // 加载属性文件
} catch (IOException e) {
    e.printStackTrace();
}

(2) 保存属性

• store(OutputStream out, String comments)：将属性保存到输出流中，并可添加注释。
• store(Writer writer, String comments)：将属性保存到字符流中。

示例：

Properties props = new Properties();
props.setProperty("name", "Alice");
props.setProperty("age", "25");

try (FileOutputStream out = new FileOutputStream("config.properties")) {
    props.store(out, "User Configuration"); // 保存属性文件
} catch (IOException e) {
    e.printStackTrace();
}

(3) 获取属性

• getProperty(String key)：根据键获取对应的值。
• getProperty(String key, String defaultValue)：如果键不存在，则返回默认值。

示例：

String name = props.getProperty("name", "Unknown"); // 获取键 "name" 的值，如果不存在则返回 "Unknown"
System.out.println("Name: " + name);

(4) 设置属性

• setProperty(String key, String value)：设置键值对。

示例：

props.setProperty("name", "Bob"); // 设置键 "name" 的值为 "Bob"

---

5. 内部实现

Properties 内部使用 Hashtable 来存储键值对。由于 Hashtable 是基于哈希表实现的，因此 Properties 的操作效率与 Hashtable 相同：

• 插入、删除和查找的时间复杂度为 O(1)（平均情况下）。

---

6. 示例代码

以下是一个完整的示例，展示如何使用 Properties 类读取和写入配置文件：

(1) 创建并保存属性文件

import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;

public class PropertiesExample {
    public static void main(String[] args) {
        Properties props = new Properties();
        props.setProperty("name", "Alice");
        props.setProperty("age", "25");

        try (FileOutputStream out = new FileOutputStream("config.properties")) {
            props.store(out, "User Configuration"); // 保存属性文件
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

生成的 config.properties 文件内容：

#User Configuration
#Wed Feb 21 10:00:00 CST 2024
name=Alice
age=25

(2) 读取属性文件

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class PropertiesReader {
    public static void main(String[] args) {
        Properties props = new Properties();
        try (FileInputStream in = new FileInputStream("config.properties")) {
            props.load(in); // 加载属性文件
        } catch (IOException e) {
            e.printStackTrace();
        }

        String name = props.getProperty("name", "Unknown");
        String age = props.getProperty("age", "0");
        System.out.println("Name: " + name);
        System.out.println("Age: " + age);
    }
}

输出结果：

Name: Alice
Age: 25

---

7. 注意事项

• 键和值的类型：Properties 的键和值必须是 String 类型。如果需要存储其他类型的值，可以通过序列化或转换为字符串的方式实现。
• 性能问题：由于 Properties 继承自 Hashtable，所有方法都是同步的，这可能导致性能瓶颈。如果不需要线程安全，可以考虑使用 HashMap 或其他非同步的集合。
• 默认值支持：通过构造函数 Properties(Properties defaults) 可以指定默认属性。

---

8. 总结

特性	描述
数据结构	基于 Hashtable 实现的键值对集合，键和值必须是 String 类型。
线程安全	是线程安全的，因为继承自 Hashtable。
用途	主要用于存储和管理配置文件中的键值对。
常用方法	提供了加载、保存、获取和设置属性的方法。

Properties 是 Java 中处理配置文件的标准工具，简单易用且功能强大，非常适合中小型项目的配置管理需求。