Spring-Smart-DI 動態(tài)切換實現(xiàn)類,很不錯!
在系統(tǒng)開發(fā)的實際場景中,我們常常會碰到這樣一類需求:同一個功能需要對接多個服務提供商。這么做主要基于兩個重要原因。其一,為了規(guī)避某個服務商的服務出現(xiàn)不可用的風險,以便在出現(xiàn)問題時能夠迅速切換到其他服務商,確保系統(tǒng)的穩(wěn)定性和業(yè)務的連續(xù)性;其二,不同服務商的收費標準存在差異,從成本控制的角度出發(fā),需要根據(jù)實際情況進行靈活切換。
傳統(tǒng)的快速切換邏輯實現(xiàn)方法是,先為每個服務商編寫對應的實現(xiàn)類,然后在配置點(這個配置點可以是數(shù)據(jù)庫,也可以是像 Nacos 這樣的配置中心)配置當前正在使用的服務商。在每次執(zhí)行相關業(yè)務邏輯時,都要從配置點獲取當前使用的服務商信息,再去執(zhí)行該服務商對應的業(yè)務邏輯。
以系統(tǒng)接入多個短信服務商為例,用戶可以根據(jù)自身需求動態(tài)地在不同服務商之間進行切換。下面我們詳細看看如果手動實現(xiàn)這個功能,具體步驟是怎樣的。
第一步,在某個配置位置(例如 Nacos 或者數(shù)據(jù)庫)配置當前使用的服務商對應的標識值。比如,我們設置 sms.impl = "某騰短信"
。
第二步,在代碼中執(zhí)行發(fā)短信操作時,手動獲取 sms.impl
對應的服務商實現(xiàn)類。以下是相應的偽代碼示例:
void sendSmsTouser(Req req) {
// 1、獲取當前使用的服務商
String name = get("sms.impl");
// 2、獲取對應的實現(xiàn)類
SmsService smsService = springContext.getBean(name);
// 3、使用 smsService 執(zhí)行具體業(yè)務邏輯
smsService.sendMsg(req);
}
不過,這種實現(xiàn)方式存在明顯的弊端,它比較繁瑣,每次執(zhí)行都需要手動去獲取配置并加載對應的實現(xiàn)類。那么,有沒有一種更優(yōu)雅的方式,讓 Spring 的 @Autowired
注解在注入時能夠自動根據(jù)配置點的配置去注入對應的實現(xiàn)類,并且當配置發(fā)生變化時,注入的實現(xiàn)類也能自動更新呢?spring-smart-di
的 AutowiredProxySPI
就是為解決這個問題而精心設計的。
1. spring-smart-di 簡介
spring-smart-di
是對 Spring @Autowired
注解的一次創(chuàng)新性擴展,它為用戶提供了自定義 Autowired
注入邏輯的能力。目前,它實現(xiàn)了兩個非常重要的注解:@SmartAutowired
和 @AutowiredProxySPI
。在本文中,我們將重點聚焦于如何使用 AutowiredProxySPI
來實現(xiàn)動態(tài)切換服務提供商的功能。
假設我們的系統(tǒng)對接了多個短信服務商,下面我們通過一個快速上手的案例,詳細了解如何使用 AutowiredProxySPI
來實現(xiàn)動態(tài)切換。
2、快速開始
2.1 引入依賴
首先,我們需要在項目中引入 spring-smart-di
的依賴。在 Maven 項目的 pom.xml
文件中添加以下依賴代碼:
<dependency>
<groupId>io.github.burukeyou</groupId>
<artifactId>spring-smart-di-all</artifactId>
<version>0.2.0</version>
</dependency>
2.2 啟用功能
在 Spring 配置類上標記 @EnableSmartDI
注解,以此來啟用 spring-smart-di
的強大功能。
2.3 @EnvironmentProxySPI
注解的使用
@EnvironmentProxySPI
注解代表著一個配置點,其主要作用是配置如何獲取具體實現(xiàn)類的邏輯。
假設我們的系統(tǒng)中有兩個短信服務商,需要實現(xiàn)動態(tài)切換。我們需要在接口上配置 @EnvironmentProxySPI
注解,表示從環(huán)境變量配置點中獲取當前使用的服務商。這里我們將配置信息存儲在屬性 ${sms.impl}
中。
@EnvironmentProxySPI("${sms.impl}")
publicinterface SmsService {
}
// 給實現(xiàn)類定義別名
@BeanAliasName("某騰短信服務")
@Component
publicclass ASmsService implements SmsService {
}
@BeanAliasName("某移短信服務")
@Component
publicclass BSmsService implements SmsService {
}
2.4 配置當前使用的服務商
我們可以在配置文件中配置當前使用的服務商。配置的值可以是 @BeanAliasName
注解指定的值,也可以是 @Component
注解指定的值,還可以是具體的全路徑類名。
sms:
impl: 某移短信服務
2.5 @AutowiredProxySPI
注入使用
接下來,我們只需要像使用 @Autowired
注解一樣使用 @AutowiredProxySPI
注解即可。
// 依賴注入
@AutowiredProxySPI
private SmsService smsService;
通過以上步驟,我們就成功完成了動態(tài)切換服務提供商的需求。只要我們改變配置屬性 ${sms.impl}
的值,系統(tǒng)就會實時生效,而無需重啟服務。這是因為 @AutowiredProxySPI
注入的是一個代理對象,每次執(zhí)行時會先實時獲取當前使用的實現(xiàn)類,然后再執(zhí)行調(diào)用操作。并且,在使用上與直接使用 @Autowired
注解基本沒有區(qū)別。
2.6 定義不同的配置點
@EnvironmentProxySPI
注解主要用于配置環(huán)境變量相關的配置點。如果我們想要自定義配置,例如從數(shù)據(jù)庫中獲取配置信息,可以實現(xiàn)自己的 ProxySPI
注解。
下面是一個自定義 DBProxySPI
注解的示例,我們需要標記上 @ProxySPI
注解,并指定具體的配置獲取邏輯實現(xiàn)類 AnnotationProxyFactory
。
@Inherited
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@ProxySPI(DbProxyFactory.class) // 指定配置獲取邏輯
public @interface DBProxySPI {
String value();
}
@Component
publicclass DbProxyFactory implements AnnotationProxyFactory<DBProxySPI> {
@Autowired
private SysConfigMapper sysConfigDao;
@Override
public Object getProxy(Class<?> targetClass, DBProxySPI spi) {
// 根據(jù)注解從數(shù)據(jù)庫獲取要注入的實現(xiàn)類
String configName = sysConfigDao.getConfig(spi.value());
return springContext.getBean(configName);
}
}
@DBProxySPI("${sms.impl}")
publicinterface SmsService {
}
通過以上的步驟,我們就可以靈活地實現(xiàn)動態(tài)切換服務提供商的功能,并且可以根據(jù)不同的需求自定義配置獲取邏輯。spring-smart-di
為我們提供了一種簡潔、高效的方式來處理這種動態(tài)切換的場景,讓我們的代碼更加靈活和易于維護。