基于微内核架构实现多租户业务扩展

介绍

相信很多公司都有自己的SaaS产品,针对小客户可以使用现有的业务逻辑让客户去适应SaaS中提供的业务功能,但不缺乏有很多大公司或者大客户去使用SaaS产时,现有功能不能满足其业务去修，需要针对某些业务功能去基于现有的 SaaS产品去做定制化功能。由于是SaaS产品，不能任由客户随意进行业务修改。这时候微内核架构的产品设计方案非常适合这种情况。

微内核架构

如下图可见，微内核架构核心思想主要是以下两点。

微内核架构包含两类组件：核心系统（core system）和插件模块（plug-in modules）
应用逻辑被分割为独立的插件模块和核心系统，提供了可扩展性、灵活性、功能隔离和自定义处理逻辑的特性。

微内核架构图.png

设计关键

插件管理:核心系统需要知道当前有哪些插件可用，如何加载这些插件，什么时候加载插件。常见的实现方法是插件注册表机制。核心系统提供插件注册表（可以是配置文件，也可以是代码，还可以是数据库），插件注册表含有每个插件模块的信息，包括它的名字、位置、加载时机（启动就加载，还是按需加载）等。
插件连接: 插件连接指插件如何连接到核心系统。通常来说，核心系统必须制定插件和核心系统的连接规范，然后插件按照规范实现，核心系统按照规范加载即可。
插件通信: 插件通信指插件间的通信。虽然设计的时候插件间是完全解耦的，但实际业务运行过程中，必然会出现某个业务流程需要多个插件协作，这就要求两个插件间进行通信。由于插件之间没有直接联系，通信必须通过核心系统，因此核心系统需要提供插件通信机制。

原文链接：架构：微内核架构（Microkernel Architecture）

如何基于SpringBoot实现微内核架构

从 Spring Framework 3.1 开始，允许在 Bean 装配时增加前置条件判断。也就是说可以在Bean装配时根据一些条件选择对应的Bean进行注册以及实例化。本次主要介绍的实现方案

基于多态特性
基于自定义 @Conditional 注解
基于默认 @ConditionalOnMissingBean 注解

微内核Demo

如图所示,我们现在有一个 Say World 的微内核架构的系统，这个系统的核心功能就是输出不同的 Say World .此次提供默认实现，并提供扩展点来进行不同租户的实现。

PluginDemo架构图.png

适用于多个租户共享一个代码仓库地址或者另外引入插件jar包，根据外部化配置实现插件的条件装配

扩展点: SayWorld
- Default：输出 "Default Plugin: Say Hello World"
- Tenant-china：输出 "China Plugin: Say Hello World"
- Tenant-india: 输出 "India Plugin: Say Hello World"

具体实现

接下来我们就来实现一下这个多租户的场景。本次只是讲如何实现，具体实现原理，后期会补充。

1.基于多态特性定义 `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.实现 OnPluginCondition

public class OnPluginCondition implements Condition {
    private static String TENANT_KEY = "tenant";
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //获取当前类中注解PluginCondition的所有属性
        Map attributes = metadata.getAnnotationAttributes(PluginCondition.class.getName());
        //获取 租户代码
        String tenant = String.valueOf(attributes.get(TENANT_KEY));
        //获取当前应用的环境变量 包括外部化配置
        Environment environment = context.getEnvironment();
        //获取外部化配置值
        String environmentTenant = environment.getProperty(TENANT_KEY);
        //如果为空 则默认赋值 default 启动默认插件
        if(!StringUtils.hasLength(environmentTenant)) {
            environmentTenant = "default";
        }
        //返回条件判断结果
        return tenant.equals(environmentTenant);
    }
}

3. 定义默认插件以及租户插件

SayHelloWorldDefaultPlugin : 默认SayWorld 插件实现

//判断是否有该 插件类别的Bean 已经注册在容器中,如果没有 则注册 即注册默认的插件
@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租户的插件实现

/**
 * @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 租户的插件实现

//自定义条件装配注解 租户code 为 India
@PluginCondition(tenant = "India")
@Service
public class SayHelloWorldIndiaPlugin implements SayWorld {
    @Override
    public String sayWorld() {
        return "India Plugin: Say Hello World";
    }
}

4.测试类以及外部化配置

测试类 SayWorldController

@RequestMapping("/say/")
@RestController
public class SayWorldController {

    private final SayWorld sayWorld;


    //注入扩展点的具体实现插件
    public SayWorldController(SayWorld sayWorld) {
        this.sayWorld = sayWorld;
    }


    @GetMapping("world")
    public String sayWorld() {
        return sayWorld.sayWorld();
    }

}

外部化配置 (application.yml) : 可以修改对应的租户,查看返回结果。

tenant: India

验证结果

application.yml 中无 tenant 属性时

result1.png

application.yml 中 tenant: India 时

result2.png

Demo 地址: https://github.com/NealLemon/PluginDemo

小结

虽然这种微内核架构比较灵活，但是相对的随着扩展点越来越多，侵入性就越来越强，所以需要很强的架构能力以及业务能力去分析可扩展点以及具体扩展细节。这种微内核插件模式不是银弹，也不适合所有的业务场景，谨慎使用。