详解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实现一个简单的FastCGI服务器实例

    使用Node.js实现一个简单的FastCGI服务器实例

    这篇文章主要介绍了使用Node.js实现一个简单的FastCGI服务器实例,也可以作为一个比较详细的Node.js服务器创建教程,需要的朋友可以参考下
    2014-06-06
  • node.js中的http.request方法使用说明

    node.js中的http.request方法使用说明

    这篇文章主要介绍了node.js中的http.request方法使用说明,本文介绍了http.request的方法说明、语法、接收参数、使用实例和实现源码需要的朋友可以参考下
    2014-12-12
  • 如何利用node转发请求详解

    如何利用node转发请求详解

    这篇文章主要给大家介绍了关于利用node转发请求的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 在Node.js中处理CORS问题的解决方案

    在Node.js中处理CORS问题的解决方案

    当今的网络应用程序越来越多地涉及跨域资源共享(CORS)问题,这是因为现代浏览器实施了安全策略,限制了跨源HTTP请求,什么是CORS?如何在Node.js中处理CORS问题,需要的朋友可以参考下
    2024-07-07
  • Node.js设置CORS跨域请求中多域名白名单的方法

    Node.js设置CORS跨域请求中多域名白名单的方法

    这篇文章主要介绍了Node.js设置CORS跨域请求中多域名白名单的方法,文中通过示例代码介绍的非常详细,相信对大家具有一定的参考价值,需要的朋友们下面来一起看看吧。
    2017-03-03
  • nodejs的http和https下载远程资源post数据实例

    nodejs的http和https下载远程资源post数据实例

    这篇文章主要为大家介绍了nodejs的http和https下载远程资源post数据实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • 浅谈Node异步编程的机制

    浅谈Node异步编程的机制

    本篇文章主要介绍了浅谈Node异步编程的机制,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • nodejs实现获取本地文件夹下图片信息功能示例

    nodejs实现获取本地文件夹下图片信息功能示例

    这篇文章主要介绍了nodejs实现获取本地文件夹下图片信息功能,涉及node.js针对文件、目录的遍历、读取等相关操作技巧,需要的朋友可以参考下
    2019-06-06
  • Node.js通过配置 strict-ssl=false解决npm安装卡住问题

    Node.js通过配置 strict-ssl=false解决npm安装卡住问题

    使用npm安装依赖包是常见的任务之一,有时会遇到安装卡住的问题,本文就来介绍一下通过配置 strict-ssl=false解决npm安装卡住问题,感兴趣的可以了解一下
    2024-12-12
  • 使用Node.js搭建Web服务器

    使用Node.js搭建Web服务器

    这篇文章介绍了使用Node.js搭建Web服务器的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06

最新评论