AI 助理
文档备案控制台
开发者社区 冰河技术 文章 正文

【Spring注解驱动开发】使用@Autowired@Qualifier@Primary三大注解自动装配组件，你会了吗？

2021-11-19 543
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Spring专题】停更一个多月，期间在更新其他专题的内容，不少小伙伴纷纷留言说：冰河，你【Spring专题】是不是停更了啊！其实并没有停更，只是中途有很多小伙伴留言说急需学习一些知识技能，以便于跳槽，哈哈，大家都懂得！所以，中途停更了一段时间，写了一些其他专题的文章。现在，继续更新【String专题】。

@Autowired注解

@Autowired 注解，可以对类成员变量、方法和构造函数进行标注，完成自动装配的工作。@Autowired 注解可以放在类，接口以及方法上。在使用@Autowired之前，我们对一个bean配置属性时，是用如下xml文件的形式进行配置的。

<property name="属性名" value=" 属性值"/>

@Autowired 注解的源码如下所示。

package org.springframework.beans.factory.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
 boolean required() default true;
}

@Autowired 注解说明：

（1）默认优先按照类型去容器中找对应的组件，找到就赋值；

（2）如果找到多个相同类型的组件，再将属性名称作为组件的id，到 IOC 容器中进行查找。

@Qualifier注解

@Autowired是根据类型进行自动装配的，如果需要按名称进行装配，则需要配合@Qualifier 注解使用。

@Qualifier注解源码如下所示。

package org.springframework.beans.factory.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Qualifier {
 String value() default "";
}

@Primary注解

在Spring 中使用注解，常使用@Autowired， 默认是根据类型Type来自动注入的。但有些特殊情况，对同一个接口，可能会有几种不同的实现类，而默认只会采取其中一种实现的情况下， 就可以使用@Primary注解来标注优先使用哪一个实现类。

@Primary注解的源码如下所示。

package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Primary {
}

自动装配

在进行项目实战之前，我们先来说说什么是Spring组件的自动装配。Spring组件的自动装配就是：Spring利用依赖注入，也就是我们通常所说的DI，完成对IOC容器中各个组件的依赖关系赋值。

项目实战

测试@Autowired注解

这里，我们以之前项目中创建的dao、service和controller为例进行说明。dao、service和controller的初始代码分别如下所示。

  • dao
package io.mykit.spring.plugins.register.dao;
import org.springframework.stereotype.Repository;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的dao
 */
@Repository
public class PersonDao {
}
  • service
package io.mykit.spring.plugins.register.service;
import io.mykit.spring.plugins.register.dao.PersonDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的Service
 */
@Service
public class PersonService {
    @Autowired
    private PersonDao personDao;
}
  • controller
package io.mykit.spring.plugins.register.controller;
import org.springframework.stereotype.Controller;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的controller
 */
@Controller
public class PersonController {
    @Autowired
    private PersonService personService;
}

可以看到，我们在Service中使用@Autowired注解注入了Dao，在Controller中使用@Autowired注解注入了Service。为了方便测试，我们在PersonService类中生成一个toString()方法，如下所示。

package io.mykit.spring.plugins.register.service;
import io.mykit.spring.plugins.register.dao.PersonDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的Service
 */
@Service
public class PersonService {
    @Autowired
    private PersonDao personDao;
    @Override
    public String toString() {
        return personDao.toString();
    }
}

这里，我们在PersonService类的toString()方法中直接调用personDao的toString()方法并返回。为了更好的演示效果，我们在项目的 io.mykit.spring.plugins.register.config 包下创建AutowiredConfig类，如下所示。

package io.mykit.spring.plugins.register.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试自动装配组件的Config配置类
 */
@Configuration
@ComponentScan(value = {
        "io.mykit.spring.plugins.register.dao", 
        "io.mykit.spring.plugins.register.service", 
        "io.mykit.spring.plugins.register.controller"})
