springboot第三方bean属性绑定&yaml语法规则

• 使用@ConfigurationProperties为自定义属性和第三方bean绑定属性，给对象属性进行注入。

自定义的bean进行加载

//自定义的bean
@Component   //最终要加载配置中对应的属性，所以这个类必须受spring管控
@Data
@ConfigurationProperties(prefix = "servers")   //这个类初始化的时候加载yml里面的数据
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

#描述服务的三个数据
servers:
  ipAddress: 192.168.1
  port: 12345
  timeout: -1

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootConfigurationApplication.class, args);
        ServerConfig bean = run.getBean(ServerConfig.class);  //获取这个对象
        System.out.println(bean);
    }

第三方bean属性绑定

通过第三方druid连接池演示

• @EnableConfigurationProperties注解

@EnableConfigurationProperties注解可以将
使用@ConfigurationProperties注解对应的类加入Spring容器。

@SpringBootApplication
/**
 *配置属性，把要做配置的类写进去，注解加上后，这个类要通过@ConfigurationProperties读取属性。
 *用来开启配置属性的功能，可以通过配置的属性向对应的类里面做属性注入。
 */
@EnableConfigurationProperties(ServerConfig.class)  

public class SpringbootConfigurationApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootConfigurationApplication.class, args);
        ServerConfig bean = run.getBean(ServerConfig.class);
        System.out.println(bean);
    }
}

ServerConfig类就不用写@Component注解了。
因为@EnableConfigurationProperties自动自动把对应的类加入Spring容器。

宽松绑定

• @ConfigurationProperties绑定属性支持属性名宽松绑定。

servers:
#    ipAddress: 192.168.1  驼峰
#    ip-address: 192.168.1   烤肉串模式 
#    ip_address: 192.168.1    unline
#    ipADDRESS: 192.168.1     常量模式
  ipAddress: 192.168.1
  port: 12345
  timeout: -1

• 注意：

宽松绑定不支持注解@Value引用单个属性的方式。
绑定前缀名命名规范：仅能使用纯小写字母、数字、下划线作为合法的字符。

常用计量单位应用

@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
//    描述时间范围
    @DurationUnit(ChronoUnit.HOURS)  // 自定义单位种类
    private Duration serverTimeOut;

//    配存储容量
    @DataSizeUnit(DataUnit.GIGABYTES) // 设置单位,服务器缓存大小,或者在yml写单位也可以
    private DataSize dataSize;
}

servers:
  serverTimeOut: 3
  dataSize: 10

bean属性效验

• 开启数据校验有助于系统安全性，J2EE规范中JSR303规范定义了一组有关数据校验相关的API。

①：添加JSR303规范坐标与Hibernate校验框架对应坐标

<!--1. 导入JSR303规范-->
        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>
<!--使用hibernate框架效验器做实验-->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>

②：对Bean开启校验功能

//2. 开启当前bean的属性注入效验
@Validated
public class ServerConfig {
}

③：设置校验规则

@Data
@ConfigurationProperties(prefix = "servers")   //这个类初始化的时候加载yml里面的数据
//2. 开启当前bean的属性注入效验
@Validated
public class ServerConfig {
    private String ipAddress;
//    效验规则
    @jakarta.validation.constraints.Min(value = 202,message = "最小值不低于202")
    private int port;
}

yaml语法规则

• 注意：

yaml文件中对于数字的定义支持进制书写格式，如需使用字符串请使用引号明确标注。