feat: init tl-ngrpc project

Author: iamtsm

LICENSE

@@ -0,0 +1,8 @@
+MIT License
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,85 @@
+# tl-ngrpc
+
+极简node-grpc依赖包，无关业务，只做规约， 支持两种服务端，http服务, socket服务
+
+### server
+
+实体模型 Teacher 为例, 编写proto文件
+
+```proto
+// teacher.proto
+syntax = "proto3";
+
+package api;
+
+service Teacher {
+    rpc hello (Request) returns (Response) {}
+}
+message Request {
+    string message = 1;
+}   
+message Response {
+    string message = 1;
+}
+```
+
+**启动服务**
+
+```js
+const TlApiRpcServer = require("xx/xx/TlApiRpcServer");
+const path = require("path")
+
+const teacherApiRpcServer = new TlApiRpcServer({
+    protoPath: path.resolve(__dirname, '../proto/api/teacher.proto'), //proto文件路径
+    protoName : "teacher", //proto文件名称
+    protoPackage : "api", //proto文件定义的package 
+    protoImpl : "Teacher", //proto定义的实体结构
+    ip : "127.0.0.1", //服务监听ip
+    port : 50051 //服务监听端口
+});
+
+//启动服务端
+teacherApiRpcServer
+//监听接口事件，并定义处理逻辑
+.on("hello", (call, callback) => {
+    console.log("服务端收到请求hello, 开始处理 : ", call.request.message);
+    callback(null, {message: 'Hello ' + call.request.message});
+})
+//监听接口事件，并定义处理逻辑
+.on("hello1", (call, callback) => {
+    console.log("服务端收到请求hello1, 开始处理 : ", call.request.message);
+    callback(null, {message: 'Hello1 ' + call.request.message});
+})
+//启动服务
+.start();
+```
+
+
+### client
+
+```js
+const TlApiRpcClient = require("../client/api/TlApiRpcClient");
+const path = require("path")
+
+const teacherApiRpcClient = new TlApiRpcClient({
+    protoPath: path.resolve(__dirname, '../proto/api/teacher.proto'), //proto文件路径
+    protoName : "teacher", //proto文件名称
+    protoPackage : "api", //proto文件定义的package 
+    protoImpl : "Teacher",  //proto定义的实体结构
+    ip : "127.0.0.1", //服务监听ip
+    port : 50051 //服务监听端口
+});
+
+//启动客户端
+(async ()=>{
+    //调用服务接口
+    let res = await teacherApiRpcClient.emit("hello", {message : "i am hello"})
+    console.log("客户端收到hello结果 : ", res);
+
+    //调用服务接口
+    res = await teacherApiRpcClient.emit("hello1", {message : "i am hello1"})
+    console.log("客户端收到hello1结果 : ", res);
+})()
+```
+
+#### socket服务同理，用法完全一致

TlRpc.js

@@ -0,0 +1,117 @@
+const { loadProtoInstance, modeEnum } = require("./comm/comm");
+const TlRpcConfig = require("./config/TlRpcConfig");
+
+/**
+ * rpc-client, rpc-server通用类
+ * 负责proto定义的加载和初始化
+ * @version 1.0.0
+ * @author iamtsm
+ */
+class TlRpc {
+    /**
+     * -- 私有属性
+     * api proto实例
+     */
+    static #apiProtoInstance = new Map();
+
+    /**
+     * -- 私有属性
+     * socket proto实例
+     */
+    static #socketProtoInstance = new Map();
+
+    /**
+     * -- 公共属性
+     * rpc 配置
+     */
+    static #configInstance = new TlRpcConfig({
+        protoName : "", protoPackage : "", protoImpl : "", ip : "", port : ""
+    });
+
+    /**
+     * 初始化
+     */
+    constructor(rpcConfig) {
+        TlRpc.#configInstance = new TlRpcConfig(rpcConfig);
+    }
+
+    /**
+     * -- 私有方法
+     * 获取proto文件对象
+     * @returns proto instance
+     */
+    #protoInstance() {
+        return loadProtoInstance(TlRpc.#configInstance.protoPath)
+    }
+
+    /**
+     * 获取缓存proto instance key
+     * @returns 
+     */
+    #getCacheProtoKey(){
+        return TlRpc.#configInstance.protoName + "-" + TlRpc.#configInstance.protoPackage;
+    }
+
+    /**
+     * -- 私有方法
+     * 从缓存获取proto对象
+     * @returns proto cache instance
+     */
+    #cacheProtoInstance() {
+        let instance = null;
+        const cacheKey = this.#getCacheProtoKey();
+
+        if (TlRpc.#configInstance.mode === modeEnum.API) {
+            instance = TlRpc.#apiProtoInstance.get(cacheKey);
+            if (!instance) {
+                instance = this.#protoInstance();
+            }
+            TlRpc.#apiProtoInstance.set(cacheKey, instance)
+        } else if (TlRpc.#configInstance.mode === modeEnum.SOCKET) {
+            instance = TlRpc.#socketProtoInstance.get(cacheKey);
+            if (!instance) {
+                instance = this.#protoInstance();
+            }
+            TlRpc.#socketProtoInstance.set(cacheKey, instance)
+        }
+        
+        return instance;
+    }
+
+    /**
+     * -- 私有方法
+     * 获取package对象
+     * @returns package instance
+     */
+    #packageInstance(){
+        const instance = this.#cacheProtoInstance();
+        if (!instance) {
+            return null;
+        }
+        return instance[TlRpc.#configInstance.protoPackage];
+    }
+
+    /**
+     * -- 私有方法
+     * 获取实例化impl对象
+     * @returns protoImpl instance
+     */
+    implInstance() {
+        const instance = this.#packageInstance();
+        if (!instance) {
+            return null;
+        }
+        return instance[TlRpc.#configInstance.protoImpl];
+    }
+
+    /**
+     * -- 对外提供
+     * 获取rpc配置
+     * @returns 
+     */
+    getConfig(){
+        return TlRpc.#configInstance;
+    }
+}
+
+module.exports = TlRpc;

