NodeJS仿WebApi路由示例

前端之家收集整理的这篇文章主要介绍了NodeJS仿WebApi路由示例前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

用过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就是这个固定前缀。

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

第二步是controller都继承自BaseController

}

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

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

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

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

@BodyParam可以得到Post上来的body

是不是有点WebApi的意思了。

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

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

核心代码

得到物理路径

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

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

});
}

从物理路径转成路由

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等。

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等。

function setParamDecorator(target: BaseController,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就用物理路由。

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

{ await this.execApi(ctx,next,funcName) }); }

private async execApi(ctx: Koa.Context,next: Function,funcName: string) : Promise { //这里就是执行controller的api方法
try
{
ctx.body = await controllerfuncName;
}
catch(err)
{
console.error(err);
next();
}
}

private buildFuncParams(ctx: 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的路由.

源码下载

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

猜你在找的Node.js相关文章