Spring YAML配置

宋涛2025年2月26日大约 5 分钟

Spring 框架是一种广泛使用的 Java 应用框架，它为企业级开发提供了全面的支持。Spring 的配置文件是整个应用的核心，尤其是 application.yml 格式的配置文件更是以其清晰的层级结构和可读性受到广泛欢迎。

本文将详细介绍基于 Spring 框架的全量 YAML 配置及其说明，涵盖核心功能、环境管理、数据源配置等常见场景。

1. Spring 配置介绍

Spring 框架的配置文件默认会读取 src/main/resources/application.yml，并支持以下功能：

应用核心信息设置：如应用程序的名称、端口配置等。
数据源管理：用于配置数据库连接和连接池。
日志管理：可控制日志输出级别和格式。
国际化支持：通过配置文件实现国际化消息管理。
多环境切换：基于 spring.profiles.active 属性灵活切换配置环境。

YAML 的基本格式通过缩进定义属性层级，例如:

server:
  port: 8080
  error:
    include-message: always

2. 核心配置

核心配置主要管理应用的基本信息和运行环境。

spring:
  application:
    name: demo-application           # 应用名称
  main:
    allow-bean-definition-overriding: false    # 是否允许覆盖 Bean 定义
  profiles:
    active: dev                      # 当前激活的环境
  lifecycle:
    timeout-per-shutdown-phase: 10s  # 应用关闭阶段的最大等待时间

server:
  port: 8080                         # 应用运行端口
  servlet:
    context-path: /api               # 应用上下文路径
  compression:
    enabled: true                    # 是否启用 GZIP 压缩
    mime-types: text/html,text/xml   # 压缩的 MIME 类型
    min-response-size: 1024          # 最大压缩响应大小

说明:

spring.application.name 是服务注册和服务之间通信的唯一标识。
server.port 指定应用程序的启动端口，默认为 8080。
server.servlet.context-path 用于定义应用的上下文根路径，比如 /api/v1。

3. 数据源配置

Spring 提供多种方式配置数据源。以下是常用的 YAML 数据源配置：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb?serverTimezone=UTC&useSSL=false
    username: root                     # 数据库用户名
    password: rootpassword             # 数据库密码
    driver-class-name: com.mysql.cj.jdbc.Driver
    hikari:
      maximum-pool-size: 10            # 连接池最大连接数
      minimum-idle: 5                  # 最小空闲连接数
      idle-timeout: 30000              # 空闲时间超时
      connection-timeout: 20000        # 连接超时时间

说明:

spring.datasource.url 配置数据库连接 URL。常见数据库包括 MySQL、PostgreSQL 和 Oracle。
hikari 是 Spring 默认提供的高性能连接池，用户可以通过其配置项优化性能。

4. 国际化配置

支持国际化是现代化应用的一大需求。Spring 提供了消息资源文件的集成。

spring:
  messages:
    basename: messages                # 定义消息资源文件的基本名称
    encoding: UTF-8                   # 配置文件编码
    cache-duration: 3600              # 缓存时间（秒）

资源文件示例：
src/main/resources/messages_en.properties:

welcome.message=Welcome to our application!

src/main/resources/messages_zh.properties:

welcome.message=欢迎使用我们的应用程序！

通过国际化配置，可以根据客户端语言动态选择不同语言的内容。

5. 日志配置

日志是每个应用程序不可或缺的一部分，用于调试和问题分析。Spring 默认支持 SLF4J 和 Logback。

logging:
  level:
    root: info                       # 默认日志级别
    com.example: debug               # 指定包的日志级别
  file:
    name: logs/app.log               # 日志文件路径
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} - %msg%n"  # 控制台日志输出格式
    file: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"

说明:

logging.level.root 默认全局日志级别，支持 TRACE、DEBUG、INFO 等。
logging.pattern.console 控制台日志输出的格式。

6. 错误页面和异常处理

Spring 提供默认的错误页面和可以自定义的异常处理方式。

server:
  error:
    include-message: always           # 获取错误消息内容
    include-stacktrace: never         # 是否包含堆栈信息
    whitelabel:
      enabled: false                  # 是否启用默认错误页面

说明:

开发者可以关闭默认的错误页面，或通过编写自定义的异常处理器来定制用户体验。

7. 文件上传配置

文件上传的配置主要用于 Web 应用，限制上传文件的大小及请求大小。

spring:
  servlet:
    multipart:
      max-file-size: 10MB             # 单个文件最大大小
      max-request-size: 20MB          # 总请求最大大小
      file-size-threshold: 1MB        # 文件上传到磁盘之前的缓冲区大小

说明:

max-file-size 限制上传单个文件的大小，默认是 1MB。

8. 多环境管理

Spring 通过 spring.profiles.active 属性实现多环境支持。例如：
application.yml：

spring:
  profiles:
    active: dev                       # 当前激活的配置

application-dev.yml：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: dev_user
    password: dev_password

application-prod.yml：

spring:
  datasource:
    url: jdbc:mysql://192.168.1.100:3306/proddb
    username: prod_user
    password: prod_password

通过设置 spring.profiles.active=dev，应用会加载 application-dev.yml 中的配置。

9. 完整配置示例

以下是一个综合的 application.yml 示例：

spring:
  application:
    name: demo-app
  profiles:
    active: dev

server:
  port: 8080
  servlet:
    context-path: /api
  error:
    include-message: always
    whitelabel:
      enabled: false

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb?serverTimezone=UTC&useSSL=false
    username: root
    password: rootpassword
    driver-class-name: com.mysql.cj.jdbc.Driver

logging:
  level:
    root: info
    com.example: debug
  file:
    name: logs/application.log

spring:
  messages:
    basename: messages
    encoding: UTF-8

10. 总结

Spring 的 YAML 配置为开发者提供了一种结构化且易读的方式来管理应用的核心配置。本文覆盖了 Spring 配置中常见的关键内容，包括核心配置、数据源管理、日志配置、国际化支持、多环境管理等。

通过合理使用 Spring 的 YAML 配置，开发者可以更高效地管理复杂的应用，并轻松实现功能扩展。