TlRpcClient.js

@@ -0,0 +1,63 @@
+const { credentials } = require('@grpc/grpc-js');
+const TlRpc = require("./TlRpc");
+
+/**
+ * rpc通用client
+ * @version 1.0.0
+ * @author iamtsm
+ */
+class TlRpcClient extends TlRpc{
+    /**
+     * -- 私有属性
+     * client实例
+     */
+    static #clientInstance = new Map();
+
+    /**
+     * 初始化
+     * @param {*} rpcConfig 
+     */
+    constructor( rpcConfig ) {
+        super( rpcConfig )
+    }
+
+    /**
+     * 返回client缓存对象的key
+     */
+    #clientInstanceKey() {
+        const config = this.getConfig();
+        return config.name + "-" + config.protoPackage + "-" + config.protoImpl + "-" + config.ip + "-" + config.port;
+    }
+
+    /**
+     * 获取client对象实例
+     * @returns 
+     */
+    clientInstance(){
+        const instance = this.implInstance();
+        if (!instance) {
+            return null;
+        }
+
+        const clientKey = this.#clientInstanceKey();
+        const client = TlRpcClient.#clientInstance.get(clientKey)
+        if (client) {
+            return client;
+        }
+
+        const config = this.getConfig();
+        const newClient = new instance(
+            config.ip + ":" + config.port,
+            credentials.createInsecure(),
+            { 'grpc.service_config': '{"loadBalancingConfig": [{"round_robin": {}}]}' },
+        )
+
+        console.log("create client instance for " + clientKey + " ok!")
+
+        TlRpcClient.#clientInstance.set(clientKey, newClient);
+
+        return newClient;
+    }
+}
+
+module.exports = TlRpcClient;

TlRpcServer.js

@@ -0,0 +1,59 @@
+const TlRpc = require("./TlRpc")
+const grpc = require('@grpc/grpc-js');
+
+/**
+ * rpc通用server
+ * @version 1.0.0
+ * @author iamtsm
+ */
+class TlRpcServer extends TlRpc{
+
+    /**
+     * 初始化
+     * @param {*} rpcConfig
+     */
+    constructor(rpcConfig) {
+        super(rpcConfig)
+    }
+
+    /**
+     * -- 对外提供
+     * 获取实例化service接口列表对象
+     * @returns service instance
+     */
+    #serviceDefinition() {
+        const instance = this.implInstance();
+        if (!instance) {
+            return null;
+        }
+        return instance.service;
+    }
+
+    /**
+     * 启动服务
+     * 启动时需要添加相应的启动函数
+     * @returns 
+     */
+    async startServer(handlerMap = {}){
+        if(Object.keys(handlerMap).length === 0){
+            return null;
+        }
+        console.log(handlerMap)
+
+        const server = new grpc.Server();
+        const config = this.getConfig();
+        return await new Promise(resolve => {
+            server.addService(this.#serviceDefinition(), handlerMap);
+            server.bindAsync(
+                config.ip + ":" + config.port,
+                grpc.ServerCredentials.createInsecure(), () => {
+                    server.start();
+                    console.log(`${JSON.stringify(config)} server start!`)
+                    resolve(handlerMap)
+                }
+            );
+        })
+    }
+}
+
+module.exports = TlRpcServer;

client/api/TlApiRpcClient.js

@@ -0,0 +1,54 @@
+const TlRpcClient = require("../../TlRpcClient");
+const { modeEnum, versionEnum } = require("../../comm/comm");
+
+/**
+ * rpc api模式client
+ * @version 1.0.0
+ * @author iamtsm
+ */
+class TlApiRpcClient extends TlRpcClient{
+    /**
+     * -- 公共属性
+     * api调用版本
+     */
+    version = versionEnum.V1;
+
+    /**
+     * -- 私有属性
+     * client实例
+     */
+    #instanceClient = this.getClient();
+
+    /**
+     * 初始化
+     * @param {*} rpcConfig 
+     */
+    constructor(rpcConfig){
+        super(Object.assign(rpcConfig, {mode : modeEnum.API}));
+    }
+
+    /**
+     * 获取client请求对象
+     * @returns 
+     */
+    getClient(){
+        return this.clientInstance();
+    }
+
+    /**
+     * -- 对外提供
+     * 发送请求 
+     * @param {*} api 
+     * @param {*} requestArgs 
+     * @returns 
+     */
+    async emit(api, requestArgs){
+        return await new Promise((resolve, reject) => {
+            this.#instanceClient[api](requestArgs, function(err, response){
+                if(err){ reject(err); } else { resolve(response) }
+            });
+        });
+    }
+}
+
+module.exports = TlApiRpcClient;