useful-dev-notes

To add @ConfigutationProperties to your app

Edit pom.xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
<!--VALIDATION IS NOT NECESSARY BUT PREFERRED-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

New class to your application

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Validated
@Getter
@Setter
@ToString
// necessary I think for spring to pick it up and scan it
// maybe some support was added in some version
// but intellij was complaining so added this too
@Configuration
@ConfigurationProperties(prefix = "prefix")
public class NameYourConfig {

	@NotBlank
	@ToString.Exclude
	private String password;

	// the class names do not matter  
	// the variable's name matters as they are what are used
	// to pick the properties
	@NotNull
	private AnotherNestedObject nested;

	@Getter
	@Setter
	@ToString
	public static class AnotherNestedObject {
		// spring binds
		// some-property
		// some_property
		// someProperty
		// some other variations too to the same variable
		@NotBlank
		private String someProperty;
	}
}

Example Config

# as properties
prefix.password=terces
prefix.nested.someProperty=value
prefix.nested.some-property=value
prefix.nested.some_property=value
# both are same

# as yaml properties
prefix:
  password: terces
  nested:
 someProperty: value
 some-property: value
 some_property: value
 # both are same