解决 Spring Boot 应用的 No spring.config.import 属性错误

问题描述

当使用 Spring Boot 创建配置客户端应用连接到 Spring Cloud Config 服务器时，可能会遇到以下错误：

No spring.config.import property has been defined
 
Action:

Add a spring.config.import=configserver: property to your configuration.   
If configuration is not required add spring.config.import=optional:configserver: instead.
To disable this check, set spring.cloud.config.enabled=false or 
spring.cloud.config.import-check.enabled=false.

这个错误主要是因为从 Spring Boot 2.4 开始，配置引导机制发生了变化，传统的 bootstrap.properties 或 bootstrap.yml 文件已被标记为弃用。

根本原因

Spring Cloud Config Client 的配置方式在较新版本的 Spring Boot 中发生了重大变化：

1. bootstrap.properties/bootstrap.yml 文件已弃用
2. 引入了新的 spring.config.import 属性来替代旧的配置方式
3. 如果你使用的是 Spring Boot 2.4+ 版本但仍在尝试使用旧的配置方式，就会出现此错误

解决方案

推荐方案：使用新的配置方式（Spring Boot 2.4+）

这是官方推荐的方式，将配置迁移到 application.properties 或 application.yml 文件中。

application.properties

spring.application.name=your-service-name
spring.config.import=optional:configserver:http://localhost:8888

application.yml

spring:
  application:
    name: your-service-name
  config:
    import: "optional:configserver:http://localhost:8888"

参数说明

• optional: - 表示即使配置服务器不可用，应用也能正常启动
• configserver: - 指定配置源类型为 Config Server
• http://localhost:8888 - 替换为你的配置服务器实际地址

替代方案：禁用配置检查

如果你不需要连接配置服务器，可以完全禁用此功能：

application.properties

spring.cloud.config.enabled=false

application.yml

spring:
  cloud:
    config:
      enabled: false

或者仅禁用导入检查：

application.properties

spring.cloud.config.import-check.enabled=false

application.yml

spring:
  cloud:
    config:
      import-check:
        enabled: false

传统方案：启用引导配置（不推荐）

如果你希望继续使用旧的 bootstrap.properties 配置方式，需要添加引导启动器依赖：

Maven

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

Gradle

implementation('org.springframework.cloud:spring-cloud-starter-bootstrap')

然后创建 bootstrap.properties 文件：

bootstrap.properties

spring.application.name=your-service-name
spring.cloud.config.uri=http://localhost:8888

bootstrap.yml

spring:
  application:
    name: your-service-name
  cloud:
    config:
      uri: http://localhost:8888

注意

这种方法已弃用，建议仅用于维护旧项目，新项目应采用新的配置方式。

完整配置示例

以下是一个完整的配置客户端示例：

application.properties

# 应用名称
spring.application.name=user-service

# 配置服务器地址
spring.config.import=optional:configserver:http://localhost:8888

# 服务器端口
server.port=8080

# 启用配置功能
spring.cloud.config.enabled=true

application.yml

spring:
  application:
    name: user-service
  config:
    import: "optional:configserver:http://localhost:8888"
  cloud:
    config:
      enabled: true
server:
  port: 8080

测试环境配置

如果不需要在测试环境中使用配置服务器，可以在测试配置文件中禁用：

src/test/resources/application.properties

spring.cloud.config.enabled=false

src/test/resources/application.yml

spring:
  cloud:
    config:
      enabled: false

版本兼容性说明

• Spring Boot 2.3 及以下：使用 bootstrap.properties 配置方式
• Spring Boot 2.4+：推荐使用 spring.config.import 配置方式
• Spring Boot 3.0+：必须使用 spring.config.import 配置方式

常见问题排查

1. 重新加载 Maven 项目：在 IDE 中右键点击 pom.xml → Maven → Reload Project
2. 清理并重新构建：执行 mvn clean install 或相应的 Gradle 命令
3. 检查依赖版本：确保 Spring Cloud 版本与 Spring Boot 版本兼容

总结

从 Spring Boot 2.4 开始，配置客户端的方式已从传统的 bootstrap.properties 迁移到使用 spring.config.import 属性。虽然旧的方式仍然可以通过添加 spring-cloud-starter-bootstrap 依赖来支持，但建议新项目采用官方推荐的新配置方式。

选择适合你项目需求的解决方案，按照上述说明进行配置，即可解决 "No spring.config.import property has been defined" 错误。