@ConfigurationProperties for type-safe config in Spring Boot - Step-by-Step Execution

Concept Flow - @ConfigurationProperties for type-safe config

Define POJO class with fields

↓

Annotate class with @ConfigurationProperties

↓

Enable @ConfigurationProperties scanning (@EnableConfigurationProperties)

↓

Spring Boot reads config properties file

↓

Spring Boot binds properties to POJO fields

↓

Use POJO bean in application code

This flow shows how Spring Boot reads configuration properties and binds them to a POJO class annotated with @ConfigurationProperties for type-safe access.

Execution Sample

Spring Boot

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private int timeout;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
}

Defines a POJO AppConfig with fields bound to properties prefixed with 'app' from application.properties or application.yml.

Execution Table

Step	Action	Property Source	Binding Target	Value Bound	Result
1	Spring Boot starts and scans components	application.properties	AppConfig bean	N/A	AppConfig bean created
2	Reads property 'app.name=MyApp'	application.properties	AppConfig.name	MyApp	AppConfig.name set to 'MyApp'
3	Reads property 'app.timeout=30'	application.properties	AppConfig.timeout	30	AppConfig.timeout set to 30
4	Binding complete	application.properties	AppConfig bean	N/A	AppConfig bean ready with values
5	Application uses AppConfig bean	N/A	AppConfig fields	MyApp, 30	AppConfig values accessible in code
6	Exit	N/A	N/A	N/A	Configuration binding finished

💡 All properties with prefix 'app' bound to AppConfig fields; binding stops after all relevant properties processed.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
AppConfig.name	null	"MyApp"	"MyApp"	"MyApp"
AppConfig.timeout	0	0	30	30

Key Moments - 3 Insights

Why do we need the @ConfigurationProperties prefix?

The prefix tells Spring Boot which properties to bind to the POJO fields. Without it, Spring won't know which properties belong to this class (see execution_table steps 2 and 3).

What happens if a property is missing in the config file?

The corresponding POJO field keeps its default value (like 0 for int or null for String), as shown in variable_tracker before binding.

Why annotate the class with @Component or enable scanning?

Spring needs to create the POJO bean to bind properties. Without @Component or @EnableConfigurationProperties, the bean won't exist and binding won't happen (see execution_table step 1).

Visual Quiz - 3 Questions

Look at the execution_table, what value does AppConfig.name have after step 3?

A "app.name"

B null

C "MyApp"

D 30

💡 Hint

Check the 'Value Bound' column at step 3 in execution_table.

At which step does Spring Boot finish binding all properties to AppConfig?

A Step 2

B Step 4

C Step 5

D Step 6

💡 Hint

Look for the row where 'Binding complete' is noted in execution_table.

If the property 'app.timeout' is removed from the config file, what happens to AppConfig.timeout?

A It becomes 0 (default int value)

B It becomes null

C It remains 30

D Binding fails with error

💡 Hint

Refer to variable_tracker start values and key_moments about missing properties.

Concept Snapshot

@ConfigurationProperties binds external config to POJO fields.
Use prefix to select properties.
Annotate class with @ConfigurationProperties and @Component.
Spring Boot auto-binds on startup.
Access config values type-safely via POJO.
Missing properties keep default values.

Full Transcript

This visual execution shows how Spring Boot uses @ConfigurationProperties to bind configuration properties to a Java POJO class. First, the POJO is defined with fields matching config keys. The class is annotated with @ConfigurationProperties and @Component so Spring creates the bean. On startup, Spring reads the application.properties file and finds keys with the specified prefix. It then sets the POJO fields with those values. The execution table traces each step of reading and binding properties. The variable tracker shows how field values change from defaults to bound values. Key moments clarify why the prefix is needed, what happens if properties are missing, and why the bean must be created. The quiz tests understanding of binding steps and default values. This approach gives type-safe, easy access to config values in Spring Boot apps.

Practice

1. What is the main purpose of using @ConfigurationProperties in a Spring Boot application?

easy

A. To create REST endpoints automatically

B. To bind external configuration properties to a Java class for type-safe access

C. To define database entities

D. To handle HTTP requests and responses

Solution

1. Step 1: Understand the role of @ConfigurationProperties

   This annotation is used to map properties from configuration files (like application.properties or application.yml) into Java classes.

2. Step 2: Identify the benefit of type-safe access

   By binding properties to a class, you avoid manual parsing and get compile-time checking of property names and types.

3. Final Answer:

   To bind external configuration properties to a Java class for type-safe access -> Option B

4. Quick Check:

   @ConfigurationProperties = type-safe config binding [OK]

Hint: Remember: @ConfigurationProperties maps config to Java class [OK]

Common Mistakes:

• Confusing @ConfigurationProperties with REST controllers
• Thinking it creates database entities
• Assuming it handles HTTP requests

2. Which of the following is the correct way to enable @ConfigurationProperties support in a Spring Boot application?

easy

A. Add @RestController on the configuration class

B. Annotate the class with @Entity

C. Annotate the class with @Component or use @EnableConfigurationProperties on a configuration class

D. Use @Service annotation on the properties class

Solution

1. Step 1: Identify how Spring Boot detects @ConfigurationProperties classes

   Spring Boot requires the class to be a Spring bean, which can be done by annotating it with @Component or by enabling it via @EnableConfigurationProperties.

