Spring Boot 配置文件未生效

网罗开发
（小红书、快手、视频号同名）

  大家好，我是 展菲，目前在上市企业从事人工智能项目研发管理工作，平时热衷于分享各种编程领域的软硬技能知识以及前沿技术，包括iOS、前端、Harmony OS、Java、Python等方向。在移动端开发、鸿蒙开发、物联网、嵌入式、云原生、开源等领域有深厚造诣。

图书作者：《ESP32-C3 物联网工程开发实战》 图书作者：《SwiftUI 入门，进阶与实战》 超级个体：COC上海社区主理人 特约讲师：大学讲师，谷歌亚马逊分享嘉宾 科技博主：华为HDE/HDG

我的博客内容涵盖广泛，主要分享技术教程、Bug解决方案、开发工具使用、前沿科技资讯、产品评测与使用体验。我特别关注云服务产品评测、AI 产品对比、开发板性能测试以及技术报告，同时也会提供产品优缺点分析、横向对比，并分享技术沙龙与行业大会的参会体验。我的目标是为读者提供有深度、有实用价值的技术洞察与分析。

展菲：您的前沿技术领航员 👋 大家好，我是展菲！ 📱 全网搜索“展菲”，即可纵览我在各大平台的知识足迹。 📣 公众号“Swift社区”，每周定时推送干货满满的技术长文，从新兴框架的剖析到运维实战的复盘，助您技术进阶之路畅通无阻。 💬 微信端添加好友“fzhanfei”，与我直接交流，不管是项目瓶颈的求助，还是行业趋势的探讨，随时畅所欲言。 📅 最新动态：2025 年 3 月 17 日 快来加入技术社区，一起挖掘技术的无限潜能，携手迈向数字化新征程！

文章目录

• • 前言
  • 问题背景
  • 解决方案一：检查配置文件路径
  • • 正确的配置文件位置
    • 检查配置文件是否被加载
    • 常见错误：配置文件位置不对
    • 解决方案：使用 @PropertySource 注解
  • 解决方案二：激活 Spring Profile
  • • Profile 配置文件命名规则
    • 激活 Profile 的方法
    • • 方法一：在 application.yml 中配置
      • 方法二：通过环境变量配置
      • 方法三：通过命令行参数配置
      • 方法四：在 IDEA 中配置 VM options
    • 检查 Profile 是否激活
    • 常见错误：Profile 未激活导致配置未加载
  • 解决方案三：IDEA 配置 VM options
  • • 配置 VM options
    • 检查 IDEA 配置
    • 常见错误：IDEA 配置未生效
  • 其他常见问题和解决方案
  • • 问题一：配置文件格式错误
    • 问题二：配置文件编码问题
    • 问题三：配置文件被覆盖
    • 问题四：使用 @ConfigurationProperties 时配置未生效
  • 实际应用场景
  • • 场景一：多环境配置管理
    • 场景二：配置外部化
    • 场景三：配置验证和默认值
  • 总结

前言

最近在做一个 Spring Boot 项目的时候，遇到了一个让人头疼的问题：明明在 application.yml 里配置了数据库连接信息，但应用启动时就是读取不到，一直报错说找不到配置。刚开始以为是配置文件格式有问题，检查了好几遍也没发现什么问题。后来才发现，原来是配置文件的位置不对，Spring Boot 根本就没找到这个文件。

相信很多 Spring Boot 开发者都遇到过类似的问题：配置文件明明写好了，但应用就是读取不到。今天我们就来聊聊 Spring Boot 配置文件未生效的常见原因和解决方案，以及如何在实际项目中避免这些问题。

问题背景

Spring Boot 的配置文件加载机制其实挺复杂的，它会在多个位置查找配置文件，而且还有优先级的概念。如果配置文件的位置不对，或者优先级设置有问题，就可能导致配置文件未生效。

最常见的问题就是 application.yml 没被加载。可能的原因有：

让我们一个个来看这些问题和解决方案。

解决方案一：检查配置文件路径

Spring Boot 默认会在以下位置查找配置文件（按优先级从高到低）：

最常见的情况是配置文件放在 src/main/resources 目录下，这个目录会被编译到 classpath 的根目录。

正确的配置文件位置

project-root/
├── src/
│ └── main/
│ ├── java/
│ │ └── com/
│ │ └── example/
│ │ └── Application.java
│ └── resources/
│ ├── application.yml # 主配置文件
│ ├── application-dev.yml # 开发环境配置
│ └── application-prod.yml # 生产环境配置
└── pom.xml

