上一篇文章我给大家说明了如何从零开始搭建一个node的服务端框架,我们用到了Egg框架。Egg框架我不再过多介绍,如果有小伙伴想了解,可以回去看我以前写的文章,会有相关的介绍。这次我将在上次搭建的框架上进行延伸,讲一下如果用Egg框架连接数据库,并且实现对数据的增删查改。接下来我们直接进入主题。
安装数据库插件
我本次选用的数据库是MySQL。所以我们安装Egg官方的数据库插件即可,首先我们安装插件 egg-mysql 。我们在项目根目录打开命令提示符,输入命令行:npm i --save egg-mysql 。回车等待插件下载安装完成。
npm i --save egg-mysql
配置插件
命令行下载安装插件完成后,我们下一步的工作就是在项目中开启并配置egg-mysql插件。具体操作如下:
首先我们要在项目中开启数据库。找到项目中的/config/plugin.js文件我们需要在里面添加几行代码,如下所示。
//开启数据库插件
mysql : {
enable: true,
package: 'egg-mysql',
}
然后我们还要在 config/config.default.js 中配置各个环境的数据库连接信息。具体配置如下。
//添加数据库连接信息
config.mysql = {
// 单数据库信息配置
client: {
// host
host: 'localhost',
// 端口号
port: '3306',
// 用户名
user: 'root',
// 密码
password: '123456',
// 数据库名
database: 'testdb',
},
// 是否加载到 app 上,默认开启
app: true,
// 是否加载到 agent 上,默认关闭
agent: false,
};
到此步骤我们的数据库插件已经安装完成并且配置好了。那我们怎么实现数据的增删查改呢?大家请继续往下看。
数据操作-新增用户
首先我们看一下怎么新增数据。我们在mysql的testdb实例中新建一个user空表。如下图所示。
我们的egg框架也遵循MVC的架构所以我们一般会在service层里面写我们逻辑处理的代码,而controller层则是获取前端数据,回传数据的控制层。所以我们操作数据库的代码是写在service文件夹里面的。
我们在app/service文件夹里面新建一个user.js文件。在里面写个新增用户的方法,该方法就是把数据存到数据库中。具体代码如下。
const Service = require('egg').Service;
class UserService extends Service {
//新增用户data是有controller层传递过来的数据记录。
async addUser(data) {
const {ctx, app} = this;
let result = {};
try {
data.id = 0;//定义id=0,因为数据库已经设置id为主键,并且自增。所以只需要赋值0即可。
// 在 user 表中,插入前端提交上来的数据记录
const info = await app.mysql.insert('user', data);
//插入成功后。
if(info.affectedRows === 1){
//给前端返回一个Json的对象
result = {
state: 0, //自定义的状态码
msg: "添加成功", //返回的消息
data: info.insertId, //新增的记录的id
}
}
} catch (err) {
//插入数据失败的返回结果
result = {
state: 1,
msg: err,
data: null,
}
}
return result
}
};
module.exports = UserService;
然后我们在app/controller文件夹里新建一个user.js文件。在这里我们需要获取前端提交上来的数据,并且将数据处理的结果返回给前端。具体代码如下。
'use strict';
const Controller = require('egg').Controller;
/**
* @Controller 用户管理
*/
class UserController extends Controller {
/**
* @summary 新增用户
* @router post /user/add
* @request body userAddRequest
* @response 200
*/
async addUser() {
const { ctx } = this;
//通过ctx.request.body的方式,可以获取到前端post方式提交上来的数据
const data = ctx.request.body;
//调用service层的addUser方法。并且返回相应的结果
const userInfo = await ctx.service.user.addUser(data);
//向前端接口响应数据。
ctx.body = userInfo;
}
}
module.exports = UserController;
最后我们定义一个路由,让前端请求访问此路由。框架会监听路由是否被访问,如果被访问了则会调用我们定义在controller层的新增用户的方法。我们在app/router.js文件中添加如下代码,即可完成路由的定义。
//新增用户路由
router.post('/user/add', controller.user.addUser);
完成这步骤后,我们一个新增用户的功能就已经完成了。接下里我们就测试一下它的实际效果。我们运行命令:npm run dev。启动项目,然后打开网页http://127.0.0.1:7001,可以直接在swagger-ui.html页面中进行测试。结果如下图所示。
经过测试,数据已经添加完成。所以数据库连接也是正常的。
本次分享暂时先告一段落。请各位小伙伴抬起你们发财的小手,点个赞呗。