Spring使用@Autowired註解靜態實例對象方式

Posted on by

Spring @Autowired註解靜態實例對象

問題

最近項目小組在重新規劃工程的業務緩存，其中涉及到部分代碼重構，過程中發現有些工具類中的靜態方法需要依賴別的對象實例（該實例已配置在xml成Spring bean，非靜態可以用@Autowired加載正常使用），而我們知道，類加載後靜態成員是在內存的共享區，靜態方法裡面的變量必然要使用靜態成員變量，這就有瞭如下代碼：

@Component
public class TestClass {
    @Autowired
    private static AutowiredTypeComponent component;
    // 調用靜態組件的方法
    public static void testMethod() {
        component.callTestMethod()；
    }
}

編譯正常，但運行時報java.lang.NullPointerException: null異常，顯然在調用testMethod()方法時，component變量還沒被初始化，報NPE。

原因

所以，在Springframework裡，我們是不能@Autowired一個靜態變量，使之成為一個Spring bean的。為什麼？其實很簡單，因為當類加載器加載靜態變量時，Spring上下文尚未加載。所以類加載器不會在bean中正確註入靜態類，並且會失敗。

解決方案

方式一

將@Autowired 註解到類的構造函數上。很好理解，Spring掃描到AutowiredTypeComponent的bean，然後賦給靜態變量component。示例如下：

@Component
public class TestClass {
    private static AutowiredTypeComponent component;
    @Autowired
    public TestClass(AutowiredTypeComponent component) {
        TestClass.component = component;
    }
    // 調用靜態組件的方法
    public static void testMethod() {
        component.callTestMethod()；
    }
}

方式二

給靜態組件加setter方法，並在這個方法上加上@Autowired。Spring能掃描到AutowiredTypeComponent的bean，然後通過setter方法註入。示例如下：

@Component
public class TestClass {
    private static AutowiredTypeComponent component;
    @Autowired
    public void setComponent(AutowiredTypeComponent component){
        TestClass.component = component;
    }
    // 調用靜態組件的方法
    public static void testMethod() {
        component.callTestMethod()；
    }
}

方式三

定義一個靜態組件，定義一個非靜態組件並加上@Autowired註解，再定義一個初始化組件的方法並加上@PostConstruct註解。這個註解是JavaEE引入的，作用於servlet生命周期的註解，你隻需要知道，用它註解的方法在構造函數之後就會被調用。示例如下：

@Component
public class TestClass {
   private static AutowiredTypeComponent component;
   @Autowired
   private AutowiredTypeComponent autowiredComponent;
   @PostConstruct
   private void beforeInit() {
      component = this.autowiredComponent;
   }
   // 調用靜態組件的方法
   public static void testMethod() {
      component.callTestMethod();
   }
}

方式四

直接用Spring框架工具類獲取bean，定義成局部變量使用。但有弊端：如果該類中有多個靜態方法多次用到這個組件則每次都要這樣獲取，個人不推薦這種方式。示例如下：

public class TestClass {
    // 調用靜態組件的方法
   public static void testMethod() {
      AutowiredTypeComponent component = SpringApplicationContextUtil.getBean("component");
      component.callTestMethod();
   }
}

總結

在上面的代碼示例中，我每個類都加瞭@Component註解，其實可以根據需要進行變更，比如這個類是處理業務邏輯，可以換成@Service；這個類是處理請求進行轉發或重定向的，可以換成@Controller（是Spring-mvc的註解）；這個類是專門用來操作Dao的就@Repository。

Spring的註解幫你做瞭一件很有意義的事：就是它們對應用進行瞭分層，這樣就能將請求處理、業務邏輯處理、數據庫操作處理分離出來，為代碼解耦，也方便瞭項目的開發和維護。

Spring容器bean加載機制用到瞭Java的反射，這裡先不作贅述，以後會專門寫一篇文章來總結Java反射在Spring的IoC和AoP中的應用。

@Autowired註解和靜態方法

一、業務場景

spring框架應用中有些靜態方法需要依賴被容器管理的類，就像這樣：

@Component
public class Test {    
    @Autowired
    private static UserService userService;    
    public static void test() {
        userService.test();
    }
}

這樣一定會報java.lang.NullPointerException: null異常。

二、原理剖析

靜態變量、類變量不是對象的屬性，而是一個類的屬性，所以靜態方法是屬於類（class）的，普通方法才是屬於實體對象（也就是New出來的對象）的，spring註入是在容器中實例化對象，所以不能使用靜態方法。

而使用靜態變量、類變量擴大瞭靜態方法的使用范圍。靜態方法在spring是不推薦使用的，依賴註入的主要目的,是讓容器去產生一個對象的實例,然後在整個生命周期中使用他們，同時也讓testing工作更加容易。

一旦你使用靜態方法,就不再需要去產生這個類的實例,這會讓testing變得更加困難，同時你也不能為一個給定的類，依靠註入方式去產生多個具有不同的依賴環境的實例，這種static field是隱含共享的，並且是一種global全局狀態，spring同樣不推薦這樣去做。

三、解決方法

1、將@Autowire加到構造方法上

@Component
public class Test {    
    private static UserService userService;    
    @Autowired
    public Test(UserService userService) {
        Test.userService = userService;
    }
}

2、用@PostConstruct註解

@Component
public class Test {    
    private static UserService userService;    
    @Autowired
    private UserService userService2;    
    @PostConstruct
    public void beforeInit() {
        userService = userService2;
    }    
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：