@fastcar/koa 0.1.18 → 0.1.20

package/annotation.d.ts

@@ -6,6 +6,8 @@ type Ret = (target: any) => void;
 
 type MRet = (target: any, name: string, descriptor: PropertyDescriptor) => void;
 
+type PMRet = (target: any, propertyKey: string) => void;
+
 type MiddleWareType = (...args: any) => Koa.Middleware | Koa.Middleware[];
 
 //关于请求方式注解
@@ -44,3 +46,5 @@ export function EnableKoa(target: any): void;
 
 //中间件添加拓展
 export function KoaMiddleware(...args: MiddleWareType[]): Ret;
+
+export function KoaApp(): PMRet;

package/index.d.ts

@@ -7,7 +7,7 @@ type MiddleWareType = (...args: any) => Koa.Middleware | Koa.Middleware[];
 export class KoaApplication {
 	protected app: FastCarApplication;
 	protected sysLogger: Logger;
-	protected koaApp: Koa;
+	public koaApp: Koa;
 
 	/***
 	 * @version 1.0 加载中间件
@@ -38,6 +38,17 @@ export type KoaConfig = {
 	koaBodyOptions?: { [key: string]: any }; //文件上传的解析
 	koaBodyParser?: { [key: string]: any }; //解析请求
 	extra?: { [key: string]: any }; //拓展设置
+	koaProxy?: {
+		//基于http-proxy-middleware来进行拓展
+		[key: string]: {
+			target: string;
+			changeOrigin?: boolean;
+			pathRewrite?: {
+				[key: string]: string;
+			};
+			ws: boolean;
+		} & any;
+	};
 };
 
 //全局异常捕捉 可以用自定义的替换这个函数
@@ -55,10 +66,16 @@ export function KoaCors(app: FastCarApplication): MiddleWareType;
 //解析静态文件
 export function KoaStatic(app: FastCarApplication): MiddleWareType;
 
+//反向代理文件
+export function KoaProxy(app: FastCarApplication): MiddleWareType;
+
 //支持api说明
 export function Swagger(app: FastCarApplication): MiddleWareType;
 
 //增强multi文件解析
 export function KoaMulter(app: FastCarApplication): MiddleWareType;
 
+//校验header 头编码是否错误
+export function HeaderCoding(): MiddleWareType;
+
 export * from "./src/type/DesignMeta";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@fastcar/koa",
-	"version": "0.1.18",
+	"version": "0.1.20",
 	"homepage": "https://github.com/williamDazhangyu/fast-car",
 	"description": "fastcar框架下对koa的包装",
 	"main": "target/index.js",
@@ -30,7 +30,7 @@
 		"node": ">=18"
 	},
 	"devDependencies": {
-		"@fastcar/core": "0.3.1",
+		"@fastcar/core": "^0.3.10",
 		"@fastcar/server": "^0.0.3",
 		"@types/co-body": "^6.1.3",
 		"@types/koa": "^2.13.5",
@@ -51,12 +51,15 @@
 		"@types/koa-range": "^0.3.2",
 		"@types/koa-static": "^4.0.2",
 		"@types/koa2-cors": "^2.0.2",
+		"http-proxy-middleware": "^3.0.5",
 		"koa-body": "^4.2.0",
 		"koa-mount": "^4.0.0",
 		"koa-range": "^0.3.0",
 		"koa-static": "^5.0.0",
+		"koa2-connect": "^1.0.2",
 		"koa2-cors": "^2.0.6",
-		"multer": "*"
+		"multer": "*",
+		"path-to-regexp": "^8.3.0"
 	},
 	"peerDependenciesMeta": {
 		"@types/koa-mount": {

package/src/KoaApplication.ts

@@ -8,7 +8,6 @@ import { DesignMeta } from "./type/DesignMeta";
 import { TypeUtil, ValidationUtil } from "@fastcar/core/utils";
 import { KoaConfig } from "./type/KoaConfig";
 import { ServerApplication } from "@fastcar/server";
-
 /***
  * @version 1.0 koa基础组件启动
  *
@@ -22,7 +21,7 @@ export default class KoaApplication {
 	@Log("koa")
 	protected koaLogger!: Logger;
 
-	protected koaApp: Koa;
+	public koaApp: Koa;
 
 	@Autowired
 	private serverApplication!: ServerApplication;

package/src/annotation/KoaApp.ts

@@ -0,0 +1,21 @@
+import { FastCarMetaData } from "@fastcar/core";
+import KoaApplication from "../KoaApplication";
+
+const koaApp = "koaApp";
+
+/**
+ * @version 1.0.0 获取koa-app方法
+ */
+export default function KoaApp(target: any, propertyKey: string) {
+	Reflect.defineMetadata(
+		FastCarMetaData.InjectionValue,
+		[
+			{
+				key: koaApp,
+				propertyKey: propertyKey,
+				relayTarget: KoaApplication,
+			},
+		],
+		target
+	);
+}

package/src/annotation/router/AddMapping.ts

@@ -3,8 +3,7 @@ import { MethodType } from "../../type/MethodType";
 import { DesignMeta } from "../../type/DesignMeta";
 
 export default function AddMapping(target: any, info: MethodType) {
-
-	if(!info.url) {
+	if (!info.url) {
 		info.url = info.method;
 	}
 
@@ -19,13 +18,18 @@ export default function AddMapping(target: any, info: MethodType) {
 		Reflect.defineMetadata(DesignMeta.ROUTER_MAP, routerMap, target);
 	}
 
-	let curr = routerMap.get(info.url);
-	if (!curr) {
-		routerMap.set(info.url, info);
-	} else {
-		if (info.url != curr.url) {
-			console.warn(`The two URL names are inconsisten in (${info.url},${curr.url})`);
+	//修改主键 根据url-method作为唯一主键
+	info.request.forEach((m) => {
+		let urlKey = `${info.url}:${m}`;
+
+		let curr = routerMap.get(urlKey);
+		if (!curr) {
+			routerMap.set(urlKey, info);
+		} else {
+			if (info.url != curr.url) {
+				console.warn(`The two URL names are inconsisten in (${info.url},${curr.url})`);
+			}
+			curr.request = [...info.request, ...curr.request];
 		}
-		curr.request = [...info.request, ...curr.request];
-	}
+	});
 }

package/src/annotation.ts

@@ -1,4 +1,5 @@
 import EnableKoa from "./annotation/EnableKoa";
+import KoaApp from "./annotation/KoaApp";
 import KoaMiddleware from "./annotation/KoaMiddleware";
 import AddMapping from "./annotation/router/AddMapping";
 import AllMapping from "./annotation/router/AllMapping";
@@ -40,4 +41,5 @@ export {
 	PATCH,
 	ALL,
 	REQUEST,
+	KoaApp,
 };

package/src/index.ts

@@ -7,5 +7,6 @@ import KoaCors from "./middleware/KoaCors";
 import KoaStatic from "./middleware/KoaStatic";
 import { DesignMeta } from "./type/DesignMeta";
 import KoaMulter from "./middleware/KoaMulter";
+import HeaderCoding from "./middleware/HeaderCoding";
 
-export { KoaApplication, KoaConfig, ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors, KoaStatic, KoaMulter, DesignMeta };
+export { KoaApplication, KoaConfig, ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors, KoaStatic, KoaMulter, HeaderCoding, DesignMeta };

package/src/middleware/HeaderCoding.ts

@@ -0,0 +1,14 @@
+//处理由于第三方头不规范导致的问题
+import * as koa from "koa";
+
+const ValidEncoding = ["gzip", "deflate", "br", "identity"];
+
+export default function HeaderCoding() {
+	return async function (ctx: koa.Context, next: Function) {
+		let encoding = ctx.headers["content-encoding"];
+		if (encoding && !ValidEncoding.includes(encoding)) {
+			delete ctx.headers["content-encoding"];
+		}
+		await next();
+	};
+}

package/src/middleware/KoaMulter.ts

@@ -1,7 +1,5 @@
-import { FastCarApplication } from "@fastcar/core";
-
 //对文件内容做解析
-export default function KoaMulter(app: FastCarApplication) {
+export default function KoaMulter() {
 	const multer = require("@koa/multer");
 
 	return multer().single();

package/src/middleware/KoaProxy.ts

@@ -0,0 +1,29 @@
+import { FastCarApplication } from "@fastcar/core";
+import * as Koa from "koa";
+import { KoaConfig } from "../type/KoaConfig";
+
+//反向代理扩展
+export default function KoaProxy(app: FastCarApplication): Koa.Middleware {
+	const httpProxy = require("http-proxy-middleware");
+	const k2c = require("koa2-connect");
+	const { match } = require("path-to-regexp");
+
+	return async function (ctx, next) {
+		let koaConfig: KoaConfig = app.getSetting("koa");
+
+		if (koaConfig && koaConfig.koaProxy) {
+			const { path } = ctx;
+			for (const route of Object.keys(koaConfig.koaProxy)) {
+				if (
+					match(route, {
+						decode: decodeURIComponent,
+					})(path)
+				) {
+					return await k2c(httpProxy.createProxyMiddleware(koaConfig.koaProxy[route]))(ctx, next);
+				}
+			}
+		}
+
+		await next();
+	};
+}

package/src/type/KoaConfig.ts

@@ -7,4 +7,15 @@ export type KoaConfig = {
 	koaBodyOptions?: { [key: string]: any }; //文件上传的解析
 	koaBodyParser?: { [key: string]: any }; //bodyParser.Options; //解析请求
 	extra?: { [key: string]: any }; //拓展设置
+	koaProxy?: {
+		//基于http-proxy-middleware来进行拓展
+		[key: string]: {
+			target: string;
+			changeOrigin?: boolean;
+			pathRewrite?: {
+				[key: string]: string;
+			};
+			ws: boolean;
+		} & any;
+	};
 };

package/target/annotation/KoaApp.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = KoaApp;
+const core_1 = require("@fastcar/core");
+const KoaApplication_1 = require("../KoaApplication");
+const koaApp = "koaApp";
+/**
+ * @version 1.0.0 获取koa-app方法
+ */
+function KoaApp(target, propertyKey) {
+    Reflect.defineMetadata(core_1.FastCarMetaData.InjectionValue, [
+        {
+            key: koaApp,
+            propertyKey: propertyKey,
+            relayTarget: KoaApplication_1.default,
+        },
+    ], target);
+}

package/target/annotation/router/AddMapping.js

@@ -16,14 +16,18 @@ function AddMapping(target, info) {
         routerMap = new Map();
         Reflect.defineMetadata(DesignMeta_1.DesignMeta.ROUTER_MAP, routerMap, target);
     }
-    let curr = routerMap.get(info.url);
-    if (!curr) {
-        routerMap.set(info.url, info);
-    }
-    else {
-        if (info.url != curr.url) {
-            console.warn(`The two URL names are inconsisten in (${info.url},${curr.url})`);
+    //修改主键 根据url-method作为唯一主键
+    info.request.forEach((m) => {
+        let urlKey = `${info.url}:${m}`;
+        let curr = routerMap.get(urlKey);
+        if (!curr) {
+            routerMap.set(urlKey, info);
         }
-        curr.request = [...info.request, ...curr.request];
-    }
+        else {
+            if (info.url != curr.url) {
+                console.warn(`The two URL names are inconsisten in (${info.url},${curr.url})`);
+            }
+            curr.request = [...info.request, ...curr.request];
+        }
+    });
 }

package/target/annotation.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REQUEST = exports.ALL = exports.PATCH = exports.PUT = exports.DELETE = exports.POST = exports.GET = exports.KoaMiddleware = exports.EnableKoa = exports.RequestMapping = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.GetMapping = exports.DeleteMapping = exports.AllMapping = exports.AddMapping = void 0;
+exports.KoaApp = exports.REQUEST = exports.ALL = exports.PATCH = exports.PUT = exports.DELETE = exports.POST = exports.GET = exports.KoaMiddleware = exports.EnableKoa = exports.RequestMapping = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.GetMapping = exports.DeleteMapping = exports.AllMapping = exports.AddMapping = void 0;
 const EnableKoa_1 = require("./annotation/EnableKoa");
 exports.EnableKoa = EnableKoa_1.default;
+const KoaApp_1 = require("./annotation/KoaApp");
+exports.KoaApp = KoaApp_1.default;
 const KoaMiddleware_1 = require("./annotation/KoaMiddleware");
 exports.KoaMiddleware = KoaMiddleware_1.default;
 const AddMapping_1 = require("./annotation/router/AddMapping");

package/target/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DesignMeta = exports.KoaMulter = exports.KoaStatic = exports.KoaCors = exports.KoaBodyParser = exports.KoaBody = exports.ExceptionGlobalHandler = exports.KoaApplication = void 0;
+exports.DesignMeta = exports.HeaderCoding = exports.KoaMulter = 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");
@@ -17,3 +17,5 @@ const DesignMeta_1 = require("./type/DesignMeta");
 Object.defineProperty(exports, "DesignMeta", { enumerable: true, get: function () { return DesignMeta_1.DesignMeta; } });
 const KoaMulter_1 = require("./middleware/KoaMulter");
 exports.KoaMulter = KoaMulter_1.default;
+const HeaderCoding_1 = require("./middleware/HeaderCoding");
+exports.HeaderCoding = HeaderCoding_1.default;

package/target/middleware/HeaderCoding.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = HeaderCoding;
+const ValidEncoding = ["gzip", "deflate", "br", "identity"];
+function HeaderCoding() {
+    return async function (ctx, next) {
+        let encoding = ctx.headers["content-encoding"];
+        if (encoding && !ValidEncoding.includes(encoding)) {
+            delete ctx.headers["content-encoding"];
+        }
+        await next();
+    };
+}

package/target/middleware/KoaMulter.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = KoaMulter;
 //对文件内容做解析
-function KoaMulter(app) {
+function KoaMulter() {
     const multer = require("@koa/multer");
     return multer().single();
 }

package/target/middleware/KoaProxy.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = KoaProxy;
+//反向代理扩展
+function KoaProxy(app) {
+    const httpProxy = require("http-proxy-middleware");
+    const k2c = require("koa2-connect");
+    const { match } = require("path-to-regexp");
+    return async function (ctx, next) {
+        let koaConfig = app.getSetting("koa");
+        if (koaConfig && koaConfig.koaProxy) {
+            const { path } = ctx;
+            for (const route of Object.keys(koaConfig.koaProxy)) {
+                if (match(route, {
+                    decode: decodeURIComponent,
+                })(path)) {
+                    return await k2c(httpProxy.createProxyMiddleware(koaConfig.koaProxy[route]))(ctx, next);
+                }
+            }
+        }
+        await next();
+    };
+}

package/test/logs/sys.log

@@ -141,3 +141,45 @@
 {"timestamp":"2025-07-10 13:33:04.671","level":"INFO","label":"sys","message":"http server is running in 1234"}
 {"timestamp":"2025-07-10 13:33:04.672","level":"INFO","label":"sys","message":"start server koaSimple is run"}
 {"timestamp":"2025-07-10 13:33:04.673","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-07-29 16:31:09.811","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-07-29 16:31:11.641","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-07-29 16:31:11.641","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-07-29 16:31:11.648","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-07-29 16:31:11.648","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-07-29 16:31:11.649","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-22 17:28:39.115","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-22 17:28:41.189","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-22 17:28:41.190","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-22 17:28:43.337","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-22 17:28:43.338","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-22 17:28:43.339","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-22 17:31:22.709","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-22 17:31:23.51","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-22 17:31:23.52","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-22 17:31:23.100","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-22 17:31:23.101","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-22 17:31:23.101","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-22 17:32:19.934","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-22 17:32:20.252","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-22 17:32:20.253","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-22 17:32:20.303","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-22 17:32:20.304","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-22 17:32:20.305","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-23 10:47:56.901","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-23 10:47:59.717","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-23 10:47:59.718","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-23 10:47:59.730","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-23 10:47:59.731","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-23 10:47:59.731","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-23 10:49:47.715","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-23 10:49:48.98","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-23 10:49:48.99","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-23 10:49:48.106","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-23 10:49:48.106","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-23 10:49:48.107","level":"INFO","label":"sys","message":"version 1.0.0"}
+{"timestamp":"2025-12-23 10:59:33.290","level":"INFO","label":"sys","message":"Start scanning component"}
+{"timestamp":"2025-12-23 10:59:33.820","level":"INFO","label":"sys","message":"Complete component scan"}
+{"timestamp":"2025-12-23 10:59:33.822","level":"INFO","label":"sys","message":"Call application initialization method"}
+{"timestamp":"2025-12-23 10:59:33.833","level":"INFO","label":"sys","message":"http server is running in 1234"}
+{"timestamp":"2025-12-23 10:59:33.834","level":"INFO","label":"sys","message":"start server koaSimple is run"}
+{"timestamp":"2025-12-23 10:59:33.835","level":"INFO","label":"sys","message":"version 1.0.0"}

package/test/resource/application.yml

@@ -8,6 +8,7 @@ settings:
         swagger:
             enable: true
             api: { "index": "/public/api/index.yaml" }
+        koaProxy: { "/:path(.*).php": { target: "http://localhost.better.lg", changeOrigin: true }, "/api/:path*": { target: "https://localhost.better.lg", "changeOrigin": true } }
         extra: #额外配置支持
             cors: #跨域支持示范
                 origin: "https://localhost:1234"