micro-rpckit

一个基于主从架构的微前端 RPC 通信框架，专注于提供标准化的跨应用通信解决方案。

特性

1. 主从架构

• 清晰的主从应用分离
• 标准化的 RPC 通信
• 支持 iframe/同域运行环境

2. 服务管理

• 声明式服务 API 定义
• 类型安全的接口调用
• 事件驱动通信

3. 权限控制

• 应用/服务/API 多级权限
• 灵活的权限策略
• 安全通信机制

系统架构

核心组件关系

                    Rpckit (全局管理)
                         |
                         |
                    ServTerminal (终端)
                    /           \
                   /             \
        ServServiceServer    ServServiceClient
        (服务端)              (客户端)

组件说明

1. Rpckit

   • 框架核心类
   • 管理终端实例
   • 提供全局服务
   • 处理生命周期

2. ServTerminal

   • 终端实现
   • 管理通信通道
   • 处理消息路由
   • 维护会话状态

3. ServSession

   • 会话管理
   • 连接状态维护
   • 消息队列处理
   • 超时控制

4. ServServiceManager

   • 服务注册与发现
   • 服务版本管理
   • 服务健康检查
   • 服务降级处理

5. ServService

   • 服务定义
   • API 实现
   • 类型声明
   • 权限控制

6. ServEventer

   • 事件管理
   • 消息订阅
   • 事件分发
   • 状态同步

通信流程

1. 服务注册流程

Rpckit -> ServTerminal -> ServServiceServer

• Rpckit 管理全局服务
• 终端协调服务注册
• 服务端实现具体服务

2. 服务调用流程

ServServiceClient -> ServTerminal -> ServServiceServer

• 客户端发起服务调用
• 终端处理消息路由
• 服务端执行服务逻辑

3. 数据流向

[客户端]                    [终端]                    [服务端]
   |                         |                         |
   |-- 服务调用请求 -------->|                         |
   |                         |-- 转发请求 ----------->|
   |                         |                         |
   |                         |<-- 返回响应 -----------|
   |<-- 返回响应 ------------|                         |

组件职责

1. Rpckit

   • 全局服务管理
   • 终端生命周期管理
   • 全局配置管理
   • 全局事件管理

2. ServTerminal

   • 通信通道管理
   • 组件协调
   • 会话管理
   • 资源管理

3. ServServiceServer

   • 服务注册
   • 请求处理
   • 服务实现
   • 权限控制

4. ServServiceClient

   • 服务发现
   • 请求发送
   • 响应处理
   • 错误处理

扩展机制

1. 插件系统

   • 中间件支持
   • 生命周期钩子
   • 自定义扩展
   • 能力增强

2. 适配器

   • 运行环境适配
   • 通信协议适配
   • 数据格式适配
   • 安全策略适配

使用场景

1. 微前端应用

// 主应用
const host = new SappSDK({
    id: 'host-app',
    type: 'master'
});

// 注册服务
@ServService()
class UserService {
    @ServAPI()
    async getUserInfo() {
        return { name: 'John' };
    }
}

// 从应用
const slave = new SappSDK({
    id: 'slave-app',
    type: 'slave'
});

// 调用主应用服务
const userService = await slave.getService('UserService');
const userInfo = await userService.getUserInfo();

2. iframe 通信

// 主应用
const host = new SappSDK({
    id: 'host-app',
    type: 'master'
});

// 打开 iframe
const iframe = await host.openIframe({
    url: 'https://slave-app.com',
    id: 'slave-1'
});

// 从应用
const slave = new SappSDK({
    id: 'slave-app',
    type: 'slave'
});

// 监听主应用消息
slave.on('message', async (message) => {
    const hostService = await slave.getService('HostService');
    return await hostService.handleMessage(message);
});

3. 小程序开发

// 平台应用
const platform = new SappSDK({
    id: 'platform-app',
    type: 'master'
});

// 注册平台能力
@ServService()
class PlatformService {
    @ServAPI()
    async getLocation() {
        return { lat: 0, lng: 0 };
    }
}

// 小程序
const miniApp = new SappSDK({
    id: 'mini-app',
    type: 'slave'
});

// 使用平台能力
const platformService = await miniApp.getService('PlatformService');
const location = await platformService.getLocation();

快速开始

安装

npm install micro-rpckit
# 或
yarn add micro-rpckit

基础示例

import { SappSDK, ServService, ServAPI } from 'micro-rpckit';

// 创建应用实例
const app = new SappSDK({
    id: 'my-app',
    type: 'master'
});

// 定义服务
@ServService()
class MyService {
    @ServAPI()
    async hello(name: string) {
        return `Hello, ${name}!`;
    }
}

// 初始化并启动
await app.init();
await app.start();

开发背景

• GUI 应用 H5 化

  • 传统原生应用向 H5 技术迁移
  • 需要处理更复杂的软件工程问题
  • 提供更好的开发体验和生产效率

• 云端化趋势

  • 终端应用向云端迁移
  • 需要处理大规模工程问题
  • 提供更好的系统架构支持

• 开放能力需求

  • 支持 SAAS 服务开放
  • 提供标准化的接入方案
  • 支持生态建设

贡献指南

欢迎提交 Issue 和 Pull Request。

许可证

MIT