Unlock 9 Hidden Spring Boot YAML Tricks for Advanced Configuration

1. Introduction

Spring Boot's application.yml is the core configuration file. Most developers know basic operations such as setting the server port or defining a datasource, but mastering advanced YAML features can greatly improve robustness and flexibility.

2. Practical Cases

2.1 Inject environment variables with default values

Use the ${VAR:default} syntax to provide a fallback value when an environment variable is missing, ensuring the application can start in any environment.

spring:
  datasource:
    username: ${DB_USER:root}
    password: ${DB_PASSWORD:root}

2.2 Import externalized files

Spring Boot can import a local .env file that is not version‑controlled, allowing sensitive data to stay out of the repository.

spring:
  config:
    # Import the file if it exists
    import: optional:file:.env[.properties]
---
pack:
  app:
    api-key: ${SECRET_KEY}

2.3 Configure application grouping (Spring Boot 3.4+)

Define spring.application.group to group applications belonging to the same business unit; the group can be included in log messages and controlled via logging.include-application-group.

spring:
  application:
    name: sb-3.4
    group: xxxooo
---
logging:
  include-application-name: true
  include-application-group: true

2.4 Activate multiple profiles and document splitting

Specify a comma‑separated list in spring.profiles.active to activate several profiles simultaneously, supporting layered configuration for A/B testing or feature releases.

spring:
  profiles:
    active: dev,redis,rabbitmq

This activates application-dev.yml, application-redis.yml and application-rabbitmq.yml.

2.5 Conditional import

In modular applications, import configuration files only when they exist by using the optional: prefix. Missing optional files will not cause startup failures.

spring:
  config:
    # No impact if the file is absent
    import: optional:classpath:/pack-custom.yml

2.6 Custom structured configuration

Use @Value for single simple properties or @ConfigurationProperties to bind a group of related settings to a POJO, providing type safety and validation.

pack:
  app:
    title: xxxooo
    version: 1.0.0
    timeout: 3000

Java class example:

@Component
@ConfigurationProperties(prefix="pack.app")
public class AppProperties {
    private String title;
    private String version;
    private Long timeout;
    // getters, setters
}

2.7 Use random values

Generate unique identifiers or temporary keys with built‑in random generators such as ${random.uuid}, ${random.int}, and ${random.long}.

pack:
  app:
    instance-id: ${random.uuid}
    key-length: ${random.int[10,20]}

2.8 Multi‑document property files

Combine multiple configuration documents with spring.config.activate.on-profile to apply settings for specific profiles without creating separate files.

# Global activation
spring:
  profiles:
    active:
      - prod
---
# Configuration for dev profile
spring:
  config:
    activate:
      on-profile:
        - dev
server:
  port: 8181
---
# Configuration for prod profile
spring:
  config:
    activate:
      on-profile:
        - prod
server:
  port: 8380

2.9 Use anchors and aliases (DRY principle)

YAML anchors ( &) and aliases ( *) allow reusable blocks, preventing duplication across multiple datasource definitions.

# Define a common datasource anchor
common-datasource: &common-ds
  driver-class-name: com.mysql.cj.jdbc.Driver
  username: root
  password: 123123
  type: com.zaxxer.hikari.HikariDataSource
spring:
  datasource:
    url: jdbc:mysql://10.100.101.227:3306/test?serverTimezone=GMT%2B8&useSSL=false&characterEncoding=UTF-8&rewriteBatchedStatements=true&cachePrepStmts=true
    # Merge common properties
    <<: *common-ds
    hikari:
      minimumIdle: 200
      maximumPoolSize: 200

Note: Do not place a YAML document separator ( ---) between lines 6 and 7, otherwise a parsing error will occur.