stone-framework

v1.0.25

Published

17 days ago

Node.js + Typescript server framework

Downloads

1,424

0High
0Medium
0Low

threstone

概况

Node.js后端多进程框架,支持动态扩容、销毁,使用Typescript实现。

特性

使用配置决定服务端进程启动方式。
支持RPC函数定义自动生成,更多代码提示。
根据进程(nodeId)生成对应附带堆栈信息输出,Error级别输出单独输出,方便查错。
提供命令模块,支持动态扩容、销毁。

使用

1. 项目初始化

全局安装Typescript依赖(用于编译js代码):

npm install -g typescript

安装框架:

npm install -g stone-framework

创建目录:stoneDemo

mkdir stoneDemo
cd stoneDemo

进入目录使用脚手架初始化项目:

stone init

安装项目依赖:

npm install

编译代码:

tsc

启动项目:

stone startAll dev

stoneDemo目录文件结构如下:

│  index.ts
│  package.json
│  publish.bat                          // 发布脚本
│  tsconfig.json
│  tsconfig_dist.json
│
├─app
│  │  RpcIndex.ts                       // RPC方法定义
│  │  StoneIndex.ts                     // 框架提供的一些全局定义
│  │
│  └─servers
│      └─server_template                // server目录
│          ├─config                     // 用于存放此服务所需配置,可删除
│          │      config.json
│          │
│          └─src                        // 源码文件夹
│              ├─bin
│              │      main.ts           // 服务入口文件
│              │
│              ├─remote                 // RPC文件存放目录
│              │      DemoRemote.ts     // 自定义RCP类
│              │
│              └─test                   // 单元测试目录,可删除
│                      Test.test.ts 
│
└─config                                // 全局配置目录,用于存放一些公共配置
        servers.json                    // servers配置

2. 服务创建

打开 app\servers\ 可以看到脚手架工具已经生成了一个模板服务server_template。 server_template的目录如下:

├─config
│      config.json
│
└─src
    ├─bin
    │      main.ts
    │
    ├─remote
    │      DemoRemote.ts
    │
    └─test
            Test.test.ts

除了入口文件外,所有其他文件及文件夹都可以删除,但如果要定义远程调用函数,则必须定义在src\remote\内。

3. 配置启动服务

打开config\servers.json将看到如下信息:

{
    "dev": {
        "master": {
            "ip": "127.0.0.1",
            "port": 999,
            "rpcPorts": [
                995
            ],
            "isTest": true
        },
        "server_template": [
            {
                "nodeId": "server_template1",
                "ip": "127.0.0.1",
                "autuResume": true
            },
            {
                "nodeId": "server_template2",
                "ip": "127.0.0.1",
                "autuResume": true
            }
        ]
    }
}

其中 dev 表示环境,正常情况下服务可能包含多个环境如dev test prod, master为框架管理程序,管理整个后端服务的创建,每个环境下master的配置必不可少。

接下来server_template为servers中新建的服务,名称必须一一对应,而server_template的值为一个数组,其中有多少个元素,就会启动多少个server_template实例,并且元素内的所有内容都将被作为启动参数带入服务。自定义服务的值都必须为数组。具体含义如下注释:

{
    "dev": {
        "master": {
            "ip": "127.0.0.1",                      // master ip 目前暂不支持创建服务于其他机器上，此参数暂时无用
            "port": 999,                            // 命令监听端口
            "rpcPorts": [                           // RPC 监听端口列表,配置多少个元素将启动对应数量的RPC Server
                995
            ],
            "isTest": true                          // 表明是否测试环境,测试环境下每次启动都会重新生成RPC Typescript定义文件
        },
        "server_template": [
            {
                "nodeId": "server_template1",       // 自定义进程名称
                "ip": "127.0.0.1",                  // 目前暂不支持创建服务于其他机器上，此参数暂时无用
                "autuResume": true                  // 是否自动重启
            },
            {
                "nodeId": "server_template2",       // 自定义进程名称
                "ip": "127.0.0.1",                  // 目前暂不支持创建服务于其他机器上，此参数暂时无用
                "autuResume": true                  // 是否自动重启
            }
        ]
    }
}

所以此配置的含义为启动两个server_template服务实例,分别为server_template1和server_template2

4. 启动服务

由于项目完全由typescript编写,所以每当修改typescript代码,都需要在项目下执行命令以编译javascript代码:

tsc

当然正常开发环境下一般都使用如下命令开启代码监听,减少每次修改都需要执行tsc编译的繁琐操作:

tsc -w

确保编译后在命令行中执行以下命令启动服务:

stone startAll dev

启动后将看到日志输出:

[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcServer.ts:12:16] [2024-04-17T14:28:25.240] [INFO] [RPC995] [40920] rpc server start, port:995
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\master\src\GlobalVar.ts:9:16] [2024-04-17T14:28:25.270] [INFO] [master] [25056] init ...
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\master\src\CommandServer.ts:15:20] [2024-04-17T14:28:25.283] [INFO] [master] start common server successfully, port:999
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:3:8] [2024-04-17T14:28:25.392] [INFO] [server_template2] init...
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:3:8] [2024-04-17T14:28:25.392] [INFO] [server_template1] init...
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcClient.ts:74:20] [2024-04-17T14:28:26.915] [INFO] [server_template1] server_template1[40280] connect rpc server successfully
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcClient.ts:74:20] [2024-04-17T14:28:26.916] [INFO] [server_template2] server_template2[32820] connect rpc server successfully
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.918] [INFO] [server_template1] hahaha
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:9:12] [2024-04-17T14:28:26.919] [INFO] [server_template1] rpc.server_template.demoRemote.callLog result:hahaha
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.920] [INFO] [server_template1] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.921] [INFO] [server_template1] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.921] [INFO] [server_template1] hahaha2
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.922] [INFO] [server_template2] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.925] [INFO] [server_template2] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.925] [INFO] [server_template2] hahaha2
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:26.937] [INFO] [server_template2] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:27.933] [INFO] [server_template2] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:28.931] [INFO] [server_template2] hahaha2

