Spring Boot 读取配置文件的几种方式

颇有几分姿色2025-04-27 22:55

Spring Boot 提供了灵活多样的方式来读取配置文件（如 application.yml 或 application.properties），本文介绍几种常见的读取方式。

1. 配置文件位置与加载顺序

Spring Boot 默认从以下位置加载配置文件（优先级从高到低）：

  1. 命令行参数（如：--server.port=8081）
  2. application.properties / application.yml（位于 classpath:/config/）
  3. classpath:/application.properties 或 application.yml
  4. 外部配置中心（如 Nacos、Spring Cloud Config）

2. 读取配置文件的方式汇总

Spring Boot 提供了多种读取配置文件的方式。

方式一：使用 @Value 注解读取配置

这种方式适合读取单个简单配置项。可以用来注入配置文件中的值，也可以指定默认值，防止配置项缺失时抛出异常 。

📄 配置文件：

yaml 复制代码 
app:
  name: order-v
  version: v1

示例代码：

java 复制代码 
@Component
public class AppProperties {

    @Value("${app.name:order}")
    private String name;

    @Value("${app.version:v1.0.0}")
    private String version;

    public void print() {
        System.out.println("App Name: " + name);
        System.out.println("App Version: " + version);
    }
}
  • : 后面就是默认值
  • 当配置文件中没有对应的值时，会使用默认值
  • 如果配置项存在对应的值，默认值不生效

测试代码：

java 复制代码 
@RestController
@RequestMapping("/test")
@AllArgsConstructor
public class TestController {

    private final AppProperties appProperties;

    @RequestMapping("/print")
    public void print() {
        appProperties.print();
    }
}

✅ 优点：

  • 简单直接，适用于读取单个变量

❌ 缺点：

  • 不支持嵌套结构、不支持批量绑定、不利于维护

方式二：使用 @ConfigurationProperties 自动绑定配置类（推荐）

适合绑定多个字段、嵌套结构、List、Map等复杂配置。

📄 配置文件：

yaml 复制代码 
app:
  name: order-v
  version: v1
  servers:
    - http://dev-server:8080
    - http://test-server:8081
    - http://prod-server:8082
  metadata:
    author: Alice
    version: 1.0.2
    website: https://emp.com
  modules:
    user:
      enabled: true
      path: /user
    admin:
      enabled: false
      path: /admin

配置类示例代码：

java 复制代码 
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "app")
@Data
public class AppProperties {

    private String name;

    // List 示例
    private List<String> servers;

    // Map<String, String> 示例
    private Map<String, String> metadata;

    // Map<String, 自定义对象> 示例
    private Map<String, Module> modules;

    @Data
    public static class Module {
        private boolean enabled;
        private String path;
    }
    
    public void print() {
        System.out.println("name: " + name);
        System.out.println("servers: " + servers);
        System.out.println("metadata: " + metadata);
        System.out.println("modules: " + modules);
    }
}

使用示例：

java 复制代码 
import com.example.xiaoshitou.config.AppConfigProperties;
import com.example.xiaoshitou.config.AppProperties;
import lombok.AllArgsConstructor;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@RequestMapping("/test")
@AllArgsConstructor
public class TestController {

    private final AppProperties appProperties;
    private final AppConfigProperties appConfigProperties;

    @RequestMapping("/print")
    public void print() {
        appProperties.print();
    }

    @RequestMapping("/printConfig")
    public void printConfig() {
        appConfigProperties.print();
    }
}

✅ 优点：

  • 支持对象结构、嵌套对象、List、Map
  • 支持校验（配合 @Validated）
  • 强类型绑定，IDE 支持友好

❌ 缺点：

  • 需要额外的类定义

方式三：使用 Environment 编程式读取配置

适合动态读取、条件判断场景。

示例代码：

java 复制代码 
import com.example.xiaoshitou.config.AppConfigProperties;
import com.example.xiaoshitou.config.AppProperties;
import com.example.xiaoshitou.config.SmsConfig;
import lombok.AllArgsConstructor;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/***
 * @title
 * @author shijiangyong
 * @date 2025/4/24 17:28
 **/
@RestController
@RequestMapping("/test")
@AllArgsConstructor
public class TestController {

    private final AppProperties appProperties;
    private final AppConfigProperties appConfigProperties;
    private final Environment env;

    @RequestMapping("/print")
    public void print() {
        appProperties.print();
    }

    @RequestMapping("/printConfig")
    public void printConfig() {
        appConfigProperties.print();
    }

    @RequestMapping("/printEnv")
    public void printEnv() {
        String name = env.getProperty("app.name");
        System.out.println("app.name = " + name);
    }

}

