胖虎的工具箱-编程导航 胖虎的工具箱-编程导航

SpringBoot配置文件的分水岭——高级配置的使用

1年前 (2023) 程序员胖胖胖虎阿
133 0 0

文章目录

  • 一、前言
  • 二、@ConfigurationProperties
  • 三、松散绑定
  • 四、常用计量单位绑定
  • 五、校验
  • 六、数据类型转换
  • 七、总结

一、前言

🎁作者简介：在校大学生一枚，Java领域新星创作者，Java、Python正在学习中。

💗个人主页：我是一棵卷心菜的个人主页

🍂日常学习网站：牛客网，可以用来刷算法题、工作内推、面经复习、练习SQL等等，很不错的多功能网站。点击注册学习刷题吧！

📕自我提醒：多学多练多思考，编程能力才能节节高！

这篇文章是介绍SpringBoot配置文件的高级使用，读完这篇文章，各位小伙伴们可以收获哪些呢？

  • 注解@ConfigurationProperties的介绍
  • 松散绑定、数据校验的使用
  • 数据类型转换的了解(需注意一下)

废话不多说，下面就开启本章的学习。

二、@ConfigurationProperties

首先向大家介绍的就是注解@ConfigurationProperties的使用，它的作用是用来为bean绑定属性的，开发者可以在yml配置文件中以对象的格式添加若干属性，下面来举一个例子：

@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

这个实体类注意要提供属性对应的setter方法

servers:
  ipAddress: 192.168.0.2
  port: 1111
  timeout: -1

使用@ConfigurationProperties注解就可以将配置中的属性值关联到实体类上，接下来写一个测试代码看看结果是否正确：

@SpringBootTest
class Springboot05ConfigurationApplicationTests {
    @Autowired
    private ServerConfig serverConfig;
    @Test
    void test01() {
        System.out.println(serverConfig);
    }
}

结果完全正确：
SpringBoot配置文件的分水岭——高级配置的使用
刚才讲的是给自定义的bean使用这种形式加载属性值，如果是第三方的bean呢？能不能用这种形式加载属性值呢？

为什么会提出这个疑问？原因就在于当前@ConfigurationProperties注解是写在类定义的上方，而第三方开发的bean源代码不是我们自己写的，我们也不可能到源代码中去添加@ConfigurationProperties注解，这种问题该怎么解决呢？

首先使用@Bean注解定义第三方bean

@Bean
public DruidDataSource datasource(){
    DruidDataSource ds = new DruidDataSource();
    return ds;
}

然后在yml中定义要绑定的属性，注意datasource此时全小写

datasource:
  driverClassName: com.mysql.cj.jdbc.Driver

最后使用@ConfigurationProperties注解为第三方bean进行属性绑定，注意前缀是全小写的datasource

@Bean
@ConfigurationProperties(prefix = "datasource")
public DruidDataSource datasource(){
    DruidDataSource ds = new DruidDataSource();
    return ds;
}

操作方式跟刚才一样，不同的是@ConfigurationProperties注解不仅能添加到类上，还可以添加到方法上，添加到类上是为spring容器管理的当前类的对象绑定属性，添加到方法上是为spring容器管理的当前方法的返回值对象绑定属性，本质上都一样。

但是目前我们定义bean不是通过类注解定义就是通过@Bean定义，使用@ConfigurationProperties注解可以为bean进行属性绑定，那在实际工作中，哪些bean通过注解@ConfigurationProperties去绑定属性了呢？因为这个注解不仅可以写在类上，还可以写在方法上，所以找起来就比较麻烦了。

为了解决这个问题，spring给我们提供了一个全新的注解，专门标注使用@ConfigurationProperties注解绑定属性的bean是哪些。这个注解叫做@EnableConfigurationProperties

首先在配置类上开启@EnableConfigurationProperties注解，并标注要使用@ConfigurationProperties注解绑定属性的类

@SpringBootApplication
@EnableConfigurationProperties(ServerConfig.class)
public class Springboot13ConfigurationApplication {
}

