Egg學(xué)習(xí)_Setp1_初始化項目添加數(shù)據(jù)庫

Karrdy 發(fā)布于2019-08-20 18:36 / 999人閱讀

摘要：前言本系列文章是學(xué)習(xí)過程的一個記錄初步目標(biāo)是寫一個個人博客會盡可能多使用中提供的各種功能本文全部使用請確保版本足夠支持文中有不正確地方請指正地址文檔初始化項目使用腳手架初始化項目選擇初始化項目的類型項目目錄結(jié)構(gòu)自定義啟動時

前言

本系列文章是Egg學(xué)習(xí)過程的一個記錄,初步目標(biāo)是寫一個個人博客,會盡可能多使用Egg中提供的各種功能.
本文全部使用 async 請確保Node版本足夠支持.
文中有不正確地方請指正.
GitHub地址: https://github.com/devil5263/...
Egg文檔: https://eggjs.org/zh-cn/intro/

初始化項目

使用Egg腳手架初始化項目

$ npm instal egg-init -g
$ egg-init egg-example --type=simple // 選擇初始化項目的類型
$ cd egg-example
$ npm install

項目目錄結(jié)構(gòu)

egg-project
├── package.json
├── app.js //自定義啟動時的初始化工作
├── app
|   ├── router.js // 配置 URL 路由規(guī)則
│   ├── controller // 控制層
│   |   └── auth.js // 業(yè)務(wù)邏輯-注冊登錄實現(xiàn)
│   ├── service // 業(yè)務(wù)邏輯層
│   |   └── auth.js // 業(yè)務(wù)邏輯-注冊登錄實現(xiàn)
|   ├── model // 數(shù)據(jù)庫表結(jié)構(gòu)
│   |   └── user.js // 業(yè)務(wù)邏輯-user表
│   ├── middleware // 中間件
│   ├── schedule // 任務(wù)
│   └── extend // 框架的擴(kuò)展
├── config // 初始化-所有配置文件
|   ├── plugin.js
|   ├── config.default.js
│   ├── config.prod.js
|   ├── config.test.js (可選)
|   ├── config.local.js (可選)
|   └── config.unittest.js (可選)
├── build // 前端webpack打包配置
|   ├── webpack.base.js
|   ├── webpack.dev.js
|   └── webpack.prod.js
├── resource// 前端源文件
|   ├── assets // 前端資源
|   ├── components // 前端組件
│   └── pages // 前端頁面
|       └── page1 // 某一頁面
|           ├── app.vue // vue單文件組件
|           ├── index.js // vue入口文件
|           ├── index.html // html頁面
|           └── js (可選) // store/router js文件
└── test // 初始化-單元測試用例
    ├── middleware
    |   └── response_time.test.js
    └── controller
        └── home.test.js

MySQL配置

這里使用了兩個Egg的插件

egg-mysql 用于連接MySQL(需要npm install egg-mysql)

egg-sequelize 用于定義model進(jìn)行db層操作(需要安裝egg-sequelize和mysql2兩個庫)

數(shù)據(jù)庫配置

// {work_dir}/config/config.default.js
const database = "egg"; // 數(shù)據(jù)庫名字
module.exports = appInfo => {
  const config = {};
  config.keys = appInfo.name + "_1501817502166_7037";

  config.sequelize = { // egg-sequelize 配置
    dialect: "mysql", // db type
    database: database,
    host: "localhost",
    port: "3306",
    username: "root",
    password: ""
  };

  return config;
};

插件配置

// {work_dir}/config/plugin.js
exports.sequelize = {
    enable: true,
    package: "egg-sequelize"
};

啟動時創(chuàng)建數(shù)據(jù)庫表

// {work_dir}/app.js
module.exports = app => {
    app.beforeStart(async function () {
        await app.model.sync({ force: true });
    });
};

定義model

// {work_dir}/app/model/user.js
module.exports = app => {
  const { STRING, INTEGER, DATE } = app.Sequelize;

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

  return User;
};

目前為止,egg-example項目已初始化并添加了MySQL配置,成功啟動后會發(fā)現(xiàn)數(shù)據(jù)庫中已經(jīng)有了定義的 model User