Egg.js

简体中文

English

简体中文

English

Appearance

为了提升研发体验，我们提供了便捷的方式在本地进行开发、调试、单元测试等。

在这里我们需要使用到 egg-bin 模块（只在本地开发和单元测试使用，如果线上请参考 应用部署）。

首先，我们需要把 egg-bin 模块作为 devDependencies 引入：

bash
$ npm i egg-bin --save-dev

启动应用 ​

本地启动应用进行开发活动，当我们修改代码并保存后，应用会自动重启实时生效。

添加命令 ​

向 package.json 中添加 npm scripts：

json
{
  "scripts": {
    "dev": "egg-bin dev"
  }
}

这样我们就可以通过 npm run dev 命令启动应用。

环境配置 ​

本地启动的应用是以 env: local 启动的，读取的配置是 config.default.js 和 config.local.js 合并的结果。

注意：本地开发环境依赖 @eggjs/development 插件，该插件默认开启，而在其他环境下关闭。配置参考 config/config.default.ts。

关于 Reload 功能 ​

以下目录（包括子目录）在开发环境下默认会监听文件变化，一旦发生变化，将触发 Egg 服务器重载：

  • ${app_root}/app
  • ${app_root}/config
  • ${app_root}/mocks
  • ${app_root}/mocks_proxy
  • ${app_root}/app.js

若设置 config.development.overrideDefault 为 true，则会跳过默认合并。

以下目录（包括子目录）在开发环境下默认忽略文件改动：

  • ${app_root}/app/view
  • ${app_root}/app/assets
  • ${app_root}/app/public
  • ${app_root}/app/web

若设置 config.development.overrideIgnore 为 true，则会跳过默认合并。

指定端口 ​

本地启动应用默认监听 7001 端口，你也可以指定其他端口，例如：

json
{
  "scripts": {
    "dev": "egg-bin dev --port 7001"
  }
}

单元测试 ​

这里主要讲解工具部分的使用，更多关于单元测试的内容请参考这里。

添加命令 ​

在 package.json 中添加 npm scripts：

json
{
  "scripts": {
    "test": "egg-bin test"
  }
}

我们可以通过执行 npm test 命令来运行单元测试。

环境配置 ​

测试用例执行时，应用以 env: unittest 启动，读取的配置是 config.default.js 和 config.unittest.js 合并的结果。

运行特定用例文件 ​

执行 npm test 会自动运行 test 目录下的以 .test.js 结尾的文件（默认 glob 匹配规则 test/**/*.test.js）。

如果只想执行正在编写的用例，可以通过下列方式指定特定用例文件：

bash
$ TESTS=test/x.test.js npm test

该方式支持 glob 规则。

指定 reporter ​

Mocha 支持多种形式的 reporter，默认是 spec reporter。

通过设置 TEST_REPORTER 环境变量来指定 reporter，例如 dot：

bash
$ TEST_REPORTER=dot npm test

image

指定用例超时时间 ​

用例默认超时时间是 30 秒。也可以手动设置超时时间（单位毫秒），例如设为 5 秒：

bash
$ TEST_TIMEOUT=5000 npm test

通过 argv 方式传参 ​

egg-bin test 不仅支持环境变量传参，还支持直接传参，包括所有 mocha 参数，详情见：mocha usage 。

bash
$ # npm 传参需额外加 `--`，详情见 https://docs.npmjs.com/cli/run-script
$ npm test -- --help
$
$ # 相当于 `TESTS=test/**/test.js npm test`，但加双引号更佳，避免 bash 限制
$ npm test "test/**/test.js"
$
$ # 相当于 `TEST_REPORTER=dot npm test`
$ npm test -- --reporter=dot
$
$ # 支持 mocha 参数，如 grep、require 等
$ npm test -- -t 30000 --grep="should GET"

代码覆盖率 ​

egg-bin 已内置 nyc 支持单元测试生成代码覆盖率报告。

在 package.json 中添加 npm scripts：

json
{
  "scripts": {
    "cov": "egg-bin cov"
  }
}

我们可以通过 npm run cov 命令运行测试覆盖率。

bash
$ egg-bin cov

  test/controller/home.test.js
    GET /
      ✓ should status 200 and get the body
    POST /post
      ✓ should status 200 and get the request body

  ...

  16 passing (1s)

=============================== Coverage summary ===============================
Statements   : 100% ( 41/41 )
Branches     : 87.5% ( 7/8 )
Functions    : 100% ( 10/10 )
Lines        : 100% ( 41/41 )
================================================================================

还可以通过 open coverage/lcov-report/index.html 命令来查看完整 HTML 覆盖率报告。

image

环境配置 ​

与 test 命令类似，执行 cov 命令时，应用以 env: unittest 启动，并读取 config.default.js 和 config.unittest.js 合并的配置结果。

忽略指定文件 ​

对于不需要计算覆盖率的文件，可通过 COV_EXCLUDES 环境变量来指定：

bash
$ COV_EXCLUDES=app/plugins/c* npm run cov
$ # 或者使用传参方式
$ npm run cov -- --x=app/plugins/c*

调试 ​

日志输出 ​

使用 logger 模块 ​

