快速搭建可用于实战的koa2+mongodb框架

亦凉 2023-01-13 10:50 157阅读 0赞

mac下安装mongodb可以参考这里：[Mac安装Mongdb - chendong\_的博客 - CSDN博客][Mac_Mongdb - chendong_ - CSDN]

源码地址戳这里：

[chenyucai/hello-koa2-mongodbgithub.com![图标][e33657a059f3cc69db6f5d14c9a5b616.png]][chenyucai_hello-koa2-mongodb_github.com_e33657a059f3cc69db6f5d14c9a5b616.png]

ps：GitHub上面的源码直接链接了我本人的云数据库，可临时提供给小伙伴们调试与使用。

**1.使用koa-generator生成koa2项目**

1.1 全局安装koa-generator

npm install -g koa-generator

1.2 使用命令生成项目基本目录

koa2 hello-koa2-mongodb

![0f5701f24c3ba81049ad9ecff09025e3.png][]

1.3 创建项目成功之后进入项目目录，进行依赖安装

cd hello-koa2-mongodb && npm install

![0d65ee7ed0f2e59973c94b4d69374a62.png][]

1.4 运行命令预览一下

npm start

浏览器打开[http://localhost:3000/][http_localhost_3000]

![07e1d69bab8962a8aff1aad5483b529e.png][]

## **2.目录结构** ##

因为现在的项目基本上都是前后端分离，所以我这里只编写的框架中并不带模版。然后我们需要改造一下目录结构，详细代码可移步[这里][chenyucai_hello-koa2-mongodb_github.com_e33657a059f3cc69db6f5d14c9a5b616.png]

![44d44c766fdbe1ee556bd48a0147997b.png][]

**config: 一些公共的配置，如数据库地址**

**controller: 控制器层**

**dbHelper: 链接mongodb**

**error: 实现统一异常处理**

**middleware: 各种中间件**

**model: 实体类**

**router: 路由信息（api接口地址）**

**utils: 各种工具类**

## **3.代码实现** ##

koa的项目中引用文件都是采用**require**，对于习惯了使用**import**关键字的小伙伴可以这样解决：在项目中引入**babel-plugin-add-module-exports**与**babel-register**

npm install babel-plugin-add-module-exports babel-register --save-dev

并在根目录下创建一个.babelrc的文件

{
      "presets": ["es2015", "stage-3"],
      "plugins": ["add-module-exports"]
    }

并在入口文件中**require('babel-register')**

3.1 入口文件：src/app.js

![052cdbf13158539681ecb5b8c949e7b2.png][]

3.2 连接mongodb等设置：src/config/index.js

![1a4b2c98fcac9f232a3b240916c9be62.png][]

3.3 router，路由信息，即api地址：src/router/index.js

![3e66aea75d9ef79f485f9f4cb8a6e6a7.png][]

3.4 controller控制器

![9512cd61e544a09dbeb7a4f3a30f671d.png][]

这里使用了**class**，习惯写**fucntion**的小伙伴用**function**也是一样的

3.5 model实体

![cc7c07f9a84c1f87a98f62bcd6ff95be.png][]

下面这样可以配置mongoose自动更新createTime和updateTime

![e082c9b86b78fe1f3706c465101fb2b9.png][]

## **4 统一异常处理** ##

如果是写java的小伙伴都知道，统一的异常处理是非常有必要的

ApiErrorNames.js定义异常code码

![0951273a1dd007535326f3b7d643a55e.png][]

ApiError.js实现统一异常处理

![92a95106a723c607670aeb6bd44d1e50.png][]

注意：为什么不用class，因为用了babel，class会被编译成es5，导致instanceof没用

## **5 jwt验证** ##

1.  使用**jsonwebtoken**库

npm i jsonwebtoken  // 一个实现jwt的包

自己实现一个jwt校验中间件 （也可以直接使用koa-jwt）

![72907b46fff22a7c73e600f4d94f026a.png][]

在需要校验的接口上加上verify就行了

![68a3dcb97578ae60941997409f7ff0a8.png][]

ps: 细心的小伙伴可能发现了，为什么没有service层啊！！ service要的要的，大家自行加上\[坏笑\]

[Mac_Mongdb - chendong_ - CSDN]: https://link.zhihu.com/?target=https%3A//blog.csdn.net/chendong_/article/details/51440986
[e33657a059f3cc69db6f5d14c9a5b616.png]: https://img-blog.csdnimg.cn/img_convert/e33657a059f3cc69db6f5d14c9a5b616.png
[chenyucai_hello-koa2-mongodb_github.com_e33657a059f3cc69db6f5d14c9a5b616.png]: https://link.zhihu.com/?target=https%3A//github.com/chenyucai/hello-koa2-mongodb.git
[0f5701f24c3ba81049ad9ecff09025e3.png]: /images/20221022/688bf4539e4b49408a32158fed4137d1.png
[0d65ee7ed0f2e59973c94b4d69374a62.png]: /images/20221022/ba81d38eae2044dea0e6920981518dc3.png
[http_localhost_3000]: https://link.zhihu.com/?target=http%3A//localhost%3A3000/
[07e1d69bab8962a8aff1aad5483b529e.png]: /images/20221022/7856911cae674f5f899d10debb5357f7.png
[44d44c766fdbe1ee556bd48a0147997b.png]: /images/20221022/975bc0f10e4b42849f6c5f28f0936fe2.png
[052cdbf13158539681ecb5b8c949e7b2.png]: /images/20221022/4c658c55e5564949986dc84a8198bbf4.png
[1a4b2c98fcac9f232a3b240916c9be62.png]: /images/20221022/31fa93deb0a04d58865c957438fe9cf6.png
[3e66aea75d9ef79f485f9f4cb8a6e6a7.png]: /images/20221022/918606a13075424a8f70346e877bb26f.png
[9512cd61e544a09dbeb7a4f3a30f671d.png]: /images/20221022/898f889936e94e2489560a11e08d5f83.png
[cc7c07f9a84c1f87a98f62bcd6ff95be.png]: /images/20221022/e8cce2e4ca3743c091f91ae23bc6ca8d.png
[e082c9b86b78fe1f3706c465101fb2b9.png]: /images/20221022/767b9895560248e5b5e8ce2531dd42a3.png
[0951273a1dd007535326f3b7d643a55e.png]: /images/20221022/b625ec3a711241edacb9aeed991ec5af.png
[92a95106a723c607670aeb6bd44d1e50.png]: /images/20221022/2d5a658b46974510a410cde3ad711881.png
[72907b46fff22a7c73e600f4d94f026a.png]: /images/20221022/4e45f2a1f4e1440b9ec05d5e3e3e5b13.png
[68a3dcb97578ae60941997409f7ff0a8.png]: /images/20221022/a8260c6b10374be78a4173908b43937f.png