[SpringBoot]接口的多实现:选择性注入SpringBoot接口的实现类

2024-01-08 06:12

本文主要是介绍[SpringBoot]接口的多实现:选择性注入SpringBoot接口的实现类,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

最近在项目中遇到两种情况,准备写个博客记录一下。

情况说明:Service层一个接口是否可以存在多个具体实现,此时应该如何调用Service(的具体实现)?

其实之前的项目中也遇到过这种情况,只不过我采用的方式是新建了一个Service接口,然后拆分两个实现类,让两个实现类分别实现两个不同的接口,然后在Controller中分别注入两个Service。最近项目中又遇到了这种情况,于是简单研究了一下,一个Service确实是可以有多个实现的,以下介绍4种区分实现类的方式。

以下代码本人均已测试,并对一些情况做了补充(欢迎继续补充)。

文章目录

  • 实现
    • 方式1: 直接使用实现类类名来区分
    • 方式2:`@Qualifier`注解
    • 方式3:设置主实现类
    • 方式4:使用`@Resource`注解
  • 总结
  • 致谢

实现


方式1: 直接使用实现类类名来区分

我在以下代码中直接创建一个接口AaaService,然后让BbbServiceImpl和CccServiceImpl分别来实现AaaService,且BbbServiceImpl和CccServiceImpl注册为Service。

public interface AaaService {String say();
}
@Service
public class BbbServiceImpl implements AaaService {@Overridepublic String say() {System.out.println("我是BBB");return "我是BBB";}
}
@Service
public class CccServiceImpl implements AaaService {@Overridepublic String say() {System.out.println("我是CCC");return "我是CCC";}
}

以上代码AAA就有了两个Service实现类,尽管我没有遵循一些明明规则,但是BBB与CCC确实是AAA的实现类,且它们三个都是Service层的组件,接下来我在Controller中注入这两个组件。

@RestController
@RequestMapping("/test")
public class TestController {@Autowiredprivate AaaService bbbServiceImpl;@Autowiredprivate AaaService cccServiceImpl;@GetMapping("/b")public String BBB(){return bbbServiceImpl.say();}@GetMapping("/c")public String CCC(){return cccServiceImpl.say();}}

这时候我们启动项目,通过浏览器分别访问/test/b/test/c地址,情况如下:

  • /test/b:我是BBB(且后端控制台也输出:我是BBB)
  • /test/c:我是CCC(且后端控制台也输出:我是CCC)

因此,我们确实在Controller层同时注入了一个Service的两个实现类。



方式2:@Qualifier注解

通常情况下,如果注入的B与C的变量名没有遵循与实现类同名(小驼峰)的命名方式的话,项目会启动失败,并且报错如下:

Action:Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

表现如下:

在这里插入图片描述

这是在提示我们使用@Qualifier注解来区分两个实现类(使用方式一也是可以的)。在一些情况下,我们虽然一个Service有多个实现类,但是我们依旧想用最传统的方式,也就是接口名小驼峰的方式来作为它的实现类来使用,但是很明显,像是下面这段代码在该情况下是不能生效的,因为我们并没有一个叫AaaService的实现类。

@RestController
public class TestController {@Autowiredprivate AaaService aaaService;
}

上面这段代码运行起来之后就会报我们上面说到的报错,该如何解决呢??只需要在@Autowired上面加上一个注解就可以,写法如下:

@RestController
public class TestController {@Qualifier("bbbServiceImpl")@Autowiredprivate AaaService aaaService;
}

注意,注解中写的内容必须是该Service接口的某个实现类的小驼峰名称。

这样一来,我们就在该Controller中注入了BbbServiceImpl,只不过它的名称是aaaService,在后续使用中,我们调用的也是BbbServiceImpl种的方法。



方式3:设置主实现类

通过以上两种方式,我们已经可以实现自由的选择我们具体要注入的是哪一个实现类,但是如果业务中有这样的一个场景:我默认下只使用A实现类,BC实现类是我在特殊情况下才去使用的。在这种情况下,我希望能有一种“默认”机制的出现,该如何实现呢?请看以下代码:

public interface AaaService  {// ...  
}@Service
@Primary // 注意这一个注解
public interface BbbServiceImpl implements AaaService {// Aaa的实现 ...
}@Service
public interface CccServiceImpl implements AaaService {// Aaa的实现 ...
}

在以上代码中,由于B实现上面有一个@Primary注解,因此该实现类会被当做是A接口的主要实现类,这时候我若是未指明具体使用的是哪一个实现类(就不会报错啦),就会默认用的是B实现类。

