Java 配置文件

为什么需要使用配置文件？

​ 配置文件是一种存储应用程序配置信息的文本文件，它可以存储诸如数据库连接字符串、应用程序路径、调试开关、日志级别等一些与应用程序相关的信息。

优点：

避免硬编码：

1. 硬编码是指将应用程序的配置信息直接嵌入到代码中，这样的代码不仅难以维护，而且需要对代码进行重新编译才能修改这些配置信息。使用配置文件可以将这些信息与代码分离，使得应用程序更加灵活。

提高可移植性：

1. 不同的应用程序在不同的环境下可能需要不同的配置信息，使用配置文件可以使得应用程序的配置信息更易于迁移，使得应用程序在不同的环境下都可以正常运行。

提高安全性：

1. 某些敏感的配置信息，如数据库连接字符串、密码等，不应该直接写在代码中，而是应该保存在安全的地方，使用配置文件可以将这些敏感信息保存在加密的配置文件中，提高了应用程序的安全性。

方便管理：

1. 使用配置文件可以使得应用程序的配置信息更易于管理，如通过配置文件可以很容易地对不同的配置信息进行分类、分组和排序，便于维护和管理。

​ 配置文件是一种非常重要的应用程序开发工具，它可以使得应用程序更加灵活、可移植、安全和易于管理。

Java项目中添加配置文件的步骤

1. 确定配置文件的位置和格式

在Java项目中，通常将配置文件存放在项目的根目录下或者是一个单独的config文件夹中。配置文件的格式可以是.properties文件、.xml文件或者是.json文件等。根据具体需求选择适合的配置文件格式。

2. 创建配置文件

根据项目需求，创建一个新的配置文件，可以使用任何文本编辑器或者集成开发环境（IDE）来创建。根据配置文件的格式，添加相应的键值对或者标签和属性。

下面是一个例子，演示如何创建一个.properties格式的配置文件：

# 配置文件示例
database.url = jdbc:mysql://localhost:3306/mydatabase
database.username = myusername
database.password = mypassword

3. 将配置文件添加到项目中

将配置文件放置在合适的位置，可以选择将配置文件直接放在项目的根目录下，也可以创建一个单独的config文件夹，并将配置文件放入其中。

4. 加载配置文件

在Java代码中，使用合适的方式加载配置文件。根据配置文件的格式不同，有不同的加载方式。下面分别介绍.properties文件、.xml文件和.json文件的加载方式。

加载.properties文件

使用java.util.Properties类来加载.properties文件。

下面是一个示例代码，演示如何加载.properties格式的配置文件：

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

public class ConfigLoader {
    public static void main(String[] args) {
        Properties properties = new Properties();
        
        try {
            FileInputStream fileInputStream = new FileInputStream("config.properties");
            properties.load(fileInputStream);
            fileInputStream.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
        
        // 通过键获取配置值
        String databaseUrl = properties.getProperty("database.url");
        String username = properties.getProperty("database.username");
        String password = properties.getProperty("database.password");
        
        // 打印配置值
        System.out.println("Database URL: " + databaseUrl);
        System.out.println("Username: " + username);
        System.out.println("Password: " + password);
    }
}

加载.xml文件

使用Java的DOM（Document Object Model）或者SAX（Simple API for XML）解析器来加载.xml文件。

下面是一个示例代码，演示如何加载.xml格式的配置文件：

import java.io.File;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

public class ConfigLoader {
    public static void main(String[] args) {
        try {
            File configFile = new File("config.xml");
            DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
            DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
            Document document = documentBuilder.parse(configFile);
            
            // 获取根元素
            Element rootElement = document.getDocumentElement();
            
            // 获取子元素列表
            NodeList nodeList = rootElement.getChildNodes();
            
            // 遍历子元素列表
            for (int i = 0; i < nodeList.getLength(); i++) {
                if (nodeList.item(i).getNodeType() == Node.ELEMENT_NODE) {
                    Element element = (Element) nodeList.item(i);
                    String key = element.getTagName();
                    String value = element.getTextContent();
                    
                    // 打印配置值
                    System.out.println(key + ": " + value);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

加载.json文件

使用第三方库，如Jackson或者Gson，来解析.json文件。

下面是一个示例代码，演示如何加载.json格式的配置文件：

import com.google.gson.Gson;
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.util.Map;

public class ConfigLoader {
    public static void main(String[] args) {
        try {
            BufferedReader bufferedReader = new BufferedReader(new FileReader("config.json"));
            Gson gson = new Gson();
            
            // 将json文件内容读取为Map对象
            Map<String, String> configMap = gson.fromJson(bufferedReader, Map.class);
            
            // 遍历Map对象
            for (Map.Entry<String, String> entry : configMap.entrySet()) {
                String key = entry.getKey();
                String value = entry.getValue();
                
                // 打印配置值
                System.out.println(key + ": " + value);
            }
            
            bufferedReader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}