Spring Boot YML Properties - Boolean

Introduction

In a Spring Boot application, the properties can be defined in a application.yml or application.properties file. The properties are used to configure the application, and they can be accessed using the @Value annotation, Environment object, or injecting the @ConfigurationProperties object.

This guide shows how to define and use boolean properties in a Spring Boot application.

Defining Boolean Properties

To define a boolean property in the application.yml file, use the true or false values:

myapp:
  enabled: true
  isDebug: false

The myapp.enabled and myapp.isDebug properties are defined as boolean values.

Using Boolean Properties

Boolean properties can be accessed in several ways.

Using @Value Annotation

To use a boolean property in a component or controller, annotate the field or setter method with the @Value annotation:

@Component
public class MyComponent {
    @Value("${myapp.enabled}")
    private boolean enabled;
    
    public boolean isEnabled() {
        return enabled;
    }
    
    @Value("${myapp.isDebug}")
    public void setDebug(boolean isDebug) {
        // Do something with isDebug
    }
}

In the above code, the @Value annotation is used to inject the boolean values of myapp.enabled and myapp.isDebug into the enabled field and setDebug method respectively.

Using Environment Object

Alternatively, the boolean properties can be accessed using the Environment object:

@Component
public class MyComponent {
    @Autowired
    private Environment env;
    
    public boolean isEnabled() {
        return Boolean.parseBoolean(env.getProperty("myapp.enabled"));
    }
}

In the above code, the Environment object is injected, and the boolean value of myapp.enabled is retrieved using the getProperty method and parsed using the Boolean.parseBoolean method.

Using @ConfigurationProperties

To bind a set of properties to a configuration class, use the @ConfigurationProperties annotation:

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private boolean enabled;
    private boolean isDebug;
    
    // Getters and setters
}

In the above code, the @ConfigurationProperties annotation is used to bind the myapp properties to the MyAppProperties configuration class. The enabled and isDebug fields are automatically populated with the corresponding values from the application.yml file.

Conclusion

Spring Boot provides several ways to define and use boolean properties in a Spring Boot application. Whether using @Value, Environment, or @ConfigurationProperties, the boolean values can be easily accessed and used in the application.