检查配置文件是否被加载

我们可以通过以下方式来检查配置文件是否被加载：

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class DemoApplication {

@Value("${spring.application.name:unknown}")
private String appName;

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

@Bean
public CommandLineRunner checkConfig() {
return args -> {
System.out.println("应用名称: " + appName);
System.out.println("配置文件是否加载成功: " +
(!appName.equals("unknown") ? "是" : "否"));
};
}
}

如果配置文件被正确加载，应该能看到配置的值；如果显示 “unknown”，说明配置文件没有被加载。

常见错误：配置文件位置不对

有时候开发者会把配置文件放在错误的位置，比如：

project-root/
├── src/
│ └── main/
│ ├── java/
│ └── resources/
│ └── config/
│ └── application.yml # 错误：不应该在 config 子目录下

虽然 Spring Boot 也会在 classpath:/config/ 下查找配置文件，但如果你没有明确指定，可能会导致配置加载顺序的问题。

解决方案：使用 @PropertySource 注解

如果你确实需要把配置文件放在非标准位置，可以使用 @PropertySource 注解来明确指定配置文件的位置：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.PropertySource;

@SpringBootApplication
@PropertySource("classpath:config/application.yml")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}

不过需要注意的是，@PropertySource 默认只支持 .properties 文件，如果要加载 .yml 文件，需要额外的配置：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.PropertySources;

@SpringBootApplication
@PropertySources({
@PropertySource(value = "classpath:config/application.yml",
factory = YamlPropertySourceFactory.class)
})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}

解决方案二：激活 Spring Profile

Spring Boot 支持多环境配置，通过 Profile 来区分不同环境的配置。如果你使用了 application-{profile}.yml 格式的配置文件，需要激活对应的 profile，否则这些配置文件不会被加载。

Profile 配置文件命名规则

Spring Boot 的配置文件命名规则如下：

• application.yml：主配置文件，所有环境都会加载
• application-{profile}.yml：特定环境的配置文件，需要激活对应的 profile 才会加载

例如：

resources/
├── application.yml # 主配置（所有环境）
├── application-dev.yml # 开发环境配置
├── application-test.yml # 测试环境配置
└── application-prod.yml # 生产环境配置

激活 Profile 的方法

有几种方式可以激活 Profile：

方法一：在 application.yml 中配置

spring:
profiles:
active: dev

这样配置后，Spring Boot 会加载 application.yml 和 application-dev.yml。

方法二：通过环境变量配置

export SPRING_PROFILES_ACTIVE=dev
java -jar app.jar

或者在 Windows 上：

set SPRING_PROFILES_ACTIVE=dev
java -jar app.jar

方法三：通过命令行参数配置

java -jar app.jar –spring.profiles.active=dev

方法四：在 IDEA 中配置 VM options

在 IDEA 中运行应用时，可以在 Run Configuration 中配置 VM options：

-Dspring.profiles.active=dev

具体步骤：

检查 Profile 是否激活

我们可以通过以下方式来检查当前激活的 Profile：

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.core.env.Environment;

@SpringBootApplication
public class DemoApplication {

@Autowired
private Environment environment;

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

@Bean
public CommandLineRunner checkProfile() {
return args -> {
String[] activeProfiles = environment.getActiveProfiles();
System.out.println("当前激活的 Profile: " +
(activeProfiles.length > 0 ? String.join(", ", activeProfiles) : "无"));

// 检查特定配置是否加载
String dbUrl = environment.getProperty("spring.datasource.url", "未配置");
System.out.println("数据库 URL: " + dbUrl);
};
}
}

常见错误：Profile 未激活导致配置未加载

很多开发者会遇到这样的问题：明明配置了 application-dev.yml，但应用启动时就是读取不到里面的配置。这通常是因为没有激活 dev profile。

错误示例：

# application-dev.yml
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: password

如果启动时没有激活 dev profile，这个配置文件就不会被加载。

正确做法：

在 application.yml 中激活 profile：

# application.yml
spring:
profiles:
active: dev

或者在启动时通过命令行参数激活：

java -jar app.jar –spring.profiles.active=dev

解决方案三：IDEA 配置 VM options

在 IDEA 中运行 Spring Boot 应用时，有时候即使配置文件位置正确，也可能读取不到配置。这通常是因为 IDEA 的运行配置有问题。

