1. 程式人生 > 其它 >@Autowired和@Resource的區別

@Autowired和@Resource的區別

https://www.zhihu.com/question/39356740

1. @Autowired的預設裝配

我們都知道在spring中@Autowired註解,是用來自動裝配物件的。通常,我們在專案中是這樣用的:

package com.sue.cache.service;

import org.springframework.stereotype.Service;

@Service
public class TestService1 {
    public void test1() {
    }
}

package com.sue.cache.service;

import org.springframework.stereotype.Service;

@Service
public class TestService2 { @Autowired private TestService1 testService1; public void test2() { } }

沒錯,這樣是能夠裝配成功的,因為預設情況下spring是按照型別裝配的,也就是我們所說的byType方式。

此外,@Autowired註解的required引數預設是true,表示開啟自動裝配,有些時候我們不想使用自動裝配功能,可以將該引數設定成false。


2. 相同型別的物件不只一個時

上面byType方式主要針對相同型別的物件只有一個的情況,此時物件型別是唯一的,可以找到正確的物件。

但如果相同型別的物件不只一個時,會發生什麼?

在專案的test目錄下,建了一個同名的類TestService1:

package com.sue.cache.service.test;

import org.springframework.stereotype.Service;

@Service
public class TestService1 {

    public void test1() {
    }
}
重新啟動專案時: Caused by: org.springframework.context.annotation.ConflictingBeanDefinitionException: Annotation-specified bean name 'testService1' for bean class [com.sue.cache.service.test.TestService1] conflicts with existing, non-compatible bean definition of same name and class [com.sue.cache.service.TestService1]

結果報錯了,報類類名稱有衝突,直接導致專案啟動不來。

注意,這種情況不是相同型別的物件在Autowired時有兩個導致的,非常容易產生混淆。這種情況是因為spring的@Service方法不允許出現相同的類名,因為spring會將類名的第一個字母轉換成小寫,作為bean的名稱,比如:testService1,而預設情況下bean名稱必須是唯一的。

下面看看如何產生兩個相同的型別bean:

public class TestService1 {

    public void test1() {
    }
}

@Service
public class TestService2 {

    @Autowired
    private TestService1 testService1;

    public void test2() {
    }
}

@Configuration
public class TestConfig {

    @Bean("test1")
    public TestService1 test1() {
        return new TestService1();
    }

    @Bean("test2")
    public TestService1 test2() {
        return new TestService1();
    }
}

在TestConfig類中手動建立TestService1例項,並且去掉TestService1類上原有的@Service註解。

重新啟動專案:

果然報錯了,提示testService1是單例的,卻找到兩個物件。

其實還有一個情況會產生兩個相同的型別bean:

public interface IUser {
    void say();
}

@Service
public class User1 implements IUser{
    @Override
    public void say() {
    }
}

@Service
public class User2 implements IUser{
    @Override
    public void say() {
    }
}

@Service
public class UserService {

    @Autowired
    private IUser user;
}

專案重新啟動時:

報錯了,提示跟上面一樣,testService1是單例的,卻找到兩個物件。

第二種情況在實際的專案中出現得更多一些,後面的例子,我們主要針對第二種情況。

3. @Qualifier和@Primary

顯然在spring中,按照Autowired預設的裝配方式:byType,是無法解決上面的問題的,這時可以改用按名稱裝配:byName。

只需在程式碼上加上@Qualifier註解即可:

@Service
public class UserService {

    @Autowired
    @Qualifier("user1")
    private IUser user;
}

只需這樣調整之後,專案就能正常啟動了。

Qualifier意思是合格者,一般跟Autowired配合使用,需要指定一個bean的名稱,通過bean名稱就能找到需要裝配的bean。

除了上面的@Qualifier註解之外,還能使用@Primary註解解決上面的問題。在User1上面加上@Primary註解:

@Primary
@Service
public class User1 implements IUser{
    @Override
    public void say() {
    }
}

去掉UserService上的@Qualifier註解:

@Service
public class UserService {

    @Autowired
    private IUser user;
}

重新啟動專案,一樣能正常執行。

當我們使用自動配置的方式裝配Bean時,如果這個Bean有多個候選者,假如其中一個候選者具有@Primary註解修飾,該候選者會被選中,作為自動配置的值。

4. @Autowired的使用範圍

上面的例項中@Autowired註解,都是使用在成員變數上,但@Autowired的強大之處,遠非如此。

先看看@Autowired註解的定義:


從圖中可以看出該註解能夠使用在5種目標型別上,下面用一張圖總結一下:

該註解我們平常使用最多的地方可能是在成員變數上。

接下來,我們重點看看在其他地方該怎麼用?

4.1 成員變數

在成員變數上使用Autowired註解:

@Service
public class UserService {

    @Autowired
    private IUser user;
}

這種方式可能是平時用得最多的。


作者:蘇三說技術
連結:https://www.zhihu.com/question/39356740/answer/1907479772
來源:知乎
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。

4.2 構造器

在構造器上使用Autowired註解:

@Service
public class UserService {

    private IUser user;

