java打包,配置文件放外面

原创

mob649e816a3664 2023-07-27 12:45:47 ©著作权

文章标签 配置文件 Java java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e816a3664的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java打包：配置文件放外面

在Java开发中，我们经常需要使用配置文件来存储一些程序的参数或者配置信息。通常情况下，配置文件会和Java代码放在同一个目录下，但是这种方式并不是最理想的。在本文中，我们将探讨一种更好的方式：将配置文件放在Java代码的外面。

为什么需要将配置文件放外面？

将配置文件放在Java代码的外面有以下几个优点：

灵活性：将配置文件和代码分离，可以方便地对配置进行修改，而无需重新编译和打包整个项目。
安全性：有些配置文件可能包含敏感信息，例如数据库密码等。将配置文件放在代码外面，可以避免这些敏感信息被意外泄露。
可维护性：将配置文件和代码分开，可以使代码更加清晰和易于维护。

如何将配置文件放外面？

下面是一种常见的做法来将配置文件放在Java代码的外面。

在Java代码中使用java.util.Properties类来读取配置文件。Properties类提供了一种简单的方式来读取和写入属性文件。

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

public class ConfigReader {
    private static final String CONFIG_FILE = "config.properties";

    public static void main(String[] args) {
        Properties properties = loadConfig();
        String username = properties.getProperty("username");
        String password = properties.getProperty("password");
        // 使用配置参数进行相应的操作
    }

    private static Properties loadConfig() {
        Properties properties = new Properties();
        try (InputStream inputStream = ConfigReader.class.getClassLoader().getResourceAsStream(CONFIG_FILE)) {
            properties.load(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return properties;
    }
}

将配置文件放在Java代码的外面。可以将配置文件放在项目根目录下，或者放在一个单独的config目录下。

project
├── src
│   └── main
│       └── java
│           └── ConfigReader.java
├── config
│   └── config.properties
└── pom.xml

打包项目时，将配置文件一起打包。可以使用maven来构建项目，并使用maven-assembly-plugin插件来打包时将配置文件包含在内。

<project>
    ...
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>com.example.Main</mainClass>
                        </manifest>
                    </archive>
                    <appendAssemblyId>false</appendAssemblyId>
                    <finalName>${project.artifactId}-${project.version}</finalName>
                    <outputDirectory>target</outputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    ...
</project>

以上配置将会生成一个包含所有依赖以及配置文件的可执行jar包。