Spring Boot 参数配置详解：properties、yml 及外部化配置

如何在代码中获取配置值？

@Value 注解 (适用于单个属性)

@Component
public class MyComponent {
    @Value("${server.port}")
    private int serverPort;

    @Value("${app.message: Hello Default}") // 使用冒号指定默认值
    private String message;
}

@ConfigurationProperties 注解 (推荐，用于绑定一组配置)

这是更类型安全、更面向对象的方式。

步骤 1：在 application.yml 中定义配置

app:
  user:
    name: "Alice"
    age: 30
    email: "[email protected]"
    hobbies:
      - reading
      - hiking

步骤 2：创建一个配置类来绑定这些属性

@Component
@ConfigurationProperties(prefix = "app.user") // 前缀是 app.user
@Data // Lombok 注解，自动生成 getter/setter
public class UserProperties {
    private String name;
    private Integer age;
    private String email;
    private List<String> hobbies;
}

步骤 3：在需要的地方注入并使用

@Service
public class MyService {
    @Autowired
    private UserProperties userProperties;

    public void doSomething() {
        System.out.println("User name: " + userProperties.getName());
        System.out.println("User hobbies: " + userProperties.getHobbies());
    }
}

别忘了在启动类上添加 @EnableConfigurationProperties 注解（但如果你像上面一样在配置类上使用了 @Component，则不需要）。

常用配置示例

# 服务器配置
server:
  port: 8080
  servlet:
    context-path: /api # 应用上下文路径

# 数据源配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

# JPA 配置
jpa:
  hibernate:
    ddl-auto: update # 生产环境不要用 create-drop 或 update
    show-sql: true

# 日志配置
logging:
  level:
    root: info
    org.springframework.web: debug
    com.example: trace
  file:
    name: logs/myapp.log # 输出到文件

# 自定义配置
myapp:
  feature:
    enabled: true
    api-url: https://api.example.com

总结

Spring Boot 的参数配置系统非常灵活和强大，其核心思想是：

• 约定大于配置：提供了大量默认配置，开箱即用。
• 配置外部化：允许你通过文件、命令行、环境变量等多种方式覆盖默认配置，轻松适应不同环境。
• 类型安全绑定：通过 @ConfigurationProperties 可以轻松地将一组配置映射到 Java Bean 上，是管理自定义配置的首选方式。