为什么Spring不推荐使用@Autowired注解?

7,408 阅读5分钟

引言

在实际工作中,使用IDEA开发时,很多码友都喜欢使用@Autowired注解进行依赖注入,这个时候 IDEA 就会报黄色警告,代码一片warning,代码洁癖的我不允许这么一个不明不白的警告在这里。@Autowired作为Spring的亲儿子,为啥在IDEA中提示了这么一个警告?所以,带着我的洁癖,和我的好奇心,开始研究起了这个警告。

我们简单翻译一下自动提示的是啥意思:

不建议直接在字段上进行依赖注入。Spring开发团队建议:在Java Bean中永远使用构造方法进行依赖注入。

带着上面的疑问,我们接着往下看

依赖注入的方式

Spring有三种依赖注入的方式

基于属性(filed)注入

这种注入方式就是在 bean 的变量上使用注解进行依赖注入。本质上是通过反射的方式直接注入到 field 。这是我平常开发中看的最多也是最熟悉的一种方式。比如:

@Autowired
UserService userService;

基于set方法注入

通过对应变量的setXXX()方法以及在方法上面使用注解,来完成依赖注入。比如:

private UserService userService;

@Autowired
public void setUserService(UserService userService) {
    this.userService = userService;
}

说明:在 Spring 4.5 及更高的版本中,setXXX 上面的 @Autowired 注解是可以不写的。

基于构造器注入

将各个必需的依赖全部放在带有注解构造方法的参数中,并在构造方法中完成对应变量的初始化,这种方式,就是基于构造方法的注入。比如:

private final UserService userService;

@Autowired
public UserController(UserService userService) {
    this.userService = userService;
}

属性注入的问题

如你所见,变量(filed)注入的方式是如此的简洁。但实际上他是有一些问题的,具体问题如下:

问题一

@Autowired
private UserService userService;

private String company;

public UserServiceImpl() {
    this.company = userService.getCompany();
}

编译过程不会报错,但是运行之后报NullPointerException

Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [...]: Constructor threw exception; nested exception is java.lang.NullPointerException

Java 在初始化一个类时,是按照静态变量或静态语句块 –> 实例变量或初始化语句块 –> 构造方法 -> @Autowired 的顺序。所以在执行这个类的构造方法时,user对象尚未被注入,它的值还是 null。

问题二

不能有效的指明依赖。相信很多人都遇见过一个 bug,依赖注入的对象为 null,在启动依赖容器时遇到这个问题都是配置的依赖注入少了一个注解什么的。这种方式就过于依赖注入容器了,当没有启动整个依赖容器时,这个类就不能运转,在反射时无法提供这个类需要的依赖。

问题三

依赖注入的核心思想之一就是被容器管理的类不应该依赖被容器管理的依赖,换成白话来说就是如果这个类使用了依赖注入的类,那么这个类摆脱了这几个依赖必须也能正常运行。然而使用变量注入的方式是不能保证这点的。

怎么解决?

我们一般开发需要注入属性的时候都会使用到这三个注解@Autowired@Inject@Resource,这三个注解在 Spring 中也是支持只用的。我们先来看一下这三个注解有啥区别?

@Autowired

@Autowired为 Spring 框架提供的注解,可以理解是 Spring 的亲儿子。这里先给出一个示例代码

public interface IndexService {

    void sayHello();
}

@Service
public class IndexServiceImpl implements IndexService {

    @Override
    public void sayHello() {
        System.out.println("hello, this is IndexServiceImpl");
    }
}

@Service
public class IndexServiceImpl2 implements IndexService {

    @Override
    public void sayHello() {
        System.out.println("hello, this is IndexServiceImpl2");
    }
}

测试方法

@SpringBootTest
public class Stest {

    @Autowired
    // @Qualifier("indexServiceImpl2")
    IndexService indexService;

    @Test
    void gooo() {
        Assertions.assertNotNull(indexService);
        indexService.sayHello();
    }

}

这里说一下匹配 bean 的过程:

  1. 按照type在上下文中查找匹配,查找typeIndexService的 bean。

  2. 如果有多个 bean,则按照name进行匹配

    • 如果有@Qualifier注解,则按照@Qualifier指定的name进行匹配,查找nameindexServiceImpl2的 bean。

    • 如果没有,则按照变量名进行匹配。查找nameindexService的 bean 。

  3. 匹配不到,则报错。@Autowired(required=false),如果设置required为 false (默认为 true ),则注入失败时不会抛出异常。

@Inject

在 Spring 的环境下,@Inject 和 @Autowired 是相同的,因为它们的依赖注入都是使用AutowiredAnnotationBeanPostProcessor这个后置处理器来处理的。

这两个的区别,首先 @Inject 是 Java EE 包里的,在SE环境需要单独引入。另一个区别在于 @Autowired 可以设置 required=false 而 @Inject 并没有这个属性。也有的说 @Inject 是 spring 的干儿子。

@Resource

@Resource 是JSR-250定义的注解。Spring 在 CommonAnnotationBeanPostProcessor 实现了对JSR-250的注解的处理,其中就包括 @Resource。

这个@Resource有 2 个属性nametype。在 spring 中name属性定义为 bean 的名字,type这是 bean 的类型。如果属性上加 @Resource 注解那么他的注入流程是:

  1. 如果同时指定了nametype,则从 Spring 上下文中找到唯一匹配的 bean 进行装配,找不到则抛出异常。

  2. 如果指定了name,则从上下文中查找名称匹配的 bean 进行装配,找不到则抛出异常。

  3. 如果指定了type,则从上下文中找到类型匹配的唯一 bean 进行装配,找不到或是找到多个,都会抛出异常。

  4. 如果既没有指定name,又没有指定type,则默认按照byName方式进行装配;如果没有匹配,按照byType进行装配。

所以我们可以使用@Resource替代@Autowired,当然也可以使用@RequiredArgsConstructor构造器方式注入,这种形式就是Spring推荐使用的构造器方式注入,此种方式是lombok包下的注解,如果使用此种方式,需要项目中引入lombok,例如:

@RequiredArgsConstructor
public class UserDaoImpl {
	private final User user;
}