聊聊依赖注入注解@Resource和@Autowired

码农小胖哥

发布于 2020-06-10 16:01:32

1.5K0

发布于 2020-06-10 16:01:32

文章被收录于专栏：码农小胖哥的码农生涯

1. 前言

@Resource和@Autowired注解都可以在Spring Framework应用中进行声明式的依赖注入。而且面试中经常涉及到这两个注解的知识点。今天我们来总结一下它们。

2. @Resource

全称javax.annotation.Resource,它属于JSR-250规范的一个注解，包含Jakarta EE（J2EE）中。Spring提供了对该注解的支持。我们来详细了解一下该注解的规则。

该注解使用在成员属性和 setter 方法上。默认情况下@Resource按照名称注入，如果没有显式声明名称则按照变量名称或者方法中对应的参数名称进行注入。

Resource注解流程

如果我们希望在目标 Bean 中体现多态我们可以这样写：

/**
 * 多态的体现.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class ResourceTest {
    @Resource
    private ApplicationRunner applicationRunner;
    @Resource
    private ApplicationRunner runner;
    // ...
}

Qualifier 约束参见 Spring 注解 @Qualifier 详细解析

3. @Autowired

@Autowired通常适用于构造函数，成员变量以及方法上。它的机制是这样的：

Autowired流程

这个注解我们是需要好好聊聊的，日常使用频率相当高。

3.1 标注在构造上

通过在目标Bean的构造函数上标注就可以注入对应的Bean。

package cn.felord;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

/**
 * @author felord.cn
 * @since 9:26
 **/
@Component
public class AutowiredTest {
 private final ApplicationRunner applicationRunner;

    @Autowired
    public AutowiredTest(ApplicationRunner applicationRunner) {
        this.applicationRunner = applicationRunner;
    }
}

从Spring Framework 4.3开始，@Autowired如果目标 Bean 只定义一个构造函数，则不再需要在该构造函数上添加@Autowired注解。如果目标 Bean 有几个构造函数可用，并且没有主/默认构造函数，则必须至少有一个构造函数被@Autowired标记，以指示 Spring IoC 容器使用哪个构造函数。

3.2 标注在成员变量上

和@Resource一样，@Autowired也可以标注到目标Bean的成员变量上。

/**
 * @author felord.cn
 * @since 9:26
 **/
@Component
public class AutowiredTest {
    @Autowired
    private ApplicationRunner applicationRunner;

    // ...

}

3.3 标注到方法上

一般 setter 方法上使用的比较多。而且一个 @Autowired 支持注入多个参数。

/**
 * The type Autowired test.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class AutowiredTest {

    private ApplicationRunner applicationRunner;
    private EmployeeMapper employeeMapper;
    private DepartmentMapper departmentMapper;

    /**
     * Sets application runner.
     *
     * @param applicationRunner the application runner
     */
    @Autowired
    public void setApplicationRunner(ApplicationRunner applicationRunner) {
        this.applicationRunner = applicationRunner;
    }


    /**
     * 支持多参数
     *
     * @param employeeMapper   the employee mapper
     * @param departmentMapper the department mapper
     */
    @Autowired
    public void prepare(EmployeeMapper employeeMapper, DepartmentMapper departmentMapper) {
        this.employeeMapper = employeeMapper;
        this.departmentMapper = departmentMapper;
    }

}

你以为这就完了？下面这种方式估计大多数人并没有在意过。

/**
 * The type Autowired test.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class AutowiredTest {
    // 注入 数组
    @Autowired
    private MovieCatalog[] movieCatalogs;

    private Map<String, Movie> movies;

    private Set<CustomerPreferenceDao> customerPreferenceDaos;

    // 注入 set
    @Autowired
    public MovieRecommender(Set<CustomerPreferenceDao> customerPreferenceDaos) {
        this.customerPreferenceDaos = customerPreferenceDaos;
    }

    // 注入 map
    @Autowired
    public void setMovieCatalogs(Map<String, Movie> movies) {
        this.movies = movies;
    }

    // ...
}

可以把 Bean 注入目标 Bean 的数组、集合容器中去。默认情况下，当给定注入点没有匹配的候选 Bean 可用时，自动装配将失败。至少应有一个匹配元素。

如果您希望元素按照特定顺序排序，则元素 Bean 可以实现org.springframework.core.Ordered接口或者对应注解@Order或标准@Priority。基于某些机制不建议使用注解方式来排序，否则无法达到预期期望，推荐使用接口Ordered。

3.4 装配可选

@Resource没有提供可选择装配的特性，一旦无法装配则会抛出异常；而@Autowired提供了required属性（默认值为true）以避免这种情况，设置@Autowired为false。

/**
 * The type Autowired test.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class AutowiredTest {
    // 一旦找不到 movieFinder  不会异常  而初始化为 null
    @Autowired(required = false)
    private MovieFinder movieFinder;
    // ...
}

这里也有骚操作，你可以忽略required属性。通过 Java 8的 java.util.Optional来表明候选 Bean 可选。

/**
 * The type Autowired test.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class AutowiredTest {
public class SimpleMovieLister {
    // 使用 Optional 表明候选Bean可选
    @Autowired
    public void setMovieFinder(Optional<MovieFinder> movieFinder) {
    // ...
    }
}

从Spring 5.0开始，您还可以使用@Nullable注解，这个注解可以你自己实现检测逻辑或者直接使用 JSR-305提供的javax.annotation.Nullable。

/**
 * The type Autowired test.
 *
 * @author felord.cn
 * @since 9 :26
 */
@Component
public class AutowiredTest {
public class SimpleMovieLister {
    // 使用 @Nullable 注解表明候选Bean可选
    @Autowired
    public void setMovieFinder(@Nullable MovieFinder movieFinder) {
     //   ...
    }
}

4. @Inject

从Spring 3.0开始，Spring提供对JSR-330标准注释（依赖注入）的支持。你需要引入依赖：

<dependency>
    <groupId>javax.inject</groupId>
    <artifactId>javax.inject</artifactId>
    <version>1</version>
</dependency>

然后你就可以使用相关的注解来进行依赖注入了，其中主要注解为@javax.inject.Inject。大部分情况下该注解都可以代替@Autowired使用，但@Inject没有required属性，不过它也可以与java.util.Optional或使用@Nullable来达到同样的效果。

大部分情况下没有人喜欢额外引入Jakarta EE依赖来使用一个已经拥有的功能，Spring堵死了Jakarta EE依赖注入的生态。

5. 总结

@Resource和@Autowired的优先级顺序不同（参见上图），另外@Resource属于 Jakarta EE规范而@Autowired属于Spring范畴，@Resource无法使用在构造参数中，@Autowired支持required属性。从面向对象来说，@Resource更加适用于多态性的细粒度注入，而@Autowired更多专注于单例。@Inject 则没必要过多讨论，只作为一个添头。