@fastcar/koa 0.1.9

package/target/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DesignMeta = exports.Swagger = exports.KoaStatic = exports.KoaCors = exports.KoaBodyParser = exports.KoaBody = exports.ExceptionGlobalHandler = exports.KoaApplication = void 0;
+const KoaApplication_1 = require("./KoaApplication");
+exports.KoaApplication = KoaApplication_1.default;
+const ExceptionGlobalHandler_1 = require("./middleware/ExceptionGlobalHandler");
+exports.ExceptionGlobalHandler = ExceptionGlobalHandler_1.default;
+const KoaBody_1 = require("./middleware/KoaBody");
+exports.KoaBody = KoaBody_1.default;
+const KoaBodyParser_1 = require("./middleware/KoaBodyParser");
+exports.KoaBodyParser = KoaBodyParser_1.default;
+const KoaCors_1 = require("./middleware/KoaCors");
+exports.KoaCors = KoaCors_1.default;
+const KoaStatic_1 = require("./middleware/KoaStatic");
+exports.KoaStatic = KoaStatic_1.default;
+const Swagger_1 = require("./middleware/Swagger");
+exports.Swagger = Swagger_1.default;
+const DesignMeta_1 = require("./type/DesignMeta");
+Object.defineProperty(exports, "DesignMeta", { enumerable: true, get: function () { return DesignMeta_1.DesignMeta; } });

package/target/middleware/ExceptionGlobalHandler.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@fastcar/core");
+//默认错误捕捉
+function ExceptionGlobalHandler(app) {
+    let logger = app.getSysLogger();
+    return async (ctx, next) => {
+        try {
+            await next();
+        }
+        catch (e) {
+            //新增如果是校验的错误则进行输出
+            if (e instanceof core_1.ValidError) {
+                ctx.body = {
+                    code: 400,
+                    msg: e.message || "parameter error",
+                };
+            }
+            else {
+                logger.error(`${ctx.url} is error`);
+                if (e) {
+                    logger.error(e);
+                }
+                ctx.body = {
+                    code: 500,
+                    msg: "Service internal error",
+                };
+            }
+        }
+    };
+}
+exports.default = ExceptionGlobalHandler;

package/target/middleware/KoaBody.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const koaBody = require("koa-body");
+//对于文件上传做限定
+function KoaBody(app) {
+    let koaConfig = app.getSetting("koa");
+    let bodyConfig = koaConfig?.koaBodyOptions;
+    return koaBody(bodyConfig);
+}
+exports.default = KoaBody;

package/target/middleware/KoaBodyParser.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bodyParser = require("koa-bodyparser");
+//对文件内容做解析
+function KoaBodyParser(app) {
+    let koaConfig = app.getSetting("koa");
+    let bodyConfig = koaConfig?.koaBodyParser;
+    return bodyParser(bodyConfig);
+}
+exports.default = KoaBodyParser;

package/target/middleware/KoaCors.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const koa2Cors = require("koa2-cors");
+function KoaCors(app) {
+    let koaConfig = app.getSetting("koa");
+    if (koaConfig?.extra) {
+        let corsConfig = Reflect.get(koaConfig.extra, "cors");
+        if (!!corsConfig) {
+            //兼容支持多个跨域
+            if (typeof corsConfig.origin == "string") {
+                let origins = corsConfig.origin.split(";");
+                Reflect.set(corsConfig, "origin", (ctx) => {
+                    let orign = ctx?.request?.header?.origin;
+                    if (!orign) {
+                        if (!origins.includes("*")) {
+                            return false;
+                        }
+                        return "*";
+                    }
+                    for (let o of origins) {
+                        if (orign.startsWith(o) || o == "*") {
+                            return o;
+                        }
+                    }
+                    return false;
+                });
+            }
+        }
+        return koa2Cors(corsConfig);
+    }
+    return [];
+}
+exports.default = KoaCors;

