初次提交
This commit is contained in:
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/node_modules
|
||||||
|
/dist
|
||||||
|
/typing
|
||||||
|
/package-lock.json
|
||||||
16
package.json
Normal file
16
package.json
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"name": "@yizhi/koa-router",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"types": "typing/index.d.ts",
|
||||||
|
"scripts": {},
|
||||||
|
"author": "",
|
||||||
|
"license": "ISC",
|
||||||
|
"description": "",
|
||||||
|
"dependencies": {
|
||||||
|
"koa": "^2.15.3"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/koa": "^2.15.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
12
src/error.ts
Normal file
12
src/error.ts
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
export class RouterError extends Error {
|
||||||
|
#code: string;
|
||||||
|
|
||||||
|
public constructor(code: string, message: string) {
|
||||||
|
super(message);
|
||||||
|
this.#code = code;
|
||||||
|
}
|
||||||
|
|
||||||
|
public get code(): string {
|
||||||
|
return this.#code;
|
||||||
|
}
|
||||||
|
}
|
||||||
2
src/index.ts
Normal file
2
src/index.ts
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from "./error";
|
||||||
|
export * from "./router";
|
||||||
211
src/router.ts
Normal file
211
src/router.ts
Normal file
@ -0,0 +1,211 @@
|
|||||||
|
import { Middleware } from "koa";
|
||||||
|
import Koa from "koa";
|
||||||
|
import { RouterError } from "./error";
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
export type KoaRouterMethods = "get" | "post" | "put" | "delete" | "patch";
|
||||||
|
|
||||||
|
interface IKoaRouterMatcher {
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IKoaRouteConfig {
|
||||||
|
method: KoaRouterMethods
|
||||||
|
pathname: string
|
||||||
|
regexp: RegExp
|
||||||
|
parsers: Record<string, IKoaRouterTypeParser>
|
||||||
|
middleware: Middleware
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IKoaRouterTypeParser {
|
||||||
|
(value: string): any
|
||||||
|
}
|
||||||
|
|
||||||
|
type KoaRouterDefaultTypes = "int" | "boolean";
|
||||||
|
|
||||||
|
export interface IKoaRouterOptions {
|
||||||
|
/** 前缀 */
|
||||||
|
prefix?: string;
|
||||||
|
/** 默认的参数类型，如果传true则安装所有，如果传数组则安装指定的类型 */
|
||||||
|
defaultParamTypes?: Array<KoaRouterDefaultTypes> | boolean;
|
||||||
|
/** 自定义类型 */
|
||||||
|
customParamtypes?: Record<string, { regexp: RegExp, parser?: IKoaRouterTypeParser }>
|
||||||
|
}
|
||||||
|
|
||||||
|
export class KoaRouter {
|
||||||
|
|
||||||
|
#option: IKoaRouterOptions
|
||||||
|
#types: Record<string, { regexpString: string, parser?: IKoaRouterTypeParser }> = {};
|
||||||
|
#routes: IKoaRouteConfig[] = [];
|
||||||
|
|
||||||
|
constructor(option?: IKoaRouterOptions) {
|
||||||
|
this.#option = {
|
||||||
|
...option,
|
||||||
|
prefix: option?.prefix?.replace(/\/+$/, "") ?? "/",
|
||||||
|
};
|
||||||
|
|
||||||
|
//参数类型安装
|
||||||
|
if (typeof option?.defaultParamTypes === "boolean") {
|
||||||
|
if (option.defaultParamTypes) this.installDefaultParamTypes();
|
||||||
|
}
|
||||||
|
else if (Array.isArray(option?.defaultParamTypes)) this.installDefaultParamTypes(option.defaultParamTypes);
|
||||||
|
|
||||||
|
//自定义类型安装
|
||||||
|
if (option?.customParamtypes) {
|
||||||
|
for (const key in option.customParamtypes) {
|
||||||
|
this.installParamType(key, option.customParamtypes[key].regexp, option.customParamtypes[key].parser);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 安装类型，类型安装后，可以在路由路径中使用类型参数，例如：
|
||||||
|
*
|
||||||
|
* "/users/{id:int}"
|
||||||
|
*
|
||||||
|
* "/users/{name:string}"
|
||||||
|
*
|
||||||
|
* @param typename 类型名称
|
||||||
|
* @param regexp 类型正则表达式（不能包含开始符号^和结束符号$）
|
||||||
|
* @param parser 匹配结果转换函数
|
||||||
|
*/
|
||||||
|
public installParamType(typename: string, regexp: RegExp, parser?: IKoaRouterTypeParser) {
|
||||||
|
this.#types[typename] = { regexpString: regexp.toString().slice(1, -1), parser };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 安装默认类型
|
||||||
|
* @param types 要安装的类型，如果没有传递则安装所有类型
|
||||||
|
*/
|
||||||
|
public installDefaultParamTypes(types?: KoaRouterDefaultTypes[]) {
|
||||||
|
const typeMap: Record<KoaRouterDefaultTypes, { regexp: RegExp, parser?: IKoaRouterTypeParser }> = {
|
||||||
|
"int": { regexp: /\d+/, parser: parseInt },
|
||||||
|
"boolean": { regexp: /(true|false|yes|no|on|off)/, parser: (v: string) => v.toLowerCase() == "true" },
|
||||||
|
};
|
||||||
|
for (const type of types ?? Object.keys(typeMap)) {
|
||||||
|
if (typeMap[type as KoaRouterDefaultTypes]) this.installParamType(type, typeMap[type as KoaRouterDefaultTypes].regexp, typeMap[type as KoaRouterDefaultTypes].parser);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册路由
|
||||||
|
* @param method 路由方法
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public register(method: KoaRouterMethods[], pathname: string, middleware: Middleware): void {
|
||||||
|
//处理路径参数
|
||||||
|
const prefix = this.#option.prefix?.replace(/\/+$/, "") ?? "";
|
||||||
|
pathname = prefix + (pathname[0] == "/" ? pathname : `/${pathname}`);
|
||||||
|
|
||||||
|
//匹配参数
|
||||||
|
// 支持的参数格式有:
|
||||||
|
// {name}
|
||||||
|
// {name:type}
|
||||||
|
const res = pathname.matchAll(/\{([a-zA-Z][a-zA-Z0-9_]*)(:([a-zA-Z][a-zA-Z0-9_]*))?\}/g);
|
||||||
|
const parsers: IKoaRouteConfig["parsers"] = {};
|
||||||
|
|
||||||
|
//处理参数，并生成正则表达式
|
||||||
|
const regexpItems: string[] = [];
|
||||||
|
let offset = 0;
|
||||||
|
for (const match of res) {
|
||||||
|
const name = match[1];
|
||||||
|
const type = match[3];
|
||||||
|
//放入路由前部分
|
||||||
|
regexpItems.push(pathname.slice(offset, match.index));
|
||||||
|
|
||||||
|
//放入路由参数部分
|
||||||
|
if (type) {
|
||||||
|
if (!this.#types[type]) throw new RouterError("ERR_ROUTER_PARAM_TYPE_NOT_INSTALL", `路由参数类型"${type}"未安装`);
|
||||||
|
regexpItems.push(`(?<${name}>${this.#types[type].regexpString})`)
|
||||||
|
if (this.#types[type].parser) parsers[name] = this.#types[type].parser;
|
||||||
|
}
|
||||||
|
else regexpItems.push(`(?<${name}>[^/]+)`);
|
||||||
|
|
||||||
|
//剩余内容
|
||||||
|
offset = match.index + match[0].length;
|
||||||
|
}
|
||||||
|
|
||||||
|
//得到正则表达式
|
||||||
|
const regexpStr = "^" + regexpItems.join("") + pathname.slice(offset) + "$";
|
||||||
|
const regexp = new RegExp(regexpStr);
|
||||||
|
|
||||||
|
//注册路由
|
||||||
|
for (const m of method) this.#routes.push({ method: m, pathname, regexp, middleware, parsers });
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册GET路由
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public get(pathname: string, middleware: Middleware) { this.register(["get"], pathname, middleware); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册POST路由
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public post(pathname: string, middleware: Middleware) { this.register(["post"], pathname, middleware); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册PUT路由
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public put(pathname: string, middleware: Middleware) { this.register(["put"], pathname, middleware); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册DELETE路由
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public delete(pathname: string, middleware: Middleware) { this.register(["delete"], pathname, middleware); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册PATCH路由
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public patch(pathname: string, middleware: Middleware) { this.register(["patch"], pathname, middleware); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 注册所有路由方法
|
||||||
|
* @param pathname 路由路径
|
||||||
|
* @param middleware 路由中间件
|
||||||
|
*/
|
||||||
|
public all(pathname: string, middleware: Middleware) { this.register(["get", "post", "put", "delete", "patch"], pathname, middleware); }
|
||||||
|
|
||||||
|
/** 路由匹配中间件 */
|
||||||
|
public callback(): Middleware {
|
||||||
|
return (ctx: Koa.Context, next: Koa.Next) => {
|
||||||
|
//匹配路由
|
||||||
|
const method = ctx.method.toLocaleLowerCase() as KoaRouterMethods;
|
||||||
|
let match: RegExpMatchArray | null = null as any;
|
||||||
|
const route = this.#routes.find(route => {
|
||||||
|
if (route.method != method) return false;
|
||||||
|
match = ctx.URL.pathname.match(route.regexp);
|
||||||
|
return match != null;
|
||||||
|
})
|
||||||
|
if (!route) return next();
|
||||||
|
|
||||||
|
//处理参数
|
||||||
|
const params = match?.groups ?? {};
|
||||||
|
for (const key in route.parsers) {
|
||||||
|
params[key] = route.parsers[key](params[key]);
|
||||||
|
}
|
||||||
|
ctx.params = params;
|
||||||
|
|
||||||
|
//执行中间件
|
||||||
|
return route.middleware(ctx, next);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
get #prefix() {
|
||||||
|
return this.#option.prefix!;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
100
tsconfig.json
Normal file
100
tsconfig.json
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
/* Visit https://aka.ms/tsconfig to read more about this file */
|
||||||
|
/* Projects */
|
||||||
|
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
||||||
|
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
||||||
|
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
||||||
|
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
||||||
|
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
||||||
|
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
||||||
|
/* Language and Environment */
|
||||||
|
"target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
||||||
|
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
||||||
|
// "jsx": "preserve", /* Specify what JSX code is generated. */
|
||||||
|
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
|
||||||
|
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
||||||
|
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
||||||
|
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
||||||
|
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
||||||
|
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
||||||
|
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
||||||
|
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
||||||
|
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
||||||
|
/* Modules */
|
||||||
|
"module": "commonjs", /* Specify what module code is generated. */
|
||||||
|
"rootDir": "./src", /* Specify the root folder within your source files. */
|
||||||
|
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
|
||||||
|
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
||||||
|
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
||||||
|
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
||||||
|
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
||||||
|
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
||||||
|
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||||
|
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
||||||
|
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
|
||||||
|
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
|
||||||
|
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
|
||||||
|
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
|
||||||
|
// "resolveJsonModule": true, /* Enable importing .json files. */
|
||||||
|
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
|
||||||
|
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
||||||
|
/* JavaScript Support */
|
||||||
|
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
||||||
|
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
||||||
|
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
||||||
|
/* Emit */
|
||||||
|
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
||||||
|
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
||||||
|
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
||||||
|
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
||||||
|
"inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
||||||
|
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
||||||
|
"outDir": "./dist", /* Specify an output folder for all emitted files. */
|
||||||
|
// "removeComments": true, /* Disable emitting comments. */
|
||||||
|
// "noEmit": true, /* Disable emitting files from a compilation. */
|
||||||
|
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
||||||
|
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
||||||
|
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
||||||
|
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||||
|
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
||||||
|
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
||||||
|
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
||||||
|
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
||||||
|
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
||||||
|
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
||||||
|
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
||||||
|
"declarationDir": "./typing", /* Specify the output directory for generated declaration files. */
|
||||||
|
/* Interop Constraints */
|
||||||
|
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
||||||
|
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
|
||||||
|
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
|
||||||
|
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
||||||
|
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
||||||
|
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
||||||
|
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
||||||
|
/* Type Checking */
|
||||||
|
"strict": true, /* Enable all strict type-checking options. */
|
||||||
|
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
||||||
|
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
||||||
|
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
||||||
|
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
||||||
|
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
||||||
|
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
||||||
|
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
||||||
|
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
||||||
|
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
||||||
|
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
||||||
|
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
||||||
|
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
||||||
|
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
||||||
|
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
||||||
|
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
||||||
|
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
||||||
|
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
||||||
|
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
||||||
|
/* Completeness */
|
||||||
|
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
||||||
|
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user