框架内置了 日志 功能，使用 logger.debug() 输出调试信息，推荐在应用代码中使用它。

js
// controller
this.logger.debug('current user: %j', this.user);

// service
this.ctx.logger.debug('debug info from service');

// app/init.js
app.logger.debug('app init');

通过 config.logger.level 来配置打印到文件的日志级别，通过 config.logger.consoleLevel 配置打印到终端的日志级别。

使用 debug 模块 ​

debug 模块是 Node.js 社区广泛使用的 debug 工具，很多模块都使用这个模块来打印调试信息，Egg 社区也广泛采用这一机制来打印 debug 信息，推荐在框架和插件开发中使用它。

我们可以通过 DEBUG 环境变量选择开启指定的调试代码，方便观测执行过程。

（调试模块和日志模块不要混淆；此外，日志模块还具备很多其他功能。这里所说的日志全部指调试信息。）

开启所有模块的日志：

bash
$ DEBUG=* npm run dev

开启指定模块的日志：

bash
$ DEBUG=egg* npm run dev

单元测试也可以使用 DEBUG=* npm test 来查看测试用例运行的详细日志。

使用 egg-bin 调试 ​

添加命令 ​

在 package.json 中添加 npm scripts：

json
{
  "scripts": {
    "debug": "egg-bin debug"
  }
}

现在，我们可以通过 npm run debug 命令来断点调试应用。

egg-bin 会智能选择调试协议。在 Node.js 8.x 之后的版本中，使用 Inspector Protocol 协议，低版本使用 Legacy Protocol。

也支持自定义调试参数：

bash
$ egg-bin debug --inspect=9229
  • master 调试端口为 9229 或 5858（旧协议）。
  • agent 调试端口固定为 5800，可以通过传递 process.env.EGG_AGENT_DEBUG_PORT 来自定义。
  • worker 调试端口为 master 调试端口递增。
  • 开发阶段，worker 的代码修改后会热重启，导致调试端口自增。参见后文的 IDE 配置，可以实现自动重连。

环境配置 ​

执行 debug 命令时，应用也是以 env: local 启动的。读取的配置是 config.default.js 和 config.local.js 合并的结果。

使用 DevTools 进行调试 ​

最新的 DevTools 只支持 Inspector Protocol 协议，因此你需要使用 Node.js 8.x 及以上版本。

执行 npm run debug 启动：

bash
➜  showcase git:(master) ✗ npm run debug

> [email protected] debug /Users/tz/Workspaces/eggjs/test/showcase
> egg-bin debug

Debugger listening on ws://127.0.0.1:9229/f8258ca6-d5ac-467d-bbb1-03f59bcce85b
For help see https://nodejs.org/en/docs/inspector
2017-09-14 16:01:35,990 INFO 39940 [master] egg version 1.8.0
Debugger listening on ws://127.0.0.1:5800/bfe1bf6a-2be5-4568-ac7d-69935e0867fa
For help see https://nodejs.org/en/docs/inspector
2017-09-14 16:01:36,432 INFO 39940 [master] agent_worker#1:39941 started (434ms)
Debugger listening on ws://127.0.0.1:9230/2fcf4208-4571-4968-9da0-0863ab9f98ae
For help see https://nodejs.org/en/docs/inspector
9230 opened
Debug Proxy online, now you could attach to 9999 without worry about reload.
DevTools → chrome-devtools://devtools/bundled/inspector.html?experiments=true&v8only=true&ws=127.0.0.1:9999/__ws_proxy__

接下来选择以下其中一种方式：

  • 直接访问控制台最后输出的 DevTools 地址，该地址代理了 worker。不必担心重启问题。
  • 访问 chrome://inspect 后，配置相应的端口。点击 Open dedicated DevTools for Node 打开调试控制台。

DevTools

使用 WebStorm 进行调试 ​

egg-bin 会自动读取 WebStorm 调试模式下设置的环境变量 $NODE_DEBUG_OPTION。

直接使用 WebStorm 的 npm 调试功能启动：

WebStorm

使用 VSCode 进行调试 ​

有以下两种方式：

方式一：开启 VSCode 的 Debug: Toggle Auto Attach。然后在 Terminal 中执行 npm run debug。

方式二：配置 VSCode 的 .vscode/launch.json，然后使用 F5 启动。注意，要关闭方式一中的配置。

json
// .vscode/launch.json
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch Egg",
      "type": "node",
      "request": "launch",
      "cwd": "${workspaceRoot}",
      "runtimeExecutable": "npm",
      "windows": { "runtimeExecutable": "npm.cmd" },
      "runtimeArgs": ["run", "debug"],
      "console": "integratedTerminal",
      "protocol": "auto",
      "restart": true,
      "port": 9229,
      "autoAttachChildProcesses": true
    }
  ]
}

我们还提供了 vscode-eggjs 扩展，可以自动生成配置。

VSCode

更多 VSCode 调试用法请参见文档：Node.js Debugging in VS Code。

更多 ​

想要了解更多有关本地开发的内容，例如如何为你的团队定制本地开发工具，请参阅 egg-bin。

Born to build better enterprise frameworks and apps

Copyright © 2017-present Egg.js