开发依赖:
koa : 后端的主框架。
koa-router : 基于 Koa 的路由。
koa-static-cache : koa 静态文件代理。
koa-ts-controllers : 基于 Koa 和 TypeScript 构建的路由控制系统,它提供了各种装饰器来构建 RESTful 风格的 API。
mysql2 : NodeJS 连接操作 MySQL 的库。
sequelize : 一个功能更丰富和强大的数据库操作库,支持 MySQL、MSSQL、SQLite 等数据库,提供了 ORM、事务 以及 Promise 等支持。
sequelize-typescript : sequelize 的 TypeScript 版。
class-validator : 基于 validator.js 和 TypeScript 的数据验证工具,对用户或者接口调用传入的数据进行校验。
jsonwebtoken : JWT 鉴权库。
moment : 日期时间处理工具。
开发辅助工具:
ts-node-dev : ts-node 的 dev 版,实现了热重载。
sequelize-cli : sequelize 提供了的 CLI 工具,可以通过它来维护数据库。
接口规范:
遵循 RESTful 规范,合理的利用 请求方法、状态码 等来设计 API。
资源路径:因为当前应用没有把接口数据与静态资源(如图片等)进行分开放置,所以为了进行区分,接口以 /api 作为前缀,静态资源以 /public 作为前缀。
为了更方便的对接口进行管理以及后续的升级,路径后同时携带当前接口的版本,如:/api/v1/login。
项目搭建:
初始化项目:创建项目目录(backend), npm init 。
创建tsconfig.json文件:
根目录下创建文件夹:
src目录:存放源码。
app.ts:在src下创建项目启动入口文件。
controllers: src下创建项目控制器类文件。
configs:src下创建项目配置文件,例如:不同环境下(开发、测试、生成等)主机地址,端口,数据库连接信息等。在configs目录下创建index.ts :
此时,代码会出现报错。因为默认情况下,TypeScript 没有内置 node 相关的类型声明,我们需要手动安装:npm i -D @types/node,安装完成以后,报错消失。
入口文件:
安装koa以及类型声明文件 : npm i koa 、 npm i -D @types/koa (Koa不是TS编写的,引用koa的时候会报错)。
启动项目:
在开发阶段,借助ts-node-dev工具帮助我们运行ts文件: npm i -D ts-node-dev ,他还具有热重载功能。
ts文件的编译:npm i -D typescript 。
启动项目,在package.json中配置启动命令:"dev": "ts-node-dev ./src/app.ts" ,配置完成以后 :npm run dev 。
基于 TypeScript 的路由控制框架:koa-ts-controllers
在 koa-ts-controllers 中,利用了 TypeScript 的装饰器,我们可以直接在指定类的某个方法中对其进行路由绑定。而且通过它提供的功能,我们可以更方便实现符合 RESTful 规范的接口。
npm i koa-ts-controllers
bootstrapControllers : koa-ts-controllers 的主要函数,用来初始化应用控制器和路由绑定。
router : 使用koa-router路由库。
basePath:设置访问接口路径的前缀,/api。
versions:接口版本,会附加到 basePath 之后,/api/v1。
controllers:控制器类文件的存放目录。
装饰器:
controllers下存放了所有的控制器类文件。我们需要将这些类都变成控制类,并绑定其中的类方法到指定的路由中,这就需要用到装饰器。
@Controller(basePath) : 针对类的装饰器,被装饰的类就会成为一个控制器类,只有控制器类下的方法才能与路由进行绑定。basePath:该类中方法绑定的路由的前缀路径。
HTTP请求方法装饰器: @Get(path) 、 @Post(path) 、 @Patch(path) 、@Put(path) 、 @Delete(path)
启动项目: npm run dev , 通过 http://localhost:8080/api/v1/test/hello 、 http://localhost:8080/api/v1/test/userInfo?id=2 等可以进行访问。此时,会报错:未找到class-validator模块, 安装一下 npm i class-validator 即可。