From 1613991ee4a43ed5a6671404be078e5cd3ce930e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E6=98=8E=E5=8D=8E?= <735161977@qq.com> Date: Sat, 16 Dec 2023 02:01:44 +0800 Subject: [PATCH 1/2] =?UTF-8?q?1=E3=80=81=E6=8F=90=E5=8D=87=E7=89=88?= =?UTF-8?q?=E6=9C=AC=E5=88=B0=201.0.0=202=E3=80=81=E6=B7=BB=E5=8A=A0AOP?= =?UTF-8?q?=E6=96=B9=E6=B3=95=E8=A3=85=E9=A5=B0=E5=99=A8=203=E3=80=81?= =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=9F=BA=E7=A1=80=E8=AE=A4=E8=AF=81=E6=9E=B6?= =?UTF-8?q?=E6=9E=84=E8=AE=BE=E8=AE=A1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 2 +- src/index.ts | 32 +++++++++- src/restful/authorize.ts | 52 +++++++++++++++++ src/restful/index.ts | 1 + src/utils/aspect.ts | 34 +++++++++++ src/utils/shared.ts | 8 +++ tsconfig.json | 123 ++++++--------------------------------- 7 files changed, 145 insertions(+), 107 deletions(-) create mode 100644 src/restful/authorize.ts create mode 100644 src/utils/aspect.ts diff --git a/package.json b/package.json index 658321e..2fdb7a1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@wangminghua/koa-restful", - "version": "0.2.6", + "version": "1.0.0", "description": "Koa Restful 是一个基于 Koa 框架的 Restful Web API 插件开源库，使用 TypeScript 构建。它旨在提供一种轻量、高效、易用的方式来构建 RESTful 风格的后端服务。", "main": "./dist/index.js", "types": "./dist/types/index.d.ts", diff --git a/src/index.ts b/src/index.ts index 46158d4..3ff41c6 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,7 +5,8 @@ import { Context, HttpError as KoaHttpError, Next } from 'koa' import compose from 'koa-compose' import { getControllers } from './restful' -import { DefaultControllerOptions, HttpError, KEY_METHOD, KEY_PARAMETER, KEY_ROUTE, KEY_ROUTE_PREFIX, ParameterConverterFn, RecordMethods, RequestMethod, isNullOrUndefined, join } from './utils/shared' +import { Hook } from './utils/aspect' +import { DefaultControllerOptions, HttpError, KEY_AFTER_HOOK, KEY_BEFORE_HOOK, KEY_METHOD, KEY_PARAMETER, KEY_ROUTE, KEY_ROUTE_PREFIX, ParameterConverterFn, RecordMethods, RequestMethod, isNullOrUndefined, join, parsePropertyKey } from './utils/shared' export * from '@wangminghua/di' export * from './openapi' @@ -21,6 +22,20 @@ type KoaRestfulOptions = { logs?: boolean } +function parseBeforeHooks(cls: Function, propertyKey: string): Array { + const metadataKey = `${KEY_BEFORE_HOOK}${parsePropertyKey(propertyKey)}` + const hooks = Reflect.getMetadata(metadataKey, cls) as Array | undefined + + return hooks || [] +} + +function parseAfterHooks(cls: Function, propertyKey: string): Array { + const metadataKey = `${KEY_AFTER_HOOK}${parsePropertyKey(propertyKey)}` + const hooks = Reflect.getMetadata(metadataKey, cls) as Array | undefined + + return hooks || [] +} + /** * 延迟处理化控制器 * @param options @@ -70,13 +85,28 @@ async function delayInit(options?: KoaRestfulOptions) { args.splice(index, 1, value) } //#endregion + try { + //#region 调用前置钩子函数 + const beforeHooks = parseBeforeHooks(controller.cls, propertyKey) + for (const hook of beforeHooks) { + await hook(ctx) + } + //#endregion + // 调用控制器方法，通过bind设置上下文 const fnResult = fn?.apply(instance, args) const data = fnResult instanceof Promise ? await fnResult : fnResult ctx.response.status = 200 ctx.response.body = data await next() + + //#region 调用后置钩子函数 + const afterHooks = parseAfterHooks(controller.cls, propertyKey) + for (const hook of afterHooks) { + await hook(ctx) + } + //#endregion } catch (e: any) { if (e instanceof HttpError) { ctx.response.status = e.status diff --git a/src/restful/authorize.ts b/src/restful/authorize.ts new file mode 100644 index 0000000..ffa2520 --- /dev/null +++ b/src/restful/authorize.ts @@ -0,0 +1,52 @@ +import { Context } from 'koa' +import { Aspect } from '../utils/aspect' +import { isNullOrUndefined } from '../utils/shared' + +const container = new Map() +/** + * 认证方式 + */ +export interface IAuthorization { + /** + * 钩子函数，执行身份认证 + * @param ctx koa Context + */ + hook(ctx: Context): Promise +} +/** + * 授权认证 + * @param authenticationSchemes 身份认证方案，不输入值时取默认方式认证，否则使用指定的方案或方案集合认证 + * @returns + * @description 请注意，如果输入的是认证方案集合，则集合中的任意方案均可通过认证后。 + */ +export function Authorize(authenticationSchemes?: string | string[]): MethodDecorator { + return Aspect( + async (ctx: Context) => { + if (container.size === 0) throw new Error('没有任何身份验证方案') + + // 没有指定身份认证方案，使用默认的方案进行认证 + let schemes: string[] = Array.isArray(authenticationSchemes) ? authenticationSchemes : isNullOrUndefined(authenticationSchemes) ? [container.keys()[0]] : [authenticationSchemes as string] + // 遍历执行认证方案 + for (const scheme of schemes) { + if (!container.has(scheme)) throw new Error(`无效的认证方案:${scheme}`) + const { hook } = container.get(scheme) as IAuthorization + const success = await hook(ctx) + if (success) return // 身份认证通过 + } + ctx.response.status = 401 // 所有身份认证方式均未通过 + return Promise.reject() + }, + { + hookType: '__BEFORE_HOOK__', + } + ) +} + +/** + * 添加身份认证方案 + * @param authenticationScheme 身份认证方案名称 + * @param authorization 认证方式 + */ +export function AddAuthentication(authenticationScheme: string, authorization: IAuthorization) { + container.set(authenticationScheme, authorization) +} diff --git a/src/restful/index.ts b/src/restful/index.ts index 91f1773..2bdd1ec 100644 --- a/src/restful/index.ts +++ b/src/restful/index.ts @@ -1,6 +1,7 @@ import { IScopeService, Lifecycle, SingletonScopeService, TransientScopeService } from '@wangminghua/di' import { DefaultControllerOptions, KEY_ROUTE, KEY_ROUTE_PREFIX, isNullOrUndefined } from '../utils/shared' +export * from './authorize' export * from './from-type' export * from './request-method' diff --git a/src/utils/aspect.ts b/src/utils/aspect.ts new file mode 100644 index 0000000..04061f1 --- /dev/null +++ b/src/utils/aspect.ts @@ -0,0 +1,34 @@ +// declare type ClassDecorator = (target: TFunction) => TFunction | void +// declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void +// declare type MethodDecorator = (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor) => TypedPropertyDescriptor | void +// declare type ParameterDecorator = (target: Object, propertyKey: string | symbol | undefined, parameterIndex: number) => void +import { Context } from 'koa' +import { KEY_AFTER_HOOK, KEY_BEFORE_HOOK, parsePropertyKey } from './shared' + +export type Hook = (ctx: Context) => Promise +/** + * 切面选项 + */ +type AspectOptions = { + /** + * 钩子类型 + */ + hookType: typeof KEY_BEFORE_HOOK | typeof KEY_AFTER_HOOK +} +/** + * 切面函数 + */ +export function Aspect(hook: Hook, options?: AspectOptions): MethodDecorator { + const { hookType } = { + hookType: KEY_BEFORE_HOOK, + ...options, + } as AspectOptions + return function (target: Object, propertyKey: string | symbol): void { + const metadataKey = `${hookType}${parsePropertyKey(propertyKey)}` + if (!Reflect.hasMetadata(metadataKey, target.constructor)) { + Reflect.defineMetadata(metadataKey, [], target.constructor) + } + const hooks = Reflect.getMetadata(metadataKey, target.constructor) as Array + hooks.push(hook) + } +} diff --git a/src/utils/shared.ts b/src/utils/shared.ts index 1c40c7d..ac38278 100644 --- a/src/utils/shared.ts +++ b/src/utils/shared.ts @@ -1,6 +1,14 @@ import { Lifecycle } from '@wangminghua/di' import { Context, Next } from 'koa' +/** + * Before Hook KEY + */ +export const KEY_BEFORE_HOOK = '__BEFORE_HOOK__' +/** + * After Hook KEY + */ +export const KEY_AFTER_HOOK = '__AFTER_HOOK__' /** * Route KEY */ diff --git a/tsconfig.json b/tsconfig.json index e87eeab..d98174b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,109 +1,22 @@ { "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": "ES2015" /* 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": "./", /* 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 ''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. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ - // "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": "./dist/types" /* Specify the output directory for generated declaration files. */, - // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ - - /* 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. */ - // "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. */ + "baseUrl": ".", + "target": "ES2015", + "experimentalDecorators": true, + "emitDecoratorMetadata": true, + "module": "commonjs", + "declaration": true, + "declarationMap": true, + "sourceMap": true, + "outDir": "./dist", + "declarationDir": "./dist/types", + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "skipLibCheck": true, + "noImplicitAny": false, + "paths": { + "@/*": ["src/*"] + } } } From f35734655c13f9ab8028152d60a6ffbe94855a45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E6=98=8E=E5=8D=8E?= <735161977@qq.com> Date: Sat, 16 Dec 2023 02:05:37 +0800 Subject: [PATCH 2/2] 1.0.0-alpha.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2fdb7a1..0399c53 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@wangminghua/koa-restful", - "version": "1.0.0", + "version": "1.0.0-alpha.1", "description": "Koa Restful 是一个基于 Koa 框架的 Restful Web API 插件开源库，使用 TypeScript 构建。它旨在提供一种轻量、高效、易用的方式来构建 RESTful 风格的后端服务。", "main": "./dist/index.js", "types": "./dist/types/index.d.ts",