IWinter 一個路由轉控制器的 Nodejs 庫

IWinter 是一個路由轉控制器的 node 庫，只解決一個問題：爲了讓使用者以更優雅的姿式進行路由的編寫。支持在 Express 和 Koa 中使用。

項目地址

簡介：

最近在學習使用 Typescript ，打算把之前寫的博客管理後臺用 Typescript 進行全面重構，在重構服務端代碼時接觸到了 Typescript 的裝飾器功能。能夠用裝飾器對路由進行一層包裝，而後就能夠這樣編寫路由：

import {Path, GET, POST, PathParam, BodyParam} from 'iwinter';

@Path('/api/orders')
class OrdersController {

    @GET
    @Path('/:name/:id', (ctx, next)=> ~~ctx.params.id > 20)
       getAllOrders(@PathParam('id') id: number, @PathParam('name') name: string){
        return [{
               id: id, name, content: 'test', author: 'test', comments: []
           }];
    }

    @POST
    @Path('/add')
    addPost(@BodyParam('order') order: object){
        return order;
    }
}

export default OrdersController;複製代碼

因爲工做中會使用 Java 編寫控制層代碼（Spring MVC 的控制層代碼），因此看到這樣的代碼簡直太親切了。並且相較於之前的路由編寫方式更清晰，更方便維護，因此就將原來的的代碼進行了改造。我使用以後發現很是好用，我就想讓更多的人均可以使用，因此就誕生了 IWinter 這個庫。IWinter 就是將各類裝飾器或裝飾器工廠函數進行封裝而後暴露出一些 API 供你們使用。今後就告別這樣編寫路由了 ;)

//app.js
...
let users = require('./routes/users');
let orders = require('./routes/orders');

app.use('/api/users', users);
app.use('/api/orders', orders);
...

//routers/orders.js
...
router.route('/')
    .get(function (req, res, next) {
        let {page, timeRange, customerId, orderNumber} = req.query;
        let limit = constants.PAGE_SIZE;
        let skip = (page - 1) * limit;
        let currentUser = global[Symbol.for('currentUser')];
        let queryCondition = {
            userId: currentUser['_id']
        };
           ...複製代碼

誰適合使用 IWinter:

* Nodejs 用戶
* Typescript 用戶
* Express / Koa 用戶

IWinter 安裝 及 使用

npm install --save iwinter複製代碼

import IWinter from 'iwinter';複製代碼

Koa 中如何使用：

import * as Router from 'koa-router';
...
app.use(new IWinter({
       engine: 'koa',
    router: new Router(),
    dir: path.join(__dirname, 'controller')
}).controller());
...複製代碼

Express 中如何使用：

import * as express from 'express';
let app = express();
let router = express.Router();
...
new IWinter({
    engine: 'express',
    router: app,
    dir: path.join(__dirname, 'controller'),
       prefix: ''
}).controller();複製代碼

使用示例

Express 示例
Koa 示例

詳細配置能夠查看 項目 README

喜歡的話，歡迎使用，歡迎 Star :)