koa2_autowired_route

Koa2 route autowired

route autowired for koa2 implementation .

特性

• 参考springMVC的注解，基于koa2的路由框架
• 开箱即用
• 简单优雅

新版特性

• 优化@Autowired注入方式
• 优化接口返回方式

安装

npm install koa2_autowired_route --save

示例

目录结构

.../
    src/
        filters/
            demo-filter.ts
        routes/
            route-demo.ts
        main.ts
        override.js
        route.json

//main.ts
import app from 'koa2_autowired_route';
app.listen(3000);

//route.json
{
  "scan-path":"routes",
  "override": "override.js"
}

//route-demo.ts
import { Route, TYPE } from 'koa2_autowired_route/core/annotation';
 
@(Route({ path: 'route-demo', Interceptors: [demoInterceptor] }) as any)
export class RouteDemo {
    @Route({ path: 'demo', type: TYPE.GET })
    async demo(ctx, next) {
        const data = { text: 'hello world' };
        return data;
        //or ctx.body = data;
    }
}

import { Interceptor } from 'koa2_autowired_route/core/annotation';
export class demoInterceptor implements Interceptor{
    intercept(ctx, next): boolean{
        //some if...else...
        return true;
    }
}

运行

npm run ts-node ./src/main.ts

打开http://localhost:3000以在浏览器中查看它 .

装饰器用法

@Route

释义: 接口注解

适用: class, method

可选参数：

{
    path:string,//url路径
    type:enum,//请求类型
    Interceptors:Interceptor[]//拦截器数组
}

path

释义: url路径

类型: string

适用: class, method

type

释义: 请求类型

类型: enum TYPE

适用: method

可选参数:

// 枚举源码
export enum TYPE {
    GET = 'get',
    POST = 'post',
    DELETE = 'delete',
    PUT = 'put'
}

即:

• TYPE.GET
• TYPE.POST
• TYPE.DELETE
• TYPE.PUT

Interceptors

释义: 拦截器集合

类型: Interceptor[]

适用: class, method

元素类型：Interceptor 接口的实现类(可以使用配置多个拦截器)

示例:

import { Interceptor } from 'koa2_autowired_route/core/annotation';
export class demoInterceptor implements Interceptor{
    intercept(ctx, next): boolean{
        //some if...else...
        return true;
    }
}

• return true: 验证通过, 接下来访问接口
• return false: 验证失败, 如果ctx没有抛出异常, 服务器默认会报401

@Autowired

释义: 依赖注入注解

适用: property

必选参数:

(): Object => new Object()

示例:

//route-demo.ts
import { Route, Autowired, TYPE } from 'koa2_autowired_route/core/annotation';
 
@(Route({ path: 'route-demo' }) as any)
export class RouteDemo {
    @(Autowired(() => 'hello world' ) as any)
    demoProperty;
    @Route({ path: 'demo', type: TYPE.GET })
    async demo(ctx, next) {
        return this.demoProperty;
        // 在浏览器中查看此接口,会输出hello world
        // View in browser this, print helloworld
    }
}

自定义Koa对象

override.js

你可以在override.js种自定义koa对象,比如自定义请求头等。例：

//override.js
module.exports = (app) => {
    app.use(async (ctx, next) => {
        await next();
    });
}

注：如果override.js与其他框架的配置文件重叠，可以通过route.json来自定义override.js文件名。例：

//route.json
{
  "override": "test.js"
}

//test.js
module.exports = (app) => {
    app.use(async (ctx, next) => {
        await next();
    });
}

缺陷

• 发现的已修复，待发现。。。

最后

• 期待你的新需求，需求请发送到 [e-mail], 收到后我就会更新啦
• 你认为这个框架哪里不好用也可以提需求啦，发送到上面的邮箱就好啦
• 赏个星啦
• 最后，谢谢各位coder