Spring Boot 指定外部配置文件

时间:2024-02-01 16:59:55

前言介绍

当你的Spring Boot应用程序需要外部化配置时,可以使用外部配置文件。这允许你在不修改代码的情况下配置应用程序的各种属性。配置文件放在外部也有利于运维人员的修改。不需要在进入jar 内部修改配置文件。

1.使用外部的配置文件

在运行Spring Boot应用程序时,你可以通过-Dspring.config.location参数指定外部配置文件的位置。Spring Boot支持多种外部配置文件格式,包括.properties.yml

java -jar your-application.jar -Dspring.config.location=/path/to/your/config

替换 your-application.jar 为实际的Spring Boot可执行JAR文件名称,将 /path/to/your/config 替换为外部配置文件的实际目录。

也可以打包分离

a. 使用.properties文件

properties文件是一种常见的键值对配置文件格式

# application.properties

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=admin
spring.datasource.password=secret

# 服务器端口
server.port=8080

b. 使用.yml文件


# application.yml

# 数据库配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydatabase
    username: admin
    password: secret

# 服务器端口
server:
  port: 8080

2. 外部化配置的优势

使用外部配置文件有一些明显的优势:

  • 易于维护: 将配置与代码分离,使得在不同环境中更轻松地配置应用程序。
  • 避免硬编码敏感信息: 将敏感信息如数据库连接信息、密码等放置在配置文件中,而不是硬编码在代码中,提高安全性。

3. 提示

在使用外部配置文件时,请考虑以下最佳实践和注意事项:

  • 安全性考虑: 确保外部配置文件中包含的敏感信息得到妥善保护,避免泄露,可以参照我的另一篇文章。
  • 命名规范: 使用一致的命名规范,使得配置文件易于理解和维护。

使用外部配置文件是一种使得应用程序更加灵活和易于管理的良好实践。希望这些指南对你的Spring Boot应用程序配置有所帮助!

4.总结

使用外部配置文件是一种良好的实践,使得在不同环境中更轻松地配置应用程序。Spring Boot通过支持多种文件格式和提供灵活的配置方式,使得外部化配置变得简单而强大。在配置文件中放置各种属性,如数据库连接信息、端口号等,能够更方便地管理和维护你的应用程序。

以下是Spring Boot官方文档的链接,其中包含关于启动参数和配置的详细信息:
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.server

在文档中,你可以查找有关启动参数的信息。这些章节通常会涵盖如何使用命令行参数、配置文件、环境变量等方式来配置你的Spring Boot应用程序。

如果你使用的是不同的Spring Boot版本,你可以在Spring Boot文档首页上选择合适的版本,然后导航到相应的章节查找所需的信息。

请确保参考与你正在使用的Spring Boot版本匹配的文档,以获取最准确和最新的信息。