Skip to main content

Find Spring @ConfigurationProperties

org.openrewrite.java.spring.search.FindConfigurationProperties

Find all classes annotated with @ConfigurationProperties and extract their prefix values. This is useful for discovering all externalized configuration properties in Spring Boot applications.

Recipe source​

GitHub: FindConfigurationProperties.java, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Example​

Before​
package test;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my.service")
public class MyProperties {
    private boolean enabled;
    private String url;

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}
After​
package test;
import org.springframework.boot.context.properties.ConfigurationProperties;

/*~~(@ConfigurationProperties("my.service"))~~>*/@ConfigurationProperties("my.service")
public class MyProperties {
    private boolean enabled;
    private String url;

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FindConfigurationProperties

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.25.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Configuration properties​

org.openrewrite.java.spring.table.ConfigurationPropertiesTable

Classes annotated with @ConfigurationProperties and their prefix values.

Column NameDescription
Source pathThe path to the source file containing the @ConfigurationProperties annotation.
Class typeThe fully qualified name of the class annotated with @ConfigurationProperties.
PrefixThe prefix/value attribute of the @ConfigurationProperties annotation.