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

 更新时间:2017年11月15日 09:23:48   作者:yvanwangl  
本篇文章主要介绍了详解IWinter 一个路由转控制器的 Nodejs 库,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

IWinter 是一个路由转控制器的 node 库,只解决一个问题:为了让使用者以更优雅的姿势进行路由的编写。支持在 Express 和 Koa 中使用。

项目地址:https://github.com/yvanwangl/iwinter

简介:

最近在学习使用 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();

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

相关文章

  • node.js回调函数之阻塞调用与非阻塞调用

    node.js回调函数之阻塞调用与非阻塞调用

    本文重点给大家介绍node.js回调函数之阻塞调用和非阻塞调用,涉及到node.js回调函数的相关知识,对本文感兴趣的朋友一起学习吧
    2015-11-11
  • node.js实现上传文件功能

    node.js实现上传文件功能

    这篇文章主要为大家详细介绍了node.js实现上传文件功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • 使用node.js搭建服务器

    使用node.js搭建服务器

    最近需要完成一个课程设计,被项目经理(组长)分配写界面功能,下面小编通过本文给大家分享使用使用node搭建小型服务器的方法,需要的朋友参考下
    2017-05-05
  • Node版本升级和降级之node版本管理工具nvm详解

    Node版本升级和降级之node版本管理工具nvm详解

    nvm是管理node版本的工具,一个电脑中可以安装多个node版本,当我们想使用哪个版本就切换成哪个版本,而nvm则是提供切换node版本的工具,这篇文章主要给大家介绍了关于Node版本升级和降级之node版本管理工具nvm的相关资料,需要的朋友可以参考下
    2022-08-08
  • Node.js 网络框架koa compose中间件使用解析

    Node.js 网络框架koa compose中间件使用解析

    这篇文章主要为大家介绍了Node.js 网络框架koa compose中间件使用解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • 一文详解Node中的文件模块与核心模块

    一文详解Node中的文件模块与核心模块

    这篇文章主要介绍了一文详解Node 中文件模块与核心模块,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下
    2022-07-07
  • 使用DNode实现php和nodejs之间通信的简单实例

    使用DNode实现php和nodejs之间通信的简单实例

    这篇文章主要介绍了使用DNode实现php和nodejs之间通信的简单实例,本文讲解了DNode的安装,以及使用的它的步骤和方法,需要的朋友可以参考下
    2015-07-07
  • 详解Node.js 中使用 ECDSA 签名遇到的坑

    详解Node.js 中使用 ECDSA 签名遇到的坑

    这篇文章主要介绍了详解Node.js 中使用 ECDSA 签名遇到的坑,主要是使用 Node.js 的 Crypto 模块无法校验网络传输过来的签名结果,感兴趣的小伙伴们可以参考一下
    2018-11-11
  • node之本地服务器图片上传的方法示例

    node之本地服务器图片上传的方法示例

    这篇文章主要介绍了node之本地服务器图片上传的方法示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • node NPM库string-random生成随机字符串学习使用

    node NPM库string-random生成随机字符串学习使用

    这篇文章主要为大家介绍了node NPM库string-random生成随机字符串学习使用,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07

最新评论