Spring 注入static屬性值

本文介紹Spring中如何從屬性文件給static字段注入值。實(shí)際應(yīng)用中一些工具類(lèi)中static屬性值需讀取配置文件，實(shí)現(xiàn)該功能可以讓工具類(lèi)提供靜態(tài)方法更易使用。

1. 問(wèn)題

首先在屬性文件中定義屬性：

name = Inject a value to a static field

然后給實(shí)例變量注入值，通常在字段上使用@Value注解：

@Value("${name}")
private String name;

但在static字段上應(yīng)用是，會(huì)發(fā)現(xiàn)其值為null，注入失?。?/p>

@Value("${name}")
private static String NAME_NULL;

這是因?yàn)镾pring不支持在static字段上使用@Value注解。

2. 解決方案

Spring @Value注解可以在方法上使用，在加載所有Spring配置和bean后，Spring上下文將調(diào)用它。方法有多個(gè)參數(shù)，那么每個(gè)參數(shù)值都為方法注解對(duì)應(yīng)的值，如果需要參數(shù)獲取不同的值，可以在參數(shù)上增加注解：

@Value("Test")
public void printValues(String s, String v){} //both 's' and 'v' values will be 'Test' 
@Value("Test")
public void printValues(String s, @Value("Data") String v){}
// s=Test, v=Data

有了上面的知識(shí)，我們可以修改代碼為：

public class PropertyUtils { 
    @Value("${name1}")
    private String name; 
    private static String NAME_STATIC; 
    @Value("${name2}")
    public void setNameStatic(String name){
        PropertyController.NAME_STATIC = name;
    }
}

這回通過(guò)方法成功給static變量NAME_STATIC賦值。

Spring依賴(lài)注入static靜態(tài)變量相關(guān)問(wèn)題

1.Spring不支持依賴(lài)注入static靜態(tài)變量

在springframework里,我們不能@Autowired一個(gè)靜態(tài)變量,使之成為一個(gè)spring bean,例如下面這樣:

@Autowired
private static YourClass yourClass;

可以試一下,yourClass在這種狀態(tài)下不能夠被依賴(lài)注入,會(huì)拋出運(yùn)行時(shí)異常java.lang.NullPointerException,為什么呢?靜態(tài)變量/類(lèi)變量不是對(duì)象的屬性,而是一個(gè)類(lèi)的屬性,spring則是基于對(duì)象層面上的依賴(lài)注入.

而使用靜態(tài)變量/類(lèi)變量擴(kuò)大了靜態(tài)方法的使用范圍.靜態(tài)方法在spring是不推薦使用的.依賴(lài)注入的主要目的,是讓容器去產(chǎn)生一個(gè)對(duì)象的實(shí)例,然后在整個(gè)生命周期中使用他們,同時(shí)也讓testing工作更加容易.

一旦你使用靜態(tài)方法,就不再需要去產(chǎn)生這個(gè)類(lèi)的實(shí)例,這會(huì)讓testing變得更加困難,同時(shí)你也不能為一個(gè)給定的類(lèi),依靠注入方式去產(chǎn)生多個(gè)具有不同的依賴(lài)環(huán)境的實(shí)例.這種static field是隱含共享的,并且是一種global全局狀態(tài),spring同樣不推薦這樣去做.

2.Spring如何給靜態(tài)變量注入值

spring 不允許/不支持把值注入到靜態(tài)變量中，如：

import org.springframework.beans.factory.annotation.Value;  
import org.springframework.stereotype.Component;    
@Component  
public class GlobalValue {    
    @Value("${mongodb.db}")  
    public static String DATABASE;    
}  

如果你獲取GlobalValue.DATABASE，會(huì)得到null

GlobalValue.DATABASE = null

那我們?nèi)绾谓鉀Q這個(gè)問(wèn)題呢。

好在spring支持set方法注入，我們可以利用非靜態(tài)setter 方法注入靜態(tài)變量。如：

