Java Properties 类详解
Properties
是 Java 中用于处理 键值对配置文件 的特殊类,继承自 Hashtable<Object,Object>
。以下是其核心知识点:
1. 核心特性
特性 | 说明 |
---|---|
存储格式 | 纯文本文件(.properties ),每行 key=value |
编码 | 默认 ISO-8859-1,中文需用 Unicode 转义(如 \u4e2d\u6587 ) |
线程安全 | 是(继承自 Hashtable) |
常用方法 | getProperty() , setProperty() , load() , store() |
2. 基础使用示例
java
// 创建 Properties 对象
Properties props = new Properties();
// 设置属性
props.setProperty("username", "admin");
props.setProperty("password", "123456");
// 获取属性
String user = props.getProperty("username"); // "admin"
// 获取带默认值的属性
String timeout = props.getProperty("timeout", "30"); // 若不存在返回"30"
3. 文件读写操作
写入配置文件
java
try (OutputStream out = new FileOutputStream("config.properties")) {
props.store(out, "This is a comment");
} catch (IOException e) {
e.printStackTrace();
}
生成的文件内容:
properties
java
#This is a comment
username=admin
password=123456
读取配置文件
java
try (InputStream in = new FileInputStream("config.properties")) {
props.load(in);
System.out.println(props.getProperty("username")); // 输出 "admin"
} catch (IOException e) {
e.printStackTrace();
}
4. 特殊方法
方法 | 作用 |
---|---|
list(PrintStream out) |
将属性列表输出到指定流(调试用) |
stringPropertyNames() |
返回所有键的 Set(返回类型为 Set<String> ,而非 Set<Object> ) |
loadFromXML() /storeToXML() |
读写 XML 格式的配置文件 |
5. 处理中文的两种方式
方法1:Unicode 转义
properties
java
# 直接写中文会乱码
name=\u4e2d\u6587
方法2:使用 native2ascii 工具转换
bash
bash
# JDK 工具转换
native2ascii -encoding UTF-8 src.txt dest.properties
6. 从类路径加载资源
java
bash
try (InputStream in = getClass().getResourceAsStream("/app.properties")) {
props.load(in);
} catch (IOException e) {
e.printStackTrace();
}
7. 与 HashMap 的区别
对比项 | Properties | HashMap |
---|---|---|
设计目的 | 配置文件管理 | 通用键值存储 |
键值类型 | 只允许 String | 允许任意对象 |
线程安全 | 是 | 否 |
持久化支持 | 内置 load/store 方法 | 需手动实现 |
8. 实际应用场景
-
读取数据库配置
properties
bash# db.properties jdbc.url=jdbc:mysql://localhost:3306/test jdbc.user=root jdbc.password=123456
国际化资源文件
properties
bash# messages_zh_CN.properties welcome=欢迎 error=错误
系统属性覆盖
java
bash
// 合并系统属性
Properties systemProps = System.getProperties();
Properties myProps = new Properties(systemProps);
9. 注意事项
-
不要滥用 :复杂配置建议用 YAML/JSON 格式(如 Spring Boot 的
application.yml
) -
编码问题:建议统一使用 UTF-8 编码,配合 IDE 的 properties 文件插件
-
性能优化:频繁读取的配置可缓存到内存中