package/target/middleware/KoaStatic.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const koaStatic = require("koa-static");
+const KoaRange = require("koa-range");
+const KoaMount = require("koa-mount");
+const fs = require("fs");
+const path = require("path");
+//支持静态文件访问
+function KoaStatic(app) {
+    let mlist = [];
+    //采用koa-range使文件可以流式传播
+    mlist.push(KoaRange);
+    let koaConfig = app.getSetting("koa");
+    if (!!koaConfig?.koaStatic) {
+        let keys = Object.keys(koaConfig?.koaStatic);
+        if (keys.length > 0) {
+            for (let key of keys) {
+                let fp = koaConfig.koaStatic[key];
+                let rp = path.join(app.getResourcePath(), fp);
+                if (!fs.existsSync(fp)) {
+                    if (!fs.existsSync(rp)) {
+                        console.error(`${fp} is not found`);
+                        continue;
+                    }
+                    else {
+                        fp = rp;
+                    }
+                }
+                if (!key.startsWith("/")) {
+                    key = `/${key}`;
+                }
+                mlist.push(KoaMount(key, koaStatic(fp)));
+            }
+        }
+    }
+    return mlist;
+}
+exports.default = KoaStatic;

package/target/middleware/Swagger.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const koaStatic = require("koa-static");
+const KoaMount = require("koa-mount");
+const swaggerDefalutUrl = "https://petstore.swagger.io/v2/swagger.json";
+//api显示和管理
+function Swagger(app) {
+    let mlist = [];
+    let koaConfig = app.getSetting("koa");
+    if (koaConfig.swagger && koaConfig.swagger.enable) {
+        let apiMap = new Map();
+        let fileMap = new Map();
+        let apis = koaConfig.swagger.api;
+        if (apis) {
+            Object.keys(apis).forEach((key) => {
+                let value = apis[key];
+                if (!key.startsWith("/")) {
+                    key = `/${key}`;
+                }
+                let realValue = value.startsWith("/") ? value : "/" + value;
+                apiMap.set(key, realValue);
+                fileMap.set(realValue, path.join(app.getResourcePath(), value));
+            });
+        }
+        //进行设置静态访问路径
+        const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath();
+        mlist.push(KoaMount("/swagger-ui", koaStatic(swaggerUiAssetPath)));
+        const swaggerTemplate = fs.readFileSync(path.join(swaggerUiAssetPath, "index.html"), "utf-8");
+        const fn = async (ctx, next) => {
+            let url = ctx.url;
+            let item = apiMap.get(url);
+            if (!!item) {
+                //输出路径
+                ctx.type = "text/html";
+                ctx.body = swaggerTemplate.replace(swaggerDefalutUrl, item).replace(/\.\//g, "./swagger-ui/");
+                return;
+            }
+            let fp = fileMap.get(url);
+            if (fp) {
+                if (fs.existsSync(fp)) {
+                    ctx.body = fs.readFileSync(fp, "utf-8");
+                    return;
+                }
+            }
+            await next();
+        };
+        mlist.unshift(fn);
+    }
+    return mlist;
+}
+exports.default = Swagger;

package/target/npmlist.json

@@ -0,0 +1 @@
+{"version":"0.1.5","name":"fastcar-koa","dependencies":{"koa-body":{"version":"4.2.0"},"koa-bodyparser":{"version":"4.3.0"},"koa-mount":{"version":"4.0.0"},"koa-range":{"version":"0.3.0"},"koa-router":{"version":"10.1.1"},"koa-static":{"version":"5.0.0"},"koa":{"version":"2.13.4"},"koa2-cors":{"version":"2.0.6"},"swagger-ui-dist":{"version":"4.10.0"}}}

package/target/type/DesignMeta.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DesignMeta = void 0;
+exports.DesignMeta = {
+    ROUTER_MAP: Symbol("ROUTER_MAP"),
+    KoaMIDDLEWARE: Symbol("KoaMIDDLEWARE"), //中间件
+};

package/target/type/KoaConfig.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/target/type/MethodType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/target/type/RouteMethods.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteMethods = void 0;
+var RouteMethods;
+(function (RouteMethods) {
+    RouteMethods["GetMapping"] = "get";
+    RouteMethods["PostMapping"] = "post";
+    RouteMethods["PutMapping"] = "put";
+    RouteMethods["DeleteMapping"] = "delete";
+    RouteMethods["PatchMapping"] = "patch";
+    RouteMethods["AllMapping"] = "all";
+})(RouteMethods = exports.RouteMethods || (exports.RouteMethods = {}));

package/test/logs/serverlogger.log

@@ -0,0 +1,3 @@
+{"timestamp":"2022-04-10 15:12:31.105","level":"INFO","label":"serverlogger","message":"http server is running in 1234"}
+{"timestamp":"2022-04-10 16:06:15.720","level":"INFO","label":"serverlogger","message":"http server is running in 1234"}
+{"timestamp":"2022-04-10 16:09:07.975","level":"INFO","label":"serverlogger","message":"http server is running in 1234"}

package/test/logs/sys.log

@@ -0,0 +1,70 @@
+{"timestamp":"2022-04-10 15:12:30.147","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-10 15:12:30.553","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-10 15:12:30.554","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-10 15:12:30.557","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-10 15:12:30.558","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-10 15:12:31.106","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-10 15:12:31.107","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-10 16:06:14.433","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-10 16:06:15.178","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-10 16:06:15.179","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-10 16:06:15.182","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-10 16:06:15.183","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-10 16:06:15.722","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-10 16:06:15.723","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-10 16:09:07.207","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-10 16:09:07.592","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-10 16:09:07.593","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-10 16:09:07.595","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-10 16:09:07.596","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-10 16:09:07.976","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-10 16:09:07.977","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-10 16:09:36.884","level":"INFO","label":"sys","message":"exit reason","splat":"[\"sigint exit\"]"}
+{"timestamp":"2022-04-11 18:02:08.195","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-11 18:02:08.682","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-11 18:02:08.682","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-11 18:02:08.684","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-11 18:02:08.684","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-11 18:02:09.01","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2022-04-11 18:02:09.02","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-11 18:02:09.03","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-11 18:03:57.591","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-11 18:03:57.852","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-11 18:03:57.853","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-11 18:03:57.854","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-11 18:03:57.855","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-11 18:03:58.84","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2022-04-11 18:03:58.85","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-11 18:03:58.86","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-11 18:04:22.624","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-11 18:04:22.871","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-11 18:04:22.872","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-11 18:04:22.873","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-11 18:04:22.874","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-11 18:04:23.104","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2022-04-11 18:04:23.105","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-11 18:04:23.106","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-22 21:16:31.916","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-22 21:16:32.795","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-22 21:16:32.797","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-22 21:16:32.799","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-22 21:16:32.799","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-22 21:16:33.297","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2022-04-22 21:16:33.298","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-22 21:16:33.298","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-23 09:53:25.585","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-23 09:53:26.372","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-23 09:53:26.372","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-23 09:53:26.374","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-23 09:53:26.374","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-23 09:53:26.862","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2022-04-23 09:53:26.863","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-23 09:53:26.864","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2022-04-23 10:22:03.459","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2022-04-23 10:22:03.909","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2022-04-23 10:22:03.910","level":"INFO","label":"sys","message":"Start component injection"}
+{"timestamp":"2022-04-23 10:22:03.913","level":"INFO","label":"sys","message":"Complete component injection"}
+{"timestamp":"2022-04-23 10:22:03.914","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2022-04-23 10:22:04.326","level":"INFO","label":"sys","message":"http server is running in 12234"}
+{"timestamp":"2022-04-23 10:22:04.327","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2022-04-23 10:22:04.328","level":"INFO","label":"sys","message":"version 1.0.0"}

package/test/resource/application.yml

@@ -0,0 +1,18 @@
+application:
+    name: "koaSimple"
+settings:
+    koa:
+        server: { port: 1234 } #服务器配置 支持 http http2和https
+        # koaStatic: #静态资源访问
+        #     { "public": "public" }
+        swagger:
+            enable: true
+            api: { "index": "/public/api/index.yaml" }
+        extra: #额外配置支持
+            cors: #跨域支持示范
+                origin: "https://localhost:1234"
+                maxAge: 60000 #指定本次预检请求的有效期，单位为秒。
+                credentials: true #是否允许发送Cookie
+                allowMethods: ["GET", "POST"] #设置所允许的HTTP请求方法
+                allowHeaders: ["Content-Type", "Authorization", "Accept"] #设置服务器支持的所有头信息字段
+                exposeHeaders: ["WWW-Authenticate", "Server-Authorization"] #设置获取其他自定义字段

package/test/resource/public/api/index.yaml

@@ -0,0 +1,37 @@
+openapi: "3.0.0"
+info:
+  title: "api 测试"
+  description: "测试"
+  version: "1.0.0"
+servers:
+  - url: http://localhost:1234
+    description: 默认版本
+paths:
+  /getHello:
+    get:
+      summary: hello 请求
+      tags:
+        - "hello"
+      description: ""
+      parameters:
+        - in: query
+          name: id
+          description: 传一个id过去
+          required: true
+          schema:
+            type: integer
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse"
+components:
+  schemas:
+    ApiResponse:
+      type: object
+      properties:
+        code: { type: integer, default: 200, description: "响应码" }
+        msg: { type: string, default: "success", description: "响应描述" }
+        data: { type: object, description: "自定义数据" }

package/test/resource/public/hello.txt

@@ -0,0 +1 @@
+hello world

package/test/simple/app.ts

@@ -0,0 +1,38 @@
+import { FastCarApplication } from "@fastcar/core";
+import { Application } from "@fastcar/core/annotation";
+import EnableKoa from "../../src/annotation/EnableKoa";
+import KoaMiddleware from "../../src/annotation/KoaMiddleware";
+import KoaStatic from "../../src/middleware/KoaStatic";
+import KoaBodyParser from "../../src/middleware/KoaBodyParser";
+import * as Koa from "koa";
+import ExceptionGlobalHandler from "../../src/middleware/ExceptionGlobalHandler";
+import KoaCors from "../../src/middleware/koaCors";
+import Swagger from "../../src/middleware/Swagger";
+
+const m1 = () => {
+	return async (ctx: any, next: Function) => {
+		console.log("m1--- in");
+		await next();
+		console.log("m1--- out");
+	};
+};
+
+const m2 = (): Koa.Middleware => {
+	return async (ctx: any, next: Function) => {
+		console.log("m2--- in");
+		await next();
+		console.log("m2--- out");
+	};
+};
+
+@Application
+@EnableKoa //开启koa
+@KoaMiddleware(ExceptionGlobalHandler, KoaStatic, KoaBodyParser)
+@KoaMiddleware(KoaCors)
+@KoaMiddleware(Swagger)
+@KoaMiddleware(m1, m2)
+class APP {
+	app!: FastCarApplication;
+}
+
+export const app = new APP();

package/test/simple/controller/HelloController.ts

@@ -0,0 +1,37 @@
+import { Controller, Rule, ValidForm } from "@fastcar/core/annotation";
+import GetMapping from "../../../src/annotation/router/GetMapping";
+import PostMapping from "../../../src/annotation/router/PostMapping";
+import RequestMapping from "../../../src/annotation/router/RequestMapping";
+import { GET } from "../../../src/annotation";
+
+@Controller
+// @RequestMapping("/test") //允许头部追加url
+export default class HelloController {
+	hello: string = "hello";
+
+	@GET("/")
+	home() {
+		return "hello world";
+	}
+
+	//支持多种http的请求方式
+	@GetMapping("/getHello")
+	@PostMapping("/getHello")
+	getHello(data: any) {
+		return {
+			code: 200,
+			data: this.hello,
+		};
+	}
+
+	@GetMapping("/getError")
+	getError() {
+		throw new Error("test error");
+	}
+
+	@GetMapping("/checkParam")
+	@ValidForm
+	async checkParam(@Rule({ hello: { required: true, maxSize: 10, type: "string" } }) { hello }: any) {
+		return hello;
+	}
+}