@Autowired的這些騷操作，你都知道嗎？

前言

最近review別人代碼的時(shí)候，看到了一些@Autowired不一樣的用法，覺得有些意思，特定花時(shí)間研究了一下，收獲了不少東西，現(xiàn)在分享給大家。

也許@Autowired比你想象中更強(qiáng)大。

1. @Autowired的默認(rèn)裝配

我們都知道在spring中@Autowired注解，是用來自動(dòng)裝配對(duì)象的。通常，我們?cè)陧?xiàng)目中是這樣用的：

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() {
    }
}

沒錯(cuò)，這樣是能夠裝配成功的，因?yàn)槟J(rèn)情況下spring是按照類型裝配的，也就是我們所說的byType方式。

此外，@Autowired注解的required參數(shù)默認(rèn)是true，表示開啟自動(dòng)裝配，有些時(shí)候我們不想使用自動(dòng)裝配功能，可以將該參數(shù)設(shè)置成false。

2. 相同類型的對(duì)象不只一個(gè)時(shí)

上面byType方式主要針對(duì)相同類型的對(duì)象只有一個(gè)的情況，此時(shí)對(duì)象類型是唯一的，可以找到正確的對(duì)象。

但如果相同類型的對(duì)象不只一個(gè)時(shí)，會(huì)發(fā)生什么？

在項(xiàng)目的test目錄下，建了一個(gè)同名的類TestService1：

package com.sue.cache.service.test;

import org.springframework.stereotype.Service;

@Service
public class TestService1 {

    public void test1() {
    }
}

重新啟動(dòng)項(xiàng)目時(shí)：

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]

結(jié)果報(bào)錯(cuò)了，報(bào)類類名稱有沖突，直接導(dǎo)致項(xiàng)目啟動(dòng)不來。

注意，這種情況不是相同類型的對(duì)象在Autowired時(shí)有兩個(gè)導(dǎo)致的，非常容易產(chǎn)生混淆。這種情況是因?yàn)閟pring的@Service方法不允許出現(xiàn)相同的類名，因?yàn)閟pring會(huì)將類名的第一個(gè)字母轉(zhuǎn)換成小寫，作為bean的名稱，比如：testService1，而默認(rèn)情況下bean名稱必須是唯一的。

下面看看如何產(chǎn)生兩個(gè)相同的類型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類中手動(dòng)創(chuàng)建TestService1實(shí)例，并且去掉TestService1類上原有的@Service注解。

重新啟動(dòng)項(xiàng)目：果然報(bào)錯(cuò)了，提示testService1是單例的，卻找到兩個(gè)對(duì)象。

其實(shí)還有一個(gè)情況會(huì)產(chǎn)生兩個(gè)相同的類型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;
}

項(xiàng)目重新啟動(dòng)時(shí)：

報(bào)錯(cuò)了，提示跟上面一樣，testService1是單例的，卻找到兩個(gè)對(duì)象。

第二種情況在實(shí)際的項(xiàng)目中出現(xiàn)得更多一些，后面的例子，我們主要針對(duì)第二種情況。

3. @Qualifier和@Primary

顯然在spring中，按照Autowired默認(rèn)的裝配方式：byType，是無法解決上面的問題的，這時(shí)可以改用按名稱裝配：byName。

只需在代碼上加上@Qualifier注解即可：

@Service
public class UserService {

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

只需這樣調(diào)整之后，項(xiàng)目就能正常啟動(dòng)了。

Qualifier意思是合格者，一般跟Autowired配合使用，需要指定一個(gè)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;
}

重新啟動(dòng)項(xiàng)目，一樣能正常運(yùn)行。

當(dāng)我們使用自動(dòng)配置的方式裝配Bean時(shí)，如果這個(gè)Bean有多個(gè)候選者，假如其中一個(gè)候選者具有@Primary注解修飾，該候選者會(huì)被選中，作為自動(dòng)配置的值。

4. @Autowired的使用范圍

上面的實(shí)例中@Autowired注解，都是使用在成員變量上，但@Autowired的強(qiáng)大之處，遠(yuǎn)非如此。

先看看@Autowired注解的定義：

從圖中可以看出該注解能夠使用在5種目標(biāo)類型上，下面用一張圖總結(jié)一下：

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

接下來，我們重點(diǎn)看看在其他地方該怎么用？

4.1 成員變量

在成員變量上使用Autowired注解：

@Service
public class UserService {

    @Autowired
    private IUser user;
}

這種方式可能是平時(shí)用得最多的。

4.2 構(gòu)造器

在構(gòu)造器上使用Autowired注解：

@Service
public class UserService {

    private IUser user;

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

注意，在構(gòu)造器上加Autowired注解，實(shí)際上還是使用了Autowired裝配方式，并非構(gòu)造器裝配。

4.3 方法

在普通方法上加Autowired注解：

@Service
public class UserService {

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

spring會(huì)在項(xiàng)目啟動(dòng)的過程中，自動(dòng)調(diào)用一次加了@Autowired注解的方法，我們可以在該方法做一些初始化的工作。

也可以在setter方法上Autowired注解：

@Service
public class UserService {

    private IUser user;

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

4.4 參數(shù)

可以在構(gòu)造器的入?yún)⑸霞覣utowired注解：

@Service
public class UserService {

