快捷導(dǎo)航

SpringBoot屬性綁定與bean屬性校驗實現(xiàn)方法詳解

更新時間：2022年11月15日 14:03:56 作者：CN丶1

這篇文章主要介紹了SpringBoot屬性綁定與bean屬性校驗實現(xiàn)方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)吧

屬性綁定

屬性綁定：我們可以使用配置文件對類的屬性進(jìn)行賦值綁定。

自定義類屬性綁定

我們自定義一個類，在此使用yml文件進(jìn)行類屬性的綁定。

屬性綁定步驟：

1.創(chuàng)建一個類，設(shè)置字段。

public class ServiceConfig {
    private int prot;
    private String ipAddress;
    private long timeOut;

2.添加注解

@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServiceConfig {
    private int prot;
    private String ipAddress;
    private long timeOut;

注解說明：

@Component：將此類加入Spring容器。

@Data：使用lombok快速創(chuàng)建實體類。

@ConfigurationProperties：聲明此類使用配置文件進(jìn)行屬性綁定，

并且設(shè)置使用配置文件中的哪個數(shù)據(jù)。

3.配置文件設(shè)置數(shù)據(jù)

4.測試：在boot引導(dǎo)類中

@SpringBootApplication
public class SpringBootDemo2Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringBootDemo2Application.class, args);
//獲取自定義類
        ServiceConfig bean = context.getBean(ServiceConfig.class);
//打印獲取的bean，查看是否成功綁定屬性
        System.out.println(bean);
    }
}

測試結(jié)果: 發(fā)現(xiàn)打印出來的數(shù)據(jù)就是我們在yml中設(shè)置的數(shù)據(jù)

第三方bean屬性匹配

說明：有時候我們的需求并不只是想要給我們自己的類進(jìn)行屬性綁定，還需要給第三方的bean進(jìn)行屬性綁定。

在此使用DruidDataSource作為第三方bean，為此bean進(jìn)行屬性綁定。

將Druid加入spring容器。（操作前提是導(dǎo)入了Druid坐標(biāo)）

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

yml文件中進(jìn)行屬性綁定

datasource:
username: root
password: root
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test

測試：打印第三方bean的配置數(shù)據(jù)到控制臺看效果

@SpringBootApplication
public class SpringBootDemo2Application {
    @Bean
    @ConfigurationProperties(prefix = "datasource")
    public DruidDataSource dataSource(){
        DruidDataSource druid = new DruidDataSource();
        return druid;
    }
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringBootDemo2Application.class, args);
        DruidDataSource bean = context.getBean(DruidDataSource.class);
        System.out.println(bean.getUsername());
        System.out.println(bean.getPassword());
        System.out.println(bean.getUrl());
        System.out.println(bean.getDriverClassName());
    }
}

測試結(jié)果：

規(guī)則-松散綁定（寬松綁定）

寬松綁定是一種特性，說的是在配置文件中的綁定屬性的數(shù)據(jù)時，屬性名的書寫規(guī)定很寬松。

松散綁定的規(guī)則：忽略標(biāo)點符號，將所有字母轉(zhuǎn)為小寫

特點：匹配規(guī)則很寬松。

舉例：屬性綁定，在配置文件中設(shè)置多種屬性名進(jìn)行匹配。

我們配置類的ipAddress屬性，查看在配置文件中書寫屬性的多種形式。

需要設(shè)置的屬性：

配置文件中進(jìn)行屬性綁定：

說明：上面的方式，均可以對屬性進(jìn)行綁定，并未列出所有。

原因：忽略標(biāo)點符號，將所有字母轉(zhuǎn)為小寫

如上方式有很多種，其中，官方主張”烤肉串模式”。

烤肉串模式：ip-address: 198.56.23.38

值得注意的是：

如上的寬松綁定規(guī)則僅僅限于：@ConfigurationProperties

Bean屬性校驗

對類的屬性賦值時自定義規(guī)則進(jìn)行校驗。

"屬性校驗"使用步驟

1.導(dǎo)入對應(yīng)坐標(biāo)

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

坐標(biāo)說明：

validation-api：是屬性校驗的接口坐標(biāo)。

hibernate-validator：相當(dāng)于是屬性校驗的接口實現(xiàn)類坐標(biāo)。

兩者關(guān)系就像jdbc和MySQL驅(qū)動相似，所以需要導(dǎo)入兩個坐標(biāo)。

2.開啟校驗功能

在需要啟用校驗功能的類上寫注解：@Validated。

@Data
@ConfigurationProperties(prefix = "servers")
@Validated
public class ServiceConfig {
}

3.設(shè)置校驗規(guī)則

在屬性上設(shè)置校驗規(guī)則

@Data
@ConfigurationProperties(prefix = "servers")
@Validated
public class ServiceConfig {
    @Max(value = 8888,message = "最大值能超過8888")
    @Min(value = 200,message = "最小值不可小于200")
    private int prot;
    private String ipAddress;
    private long timeOut;
}

說明：如上代碼中，@Max和@Min就是設(shè)置的規(guī)則，其中有value和messge兩個屬性。

提供數(shù)據(jù)校驗的規(guī)則有許多，如下（查看constraints包）：