NodeJS仿WebApi路由示例


Posted in NodeJs onFebruary 28, 2017

用过WebApi或Asp.net MVC的都知道微软的路由设计得非常好,十分方便,也十分灵活。虽然个人看来是有的太灵活了,team内的不同开发很容易使用不同的路由方式而显得有点混乱。 不过这不是重点,我在做Node项目的时候就觉得不停的用use(...)来指定路由路径很烦人,所以用Typescript写了这个基于KoaKoa-router的路由插件,可以简单实现一些类似WebApi的路由功能。

目标是和WebApi一样:

1.加入的controller会自动加入路由。

2.也可以通过path()手动指定路由。

3.可以定义http method, 如GETPOST等。

4.Api的参数可以指定url里的query param、path param以及body等。

包已经上传到npm中,npm install webapi-router 安装,可以先看看效果:

第一步,先设置controllers的目录和url的固定前缀

所有的controller都在这目录下,这样会根据物理路径自动算出路由。 url的固定前缀就是host和路由之间的,比如localhost/api/v2/user/nameapi/v2就是这个固定前缀。

import { WebApiRouter } from 'webapi-router';

app.use(new WebApiRouter().router('sample/controllers', 'api'));

第二步是controller都继承自BaseController

export class TestController extends BaseController
{

}

第三步给controller的方法加上装饰器

@POST('/user/:name')
postWithPathParam(@PathParam('name') name: string, @QueryParam('id') id: string, @BodyParam body: any) {
  console.info(`TestController - post with name: ${name}, body: ${JSON.stringify(body)}`);
  return 'ok';
}

@POST里的参数是可选的,空的话会用这个controller的物理路径做为路由地址。

:name是路径里的变量,比如 /user/brook, :name就是brook,可以在方法的参数里用@PathParam得到

@QueryParam可以得到url?后的参数

@BodyParam可以得到Post上来的body

是不是有点WebApi的意思了。

现在具体看看是怎么实现的

实现过程其实很简单,从上面的目标入手,首先得到controllers的物理路径,然后还要得到被装饰器装饰的方法以及它的参数。
装饰器的目的在于要得到是Get还是Post等,还有就是指定的Path,最后就是把node request里的数据赋值给方法的参数。

核心代码:

得到物理路径

initRouterForControllers() {
  //找出指定目录下的所有继承自BaseController的.js文件
  let files = FileUtil.getFiles(this.controllerFolder);

  files.forEach(file => {
    let exportClass = require(file).default;

    if(this.isAvalidController(exportClass)){
      this.setRouterForClass(exportClass, file);
    }
  });
}

从物理路径转成路由

private buildControllerRouter(file: string){

  let relativeFile = Path.relative(Path.join(FileUtil.getApiDir(), this.controllerFolder), file);
  let controllerPath = '/' + relativeFile.replace(/\\/g, '/').replace('.js','').toLowerCase();

  if(controllerPath.endsWith('controller'))
    controllerPath = controllerPath.substring(0, controllerPath.length - 10);

  return controllerPath;
}

装饰器的实现

装饰器需要引入reflect-metadata库

先看看方法的装饰器,@GET,@POST之类的,实现方法是给装饰的方法加一个属性RouterRouter是个Symbol,确保唯一。 然后分析装饰的功能存到这个属性中,比如MethodPath等。

export function GET(path?: string) {
  return (target: BaseController, name: string) => setMethodDecorator(target, name, 'GET', path);
} 

function setMethodDecorator(target: BaseController, name: string, method: string, path?: string){
  target[Router] = target[Router] || {};
  target[Router][name] = target[Router][name] || {};
  target[Router][name].method = method;
  target[Router][name].path = path;
}

另外还有参数装饰器,用来给参数赋上request里的值,如body,param等。

export function BodyParam(target: BaseController, name: string, index: number) {
  setParamDecorator(target, name, index, { name: "", type: ParamType.Body });
}

function setParamDecorator(target: BaseController, name: string, index: number, value: {name: string, type: ParamType}) {
  let paramTypes = Reflect.getMetadata("design:paramtypes", target, name);
  target[Router] = target[Router] || {};
  target[Router][name] = target[Router][name] || {};
  target[Router][name].params = target[Router][name].params || [];
  target[Router][name].params[index] = { type: paramTypes[index], name: value.name, paramType: value.type };
}

这样装饰的数据就存到对象的Router属性上,后面构建路由时就可以用了。

绑定路由到Koa-router

上面从物理路径得到了路由,但是是以装饰里的参数路径优先,所以先看看刚在存在原型里的Router属性里有没有Path,有的话就用这个作为路由,没有Path就用物理路由。

private setRouterForClass(exportClass: any, file: string) { 

  let controllerRouterPath = this.buildControllerRouter(file);
  let controller = new exportClass();

  for(let funcName in exportClass.prototype[Router]){
    let method = exportClass.prototype[Router][funcName].method.toLowerCase();
    let path = exportClass.prototype[Router][funcName].path;

    this.setRouterForFunction(method, controller, funcName, path ? `/${this.urlPrefix}${path}` : `/${this.urlPrefix}${controllerRouterPath}/${funcName}`);
  }
}

给controller里的方法参数赋上值并绑定路由到KoaRouter

private setRouterForFunction(method: string, controller: any, funcName: string, routerPath: string){
  this.koaRouter[method](routerPath, async (ctx, next) => { await this.execApi(ctx, next, controller, funcName) });
}

