@ConfigurationProperties解读

2023-12-06 23:00:41 浏览数 (1)

@ConfigurationProperties

当想需要获取到配置文件数据时,除了可以用 Spring 自带的 @Value 注解外,SpringBoot 还提供了一种更加方便的方式:@ConfigurationProperties。 此注解的作用是用来为bean绑定属性的。开发者可以在yml配置文件中以对象的格式添加若干属性

自定义bean使用注入

在application.yml中 配置

代码语言:javascript复制
servers:
  ip-address: 192.168.0.1 
  port: 2345
  timeout: -1

然后再开发一个用来封装数据的实体类,注意要提供属性对应的setter方法

代码语言:javascript复制
@Component
@Data
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

 使用@ConfigurationProperties注解就可以将配置中的属性值关联到开发的模型类上

代码语言:javascript复制
@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

 我们可以在启动类中测试一波

代码语言:javascript复制
@SpringBootApplication
public class SsmpApplication {

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

}

测试结果如下:

 第三方bean注入

@ConfigurationProperties注解是写在类定义的上方,而第三方开发的bean源代码不是你自己书写的,也不可能到源代码中去添加@ConfigurationProperties注解,这种问题该怎么解决呢?下面就来说说这个问题。

使用@ConfigurationProperties注解其实可以为第三方bean加载属性,格式特殊一点而已。

步骤①:使用@Bean注解定义第三方bean

代码语言:javascript复制
@Bean
public DruidDataSource datasource(){
    DruidDataSource ds = new DruidDataSource();
    return ds;
}

步骤②:在yml中定义要绑定的属性,注意datasource此时全小写

代码语言:javascript复制
datasource:
  driverClassName: com.mysql.cj.jdbc.Driver

步骤③:使用@ConfigurationProperties注解为第三方bean进行属性绑定,注意前缀是全小写的datasource

代码语言:javascript复制
@Bean
@ConfigurationProperties(prefix = "datasource")
public DruidDataSource datasource(){
    DruidDataSource ds = new DruidDataSource();
    return ds;
}

 @ConfigurationProperties注解不仅能添加到类上,还可以添加到方法上,添加到类上是为spring容器管理的当前类的对象绑定属性,添加到方法上是为spring容器管理的当前方法的返回值对象绑定属性,其实本质上都一样。

@EnableConfigurationProperties

我们定义bean不是通过类注解定义就是通过@Bean定义,使用@ConfigurationProperties注解可以为bean进行属性绑定,那在一个业务系统中,哪些bean通过注解@ConfigurationProperties去绑定属性了 了呢? 因为这个注解不仅可以写在类上,还可以写在方法上,所以找起来就比较麻烦了。为了解决这个问题方便统一直观的看到,spring给我们提供了一个全新的注解,专门标注使用@EnableConfigurationProperties

步骤①:在配置类上开启@EnableConfigurationProperties注解,并标注要使用@ConfigurationProperties注解绑定属性的类

代码语言:javascript复制
@SpringBootApplication
@EnableConfigurationProperties(ServerConfig.class)
public class SsmpApplication {
}

步骤②:在对应的类上直接使用@ConfigurationProperties进行属性绑定

代码语言:javascript复制
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {
    private String ipAddress;
    private int port;
    private long timeout;
}

这里需要注意在 ServerConfig 这个类中就不用标@Component注解,@EnableConfigurationProperties会自己加载这个bean了否则就会出现

 现在绑定属性的ServerConfig类并没有声明@Component注解。当使用@EnableConfigurationProperties注解时,spring会默认将其标注的类定义为bean,因此无需再次声明@Component注解了。

0 人点赞