介紹
相信很多公司都有自己的SaaS產(chǎn)品,針對(duì)小客戶可以使用現(xiàn)有的業(yè)務(wù)邏輯讓客戶去適應(yīng)SaaS中提供的業(yè)務(wù)功能,但不缺乏有很多大公司或者大客戶去使用SaaS產(chǎn)時(shí),現(xiàn)有功能不能滿足其業(yè)務(wù)去修耐朴，需要針對(duì)某些業(yè)務(wù)功能去基于現(xiàn)有的 SaaS產(chǎn)品去做定制化功能。由于是SaaS產(chǎn)品举反，不能任由客戶隨意進(jìn)行業(yè)務(wù)修改儡毕。這時(shí)候微內(nèi)核架構(gòu)的產(chǎn)品設(shè)計(jì)方案非常適合這種情況。
微內(nèi)核架構(gòu)
如下圖可見(jiàn)玛瘸，微內(nèi)核架構(gòu)核心思想主要是以下兩點(diǎn)媒峡。
微內(nèi)核架構(gòu)包含兩類組件：核心系統(tǒng)（core system）和插件模塊（plug-in modules）
應(yīng)用邏輯被分割為獨(dú)立的插件模塊和核心系統(tǒng)淤年，提供了可擴(kuò)展性钧敞、靈活性蜡豹、功能隔離和自定義處理邏輯的特性。
設(shè)計(jì)關(guān)鍵
- 插件管理:核心系統(tǒng)需要知道當(dāng)前有哪些插件可用溉苛，如何加載這些插件镜廉，什么時(shí)候加載插件。常見(jiàn)的實(shí)現(xiàn)方法是插件注冊(cè)表機(jī)制愚战。核心系統(tǒng)提供插件注冊(cè)表（可以是配置文件桨吊，也可以是代碼，還可以是數(shù)據(jù)庫(kù)）凤巨，插件注冊(cè)表含有每個(gè)插件模塊的信息视乐，包括它的名字、位置敢茁、加載時(shí)機(jī)（啟動(dòng)就加載佑淀，還是按需加載）等。
- 插件連接: 插件連接指插件如何連接到核心系統(tǒng)彰檬。通常來(lái)說(shuō)伸刃，核心系統(tǒng)必須制定插件和核心系統(tǒng)的連接規(guī)范，然后插件按照規(guī)范實(shí)現(xiàn)逢倍，核心系統(tǒng)按照規(guī)范加載即可捧颅。
- 插件通信: 插件通信指插件間的通信。雖然設(shè)計(jì)的時(shí)候插件間是完全解耦的较雕，但實(shí)際業(yè)務(wù)運(yùn)行過(guò)程中碉哑，必然會(huì)出現(xiàn)某個(gè)業(yè)務(wù)流程需要多個(gè)插件協(xié)作，這就要求兩個(gè)插件間進(jìn)行通信亮蒋。由于插件之間沒(méi)有直接聯(lián)系扣典，通信必須通過(guò)核心系統(tǒng)，因此核心系統(tǒng)需要提供插件通信機(jī)制慎玖。
原文鏈接： 架構(gòu)：微內(nèi)核架構(gòu)（Microkernel Architecture）
如何基于SpringBoot實(shí)現(xiàn)微內(nèi)核架構(gòu)
從 Spring Framework 3.1 開(kāi)始贮尖，允許在 Bean 裝配時(shí)增加前置條件判斷。也就是說(shuō)可以在Bean裝配時(shí)根據(jù)一些條件選擇對(duì)應(yīng)的Bean進(jìn)行注冊(cè)以及實(shí)例化趁怔。本次主要介紹的實(shí)現(xiàn)方案
基于多態(tài)特性
基于 自定義
@Conditional注解基于 默認(rèn)
@ConditionalOnMissingBean注解
微內(nèi)核Demo
如圖所示,我們現(xiàn)在有一個(gè) Say World 的微內(nèi)核架構(gòu)的系統(tǒng)湿硝，這個(gè)系統(tǒng)的核心功能就是輸出不同的 Say World .此次提供默認(rèn)實(shí)現(xiàn)，并提供擴(kuò)展點(diǎn)來(lái)進(jìn)行不同租戶的實(shí)現(xiàn)润努。
適用于多個(gè)租戶共享一個(gè)代碼倉(cāng)庫(kù)地址或者另外引入插件jar包关斜，根據(jù)外部化配置實(shí)現(xiàn)插件的條件裝配
- 擴(kuò)展點(diǎn): SayWorld
- Default：輸出 "Default Plugin: Say Hello World"
- Tenant-china：輸出 "China Plugin: Say Hello World"
- Tenant-india: 輸出 "India Plugin: Say Hello World"
具體實(shí)現(xiàn)
接下來(lái)我們就來(lái)實(shí)現(xiàn)一下 這個(gè)多租戶的場(chǎng)景。 本次只是講如何實(shí)現(xiàn)任连，具體實(shí)現(xiàn)原理蚤吹，后期會(huì)補(bǔ)充例诀。
1.基于多態(tài)特性 定義 SayWorld 接口
public interface SayWorld {
String sayWorld();
}
2.基于 @Conditional 注解 自定義條件判斷邏輯
1.自定義 注解 @PluginCondition
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPluginCondition.class)
public @interface PluginCondition {
String tenant() default "default";
}
2.實(shí)現(xiàn) OnPluginCondition
public class OnPluginCondition implements Condition {
private static String TENANT_KEY = "tenant";
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
//獲取當(dāng)前類中注解PluginCondition的所有屬性
Map<String,Object> attributes = metadata.getAnnotationAttributes(PluginCondition.class.getName());
//獲取 租戶代碼
String tenant = String.valueOf(attributes.get(TENANT_KEY));
//獲取當(dāng)前應(yīng)用的環(huán)境變量 包括外部化配置
Environment environment = context.getEnvironment();
//獲取外部化配置值
String environmentTenant = environment.getProperty(TENANT_KEY);
//如果為空 則默認(rèn)賦值 default 啟動(dòng)默認(rèn)插件
if(!StringUtils.hasLength(environmentTenant)) {
environmentTenant = "default";
}
//返回條件判斷結(jié)果
return tenant.equals(environmentTenant);
}
}
3. 定義默認(rèn)插件以及租戶插件
-
SayHelloWorldDefaultPlugin: 默認(rèn)SayWorld 插件實(shí)現(xiàn)
//判斷是否有該 插件類別的Bean 已經(jīng)注冊(cè)在容器中,如果沒(méi)有 則注冊(cè) 即注冊(cè)默認(rèn)的插件
@ConditionalOnMissingBean(value = {SayWorld.class},ignored = {SayHelloWorldDefaultPlugin.class})
@Service
public class SayHelloWorldDefaultPlugin implements SayWorld {
@Override
public String sayWorld() {
return "Default Plugin: Say Hello World";
}
}
-
SayHelloWorldChinaPlugin： China租戶的插件實(shí)現(xiàn)
/**
* @description: 條件裝配 租戶插件
* @author: Neal
* @date: 2022/11/21
**/
//自定義條件裝配注解 租戶code 為 China
@PluginCondition(tenant = "China")
@Service
public class SayHelloWorldChinaPlugin implements SayWorld {
@Override
public String sayWorld() {
return "China Plugin: Say Hello World";
}
}
-
SayHelloWorldIndiaPlugin: India 租戶的插件實(shí)現(xiàn)
//自定義條件裝配注解 租戶code 為 India
@PluginCondition(tenant = "India")
@Service
public class SayHelloWorldIndiaPlugin implements SayWorld {
@Override
public String sayWorld() {
return "India Plugin: Say Hello World";
}
}
4.測(cè)試類以及外部化配置
- 測(cè)試類
SayWorldController
@RequestMapping("/say/")
@RestController
public class SayWorldController {
private final SayWorld sayWorld;
//注入擴(kuò)展點(diǎn)的具體實(shí)現(xiàn)插件
public SayWorldController(SayWorld sayWorld) {
this.sayWorld = sayWorld;
}
@GetMapping("world")
public String sayWorld() {
return sayWorld.sayWorld();
}
}
- 外部化配置 (application.yml) : 可以修改對(duì)應(yīng)的租戶,查看返回結(jié)果随抠。
tenant: India
驗(yàn)證結(jié)果
- application.yml 中無(wú)
tenant屬性時(shí)
- application.yml 中
tenant: India時(shí)
Demo 地址: https://github.com/NealLemon/PluginDemo
小結(jié)
雖然這種微內(nèi)核架構(gòu)比較靈活裁着，但是相對(duì)的隨著擴(kuò)展點(diǎn)越來(lái)越多，侵入性就越來(lái)越強(qiáng)拱她，所以需要很強(qiáng)的架構(gòu)能力以及業(yè)務(wù)能力去分析可擴(kuò)展點(diǎn)以及具體擴(kuò)展細(xì)節(jié)二驰。 這種微內(nèi)核插件模式不是銀彈，也不適合所有的業(yè)務(wù)場(chǎng)景秉沼，謹(jǐn)慎使用桶雀。