    @Autowired
    public UserService(IUser user) {
        this.user = user;
        System.out.println("user:" + user);
    }
}
注意,在構造器上加Autowired註解,實際上還是使用了Autowired裝配方式,並非構造器裝配。

4.3 方法

在普通方法上加Autowired註解:

@Service
public class UserService {

    @Autowired
    public void test(IUser user) {
       user.say();
    }
}

spring會在專案啟動的過程中,自動呼叫一次加了@Autowired註解的方法,我們可以在該方法做一些初始化的工作。

也可以在setter方法上Autowired註解:

@Service
public class UserService {

    private IUser user;

    @Autowired
    public void setUser(IUser user) {
        this.user = user;
    }
}

4.4 引數

可以在構造器的入參上加Autowired註解:

@Service
public class UserService {

    private IUser user;

    public UserService(@Autowired IUser user) {
        this.user = user;
        System.out.println("user:" + user);
    }
}

也可以在非靜態方法的入參上加Autowired註解:

@Service
public class UserService {

    public void test(@Autowired IUser user) {
       user.say();
    }
}

4.5 註解

這種方式其實用得不多,我就不過多介紹了。

5. @Autowired的高階玩法

其實上面舉的例子都是通過@Autowired自動裝配單個例項,但這裡我會告訴你,它也能自動裝配多個例項,怎麼回事呢?

將UserService方法調整一下,用一個List集合接收IUser型別的引數:

@Service
public class UserService {

    @Autowired
    private List<IUser> userList;

    @Autowired
    private Set<IUser> userSet;

    @Autowired
    private Map<String, IUser> userMap;

    public void test() {
        System.out.println("userList:" + userList);
        System.out.println("userSet:" + userSet);
        System.out.println("userMap:" + userMap);
    }
}

增加一個controller:

@RequestMapping("/u")
@RestController
public class UController {

    @Autowired
    private UserService userService;

    @RequestMapping("/test")
    public String test() {
        userService.test();
        return "success";
    }
}

呼叫該介面後:

從上圖中看出:userList、userSet和userMap都打印出了兩個元素,說明@Autowired會自動把相同型別的IUser物件收集到集合中。

意不意外,驚不驚喜?

6. @Autowired一定能裝配成功?

前面介紹了@Autowired註解這麼多牛逼之處,其實有些情況下,即使使用了@Autowired裝配的物件還是null,到底是什麼原因呢?

6.1 沒有加@Service註解

在類上面忘了加@Controller、@Service、@Component、@Repository等註解,spring就無法完成自動裝配的功能,例如:

public class UserService {

    @Autowired
    private IUser user;

    public void test() {
        user.say();
    }
}

這種情況應該是最常見的錯誤了,不會因為你長得帥,就不會犯這種低階的錯誤。

作者:蘇三說技術
連結:https://www.zhihu.com/question/39356740/answer/1907479772
來源:知乎
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。

6.2 注入Filter或Listener

web應用啟動的順序是:listener->filter->servlet

接下來看看這個案例:

public class UserFilter implements Filter {

    @Autowired
    private IUser user;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        user.say();
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

    }

    @Override
    public void destroy() {
    }
}

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean filterRegistrationBean() {
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new UserFilter());
        bean.addUrlPatterns("/*");
        return bean;
    }
}

程式啟動會報錯:

tomcat無法正常啟動。

什麼原因呢?

眾所周知,springmvc的啟動是在DisptachServlet裡面做的,而它是在listener和filter之後執行。如果我們想在listener和filter裡面@Autowired某個bean,肯定是不行的,因為filter初始化的時候,此時bean還沒有初始化,無法自動裝配。

如果工作當中真的需要這樣做,我們該如何解決這個問題呢?

public class UserFilter  implements Filter {

    private IUser user;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        ApplicationContext applicationContext = WebApplicationContextUtils.getWebApplicationContext(filterConfig.getServletContext());
        this.user = ((IUser)(applicationContext.getBean("user1")));
        user.say();
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

    }

    @Override
    public void destroy() {

    }
}

答案是使用WebApplicationContextUtils.getWebApplicationContext獲取當前的ApplicationContext,再通過它獲取到bean例項。

6.3 註解未被@ComponentScan掃描

通常情況下,@Controller、@Service、@Component、@Repository、@Configuration等註解,是需要通過@ComponentScan註解掃描,收集元資料的。

但是,如果沒有加@ComponentScan註解,或者@ComponentScan註解掃描的路徑不對,或者路徑範圍太小,會導致有些註解無法收集,到後面無法使用@Autowired完成自動裝配的功能。

有個好訊息是,在springboot專案中,如果使用了@SpringBootApplication註解,它裡面內建了@ComponentScan註解的功能。

6.4 迴圈依賴問題

如果A依賴於B,B依賴於C,C又依賴於A,這樣就形成了一個死迴圈。

spring的bean預設是單例的,如果單例bean使用@Autowired自動裝配,大多數情況,能解決迴圈依賴問題。

但是如果bean是多例的,會出現迴圈依賴問題,導致bean自動裝配不了。

還有有些情況下,如果建立了代理物件,即使bean是單例的,依然會出現迴圈依賴問題。