然后在对应的类上直接使用@ConfigurationProperties进行属性绑定

@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

可能小伙伴们会说，这没区别啊？仔细观察，现在绑定属性的ServerConfig类并没有声明@Component注解。当使用@EnableConfigurationProperties注解时，spring会默认将其标注的类定义为bean，因此无需再次声明@Component注解了。

注意，如果在使用@ConfigurationProperties注解时，会出现下图的提示：
SpringBoot配置文件的分水岭——高级配置的使用
只需要添加一个坐标就可以解决了

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

总结

  • 使用@ConfigurationProperties可以为使用@Bean声明的第三方bean绑定属性
  • 当使用@EnableConfigurationProperties声明进行属性绑定的bean后，无需使用@Component注解再次进行bean声明

三、松散绑定

在进行属性绑定时，为了进行标准命名，我们会将属性名严格按照驼峰命名法书写，在yml配置文件中将datasource修改为dataSource，如下：

dataSource:
  driverClassName: com.mysql.cj.jdbc.Driver

此时程序可以正常运行，然后又将代码中的前缀datasource修改为dataSource，如下：

@Bean
@ConfigurationProperties(prefix = "dataSource")
public DruidDataSource datasource(){
    DruidDataSource ds = new DruidDataSource();
    return ds;
}

此时代码就会报错，为什么会出现这种问题？这就要来说一说springboot进行属性绑定时的一个重要知识点——松散绑定

​什么是宽松绑定？是springboot进行编程时人性化设计的一种体现，即配置文件中的命名格式与变量名的命名格式可以进行格式上的最大化兼容

在ServerConfig中的ipAddress属性名

@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    private String ipAddress;
}

可以与下面的配置属性名规则全兼容：

servers:
  ipAddress: 192.168.0.2       # 驼峰模式
  ip_address: 192.168.0.2      # 下划线模式
  ip-address: 192.168.0.2      # 烤肉串模式
  IP_ADDRESS: 192.168.0.2      # 常量模式

以上4种模式最终都可以匹配到ipAddress这个属性名。为什么这样呢？原因就是在进行匹配时，配置中的名称要去掉中划线和下划线后，忽略大小写的情况下去与java代码中的属性名进行忽略大小写的等值匹配，以上4种命名去掉下划线中划线忽略大小写后都是一个词ipaddress，java代码中的属性名忽略大小写后也是ipaddress，这样就可以进行等值匹配了，这就是为什么这4种格式都能匹配成功的原因。不过springboot官方推荐使用烤肉串模式，也就是中划线模式。

注意：以上规则仅针对springboot中@ConfigurationProperties注解进行属性绑定时有效，对@Value注解进行属性映射无效。

总结

  • @ConfigurationProperties绑定属性时支持属性名宽松绑定，这个宽松体现在属性名的命名规则上
  • @Value注解不支持松散绑定规则
  • 绑定前缀名推荐采用烤肉串命名规则，即使用中划线做分隔符

四、常用计量单位绑定

在前面的配置中，我们书写了如下配置值，其中第三项超时时间timeout描述了服务器操作超时时间，当前值是-1表示永不超时。

servers:
  ipAddress: 192.168.0.2
  port: 1111
  timeout: -1

但是每个人都这个值的理解会产生不同，比如线上服务器完成一次主从备份，配置超时时间240，这个240如果单位是秒就是超时时间4分钟，如果单位是分钟就是超时时间4小时。面对一次线上服务器的主从备份，设置4分钟等等。那么问题就来了，怎么解决这个误会？

springboot充分利用了JDK8中提供的全新的用来表示计量单位的新数据类型，用来解决这个问题。ServerConfig 类中添加了两个JDK8中新增的类，分别是Duration和DataSize

@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    @DurationUnit(ChronoUnit.HOURS)
    private Duration serverTimeOut;
    @DataSizeUnit(DataUnit.MEGABYTES)
    private DataSize dataSize;
}
  • Duration：表示时间间隔，可以通过@DurationUnit注解描述时间单位，例如上例中描述的单位为小时（ChronoUnit.HOURS）
  • DataSize：表示存储空间，可以通过@DataSizeUnit注解描述存储空间单位，例如上例中描述的单位为MB（DataUnit.MEGABYTES）