    private IUser user;

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

也可以在非靜態(tài)方法的入?yún)⑸霞覣utowired注解：

@Service
public class UserService {

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

4.5 注解

這種方式其實(shí)用得不多，我就不過多介紹了。

5. @Autowired的高端玩法

其實(shí)上面舉的例子都是通過@Autowired自動(dòng)裝配單個(gè)實(shí)例，但這里我會(huì)告訴你，它也能自動(dòng)裝配多個(gè)實(shí)例，怎么回事呢？

將UserService方法調(diào)整一下，用一個(gè)List集合接收IUser類型的參數(shù)：

@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);
    }
}

增加一個(gè)controller：

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

    @Autowired
    private UserService userService;

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

調(diào)用該接口后：

從上圖中看出：userList、userSet和userMap都打印出了兩個(gè)元素，說明@Autowired會(huì)自動(dòng)把相同類型的IUser對(duì)象收集到集合中。

意不意外，驚不驚喜？

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

前面介紹了@Autowired注解這么多牛逼之處，其實(shí)有些情況下，即使使用了@Autowired裝配的對(duì)象還是null，到底是什么原因呢？

6.1 沒有加@Service注解

在類上面忘了加@Controller、@Service、@Component、@Repository等注解，spring就無法完成自動(dòng)裝配的功能，例如：

public class UserService {

    @Autowired
    private IUser user;

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

這種情況應(yīng)該是最常見的錯(cuò)誤了，不會(huì)因?yàn)槟汩L(zhǎng)得帥，就不會(huì)犯這種低級(jí)的錯(cuò)誤。

6.2 注入Filter或Listener

web應(yīng)用啟動(dòng)的順序是：listener->filter->servlet。

接下來看看這個(gè)案例：

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;
    }
}

程序啟動(dòng)會(huì)報(bào)錯(cuò)：

tomcat無法正常啟動(dòng)。

什么原因呢？

眾所周知，springmvc的啟動(dòng)是在DisptachServlet里面做的，而它是在listener和filter之后執(zhí)行。如果我們想在listener和filter里面@Autowired某個(gè)bean，肯定是不行的，因?yàn)閒ilter初始化的時(shí)候，此時(shí)bean還沒有初始化，無法自動(dòng)裝配。

如果工作當(dāng)中真的需要這樣做，我們?cè)撊绾谓鉀Q這個(gè)問題呢？

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獲取當(dāng)前的ApplicationContext，再通過它獲取到bean實(shí)例。

6.3 注解未被@ComponentScan掃描

通常情況下，@Controller、@Service、@Component、@Repository、@Configuration等注解，是需要通過@ComponentScan注解掃描，收集元數(shù)據(jù)的。

但是，如果沒有加@ComponentScan注解，或者@ComponentScan注解掃描的路徑不對(duì)，或者路徑范圍太小，會(huì)導(dǎo)致有些注解無法收集，到后面無法使用@Autowired完成自動(dòng)裝配的功能。

有個(gè)好消息是，在springboot項(xiàng)目中，如果使用了@SpringBootApplication注解，它里面內(nèi)置了@ComponentScan注解的功能。

6.4 循環(huán)依賴問題

如果A依賴于B，B依賴于C，C又依賴于A，這樣就形成了一個(gè)死循環(huán)。

spring的bean默認(rèn)是單例的，如果單例bean使用@Autowired自動(dòng)裝配，大多數(shù)情況，能解決循環(huán)依賴問題。

但是如果bean是多例的，會(huì)出現(xiàn)循環(huán)依賴問題，導(dǎo)致bean自動(dòng)裝配不了。

還有有些情況下，如果創(chuàng)建了代理對(duì)象，即使bean是單例的，依然會(huì)出現(xiàn)循環(huán)依賴問題。

如果你對(duì)循環(huán)依賴問題比較感興趣，也可以看一下我的另一篇專題《》，里面介紹的非常詳細(xì)。

7. @Autowired和@Resouce的區(qū)別

@Autowired功能雖說非常強(qiáng)大，但是也有些不足之處。比如：比如它跟spring強(qiáng)耦合了，如果換成了JFinal等其他框架，功能就會(huì)失效。而@Resource是JSR-250提供的，它是Java標(biāo)準(zhǔn)，絕大部分框架都支持。

除此之外，有些場(chǎng)景使用@Autowired無法滿足的要求，改成@Resource卻能解決問題。接下來，我們重點(diǎn)看看@Autowired和@Resource的區(qū)別。

• @Autowired默認(rèn)按byType自動(dòng)裝配，而@Resource默認(rèn)byName自動(dòng)裝配。
• @Autowired只包含一個(gè)參數(shù)：required，表示是否開啟自動(dòng)準(zhǔn)入，默認(rèn)是true。而@Resource包含七個(gè)參數(shù)，其中最重要的兩個(gè)參數(shù)是：name 和 type。
• @Autowired如果要使用byName，需要使用@Qualifier一起配合。而@Resource如果指定了name，則用byName自動(dòng)裝配，如果指定了type，則用byType自動(dòng)裝配。
• @Autowired能夠用在：構(gòu)造器、方法、參數(shù)、成員變量和注解上，而@Resource能用在：類、成員變量和方法上。
• @Autowired是spring定義的注解，而@Resource是JSR-250定義的注解。

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

@Autowired的裝配順序如下：

@Resource的裝配順序如下：

1. 如果同時(shí)指定了name和type：

2. 如果指定了name：

3. 如果指定了type：

4. 如果既沒有指定name，也沒有指定type：

后記

我原本打算接下來寫@Autowired原理分析和源碼解讀的，但是由于篇幅太長(zhǎng)了，不適合放在一起，后面打算開個(gè)專題。如果有興趣的朋友，可以持續(xù)關(guān)注我后續(xù)的文章，相信你讀完必定會(huì)有些收獲。