@ConfigurationProperties加载外部如何配置

发布时间：2023-03-13 10:36:36 作者：iii
来源：亿速云阅读：164

@ConfigurationProperties加载外部如何配置

在现代的Java应用程序开发中，配置管理是一个至关重要的环节。Spring Boot提供了多种方式来加载和管理配置，其中@ConfigurationProperties注解是一个非常强大的工具，它允许我们将外部的配置属性绑定到Java对象中。本文将详细介绍如何使用@ConfigurationProperties加载外部配置，并探讨其在实际应用中的最佳实践。

1. 什么是@ConfigurationProperties？

@ConfigurationProperties是Spring Boot提供的一个注解，用于将外部的配置属性绑定到Java对象中。通过这种方式，我们可以将配置文件中的属性值直接注入到Java类的字段中，从而简化配置管理。

1.1 基本用法

假设我们有一个application.properties文件，内容如下：

app.name=MyApp
app.description=This is a sample application
app.version=1.0.0

我们可以通过@ConfigurationProperties将这些属性绑定到一个Java类中：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String description;
    private String version;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

在这个例子中，@ConfigurationProperties注解的prefix属性指定了配置属性的前缀。Spring Boot会自动将app.name、app.description和app.version的值绑定到AppConfig类的相应字段中。

1.2 支持的类型

@ConfigurationProperties支持多种类型的属性绑定，包括：

基本类型（如int、boolean、String等）
集合类型（如List、Set、Map等）
嵌套对象

例如，我们可以在application.properties中定义嵌套的配置：

app.name=MyApp
app.description=This is a sample application
app.version=1.0.0
app.database.url=jdbc:mysql://localhost:3306/mydb
app.database.username=root
app.database.password=secret

然后在Java类中定义嵌套的对象：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String description;
    private String version;
    private DatabaseConfig database;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public DatabaseConfig getDatabase() {
        return database;
    }

    public void setDatabase(DatabaseConfig database) {
        this.database = database;
    }

    public static class DatabaseConfig {
        private String url;
        private String username;
        private String password;

        // Getters and Setters
        public String getUrl() {
            return url;
        }

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

        public String getUsername() {
            return username;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public String getPassword() {
            return password;
        }

        public void setPassword(String password) {
            this.password = password;
        }
    }
}

在这个例子中，DatabaseConfig类是一个嵌套的配置对象，Spring Boot会自动将app.database.url、app.database.username和app.database.password的值绑定到DatabaseConfig类的相应字段中。

2. 加载外部配置的方式

Spring Boot支持多种方式来加载外部配置，包括：

配置文件（如application.properties或application.yml）
环境变量
命令行参数
自定义配置文件

2.1 配置文件

Spring Boot默认会加载application.properties或application.yml文件中的配置。我们可以在src/main/resources目录下创建这些文件，并在其中定义配置属性。

例如，application.yml文件的内容如下：

app:
  name: MyApp
  description: This is a sample application
  version: 1.0.0
  database:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret

Spring Boot会自动加载这些配置，并将其绑定到@ConfigurationProperties注解的类中。

2.2 环境变量

Spring Boot还支持通过环境变量来加载配置。环境变量的名称需要遵循一定的规则，通常是将配置属性的名称转换为大写，并将.替换为_。

例如，我们可以通过设置以下环境变量来覆盖application.properties中的配置：

export APP_NAME=MyApp
export APP_DESCRIPTION="This is a sample application"
export APP_VERSION=1.0.0
export APP_DATABASE_URL=jdbc:mysql://localhost:3306/mydb
export APP_DATABASE_USERNAME=root
export APP_DATABASE_PASSWORD=secret

Spring Boot会自动将这些环境变量的值绑定到@ConfigurationProperties注解的类中。

2.3 命令行参数

Spring Boot还支持通过命令行参数来加载配置。命令行参数的格式为--property=value。

例如，我们可以通过以下命令行参数来覆盖application.properties中的配置：

java -jar myapp.jar --app.name=MyApp --app.description="This is a sample application" --app.version=1.0.0 --app.database.url=jdbc:mysql://localhost:3306/mydb --app.database.username=root --app.database.password=secret

