https://github.com/eggjs/egg-aop
AOP plugin for eggjs, add DI, AOP support.
https://github.com/eggjs/egg-aop
aop di egg egg-plugin typescript
Last synced: about 2 months ago
JSON representation
AOP plugin for eggjs, add DI, AOP support.
- Host: GitHub
- URL: https://github.com/eggjs/egg-aop
- Owner: eggjs
- License: mit
- Created: 2018-03-15T06:38:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-28T03:41:46.000Z (about 7 years ago)
- Last Synced: 2025-10-29T21:56:11.722Z (4 months ago)
- Topics: aop, di, egg, egg-plugin, typescript
- Language: TypeScript
- Homepage:
- Size: 52.7 KB
- Stars: 43
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-aop
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-aop.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-aop
[travis-image]: https://img.shields.io/travis/eggjs/egg-aop.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-aop
[codecov-image]: https://codecov.io/github/eggjs/egg-aop/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/eggjs/egg-aop?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-aop.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-aop
[snyk-image]: https://snyk.io/test/npm/egg-aop/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-aop
[download-image]: https://img.shields.io/npm/dm/egg-aop.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-aop
Add DI, AOP support for eggjs.
## DI
### Quick overview
```ts
import { Service, Context } from 'egg';
import { context, lazyInject } from 'egg-aop';
@context() // or @application()
export class TestService extends Service {
get() {
/* code */
}
}
export class Controller {
@lazyInject()
private testService: TestService;
demo() {
this.testService.get();
}
}
```
### API
#### decorators
- `@context(keyType?: any)`
Declaration of life cycle of an instance, is context level. You can provide a class type or from metadata by TypeScript emit.
- `@application(keyType?: any)`
Declaration of life cycle of an instance, is context level. You can provide a class type or from metadata by TypeScript emit.
- `@inject(keyType?: any)`
Inject component when the class is instantiated.
- `@lazyInject(keyType?: any)`
Inject component when accessing the property.
#### functions
- `getInstance(clsType: any, app: any, ctx: any): T`
You can use this function to manually get the component instance.
- `setCreateInstanceHook(func: CreateInstanceHookFunction)`
You can use this function to interception every new component instance.
`type CreateInstanceHookFunction = (instance: any, app: any, ctx?: any) => any;`
#### typeLoader
`typeLoader` is an instance of `IocContext`, it stores all type's classes. You can use this to affect DI behavior.
## AOP
### Quick overview
```ts
function logging(type: string) {
return aspect({
// before method running
before: (context) => { /* log code */ },
// after method running
after: (context) => { /* log code */ },
// when method throw error
onError: (context) => { /* log code */ },
})
}
class DemoService {
@logging('create')
createData() {
/* code */
}
}
/* FunctionContext type define */
export interface FunctionContext {
readonly inst: T;
readonly functionName: string;
args: any[];
ret: any;
err: Error;
}
```
### API
#### functions
- `aspect(point: AspectPoint = {})`
You can use this to intercept method, this function provides `before` / `after` / `error` cross-sections.
```ts
interface AspectPoint {
before?: (context: FunctionContext) => void;
after?: (context: FunctionContext) => void;
error?: (context: FunctionContext) => void;
}
```
The param `context` is the function's execution context. It includes `inst` / `args` / `ret`. You can replace them to affect the function execution.