✅ 优点：

  • 动态、灵活，支持条件判断
  • 可用于第三方库或工具类中

❌ 缺点：

  • 可读性差，不支持自动绑定

方式四：加载自定义配置文件（@PropertySource）

当你需要读取非 application.yml 的配置文件时使用。

📄 自定义配置文件 sms-config.properties：

properties 复制代码 
sms.sign=aliyun
sms.template.code=TPL001

示例代码：

java 复制代码 
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

/***
 * @title
 * @author shijiangyong
 * @date 2025/4/25 10:08
 **/
@Configuration
@PropertySource("classpath:sms-config.properties")
@ConfigurationProperties(prefix = "sms")
@Data
public class SmsConfig {
    private String sign;
    private Template template;

    @Data
    public static class Template {
        private String code;
    }

    public void print() {
        System.out.println("sign : " + sign);
        System.out.println("template.code : " + template.getCode());
    }
}

使用实力：

java 复制代码 
import com.example.xiaoshitou.config.AppConfigProperties;
import com.example.xiaoshitou.config.AppProperties;
import com.example.xiaoshitou.config.SmsConfig;
import lombok.AllArgsConstructor;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/***
 * @title
 * @author shijiangyong
 * @date 2025/4/24 17:28
 **/
@RestController
@RequestMapping("/test")
@AllArgsConstructor
public class TestController {

    private final AppProperties appProperties;
    private final AppConfigProperties appConfigProperties;
    private final SmsConfig smsConfig;
    private final Environment env;

    @RequestMapping("/print")
    public void print() {
        appProperties.print();
    }

    @RequestMapping("/printConfig")
    public void printConfig() {
        appConfigProperties.print();
    }

    @RequestMapping("/printEnv")
    public void printEnv() {
        String name = env.getProperty("app.name");
        System.out.println("app.name = " + name);
    }


    @RequestMapping("/smsConfig")
    public void smsConfig() {
        smsConfig.print();
    }

}

✅ 优点：

  • 支持加载自定义配置文件
  • 可与 @ConfigurationProperties 搭配使用

❌ 缺点：

  • 不支持 .yml 格式
  • 不支持动态刷新

方式五：多环境配置（多 Profile）

适用于开发、测试、生产环境的配置隔离。

📄 配置文件：

yaml 复制代码 
# application-dev.yml
app:
  name: DevApp

# application-prod.yml
app:
  name: ProdApp

激活方式：

  • 在 application.yml 中设置：
yaml 复制代码 
spring:
  profiles:
    active: dev
  • 或通过启动参数：
bash 复制代码 
--spring.profiles.active=prod

✅ 优点：

  • 多环境隔离，配置清晰
  • 支持组合激活多个 profile

总结

场景 推荐方式
读取单个简单值 @Value
读取嵌套结构、对象 @ConfigurationProperties
动态读取 Environment
非默认配置文件 @PropertySource
多环境支持 多 profile
相关推荐
苍煜1 小时前
Maven构建流程详解：如何正确管理微服务间的依赖关系-当依赖的模块更新后，我应该如何重新构建主项目
java·微服务·maven
冼紫菜1 小时前
[特殊字符]CentOS 7.6 安装 JDK 11（适配国内服务器环境）
java·linux·服务器·后端·centos
isyangli_blog1 小时前
（1-4）Java Object类、Final、注解、设计模式、抽象类、接口、内部类
java·开发语言
秋野酱2 小时前
Spring Boot 项目的计算机专业论文参考文献
java·spring boot·后端
码视野2 小时前
基于Spring Boot和Vue的在线考试系统架构设计与实现(源码+论文+部署讲解等)
vue.js·spring boot·系统架构
士别三日&&当刮目相看2 小时前
数据结构*优先级队列(堆)
java·数据结构
香饽饽~、2 小时前
【第二篇】 初步解析Spring Boot
java·spring boot·后端
坎布里奇3 小时前
java -jar命令运行 jar包时如何运行外部依赖jar包
java·pycharm·jar
冷yan~3 小时前
GitHub文档加载器设计与实现
java·人工智能·spring·ai·github·ai编程
热门推荐
01KGG转MP3工具|非KGM文件|解密音频02YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】03从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑04【SpeedAI科研小助手】2分钟极速解决知网维普重复率、AIGC率过高，一键全文降！文件格式不变，公式都保留的！05DeepSeek各版本说明与优缺点分析06Coze扣子平台完整体验和实践（附国内和国际版对比）07YOLOv5改进 | 添加CA注意力机制 + 增加预测层 + 更换损失函数之GIoU08苍穹外卖面试总结09yolov8，yolo11，yolo12 服务器训练到部署全流程 笔记10Ubuntu24.04安装中文输入法