如何在Java中使用Properties类？

介绍

当我们开发 Java 应用程序时，通常需要使用一些配置，例如数据库的 URL、服务器的端口等。我们不想将这些设置直接硬编码到代码中，而是从代码外部的某个位置（例如属性文件）获取它们。或者甚至能够在运行时保存配置以便稍后读取。

无论哪种情况，我们都可以针对某些场景制定自己的解决方案，例如创建一个文本文件并在第一行保存数据库的URL，在第二行保存服务器端口等。但这可能很乏味且容易出错，因此需要更强大且可扩展的解决方案。对于这种情况，Java 为我们提供了一个非常简单高效的解决方案，即 Properties 类。

什么是属性类？

Properties 是 java.util 包中的一个类，它允许我们将配置临时保存在内存中并永久保存在属性文件中，以便我们稍后可以读取它们并在我们的应用程序中使用它们。通过创建 Properties 类的实例，您将获得一个行为类似于字典的对象，其中每个配置都保存为键值对。

使用属性类

首先，必须创建 Properties 类的实例。

Properties props = new Properties();

通过继承HashTable类（它又继承自Dictionary），在Properties类中我们可以看到它有Object类型的方法，而实际上值应该是字符串或String，而不是，每次使用值时都不需要强制转换字符串。这样，虽然实例中存在地图的常用方法，但大多数情况下没有必要使用它们。例如，您可以使用 getProperty(String key)，而不是使用 get(Object key)。

定义属性

定义一个属性，需要用到setProperty(String key, String value)方法，正如它的名字所示，这个方法接收两个参数，key（你想如何调用属性）和value（属性值） ），考虑到两个参数始终应为 String 类型。

Properties props = new Properties();
props.setProperty("DB_HOST", "localhost");
props.setProperty("DB_PORT", "3306");
props.setProperty("DB_USER", "root");
props.setProperty("DB_PASS", "p4ssw0rd");

获得房产

要获取属性，可以使用 getProperty(String key) 方法，该方法接收要获取的属性的键作为参数，如果属性不存在，将返回 null。

Properties props = new Properties();

为了避免在属性不存在时获取 null，您可以使用 getProperty(String key, String defaultValue) 方法，该方法接收默认值作为第二个参数。

Properties props = new Properties();
props.setProperty("DB_HOST", "localhost");
props.setProperty("DB_PORT", "3306");
props.setProperty("DB_USER", "root");
props.setProperty("DB_PASS", "p4ssw0rd");

迭代属性

由于它是一个map类型的对象（虽然不建议使用HashTable方法），它有entrySet()方法，但是正如你所看到的，它是Object类型的，迭代所有属性的替代方法是使用 stringPropertyNames() 方法，该方法返回一组包含所有属性键的字符串（返回值不分先后）。

var API_URL = props.getProperty("API_URL");
System.out.println(API_URL);

// Output
null

显示所有属性的更快方法是使用 list(PrintStream out) 方法，该方法将所有属性打印到作为参数传递的输出流，例如 System.out。

var API_URL = props.getProperty("API_URL", "http://api.example.com");
System.out.println(API_URL);

// Output
http://api.example.com

将属性保存到文件

Properties 提供了 store() 和 storeToXML() 方法，以便属性可以以 properties (key=value) 格式和 XML 格式保存（这可以是如果这些属性将分别在不同的环境中使用，则很有用）。不要使用 save() 方法，因为它已过时，并且不建议使用它，因为它在发生错误时不会抛出异常。

在将属性保存到文件之前，我们可以执行以下操作，通过控制台验证使用 store() 和 System.out 方法实际保存的内容，以某种方式控制抛出的异常非常重要。

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

// Output
DB_PORT = 3306
DB_PASS = p4ssw0rd
DB_USER = root
DB_HOST = localhost

分析结果可以看到，第一行保存了作为第二个参数传入的注释（是否为空字符串没关系，如果为null则不打印），在第二行保存保存属性的日期和时间，从第三行开始，属性以 key=value.

格式保存

如果使用storeToXML()方法，将会得到一个包含以下内容的文件：

props.list(System.out);

// Output
-- listing properties --
DB_PORT=3306
DB_PASS=p4ssw0rd
DB_USER=root
DB_HOST=localhost

要将属性保存在名为 db.properties 的文件中，您可以执行以下操作：

props.store(System.out, "Database Configuration");

// Output
#Database Configuration
#Thu Oct 10 11:06:04 CST 2024
DB_HOST=localhost
DB_PASS=p4ssw0rd
DB_PORT=3306
DB_USER=root

执行后，如果没有抛出异常，你会看到在程序执行的目录下创建了一个名为 db.properties 的文件，内容如下：

props.storeToXML(System.out, "Database Configuration");

// Output
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>Database Configuration</comment>
<entry key="DB_PORT">3306</entry>
<entry key="DB_PASS">p4ssw0rd</entry>
<entry key="DB_USER">root</entry>
<entry key="DB_HOST">localhost</entry>
</properties>

要将属性保存为 XML 格式，只需将 store() 方法更改为 storeToXML()。

Properties props = new Properties();

从文件加载属性

假设某些属性已被修改或在 db.properties 或 db.properties.xml 文件中添加了新属性，以从两个文件之一加载属性，在 properties 或 XML，可以分别使用load()和loadFromXML()方法。以某种方式控制在文件不存在或无法读取时引发的异常非常重要。

Properties props = new Properties();
props.setProperty("DB_HOST", "localhost");
props.setProperty("DB_PORT", "3306");
props.setProperty("DB_USER", "root");
props.setProperty("DB_PASS", "p4ssw0rd");

var API_URL = props.getProperty("API_URL");
System.out.println(API_URL);

// Output
null

属性加载后，可以在控制台中显示它们以验证它们是否已正确加载。

var API_URL = props.getProperty("API_URL", "http://api.example.com");
System.out.println(API_URL);

// Output
http://api.example.com

结论

正如我们所见，Properties 类允许我们以高效且简单的方式处理属性或配置文件，保存和读取属性，这在我们的 Java 应用程序中了解和使用很有趣。

以上是如何在Java中使用Properties类？的详细内容。更多信息请关注PHP中文网其他相关文章！