【Java基础-53】Java中的Properties类及其方法详解

AllenBright

于 2025-03-07 16:46:15 发布

阅读量547

点赞数 8

分类专栏： # Java基础文章标签： java 数据库

本文链接：https://blog.csdn.net/weixin_39033358/article/details/146094828

版权

Java基础专栏收录该内容

129 篇文章

订阅专栏

在Java编程中，Properties类是一个非常常用的工具类，用于处理配置文件和键值对数据。它继承自Hashtable，因此具有Hashtable的所有特性，并且在此基础上提供了更多与配置文件相关的方法。本文将详细介绍Properties类的使用方法，并通过示例代码帮助读者更好地理解其功能。

1. Properties类概述

Properties类是java.util包中的一个类，主要用于处理属性文件（.properties文件）。属性文件通常用于存储配置信息，例如数据库连接信息、应用程序设置等。Properties类允许我们轻松地读取、写入和操作这些属性。

1.1 Properties类的特点

键值对存储：Properties类以键值对的形式存储数据，键和值都是字符串类型。
继承自Hashtable：由于Properties继承自Hashtable，因此它具有Hashtable的所有方法，例如put、get、remove等。
支持文件操作：Properties类提供了直接从文件加载属性或将属性保存到文件的方法。
支持默认值：Properties类允许为属性设置默认值，当某个键不存在时，可以返回默认值。

2. Properties类的常用方法

2.1 构造方法

Properties类提供了两个常用的构造方法：

Properties()：创建一个空的属性列表。
Properties(Properties defaults)：创建一个带有指定默认值的属性列表。

Properties props = new Properties();
Properties defaultProps = new Properties();
defaultProps.setProperty("user", "admin");
Properties propsWithDefaults = new Properties(defaultProps);

2.2 常用方法

2.2.1 设置和获取属性

setProperty(String key, String value)：设置属性键值对。
getProperty(String key)：获取指定键对应的值。
getProperty(String key, String defaultValue)：获取指定键对应的值，如果键不存在，则返回默认值。

props.setProperty("username", "admin");
props.setProperty("password", "123456");

String username = props.getProperty("username"); // 返回 "admin"
String password = props.getProperty("password"); // 返回 "123456"
String timeout = props.getProperty("timeout", "30"); // 返回 "30"，因为键不存在

2.2.2 加载和保存属性

load(InputStream inStream)：从输入流中加载属性列表。
load(Reader reader)：从字符流中加载属性列表。
store(OutputStream out, String comments)：将属性列表保存到输出流，并添加注释。
store(Writer writer, String comments)：将属性列表保存到字符流，并添加注释。

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

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

2.2.3 遍历属性

stringPropertyNames()：返回所有属性键的集合。
entrySet()：返回所有属性键值对的集合。

for (String key : props.stringPropertyNames()) {
    String value = props.getProperty(key);
    System.out.println(key + " = " + value);
}

for (Map.Entry<Object, Object> entry : props.entrySet()) {
    System.out.println(entry.getKey() + " = " + entry.getValue());
}

2.2.4 其他方法

list(PrintStream out)：将属性列表打印到指定的输出流。
list(PrintWriter out)：将属性列表打印到指定的字符输出流。
clear()：清空所有属性。

props.list(System.out); // 打印属性列表到控制台
props.clear(); // 清空所有属性

3. 使用示例

3.1 读取配置文件

假设我们有一个config.properties文件，内容如下：

# Application Configuration
username=admin
password=123456
timeout=30

我们可以使用Properties类来读取这些配置：

Properties props = new Properties();
try (InputStream input = new FileInputStream("config.properties")) {
    props.load(input);
} catch (IOException e) {
    e.printStackTrace();
}

String username = props.getProperty("username");
String password = props.getProperty("password");
String timeout = props.getProperty("timeout", "30");

System.out.println("Username: " + username);
System.out.println("Password: " + password);
System.out.println("Timeout: " + timeout);

3.2 写入配置文件

我们也可以使用Properties类将配置写入文件：

Properties props = new Properties();
props.setProperty("username", "admin");
props.setProperty("password", "123456");
props.setProperty("timeout", "30");

try (OutputStream output = new FileOutputStream("config.properties")) {
    props.store(output, "Application Configuration");
} catch (IOException e) {
    e.printStackTrace();
}

3.3 使用默认值

我们可以为Properties对象设置默认值，当某个键不存在时，返回默认值：

Properties defaultProps = new Properties();
defaultProps.setProperty("timeout", "30");

Properties props = new Properties(defaultProps);
props.setProperty("username", "admin");
props.setProperty("password", "123456");

String timeout = props.getProperty("timeout"); // 返回 "30"，即使没有显式设置