@Autowired的這些新姿勢，你學(xué)會了？
前言
最近review別人代碼的時候，看到了一些@Autowired不一樣的用法，覺得有些意思，特定花時間研究了一下，收獲了不少東西，現(xiàn)在分享給大家。
也許@Autowired比你想象中更強(qiáng)大。
1. @Autowired的默認(rèn)裝配
我們都知道在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() {
- }
- }
沒錯，這樣是能夠裝配成功的，因為默認(rèn)情況下spring是按照類型裝配的，也就是我們所說的byType方式。
此外，@Autowired注解的required參數(shù)默認(rèn)是true，表示開啟自動裝配，有些時候我們不想使用自動裝配功能，可以將該參數(shù)設(shè)置成false。
2. 相同類型的對象不只一個時
上面byType方式主要針對相同類型的對象有且只有一個的情況，此時對象類型是唯一的，可以找到正確的對象。
但如果相同類型的對象不只一個時，會發(fā)生什么?
在項目的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]
結(jié)果報錯了，報類類名稱有沖突，直接導(dǎo)致項目啟動不來。
- 注意，這種情況不是相同類型的對象在Autowired時有兩個導(dǎo)致的，非常容易產(chǎn)生混淆。這種情況是因為spring的@Service方法不允許出現(xiàn)相同的類名，因為spring會將類名的第一個字母轉(zhuǎn)換成小寫，作為bean的名稱，比如：testService1，而默認(rèn)情況下bean名稱必須是唯一的。
下面看看如何產(chǎn)生兩個相同的類型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類中手動創(chuàng)建TestService1實例，并且去掉TestService1類上原有的@Service注解。
重新啟動項目：
果然報錯了，提示testService1是單例的，卻找到兩個對象。
其實還有一個情況會產(chǎn)生兩個相同的類型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是單例的，卻找到兩個對象。
第二種情況在實際的項目中出現(xiàn)得更多一些，后面的例子，我們主要針對第二種情況。
3. @Qualifier和@Primary
顯然在spring中，按照Autowired默認(rèn)的裝配方式：byType，是無法解決上面的問題的，這時可以改用按名稱裝配：byName。
只需在代碼上加上@Qualifier注解即可：
- @Service
- public class UserService {
- @Autowired
- @Qualifier("user1")
- private IUser user;
- }
調(diào)整之后，項目就能正常啟動了。
- 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;
- }
重新啟動項目，一樣能正常運行。
- 當(dāng)我們使用自動配置的方式裝配Bean時，如果這個Bean有多個候選者，假如其中一個候選者具有@Primary注解修飾，該候選者會被選中，作為自動配置的值。
4. @Autowired的使用范圍
上面的實例中@Autowired注解，都是使用在成員變量上，但@Autowired的強(qiáng)大之處，遠(yuǎn)非如此。
先看看@Autowired注解的定義：
從圖中可以看出該注解能夠使用在5種目標(biāo)類型上，下面用一張圖總結(jié)一下：
4.1 成員變量
在成員變量上使用Autowired注解：
- @Service
- public class UserService {
- @Autowired
- private IUser user;
- }
這種方式可能是平時用得最多的。
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注解，實際上還是使用了Autowired裝配方式，并非構(gòu)造器裝配。
4.3 方法
在普通方法上加Autowired注解：
- @Service
- public class UserService {
- @Autowired
- public void test(IUser user) {
- user.say();
- }
- }
spring會在項目啟動的過程中，自動調(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 注解
這種方式其實用得不多，我就不過多介紹了。
5. @Autowired的高端玩法
其實上面舉的例子都是通過@Autowired自動裝配單個實例，但這里我會告訴你，它也能自動裝配多個實例，怎么回事呢?
將UserService方法調(diào)整一下，用一個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);
- }
- }
增加一個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都打印出了兩個元素，說明@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();
- }
- }
這種情況應(yīng)該是最常見的錯誤了，不會因為你長得帥，就不會犯這種低級的錯誤。
6.2 注入Filter或Listener
web應(yīng)用啟動的順序是：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之后執(zhí)行。如果我們想在listener和filter里面@Autowired某個bean，肯定是不行的，因為filter初始化的時候，此時bean還沒有初始化，無法自動裝配。
如果工作當(dāng)中真的需要這樣做，我們該如何解決這個問題呢?
- 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實例。
6.3 注解未被@ComponentScan掃描
通常情況下，@Controller、@Service、@Component、@Repository、@Configuration等注解，是需要通過@ComponentScan注解掃描，收集元數(shù)據(jù)的。
但是，如果沒有加@ComponentScan注解，或者@ComponentScan注解掃描的路徑不對，或者路徑范圍太小，會導(dǎo)致有些注解無法收集，到后面無法使用@Autowired完成自動裝配的功能。
有個好消息是，在springboot項目中，如果使用了@SpringBootApplication注解，它里面內(nèi)置了@ComponentScan注解的功能。
6.4 循環(huán)依賴問題
如果A依賴于B，B依賴于C，C又依賴于A，這樣就形成了一個死循環(huán)。
spring的bean默認(rèn)是單例的，如果單例bean使用@Autowired裝配，大多數(shù)情況，能解決循環(huán)依賴問題。
但是如果bean是多例的，會出現(xiàn)循環(huán)依賴問題，導(dǎo)致bean自動裝配不了。
還有有些情況下，如果創(chuàng)建了代理對象，即使bean是單例的，依然會出現(xiàn)循環(huán)依賴問題。
如果你對循環(huán)依賴問題比較感興趣，也可以看一下我的另一篇專題《spring：我是如何解決循環(huán)依賴的?》，里面介紹的非常詳細(xì)。
7. @Autowired和@Resouce的區(qū)別
@Autowired功能雖說非常強(qiáng)大，但是也有些不足之處。比如：比如它跟spring強(qiáng)耦合了，如果換成了JFinal等其他框架，功能就會失效。而@Resource是JSR-250提供的，它是Java標(biāo)準(zhǔn)，絕大部分框架都支持。
除此之外，有些場景使用@Autowired無法滿足的要求，改成@Resource卻能解決問題。接下來，我們重點看看@Autowired和@Resource的區(qū)別。
@Autowired默認(rèn)按byType自動裝配，而@Resource默認(rèn)byName自動裝配。
@Autowired只包含一個參數(shù)：required，表示是否開啟自動準(zhǔn)入，默認(rèn)是true。而@Resource包含七個參數(shù)，其中最重要的兩個參數(shù)是：name 和 type。
@Autowired如果要使用byName，需要使用@Qualifier一起配合。而@Resource如果指定了name，則用byName自動裝配，如果指定了type，則用byType自動裝配。
@Autowired能夠用在：構(gòu)造器、方法、參數(shù)、成員變量和注解上，而@Resource能用在：類、成員變量和方法上。
@Autowired是spring定義的注解，而@Resource是JSR-250定義的注解。
此外，它們的裝配順序不同。
@Autowired的裝配順序如下：
@Resource的裝配順序如下：
如果同時指定了name和type：
如果指定了name：
如果指定了type：
如果既沒有指定name，也沒有指定type：
后記
我原本打算接下來寫@Autowired原理分析和源碼解讀的，但是由于篇幅太長了，不適合放在一起，后面打算開個專題。如果有興趣的朋友，可以持續(xù)關(guān)注我后續(xù)的文章，相信你讀完必定會有些收獲。
本文轉(zhuǎn)載自微信公眾號「蘇三說技術(shù)」，可以通過以下二維碼關(guān)注。轉(zhuǎn)載本文請聯(lián)系蘇三說技術(shù)公眾號。