通过日志可以看到创建的server_template1与server_template2进程成功启动了。

具体关于stone的命令可以执行如下命令查看帮助:

stone -h

5. RPC使用

RPC为后端各个进程之间通讯的主要方式,本框架提供简单且附带代码提示的的远程调用方式。

1.定义远程方法

打开app\servers\server_template\src\remote\DemoRemote.ts,可以看到如下脚手架工具已经创建好的RPC函数:

export class DemoRemote {
    /** 定义一个方法打印参数并返回 */
    log(str: string): string {
        logger.log(str);
        return str;
    }

    /** 在一定时间后打印参数并返回 */
    async delayLog(str: string, delayTime: number): Promise<string> {
        await new Promise<void>((resolve) => {
            setTimeout(() => {
                resolve();
            }, delayTime);
        })
        logger.log(str);
        return str;
    }
}

修改代码后执行stone updateRpcDesc将生成对应的定义文件于app\RpcIndex.ts中, 后续每一次修改RPC函数,都需要执行此命令以更新定义,或者在测试环境下启动项目将自动更新RPC定义文件。 app\RpcIndex.ts中RPC定义如下:

declare interface RpcRouterOptions {
    type?: number | 0/* random */ | 1/* target */ | 2/* all */;
    nodeId?: string;
}
        
declare class rpc {
    static server_template: typeof Server_template;
}

declare class Server_template {
    static demoRemote: typeof Server_template_DemoRemote;
}

declare class Server_template_DemoRemote {
    static callLog(routeOption: RpcRouterOptions, str: string): Promise<string>;
    static sendLog(routeOption: RpcRouterOptions, str: string): void;
    static callDelayLog(routeOption: RpcRouterOptions, str: string, delayTime: number): Promise<string>;
    static sendDelayLog(routeOption: RpcRouterOptions, str: string, delayTime: number): void;
}

其中以call为开头的方法将接收RPC函数的返回值,而send为开头的方法将不关注返回值。

2.测试远程方法

打开 app\servers\server_template\src\bin\main.ts 代码如下:

import { StoneEvent, RpcRouteType } from "stone-framework";

logger.info('init...');
if (serverConfig.nodeId === 'server_template1') {
    eventEmitter.once(StoneEvent.RpcServerConnected, rpcTest.bind(this));
}
async function rpcTest() {
    const result = await rpc.server_template.demoRemote.callLog({ type: RpcRouteType.Random }, 'hahaha');
    logger.info(`rpc.server_template.demoRemote.callLog result:${result}`);

    for (let index = 0; index < 3; index++) {
        rpc.server_template.demoRemote.sendLog({ type: RpcRouteType.All }, `hahaha${index}`);
    }

    for (let index = 0; index < 3; index++) {
        rpc.server_template.demoRemote.sendDelayLog({ type: RpcRouteType.Target, nodeId: 'server_template2' }, `hahaha${index}`, index * 1000);
    }
}

rpc.server_template.demoRemote.callLog表示为命名空间.服务器类型.远程调用类.远程调用方法 远程调用第一个参数恒为routeOption,用来决定远程调用的目标,支持随机目标、指定目标、和所有目标。

编译执行代码后将获得如下输出:

[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcServer.ts:12:16] [2024-04-17T14:28:25.240] [INFO] [RPC995] [40920] rpc server start, port:995
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\master\src\GlobalVar.ts:9:16] [2024-04-17T14:28:25.270] [INFO] [master] [25056] init ...
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\master\src\CommandServer.ts:15:20] [2024-04-17T14:28:25.283] [INFO] [master] start common server successfully, port:999
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:3:8] [2024-04-17T14:28:25.392] [INFO] [server_template2] init...
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:3:8] [2024-04-17T14:28:25.392] [INFO] [server_template1] init...
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcClient.ts:74:20] [2024-04-17T14:28:26.915] [INFO] [server_template1] server_template1[40280] connect rpc server successfully
[C:\Users\yw\AppData\Roaming\npm\node_modules\stone-framework\common\core\rpc\RpcClient.ts:74:20] [2024-04-17T14:28:26.916] [INFO] [server_template2] server_template2[32820] connect rpc server successfully
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.918] [INFO] [server_template1] hahaha
[D:\threstone\stoneDemo\app\servers\server_template\src\bin\main.ts:9:12] [2024-04-17T14:28:26.919] [INFO] [server_template1] rpc.server_template.demoRemote.callLog result:hahaha
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.920] [INFO] [server_template1] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.921] [INFO] [server_template1] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.921] [INFO] [server_template1] hahaha2
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.922] [INFO] [server_template2] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.925] [INFO] [server_template2] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:4:16] [2024-04-17T14:28:26.925] [INFO] [server_template2] hahaha2
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:26.937] [INFO] [server_template2] hahaha0
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:27.933] [INFO] [server_template2] hahaha1
[D:\threstone\stoneDemo\app\servers\server_template\src\remote\DemoRemote.ts:15:16] [2024-04-17T14:28:28.931] [INFO] [server_template2] hahaha2

6. 服务发布

publish.bat

7. 参考

Anduin

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

概况

特性

使用