NodeJS仿WebApi路由
用过WebApi或Asp.net MVC的都知道微软的路由设计得非常好,十分方便,也十分灵活。虽然个人看来是有的太灵活了,team内的不同开发很容易使用不同的路由方式而显得有点混乱。 不过这不是重点,我在做Node项目的时候就觉得不停的用use(...)
来指定路由路径很烦人,所以用Typescript
写了这个基于Koa
和Koa-router
的路由插件,可以简单实现一些类似WebApi的路由功能。
目标是和WebApi一样:
- 加入的controller会自动加入路由。
- 也可以通过path()手动指定路由。
- 可以定义http method, 如
GET
或POST
等。 - Api的参数可以指定url里的query param、path param以及body等。
包已经上传到npm中,npm install webapi-router 安装,可以先看看效果:
第一步,先设置controllers的目录和url的固定前缀
所有的controller都在这目录下,这样会根据物理路径自动算出路由。 url的固定前缀就是host和路由之间的,比如localhost/api/v2/user/name
,api/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
之类的,实现方法是给装饰的方法加一个属性Router
,Router
是个Symbol
,确保唯一。 然后分析装饰的功能存到这个属性中,比如Method
,Path
等。
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'); } }
转载于:https://www.cnblogs.com/zhaohongtian/p/6801293.html
NodeJS仿WebApi路由相关推荐
- 【开源】NodeJS仿WebApi路由
用过WebApi或Asp.net MVC的都知道微软的路由设计得非常好,十分方便,也十分灵活.虽然个人看来是有的太灵活了,team内的不同开发很容易使用不同的路由方式而显得有点混乱. 不过这不是重点, ...
- C#WebApi路由机制详解
随着前后端分离的大热,WebApi在项目中的作用也是越来越重要,可单独部署.与前端和App交互都很方便,既然有良好的发展趋势,我们当然应该顺势而为--搞懂WebApi!Restful相当于给Http请 ...
- NodeJS入门04-Express路由和中间件 - 小之 - 博客园
nodeJS入门04-Express路由和中间件 Express框架是后台的Node框架,在后台的受欢迎的程度,和jQuery一样,就是企业的事实上的标准. 路由 路由是指如何定义应用的端点(URIs ...
- VBS 请求WebAPI接口_C#进阶系列——WebApi 路由机制剖析:你准备好了吗?
正文 前言:从MVC到WebApi,路由机制一直是伴随着这些技术的一个重要组成部分. 它可以很简单:如果你仅仅只需要会用一些简单的路由,如/Home/Index,那么你只需要配置一个默认路由就能简单搞 ...
- WebApi 路由机制剖析
阅读目录 一.MVC和WebApi路由机制比较 1.MVC里面的路由 2.WebApi里面的路由 二.WebApi路由基础 1.默认路由 2.自定义路由 3.路由原理 三.WebApi路由过程 1.根 ...
- WebApi路由机制详解
随着前后端分离的大热,WebApi在项目中的作用也是越来越重要,由于公司的原因我之前一直没有机会参与前后端分离的项目,但WebApi还是要学的呀,因为这东西确实很有用,可单独部署.与前端和App交互都 ...
- WebApi路由机制详解——看完不会用你打我
随着前后端分离的大热,WebApi在项目中的作用也是越来越重要,由于公司的原因我之前一直没有机会参与前后端分离的项目,但WebApi还是要学的呀,因为这东西确实很有用,可单独部署.与前端和App交互都 ...
- 第十五节:Asp.Net Core MVC和WebApi路由规则的总结和对比-第二十节
一. Core Mvc 1.传统路由 Core MVC中,默认会在 Startup类→Configure方法→UseMvc方法中,会有默认路由:routes.MapRoute("defaul ...
- node.js express php,nodejs开发——express路由与中间件
路由 通常HTTP URL的格式是这样的: http表示协议. host表示主机. port为端口,可选字段,不提供时默认为80. path指定请求资源的URI(Uniform Resource Id ...
最新文章
- java 终极超类,Java问答:终极父类(3),java问答
- Silverlight中摄像头的运用—part2
- 2019-03-15-算法-进化(有效的数独)
- (教学思路 C#之类五)类的分类(静态类、实例类、嵌套类、结构、简单的抽象类、简单的密封类)...
- 前端学习(696):双重for循环
- git(4):git安装教程
- excel公式编辑器_Excel中自动更新超链接的文件目录,超简单
- 从李一男,到美女博士姚婷,任正非:要把中国的天才,留在中国
- Existing lock /var/run/yum.pid: another copy is running as pid
- mix2线刷开发板救砖_小米Mix 2(安卓8.0)一键救砖教程,轻松刷回官方系统
- 光盘版linux6,光盘上的系统 Slax Linux 6.0.6新版
- 苹果:确认开始在印度生产iPhone 13
- 【mac】mac 安装 RibbitMQ 报错 Error when reading /Users/lcc/.erlang.cookie: eacces
- mysql数据库的笔试题_MySQL数据库常见面试题
- 关于事务开启与否对数据库插入数据所需时间的影响的讨论
- springMVC文件上传的三种方法
- 使用VSTO开发Excel WorkBook文档级项目中出现的Bug及处理办法
- 金鹰dreamweaver视频教程下载地址
- 卫生间里的上下铺,那滋味~
- nginx代理、白名单过滤、双域名备案代理
热门文章
- 初学 快速幂 的理解
- android:id=@android:id/tabhost 、android:id=@+id/llRoot 、android:id=@id/llRoot 之间的区别...
- 一个不能进入系统的小问题——供远程为别人解决问题时参考。
- 行业利空出尽 关注钢铁龙头(000825)
- Babel下的ES6兼容性与规范
- JavaScript学习(六十七)—正则表达式学习总结
- 计算机网络学习(六)—网络层概述以及相关习题
- 类加载器以及双亲委派模型
- 请问用微信很少语音而且打字不喜欢打错别字的是什么样的人?能说明这样的人办事认真吗?
- 苹果手机没充满电就拔下,会对电池造成伤害吗?