How to load custom properties files in Spring Boot

By mkyong | Updated: September 20, 2023

Viewed: 6,873 (+291 pv/w)

Tags: properties file spring boot

This article shows how to use @PropertySource annotation to load custom properties files in Spring Boot.

Table of contents:

• 1. Load default properties file
• 2. Load custom properties files
• 3. Load multiple custom properties files
• 4. Download Source Code
• 5. References

P.S. Tested with Spring Boot 3.1.2

1. Load default properties file

Spring default loads application.properties into the application’s environment, and we can use @Value to access the property values.

server.name=SpringAppCluster01

package com.mkyong.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class ServerProperties {

    @Value("${server.name}")
    private String name; // Value = 'SpringAppCluster01'

    //...
}

2. Load custom properties files

We can use @PropertySource to load a custom properties file.

server.name=SpringAppCluster01

package com.mkyong.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Component
@PropertySource("classpath:server.properties")
public class ServerProperties {

    @Value("${server.name}")
    private String name; // Value = 'SpringAppCluster01'

    //...
}

3. Load multiple custom properties files

@PropertySource example.

import org.springframework.context.annotation.PropertySource;

@PropertySource({
    "classpath:/server/db.properties",
    "classpath:/server/file.properties"
})

@PropertySources example.

import org.springframework.context.annotation.PropertySources;
import org.springframework.context.annotation.PropertySource;

@PropertySources({
      @PropertySource("classpath:/server/db.properties"),
      @PropertySource("classpath:/server/file.properties")
})

4. Download Source Code

5. References

• SpringDoc – PropertySource
• SpringDoc – PropertySources
• Spring Boot – Externalized Configuration
• Access values from application.properties in Spring Boot
• Java Properties file examples
• Spring @PropertySource example