配置 VM options

在 IDEA 中配置 VM options 的步骤：

检查 IDEA 配置

我们可以通过以下方式来检查 IDEA 的配置是否正确：

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class DemoApplication {

@Value("${spring.profiles.active:default}")
private String activeProfile;

@Value("${spring.datasource.url:未配置}")
private String dbUrl;

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

@Bean
public CommandLineRunner checkConfig() {
return args -> {
System.out.println("=== 配置检查 ===");
System.out.println("激活的 Profile: " + activeProfile);
System.out.println("数据库 URL: " + dbUrl);
System.out.println("================");
};
}
}

运行应用后，如果能看到正确的配置值，说明配置已经生效。

常见错误：IDEA 配置未生效

有时候在 IDEA 中配置了 VM options，但应用启动时还是读取不到配置。可能的原因有：

解决方法：

其他常见问题和解决方案

除了上面提到的三个主要问题，还有一些其他可能导致配置文件未生效的原因：

问题一：配置文件格式错误

YAML 文件对格式要求很严格，如果格式错误，可能会导致配置文件无法解析。

错误示例：

spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb # 错误：缩进不对
username: root

正确格式：

spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: password

问题二：配置文件编码问题

如果配置文件包含中文，需要确保文件编码是 UTF-8，否则可能导致配置读取错误。

解决方法：

在 IDEA 中设置文件编码：

问题三：配置文件被覆盖

如果有多个配置文件，Spring Boot 会按照优先级加载，后面的配置会覆盖前面的配置。

配置文件加载顺序（从低到高）：

解决方法：

如果发现配置被覆盖，可以检查：

问题四：使用 @ConfigurationProperties 时配置未生效

如果使用了 @ConfigurationProperties 注解，需要确保：

示例：

package com.example.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
private String name;
private String version;

// getter 和 setter
public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public String getVersion() {
return version;
}

public void setVersion(String version) {
this.version = version;
}
}

对应的配置文件：

app:
name: My Application
version: 1.0.0

实际应用场景

让我们看几个实际应用场景，了解如何在实际项目中应用这些解决方案：

场景一：多环境配置管理

在实际项目中，我们通常需要为不同环境配置不同的参数，比如开发环境、测试环境、生产环境。

配置文件结构：

resources/
├── application.yml # 主配置
├── application-dev.yml # 开发环境
├── application-test.yml # 测试环境
└── application-prod.yml # 生产环境

application.yml（主配置）：

spring:
application:
name: my–app
profiles:
active: dev # 默认激活开发环境

application-dev.yml（开发环境）：

spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb_dev
username: dev_user
password: dev_password
logging:
level:
root: DEBUG

application-prod.yml（生产环境）：

spring:
datasource:
url: jdbc:mysql://prod–server:3306/mydb_prod
username: prod_user
password: ${DB_PASSWORD} # 从环境变量读取
logging:
level:
root: INFO

启动应用：

开发环境：

java -jar app.jar –spring.profiles.active=dev

生产环境：

java -jar app.jar –spring.profiles.active=prod

场景二：配置外部化

在实际项目中，我们通常不希望把敏感信息（如密码、密钥）写在配置文件中，而是通过环境变量或外部配置文件来管理。

方法一：使用环境变量

spring:
datasource:
password: ${DB_PASSWORD}

启动时设置环境变量：

export DB_PASSWORD=mysecretpassword
java -jar app.jar

方法二：使用外部配置文件

java -jar app.jar –spring.config.location=file:/path/to/config/application.yml

方法三：使用配置中心

对于大型项目，可以使用配置中心（如 Spring Cloud Config、Nacos、Apollo）来管理配置。

场景三：配置验证和默认值

在实际项目中，我们可以使用 @Value 注解的默认值功能，以及配置验证来确保配置正确。

使用默认值：

@Value("${server.port:8080}")
private int serverPort;

@Value("${spring.datasource.url:jdbc:h2:mem:testdb}")
private String dbUrl;

配置验证：

package com.example.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Min;

@Component
@ConfigurationProperties(prefix = "app")
@Validated
public class AppConfig {
@NotBlank
private String name;

@Min(1)
private int version;

// getter 和 setter
}

如果配置验证失败，应用启动时会抛出异常。

总结

Spring Boot 配置文件未生效是一个常见问题，主要原因有：

解决步骤：

最佳实践：