public class AutowiredConfig {
}

接下来，我们来测试一下上面的程序，我们在项目的src/test/java目录下的 io.mykit.spring.test 包下创建AutowiredTest类，如下所示。

package io.mykit.spring.test;
import io.mykit.spring.plugins.register.config.AutowiredConfig;
import io.mykit.spring.plugins.register.service.PersonService;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试自动装配
 */
public class AutowiredTest {
    @Test
    public void testAutowired01(){
        //创建IOC容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AutowiredConfig.class);
        PersonService personService = context.getBean(PersonService.class);
        System.out.println(personService);
        context.close();
    }
}

测试方法比较简单，这里，我就不做过多说明了。接下来，我们运行AutowiredTest类的testAutowired01()方法，得出的输出结果信息如下所示。

io.mykit.spring.plugins.register.dao.PersonDao@10e92f8f

可以看到，输出了PersonDao信息。

那么问题来了：我们在PersonService类中输出的PersonDao，和我们直接在Spring IOC容器中获取的PersonDao是不是同一个对象呢？

我们可以在AutowiredTest类的testAutowired01()方法中添加获取PersonDao对象的方法，并输出获取到的PersonDao对象，如下所示。

@Test
public void testAutowired01(){
    //创建IOC容器
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AutowiredConfig.class);
    PersonService personService = context.getBean(PersonService.class);
    System.out.println(personService);
    PersonDao personDao = context.getBean(PersonDao.class);
    System.out.println(personDao);
    context.close();
}

我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

io.mykit.spring.plugins.register.dao.PersonDao@10e92f8f
io.mykit.spring.plugins.register.dao.PersonDao@10e92f8f

可以看到，我们在PersonService类中输出的PersonDao对象和直接从IOC容器中获取的PersonDao对象是同一个对象。

如果在Spring容器中存在对多个PersonDao对象该如何处理呢？

首先，为了更加直观的看到我们使用@Autowired注解装配的是哪个PersonDao对象，我们对PersonDao类进行改造，为其加上一个remark字段，为其赋一个默认值，如下所示。

package io.mykit.spring.plugins.register.dao;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Repository;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的dao
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Repository
public class PersonDao {
    private String remark = "1";
}

接下来，我们就在AutowiredConfig类中注入一个PersonDao对象，并且显示指定PersonDao对象在IOC容器中的bean的名称为personDao2，并为PersonDao对象的remark字段赋值为2，如下所示。

@Bean("personDao2")
  public PersonDao personDao(){
      return new PersonDao("2");
  }

目前，在我们的IOC容器中就会注入两个PersonDao对象。那此时，@Autowired注解装配的是哪个PersonDao对象呢？

接下来，我们运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonDao{remark='1'}

可以看到，结果信息输出了1，说明：@Autowired注解默认优先按照类型去容器中找对应的组件，找到就赋值；如果找到多个相同类型的组件，再将属性名称作为组件的id，到 IOC 容器中进行查找。

那我们如何让@Autowired装配personDao2呢？ 这个问题问的好，其实很简单，我们将PersonService类中的personDao全部修改为personDao2，如下所示。

package io.mykit.spring.plugins.register.service;
import io.mykit.spring.plugins.register.dao.PersonDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的Service
 */
@Service
public class PersonService {
    @Autowired
    private PersonDao personDao2;
    @Override
    public String toString() {
        return personDao2.toString();
    }
}

此时，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonDao{remark='2'}

可以看到，此时命令行输出了personDao2的信息。

测试@Qualifier注解

从测试@Autowired注解的结果来看：@Autowired注解默认优先按照类型去容器中找对应的组件，找到就赋值；如果找到多个相同类型的组件，再将属性名称作为组件的id，到 IOC 容器中进行查找。

如果IOC容器中存在多个相同类型的组件时，我们可不可以显示指定@Autowired注解装配哪个组件呢？有些小伙伴肯定会说：废话！你都这么问了，那肯定可以啊！没错，确实可以啊！此时，@Qualifier注解就派上用场了！

