SpringBoot2.x基础篇：谈谈SpringBoot内提供的这几种配置绑定

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

知识改变命运，撸码使我快乐，2020继续游走在开源界<br/>

点赞再看，养成习惯<br/>

给我来个Star吧，点击了解下基于SpringBoot的组件化接口服务落地解决方案

常见配置绑定方式

SpringBoot在不断地版本迭代中陆续提供了不同的配置参数绑定的方式，我们可以单独获取一个配置参数也可以将一系列的配置映射绑定到JavaBean的属性字段，下面我们来看看这几种方式的配置绑定哪一种是你最常用到的。

示例配置参数

system:
  config:
    app-id: hengboy
    app-secret: yuqiyu@admin

上面是一段示例的配置参数，提供给下面的配置绑定方式来使用。

@Configuration方式绑定

当我们需要将一个配置前缀下的参数映射绑定到JavaBean的属性字段时，我们可以考虑使用@ConfigurationProperties + @Configuration注解组合的方式，使用如下所示：

/**
 * 系统配置
 *
 * @author 恒宇少年
 */
@Configuration
@ConfigurationProperties(prefix = SYSTEM_CONFIG_PREFIX)
@Data
public class SystemConfig {
    /**
     * 系统配置前缀
     */
    public static final String SYSTEM_CONFIG_PREFIX = "system.config";
    private String appId;
    private String appSecret;
}

**注意事项：**配置参数与JavaBean属性之间的绑定是通过调用JavaBean属性的Setter方法来赋值的，所以我们需要提供对应属性字段的Setter方法。

由于@Configuration注解被@Component修饰，所以我们在使用时只需要注入SystemConfig配置绑定映射类即可，通过Getter方法来获取对应配置参数的值。

配置扫描路径方式绑定

如果你系统中需要创建的配置映射类较多，而且每一个类都需要交付给IOC容器进行托管，那么可以考虑使用@ConfigurationPropertiesScan + @ConfigurationProperties注解组合的方式，使用如下所示：

@SpringBootApplication
@ConfigurationPropertiesScan
public class ConfigureBindingAwayApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigureBindingAwayApplication.class, args);
    }
}

我们首先需要在XxxApplication应用程序启动类上添加@ConfigurationPropertiesScan注解，表示我们需要使用自动扫描的方式来注册配置映射类，注解配置参数如下所示：

  • value：配置扫描的基础package，与basePackages作用一致，通过数组的形式来接收配置。

  • basePackages：配置扫描的基础package。

  • basePackageClasses：配置基础扫描类，会将每一个扫描类所处于的package作为扫描基础package。

当我们在使用@ConfigurationPropertiesScan注解时，如果不进行自定义扫描路径，默认使用SpringBoot应用程序扫描的packages。

使用这种方式我们配置映射类就不再需要添加@Configuration注解了，这是因为我们在使用@ConfigurationPropertiesScan注解时，会通过@Import方式来引用配置映射类的注册实现，详见：org.springframework.boot.context.properties.ConfigurationPropertiesScanRegistrar#registerBeanDefinitions，配置映射类如下所示：

/**
 * 系统配置
 *
 * @author 恒宇少年
 */
@ConfigurationProperties(prefix = SYSTEM_CONFIG_PREFIX)
@Data
public class SystemConfig {
    /**
     * 系统配置前缀
     */
    public static final String SYSTEM_CONFIG_PREFIX = "system.config";
    private String appId;
    private String appSecret;
}

构造函数方式绑定

在上面的两种方式都是通过Setter方法来进行映射字段的赋值，而构造函数绑定方式是通过构造函数来进行赋值的，我们只需要在配置映射类上添加@ConstructorBinding注解并提供对应的构造函数即可，使用方式如下所示：

/**
 * 系统配置
 *
 * @author 恒宇少年
 */
@ConfigurationProperties(prefix = SYSTEM_CONFIG_PREFIX)
@ConstructorBinding
@Getter
public class SystemConfig {
    /**
     * 系统配置前缀
     */
    public static final String SYSTEM_CONFIG_PREFIX = "system.config";
    public SystemConfig(String appId, String appSecret) {
        this.appId = appId;
        this.appSecret = appSecret;
    }
    private String appId;
    private String appSecret;
}

在之前我也写过一篇关于构造函数映射配置参数的问题，详情访问：@ConstructorBinding注解的使用

第三方类绑定

如果我们需要将配置参数映射绑定到第三方依赖内提供的JavaBean，我们该使用什么方式呢？由于接收参数的类并不是我们自己编写的，所以没有办法对.class文件源码进行修改。

这时我们可以将第三方提供的JavaBean交给IOC容器托管，然后结合@ConfigurationProperties注解来映射绑定配置参数，使用方式如下所示：

@Bean
@ConfigurationProperties(prefix = SYSTEM_CONFIG_PREFIX)
public SystemConfig systemConfig() {
	return new SystemConfig();
}

这种方式也需要第三方提供的JavaBean有映射字段的Setter方法，否则无法进行赋值。

我们知道通过@Bean注解修饰的方法，会将方法的返回值加入到IOC容器内，那我们在使用配置时，直接注入配置映射类就可以了。

总结

上面这几种配置绑定方式都遵循OOP实现，当然如果你只需要获取一个配置参数，使用@Value也是一个好的选择，没有更好，只有更合适，根据每一种绑定方式的特点合理的选择一个合适业务的方式。

作者个人 博客

使用开源框架 ApiBoot 助你成为Api接口服务架构师

以上是 SpringBoot2.x基础篇：谈谈SpringBoot内提供的这几种配置绑定 的全部内容， 来源链接： utcz.com/z/515207.html

回到顶部