悠悠楠杉
网站页面
在Java中如何使用Properties类读取配置文件
11/20
在Java开发中，配置文件是项目不可或缺的一部分。无论是数据库连接信息、日志级别设置，还是应用的运行参数，通常都会通过配置文件进行管理，以实现代码与配置的分离，提升项目的可维护性与灵活性。Java标准库中的java.util.Properties类，正是为处理这类键值对形式的配置文件而设计的利器。掌握其使用方法，对于每一个Java开发者而言，都是基础且重要的技能。
Properties类本质上是一个继承自Hashtable的线程安全的映射集合，专门用于存储字符串类型的键和值。最常见的应用场景是读取.properties格式的文本文件，这种文件结构简单，易于编辑，广泛应用于各种Java项目中，包括Spring、Maven插件以及自定义工具类等。
要使用Properties类读取配置文件，首先需要准备一个.properties文件。通常我们会将其放置在src/main/resources目录下，以便在打包时能被正确包含进JAR或WAR文件中。例如，创建一个名为app.properties的文件，内容如下：
properties
database.url=jdbc:mysql://localhost:3306/mydb
database.username=root
database.password=123456
log.level=DEBUG
接下来，在Java代码中加载这个文件。最常见的方式是通过ClassLoader的getResourceAsStream()方法获取输入流，然后调用Properties对象的load()方法进行解析。这种方式能够确保在不同部署环境下（如开发、测试、生产）都能正确加载资源。
示例代码如下：
java
import java.io.InputStream;
import java.util.Properties;
public class ConfigLoader {
private Properties props;
public ConfigLoader() {
props = new Properties();
try (InputStream input = getClass().getClassLoader()
.getResourceAsStream("app.properties")) {
if (input == null) {
throw new RuntimeException("无法找到配置文件 app.properties");
}
props.load(input);
} catch (Exception e) {
throw new RuntimeException("加载配置文件失败", e);
}
}
public String getProperty(String key) {
return props.getProperty(key);
}
public String getProperty(String key, String defaultValue) {
return props.getProperty(key, defaultValue);
}
}
上述代码中，我们通过getClass().getClassLoader().getResourceAsStream()获取了类路径下的资源流。使用try-with-resources语法确保输入流在使用后自动关闭，避免资源泄露。如果文件不存在，getResourceAsStream()会返回null，因此我们需要进行判空处理并抛出有意义的异常。
除了从类路径加载，也可以通过FileInputStream直接读取磁盘上的文件，适用于配置文件位于外部目录的情况。例如：
java
try (FileInputStream fis = new FileInputStream("/path/to/config/app.properties")) {
props.load(fis);
} catch (IOException e) {
e.printStackTrace();
}
但这种方式在部署时容易因路径问题导致失败，因此更推荐将配置文件放在类路径中，利用类加载器机制进行加载。
Properties类还支持写入操作，可以调用store()方法将当前属性保存回文件，适用于需要动态修改配置并持久化的场景。此外，它也提供了propertyNames()方法用于遍历所有键名，方便进行批量处理或调试输出。
值得注意的是，.properties文件默认采用ISO-8859-1编码，如果配置中包含中文字符，需进行转义或使用native2ascii工具转换，否则可能出现乱码。Java 9之后，load()方法支持UTF-8编码的替代方案，但在实际项目中仍建议统一编码规范，避免兼容性问题。
综上所述，Properties类是Java中轻量级、高效且稳定的配置管理工具。合理使用它，不仅能简化配置读取逻辑，还能提升代码的可读性与可维护性。在实际开发中，结合单例模式或依赖注入框架，可以进一步封装配置加载逻辑，使整个应用的配置管理更加清晰有序。