2. Step 2: Recognize incorrect annotations

   @Entity is for JPA entities, @RestController is for web controllers, and @Service is for service layer beans, none of which enable configuration properties binding.

3. Final Answer:

   Annotate the class with @Component or use @EnableConfigurationProperties on a configuration class -> Option C

4. Quick Check:

   Enable with @Component or @EnableConfigurationProperties [OK]

Hint: Use @Component or @EnableConfigurationProperties to activate binding [OK]

Common Mistakes:

• Using @Entity or @RestController instead of @Component
• Forgetting to register the properties class as a bean
• Assuming @Service enables configuration binding

3. Given the following configuration class and properties, what will be the value of appProperties.getTimeout()?

application.yml:
app:
  timeout: 5000

Java class:
@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private int timeout;
    public int getTimeout() { return timeout; }
    public void setTimeout(int timeout) { this.timeout = timeout; }
}

medium

A. 5000

B. 0

C. null

D. Throws an exception

Solution

1. Step 1: Match property prefix and field

   The prefix 'app' matches the class prefix, and 'timeout' matches the field name, so the value 5000 binds correctly.

2. Step 2: Understand default value and binding

   Since the property is set in the YAML, the field will be set to 5000, not the default 0 or null.

3. Final Answer:

   5000 -> Option A

4. Quick Check:

   Property value binds correctly = 5000 [OK]

Hint: Match prefix and field names exactly for binding [OK]

Common Mistakes:

• Assuming default 0 because of missing @Value
• Confusing null with primitive int default
• Expecting exception without validation

4. Consider this configuration class:

@ConfigurationProperties(prefix = "server")
public class ServerConfig {
    private String host;
    private int port;

    public String getHost() { return host; }
    public void setHost(String host) { this.host = host; }

    public int getPort() { return port; }
    public void setPort(int port) { this.port = port; }
}

If the application.yml contains:

server:
  host: localhost
  port: notANumber

What will happen when Spring Boot starts?

medium

A. Port is set to 0 by default, application starts normally

B. Application starts, port is set to string 'notANumber'

C. Port is ignored, host is set, application starts with warning

D. Application fails to start with a binding exception due to invalid port value

Solution

1. Step 1: Analyze property type mismatch

   The 'port' field is an int, but the YAML provides a non-numeric string 'notANumber', causing a type mismatch.

2. Step 2: Understand Spring Boot binding behavior

   Spring Boot throws a binding exception on startup if it cannot convert the property to the required type.

3. Final Answer:

   Application fails to start with a binding exception due to invalid port value -> Option D

4. Quick Check:

   Invalid type causes startup failure [OK]

Hint: Type mismatch in config causes startup failure [OK]

Common Mistakes:

• Assuming default values are used silently
• Expecting warnings instead of errors
• Thinking string can be assigned to int field

5. You want to create a nested configuration properties class to map this YAML:

app:
  security:
    enabled: true
    roles:
      - USER
      - ADMIN

Which of the following Java class structures correctly uses @ConfigurationProperties to map this nested config?

hard

A. public class AppProperties {
private Security security;
public static class Security {
private boolean enabled;
private List<String> roles;
// getters and setters
}
// getters and setters
}

@ConfigurationProperties(prefix = "app")
@Component
public class AppProperties {}

B. @ConfigurationProperties(prefix = "app.security")
@Component
public class Security {
private boolean enabled;
private List<String> roles;
// getters and setters
}

C. @ConfigurationProperties(prefix = "app")
@Component
public class AppProperties {
private boolean enabled;
private List<String> roles;
// getters and setters
}

D. @ConfigurationProperties(prefix = "security")
@Component
public class Security {
private boolean enabled;
private List<String> roles;
// getters and setters
}

Solution

1. Step 1: Understand nested property mapping

   To map nested properties, create a nested class inside the main properties class and define fields matching the nested keys.

2. Step 2: Match prefix and class structure

   The prefix 'app' matches the root, and the nested Security class maps the 'security' subtree with 'enabled' and 'roles'. The main class must be annotated with @ConfigurationProperties and registered as a bean.

3. Step 3: Evaluate options

   public class AppProperties { private Security security; public static class Security { private boolean enabled; private List<String> roles; // getters and setters } // getters and setters } @ConfigurationProperties(prefix = "app") @Component public class AppProperties {} correctly nests Security inside AppProperties and uses prefix 'app'. @ConfigurationProperties(prefix = "app.security") @Component public class Security { private boolean enabled; private List<String> roles; // getters and setters } uses prefix 'app.security' but does not nest. @ConfigurationProperties(prefix = "app") @Component public class AppProperties { private boolean enabled; private List<String> roles; // getters and setters } flattens properties incorrectly. @ConfigurationProperties(prefix = "security") @Component public class Security { private boolean enabled; private List<String> roles; // getters and setters } uses wrong prefix.

4. Final Answer:

   Option A with nested Security class inside AppProperties and prefix 'app' -> Option A

5. Quick Check:

   Nested class + prefix 'app' = correct mapping [OK]

Hint: Use nested classes for nested config with root prefix [OK]

Common Mistakes:

• Using wrong prefix for nested properties
• Flattening nested properties into one class
• Not annotating main class with @ConfigurationProperties