Java集合——8.使用Properties

目录

• Java中Properties类：配置文件操作
  • Properties类的本质
  • 读取配置文件的步骤
    • 1. 创建Properties实例
    • 2. 加载配置文件
    • 3. 获取配置值
  • 写入配置文件
  • 处理编码问题
  • 注意事项

---

Java中Properties类：配置文件操作

在开发Java应用程序时，配置文件是存储程序参数的常用方式，Java集合框架提供了Properties类专门用于处理这种键值对形式的配置文件。

Properties类的本质

Properties类虽然本质上是Hashtable的子类（历史遗留设计），但它专为处理字符串类型的键值对（String-String）设计。其特点包括：

• 专注于配置文件的读写，提供了便捷的getProperty()和setProperty()方法
• 支持从多种输入流（文件、classpath资源、内存流等）加载配置
• 可以将修改后的配置写入文件，保留注释信息
• 兼容.properties文件格式（以key=value为行，#开头为注释）

读取配置文件的步骤

使用Properties读取配置文件通常分为三步：

1. 创建Properties实例

Properties props = new Properties();

2. 加载配置文件

Properties提供了load()方法加载配置，支持多种输入源：

• 从文件系统加载：

  // 读取本地文件系统中的配置文件
  props.load(new FileInputStream("config/setting.properties"));
  

• 从classpath加载：

  // 读取项目资源目录中的配置文件（适合打包在jar中的默认配置）
  props.load(getClass().getResourceAsStream("/default.properties"));
  

• 从内存流加载：

  // 从字符串生成的字节流中读取配置
  String configStr = "app.name=MyApp\nversion=1.0";
  ByteArrayInputStream in = new ByteArrayInputStream(configStr.getBytes(StandardCharsets.UTF_8));
  props.load(in);
  

3. 获取配置值

使用getProperty()方法获取配置，可指定默认值（当键不存在时返回）：

// 获取配置，不存在则返回null
String lastFile = props.getProperty("last_open_file");

// 获取配置，不存在则返回默认值120
int interval = Integer.parseInt(props.getProperty("auto_save_interval", "120"));

写入配置文件

当需要保存修改后的配置时，使用store()方法将Properties实例中的键值对写入文件：

Properties props = new Properties();
// 设置配置项
props.setProperty("url", "https://example.com");
props.setProperty("timeout", "3000");

// 写入文件，第二个参数为注释
try (FileOutputStream out = new FileOutputStream("config/user.properties")) {
    props.store(out, "User configuration updated at " + new Date());
} catch (IOException e) {
    e.printStackTrace();
}

写入的文件会自动保留key=value格式，注释行会以#开头。

处理编码问题

早期Java版本中，.properties文件默认使用ASCII编码（ISO8859-1），中文需要转义为\uXXXX形式。JDK9及以上版本支持UTF-8编码，但需注意：

• 读取UTF-8编码的配置文件时，应使用load(Reader)方法（字符流）而非load(InputStream)（字节流）：

  // 正确读取UTF-8编码的配置文件
  props.load(new FileReader("config/chinese.properties", StandardCharsets.UTF_8));
  

• 写入包含中文的配置时，store()方法默认会对非ASCII字符转义，若需保留UTF-8明文，可使用第三方库或自定义处理。

注意事项

1. 优先使用专用方法：始终使用getProperty()和setProperty()方法，避免调用从Hashtable继承的get()、put()等方法（这些方法支持非字符串类型，可能破坏配置的一致性）。

2. 分层配置策略：将默认配置放在classpath中，再通过外部配置文件覆盖部分参数，实现灵活的环境适配：

   // 加载默认配置
   props.load(getClass().getResourceAsStream("/default.properties"));
   // 加载外部配置覆盖默认值
   props.load(new FileInputStream("conf/custom.properties"));
   

3. 资源关闭：使用try-with-resources语法确保输入输出流正确关闭，避免资源泄漏。