koa大型web项目中使用路由装饰器的方法示例
一、关于重复造轮子解释下
在npmjs上搜索关于koa路由装饰器的已经有那么几个包了,但是我从几个包中发现作者的思维仅仅限制于前端开发的思想,项目分层不明确,我们开发kow-web项目可以根据java-web中项目分层的思想来写项目,项目结构清晰明了,本人封装这个包也是参考了java-web开发过程中把项目分为四层架构。
1、controllers:路由的控制
2、servers:常用于一些业务逻辑的判断
3、dao:操作数据库的
4、models:关于建表的数据模型
二、关于koa2-router-decors包的使用步骤
1、构建一个项目,并创建分层目录
2、安装
npminstallkoa2-router-decors //or yarnaddkoa2-router-decors
3、在中间件中使用我们安装的包
import{resolve}from'path';
importRoutefrom'koa2-router-decors';
//可以写到config中统一配置
constAPI_VERSION='/api/v1';
/**
*@Description:反转路径的方法
*@param{String}
*@return:
*/
constdir=path=>resolve(__dirname,path);
/**
*@Description:路由中间件读取controllers中的装饰器配置
*@param{type}
*@return:
*/
exportdefault(app)=>{
//这个地方是要读取的文件夹目录
constapiPath=dir('../controllers/*');
//实例化类并调用方法
constroute=newRoute(app,apiPath,API_VERSION);
route.init();
};
4、使用中间件
5、在controllers的文件夹中使用装饰器
@controller('/user')
exportclassUserControllerextendsBaseController{
constructor(){
super();
}
/**
*
*@api{post}/api/v1/user/create/添加用户
*@apiDescription创建用户的接口
*@apiNamecreateUser
*@apiGroupusers
*@apiVersion0.1.0
*@apiParam{string}username="张三"用户名
*@apiParam{string}mobile手机号码
*@apiParam{string}email邮箱
*@apiParam{string}password密码
*/
@post('/create')
@required({body:['username','mobile','password']})
asynccreateUser(ctx){
constresult=awaitUserServer.createUser(ctx.request.body);
ctx.success(result);
}
....
}
6、具体代码可以参考example中写的
三、关于example代码跑起来的说明
1、使用的是mysql
2、mysql建表sql
CREATETABLE`user`( `id`int(11)NOTNULLAUTO_INCREMENT, `username`varchar(30)NOTNULL, `mobile`varchar(11)DEFAULTNULL, `email`varchar(20)DEFAULTNULL, `password`varchar(255)NOTNULL, `created_at`datetimeDEFAULTCURRENT_TIMESTAMP, `updated_at`datetimeDEFAULTCURRENT_TIMESTAMPONUPDATECURRENT_TIMESTAMP, PRIMARYKEY(`id`) )ENGINE=InnoDBAUTO_INCREMENT=12DEFAULTCHARSET=utf8
3、在example的根目录下创建一个.env的文件
DB_HOST=数据库地址 DB_USERNAME=数据库连接名 DB_PASSWORD=数据库连接密码 DB_DATABASE=数据库名
四、源码地址,欢迎小伙伴提出问题，方便点赞一个
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。