spring的構(gòu)造函數(shù)注入屬性@ConstructorBinding用法

更新時(shí)間：2023年12月15日 14:27:49 作者：搏·夢(mèng)

這篇文章主要介紹了關(guān)于spring的構(gòu)造函數(shù)注入屬性@ConstructorBinding用法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

前言

前情回顧：

實(shí)體類使用@Builder，導(dǎo)致@ConfigurationProperties注入屬性失敗

根據(jù)上一篇文章，引出如下問題：

先說結(jié)論

@ConstructorBinding注解：這個(gè)注解是SpringBoot在2.2發(fā)行版中添加的，添加該注解的屬性配置類不再需要添加Setter方法，但是需要添加構(gòu)造函數(shù)，根據(jù)構(gòu)造函數(shù)進(jìn)行實(shí)例化屬性配置類。

使用@ConstructorBinding，該類得擁有有參的構(gòu)造函數(shù)方法，才可以賦值成功。

@ConstructorBinding注解的類，此類不能加@Component類似聲明該類為bean對(duì)象的注解，因?yàn)閟pring創(chuàng)建bean的時(shí)候，有種方式叫構(gòu)造函數(shù)創(chuàng)建bean，如果此類加上@Component，構(gòu)造函數(shù)的參數(shù)，則都是去單例池中找對(duì)象并注入。

回答上一篇問題：

使用該@ConstructorBinding注解，進(jìn)行構(gòu)造函數(shù)方法注入屬性，可以不用set方法，因此完全可以不用提供set方法。
如果不想提供無參的構(gòu)造函數(shù)方法，使用@Builder，因?yàn)锧Builder可以把無參構(gòu)造函數(shù)給抹殺掉，擁有全參構(gòu)造函數(shù)，再配合@ConstructorBinding即可，屬性注入。

快速入門

// @EnableConfigurationProperties的具體使用方式可以看如下：
// https://blog.csdn.net/xueyijin/article/details/124072389
@Component
@EnableConfigurationProperties(demoFailedTest.class)
@ToString
public class demoFailedConfig {
    @Autowired
    private demoFailedTest demoFailedTest;
}

@ToString
@ConfigurationProperties(prefix = "failed.test")
@ConstructorBinding
@AllArgsConstructor
public class demoFailedTest {

    private String username;
    private int age;
    private demoPerson demoPerson;

}

@ToString
@AllArgsConstructor
@ConstructorBinding
public class demoPerson {
    private String name;
    private String sex;
}

@Component("demoFailedTestRunner")
public class demoRunner implements ApplicationRunner {

    @Autowired
    demoFailedConfig demoFailedConfig;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(demoFailedConfig);
    }
}

運(yùn)行結(jié)果圖：

其他情況案例

1.屬性不在構(gòu)造函數(shù)的參數(shù)列表中

無法被注入

@Component
@EnableConfigurationProperties(demoFailedTest.class)
@ToString
public class demoFailedConfig {

    @Autowired
    private demoFailedTest demoFailedTest;
}

@ToString
@ConfigurationProperties(prefix = "failed.test")
@ConstructorBinding
public class demoFailedTest {

    private String username;
    private int age;
    private demoPerson demoPerson;

	// 少了age屬性
    public demoFailedTest(String username, com.example.csdn.configuration_failed_test.demoPerson demoPerson) {
        this.username = username;
        this.demoPerson = demoPerson;
    }
}

@ToString
@ConstructorBinding
public class demoPerson {
    private String name;
    private String sex;

	// 少了name屬性
    public demoPerson(String sex) {
        this.sex = sex;
    }
}

@Component("demoFailedTestRunner")
public class demoRunner implements ApplicationRunner {

    @Autowired
    demoFailedConfig demoFailedConfig;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(demoFailedConfig);
    }
}

2.使用@ConstructorBinding的類上再使用@Component注解

會(huì)報(bào)錯(cuò)

@Component
@EnableConfigurationProperties(demoFailedTest.class)
@ToString
public class demoFailedConfig {
    @Autowired
    private demoFailedTest demoFailedTest;
}

@Component
@ToString
@ConfigurationProperties(prefix = "failed.test")
@ConstructorBinding
@Builder
public class demoFailedTest {
    private String username;
    private int age;
    private demoPerson demoPerson;
}

@ToString
@ConstructorBinding
@Builder
public class demoPerson {
    private String name;
    private String sex;
}


@Component("demoFailedTestRunner")
public class demoRunner implements ApplicationRunner {

    @Autowired
    demoFailedConfig demoFailedConfig;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(demoFailedConfig);
    }
}

可以從報(bào)錯(cuò)信息看出來，spring將該demoFailedTest類執(zhí)行構(gòu)造函數(shù)方法的時(shí)候，當(dāng)成創(chuàng)建該類的單例bean對(duì)象，因此，該構(gòu)造函數(shù)所需的參數(shù)，必然是從單例池中去找，顯示是沒有String類型的單例對(duì)象，所以報(bào)錯(cuò)了。