@Value for property injection in Spring Boot

Introduction

The @Value annotation helps you get values from configuration files into your code easily. It saves you from hardcoding values.

You want to use a database URL stored in application.properties inside your code.

You need to inject a timeout value that might change without changing the code.

You want to read a custom message or label from your config file to show in your app.

You want to keep secret keys or tokens outside your code and load them safely.

You want to configure feature flags that can be turned on or off via properties.

Syntax

Spring Boot

@Value("${property.key}")
private DataType variableName;

The ${property.key} is the key name in your properties file.

Make sure the property exists in your application.properties or application.yml.

Examples

This injects the value of app.name from your properties into appName.

Spring Boot

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

This injects server.port or uses 8080 as a default if the property is missing.

Spring Boot

@Value("${server.port:8080}")
private int serverPort;

This injects a boolean flag from properties, defaulting to false if not set.

Spring Boot

@Value("${feature.enabled:false}")
private boolean featureEnabled;

Sample Program

This Spring Boot app reads app.greeting and app.version from properties. It prints them when the app starts. If app.version is missing, it uses "1.0" as default.

Spring Boot

package com.example.demo;

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 DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

@Component
class PropertyPrinter implements CommandLineRunner {

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

    @Value("${app.version:1.0}")
    private String version;

    @Override
    public void run(String... args) {
        System.out.println(greeting + " - Version: " + version);
    }
}

Important Notes

If the property is missing and no default is given, the app will fail to start.

You can use @Value on fields, constructor parameters, or setter methods.

For complex configurations, consider using @ConfigurationProperties instead.

Summary

@Value injects config values into your Spring beans.

You can provide default values using a colon : inside the expression.

It helps keep your code flexible and easy to configure.

Practice

1. What is the main purpose of the @Value annotation in Spring Boot?

easy

A. To create database connections

B. To define a new Spring bean

C. To handle HTTP requests

D. To inject values from configuration files into Spring beans

Solution

1. Step 1: Understand the role of @Value

   @Value is used to inject configuration values like those from application.properties into Spring beans.

2. Step 2: Compare with other options

   Defining beans, handling HTTP requests, and database connections are done by other annotations or classes, not @Value.

3. Final Answer:

   To inject values from configuration files into Spring beans -> Option D

4. Quick Check:

   @Value injects config values = A [OK]

Hint: Remember: @Value pulls config values into your code [OK]

Common Mistakes:

• Confusing @Value with @Bean or @Autowired
• Thinking @Value handles HTTP or DB tasks
• Ignoring that @Value reads from properties

2. Which of the following is the correct syntax to inject a property named app.name using @Value?

easy

A. @Value(${app.name}) private String appName;

B. @Value("${app.name}") private String appName;

C. @Value("app.name") private String appName;

D. @Value(app.name) private String appName;

Solution

1. Step 1: Recall correct syntax for property injection

   The property key must be inside ${} and the whole expression inside quotes: @Value("${property.key}").

2. Step 2: Check each option

   @Value("${app.name}") private String appName; matches the correct syntax. The other options miss either the quotes around the expression, the ${} delimiters, or use quotes around just the property name.

3. Final Answer:

   @Value("${app.name}") private String appName; -> Option B

4. Quick Check:

   Correct syntax uses ${} inside quotes = D [OK]

Hint: Use @Value("${property.key}") with quotes and ${} [OK]

Common Mistakes:

• Omitting quotes around the expression
• Forgetting the ${} around the property key
• Using plain property name without ${}

3. Given the property server.port=8080 in application.properties, what will be the output of this Spring component?

public class ServerConfig {
  @Value("${server.port}")
  private int port;

  public int getPort() {
    return port;
  }
}

// In main method:
ServerConfig config = new ServerConfig();
System.out.println(config.getPort());

medium

A. 0

B. 8080

C. null

D. Compilation error

Solution

1. Step 1: Understand Spring bean lifecycle and injection

   Property injection with @Value happens only when Spring creates and manages the bean. Here, ServerConfig is created manually with new, so injection does not happen.

2. Step 2: Check default value of int field

   Since port is a primitive int and not injected, it defaults to 0.

3. Final Answer:

   0 -> Option A

4. Quick Check:

   Manual new means no injection, int defaults to 0 [OK]

Hint: Only Spring-managed beans get @Value injection [OK]

Common Mistakes:

• Assuming @Value works on manually created objects
• Expecting null for primitive int fields
• Ignoring Spring bean lifecycle

4. What is wrong with this code snippet?

@Value("${missing.property}:defaultValue")
private String value;

When missing.property is not defined in properties, the application fails to start with an error.

medium

A. The field must be public for @Value to work

B. The property key must be defined; default values are not supported

C. The default value syntax is incorrect; colon should be inside quotes

D. The @Value annotation cannot be used on String fields

Solution

1. Step 1: Check default value syntax in @Value

   The default value must be inside the quotes as part of the expression: @Value("${property:default}") is correct.

2. Step 2: Identify the error cause

   If the colon is outside quotes or expression is malformed, Spring cannot parse it and throws an error.

3. Final Answer:

   The default value syntax is incorrect; colon should be inside quotes -> Option C

4. Quick Check:

   Default values must be inside ${} quotes [OK]

Hint: Put default after colon inside quotes in @Value [OK]

Common Mistakes:

• Placing colon outside the quotes
• Assuming default values are not supported
• Making fields public unnecessarily

5. You want to inject a list of strings from a property app.modes=dev,prod,test into a Spring bean using @Value. Which approach correctly converts the property into a List<String>?

hard

A. @Value("#{T(java.util.Arrays).asList('${app.modes}'.split(','))}") private List<String> modes;

B. @Value("${app.modes}") private List<String> modes; // Spring auto-converts comma-separated string

C. @Value("${app.modes}") private String[] modes; // Use array instead of List

D. @Value("${app.modes}") private String modes; // Parse manually later

Solution

1. Step 1: Understand property injection for collections

   Spring does not automatically convert comma-separated strings to List<String> with plain @Value.

2. Step 2: Use SpEL expression for conversion

   @Value("#{T(java.util.Arrays).asList('${app.modes}'.split(','))}") private List<String> modes; uses Spring Expression Language (SpEL) to split the string and convert it to a List<String>, which is the correct approach.

3. Final Answer:

   @Value("#{T(java.util.Arrays).asList('${app.modes}'.split(','))}") private List<String> modes; -> Option A

4. Quick Check:

   Use SpEL split and asList for List injection [OK]

Hint: Use SpEL with split and asList to inject List<String> [OK]

Common Mistakes:

• Expecting automatic conversion from String to List
• Using array when List is required without conversion
• Injecting as String and forgetting to parse