NodeJS仿WebApi路由示例
用过webapi或asp.net mvc的都知道微软的路由设计得非常好,十分方便,也十分灵活。虽然个人看来是有的太灵活了,team内的不同开发很容易使用不同的路由方式而显得有点混乱。 不过这不是重点,我在做node项目的时候就觉得不停的用use(...)
来指定路由路径很烦人,所以用typescript
写了这个基于koa
和koa-router
的路由插件,可以简单实现一些类似webapi的路由功能。
目标是和webapi一样:
1.加入的controller会自动加入路由。
2.也可以通过path()手动指定路由。
3.可以定义http method, 如get
或post
等。
4.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/*
, :name
就是*
,可以在方法的参数里用@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'); } }
这样就完成了简单版的类似webapi的路由.
源码下载:
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: JSON与JS对象的区别与对比
下一篇: 浅谈js for循环输出i为同一值的问题