在之前的测试案例中，命令行输出了 PersonDao{remark='2'} 说明@Autowired注解装配了personDao2，那我们如何显示的让@Autowired注解装配personDao呢？

比较简单，我们只需要在PersonService类上personDao2字段上添加@Qualifier注解，显示指定@Autowired注解装配personDao，如下所示。

@Qualifier("personDao")
@Autowired
private PersonDao personDao2;

此时，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonDao{remark='1'}

可以看到，此时尽管字段的名称为personDao2，但是我们使用了@Qualifier注解显示指定@Autowired注解装配personDao对象，所以，最终的结果输出了personDao对象的信息。

测试容器中无组件的情况

如果IOC容器中无相应的组件，会发生什么情况呢？此时，我们删除PersonDao类上的@Repository注解，并且删除AutowiredConfig类中的personDao()方法上的@Bean注解，如下所示。

package io.mykit.spring.plugins.register.dao;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试的dao
 */
public class PersonDao {
    private String remark = "1";
    public String getRemark() {
        return remark;
    }
    public void setRemark(String remark) {
        this.remark = remark;
    }
    @Override
    public String toString() {
        return "PersonDao{" +
                "remark='" + remark + '\'' +
                '}';
    }
}
package io.mykit.spring.plugins.register.config;
import io.mykit.spring.plugins.register.dao.PersonDao;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试自动装配组件的Config配置类
 */
@Configuration
@ComponentScan(value = {
        "io.mykit.spring.plugins.register.dao",
        "io.mykit.spring.plugins.register.service",
        "io.mykit.spring.plugins.register.controller"})
public class AutowiredConfig {
    public PersonDao personDao(){
        PersonDao personDao = new PersonDao();
        personDao.setRemark("2");
        return personDao;
    }
}

此时IOC容器中不再有personDao，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'io.mykit.spring.plugins.register.dao.PersonDao' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Qualifier(value=personDao), @org.springframework.beans.factory.annotation.Autowired(required=true)}

可以看到，Spring抛出了异常，未找到相应的bean对象，我们能不能让Spring不报错呢？ 那肯定可以啊！Spring的异常信息中都给出了相应的提示。

{@org.springframework.beans.factory.annotation.Qualifier(value=personDao), @org.springframework.beans.factory.annotation.Autowired(required=true)}

解决方案就是在PersonService类的@Autowired添加一个属性required=false，如下所示。

@Qualifier("personDao")
@Autowired(required = false)
private PersonDao personDao2;

并且我们修改下PersonService的toString()方法，如下所示。

@Override
public String toString() {
    return "PersonService{" +
        "personDao2=" + personDao2 +
        '}';
}

此时，还需要将AutowiredTest类的testAutowired01()方法中直接从IOC容器中获取personDao的代码删除，如下所示。

@Test
public void testAutowired01(){
    //创建IOC容器
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AutowiredConfig.class);
    PersonService personService = context.getBean(PersonService.class);
    System.out.println(personService);
    context.close();
}

此时，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonService{personDao2=null}

可以看到，当为@Autowired添加属性required=false后，即使IOC容器中没有对应的对象，Spring也不会抛出异常。此时，装配的对象就为null。

测试完成后，我们再次为PersonDao类添加@Repository注解，并且为AutowiredConfig类中的personDao()方法添加@Bean注解。

测试@Primary注解

在Spring中，对同一个接口，可能会有几种不同的实现类，而默认只会采取其中一种实现的情况下， 就可以使用@Primary注解来标注优先使用哪一个实现类。

首先，我们在AutowiredConfig类的personDao()方法上添加@Primary注解，此时，我们需要删除PersonService类中personDao字段上的@Qualifier注解，这是因为@Qualifier注解为显示指定装配哪个组件，如果使用了@Qualifier注解，无论是否使用了@Primary注解，都会装配@Qualifier注解标注的对象。