这时候又出现了一个小问题,如果这时候我想用C,该怎么办呢?换种方式问一下:命名这个东西是随便写的,如果我们恰巧如方式1中所说的,我变量名命名成了cccServiceImpl,它注入的是B还是C呢?答案揭晓:是B在此种情况下,用命名来区分实现类的方式已经失效了,要是想使用其他的实现类,只能使用方式二中的@Qualifier注解来区分。



方式4:使用@Resource注解

正如方式3中所说,我们设置了@Primary之后,已经无法通过@Autowired注解去控制注入哪个实现类了,但是有没有一种方法还是可以用名称去选择呢?当然可以,那就是@Resource注解。

因为Resource注解默认使用名称进行依赖注入,所以情况3中的代码不变,我们对Controller做如下修改:

@RestController
public class TestController {@ResourceAaaService cccServiceImpl;@GetMapping("/test")public String test() {return cccServiceImpl.say();}}

在以上代码中,虽然我们已经对AaaService设置了默认实现类BbbServiceImpl,但是使用@Resource注解注入了名称为cccServiceImpl的实现,这时候访问/test,得到的字符串依旧是"我是CCC"。





总结

  1. 结论:一个Service可以有多个实现,且我们可以手动选择具体使用的哪个实现
  2. 使用@Autowired且没有做过多操作(如设置默认实现)的情况下,我们可以使用注入的变量名称(一定是小驼峰)的方式选择变量名,也可以在@Autowired上面添加@Qualifier("实现类的小驼峰")的方式来选择具体实现类。
  3. 我们可以在接口实现类上写上@Primary注解来认证该实现类为主实现类,在该情况下,如果不特意指定是哪个实现类,则一律认为是默认实现类。
  4. 当指定了默认实现类之后,使用@Autowired+小驼峰名称的注入方式,已经无法指定特定实现类,只能使用``@Qualifier(“实现类的小驼峰”)@+@Autowired@Resource + 小驼峰命名`的方式进行区分。





致谢

感谢 [CSDN | springboot中一个service接口多个实现类,如何注入]

感谢 [稀土掘金 | spring接口多实现类,选择性注入的4种解决方案]

这篇关于[SpringBoot]接口的多实现:选择性注入SpringBoot接口的实现类的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/582521

相关文章

基于SpringBoot+Mybatis实现Mysql分表

《基于SpringBoot+Mybatis实现Mysql分表》这篇文章主要为大家详细介绍了基于SpringBoot+Mybatis实现Mysql分表的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可... 目录基本思路定义注解创建ThreadLocal创建拦截器业务处理基本思路1.根据创建时间字段按年进

SpringBoot3实现Gzip压缩优化的技术指南

《SpringBoot3实现Gzip压缩优化的技术指南》随着Web应用的用户量和数据量增加,网络带宽和页面加载速度逐渐成为瓶颈,为了减少数据传输量,提高用户体验,我们可以使用Gzip压缩HTTP响应,... 目录1、简述2、配置2.1 添加依赖2.2 配置 Gzip 压缩3、服务端应用4、前端应用4.1 N

Java编译生成多个.class文件的原理和作用

《Java编译生成多个.class文件的原理和作用》作为一名经验丰富的开发者,在Java项目中执行编译后,可能会发现一个.java源文件有时会产生多个.class文件,从技术实现层面详细剖析这一现象... 目录一、内部类机制与.class文件生成成员内部类(常规内部类)局部内部类(方法内部类)匿名内部类二、

SpringBoot实现数据库读写分离的3种方法小结

《SpringBoot实现数据库读写分离的3种方法小结》为了提高系统的读写性能和可用性,读写分离是一种经典的数据库架构模式,在SpringBoot应用中,有多种方式可以实现数据库读写分离,本文将介绍三... 目录一、数据库读写分离概述二、方案一:基于AbstractRoutingDataSource实现动态

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整

Springboot @Autowired和@Resource的区别解析

《Springboot@Autowired和@Resource的区别解析》@Resource是JDK提供的注解,只是Spring在实现上提供了这个注解的功能支持,本文给大家介绍Springboot@... 目录【一】定义【1】@Autowired【2】@Resource【二】区别【1】包含的属性不同【2】@

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

Java枚举类实现Key-Value映射的多种实现方式

《Java枚举类实现Key-Value映射的多种实现方式》在Java开发中,枚举(Enum)是一种特殊的类,本文将详细介绍Java枚举类实现key-value映射的多种方式,有需要的小伙伴可以根据需要... 目录前言一、基础实现方式1.1 为枚举添加属性和构造方法二、http://www.cppcns.co

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J