spring boot中使用@ConfigurationProperties注解

最新推荐文章于 2025-06-23 16:18:06 发布

转载最新推荐文章于 2025-06-23 16:18:06 发布 · 541 阅读

文章标签：

#ConfigurationProperties

转载专栏收录该内容

5 篇文章

订阅专栏

本文介绍如何利用Spring Boot的@ConfigurationProperties注解，自动读取配置文件信息并封装到实体类中，提供了两种使用方式及示例代码，同时解决不生效的问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

今天在看项目的代码时，看到了这个ConfigurationProperties注解，以前没有用过，然后就查了一下相关知识。

想把配置文件的信息，读取并自动封装成实体类，可以使用@ConfigurationProperties，可以把同类的配置信息自动封装成实体类。

例子：

配置文件:

connection.username=admin
connection.password=kyjufskifas2jsfs
connection.remoteAddress=192.168.1.1

定义一个实体类在装载配置文件信息
第一种用法 Component和ConfigurationProperties结合使用
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {

    private String username;
    private String remoteAddress;
    private String password ;

    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getRemoteAddress() {
        return remoteAddress;
    }
    public void setRemoteAddress(String remoteAddress) {
        this.remoteAddress = remoteAddress;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }

}

第二种用法将@ConfigurationProperties直接定义在@bean的注解上

@SpringBootApplication
public class DemoApplication{

    //...

    @Bean
    @ConfigurationProperties(prefix = "connection")
    public ConnectionSettings connectionSettings(){
        return new ConnectionSettings();

    }

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

使用的时候就直接注入

@RestController
@RequestMapping("/task")
public class TaskController {

@Autowired ConnectionSettings conn;

@RequestMapping(value = {"/",""})
public String hellTask(){
    String userName = conn.getUsername();     
    return "hello task !!";
}

}

如果发现@ConfigurationPropertie不生效，有可能是项目的目录结构问题，

你可以通过@EnableConfigurationProperties(ConnectionSettings.class)来明确指定需要用哪个实体类来装载配置信息

@Configuration
@EnableConfigurationProperties(ConnectionSettings.class)
 public class MailConfiguration { 
    @Autowired private MailProperties mailProperties; 

    @Bean public JavaMailSender javaMailSender() {
      // omitted for readability
    }
 }