设置完成后，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonService{personDao2=PersonDao{remark='2'}}

可以看到，此时remark的值为2，装配了AutowiredConfig类中注入的personDao。

接下来，我们为PersonService类中personDao字段再次添加@Qualifier注解，如下所示。

@Qualifier("personDao")
@Autowired(required = false)
private PersonDao personDao;

此时，我们再次运行AutowiredTest类的testAutowired01()方法，输出的结果信息如下所示。

PersonService{personDao=PersonDao{remark='1'}}

可以看到，此时，Spring装配了使用@Qualifier标注的personDao。

文章标签：
Java
容器
Spring
数据格式
XML
关键词：
Spring开发
Spring自动装配
Spring注解
Spring组件
Spring驱动
码农小达人
目录
相关文章
游客izzodqdjmth2i
|
6月前
|
安全 Java 决策智能
Spring Boot自动装配
Spring Boot自动装配基于“约定优于配置”理念，通过条件化配置与Starters机制，智能推断并加载所需组件，大幅简化开发流程。它实现配置自动化，提升效率，降低维护成本，支持自定义扩展，推动微服务快速构建，是Java生态中开发范式的革新之作。（238字）
游客izzodqdjmth2i
627 6
WanderInk-20107
|
NoSQL 安全 Java
深入理解 RedisConnectionFactory：Spring Data Redis 的核心组件
在 Spring Data Redis 中，`RedisConnectionFactory` 是核心组件，负责创建和管理与 Redis 的连接。它支持单机、集群及哨兵等多种模式，为上层组件（如 `RedisTemplate`）提供连接抽象。Spring 提供了 Lettuce 和 Jedis 两种主要实现，其中 Lettuce 因其线程安全和高性能特性被广泛推荐。通过手动配置或 Spring Boot 自动化配置，开发者可轻松集成 Redis，提升应用性能与扩展性。本文深入解析其作用、实现方式及常见问题解决方法，助你高效使用 Redis。
WanderInk-20107
1242 4
凉凉心.
|
6月前
|
XML Java 应用服务中间件
【SpringBoot（一）】Spring的认知、容器功能讲解与自动装配原理的入门，带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章，讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门，还有其他常用的Springboot注解！如果想要了解SpringBoot，那么就进来看看吧！
凉凉心.
691 2
游客cjle3qpbn6lw6
|
负载均衡 Java Nacos
Spring Cloud五大组件
Spring Cloud五大组件
游客cjle3qpbn6lw6
6573 0
Quan_Chen
|
安全 Java 数据安全/隐私保护
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 三大核心组件
本课程介绍如何在Spring Boot中集成Shiro框架，主要讲解Shiro的认证与授权功能。Shiro是一个简单易用的Java安全框架，用于认证、授权、加密和会话管理等。其核心组件包括Subject（认证主体）、SecurityManager（安全管理员）和Realm（域）。Subject负责身份认证，包含Principals（身份）和Credentials（凭证）；SecurityManager是架构核心，协调内部组件运作；Realm则是连接Shiro与应用数据的桥梁，用于访问用户账户及权限信息。通过学习，您将掌握Shiro的基本原理及其在项目中的应用。
Quan_Chen
472 0
Unfailed_realme
|
9月前
|
JSON 前端开发 Java
Spring MVC 核心组件与请求处理机制详解
本文解析了 Spring MVC 的核心组件及请求流程，核心组件包括 DispatcherServlet（中央调度）、HandlerMapping（URL 匹配处理器）、HandlerAdapter（执行处理器）、Handler（业务方法）、ViewResolver（视图解析），其中仅 Handler 需开发者实现。 详细描述了请求执行的 7 步流程：请求到达 DispatcherServlet 后，经映射器、适配器找到并执行处理器，再通过视图解析器渲染视图（前后端分离下视图解析可省略）。 介绍了拦截器的使用（实现 HandlerInterceptor 接口 + 配置类）及与过滤器的区别
Unfailed_realme
928 0
mao29955
|
负载均衡 算法 Java
除了 Ribbon，Spring Cloud 中还有哪些负载均衡组件？
这些负载均衡组件各有特点，在不同的场景和需求下，可以根据项目的具体情况选择合适的负载均衡组件来实现高效、稳定的服务调用。
mao29955
1371 61
wljslmz
|
消息中间件 Java Kafka
Spring Boot 与 Apache Kafka 集成详解：构建高效消息驱动应用
Spring Boot 与 Apache Kafka 集成详解：构建高效消息驱动应用
wljslmz
742 1
javaedge
|
Oracle NoSQL Java
Spring的@Autowired依赖注入原来这么多坑！（中）
像第一个案例，同种类型的实现，可能不是同时出现在自己的项目代码中，而是有部分实现出现在依赖的类库。看来研究源码的确能让我们少写几个 bug！
javaedge
723 0
Spring的@Autowired依赖注入原来这么多坑！（中）
javaedge
|
Oracle NoSQL 关系型数据库
Spring的@Autowired依赖注入原来这么多坑！（上）
像第一个案例，同种类型的实现，可能不是同时出现在自己的项目代码中，而是有部分实现出现在依赖的类库。看来研究源码的确能让我们少写几个 bug！
javaedge
245 0
Spring的@Autowired依赖注入原来这么多坑！（上）

