Java 从文件读取属性（Java Properties from File）

简介

在 Java 开发中，经常需要从外部文件读取配置信息，例如数据库连接参数、应用程序的默认设置等。Java 的 Properties 类提供了一种方便的方式来处理这种需求，它允许我们将键值对存储在文件中，并在程序运行时轻松读取这些值。本文将详细介绍 Java Properties from File 的相关知识，包括基础概念、使用方法、常见实践以及最佳实践。

基础概念

Properties 类是 Java 中用于表示一组持久化的属性的类，它继承自 Hashtable，本质上是一个键值对的集合。属性文件通常是一个文本文件，每一行包含一个键值对，格式为 key=value。注释行以 # 或 ! 开头，会被 Properties 类忽略。

使用方法

读取属性文件

下面是一个简单的示例，展示如何从属性文件中读取属性值：

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class ReadPropertiesExample {
    public static void main(String[] args) {
        Properties properties = new Properties();
        try (FileInputStream fis = new FileInputStream("config.properties")) {
            properties.load(fis);
            String username = properties.getProperty("username");
            String password = properties.getProperty("password");
            System.out.println("Username: " + username);
            System.out.println("Password: " + password);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在上述代码中： 1. 创建一个 Properties 对象。 2. 使用 FileInputStream 打开属性文件，并通过 properties.load(fis) 方法将文件内容加载到 Properties 对象中。 3. 使用 properties.getProperty(key) 方法获取指定键的值。

写入属性文件

以下是一个将属性写入文件的示例：

import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;

public class WritePropertiesExample {
    public static void main(String[] args) {
        Properties properties = new Properties();
        properties.setProperty("username", "JohnDoe");
        properties.setProperty("password", "password123");

        try (FileOutputStream fos = new FileOutputStream("config.properties")) {
            properties.store(fos, "Configuration File");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中： 1. 创建一个 Properties 对象，并设置一些属性键值对。 2. 使用 FileOutputStream 打开一个文件，并通过 properties.store(fos, comment) 方法将属性写入文件，其中 comment 是文件开头的注释信息。

常见实践

配置数据库连接

在实际应用中，经常需要将数据库连接信息存储在属性文件中，以便于修改和管理。以下是一个示例：

import java.io.FileInputStream;
import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Properties;

public class DatabaseConnectionExample {
    public static Connection getConnection() {
        Properties properties = new Properties();
        try (FileInputStream fis = new FileInputStream("database.properties")) {
            properties.load(fis);
            String url = properties.getProperty("db.url");
            String username = properties.getProperty("db.username");
            String password = properties.getProperty("db.password");
            return DriverManager.getConnection(url, username, password);
        } catch (IOException | SQLException e) {
            e.printStackTrace();
            return null;
        }
    }

    public static void main(String[] args) {
        Connection connection = getConnection();
        if (connection!= null) {
            System.out.println("Connected to the database!");
            try {
                connection.close();
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
}

在 database.properties 文件中，内容可以如下：

db.url=jdbc:mysql://localhost:3306/mydb
db.username=root
db.password=rootpassword

管理应用程序设置

属性文件也可用于管理应用程序的各种设置，例如日志级别、缓存大小等。以下是一个简单示例：

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class AppSettingsExample {
    public static void main(String[] args) {
        Properties properties = new Properties();
        try (FileInputStream fis = new FileInputStream("app.properties")) {
            properties.load(fis);
            String logLevel = properties.getProperty("log.level", "INFO");
            int cacheSize = Integer.parseInt(properties.getProperty("cache.size", "100"));
            System.out.println("Log Level: " + logLevel);
            System.out.println("Cache Size: " + cacheSize);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在 app.properties 文件中：

log.level=DEBUG
cache.size=200

最佳实践

属性文件的命名和组织

命名规范：属性文件的命名应具有描述性，清晰地表明其用途。例如，database.properties 用于数据库配置，app-settings.properties 用于应用程序通用设置。
组织方式：根据功能模块或应用程序的不同部分来组织属性文件。例如，将与用户界面相关的设置放在 ui.properties 中，与业务逻辑相关的设置放在 business.properties 中。

错误处理

在读取和写入属性文件时，应进行充分的错误处理。例如，在文件不存在或无法读取时，应给出明确的错误提示，而不是让程序崩溃。可以使用 try-catch 块来捕获 IOException 等异常，并进行相应的处理。

安全考虑

对于包含敏感信息（如密码、密钥等）的属性文件，应采取适当的安全措施： - 文件权限：确保属性文件的访问权限设置为仅允许授权用户读取和修改。 - 加密：对于非常敏感的信息，可以考虑在存储到属性文件之前进行加密，并在读取时进行解密。

小结

通过使用 Java 的 Properties 类从文件读取和写入属性，我们可以轻松地管理应用程序的配置信息。了解基础概念、掌握使用方法，并遵循常见实践和最佳实践，能够使我们的代码更加灵活、可维护和安全。希望本文能够帮助读者深入理解并高效使用 Java Properties from File。