[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

相关文章

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1:定义时间段类步骤2:添加时间段步骤3:检查时间段是否有重合步骤4:输出结果示例代码结语作

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①:StringBui

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下:需要在

Java中ArrayList和LinkedList有什么区别举例详解

《Java中ArrayList和LinkedList有什么区别举例详解》:本文主要介绍Java中ArrayList和LinkedList区别的相关资料,包括数据结构特性、核心操作性能、内存与GC影... 目录一、底层数据结构二、核心操作性能对比三、内存与 GC 影响四、扩容机制五、线程安全与并发方案六、工程

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.