SpringBoot2底層註解@ConfigurationProperties設定繫結

2022-05-28 14:00:21

SpringBoot2底層註解@ConfigurationProperties的設定繫結

我們通常會把一些經常變動的東西放到組態檔裡。

比如之前寫在組態檔application.properties裡的埠號server.port=8080，另外常見的還有資料庫的連線資訊等等。

那麼，我的資料庫連線資訊放在組態檔裡，我要使用的話肯定得去解析組態檔，解析出的內容在 bean 裡面去使用。

整個場景其實就是把組態檔裡的所有設定，繫結到 java bean 裡面。

要完成這個場景，基於 java 原生程式碼編寫還是有點麻煩的。通常會做一個封裝，讀取到properties檔案中的內容，並且把它封裝到JavaBean中：

public class getProperties {
     public static void main(String[] args) throws FileNotFoundException, IOException {
         Properties pps = new Properties();
         pps.load(new FileInputStream("a.properties"));
         Enumeration enum1 = pps.propertyNames();//得到組態檔的名字
         while(enum1.hasMoreElements()) {
             String strKey = (String) enum1.nextElement();
             String strValue = pps.getProperty(strKey);
             System.out.println(strKey + "=" + strValue);
             //封裝到JavaBean
             ... ...
         }
     }

這裡就是使用Properties類來載入組態檔a.properties，然後遍歷組態檔中的每一個k-v，獲取之後就可以用到對應的地方。

在 springboot 中簡化了這個過程，這就是設定繫結。

設定繫結

通過使用註解@ConfigurationProperties來完成設定繫結，注意需要結合@Component使用。

新建一個元件Car，有2個屬性分別是品牌和價格：

@Component
public class Car {
    private String brand;
    private Integer price;
// get set tostring 就不貼了

在組態檔application.properties，設定一些屬性值，比如：

mycar.brand=QQmycar.price=9999

使用@ConfigurationProperties註解，加到元件上：

mycar.brand=QQ
mycar.price=9999

傳進去的 prefix 是組態檔裡的字首，這裡就是 mycar。

驗證

現在來測試一下是否繫結成功，在之前的HelloController繼續增加一個控制器方法:

@RestController
public class HelloController {
    @Autowired
    Car car;
    @RequestMapping("/car")
    public Car car() {
        return car;
    }
    @RequestMapping("/hello")
    public String Hello() {
        return "Hello SpringBoot2 你好";
    }
}

部署一下應用，瀏覽器存取http://localhost:8080/car:

繫結成功。

另一種方式

除上述方法之外，還可以使用@EnableConfigurationProperties + @ConfigurationProperties的方式來完成繫結。

注意，@EnableConfigurationProperties註解要使用在設定類上，表示開啟屬性設定的功能：

//@ConditionalOnBean(name = "pet1")
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
@ImportResource("classpath:beans.xml")  //組態檔的類路徑
@EnableConfigurationProperties(Car.class) //開啟屬性設定的功能
public class MyConfig {
 
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
 
    @Bean("pet22")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

@EnableConfigurationProperties(Car.class)傳入要開啟設定的類，這可以自動的把 Car 註冊到容器中，也就是說之前 Car 上的@Component就不需要了。

//@Component
@ConfigurationProperties(prefix = "mycar")
public class Car {
    private String brand;
    private Integer price;

重新部署存取下地址，依然可以。

關於第二種的使用場景，比如這裡的 Car 是一個第三方包裡的類，但是人家原始碼沒有加@Component註解，這時候就可以用這種方式進行繫結。

最後，要記住當使用@ConfigurationProperties(prefix = "mycar")這個設定繫結時，是跟 springboot 核心組態檔 application.properties檔案的內容建立的繫結關係。

以上就是SpringBoot2底層註解@ConfigurationProperties設定繫結的詳細內容，更多關於SpringBoot2註解設定繫結的資料請關注it145.com其它相關文章！

SpringBoot2底層註解@ConfigurationProperties設定繫結

目錄

SpringBoot2底層註解@ConfigurationProperties的設定繫結

設定繫結

驗證

另一種方式

熱門文章