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