@fastcar/template-microservices 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 william_zhong
+
+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.

package/README.md

@@ -0,0 +1,124 @@
+# @fastcar/template-microservices
+
+基于 fastcar-core 的微服务应用模板
+
+## 简介
+
+这是一个用于快速搭建微服务架构的模板，包含多个服务模块，适用于构建分布式系统。
+
+## 特性
+
+- 🚀 基于 [fastcar-core](https://www.npmjs.com/package/@fastcar/core) 框架
+- 🏗️ 多服务模式（center、connector、chat、web）
+- 🔗 内置 RPC 通信
+- 📦 支持 TypeScript
+- 🔄 支持 PM2 进程管理
+- 🔌 支持 WebSocket
+
+## 服务模块
+
+- **center**: 服务中心，提供服务注册与发现
+- **connector**: 连接器服务，处理客户端连接
+- **chat**: 聊天服务，处理实时消息
+- **web**: Web 服务，提供 HTTP 接口
+- **base**: 基础服务，提供公共功能
+
+## 使用方式
+
+### 安装依赖
+
+```bash
+cd template
+npm install
+# 或者
+yarn install
+```
+
+### 开发调试
+
+```bash
+# 启动单个节点模式
+npm run start-node
+
+# 启动 PM2 管理模式
+npm run start-pm2
+```
+
+### 编译项目
+
+```bash
+npm run build
+# 或者
+yarn build
+```
+
+### 启动服务
+
+```bash
+npm start
+# 或者
+yarn start
+```
+
+### 停止服务
+
+```bash
+npm stop
+# 或者
+yarn stop
+```
+
+## 配置说明
+
+配置文件位于 `resource/` 目录：
+
+- `application.yml` - 主配置
+- `application-dev.yml` - 开发环境配置
+- `ecosystem.config.yml` - PM2 配置
+
+## 项目结构
+
+```
+template/
+├── src/
+│   ├── annotation/       # 注解定义
+│   ├── common/           # 公共代码
+│   ├── middleware/       # 中间件
+│   ├── servers/          # 服务目录
+│   │   ├── base/         # 基础服务
+│   │   ├── center/       # 服务中心
+│   │   ├── chat/         # 聊天服务
+│   │   ├── connector/    # 连接器服务
+│   │   └── web/          # Web 服务
+│   ├── types/            # 类型定义
+│   ├── utils/            # 工具函数
+│   ├── app-node.ts       # 单节点入口
+│   └── app-pm2.ts        # PM2 入口
+├── resource/
+│   ├── application.yml
+│   ├── application-dev.yml
+│   └── ecosystem.config.yml
+├── test/                 # 测试文件
+├── package.json
+├── tsconfig.json
+└── ecosystem.config.yml
+```
+
+## 依赖
+
+- [@fastcar/core](https://www.npmjs.com/package/@fastcar/core) - 核心框架
+- [@fastcar/koa](https://www.npmjs.com/package/@fastcar/koa) - Koa 集成
+- [@fastcar/rpc](https://www.npmjs.com/package/@fastcar/rpc) - RPC 支持
+- [@fastcar/server](https://www.npmjs.com/package/@fastcar/server) - 服务器支持
+- [@fastcar/timer](https://www.npmjs.com/package/@fastcar/timer) - 定时器支持
+
+## 相关模板
+
+- [@fastcar/template-web](../web) - Web 项目模板
+- [@fastcar/template-static](../static) - 静态资源服务器模板
+- [@fastcar/template-rpc](../rpc) - RPC 服务器模板
+- [@fastcar/template-cos](../cos) - 对象存储服务模板
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "@fastcar/template-microservices",
+	"version": "1.0.0",
+	"description": "基于 fastcar-core 的微服务应用模板",
+	"main": "index.js",
+	"keywords": [
+		"fastcar",
+		"microservices",
+		"template",
+		"typescript",
+		"nodejs"
+	],
+	"author": "william_zhong",
+	"license": "MIT",
+	"homepage": "https://github.com/williamDazhangyu/fastcar-template#readme",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/williamDazhangyu/fastcar-template.git",
+		"directory": "microservices"
+	},
+	"bugs": {
+		"url": "https://github.com/williamDazhangyu/fastcar-template/issues"
+	},
+	"engines": {
+		"node": ">=16"
+	},
+	"files": [
+		"template",
+		"README.md",
+		"LICENSE"
+	],
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	}
+}

package/template/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "tabWidth": 4,
+  "printWidth": 200,
+  "trailingComma": "es5",
+  "useTabs": true,
+  "jsonEnable": [
+    "json"
+  ]
+}

package/template/.vscode/launch.json

@@ -0,0 +1,183 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run TS",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${relativeFile}",
+                "serverType=web",
+                "serviceId=web-server-1"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run JS",
+            "type": "node",
+            "request": "launch",
+            "program": "${file}"
+        },
+        {
+            "name": "Run APP_NODE",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run APP_PM2",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-pm2.ts"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run mocha",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+            "stopOnEntry": false,
+            "args": [
+                "${relativeFile}",
+                "--no-timeouts"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeExecutable": null,
+            "env": {
+                "NODE_ENV": "testing"
+            },
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "DEBUG",
+            "address": "localhost",
+            "port": 2000,
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "${workspaceFolder}"
+        },
+        {
+            "name": "Run CENTER-1",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts",
+                "serverType=center",
+                "serviceId=center-server-1"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run CENTER-2",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts",
+                "serverType=center",
+                "serviceId=center-server-2"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run WEB-1",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts",
+                "serverType=web",
+                "serviceId=web-server-1"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run WEB-2",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts",
+                "serverType=web",
+                "serviceId=web-server-2"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+        {
+            "name": "Run CHAT-1",
+            "type": "node",
+            "request": "launch",
+            "args": [
+                "${workspaceRoot}/src/app-node.ts",
+                "serverType=chat",
+                "serviceId=chat-server-1"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "env": {
+                "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+            }
+        },
+    ]
+}

package/template/README.md

@@ -0,0 +1 @@
+#fastcar-microservices

package/template/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@fastcar/template-microservices",
+	"version": "1.0.0",
+	"description": "微服务应用模板",
+	"engines": {
+		"node": ">=22"
+	},
+	"scripts": {
+		"start": "pm2 start ./resource/ecosystem.config.yml",
+		"stop": "pm2 stop ./resource/ecosystem.config.yml",
+		"delete": "pm2 delete ./resource/ecosystem.config.yml",
+		"build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+		"start-node": "node -r ts-node/register ./src/app-node.ts",
+		"start-pm2": "node -r ts-node/register ./src/app-pm2.ts cmd=start",
+		"start-pm2-js": "node ./target/app-pm2.js cmd=start",
+		"stop-pm2": "node -r ts-node/register ./src/app-pm2.ts cmd=stop",
+		"stop-pm2-js": "node ./target/app-pm2.js cmd=stop"
+	},
+	"dependencies": {
+		"@fastcar/core": "^0.3.19",
+		"@fastcar/koa": "^0.1.21",
+		"@fastcar/rpc": "^0.2.9",
+		"@fastcar/server": "^0.0.5",
+		"@fastcar/timer": "^0.2.0",
+		"nanoid": "3.3.4",
+		"ws": "^8.18.0"
+	},
+	"devDependencies": {
+		"@types/koa": "^2.15.0",
+		"@types/mocha": "^10.0.10",
+		"@types/node": "^22.10.1",
+		"@types/tz-offset": "^0.0.0",
+		"mocha": "^9.1.4",
+		"ts-node": "^10.9.2",
+		"tsc-alias": "^1.8.16",
+		"tsconfig-paths": "^4.2.0",
+		"typescript": "^5.9.3"
+	},
+	"peerDependencies": {
+		"pm2": "^6.0.14"
+	},
+	"peerDependenciesMeta": {
+		"pm2": {
+			"optional": true
+		}
+	}
+}

package/template/resource/application-dev.yml

@@ -0,0 +1,56 @@
+#应用的基础配置
+settings:
+    hotterSysConfig: true #监听系统配置
+    microservices:
+        center: #应用类型
+            token: "nW0tT4bZ6qM7mF7wD2rT2pR9dT7gK3hZ"
+            servers:
+                - host: "localhost"
+                  clusters: 1 #代表有两个这样的 serviceId和prot端口号都递增
+                  list:
+                      - type: "ws"
+                        server: { port: 60000 }
+                        timeout: 0 #设置永不超时
+                        connectionLimit: 1
+                        disconnectInterval: 1000 #断线重连1秒
+                        retry: { retryCount: 3, retryInterval: 3000, timeout: 30000, maxMsgNum: 10000, increase: true }
+                - host: "localhost"
+                  clusters: 3 #代表有两个这样的 serviceId和prot端口号都递增
+                  list:
+                      - type: "ws"
+                        server: { port: 60000 }
+                        timeout: 0 #设置永不超时
+                        connectionLimit: 1
+                        disconnectInterval: 1000 #断线重连1秒
+                        retry: { retryCount: 3, retryInterval: 3000, timeout: 30000, maxMsgNum: 10000, increase: true }
+        connector:
+            token: "x3TGsWC9uloZu235LA07eAiJ61nQ1A5f"
+            servers:
+                - host: "localhost"
+                  clusters: 1
+                  list:
+                      - front: true
+                        type: "ws"
+                        server: { port: 60100 }
+        chat:
+            token: "go0kbkNM3wQ4e2Vgo0kbkNM3wQ4e2V"
+            servers:
+                - host: "localhost"
+                  clusters: 1
+                  list:
+                      - type: "ws"
+                        server: { port: 60200 }
+        web:
+            token: "go0kbkNM3wQ4e2Vgo0kbkNM3wQ4e2V"
+            koa:
+                koaBodyParser: #koabody设置 新增xml解析
+                    enableTypes: ["json", "form", "text"]
+                    extendTypes: { text: ["text/xml", "application/xml"] }
+            servers:
+                - host: "localhost"
+                  clusters: 1
+                  list:
+                      - type: "http"
+                        server: { port: 8080 } #服务器配置 支持 http http2和https
+                      - type: "ws"
+                        server: { port: 60300 }

package/template/resource/application.yml

@@ -0,0 +1,2 @@
+application:
+    env: "dev"

package/template/src/annotation/AuthServiceRole.ts

@@ -0,0 +1,76 @@
+import "reflect-metadata";
+import { ServerKind } from "@/common/Constant";
+import Result from "@/common/Result";
+import Code from "@/common/Code";
+import { SessionAttribute } from "@/types/SessionAttribute";
+import { ClassUtils } from "@fastcar/core/utils";
+import { ForwardRpcContext } from "@/types/ForwardRpcContext";
+import { MethodType, RpcMetaData } from "@fastcar/rpc";
+
+const BASETYPE = ["constructor", "prototype", "name"];
+
+//定义方法
+function defineFunction(desc: PropertyDescriptor, role: ServerKind[]): PropertyDescriptor {
+	let beforeFN = desc.value;
+	desc.value = function (data: any, ctx: ForwardRpcContext) {
+		if (ctx.forward) {
+			let session = ctx.session;
+
+			if (!session) {
+				return Result.errorCode(Code.COMMON.PERMISSIONS_MISSING);
+			}
+
+			let sessionRole = session.settings.get(SessionAttribute.serverKind);
+
+			if (!role.includes(sessionRole)) {
+				return Result.errorCode(Code.COMMON.PERMISSIONS_MISSING);
+			}
+
+			return Promise.resolve(Reflect.apply(beforeFN, this, [data, ctx]));
+		}
+
+		//优先从session会话中判断
+		let roleLevel = ctx.settings.get(SessionAttribute.serverKind);
+		if (!role.includes(roleLevel)) {
+			return Result.errorCode(Code.COMMON.PERMISSIONS_MISSING);
+		}
+
+		return Promise.resolve(Reflect.apply(beforeFN, this, [data, ctx]));
+	};
+
+	return desc;
+}
+
+//校验角色
+export default function AuthServiceRole(...role: ServerKind[]) {
+	return function (target: any, methodName?: string, descriptor?: PropertyDescriptor) {
+		if (methodName && descriptor) {
+			defineFunction(descriptor, role);
+		} else {
+			let keys = ClassUtils.getProtoType(target);
+			let routerMap: Map<string, MethodType> = Reflect.getMetadata(RpcMetaData.RPCMethod, target.prototype);
+
+			if (!routerMap || routerMap.size == 0) {
+				return;
+			}
+
+			let methods: string[] = [];
+			routerMap.forEach((v) => {
+				methods.push(v.method);
+			});
+
+			keys.forEach((item) => {
+				if (BASETYPE.includes(item.toString())) {
+					return;
+				}
+				if (!methods.includes(item.toString())) {
+					return;
+				}
+				let desc: PropertyDescriptor | undefined = Reflect.getOwnPropertyDescriptor(target.prototype, item);
+				if (desc) {
+					Reflect.defineProperty(target.prototype, item, defineFunction(desc, role));
+				}
+			});
+		}
+	};
+}

package/template/src/annotation/EnableHotConfig.ts

@@ -0,0 +1,13 @@
+import { setHotKey } from "@/hotconfig/HotConfigInterface";
+import { ComponentInjection } from "@fastcar/core/annotation";
+import path = require("path");
+
+export default function EnableHotConfig(obj: { [rp: string]: string[] }) {
+	return function (target: any) {
+		Object.keys(obj).forEach((rp) => {
+			let fp = require.resolve(path.join(__dirname, "../", "hotconfig", rp));
+			setHotKey(fp, Reflect.get(obj, rp));
+			ComponentInjection(target, fp);
+		});
+	};
+}

package/template/src/app-node.ts

@@ -0,0 +1,94 @@
+import { ChildProcess, spawn, SpawnOptions } from "child_process";
+import { FileUtil } from "@fastcar/core/utils";
+import * as path from "path";
+import { execPath } from "process";
+import NetWork from "./utils/NetWork";
+import * as fs from "fs";
+import MicroservicesUtils from "./utils/MicroservicesUtils";
+
+//使用子进程启动微服务
+class APPNode {
+	spawnProcess(options: string[], debug: boolean = false) {
+		let stdioArgs: SpawnOptions = { detached: true, stdio: "inherit" };
+		let child: ChildProcess = spawn(execPath, options, debug ? {} : stdioArgs);
+
+		child?.stderr?.on("data", function (chunk) {
+			process.stderr.write(chunk.toString());
+		});
+
+		child?.stdout?.on("data", function (chunk) {
+			process.stdout.write(chunk.toString());
+		});
+
+		child.on("error", function (error) {
+			console.error(error);
+		});
+
+		child.on("exit", function (code) {
+			if (code !== 0) {
+				console.error("child process exit with error, error code: %s", code);
+			}
+		});
+	}
+
+	start() {
+		const serverPath = path.join(__dirname, "servers");
+		//加载配置
+		//根据配置读取server集群
+		let microservices = MicroservicesUtils.getMicroservicesConfig();
+		microservices = MicroservicesUtils.format(microservices);
+
+		let pargs = MicroservicesUtils.parseArgs(process.argv);
+		let argServerType = Reflect.get(pargs, "serverType");
+		let argServiceId = Reflect.get(pargs, "serviceId");
+
+		Object.keys(microservices).forEach((serverType) => {
+			if (argServerType && argServerType != serverType) {
+				return;
+			}
+
+			//判断是否为本地IP
+			let item = microservices[serverType];
+			let servers = item.servers;
+			servers.forEach((s) => {
+				if (argServiceId && argServiceId != s.serviceId) {
+					return;
+				}
+
+				if (NetWork.isLocalIP(s.host)) {
+					try {
+						let args: string[] = [];
+
+						if (!!s.debugPort) {
+							args.push(`--inspect=${s.host}:${s.debugPort}`);
+						}
+
+						let scriptPath = require.resolve(path.join(serverPath, serverType, "app"));
+						if (!fs.existsSync(scriptPath)) {
+							return;
+						}
+						if (FileUtil.getSuffix(scriptPath) == "ts") {
+							args.push("-r");
+							args.push("ts-node/register");
+						}
+
+						args.push(scriptPath);
+
+						args.push(serverType);
+						args.push(s.serviceId);
+
+						this.spawnProcess(args, !!s.debugPort);
+					} catch (e) {
+						console.error(`${s.serviceId} startup failed`);
+						console.error(e);
+					}
+				}
+			});
+		});
+	}
+}
+
+//设置时区
+process.env.TZ = "UTC";
+
+export default new APPNode().start();