Spring Boot 4 Complete Guide · Lesson

Externalizing Application Properties

Configure your application using `application.properties` and `application.yml` files, and manage profiles.

Externalizing Application Properties is a free Spring Boot 4 Complete Guide lesson on CoddyKit — lesson 3 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Spring Boot 4 Complete Guide learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Keep Config Flexible

Imagine building an app for different environments like development, testing, and production. Each might need unique database credentials, API keys, or server ports.

Hardcoding these values directly into your code is a bad practice. It makes your app inflexible and difficult to manage.

Externalizing configuration means storing these changeable values outside your main application code, allowing you to modify them without rebuilding your app.

application.properties

Spring Boot makes external configuration easy. The most common way is using the application.properties file, located in your src/main/resources folder.

It uses a simple key-value pair format, where each property is on a new line:

server.port=8080
spring.datasource.url=jdbc:h2:mem:testdb
my.custom.greeting=Hello CoddyKit!

These values can then be injected into your Spring components.

Injecting with @Value

To use an externalized property in your Java code, Spring provides the @Value annotation.

You can apply @Value to fields, constructor parameters, or method parameters. It reads the value associated with a specific key from your properties files.

The syntax is @Value("${property.key}"). If the property is not found, you can provide a default value like @Value("${property.key:Default Value}").

@Value in Action

Let's see how @Value works. First, we'll create an application.properties file.

src/main/resources/application.properties:

app.message=Welcome to CoddyKit!

Now, run this Spring Boot application. It will inject the property and print it on startup.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@Component
class MessagePrinter implements CommandLineRunner {

  @Value("${app.message}")
  private String message;

  @Override
  public void run(String... args) throws Exception {
    System.out.println("Application Message: " + message);
  }
}

Structured YAML Files

Another popular format for external configuration is YAML (YAML Ain't Markup Language), typically in an application.yml file.

YAML offers a more human-readable, hierarchical structure compared to the flat key-value pairs of .properties files. It uses indentation to define nested properties.

Readability: Easier to grasp complex configurations.
Hierarchy: Naturally groups related properties.
Less Repetition: Avoids repeating common prefixes.

YAML for Clarity

Here's how the same message property from before would look in application.yml:

src/main/resources/application.yml:

app:
  message: Welcome to CoddyKit! (YAML)

The Java code remains exactly the same as Spring Boot automatically supports both formats. Run this to see it in action.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@Component
class MessagePrinter implements CommandLineRunner {

  @Value("${app.message}")
  private String message;

  @Override
  public void run(String... args) throws Exception {
    System.out.println("Application Message: " + message);
  }
}

Who Wins? Precedence

What if you have both application.properties and application.yml in your project? Which one takes precedence?

Spring Boot has a specific order for loading configuration sources. Generally, properties defined in application.properties take precedence over those in application.yml when both exist and define the same key.

This allows you to override default values with more specific ones when needed, without changing the original files.

Adapting with Profiles

Spring Profiles provide a way to segregate parts of your application configuration and make it available only in certain environments.

For example, you might have different database settings for your development, test, and production environments. Instead of manually changing configuration files, you can define profiles.

When a specific profile is active, only the beans and configuration associated with that profile are loaded.

Tailoring for Environments

To define profile-specific properties, you create additional configuration files following a specific naming convention:

application-{profile}.properties
application-{profile}.yml

For example:

application-dev.properties for development settings.
application-prod.yml for production settings.

These files contain properties that apply only when their corresponding profile is active.

Switching Profiles

You can activate a Spring profile in several ways:

JVM System Property: Pass -Dspring.profiles.active=dev when running your app.
Environment Variable: Set SPRING_PROFILES_ACTIVE=prod.
Inside application.properties/.yml: Set spring.profiles.active=test.

It's common to use JVM arguments or environment variables for production deployments, keeping your main application.properties clean.

Quick Check: Config

You have an application.properties file with app.environment=development. You also have an application-prod.properties file with app.environment=production.

How would you activate the prod profile to ensure app.environment resolves to production?

Config Mastery Recap

Great job! You've learned how to externalize application properties in Spring Boot, making your applications more flexible and easier to manage across different environments.

We explored application.properties for simple key-value pairs.
We saw application.yml for structured, hierarchical configuration.
You learned to inject properties into your code using the @Value annotation.
Finally, we covered Spring Profiles to tailor configurations for specific environments and how to activate them.

This knowledge is crucial for building robust and adaptable Spring Boot applications!

Frequently asked questions

Is the “Externalizing Application Properties” lesson free?

Yes — the full text of “Externalizing Application Properties” is free to read here on the web, and the Spring Boot 4 Complete Guide course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Spring Boot 4 Complete Guide course, upgrade to CoddyKit PRO.

What will I learn in “Externalizing Application Properties”?

Configure your application using `application.properties` and `application.yml` files, and manage profiles. You practise Spring Boot 4 Complete Guide with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Spring Boot 4 Complete Guide?

No prior experience is required. Spring Boot 4 Complete Guide on CoddyKit is structured for beginners through advanced learners; this is — lesson 3 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Externalizing Application Properties” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Spring Boot 4 Complete Guide lesson?

Yes. Every Spring Boot 4 Complete Guide lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to Spring Boot 4 Complete Guide