热门文章

最新文章

  • 1
    Spring Boot 2.X(六)：Spring Boot 集成 Redis
  • 2
    基于Springboot+Vue+Mybatis的小说阅读管理系统
  • 3
    java版spring cloud+spring boot 社交电子商务平台-Ribbon设计原理
  • 4
    校园互助系统|校园基于vue+springboot开发的校园互助平台
  • 5
    Struts2与Spring整合
  • 6
    Spring Boot Actuator集成，难的是灵活运用！
  • 7
    使用Cloud Studio在线编写、调试和管理Spring Boot应用
  • 8
    spring-doc报错Unable to render this definition
  • 9
    详解Spring MVC 4之DispatcherServlet
  • 10
    【Spring开发】—— Spring注入静态变量
  • 1
    基于SpringBoot+Vue+uniapp的珠江学院大学生自愿者服务网的详细设计和实现(源码+lw+部署文档+讲解等)
    188
  • 2
    基于SpringBoot+Vue+uniapp的线上旅游体验系统的详细设计和实现(源码+lw+部署文档+讲解等)
    182
  • 3
    基于SpringBoot+Vue+uniapp的江苏融汇房地产营销策划有限公司的详细设计和实现(源码+lw+部署文档+讲解等)
    105
  • 4
    基于SpringBoot+Vue+uniapp的智能训练管理平台的详细设计和实现(源码+lw+部署文档+讲解等)
    203
  • 5
    基于SpringBoot+Vue+uniapp的疫苗预约系统的详细设计和实现(源码+lw+部署文档+讲解等)
    160
  • 6
    基于SpringBoot+Vue+uniapp的壁纸网站的详细设计和实现(源码+lw+部署文档+讲解等)
    328
  • 7
    基于SpringBoot+Vue+uniapp的网上系统调查的详细设计和实现(源码+lw+部署文档+讲解等)
    107
  • 8
    基于SpringBoot+Vue+uniapp的数学课程评价系统的详细设计和实现(源码+lw+部署文档+讲解等)
    136
  • 9
    基于SpringBoot+Vue+uniapp的教务信息平台的详细设计和实现(源码+lw+部署文档+讲解等)
    140
  • 10
    基于SpringBoot+Vue+uniapp的数字家庭网站的详细设计和实现(源码+lw+部署文档+讲解等)
    175

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第三阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    PolarDB MySQL 版 Serverless-测评