SpringBoot3配置文件的使用技巧分享

# application.yml 格式
server:
  port: 8080 # 服务器端口，默认 8080
  servlet:
    context-path: /springboot3 # 项目上下文路径，默认 /（空路径）
  tomcat:
    uri-encoding: UTF-8 # Tomcat 编码，SpringBoot3 默认 UTF-8

# application.properties 格式
server.port=8080
server.servlet.context-path=/springboot3
server.tomcat.uri-encoding=UTF-8

# application.yml 格式
logging:
  level:
    root: INFO # 根日志级别（DEBUG/INFO/WARN/ERROR）
    com.example: DEBUG # 自定义包的日志级别（开发环境常用 DEBUG）
  file:
    name: logs/springboot3.log # 日志输出文件路径
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n" # 控制台日志格式
    file: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n" # 文件日志格式

# application.yml 格式
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springboot3_db?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root # 数据库用户名
    password: 123456 # 数据库密码
    driver-class-name: com.mysql.cj.jdbc.Driver # MySQL 8.0+ 驱动类（SpringBoot3 可省略，自动识别）
  jpa:
    hibernate:
      ddl-auto: update # 自动生成表结构（开发环境可用，生产环境禁用）
    show-sql: true # 控制台打印 SQL 语句

# 自定义配置项（前缀可自定义，建议与项目/模块名一致）
demo:
  name: SpringBoot3-Config
  version: 1.0.0
  description: 这是 SpringBoot3 配置文件实战示例
  enable: true # 布尔类型
  max-size: 100 # 数字类型

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

@RestController
public class ConfigController {

    // 注入自定义属性，${} 为占位符，指定配置项的键
    @Value("${demo.name}")
    private String demoName;

    @Value("${demo.version}")
    private String demoVersion;

    // 布尔类型注入，无需转换，SpringBoot 自动解析
    @Value("${demo.enable:true}") // 冒号后为默认值，若配置文件中无该属性，使用默认值 true
    private boolean demoEnable;

    @GetMapping("/config/simple")
    public String getSimpleConfig() {
        return "demoName: " + demoName + ", demoVersion: " + demoVersion + ", demoEnable: " + demoEnable;
    }
}

import jakarta.validation.constraints.NotBlank;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

// 绑定配置文件中前缀为 demo 的配置项
@Component // 注入到 Spring 容器中，否则无法被扫描到
@ConfigurationProperties(prefix = "demo")
@Data // Lombok 注解，简化 getter/setter（推荐使用）
public class DemoConfig {

    @NotBlank(message = "demo.name 不能为空") // 支持 JSR380 校验，SpringBoot3 内置支持
    private String name;

    private String version;

    private String description;

    private boolean enable;

    private Integer maxSize;

    // 数组/集合类型配置
    private List<String> authors;

    // 嵌套对象配置（复杂层次）
    private DatabaseConfig database;

    // 嵌套对象，无需添加 @Component，会被自动绑定
    @Data
    public static class DatabaseConfig {
        private String url;
        private String username;
        private String password;
    }
}

demo:
  name: SpringBoot3-Config
  version: 1.0.0
  description: 这是 SpringBoot3 配置文件实战示例
  enable: true
  max-size: 100
  authors: [张三, 李四, 王五] # 数组格式（两种写法均可）
  # authors:
  #  - 张三
  #  - 李四
  #  - 王五
  database: # 嵌套对象配置
    url: jdbc:mysql://localhost:3306/test_db
    username: root
    password: 123456

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

@RestController
public class ConfigController {

    @Autowired
    private DemoConfig demoConfig; // 注入绑定好的实体类

    @GetMapping("/config/complex")
    public DemoConfig getComplexConfig() {
        // 直接返回实体类，SpringBoot 自动转为 JSON
        return demoConfig;
    }
}

demo:
  # 1. 引用当前配置文件中的其他配置项
  name: SpringBoot3
  full-name: ${demo.name}-Config-Demo

  # 2. 引用系统环境变量（SpringBoot3 优化了环境变量的解析，支持更多系统）
  user-home: ${user.home}

  # 3. 引用命令行参数（启动时通过 --key=value 传入，优先级高于配置文件）
  port: ${server.port:8080} # 冒号后为默认值，若命令行未传入，使用 8080

spring:
  profiles:
    active: dev # 默认激活开发环境
  # 全局共用配置（所有环境都生效）
  application:
    name: springboot3-config-demo

server:
  port: 8080 # 开发环境端口 8080
logging:
  level:
    root: DEBUG # 开发环境日志级别 DEBUG，方便调试
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db # 开发环境数据库
    username: root
    password: 123456

server:
  port: 80 # 生产环境端口 80
logging:
  level:
    root: ERROR # 生产环境日志级别 ERROR，减少日志输出
spring:
  datasource:
    url: jdbc:mysql://192.168.1.100:3306/prod_db # 生产环境数据库
    username: prod_user
    password: prod_123456 # 生产环境密码加密（下文会讲）

<!-- pom.xml -->
<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.5</version> <!-- 适配 SpringBoot3 -->
</dependency>

# application-prod.yml
jasypt:
  encryptor:
    password: ${JASYPT_ENCRYPT_PASSWORD} # 加密密钥，从环境变量获取
    algorithm: PBEWithMD5AndDES # 加密算法（默认，可自定义）

import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

// 项目启动时生成加密后的密码（仅开发时使用，生产时删除）
@Component
public class JasyptTest implements CommandLineRunner {

    @Autowired
    private StringEncryptor stringEncryptor;

    @Override
    public void run(String... args) throws Exception {
        // 加密明文密码（prod_123456）
        String encryptPassword = stringEncryptor.encrypt("prod_123456");
        System.out.println("加密后的密码：" + encryptPassword);
        // 输出示例：EV7k8Z7xQ+3a9B1c2D3e4F5g6H7i8J9k0L1m2N3o4P5q6R7s8T9u0V1w2X3y4Z5
    }
}

spring:
  datasource:
    password: ENC(EV7k8Z7xQ+3a9B1c2D3e4F5g6H7i8J9k0L1m2N3o4P5q6R7s8T9u0V1w2X3y4Z5)

java -jar springboot3-config.jar --spring.profiles.active=prod --jasypt.encryptor.password=你的密钥

java -jar springboot3-config.jar -spring.config.location=/opt/config/application-prod.yml

# 锚点复用示例
common-db: &common-db # 定义锚点，名称为 common-db
  driver-class-name: com.mysql.cj.jdbc.Driver
  username: root

demo:
  database:
    <<: *common-db # 合并锚点配置，复用 driver-class-name 和 username
    url: jdbc:mysql://localhost:3306/dev_db
    password: 123456