hapi框架搭建记录三Joi数据校验和Sequelize数据迁移填充数据

• hapi 框架，用官网的简介来说就是：Hapi 是构建应用程序和服务的丰富框架，它使开发人员能够专注于编写可重用的应用程序逻辑，而不是花时间构建基础设施。
• 用自己的话简单来说，就是个类似 express，koa 之类的 node 服务基础框架。
• 此篇博客是在阅读过掘金小册的《基于 hapi 的 Node.js 小程序后端开发实践指南》并实践操作后，以此记录实践过程和踩过的坑。感兴趣读者可支持阅读掘金小册原版的内容。

Joi 数据校验

1. 安装 joi

更多校验规则参考文档：https://www.npmjs.com/package…

npm i @hapi/joi

2. 配合 swagger

只需要在路由的 config 配置校验信息，如./routes/test.js 新增多一条测试接口

{
    method: "GET",
    path: `/${GROUP_NAME}/get`,
    handler: (request, h) => {return { data: request.query};
    },
    config: {tags: ["api", GROUP_NAME],
      description: "测试 get 提交",
      notes: "配置 Implementation 说明文",
      validate: {
        query: {num: Joi.number()
            .integer()
            .required()
            .description("数字")
            .error(new Error("num 参数错误"))
        }
      }
    }
  },

3.swagger 接口文档

Sequence 的使用

1. 安装

此案例链接 mysql 数据库，所以安装 mysq2

npm i sequelize-cli -D
npm i sequelize
npm i mysql2

2. 使用到的目录和文件

├── config                       # 项目配置目录
|   ├── config.js                # 数据库连接的配置 (区分开发 / 生产环境)
|   ├── index.js                 # 暴露部分配置信息给 app.js 使用
├── models                       # 数据库 model
|   ├── index.js                 # 数据库连接的样板代码
├── migrations                   # 数据迁移的目录
├── seeders                      # 数据填充的目录
├── .env                         # 配置 

3.env 配置数据库信息

注意需要在本地 mysql 中创建对应的数据库, 如:hapi_db

# 域名配置信息
HOST = 127.0.0.1
PORT = 3303
# MySQL 数据库连接配置信息
MYSQL_HOST = 127.0.0.1
MYSQL_PORT = 3306
MYSQL_DB_NAME = hapi_db
MYSQL_USERNAME = root
MYSQL_PASSWORD = 123456

4. 暴露给入口文件使用的数据信息

新建./config/index.js

const {env} = process;
module.exports = {
  host: env.HOST,
  port: env.PORT
};

5. 模式 model 使用

新建./config/config.js 给后台将要创建的数据库模型 model 使用的数据信息

// 根据环境动态加载数据库配置信息
// 本页面内容主要给数据库连接使用（../models/index.js）if (process.env.NODE_ENV == "production") {require("env2")("./.env.prod");
} else {require("env2")("./.env");
}
const {env} = process;
module.exports = {
  development: {
    username: env.MYSQL_USERNAME,
    password: env.MYSQL_PASSWORD,
    database: env.MYSQL_DB_NAME,
    host: env.MYSQL_HOST,
    port: env.MYSQL_PORT,
    dialect: "mysql",
    operatorsAliases: false
  },
  production: {
    username: env.MYSQL_USERNAME,
    password: env.MYSQL_PASSWORD,
    database: env.MYSQL_DB_NAME,
    host: env.MYSQL_HOST,
    port: env.MYSQL_PORT,
    dialect: "mysql",
    operatorsAliases: false
  }
};

使用 sequelize 创建表

1. 数据库的创建

sequelize 提供创建数据库的命令，但最后还需要自己动手修改数据库格式为 utf-8，所以还是手动直接创建方便

2.migration 创建表

创建一个商品表 shops

根据以下命令，将会自动创建./migration/2019XXXXXXXXX-create-shops-table.js

其实是可以直接在 mysql 创建表并填写数据，但这里使用 migration 来创建主要为了留下对表的创建修改等记录，未来有查询依据。就类比记录创建日志。

./node_modules/.bin/sequelize migration:create --name create-shops-table

xxxx-crate.shops.table.js

"use strict";

module.exports = {up: (queryInterface, Sequelize) => {
    return queryInterface.createTable("shops", {
      id: {
        type: Sequelize.INTEGER,
        autoIncrement: true,
        primaryKey: true
      },
      name: {
        type: Sequelize.STRING,
        allowNull: false
      },
      thumb_url: Sequelize.STRING,
      created_at: Sequelize.DATE,
      updated_at: Sequelize.DATE
    });
  },

  down: (queryInterface, Sequelize) => {face.dropTable("shops");
  }
};

3. 向 mysql 数据库中创建表

在项目根目录下执行命令

./node_modules/.bin/sequelize db:migrate

成功创建示例

可能报错情况 1：

解决：查看 config/config.js 配置是否正确，并注释掉 operatorsAliases: false

可能报错情况 2：

解决：mysql 数据库没有设置密码，注释掉配置文件 (config/config.js)password: env.MYSQL_PASSWORD,

数据库表成功插件

使用 Sequelize 填充表数据

1. 在项目根目录下执行命令：

将自动创建 /seeders/2019XXXX-init-shops.js

./node_modules/.bin/sequelize seed:create --name init-shops

2. 编写要填充的数据 xxxx-init-shops.js

"use strict";
/**
 * 初始化 店铺 数据
 * 若 数据库表中存在 created_at 和 updated_at 此两个字段，将默认由 Sequelize 维护
 */
const timestamps = {created_at: new Date().toLocaleString(),// 解决时差问题，使用 toLocaleString()
  updated_at: new Date().toLocaleString()
};
module.exports = {up: (queryInterface, Sequelize) => {
    return queryInterface.bulkInsert(
      "shops",
      [{ id: 1, name: "店铺 1", thumb_url: "1.png", ...timestamps},
        {id: 2, name: "店铺 2", thumb_url: "2.png", ...timestamps},
        {id: 3, name: "店铺 3", thumb_url: "3.png", ...timestamps},
        {id: 4, name: "店铺 4", thumb_url: "4.png", ...timestamps}
      ],
      {});
  },
  down: (queryInterface, Sequelize) => {
    // 删除 shop 表 id 为 1，2，3，4 的数据
    const {Op} = Sequelize;
    return queryInterface.bulkDelete(
      "shops",
      {id: { [Op.in]: [1, 2, 3, 4] } },
      {});
  }
};

3. 执行填充

./node_modules/.bin/sequelize db:seed:all

执行效果和数据结果

目录结构

截止目前为止，目录结构和文件如下：