spring boot将配置文件放在指定目录

原创

mob64ca12de24b0 2024-10-15 06:17:17 ©著作权

文章标签 配置文件 spring 指定目录 文章分类 spring boot 后端开发

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

Spring Boot：将配置文件放在指定目录

Spring Boot 是一种用于简化 Spring 应用程序开发的框架。其核心特性之一是灵活的配置管理。本文将讨论如何将配置文件放置在指定目录，并给出相关的代码示例。我们将涵盖以下内容：

Spring Boot 配置文件概述
如何将配置文件放在指定目录
代码示例
旅行图
流程图
结论

一、Spring Boot 配置文件概述

Spring Boot 使用配置文件简化配置管理，通常使用 application.properties 或 application.yml 文件。默认情况下，这些文件放置在 src/main/resources 目录下，但有时我们希望将它们放置在不同的目录中以满足特定需求，比如外部配置或环境隔离。

二、如何将配置文件放在指定目录

在 Spring Boot 中，你可以通过几种方式指定配置文件的位置：

命令行参数：可以在启动应用程序时使用 --spring.config.location 属性来指定配置文件目录。
```
java -jar your-app.jar --spring.config.location=/path/to/config/
```
环境变量：也可以通过设置 SPRING_CONFIG_LOCATION 环境变量来实现。
```
export SPRING_CONFIG_LOCATION=/path/to/config/
```
在 application.properties 中：尽管不太常见，你可以直接在配置文件中设置路径。
使用 @PropertySource 注解：在配置类中使用 @PropertySource 加载外部文件。

三、代码示例

下面是一个使用 Spring Boot 的示例，我们将配置文件放在指定的目录下。

创建一个新的 Spring Boot 项目，我们将使用 spring-boot-starter 作为基本依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

在 src/main/resources 目录中创建 config 文件夹，并在其中添加配置文件 application.properties。

server.port=8081
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=pass

在 MyApplication.java 中，使用 @SpringBootApplication 注解启动应用程序。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

启动应用程序时，使用命令行参数来指定配置文件位置。
```
java -jar your-app.jar --spring.config.location=classpath:/config/
```

我们可以通过使用 @Value 注解来读取配置。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/port")
    public String getServerPort() {
        return "Server is running on port: " + serverPort;
    }
}

四、旅行图

在这个过程中，你可以采用一定的步骤。这可以在项目中被视为一场"旅行"。以下是一个旅行图的示例：

journey
    title Spring Boot 配置文件放置之旅
    section 制作项目
      创建 Spring Boot 项目      : 5: 开始
    section 添加配置文件
      在指定目录中添加 config 文件 : 4: 进行中
    section 启动应用
      使用命令行启动应用        : 3: 进行中
    section 读取配置
      使用 @Value 注解读取配置   : 2: 进行中

五、流程图

在整个过程中，我们可以用流程图来标识各个步骤：

flowchart TD
    A[开始创建 Spring Boot 项目] --> B{是否添加配置文件?}
    B -- yes --> C[在指定目录创建配置文件]
    B -- no --> D[继续开发]
    C --> E[启动应用程序]
    E --> F{成功启动?}
    F -- yes --> G[使用 @Value 读取配置]
    F -- no --> H[报错]