Spring Boot会自动将这些命令行参数的值绑定到@ConfigurationProperties注解的类中。

2.4 自定义配置文件

除了默认的application.properties或application.yml文件外，我们还可以通过@PropertySource注解加载自定义的配置文件。

例如，我们可以在src/main/resources目录下创建一个custom.properties文件，内容如下：

custom.name=CustomApp
custom.description=This is a custom application
custom.version=2.0.0

然后在Java类中使用@PropertySource注解加载这个文件：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "custom")
@PropertySource("classpath:custom.properties")
public class CustomConfig {
    private String name;
    private String description;
    private String version;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

在这个例子中，@PropertySource注解指定了要加载的配置文件，Spring Boot会自动将custom.properties文件中的配置属性绑定到CustomConfig类的相应字段中。

3. 配置属性的验证

在实际应用中，我们通常需要对配置属性进行验证，以确保其值的合法性。Spring Boot提供了多种方式来验证配置属性。

3.1 JSR-303验证

我们可以使用JSR-303（Bean Validation）注解来验证配置属性。例如，我们可以使用@NotNull、@Size、@Min、@Max等注解来验证字段的值。

例如，我们可以在AppConfig类中添加验证注解：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

@Component
@ConfigurationProperties(prefix = "app")
@Validated
public class AppConfig {
    @NotNull
    private String name;

    @Size(max = 100)
    private String description;

    @NotNull
    private String version;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

在这个例子中，@NotNull注解确保name和version字段的值不能为null，@Size(max = 100)注解确保description字段的值长度不能超过100个字符。

3.2 自定义验证

除了使用JSR-303注解外，我们还可以通过实现Validator接口来自定义验证逻辑。

例如，我们可以创建一个自定义的验证器来验证AppConfig类中的字段：

import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

public class AppConfigValidator implements Validator {
    @Override
    public boolean supports(Class<?> clazz) {
        return AppConfig.class.isAssignableFrom(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "field.required", "Name is required");
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "version", "field.required", "Version is required");

        AppConfig config = (AppConfig) target;
        if (config.getDescription() != null && config.getDescription().length() > 100) {
            errors.rejectValue("description", "field.maxlength", "Description must be less than 100 characters");
        }
    }
}

然后，我们可以在Spring Boot应用程序中注册这个验证器：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;

@Configuration
public class AppConfigValidation {
    @Bean
    public LocalValidatorFactoryBean validator() {
        return new LocalValidatorFactoryBean();
    }

    @Bean
    public AppConfigValidator appConfigValidator() {
        return new AppConfigValidator();
    }
}

在这个例子中，AppConfigValidator类实现了Validator接口，并定义了自定义的验证逻辑。Spring Boot会自动调用这个验证器来验证AppConfig类中的字段。

4. 配置属性的动态更新

在某些情况下，我们可能需要在应用程序运行时动态更新配置属性。Spring Boot提供了@RefreshScope注解来实现这一功能。

4.1 使用@RefreshScope

@RefreshScope注解用于标记一个Bean，表示该Bean的配置属性可以在运行时动态更新。当配置属性发生变化时，Spring Boot会自动重新加载这些属性，并更新相应的Bean。

例如，我们可以在AppConfig类上添加@RefreshScope注解：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
@RefreshScope
public class AppConfig {
    private String name;
    private String description;
    private String version;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

在这个例子中，@RefreshScope注解表示AppConfig类的配置属性可以在运行时动态更新。当配置属性发生变化时，Spring Boot会自动重新加载这些属性，并更新AppConfig类的字段。

4.2 触发配置更新

要触发配置更新，我们可以使用Spring Cloud Config的/actuator/refresh端点。例如，我们可以通过发送HTTP POST请求来触发配置更新：

curl -X POST http://localhost:8080/actuator/refresh

Spring Boot会自动重新加载配置属性，并更新标记了@RefreshScope注解的Bean。

5. 配置属性的加密

在某些情况下，我们可能需要对配置属性进行加密，以保护敏感信息（如数据库密码）。Spring Boot提供了多种方式来实现配置属性的加密。

5.1 使用Jasypt加密

Jasypt是一个Java库，用于简化加密和解密操作。我们可以使用Jasypt来加密配置属性，并在Spring Boot中解密这些属性。

首先，我们需要在pom.xml中添加Jasypt的依赖：

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.4</version>
</dependency>

然后，我们可以在application.properties中定义加密的配置属性：

app.name=MyApp
app.description=This is a sample application
app.version=1.0.0
app.database.url=jdbc:mysql://localhost:3306/mydb
app.database.username=root
app.database.password=ENC(encrypted_password)

在这个例子中，app.database.password的值是一个加密的字符串，前缀为ENC(，后缀为)。

接下来，我们需要在application.properties中配置Jasypt的加密密钥：

jasypt.encryptor.password=mysecretkey

在这个例子中，jasypt.encryptor.password是Jasypt的加密密钥，用于解密配置属性。

最后，我们可以在Spring Boot应用程序中使用@ConfigurationProperties注解加载这些配置属性：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String description;
    private String version;
    private DatabaseConfig database;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public DatabaseConfig getDatabase() {
        return database;
    }

