Spring 依赖注入方式及@Autowired 和 @Resource

ximeneschen

已于 2023-07-09 22:32:55 修改

阅读量1.8k

点赞数 5

分类专栏： SpringBoot Spring 文章标签： spring java

于 2022-08-31 11:25:27 首次发布

原文链接：https://juejin.cn/post/7137090639887335437

版权

SpringBoot 同时被 2 个专栏收录

55 篇文章

订阅专栏

Spring

50 篇文章

订阅专栏

一、Spring 依赖注入方式

在 Spring 中实现依赖注入的常见方式有以下 3 种：

属性注入（Field Injection）
Setter 注入（Setter Injection）
构造方法注入（Constructor Injection）

它们的具体使用和优缺点分析如下。

属性注入：属性注入是我们最熟悉，也是日常开发中使用最多的一种注入方式，它的实现代码如下：

@RestController
public class UserController {
    // 属性对象
    @Autowired
    private UserService userService;

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

优点分析

属性注入最大的优点就是实现简单、使用简单，只需要给变量上添加一个注解（@Autowired），就可以在不 new 对象的情况下，直接获得注入的对象了（这就是 DI 的功能和魅力所在），所以它的优点就是使用简单。

缺点分析

然而，属性注入虽然使用简单，但也存在着很多问题，甚至编译器 Idea 都会提醒你“不建议使用此注入方式”，Idea 的提示信息如下：

在这里插入图片描述

属性注入的缺点主要包含以下 3 个：

功能性问题：无法注入一个不可变的对象（final 修饰的对象）
通用性问题：只能适应于 IoC 容器
设计原则问题：更容易违背单一设计原则

接下来我们一一来看。

缺点1：功能性问题

使用属性注入无法注入一个不可变的对象（final 修饰的对象），如下图所示：
在这里插入图片描述

原因也很简单：在 Java 中 final 对象（不可变）要么直接赋值，要么在构造方法中赋值，所以当使用属性注入 final 对象时，它不符合 Java 中 final 的使用规范，所以就不能注入成功了。

PS：如果要注入一个不可变的对象，要怎么实现呢？使用下面的构造方法注入即可。

缺点2：通用性问题
使用属性注入的方式只适用于 IoC 框架（容器），如果将属性注入的代码移植到其他非 IoC 的框架中，那么代码就无效了，所以属性注入的通用性不是很好。
缺点3：设计原则问题
使用属性注入的方式，因为使用起来很简单，所以开发者很容易在一个类中同时注入多个对象，而这些对象的注入是否有必要？是否符合程序设计中的单一职责原则？就变成了一个问题。但可以肯定的是，注入实现越简单，那么滥用它的概率也越大，所以出现违背单一职责原则的概率也越大。
注意：这里强调的是违背设计原则（单一职责）的可能性，而不是一定会违背设计原则，二者有着本质的区别。

Setter 注入

Setter 注入的实现代码如下：

@RestController
public class UserController {
    // Setter 注入
    private UserService userService;

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

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

优缺点分析

从上面代码可以看出，Setter 注入比属性注入要麻烦很多。要说 Setter 注入有什么优点的话，那么首当其冲的就是它完全符合单一职责的设计原则，因为每一个 Setter 只针对一个对象。但它的缺点也很明显，它的缺点主要体现在以下 2 点：

不能注入不可变对象（final 修饰的对象）；
注入的对象可被修改。

接下来我们一一来看。

缺点1：不能注入不可变对象

使用 Setter 注入依然不能注入不可变对象，比如以下注入会报错：
在这里插入图片描述

缺点2：注入对象可被修改

Setter 注入提供了 setXXX 的方法，意味着你可以在任何时候、在任何地方，通过调用 setXXX 的方法来改变注入对象，所以 Setter 注入的问题是，被注入的对象可能随时被修改。

构造方法注入

构造方法注入是 Spring 官方从 4.x 之后推荐的注入方式，它的实现代码如下：

@RestController
public class UserController {
    // 构造方法注入
    private UserService userService;
    @Autowired
    public UserController(UserService userService) {
        this.userService = userService;
    }
    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

当然，如果当前的类中只有一个构造方法，那么 @Autowired 也可以省略，所以以上代码还可以这样写：

@RestController
public class UserController {
    // 构造方法注入
    private UserService userService;

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

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

优点分析

构造方法注入相比于前两种注入方法，它可以注入不可变对象，并且它只会执行一次，也不存在像 Setter 注入那样，被注入的对象随时被修改的情况，它的优点有以下 4 个：

可注入不可变对象
注入对象不会被修改
注入对象会被完全初始化
通用性更好

接下来我们一一来看。

优点1：注入不可变对象

使用构造方法注入可以注入不可变对象，如下代码所示：
在这里插入图片描述

优点2：注入对象不会被修改

构造方法注入不会像 Setter 注入那样，构造方法在对象创建时只会执行一次，因此它不存在注入对象被随时（调用）修改的情况。

优点3：完全初始化

因为依赖对象是在构造方法中执行的，而构造方法是在对象创建之初执行的，因此被注入的对象在使用之前，会被完全初始化，这也是构造方法注入的优点之一。

优点4：通用性更好

构造方法和属性注入不同，构造方法注入可适用于任何环境，无论是 IoC 框架还是非 IoC 框架，构造方法注入的代码都是通用的，所以它的通用性更好。

总结

依赖注入的常见实现方式有 3 种：属性注入、Setter 注入和构造方法注入。其中属性注入的写法最简单，所以日常项目中使用的频率最高，但它的通用性不好；而 Spring 官方推荐的是构造方法注入，它可以注入不可变对象，其通用性也更好，如果是注入可变对象，那么可以考虑使用 Setter 注入。

二、@Autowired 和 @Resource 有什么区别

@Autowired 和 @Resource 都是 Spring/Spring Boot 项目中，用来进行依赖注入的注解。它们都提供了将依赖对象注入到当前对象的功能，但二者却有众多不同，并且这也是常见的面试题之一，所以我们今天就来盘它。

@Autowired 和 @Resource 的区别主要体现在以下 5 点：

来源不同
依赖查找的顺序不同
支持的参数不同
依赖注入的用法不同
编译器 IDEA 的提示不同

来源不同

@Autowired 和 @Resource 来自不同的“父类”，其中 @Autowired 是 Spring 定义的注解，而 @Resource 是 Java 定义的注解，它来自于 JSR-250（Java 250 规范提案）。

小知识：JSR 是 Java Specification Requests 的缩写，意思是“Java 规范提案”。任何人都可以提交 JSR给 Java 官方，但只有最终确定的 JSR，才会以 JSR-XXX 的格式发布，如 JSR-250，而被发布的 JSR 就可以看作是 Java 语言的规范或标准。

依赖查找顺序不同

依赖注入的功能，是通过先在 Spring IoC 容器中查找对象，再将对象注入引入到当前类中。而查找有分为两种实现：按名称（byName）查找或按类型（byType）查找，其中 @Autowired 和 @Resource 都是既使用了名称查找又使用了类型查找，但二者进行查找的顺序却截然相反。

@Autowired 查找顺序

@Autowired 是先根据类型（byType）查找，如果存在多个 Bean 再根据名称（byName）进行查找，它的具体查找流程如下：
在这里插入图片描述

关于以上流程，可以通过查看 Spring 源码中的 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor#postProcessPropertyValues 实现分析得出，源码执行流程如下图所示：
在这里插入图片描述

@Resource 查找顺序

@Resource 是先根据名称查找，如果（根据名称）查找不到，再根据类型进行查找，它的具体流程如下图所示：
在这里插入图片描述

关于以上流程可以在 Spring 源码的org.springframework.context.annotation.CommonAnnotationBeanPostProcessor#postProcessPropertyValues 中分析得出。虽然 @Resource 是 JSR-250 定义的，但是由 Spring 提供了具体实现，它的源码实现如下：
在这里插入图片描述

查找顺序小结

由上面的分析可以得出：

@Autowired 先根据类型（byType）查找，如果存在多个（Bean）再根据名称（byName）进行查找；
@Resource先根据名称（byName）查找，如果（根据名称）查找不到，再根据类型（byType）进行查找。

支持的参数不同

@Autowired 和 @Resource 在使用时都可以设置参数，比如给 @Resource 注解设置 name 和 type 参数，实现代码如下：

@Resource(name = "userinfo", type = UserInfo.class)
private UserInfo user;

但二者支持的参数以及参数的个数完全不同，其中 @Autowired 只支持设置一个 required 的参数，而 @Resource 支持 7 个参数，支持的参数如下图所示：
在这里插入图片描述

依赖注入的支持不同
@Autowired 和 @Resource 支持依赖注入的用法不同，常见依赖注入有以下 3 种实现：

属性注入
构造方法注入
Setter 注入

这 3 种实现注入的实现代码如下。

a) 属性注入

@RestController
public class UserController {
    // 属性注入
    @Autowired
    private UserService userService;

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

b) 构造方法注入

@RestController
public class UserController {
    // 构造方法注入
    private UserService userService;

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

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

c) Setter 注入

@RestController
public class UserController {
    // Setter 注入
    private UserService userService;

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