import org.springframework.beans.factory.annotation.Value;  
import org.springframework.stereotype.Component;    
@Component  
public class GlobalValue {    
    public static String DATABASE;    
    @Value("${mongodb.db}")  
    public void setDatabase(String db) {  
        DATABASE = db;  
    } 
}  

輸出：

GlobalValue.DATABASE = "mongodb database name"

3.Spring靜態(tài)注入的三種方式

(說(shuō)明：MongoFileOperationUtil是自己封裝的一個(gè)Mongodb文件讀寫(xiě)工具類(lèi)，里面需要依賴(lài)AdvancedDatastore對(duì)象實(shí)例，dsForRW用來(lái)獲取Mongodb數(shù)據(jù)源)

在springframework里，我們不能@Autowired一個(gè)靜態(tài)變量,使之成為一個(gè)spring bean，例如下面這種方式：

@Autowired  
private static AdvancedDatastore dsForRW;  

可以試一下，dsForRW在這種狀態(tài)下不能夠被依賴(lài)注入，會(huì)拋出運(yùn)行時(shí)異常java.lang.NullPointerException，為什么呢?靜態(tài)變量/類(lèi)變量不是對(duì)象的屬性,而是一個(gè)類(lèi)的屬性,spring則是基于對(duì)象層面上的依賴(lài)注入。

但是自己比較喜歡封裝工具類(lèi)，并通過(guò)@Component注解成功能組件，但是功能組件中的方法一般都是靜態(tài)方法，靜態(tài)方法只能調(diào)用靜態(tài)成員變量，于是就有了下面的問(wèn)題。封有的時(shí)候封裝功能組件會(huì)需要底層的service注入，怎么辦呢？

去網(wǎng)上搜了下解決辦法，簡(jiǎn)單總結(jié)一下幾種實(shí)現(xiàn)方式

1.xml方式實(shí)現(xiàn)

<bean id="mongoFileOperationUtil" class="com.*.*.MongoFileOperationUtil" init-method="init">  
    <property name="dsForRW" ref="dsForRW"/>  
</bean> 

public class MongoFileOperationUtil {        
    private static AdvancedDatastore dsForRW;    
    private static MongoFileOperationUtil mongoFileOperationUtil;    
    public void init() {  
        mongoFileOperationUtil = this;  
        mongoFileOperationUtil.dsForRW = this.dsForRW;  
    }    
}

這種方式適合基于XML配置的WEB項(xiàng)目；

2.@PostConstruct方式實(shí)現(xiàn)

import org.mongodb.morphia.AdvancedDatastore;  
import org.springframework.beans.factory.annotation.Autowired;   
@Component  
public class MongoFileOperationUtil {  
    @Autowired  
    private static AdvancedDatastore dsForRW;    
    private static MongoFileOperationUtil mongoFileOperationUtil;    
    @PostConstruct  
    public void init() {  
        mongoFileOperationUtil = this;  
        mongoFileOperationUtil.dsForRW = this.dsForRW;  
    }    
}

@PostConstruct 注解的方法在加載類(lèi)的構(gòu)造函數(shù)之后執(zhí)行，也就是在加載了構(gòu)造函數(shù)之后，執(zhí)行init方法；(@PreDestroy 注解定義容器銷(xiāo)毀之前的所做的操作)

這種方式和在xml中配置 init-method和 destory-method方法差不多，定義spring 容器在初始化bean 和容器銷(xiāo)毀之前的所做的操作；

3.set方法上添加@Autowired注解，類(lèi)定義上添加@Component注解

import org.mongodb.morphia.AdvancedDatastore;  
import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Component;   
@Component  
public class MongoFileOperationUtil {    
    private static AdvancedDatastore dsForRW;        
    @Autowired  
    public void setDatastore(AdvancedDatastore dsForRW) {  
        MongoFileOperationUtil.dsForRW = dsForRW;  
    }  
}  

首先Spring要能掃描到AdvancedDatastore的bean，然后通過(guò)setter方法注入；

然后注意：成員變量上不需要再添加@Autowired注解；

最新評(píng)論