Spring Boot（5）：@ConfigurationProperties和@EnableConfigurationProperties配置绑定

news/2024/4/17 7:23:22/文章来源:https://blog.csdn.net/qq_43745578/article/details/127253566

ConfigurationProperties

简介

Spring源码中大量使用了ConfigurationProperties注解，比如server.port就是由该注解获取到的，通过与其他注解配合使用，能够实现Bean的按需配置。

该注解有一个prefix属性，通过指定的前缀，绑定配置文件中的配置。该注解可以放在类上，也可以放在方法上。
源码如下：

package org.springframework.boot.context.properties;import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Indexed;@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface ConfigurationProperties {@AliasFor("prefix")String value() default "";@AliasFor("value")String prefix() default "";boolean ignoreInvalidFields() default false;boolean ignoreUnknownFields() default true;
}

示例

下面以一个示例演示如何使用ConfigurationProperties注解进行配置绑定。

1.编写配置文件

application.properties配置如下：

mycar.brand=BYD
mycar.price=10000

2.编写组件

有如下组件，需要注册到容器，代码如下：

package com.example.ethan.bean;import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;@Component
@ConfigurationProperties(prefix = "mycar")
public class Car {private String name;private Integer price;public Car() {}public Car(String name, Integer price) {this.name = name;this.price = price;}public String getName() {return name;}public void setName(String name) {this.name = name;}public Integer getPrice() {return price;}public void setPrice(Integer price) {this.price = price;}@Overridepublic String toString() {return "Car{" +"name='" + name + '\'' +", price=" + price +'}';}
}

使用@ConfigurationProperties(prefix = "mycar")注解并指定前缀，指定这个类会使用配置文件中mycar开头的配置。并且会把配置中的配置名和属性名称匹配的属性进行绑定。

3.编写主程序测试

package com.example.ethan;import ch.qos.logback.core.db.DBHelper;
import com.example.ethan.bean.Car;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import com.example.ethan.config.ConfigDemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;@SpringBootApplication
public class EthanApplication {public static void main(String[] args) {// 返回ioc容器ConfigurableApplicationContext run = SpringApplication.run(EthanApplication.class, args);Car car = run.getBean(Car.class);System.out.println(car);// Car{name='null', price=10000}}
}

可以看到成功把配置绑定到属性上了。

注意：要绑定属性的类必须是被容器管理的Bean，配置才能绑定到属性上。
上面的Car类时通过@Component注解注册到容器中了。

EnableConfigurationProperties

上面那种方式，必须是是被容器管理的Bean才能把配置绑定到属性上。为此在类上使用了Componen注解。

加如是第三方的组件，别人没有Component注解，还有一种方式可以实现上述功能，就是使用EnableConfigurationProperties注解。

示例如下：

首先把Car类上的Component注解去掉，然后在配置类上使用EnableConfigurationProperties注解，如下

package com.example.ethan.config;import com.example.ethan.bean.Car;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration(proxyBeanMethods=true)
@EnableConfigurationProperties(Car.class)
public class ConfigDemo {@Bean("my rd")public Dept rd(){return new Dept("研发部");}@Beanpublic User user01(){User zhangsan = new User("zhangsan", 18);//user组件依赖了Dept组件zhangsan.setDept(rd());return zhangsan;}
}