欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解IWinter 一个路由转控制器的 Nodejs 库

程序员文章站 2022-03-19 22:21:48
iwinter 是一个路由转控制器的 node 库,只解决一个问题:为了让使用者以更优雅的姿势进行路由的编写。支持在 express 和 koa 中使用。 项目地址:...

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:

  1. nodejs 用户
  2. typescript 用户
  3. 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();

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。