private async execApi(ctx: Koa.Context, next: Function, controller: any, funcName: string) : Promise<void> { //这里就是执行controller的api方法了
  try
  {
    ctx.body = await controller[funcName](...this.buildFuncParams(ctx, controller, controller[funcName]));
  }
  catch(err)
  {
    console.error(err);
    next(); 
  }
}

private buildFuncParams(ctx: any, controller: any, func: Function) { //把参数具体的值收集起来
  let paramsInfo = controller[Router][func.name].params;
  let params = [];
  if(paramsInfo)
  {
    for(let i = 0; i < paramsInfo.length; i++) {
      if(paramsInfo[i]){
        params.push(paramsInfo[i].type(this.getParam(ctx, paramsInfo[i].paramType, paramsInfo[i].name)));
      } else {
        params.push(ctx);
      }
    }
  }
  return params;
}

private getParam(ctx: any, paramType: ParamType, name: string){ // 从ctx里把需要的参数拿出来
  switch(paramType){
    case ParamType.Query:
      return ctx.query[name];
    case ParamType.Path:
      return ctx.params[name];
    case ParamType.Body:
      return ctx.request.body;
    default:
      console.error('does not support this param type');
  }
}

这样就完成了简单版的类似WebApi的路由.

源码下载:webapi-router_3water.rar

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

NodeJs 相关文章推荐
nodejs之请求路由概述
Jul 05 NodeJs
轻松创建nodejs服务器(9):实现非阻塞操作
Dec 18 NodeJs
nodeJS代码实现计算交社保是否合适
Mar 09 NodeJs
nodejs简单实现中英文翻译
May 04 NodeJs
详解nodejs中exports和module.exports的区别
Feb 17 NodeJs
详解Nodejs之静态资源处理
Jun 05 NodeJs
浅析 NodeJs 的几种文件路径
Jun 07 NodeJs
详解使用vscode+es6写nodejs服务端调试配置
Sep 21 NodeJs
使用npm安装最新版本nodejs
Jan 18 NodeJs
nodejs中使用archive压缩文件的实现代码
Nov 26 NodeJs
windows如何把已安装的nodejs高版本降级为低版本(图文教程)
Dec 14 NodeJs
一文秒懂nodejs中的异步编程
Jan 28 NodeJs
Nodejs多站点切换Htpps协议详解及简单实例
Feb 23 #NodeJs
NodeJs下的测试框架Mocha的简单介绍
Feb 22 #NodeJs
基于Nodejs利用socket.io实现多人聊天室
Feb 22 #NodeJs
NodeJS配置HTTPS服务实例分享
Feb 19 #NodeJs
解决nodejs中使用http请求返回值为html时乱码的问题
Feb 18 #NodeJs
利用nodejs监控文件变化并使用sftp上传到服务器
Feb 18 #NodeJs
详解nodejs中exports和module.exports的区别
Feb 17 #NodeJs
You might like
ThinkPHP框架任意代码执行漏洞的利用及其修复方法
2014/07/04 PHP
php图片处理函数获取类型及扩展名实例
2014/11/19 PHP
php中有关合并某一字段键值相同的数组合并的改进
2015/03/10 PHP
jQuery 自动增长的文本输入框实现代码
2010/04/02 Javascript
javascript中onclick(this)用法介绍
2013/04/19 Javascript
jquery实现聚光灯效果的方法
2015/02/06 Javascript
15个常用的jquery代码片段
2015/12/19 Javascript
Angular 页面跳转时传参问题
2016/08/01 Javascript
简单理解Vue条件渲染
2016/12/03 Javascript
详解百度百科目录导航树小插件
2017/01/08 Javascript
SVG描边动画
2017/02/23 Javascript
JavaScript实现修改伪类样式
2017/11/27 Javascript
在iFrame子页面里实现模态框的方法
2018/08/17 Javascript
vue-router命名视图的使用讲解
2019/01/19 Javascript
Vue自定义全局Toast和Loading的实例详解
2019/04/18 Javascript
解决vue组件中click事件失效的问题
2019/11/09 Javascript
Vue-cli assets SubDirectory及PublicPath区别详解
2020/08/18 Javascript
python处理中文编码和判断编码示例
2014/02/26 Python
举例讲解Python中装饰器的用法
2015/04/27 Python
python迭代器与生成器详解
2016/03/10 Python
Python控制多进程与多线程并发数总结
2016/10/26 Python
Python使用微信SDK实现的微信支付功能示例
2017/06/30 Python
Pyspider中给爬虫伪造随机请求头的实例
2018/05/07 Python
基于Python List的赋值方法
2018/06/23 Python
python画双y轴图像的示例代码
2019/07/07 Python
为什么从Python 3.6开始字典有序并效率更高
2019/07/15 Python
OpenCV 表盘指针自动读数的示例代码
2020/04/10 Python
使用Keras建立模型并训练等一系列操作方式
2020/07/02 Python
Microsoft Advertising美国:微软搜索广告
2019/05/01 全球购物
预备党员入党思想汇报
2014/01/04 职场文书
秋季运动会通讯稿
2014/01/24 职场文书
国际经济与贸易专业大学生职业规划书
2014/03/01 职场文书
夫妻忠诚协议书范本
2014/11/17 职场文书
部队2015年终工作总结
2015/04/02 职场文书
公司开业致辞
2015/07/29 职场文书
go类型转换及与C的类型转换方式
2021/05/05 Golang