如果你對迴圈依賴問題比較感興趣,也可以看一下我的另一篇專題《》,裡面介紹的非常詳細。

7. @Autowired和@Resouce的區別

@Autowired功能雖說非常強大,但是也有些不足之處。比如:比如它跟spring強耦合了,如果換成了JFinal等其他框架,功能就會失效。而@Resource是JSR-250提供的,它是Java標準,絕大部分框架都支援。

除此之外,有些場景使用@Autowired無法滿足的要求,改成@Resource卻能解決問題。接下來,我們重點看看@Autowired和@Resource的區別。

  • @Autowired預設按byType自動裝配,而@Resource預設byName自動裝配。
  • @Autowired只包含一個引數:required,表示是否開啟自動准入,預設是true。而@Resource包含七個引數,其中最重要的兩個引數是:name 和 type。
  • @Autowired如果要使用byName,需要使用@Qualifier一起配合。而@Resource如果指定了name,則用byName自動裝配,如果指定了type,則用byType自動裝配。
  • @Autowired能夠用在:構造器、方法、引數、成員變數和註解上,而@Resource能用在:類、成員變數和方法上。
  • @Autowired是spring定義的註解,而@Resource是JSR-250定義的註解。

此外,它們的裝配順序不同。

@Autowired的裝配順序如下:

@Resource的裝配順序如下:

  1. 如果同時指定了name和type:

  1. 如果指定了name:

  1. 如果指定了type:

  1. 如果既沒有指定name,也沒有指定type:

其他人員進一步說明:正確性?

@Autowired註解是按型別裝配依賴物件,預設情況下它要求依賴物件必須存在,如果允許null值,可以設定它required屬性為false。

@Resource註解和@Autowired一樣,也可以標註在欄位或屬性的setter方法上,但它預設按名稱裝配。名稱可以通過@Resource的name屬性指定,如果沒有指定name屬性,當註解標註在欄位上,即預設取欄位的名稱作為bean名稱尋找依賴物件,當註解標註在屬性的setter方法上,即預設取屬性名作為bean名稱尋找依賴物件。

@Resources按名字,是JDK的,@Autowired按型別,是Spring的。


作者:秦子軒
連結:https://www.zhihu.com/question/39356740/answer/1297401530
來源:知乎
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。

(1)處理這2個註解的BeanPostProcessor不一樣

CommonAnnotationBeanPostProcessor是處理@ReSource註解的

AutoWiredAnnotationBeanPostProcessor是處理@AutoWired註解的

(2)@Autowired只按照byType 注入;@Resource預設按byName自動注入,也提供按照byType 注入;

(3)屬性:@Autowired按型別裝配依賴物件,預設情況下它要求依賴物件必須存在,如果允許null值,可以設定它required屬性為false。如果我們想使用按名稱裝配,可以結合@Qualifier註解一起使用。@Resource有兩個中重要的屬性:name和type。name屬性指定byName,如果沒有指定name屬性,當註解標註在欄位上,即預設取欄位的名稱作為bean名稱尋找依賴物件,當註解標註在屬性的setter方法上,即預設取屬性名作為bean名稱尋找依賴物件。需要注意的是,@Resource如果沒有指定name屬性,並且按照預設的名稱仍然找不到依賴物件時, @Resource註解會回退到按型別裝配。但一旦指定了name屬性,就只能按名稱裝配了。

@Resource裝配順序

  1. 如果同時指定了name和type,則從Spring上下文中找到唯一匹配的bean進行裝配,找不到則丟擲異常

  2. 如果指定了name,則從上下文中查詢名稱(id)匹配的bean進行裝配,找不到則丟擲異常

  3. 如果指定了type,則從上下文中找到型別匹配的唯一bean進行裝配,找不到或者找到多個,都會丟擲異常

  4. 如果既沒有指定name,又沒有指定type,則自動按照byName方式進行裝配;如果沒有匹配,則回退為一個原始型別進行匹配,如果匹配則自動裝配;

推薦使用@Resource註解在欄位上,這樣就不用寫setter方法了.並且這個註解是屬於J2EE的,減少了與Spring的耦合,這樣程式碼看起就比較優雅 。

Autowired預設使用byType,如果存在多個結果,則會使用byName,可通過Qualifier指定name;

Resouce有name和type屬性,分別對應byName和byType方式,如果屬性不賦值則預設使用byName,查詢不到會回退到原始型別,根據byType進行查詢




@Autowired applies to fields, constructors, and multi-argument methods,@Resource is supported only for fields and bean property setter methods with a single argument. As a consequence, stick with qualifiers if your injection target is a constructor or a multi-argument method.

If you intend to express annotation-driven injection by name, do not primarily use @Autowired, even if is technically capable of referring to a bean name through @Qualifier values. Instead, use the JSR-250 @Resource annotation, which is semantically defined to identify a specific target component by its unique name, with the declared type being irrelevant for the matching process.

As a specific consequence of this semantic difference, beans that are themselves defined as a collection or map type cannot be injected through@Autowired, because type matching is not properly applicable to them. Use @Resource for such beans, referring to the specific collection or map bean by unique name.