EggJS+MySQL（mysql2+egg-sequelize+egg-cors）实现简单的增删改查

猫头嘤
4,426 阅读4分钟

1. 简介

  1. Egg官方文档 初学Egg，还是学习到了很多知识，同时也踩了一些坑。接下来就简单的搭一个Egg+MySql的架子，方便后期直接使用，拒绝做简单重复的操作。

  2. 以下是官方对目录的介绍： image.png

2.起步

2.1 快速初始化

官方推荐直接使用脚手架，只需几条简单指令，即可快速生成项目。

创建项目文件夹：mkdir egg-mysql-basic && cd egg-mysql-basic
快速初始化：npm init egg --type=simple
安装依赖：npm i
运行：npm run dev

2.2 安装所插件及配置

2.1 插件介绍

  1. mysql2 操作mysql的基础库。
  2. egg-sequelize是一个ORM 框架，在一些较为复杂的应用中，帮助我们管理数据层的代码。
  3. egg-cors开启跨域访问。

2.2 安装

npm install mysql2 egg-sequelize egg-cors --save

2.3 配置已安装插件

安装插件后，还需到config/config.default.js和config/plugin.js进行配置才可以使用哦！

// config/plugin.js
'use strict';

module.exports = {
    // 引入egg-sequelize包
    sequelize: {
        enable: true,
        package: 'egg-sequelize',
    },
    //引入egg-cors包
    cors: {
        enable: true,
        package: 'egg-cors',
    }
};

// config/config.default.js
'use strict';

module.exports = appInfo => {
    const config = exports = {};
    config.keys = appInfo.name + '_1620783032002_1928';
    config.middleware = [];
    /* 取消安全证书验证 */
    config.security = {
        csrf: {
            enable: false,
        },
        domainWhiteList: ["*"], // 白名单
    };
    /* 连接mysql配置 */
    config.sequelize = {
        dialect: 'mysql',
        host: 'localhost',
        port: 3306,
        database: 'egg-mysql',
        username: "root",
        password: "123456"
    };
    /* 配置允许跨域 */
    config.cors = {
        credentials: true,
        origin: "*", //允许任何跨域，若只允许个别IP跨域，则：origin:['http://localhost:8080']
        allowMethods: 'GET,PUT,POST,DELETE', // 被允许的请求方式
    };
    const userConfig = {};

    return {
        ...config,
        ...userConfig,
    };
};

OK! 以上配置以及项目初始化基本完成，接下来就开始 敲代码

3. 编写代码

代码编写大部分会在app目录下进行。以下实例中，会对egg-mysql数据库进行增删改查操作，以下文件夹以及文件，在本项目中是少不了的。

image.png

3.1 model层

首先，在app/model文件夹中对模型进行定义

// app/model/users.js
'use strict';
module.exports = app => {
    const { STRING, INTEGER } = app.Sequelize;
    const Users = app.model.define('users', {
        id: { type: STRING, primaryKey: true },
        username: STRING(255),
        nickname: STRING(255),
        avatar: STRING(255),
        sex: INTEGER(11),
        age: INTEGER(11)
    }, {
        timestamps: false, //自动增加创建时间
        tableName: 'users' //设置表名称
    });
    return Users;
};

3.2 service层

其次，在app/service文件夹中完成主要的业务逻辑

  1. 在app/service下，首先新建一个基础的控制层base.js,用于公共方法的编写。
// app/service/base.js

'use strict';

const Service = require('egg').Service;

class BaseService extends Service {
    //查询数据
    async _findAll(modelName) {
        const { ctx, app } = this
        try {
            return await ctx.model[modelName].findAll()
        } catch (error) {
            return "Server error"
        }
    }

    //查询数据总数
    async _count(modelName) {
        const { ctx } = this
        try {
            return await ctx.model[modelName].count();
        } catch (error) {
            return "Server error"
        }
    }

    //根据ID查询数据
    async _findById(modelName, id) {
        const { ctx } = this
        try {
            const result = await ctx.model[modelName].findByPk(id);
            return result
        } catch (error) {
            return "Server error"
        }
    }

    //新增数据
    async _add(modelName, json) {
        const { ctx } = this
        try {
            await ctx.model[modelName].create(json)
            return "新增成功"
        } catch (error) {
            return "Server error"
        }
    }