    @RequestMapping("/add")
    public UserInfo add(String username, String password) {
        return userService.add(username, password);
    }
}

其中， @Autowired 支持属性注入、构造方法注入和 Setter 注入，而 @Resource 只支持属性注入和 Setter 注入，当使用 @Resource 实现构造方法注入时就会提示以下错误：
在这里插入图片描述

编译器提示不同

当使用 IDEA 专业版在编写依赖注入的代码时，如果注入的是 Mapper 对象，那么使用 @Autowired 编译器会提示报错信息，报错内容如下图所示：
在这里插入图片描述

虽然 IDEA 会出现报错信息，但程序是可以正常执行的。
然后，我们再将依赖注入的注解更改为 @Resource 就不会出现报错信息了，具体实现如下：
在这里插入图片描述

总结
@Autowired 和 @Resource 都是用来实现依赖注入的注解（在 Spring/Spring Boot 项目中），但二者却有着 5 点不同：

来源不同：@Autowired 来自 Spring 框架，而 @Resource 来自于（Java）JSR-250；
依赖查找的顺序不同：@Autowired 先根据类型再根据名称查询，而 @Resource 先根据名称再根据类型查询；
支持的参数不同：@Autowired 只支持设置 1 个参数，而 @Resource 支持设置 7 个参数；
依赖注入的用法支持不同：@Autowired 既支持构造方法注入，又支持属性注入和 Setter 注入，而 @Resource只支持属性注入和 Setter 注入；编译器 IDEA 的提示不同：当注入 Mapper 对象时，使用 @Autowired
注解编译器会提示错误，而使用 @Resource 注解则不会提示错误。