@eggjs/tegg-aop-plugin 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.2.0](https://github.com/eggjs/tegg/compare/v0.1.19...v0.2.0) (2022-01-20)
+
+
+### Features
+
+* impl aop ([c53df00](https://github.com/eggjs/tegg/commit/c53df001d1455a0a105689694775d880541d9d2f))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# @eggjs/tegg-aop-plugin
+
+## Usage
+
+```js
+// plugin.js
+export.aopModule = {
+  enable: true,
+  package: '@eggjs/tegg-aop-plugin',
+};
+```
+
+## Advice
+
+使用 `@Advice` 注解来申明一个实现，可以用来监听、拦截方法执行。
+
+**注意：Advice 也是一种 Prototype，可以通过 initType 来指定不同的生命周期。**
+
+```ts
+import { Advice, IAdvice } from '@eggjs/tegg/aop';
+
+@Advice()
+export class AdviceExample implements IAdvice {
+  // Advice 中可以正常的注入其他的对象
+  @Inject()
+  private readonly callTrace: CallTrace;
+
+  // 在函数执行前执行
+  async beforeCall(ctx: AdviceContext): Promise<void> {
+    // ...
+  }
+
+  // 在函数成功后执行
+  async afterReturn(ctx: AdviceContext, result: any): Promise<void> {
+    // ...
+  }
+
+  // 在函数成功后执行
+  async afterThrow(ctx: AdviceContext, error: Error): Promise<void> {
+    // ...
+  }
+
+  // 在函数退出时执行
+  async afterFinally(ctx: AdviceContext): Promise<void> {
+  }
+
+  // 类似 koa 中间件的模式
+  // block = next
+  async around(ctx: AdviceContext, next: () => Promise<any>): Promise<any> {
+  }
+}
+```
+
+## Pointcut
+
+使用 `@Pointcut` 在某个类特定的方法上申明一个 `Advice`
+
+```ts
+import { Pointcut } from '@eggjs/tegg/aop';
+import { ContextProto } from '@eggjs/tegg';
+
+@ContextProto()
+export class Hello {
+  @Pointcut(AdviceExample)
+  async hello(name: string) {
+    return `hello ${name}`;
+  }
+}
+```
+
+## Crosscut
+
+使用 `@Crosscut` 来声明一个通用的 `Advice`，有三种模式
+- 指定类和方法
+- 通过正则指定类和方法
+- 通过回调来指定类和方法
+
+**注意：egg 中的对象无法被 Crosscut 指定到。**
+
+```ts
+import { Crosscut, Advice, IAdvice } from '@eggjs/tegg/aop';
+
+// 通过类型来指定
+@Crosscut({
+  type: PointcutType.CLASS,
+  clazz: CrosscutExample,
+  methodName: 'hello',
+})
+@Advice()
+export class CrosscutClassAdviceExample implements IAdvice {
+}
+
+// 通过正则来指定
+@Crosscut({
+  type: PointcutType.NAME,
+  className: /crosscut.*/i,
+  methodName: /hello/,
+})
+@Advice()
+export class CrosscutNameAdviceExample implements IAdvice {
+}
+
+// 通过回调来指定
+@Crosscut({
+  type: PointcutType.CUSTOM,
+  callback:  (clazz: EggProtoImplClass, method: PropertyKey) => {
+    return clazz === CrosscutExample && method === 'hello';
+  }
+})
+@Advice()
+****export class CrosscutCustomAdviceExample implements IAdvice {
+}
+
+```

package/app.d.ts

@@ -0,0 +1,10 @@
+export default class AopAppHook {
+    private readonly app;
+    private readonly crosscutAdviceFactory;
+    private readonly loadUnitAopHook;
+    private readonly eggPrototypeCrossCutHook;
+    private readonly eggObjectAopHook;
+    constructor(app: any);
+    configDidLoad(): void;
+    beforeClose(): void;
+}

package/app.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const aop_1 = require("@eggjs/tegg/aop");
+const tegg_aop_runtime_1 = require("@eggjs/tegg-aop-runtime");
+class AopAppHook {
+    constructor(app) {
+        this.app = app;
+        this.crosscutAdviceFactory = new aop_1.CrosscutAdviceFactory();
+        this.loadUnitAopHook = new tegg_aop_runtime_1.LoadUnitAopHook(this.crosscutAdviceFactory);
+        this.eggPrototypeCrossCutHook = new tegg_aop_runtime_1.EggPrototypeCrossCutHook(this.crosscutAdviceFactory);
+        this.eggObjectAopHook = new tegg_aop_runtime_1.EggObjectAopHook();
+    }
+    configDidLoad() {
+        this.app.eggPrototypeLifecycleUtil.registerLifecycle(this.eggPrototypeCrossCutHook);
+        this.app.loadUnitLifecycleUtil.registerLifecycle(this.loadUnitAopHook);
+        this.app.eggObjectLifecycleUtil.registerLifecycle(this.eggObjectAopHook);
+    }
+    beforeClose() {
+        this.app.eggPrototypeLifecycleUtil.deleteLifecycle(this.eggPrototypeCrossCutHook);
+        this.app.loadUnitLifecycleUtil.deleteLifecycle(this.loadUnitAopHook);
+        this.app.eggObjectLifecycleUtil.deleteLifecycle(this.eggObjectAopHook);
+    }
+}
+exports.default = AopAppHook;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiYXBwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EseUNBQXdEO0FBQ3hELDhEQUFzRztBQUV0RyxNQUFxQixVQUFVO0lBUTdCLFlBQVksR0FBRztRQUNiLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO1FBQ2YsSUFBSSxDQUFDLHFCQUFxQixHQUFHLElBQUksMkJBQXFCLEVBQUUsQ0FBQztRQUN6RCxJQUFJLENBQUMsZUFBZSxHQUFHLElBQUksa0NBQWUsQ0FBQyxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUN2RSxJQUFJLENBQUMsd0JBQXdCLEdBQUcsSUFBSSwyQ0FBd0IsQ0FBQyxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUN6RixJQUFJLENBQUMsZ0JBQWdCLEdBQUcsSUFBSSxtQ0FBZ0IsRUFBRSxDQUFDO0lBQ2pELENBQUM7SUFFRCxhQUFhO1FBQ1gsSUFBSSxDQUFDLEdBQUcsQ0FBQyx5QkFBeUIsQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsd0JBQXdCLENBQUMsQ0FBQztRQUNwRixJQUFJLENBQUMsR0FBRyxDQUFDLHFCQUFxQixDQUFDLGlCQUFpQixDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUN2RSxJQUFJLENBQUMsR0FBRyxDQUFDLHNCQUFzQixDQUFDLGlCQUFpQixDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQzNFLENBQUM7SUFFRCxXQUFXO1FBQ1QsSUFBSSxDQUFDLEdBQUcsQ0FBQyx5QkFBeUIsQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLHdCQUF3QixDQUFDLENBQUM7UUFDbEYsSUFBSSxDQUFDLEdBQUcsQ0FBQyxxQkFBcUIsQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ3JFLElBQUksQ0FBQyxHQUFHLENBQUMsc0JBQXNCLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQ3pFLENBQUM7Q0FDRjtBQTNCRCw2QkEyQkMifQ==

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@eggjs/tegg-aop-plugin",
+  "version": "0.2.0",
+  "eggPlugin": {
+    "name": "aopModule",
+    "dependencies": [
+      "tegg"
+    ]
+  },
+  "types": "typings/index.d.ts",
+  "description": "tegg aop plugin",
+  "keywords": [
+    "egg",
+    "typescript",
+    "decorator",
+    "aop",
+    "tegg"
+  ],
+  "files": [
+    "app.js",
+    "app.d.ts"
+  ],
+  "scripts": {
+    "clean": "tsc -b --clean",
+    "tsc": "npm run clean && tsc -p ./tsconfig.json",
+    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
+    "prepublishOnly": "npm run tsc:pub",
+    "autod": "autod"
+  },
+  "homepage": "https://github.com/eggjs/tegg",
+  "bugs": {
+    "url": "https://github.com/eggjs/tegg/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eggjs/tegg.git",
+    "directory": "plugin/aop"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "@eggjs/tegg": "^0.2.0",
+    "@eggjs/tegg-aop-runtime": "^0.2.0"
+  },
+  "devDependencies": {
+    "@eggjs/tegg-config": "^0.2.0",
+    "@eggjs/tegg-plugin": "^0.2.0",
+    "egg": "^2.29.4",
+    "egg-mock": "^4.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "320bffc1f6074d7785a020815e0cdc3c27cc654b"
+}