20190317 migration学习

2019-03-17 本文已影响0人瑶九九

使用migration的目的

我们可以直接通过mysql命令将数据表建好，但是在多人协作过程中，在项目的演进过程中，每一个迭代都有可能对数据库数据结构做变更，如果采用mysql命令，我们很难追踪每一个迭代的数据变更
这时我们就需要利用migration帮助我们管理数据结构变更了
migration的作用是使数据库的操作能够类似git一样对版本进行管理，比如回退，上传这些

操作步骤

在egg中使用migration

初始化项目

通过egg-init初始化一个项目，并通过npm i来安装egg项目需要的模块

egg-init --type=simple --dir=sequelize-project
cd sequelize-project
npm i

安装并配置egg-sequelize插件和mysql2模块
配置egg-sequelize插件的作用：它会辅助我们将定义好的 Model 对象加载到 app 和 ctx 上
-- 安装mysql2

npm install --save egg-sequelize mysql2

-- 在 config/plugin.js 中引入 egg-sequelize 插件

exports.sequelize = {
 enable: true,
 package: 'egg-sequelize',
};

-- 在 config/config.default.js 中编写 sequelize 配置

config.sequelize = {
 dialect: 'mysql',
 host: '127.0.0.1',
 port: 3306,
 database: 'egg-sequelize-doc-default',
};

完成上面的配置后，一个使用sequelize的项目就初始化完成了

3初始化数据库和migration

a. 初始化数据库

mysql -u root -e 'CREATE DATABASE IF NOT EXISTS `egg-sequelize-doc-default`;'

b. 安装sequelize-cli
sequelize提供了sequelize-cli工具来实现migration，因此我们需要在egg项目中引入sequelize-cli
npm install --save-dev sequelize-cli
c. 新建.sequelizerc 配置文件
为了让项目结构更加清楚，我们希望所有数据库migrations相关的内容都放在database目录下，因此我们需要新建.sequelizerc 配置文件来帮助我们实现这个目的

'use strict';
const path = require('path');
 module.exports = {
   config: path.join(__dirname, 'database/config.json'),
   'migrations-path': path.join(__dirname, 'database/migrations'),
   'seeders-path': path.join(__dirname, 'database/seeders'),
   'models-path': path.join(__dirname, 'app/model'),
 }

d.初始化migrations配置文件和目录

npx sequelize init:config
npx sequelize init:migrations

执行完成后会生成database/config.json 文件和 database/migrations 目录
我们需要修改config.json中的内容，将其变成我们项目中使用的数据库配置

{
  "development": {
    "username": "root",
    "password": null,
    "database": "egg-sequelize-doc-default",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "test": {
    "username": "root",
    "password": null,
    "database": "egg-sequelize-doc-unittest",
    "host": "127.0.0.1",
    "dialect": "mysql"
  }
}

e. 创建users表
此时 sequelize-cli 和相关的配置也都初始化好了，我们可以开始编写项目的第一个 Migration 文件来创建我们的一个 users 表了
新建表的操作：
npx sequelize migration:generate --name=init-users
执行完后会在 database/migrations 目录下生成一个 migration 文件(${timestamp}-init-users.js)，我们修改它来处理初始化 users 表：

use strict';
module.exports = {
  // 在执行数据库升级时调用的函数，创建 users 表
  up: async (queryInterface, Sequelize) => {
    const { INTEGER, DATE, STRING } = Sequelize;
    await queryInterface.createTable('users', {
      id: { type: INTEGER, primaryKey: true, autoIncrement: true },
      name: STRING(30),
      age: INTEGER,
      created_at: DATE,
      updated_at: DATE,
    });
  },
  // 在执行数据库降级时调用的函数，删除 users 表
  down: async queryInterface => {
    await queryInterface.dropTable('users');
  },
};

f. 进行数据库操作

升级数据库
npx sequelize db:migrate
升级数据库命令会调用上面代码中up指定的函数，即创建user表
回退一个变更
npx sequelize db:migrate:undo
回退到初始状态
npx sequelize db:migrate:undo:all

编写代码实现业务逻辑

第一步：
在 app/model/ 目录下编写 user 这个 Model

'use strict';

module.exports = app => {
  const { STRING, INTEGER, DATE } = app.Sequelize;

  const User = app.model.define('user', {
    id: { type: INTEGER, primaryKey: true, autoIncrement: true },
    name: STRING(30),
    age: INTEGER,
    created_at: DATE,
    updated_at: DATE,
  });

  return User;
};

这个 Model 就可以在 Controller 和 Service 中通过 app.model.User 或者 ctx.model.User 访问到了

第二步：
编写controller文件夹下的文件

// app/controller/users.js
const Controller = require('egg').Controller;

function toInt(str) {
  if (typeof str === 'number') return str;
  if (!str) return str;
  return parseInt(str, 10) || 0;
}

class UserController extends Controller {
  async index() {
    const ctx = this.ctx;
    const query = { limit: toInt(ctx.query.limit), offset: toInt(ctx.query.offset) };
    ctx.body = await ctx.model.User.findAll(query);
  }

  async show() {
    const ctx = this.ctx;
    ctx.body = await ctx.model.User.findById(toInt(ctx.params.id));
  }

  async create() {
    const ctx = this.ctx;
    const { name, age } = ctx.request.body;
    const user = await ctx.model.User.create({ name, age });
    ctx.status = 201;
    ctx.body = user;
  }

  async update() {
    const ctx = this.ctx;
    const id = toInt(ctx.params.id);
    const user = await ctx.model.User.findById(id);
    if (!user) {
      ctx.status = 404;
      return;
    }

    const { name, age } = ctx.request.body;
    await user.update({ name, age });
    ctx.body = user;
  }

  async destroy() {
    const ctx = this.ctx;
    const id = toInt(ctx.params.id);
    const user = await ctx.model.User.findById(id);
    if (!user) {
      ctx.status = 404;
      return;
    }

    await user.destroy();
    ctx.status = 200;
  }
}

module.exports = UserController;

第三步：
将这个controller挂载到路由上

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  router.resources('users', '/users', controller.users);
};

这里需要注意resources方法
之后postman发请求时请求方法和格式需要按照resources方法定义的标准来
这里附上关于resources的官方文档：
https://eggjs.org/zh-cn/basics/router.html#restful-%E9%A3%8E%E6%A0%BC%E7%9A%84-url-%E5%AE%9A%E4%B9%89