Eliminate Spring Boot Configuration Warnings with Auto‑Generated Metadata

When developing with Spring Boot, custom properties often trigger a Cannot resolve configuration property warning in the IDE. Although you can suppress this warning via settings, the warning actually helps distinguish your custom configuration from framework defaults.

The root cause is the lack of configuration metadata for your custom properties. Spring Boot provides a JSON metadata file for its own properties, containing fields such as name and description, which IDEs use for auto‑completion and validation.

To provide similar metadata for your own configuration, follow these steps:

Step 1: Create a Configuration Class

@Data
@Configuration
@ConfigurationProperties(prefix = "com.didispace")
public class DidiProperties {
    /**
     * This is a test configuration
     */
    private String from;
}

Step 2: Add the Configuration Processor Dependency

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

Step 3: Build the Project

Run mvn install. After the build, a metadata file is generated under the target directory.

When you edit your application.yml or application.properties, the IDE now offers auto‑completion and no longer shows the warning.

For a complete example, see the chapter1-4 directory in the repository:

GitHub: https://github.com/dyc87112/SpringBoot-Learning/

Gitee: https://gitee.com/didispace/SpringBoot-Learning/

By adding the configuration processor, you keep your custom properties well‑documented, improve developer experience, and avoid unnecessary warning suppression.