mas-server 2.0.52 → 2.0.54

package/dist/index.js

@@ -9,7 +9,7 @@ const express_1 = __importDefault(require("express"));
 const cors_1 = __importDefault(require("cors"));
 const path_1 = __importDefault(require("path"));
 const state_1 = require("./state");
-const getLog_1 = __importDefault(require("./utils/getLog"));
+const printLog_1 = __importDefault(require("./utils/printLog"));
 const quickSend_1 = __importDefault(require("./utils/quickSend"));
 const readApi_1 = __importDefault(require("./utils/readApi"));
 exports.readApi = readApi_1.default;
@@ -39,8 +39,11 @@ const validType_1 = __importDefault(require("./utils/validType"));
 exports.validType = validType_1.default;
 const createRouter_1 = __importDefault(require("./utils/createRouter"));
 const getRouterInfo_1 = __importDefault(require("./utils/getRouterInfo"));
+const logs_1 = __importDefault(require("./utils/logs"));
+const apiLimit_1 = __importDefault(require("./utils/apiLimit"));
 // =================================================================
 function getApp(DIRNAME, beforeMounted) {
+    var _a;
     // 路径和配置放入state
     state_1.state.DIRNAME = DIRNAME;
     const config = require(path_1.default.join(DIRNAME, "/config/config.ts")).default;
@@ -50,6 +53,10 @@ function getApp(DIRNAME, beforeMounted) {
     state_1.state.apiCN = [];
     // new express
     const app = (0, express_1.default)();
+    // ip限制
+    if ((_a = config.apiLimit) === null || _a === void 0 ? void 0 : _a.open) {
+        (0, apiLimit_1.default)(app, config.apiLimit || {});
+    }
     // 是否允许跨域
     config.cors && app.use((0, cors_1.default)());
     if (beforeMounted) {
@@ -67,10 +74,15 @@ function getApp(DIRNAME, beforeMounted) {
     });
     //快速return
     app.use(quickSend_1.default);
-    // 日志
-    if (config.logs.open) {
+    // 打印日志
+    if (config.logs.debug) {
         app.use(require("express-ip")().getIpInfoMiddleware);
-        app.use(getLog_1.default);
+        app.use(printLog_1.default);
+    }
+    // 存储日志
+    if (config.logs.open) {
+        // app.use(printLog);
+        (0, logs_1.default)(app, path_1.default.join(DIRNAME + `/logs/`));
     }
     // 权限管理
     if (config.token.open) {

package/dist/utils/apiLimit.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_rate_limit_1 = __importDefault(require("express-rate-limit"));
+const apiLimit = (app, config) => {
+    // 创建一个速率限制器，限制每个IP地址在一分钟内最多可以发送10个请求
+    const limiter = (0, express_rate_limit_1.default)({
+        windowMs: (config === null || config === void 0 ? void 0 : config.windowMs) || 60 * 1000,
+        max: (config === null || config === void 0 ? void 0 : config.max) || 20,
+        // 当达到限制时调用的处理函数
+        handler: function (req, res) {
+            res.status(502).end();
+        },
+    });
+    // 将速率限制器应用于所有请求
+    app.use(limiter);
+};
+exports.default = apiLimit;

package/dist/utils/getRouterInfo.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const state_1 = require("@/state");
+const state_1 = require("../state");
 const readApi_1 = __importDefault(require("./readApi"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));

package/dist/utils/logs.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const morgan_1 = __importDefault(require("morgan"));
+const fs_1 = __importDefault(require("fs"));
+const rfs = __importStar(require("rotating-file-stream"));
+const getLogs = (app, dir) => {
+    // 创建一个日志目录（如果它不存在的话）
+    const logDirectory = dir;
+    fs_1.default.existsSync(logDirectory) || fs_1.default.mkdirSync(logDirectory);
+    // 创建一个循环日志流
+    const accessLogStream = rfs.createStream("access.log", {
+        size: "50M",
+        interval: "1d",
+        path: logDirectory,
+    });
+    app.use((0, morgan_1.default)("combined", { stream: accessLogStream }));
+};
+exports.default = getLogs;

package/dist/utils/printLog.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment_1 = __importDefault(require("moment"));
+exports.default = (req, res, next) => {
+    const date = (0, moment_1.default)().format("YYYY-MM-DD HH:mm:ss");
+    const data = `${date} ${req.method} ${req.ipInfo.ip} ${req.url} ${req.body ? JSON.stringify(req.body) : ""}\n`;
+    console.info(data);
+    next();
+};

package/package.json

@@ -1,50 +1,52 @@
-{
-  "name": "mas-server",
-  "version": "2.0.52",
-  "description": "一款基于express面向中小型项目的后端框架",
-  "main": "dist/index.js",
-  "typings": "src/index.ts",
-  "scripts": {
-    "testdev": "npx ts-node-dev --transpile-only ./test/scripts/run.ts --respawn",
-    "test": "npx ts-node ./test/scripts/beforeCreated.ts -end && npx ts-node ./test/scripts/run.ts",
-    "testmon": "npx nodemon ./test/scripts/run.ts",
-    "testTS": "npx nodemon ./test/test.ts",
-    "createSql": "npx ts-node ./test/scripts/createSqlForm.ts",
-    "createApi": "npx ts-node ./test/scripts/createApiFile.ts",
-    "createApis": "npx ts-node ./test/scripts/createApis.ts",
-    "init": "npx nodemon ./test/scripts/beforeCreated.ts -end",
-    "gsft": "npx nodemon ./test/scripts/getSqlFormType.ts",
-    "build": "tsc --project ./tsconfig-build.json",
-    "sync": "npm run build && node ./beforebuild.js && npm publish && cnpm sync mas-server && explorer \"https://npmmirror.com/package/mas-server\""
-  },
-  "keywords": [],
-  "author": "tingxi8087",
-  "license": "ISC",
-  "dependencies": {
-    "@types/express": "^4.17.17",
-    "ansi-colors": "^4.1.3",
-    "axios": "^1.3.6",
-    "cors": "^2.8.5",
-    "express": "^4.18.2",
-    "express-ip": "^1.0.4",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.1",
-    "masmysql": "^2.0.53",
-    "module-alias": "^2.2.2",
-    "moment": "^2.29.4",
-    "mysql": "^2.18.1",
-    "nodemon": "^2.0.22",
-    "ts-node": "^10.9.1",
-    "ts-node-dev": "^2.0.0",
-    "typescript": "^5.0.4"
-  },
-  "_moduleAliases": {
-    "@": "src/",
-    "@@": "."
-  },
-  "devDependencies": {
-    "@types/cors": "^2.8.13",
-    "@types/express": "^4.17.17",
-    "@types/moment": "^2.13.0"
-  }
-}
+{
+  "name": "mas-server",
+  "version": "2.0.54",
+  "description": "一款基于express面向中小型项目的后端框架",
+  "main": "dist/index.js",
+  "typings": "src/index.ts",
+  "scripts": {
+    "test": "npx ts-node ./test/scripts/beforeCreated.ts -end && npx ts-node ./test/scripts/run.ts",
+    "testmon": "npx nodemon ./test/scripts/run.ts",
+    "testTS": "npx nodemon ./test/test.ts",
+    "createSql": "npx ts-node ./test/scripts/createSqlForm.ts",
+    "createApi": "npx ts-node ./test/scripts/createApiFile.ts",
+    "createApis": "npx ts-node ./test/scripts/createApis.ts",
+    "init": "npx nodemon ./test/scripts/beforeCreated.ts -end",
+    "gsft": "npx nodemon ./test/scripts/getSqlFormType.ts",
+    "build": "tsc --project ./tsconfig-build.json",
+    "sync": "npm run build && node ./beforebuild.js && npm publish && cnpm sync mas-server && explorer \"https://npmmirror.com/package/mas-server\""
+  },
+  "keywords": [],
+  "author": "tingxi8087",
+  "license": "ISC",
+  "dependencies": {
+    "@types/express": "^4.17.17",
+    "ansi-colors": "^4.1.3",
+    "axios": "^1.3.6",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "express-ip": "^1.0.4",
+    "express-rate-limit": "^7.1.4",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.1",
+    "masmysql": "^2.0.53",
+    "module-alias": "^2.2.2",
+    "moment": "^2.29.4",
+    "morgan": "^1.10.0",
+    "mysql": "^2.18.1",
+    "nodemon": "^2.0.22",
+    "rotating-file-stream": "^3.1.1",
+    "ts-node": "^10.9.1",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.0.4"
+  },
+  "_moduleAliases": {
+    "@": "src/",
+    "@@": "."
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
+    "@types/moment": "^2.13.0"
+  }
+}

package/src/index.ts

@@ -5,11 +5,10 @@ import cors from "cors";
 import path from "path";
 import * as fs from "fs";
 import { state } from "./state";
-import getLog from "./utils/getLog";
+import printLog from "./utils/printLog";
 import quickSend from "./utils/quickSend";
 import readApi from "./utils/readApi";
 import validRouteData from "./utils/validRouteData";
-
 import validTokenUse from "./utils/validToken";
 import type {
   masReq,
@@ -40,6 +39,8 @@ import { createToken, validToken } from "./utils/meaToken";
 import validType from "./utils/validType";
 import createRouter from "./utils/createRouter";
 import getRouterInfo from "./utils/getRouterInfo";
+import getLogs from "./utils/logs";
+import apiLimit from "./utils/apiLimit";
 
 // =================================================================
 export function getApp(
@@ -58,6 +59,10 @@ export function getApp(
   state.apiCN = [];
   // new express
   const app = express();
+  // ip限制
+  if (config.apiLimit?.open) {
+    apiLimit(app, config.apiLimit || {});
+  }
   // 是否允许跨域
   config.cors && app.use(cors());
   if (beforeMounted) {
@@ -75,11 +80,17 @@ export function getApp(
   });
   //快速return
   app.use(quickSend);
-  // 日志
-  if (config.logs.open) {
+  // 打印日志
+  if (config.logs.debug) {
     app.use(require("express-ip")().getIpInfoMiddleware);
-    app.use(getLog);
+    app.use(printLog);
   }
+  // 存储日志
+  if (config.logs.open) {
+    // app.use(printLog);
+    getLogs(app, path.join(DIRNAME + `/logs/`));
+  }
+
   // 权限管理
   if (config.token.open) {
     app.use(validTokenUse);

package/src/typings/index.ts

@@ -85,13 +85,21 @@ export type configType = {
   };
   /** 是否允许跨域 */
   cors: boolean;
-
   logs: {
     /** 是否保存日志 */
     open: boolean;
     /** 是否打印访问日志 */
     debug: boolean;
   };
+  /** ip请求限制 */
+  apiLimit: {
+    /** 是否开启 */
+    open?: boolean;
+    /** 同个 ip windowMs ms之内 */
+    windowMs?: number;
+    /** 最多max个请求 */
+    max?: number; //
+  };
   token: {
     /** 是否使用token */
     open: boolean;

package/src/utils/apiLimit.ts

@@ -0,0 +1,15 @@
+import rateLimit from "express-rate-limit";
+const apiLimit = (app: any, config?: { windowMs: number; max: number }) => {
+  // 创建一个速率限制器，限制每个IP地址在一分钟内最多可以发送10个请求
+  const limiter = rateLimit({
+    windowMs: config?.windowMs || 60 * 1000, // 1分钟
+    max: config?.max || 20, // 最多10个请求
+    // 当达到限制时调用的处理函数
+    handler: function (req, res) {
+      res.status(502).end();
+    },
+  });
+  // 将速率限制器应用于所有请求
+  app.use(limiter);
+};
+export default apiLimit;

package/src/utils/getRouterInfo.ts

@@ -1,4 +1,4 @@
-import { state } from "@/state";
+import { state } from "../state";
 import readFilesRecursively from "./readApi";
 import path from "path";
 import fs from "fs";

package/src/utils/logs.ts

@@ -0,0 +1,17 @@
+import rateLimit from "express-rate-limit";
+import morgan from "morgan";
+import fs from "fs";
+import * as rfs from "rotating-file-stream";
+const getLogs = (app: any, dir: string) => {
+  // 创建一个日志目录（如果它不存在的话）
+  const logDirectory = dir;
+  fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory);
+  // 创建一个循环日志流
+  const accessLogStream = rfs.createStream("access.log", {
+    size: "50M", // 单个文件的最大大小
+    interval: "1d", // 每天滚动日志
+    path: logDirectory,
+  });
+  app.use(morgan("combined", { stream: accessLogStream }));
+};
+export default getLogs;

package/src/utils/{getLog.ts → printLog.ts}

@@ -3,18 +3,10 @@ import { state } from "../state";
 import moment from "moment";
 
 export default (req, res, next) => {
-  const { config } = state;
   const date = moment().format("YYYY-MM-DD HH:mm:ss");
   const data = `${date} ${req.method} ${req.ipInfo.ip} ${req.url} ${
     req.body ? JSON.stringify(req.body) : ""
   }\n`;
-  fs.appendFileSync(
-    state.DIRNAME + `/logs/${moment().format("YYYY-MM-DD")}.log`,
-    data
-  );
-
-  if (config.logs.debug) {
-    console.info(data);
-  }
+  console.info(data);
   next();
 };

package/test/config/config.ts

@@ -12,12 +12,18 @@ export default <configType>{
     open: true,
     debug: false,
   },
+  apiLimit: {
+    open: true,
+    windowMs: 60 * 1000,
+    // windowMs: 60 * 1000,
+    max: 5,
+  },
   token: {
     open: true,
     pwd: "8087",
     headerParams: "token",
   },
-  useSql: true,
+  useSql: false,
   debugTime: 100,
   sql: {
     host: "127.0.0.1",

package/test//345/276/205/345/274/200/345/217/221.md

@@ -1,20 +0,0 @@
-约定式接口读取 完成
-数据效验 完成
-masmysql引入 (massql set方法开发) 完成
-权限管理，token生成 完成
-接口文档生成 完成
-快捷创建接口 完成
-生成sql类型 完成
-错误处理 完成
-cookie管理
-路由导航汉化
-接口文档体验优化
-.vscode配置
-一键导出前端axios代码
-  接口加载状态
-  导航点击跳转 调试->调试
-特别说明：
-get请求和请求头的number参数会被转为string,get请求无法发送和接收数组
-接口改名配置丢失
-只能接收{}或[]
-请求参数必须是对象或数组