    public void setDatabase(DatabaseConfig database) {
        this.database = database;
    }

    public static class DatabaseConfig {
        private String url;
        private String username;
        private String password;

        // Getters and Setters
        public String getUrl() {
            return url;
        }

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

        public String getUsername() {
            return username;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public String getPassword() {
            return password;
        }

        public void setPassword(String password) {
            this.password = password;
        }
    }
}

在这个例子中，Spring Boot会自动解密app.database.password的值，并将其绑定到DatabaseConfig类的password字段中。

5.2 使用Spring Cloud Config加密

Spring Cloud Config提供了对配置属性的加密支持。我们可以使用Spring Cloud Config的加密功能来加密配置属性，并在Spring Boot中解密这些属性。

首先，我们需要在application.properties中配置Spring Cloud Config的加密密钥：

encrypt.key=mysecretkey

然后，我们可以在application.properties中定义加密的配置属性：

app.name=MyApp
app.description=This is a sample application
app.version=1.0.0
app.database.url=jdbc:mysql://localhost:3306/mydb
app.database.username=root
app.database.password={cipher}encrypted_password

在这个例子中，app.database.password的值是一个加密的字符串，前缀为{cipher}。

接下来，我们需要在Spring Boot应用程序中使用@ConfigurationProperties注解加载这些配置属性：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String description;
    private String version;
    private DatabaseConfig database;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public DatabaseConfig getDatabase() {
        return database;
    }

    public void setDatabase(DatabaseConfig database) {
        this.database = database;
    }

    public static class DatabaseConfig {
        private String url;
        private String username;
        private String password;

        // Getters and Setters
        public String getUrl() {
            return url;
        }

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

        public String getUsername() {
            return username;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public String getPassword() {
            return password;
        }

        public void setPassword(String password) {
            this.password = password;
        }
    }
}

在这个例子中，Spring Boot会自动解密app.database.password的值，并将其绑定到DatabaseConfig类的password字段中。

6. 配置属性的国际化

在某些情况下，我们可能需要对配置属性进行国际化处理，以支持多语言环境。Spring Boot提供了多种方式来实现配置属性的国际化。

6.1 使用MessageSource

Spring Boot提供了MessageSource接口来实现国际化。我们可以使用MessageSource来加载不同语言环境的配置属性。

首先，我们需要在application.properties中定义不同

@ConfigurationProperties加载外部如何配置

@ConfigurationProperties加载外部如何配置

1. 什么是@ConfigurationProperties？

1.1 基本用法

1.2 支持的类型

2. 加载外部配置的方式

2.1 配置文件

2.2 环境变量

2.3 命令行参数

2.4 自定义配置文件

3. 配置属性的验证

3.1 JSR-303验证

3.2 自定义验证

4. 配置属性的动态更新

4.1 使用@RefreshScope

4.2 触发配置更新

5. 配置属性的加密

5.1 使用Jasypt加密

5.2 使用Spring Cloud Config加密

6. 配置属性的国际化

6.1 使用MessageSource

相关阅读