night-decorator v1.2.3

本项目是基于express封装的路由装饰器，可自动引入控制器，并以装饰器方式引入路由地址

github 项目地址：(https://github.com/by-night/decorator)

下载

npm install night-decorator

1. 使用说明：

参数

autoRouter(Router, options)

• Router: 路由实例
• options: 路由配置 (可选参数)

路由配置options:

• 路由路径：默认为根目录的controller目录，可用过options的 con_path 配置项修改
• 拦截器路径：默认为根目录的interceptor目录，可用过options的 inter_path 配置项修改

app.use(autoRouter(Router, {
    con_path: '/src/controller',
    inter_path: '/src/interceptor'
}));

2. 示例：

• 在根文件(一般为app.js) 中使用：

const express = require("express");
const autoRouter = require('night-decorator');
const app = express();
// 传入 express 的路由
app.use(autoRouter(new express.Router()));

app.listen('8888', () => {
    console.log(`server is running on port 8888`);
});

• 在根目录中创建控制器目录 control, 创建控制器文件

const {Post, Controller} = require('night-decorator/decorator');
 // 公共前缀
@Controller('/demo')
class Test {
    // 当前url（Post 请求）
    // 请求支持 Post,Get,Put,Delete,Use(请求拦截时使用)方式)
    @Post('/sayHello') 
    sayHello(req, res) {
        res.send('hello world');
    }
}

module.exports = Test;

• 在根目录中创建控制器目录 interceptor, 创建拦截器文件（选用）
  (1) 将装饰器放置在类上

const {Interceptor} = require('night-decorator/decorator');
 // 要拦截的前缀
@Interceptor("/demo")
class Test {
    // 必须指定为 init 函数
    init(req, res, next) {
        
        ... // 拦截处理
        
        next();
    }
}

module.exports = Test;

(2) 将装饰器放置在方法上

const {Interceptor} = require('night-decorator/decorator');
class Test {
    @Interceptor("/demo")
    // 方法可随意命名
    say(req, res, next) {
        
        ... // 拦截处理
        
        next();
    }
}

module.exports = Test;

请求地址为:

http://localhost:8888/demo/sayHello (Post 请求)