Spring中的@ConfigurationProperties詳解

更新時間：2023年09月25日 09:52:52 作者：騎個小蝸牛

這篇文章主要介紹了Spring中的@ConfigurationProperties詳解,ConfigurationProperties注解主要用于將外部配置文件配置的屬性填充到這個Spring Bean實例中,需要的朋友可以參考下

@ConfigurationProperties

ConfigurationProperties注解主要用于將外部配置文件配置的屬性填充到這個** Spring Bean實例 **中。

需要注意：它自己單獨使用無效，需要配合其它注解一起使用。且對于Spring Bean才生效，普通的new 對象不生效。

ConfigurationProperties的使用方式：

@ConfigurationProperties + @Component（或其它實例化Bean的注解）注解到bean定義類上
@ConfigurationProperties + @Bean注解到配置類的bean定義方法上
@ConfigurationProperties注解到普通類，然后通過@EnableConfigurationProperties定義為bean

使用方式

配置文件：

sftp:
  host: 127.0.0.1
  port: 22
  username: admin
  password: 123456

1. @ConfigurationProperties + @Component

@ConfigurationProperties + @Component（或其它實例化Bean的注解）注解到bean定義類上

@Data
@Component
// @Configuration
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

2. @ConfigurationProperties + @Bean

@ConfigurationProperties + @Bean注解到配置類的bean定義方法上

@Data
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@Configuration
public class BeanConfig {
    @Bean
    @ConfigurationProperties(prefix = "sftp")
    public Sftp sftp() {
        return new Sftp();
    }
}

此種用法遇到的坑：重復(fù)使用@ConfigurationProperties 如果將代碼改成這樣：

@Data
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@Configuration
public class BeanConfig {
    @Bean
    @ConfigurationProperties(prefix = "aaaa")
    public Sftp sftp() {
        return new Sftp();
    }
}

這種方式上有@ConfigurationProperties注解，且類上也有@ConfigurationProperties注解的，只有方法上的@ConfigurationProperties會生效（可以理解為類上的注解方法的給重寫了）。

3. @ConfigurationProperties + @EnableConfigurationProperties

@ConfigurationProperties注解到普通類，然后通過@EnableConfigurationProperties定義為bean

@Data
@ConfigurationProperties(prefix = "sftp")
public class Sftp {
    private String host;
    private String port;
    private String username;
    private String password;
}

@SpringBootApplication
@EnableConfigurationProperties(value = {Sftp.class})
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}

到此這篇關(guān)于Spring中的@ConfigurationProperties詳解的文章就介紹到這了,更多相關(guān)@ConfigurationProperties詳解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: