app.js

框架提供了统一的入口文件（app.js）进行启动过程自定义 app.js

module.exports = app => {

app.beforeStart(async () => {

// 保证应用启动监听端口前数据已经准备好了

// 后续数据的更新由定时任务自动触发

await app.runSchedule('update_cache');

});

};

MySQL

框架提供了 egg-mysql 插件来访问 MySQL 数据库。这个插件既可以访问普通的 MySQL 数据库，也可以访问基于 MySQL 协议的在线数据库服务。

安装与配置

$ cnpm i --save egg-mysql

开启插件

config/plugin.js

exports.mysql = {

enable: true,

package: 'egg-mysql',

};

建表

DROP TABLE IF EXISTS `news`;

CREATE TABLE `news` (

`id` int(11) NOT NULL AUTO_INCREMENT,

`title` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NULL DEFAULT NULL,

`url` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NULL DEFAULT NULL,

`image` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NULL DEFAULT NULL,

`createAt` datetime NULL DEFAULT NULL,

PRIMARY KEY (`id`) USING BTREE

) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_bin ROW_FORMAT = Compact;

INSERT INTO `news` VALUES (1, '世界首富早晚是这个人，坐拥7家独角兽公司，估值破数万！', 'http://tech.ifeng.com/a/20180904/45154322_0.shtml', 'http://p0.ifengimg.com/pmop/2018/0905/CFFF918B94D561D2A61FB434ADA81589E8972025_size41_w640_h479.jpeg', '2019-06-08 22:07:29');

INSERT INTO `news` VALUES (2, '支付宝们来了！将来人民币会消失吗？', 'http://finance.ifeng.com/a/20180907/16491630_0.shtml', 'http://p0.ifengimg.com/pmop/2018/0907/2AF684C2EC49B7E3C17FCB13D6DEEF08401D4567_size27_w530_h369.jpeg', '2019-06-08 22:08:24');

INSERT INTO `news` VALUES (3, '《福布斯》专访贝索斯：无业务边界的亚马逊 令对手生畏的CEO', 'https://www.jiemian.com/article/2451982.html', 'https://img1.jiemian.com/101/original/20180907/153628523948814900_a580x330.jpg', '2019-06-08 22:17:16');

配置数据源

config/config.${env}.js

config.mysql = {

// 单数据库信息配置

client: {

// host

host: 'localhost',

// 端口号

port: '3306',

// 用户名

user: 'root',

// 密码

password: 'root',

// 数据库名

database: 'cms'

},

// 是否加载到 app 上，默认开启

app: true,

// 是否加载到 agent 上，默认关闭

agent: false,

};

news.js

app\service\news.js

const { Service}=require('egg');

class NewsService extends Service {

async list(pageNum,pageSize) {

const { ctx}=this;

let result = await this.app.mysql.query('select * from news');

return result;

}

}

module.exports=NewsService;

Sequelize

在一些较为复杂的应用中，我们可能会需要一个 ORM 框架来帮助我们管理数据层的代码。而在 Node.js 社区中，sequelize 是一个广泛使用的 ORM 框架，它支持 MySQL、PostgreSQL、SQLite 和 MSSQL 等多个数据源

安装

egg-sequelize插件会辅助我们将定义好的Model对象加载到app和ctx上

$ cnpm install --save egg-sequelize mysql2

启用插件

exports.sequelize = {

enable: true,

package: 'egg-sequelize',

};

sequelize 配置

config/config.default.js

config.sequelize = {

dialect: 'mysql',

host: 'localhost',

port: 3306,

username: "root",

password: "root",

database: 'cms-development'

};

config/config.test.js

module.exports=app => {

let config={ };

config.sequelize = {

dialect: 'mysql',

host: 'localhost',

port: 3306,

username: "root",

password: "root",

database: 'cms-test',

};

return config;

}

初始化数据库

安装sequelize-cli

sequelize 提供了 sequelize-cli 工具来实现 Migrationssequelize-cli用于支持数据迁移和项目引导。通过迁移，可以将现有数据库迁移到另一个状态，反之亦然这些迁移文件会被保存在迁移文件中，迁移文件描述了怎样到达新状态以及如何恢复更改以返回到迁移前的旧状态

cnpm install --save sequelize sequelize-cli

.sequelizerc

我们希望将所有数据库

Migrations

相关的内容都放在

database

目录下，所以我们在项目根目录下新建一个

.sequelizerc

配置文件

config 包含配置文件，它告诉 CLI 如何连接数据库migrations-path 包含所有迁移文件seeders-path 包含所有种子文件,seeders 来在初始化数据表中中初始化一些基础数据models-path 包含您的项目的所有模型

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'),

};

初始化 Migrations

在项目的演进过程中，每一个迭代都有可能对数据库数据结构做变更，怎样跟踪每一个迭代的数据变更，并在不同的环境（开发、测试、CI）和迭代切换中，快速变更数据结构呢？这时候我们就需要 Migrations 来帮我们管理数据结构的变更了初始化 Migrations 配置文件和目录执行完后会生成 database/config.json 文件和 database/migrations

npx sequelize init:config

npx sequelize init:migrations

key是环境变量NODE_ENV的值，默认就是 developmentset NODE_ENV=test

config.json

{

"development": {

"username": "root",

"password": "root",

"database": "cms-development",

"host": "127.0.0.1",

"dialect": "mysql",

"operatorsAliases": false

},

"test": {

"username": "root",

"password": "root",

"database": "cms-test",

"host": "127.0.0.1",

"dialect": "mysql",

"operatorsAliases": false

}

}

创建users表

创建目录

编写项目的第一个 Migration 文件来创建我们的一个 users 表

npx sequelize migration:generate --name=init-users

执行完后会在 database/migrations 目录下生成一个 migration 文件(${timestamp}-init-users.js)

创建升级脚本

database\migrations\20190608143311-init-users.js

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');

},

};

执行 migrate 进行数据库变更

# 升级数据库

npx sequelize db:migrate

# 如果有问题需要回滚，可以通过 `db:migrate:undo` 回退一个变更

# npx sequelize db:migrate:undo

# 可以通过 `db:migrate:undo:all` 回退到初始状态

# npx sequelize db:migrate:undo:all

添加种子数据

sequelize seed:create --name init-users

npx sequelize db:seed:all

npx sequelize db:seed:all --env development

database\seeders\20190803152323-init-users.js

module.exports = {

up: (queryInterface, Sequelize) => {

return queryInterface.bulkInsert('users', [{

name: 'hs',

age:1,

created_at: new Date(),

updated_at: new Date()

},{

name: 'haha',

age:2,

created_at: new Date(),

updated_at: new Date()

}],{ });

},

down: (queryInterface, Sequelize) => {

return queryInterface.bulkDelete('users', null, { });

}

};

使用

app\model\user.js

app\model\user.js

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 访问到了

router.js

app\router.js

module.exports = app => {

const { router, controller } = app;

router.get('/news', controller.news.index);

router.get('/users', controller.users.index);

}

users.js

app\controller\users.js

const { Controller } = require('egg');

class UserController extends Controller {

async index() {

const { ctx,service}=this;

ctx.body = await ctx.model.User.findAll();

}

}

module.exports = UserController;

单元测试

在测试环境中建表

npx sequelize db:migrate --env test

factory-girl

通过 factory-girl 模块来快速创建测试数据

cnpm install --save-dev factory-girl

factories.js

test/factories.js

const { factory } = require('factory-girl');

module.exports = app => {

// 可以通过 app.factory 访问 factory 实例

app.factory = factory;

// 定义 user 和默认数据

factory.define('user', app.model.User, {

name: factory.sequence('User.name', n => `name_${ n}`),

age: 18,

});

};

.setup.js

test/.setup.js

const { app } = require('egg-mock/bootstrap');

const factories = require('./factories');

before(() => factories(app));

afterEach(async () => {

await Promise.all([

app.model.User.destroy({ truncate: true, force: true }),

]);

});

users.test.js

test/app/controller/users.test.js

// test/app/controller/users.test.js

const { assert, app } = require('egg-mock/bootstrap');

describe('test/app/controller/users.test.js', () => {

describe('GET /users', () => {

it('should work', async () => {

// 通过 factory-girl 快速创建 user 对象到数据库中

await app.factory.createMany('user', 3);

const res = await app.httpRequest().get('/users');

assert(res.status === 200);

assert(res.body.length === 3);

assert(res.body[0].name);

assert(res.body[0].age);

});

});

});

package.json

"scripts": {

"dev": "egg-bin dev",

+ "test": "egg-bin test"

}

npm run test

国际化（I18n）

为了方便开发多语言应用，框架内置了国际化（I18n）支持，由 egg-i18n 插件提供。

默认语言

// config/config.default.js

exports.i18n = {

defaultLocale: 'zh-CN',

};

多语言文件

多种语言的配置是独立的，统一存放在 config/locale/*.js 下。

config/locale/

en-US.jszh-CN.js

en-US.js

config/locale/en-US.js

module.exports = {

Email: 'Email',

'Welcome back, %s!': 'welcome back，%s!',

'Hello {0}! My name is {1}.': '你好 {0}! 我的名字叫 {1}。',

};

zh-CN.js

config/locale/zh-CN.js

// config/locale/zh-CN.js

module.exports = {

Email: '邮箱',

'Welcome back, %s!': '欢迎回来，%s!',

'Hello {0}! My name is {1}.': 'Hello {0}! My name is {1}.',

};

获取多语言文本

我们可以使用 __ (Alias: gettext) 函数获取 locale 文件夹下面的多语言文本。

ctx.__('Email')

// zh-CN => 邮箱

// en-US => Email

app\router.js

router.get('/hello', controller.news.hello);

app\controller\news.js

const { Controller } = require('egg');

class NewsController extends Controller {

async hello(){

const {ctx}=this;

+ let email = ctx.__('Email');

+ let welcome = ctx.__('Welcome back, %s!', 'hs');

+ let Hello = ctx.__('Hello {0}! My name is {1}.', ['haha','xixi']);

+ ctx.body = email+welcome+Hello;

}

}

module.exports = NewsController;

app\view\index.html

{ {__('Email')}}

{ {__('Welcome back, %s!', name)}}

{ {__('Hello {0}! My name is {1}.', names)}}

扩展工具方法

框架提供了一种快速扩展的方式，只需在app/extend目录下提供扩展脚本即可Helper 函数用来提供一些实用的 utility 函数。访问方式 通过 ctx.helper 访问到 helper 对象

app\extend\helper.js

const moment=require('moment');

moment.locale('zh-cn');

exports.fromNow=dateTime => moment(new Date(dateTime)).fromNow();

app\controller\news.js

list.forEach(item => {

item.createAt=ctx.helper.fromNow(item.createAt);

return item;

});

app\view\index.html

时间: { { helper.fromNow(news.createAt)}}

中间件

app/middleware/robot.js

module.exports=(options,app) => {

return async function(ctx,next) {

const source=ctx.get('user-agent')||'';

const matched=options.ua.some(ua => ua.test(source));

if (matched) {

ctx.status=403;

ctx.body='你没有访问权限';code>

} else { -- -->

await next();

}

}

}

config.default.js

config.middleware=[

'robot'

]

config.robot={

ua: [

/Chrome/

]

}

curl -v --user-agent 'Chrome' http://127.0.0.1:7001/news

curl -v --user-agent 'Chrome' http://127.0.0.1:7001/news

运行环境

<code>npm install cross-env --save-dev

"scripts": {

"dev": "cross-env EGG_SERVER_ENV=local egg-bin dev",

"debug": "egg-bin debug"

}

单元测试

单元测试的优点

代码质量持续有保障重构正确性保障增强自信心自动化运行

测试框架

mochajspower-assert

测试约定

测试目录结构

我们约定 test 目录为存放所有测试脚本的目录，测试所使用到的 fixtures 和相关辅助脚本都应该放在此目录下。

测试脚本文件统一按 ${filename}.test.js 命名，必须以 .test.js 作为文件后缀。 一个应用的测试目录示例：

test

├── controller

│ └── news.test.js

└── service

└── news.test.js

测试运行工具

统一使用 egg-bin 来运行测试脚本， 自动将内置的 Mocha、co-mocha、power-assert，nyc 等模块组合引入到测试脚本中， 让我们聚焦精力在编写测试代码上，而不是纠结选择那些测试周边工具和模块。

"scripts": {

"test": "egg-bin test",

"cov": "egg-bin cov"

}

mock

如果要完整手写一个 app 创建和启动代码，还是需要写一段初始化脚本的， 并且还需要在测试跑完之后做一些清理工作，如删除临时文件，销毁 app。常常还有模拟各种网络异常，服务访问异常等特殊情况。egg.js单独为框架抽取了一个测试 mock 辅助模块：egg-mock， 有了它我们就可以非常快速地编写一个 app 的单元测试，并且还能快速创建一个 ctx 来测试它的属性、方法和 Service 等。

cnpm i egg-mock -D

app

在测试运行之前，我们首先要创建应用的一个 app 实例， 通过它来访问需要被测试的 Controller、Middleware、Service 等应用层代码。

// test/controller/news.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

describe('test/controller/news.test.js', () => {

});

钩子函数

test/order.test.js

describe('egg test', () => {

before(() => console.log('order 1'));

before(() => console.log('order 2'));

after(() => console.log('order 6'));

beforeEach(() => console.log('order 3'));

afterEach(() => console.log('order 5'));

it('should worker', () => console.log('order 4'));

});

ctx

test/controller/news.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

describe('test/controller/news.test.js', () => {

it('should get a ctx', () => {

const ctx=app.mockContext({

session: {

user:{ name:'zfpx'}

}

});

assert(ctx.method === 'GET');

assert(ctx.url==='/');

assert(ctx.session.user.name == 'zfpx');

});

});

异步测试

test/controller/news.test.js

egg-bin 支持测试异步调用，它支持多种写法

/*

it('promise',() => {

return app.httpRequest().get('/news').expect(200);

});

*/

/*

it('callback',(done) => {

app.httpRequest().get('/news').expect(200,done);

});

*/

/*

it('async',async () => {

await app.httpRequest().get('/news').expect(200);

});

*/

全面测试

测试Controller

test/controller/user.test.js

app.httpRequest()是 egg-mock 封装的 SuperTest 请求实例

准备数据

app/router.js

router.get('/add',controller.user.add);

router.post('/doAdd',controller.user.doAdd);

app/controller/user.js

const { Controller}=require('egg');

let users=[];

class UserController extends Controller{

async index() {

let { ctx}=this;

await ctx.render('user/list',{ users});

}

async add() {

let { ctx}=this;

await ctx.render('user/add',{ });

}

async doAdd() {

let { ctx}=this;

let user=ctx.request.body;

user.id=users.length>0?users[users.length-1].id+1:1;

users.push(user);

ctx.body = user;

}

}

module.exports=UserController;

user.test.js

test/controller/user.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

it('test post',async () => {

let user={ username: 'zfpx'};

app.mockCsrf();

let response=await app.httpRequest().post('/doAdd').send(user).expect(200);

assert(response.body.id == 1);

});

测试service

Service 相对于 Controller 来说，测试起来会更加简单我们只需要先创建一个 ctx，然后通过 ctx.service.${serviceName} 拿到 Service 实例， 然后调用 Service 方法即可。

test/service/user.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

const { app,assert}=require('egg-mock/bootstrap');

describe('test/service/news.test.js',() => {

it('newsService',async () => {

let ctx=app.mockContext();

let result=await ctx.service.news.list(1,5);

assert(result.length == 3);

});

});

Extend 测试

应用可以对 Application、Request、Response、Context 和 Helper 进行扩展。 我们可以对扩展的方法或者属性针对性的编写单元测试。

application

egg-mock 创建 app 的时候，已经将 Application 的扩展自动加载到 app 实例了， 直接使用这个 app 实例访问扩展的属性和方法即可进行测试。

app/extend/application.js

let cacheData={ };

exports.cache={

get(key) {

return cacheData[key];

},

set(key,val) {

cacheData[key]=val;

}

}

test/app/extend/cache.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

describe('test/app/extend/cache.test.js', () => {

it('cache',async () => {

app.cache.set('name','zfpx');

assert(app.cache.get('name') == 'zfpx');

});

});

context

Context 测试只比 Application 多了一个 app.mockContext() 步骤来模拟创建一个 Context 对象。

app\extend\context.js

exports.language=function () {

return this.get('accept-language');

}

test/app/extend/context.test.js

const { app, mock, assert } = require('egg-mock/bootstrap');

describe('test/app/extend/context.test.js',() => {

let language="zh-cn";code>

it('test language',async () => { -- -->

const ctx=app.mockContext({ headers: { 'Accept-Language':language}});

//console.log('ctx.lan',ctx.lan())

assert(ctx.language() == language);

});

});

Request