https://github.com/xygengcn/node-mesh

Master - Branch 形式 Nodejs 微服务框架
https://github.com/xygengcn/node-mesh

Last synced: 9 days ago
JSON representation

Master - Branch 形式 Nodejs 微服务框架

• Host: GitHub
• URL: https://github.com/xygengcn/node-mesh
• Owner: xygengcn
• Created: 2023-02-13T14:29:00.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-14T06:45:41.000Z (12 months ago)
• Last Synced: 2024-03-15T07:24:14.321Z (10 months ago)
• Language: TypeScript
• Size: 231 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Master - Branch 形式 Nodejs 微服务框架

## 一、用法(Usage)

Master 和 Branch 可以是不同文件的不同进程，为了方便示例，都放在同一个文件

### 1、 Request - Response

---

```ts

import { Master, Branch } from 'node-mesh';

const actions = {

    add: (a: number, b: number): number => {

        return a + b;

    }

};

const actions2 = {

    add2: (a: number, b: number): number => {

        return a + b + 1;

    }

};

const master1 = new Master('master1', { port: 3010 });

const branch1 = new Branch('branch1', { port: 3010 });

// 批量注册方法

master1.createResponder(actions2);

// 创建请求者

const masterReq = master1.createRequester();

// 批量注册方法

branch1.createResponder(actions);

// 创建请求者

const branchReq = branch1.createRequester();

// 请求

branchReq.add(11, 11).then((result) => {

    console.log('result1', result); // 22

});

// 请求

branchReq.add2(22, 22).then((result) => {

    console.log('result2', result); // 45

});

// 请求

masterReq.add(33, 33).then((result) => {

    console.log('result3', result); // 66

});

// 请求

masterReq.add2(44, 44).then((result) => {

    console.log('result4', result); // 89

});

```

### 2、Subscribe - Publish

---

```ts

import { Master, Branch } from 'node-mesh';

const master1 = new Master('master1', { port: 3010 });

const branch1 = new Branch('branch1', { port: 3010, master: 'master1' });

// Subscribe

master1.subscribe('sub/test', (error, content) => {

    console.log(555, content); // content === sub

});

// Publish

branch1.publish('sub/test', 'sub');

```

## 二、原理(Design)

### 1、客户端与服务端绑定(bind)

---

客户端与服务端建立 connect，客户端发出绑定通知，服务端接收绑定通知，校验返回结果，完成绑定

### 2、单主分支(branch)

---

master 启动 -》 branch 建立链接 -》 注册 action 到 master 缓存 -》 通知其他分支上线

分支请求动作 -》 检查自己有没有 action -》 检查有没有缓存 action -》 请求 action

分支下线 -》 清除 master 上的分支 action 缓存 -》 通知其他分支下线

## 三、错误列表(Error)

```ts

export enum CustomErrorCode {

    success = "OK", // 成功

    none = "NONE", // 未知

    requestTimeout = "REQUEST_TIMEOUT", // 请求超时

    bindError = "BIND_ERROR", // 绑定失败

    requestParamsError = "REQUEST_PARAM_ERROR", // 请求参数问题

    bindTimeout = "BIND_TIMEOUT", // 绑定超时

    actionNotExist = "ACTION_NOT_EXIST", // 动作不存在

    actionSocketNotActive = "ACTION_SOCKET_NOT_ACTIVE" // socket不在线或者不存在

}

```