快捷導(dǎo)航

SpringBoot的ConfigurationProperties或Value注解無效問題及解決

更新時間：2024年11月01日 15:09:40 作者：Cadreman Johnson

在SpringBoot項目開發(fā)中,全局靜態(tài)配置類讀取application.yml或application.properties文件時,可能會遇到配置值始終為null的問題,這通常是因為在創(chuàng)建靜態(tài)屬性后,IDE自動生成的Get/Set方法包含了static關(guān)鍵字

SpringBoot的ConfigurationProperties或Value注解無效

記錄一個問題

在一般的SpringBoot項目開發(fā)中，我們一般會創(chuàng)建一些全局的靜態(tài)配置類，用來讀取application.yml/application.properties配置文件的內(nèi)容。

普遍的做法是利用@Component和@ConfigurationProperties(prefix = “XXX”)這兩個注解來幫我們實現(xiàn)。

# 項目相關(guān)配置
cadre:
  # 名稱
  name: cadreuc

package com.cadre.common.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * 全局配置類
 *
 * @author cadre
 */
@Component
@ConfigurationProperties(prefix = "cadreman")
public class Global
{
    /** 項目名稱 */
    private static String name;

    public static String getName()
    {
        return name;
    }

    public static void setName(String name)
    {
        Global.name = name;
    }
}

原理非常簡單，利用Spring將屬性注入到靜態(tài)類，然后通過靜態(tài)類的特性使我們可以在項目全局取到它的值。

但是，當(dāng)我們照貓畫虎的創(chuàng)建了一個靜態(tài)類后，卻發(fā)現(xiàn)我們?nèi)〉闹凳冀K為null。

難道是Component注解失效了嗎？并不是，我們創(chuàng)建一個同名的Bean后提示命名重復(fù)。

難道是ConfigurationProperties注解失效了嗎？帶著疑問，我們繼續(xù)研究。

發(fā)現(xiàn)問題所在

作為一名資深的CV程序員，已經(jīng)多年沒有手打過Get/Set方法了。

然而問題就在這里。當(dāng)我們創(chuàng)建了一個靜態(tài)屬性時，IDE幫我們生成的Get/Set方法都默認(rèn)加上了static。

	/** 項目名稱 */
    private static String name;

	public static String getName()
    {
        return name;
    }

    public static void setName(String name)
    {
        Global.name = name;
    }

而Spring在注入這些屬性時，反射的Set方法不會對static方法起作用。

所以導(dǎo)致了我們的set方法沒有被調(diào)用。