使用上述两个单位就可以有效避免因沟通不同步或文档不健全导致的信息不对称问题，从根本上解决了问题，避免产生误读。

Druation常用单位如下：

SpringBoot配置文件的分水岭——高级配置的使用
DataSize常用单位如下：
SpringBoot配置文件的分水岭——高级配置的使用

五、校验

由于无法感知模型类中的数据类型，就会出现类型不匹配的问题，比如代码中需要int类型，配置中给了非法的数值，例如写一个“a"，这种数据肯定无法有效的绑定，还会引发错误。SpringBoot给出了强大的数据校验功能，可以有效的避免此类问题的发生。

首先开启校验框架，引入需要的依赖

<!--1.导入JSR303规范-->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>
<!--使用hibernate框架提供的校验器做实现-->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

然后在需要开启校验功能的类上使用注解@Validated开启校验功能

@Component
@Data
@ConfigurationProperties(prefix = "servers")
//开启对当前bean的属性注入校验
@Validated
public class ServerConfig {
}

最后对具体的字段设置校验规则

@Component
@Data
@ConfigurationProperties(prefix = "servers")
//开启对当前bean的属性注入校验
@Validated
public class ServerConfig {
    //设置具体的规则
    @Max(value = 666,message = "最大值不能超过666")
    @Min(value = 28,message = "最小值不能低于28")
    private int port;
}

总结

开启Bean属性校验功能一共3步：

  • 导入JSR303与Hibernate校验框架坐标、
  • 使用@Validated注解启用校验功能
  • 使用具体校验规则规范数据校验格式

六、数据类型转换

假如我们配合数据库的配置文件是这样的，用户名、密码的数值是正确的，注意，我这里说的是数值

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/ssm_db?serverTimezone=UTC
    username: root
    password: 0123

这名开发者的生日是1月23日，所以密码就使用了0123，问题就出在这里了。

还记得我在SpringBoot配置文件是什么？该如何使用？这篇基础文章中的知识点吗？
SpringBoot配置文件的分水岭——高级配置的使用
问题就出现在了支持进制， 0123在开发者眼中是一个字符串“0123”，但是在springboot看来，这就是一个数字，而且是一个八进制的数字。当后台使用String类型接收数据时，如果配置文件中配置了一个整数值，他是先安装整数进行处理，读取后再转换成字符串。巧了，0123撞上了八进制的格式，所以最终以十进制数字83的结果存在了。

注意点：

  • 字符串标准书写加上引号包裹，养成习惯
  • 遇到0开头的数据多注意

七、总结

乐莫乐兮新相知，很高兴各位小伙伴可以坚持看完这篇文章。如果对你有帮助，可以给博主一个赞哦~~ 一起加油，一起进步！

版权声明：程序员胖胖胖虎阿 发表于 2023年8月31日 下午11:40。
转载请注明：SpringBoot配置文件的分水岭——高级配置的使用 | 胖虎的工具箱-编程导航

相关文章

应聘Java岗啥都答不出，面试官无奈吐槽“啥时候能有人给我挖坑”
程序员胖胖胖虎阿
375
TCP协议详解 (史上最全)
程序员胖胖胖虎阿
442
IDEA正版注册码(IntelliJ IDEA最新破解插件永久有效)
程序员胖胖胖虎阿
313
面试突击79：Bean 作用域是啥？它有几种类型？
程序员胖胖胖虎阿
266
IDEA2022.1激活工具(IDEA2020破解方法每日更新)
程序员胖胖胖虎阿
197
IDEA最新激活工具(windows/mac idea2020破解方法绝对有效)
程序员胖胖胖虎阿
318

暂无评论

暂无评论...
致力于称为最好的程序员导航网站

友链申请 免责声明 关于我们

Copyright © 2022  胖虎的工具箱-编程导航   陇ICP备2022001249号