    //编辑数据
    async _edit(modelName, json) {
        const { ctx } = this
        try {
            const result = await ctx.model[modelName].findByPk(json.id);
            if (!result) return false;
            await result.update({...json });
            return true
        } catch (error) {
            return "Server error"
        }
    }

    //删除数据
    async _delete(modelName, key) {
        const { ctx } = this;
        try {
            const result = await ctx.model[modelName].findByPk(key);
            if (!result) return false;
            await result.destroy();
            return true;
        } catch (error) {
            return "Server error"
        }
    }
}

module.exports = BaseService;
  1. 在app/service下创建user.js
// app/service/users.js 

'use strict';

const BaseService = require('./base');

class UsersService extends BaseService {
    //查询所有数据
    async findAll() {
        let data = await this._findAll('Users')
        let total = await this._count('Users')
        return { total, data }
    }

    //根据ID查询数据
    async findById(id) {
        return await this._findById('Users', id)
    }

    //新增数据
    async add(json) {
        return await this._add('Users', json)
    }

    //编辑数据
    async edit() {
        let data = await this._edit('Users', json);
        if (!data) return "Id传入有误"
        return data
    }

    //删除数据
    async del(id) {
        let data = await this._delete('Users', id);
        if (!data) return "Id传入有误"
        return data
    }
}

module.exports = UsersService;

3.3 controller层

再次，在app/controller文件夹中编写负责具体的业务模块流程的控制

  1. 在app/controller下，首先新建一个基础的控制层base.js,用于公共方法的编写。
// app/controller/base.js
'use strict';

const Controller = require('egg').Controller;

class BaseController extends Controller {
    /* 操作成功，返回数据 */
    async success(data, msg, code = 200) {
        const { ctx } = this
        ctx.body = {
            code,
            msg,
            data
        }
    }

    /* 操作失败，返回数据 */
    async error(msg, code = 403) {
        const { ctx } = this
        ctx.body = {
            code,
            msg
        }
    }
}

module.exports = BaseController;

2.在app/controller下创建user.js

// app/controller/user.js
'use strict';

const BaseController = require('./base');

class UserController extends BaseController {
    //查询所有数据
    async findAll() {
        const { ctx, service } = this;
        let result = await service.user.findAll()
        this.success(result, 'OK');
    }

    //根据ID查数据
    async findById() {
        const { ctx, service } = this;
        let id = ctx.params.id
        let result = await service.user.findById(id)
        this.success(result, 'OK');
    }

    //新增数据
    async add() {
        const { ctx, service } = this;
        let { username, nickname, avatar, sex, age } = ctx.request.body
        let result = await service.user.add({ id: new Date().valueOf(), username, nickname, avatar, sex, age })
        if (result === 'Server error') this.error(0, result);
        this.success(1, result);
    }

    //修改数据
    async edit() {
        const { ctx, service } = this;
        let { id, username, nickname, avatar, sex, age } = ctx.request.body
        let result = await service.user.edit({ id, username, nickname, avatar, sex, age })
        if (result === 'Server error') this.error(0, result);
        this.success(1, result);
    }

    //修改数据
    async del() {
        const { ctx, service } = this;
        let id = ctx.params.id
        let result = await service.user.del(id)
        if (result === 'Server error') this.error(0, result);
        this.success(1, result);
    }
}

module.exports = UserController;

3.4 路由层

最后，在app/router.js中完成接口的编写

// app/router.js

'use strict';
module.exports = app => {
    const { router, controller } = app;
    router.get('/users/findAll', controller.user.findAll);
    router.get('/users/findById/:id', controller.user.findById);
    router.post('/users/add', controller.user.add);
    router.put('/users/edit', controller.user.edit);
    router.delete('/users/del/:id', controller.user.del);
};

OK！ EggJS+MySQL实现简单的增删改查已经实现了。

4.运行项目

打开控制台：npm run dev,即可看到http://127.0.0.1:7001

5.获取本文源码

点击获取：Egg增删改查源码

avatar
文章
阅读
粉丝
相关推荐
【Egg】搞定Egg—学习优秀的服务设计
996阅读
 · 
3点赞
egg-从入门到上线 (下)
3.8k阅读
 · 
33点赞
Node进阶：express默认日志组件morgan从入门使用到源码剖析
2.0k阅读
 · 
73点赞
基于eggjs+sequelize+mysql搭建nodejs后台服务
309阅读
 · 
2点赞
一文看懂 Eggjs-基础全面讲解（中）
9.6k阅读
 · 
40点赞