后端Web框架【免费下载链接】egg Born to build better enterprise frameworks and apps with Node.js Koa项目地址https://gitcode.com/gh_mirrors/egg11/egg点击查看免费下载本地开发体验是 Egg 框架本文基于 egg 仓库源码的强项之一通过egg-bin这一专用命令行工具你可以一键启动带热更新的开发服务器、运行 Mocha 单元测试、自动统计代码覆盖率并接入 DevTools / WebStorm / VSCode 进行断点调试。本文将以官方文档 本地开发 为骨架结合本仓库的配置与源码实现完整讲解从搭建开发环境到高级调试的每一步读完即可在自己的 Egg 项目中复刻整套本地开发流程。说明egg-bin只在本地开发和单元测试场景使用线上环境请参考 应用部署。一、引入本地开发工具链 egg-binegg-bin是 Egg 官方提供的本地开发命令行工具封装了 dev开发、test测试、cov覆盖率、debug调试等子命令。它作为devDependencies引入因为生产部署时不会安装开发依赖$ npm i egg-bin --save-dev本仓库自身也在 package.json 的devDependencies中声明了egg-bin并基于它组织了自己的脚本{ scripts: { test-local: egg-bin test, cov: egg-bin cov --timeout 100000 } }可见即使 Egg 框架自身也是用这套工具跑测试与覆盖率的。二、本地启动应用npm run dev2.1 添加命令在package.json的scripts中添加{ scripts: { dev: egg-bin dev } }之后执行npm run dev即可启动应用。开发模式下当你修改代码并保存后应用会自动重启改动实时生效——这一能力由框架内置的egg-development与egg-watcher插件提供见 package.json 的 dependencies无需额外配置。2.2 环境配置egg-bin dev启动的应用以env: local运行因此读取的配置是config.default.js与config.local.js合并后的结果。本地环境配置文件的真实内容如下见 config/config.local.jsuse strict; exports.logger { coreLogger: { consoleLevel: WARN, }, };也就是说本地开发时框架核心日志coreLogger在终端上以WARN级别输出避免框架自身的 INFO 日志刷屏而应用日志logger仍保持默认的INFO级别见 config/config.default.js 中config.logger的默认值level: INFO、consoleLevel: INFO。关于local环境的来源与映射可参考 运行环境 文档中的规则表NODE_ENVEGG_SERVER_ENV说明local本地开发环境testunittest单元测试productionprod生产环境2.3 指定端口本地启动默认监听7001端口该默认值来自 config/config.default.js 中的config.cluster.listen.port 7001。如需修改可通过--port参数指定{ scripts: { dev: egg-bin dev --port 7001 } }小提示在local/unittest环境下若应用未配置config.keysCookie 签名密钥框架会在启动时打印明确的中文错误提示指引你在config/config.default.js中补全对应实现见 lib/application.js 中get keys()的逻辑。这是本地开发最容易踩到的第一个坑。三、单元测试npm test本节聚焦测试工具的使用关于测试框架、断言、异步测试等编写层面的内容请参考 单元测试。3.1 添加命令{ scripts: { test: egg-bin test } }之后执行npm test即可运行全部单元测试。3.2 环境配置测试用例执行时应用以env: unittest启动读取config.default.js与config.unittest.js合并后的配置。本仓库的 config/config.unittest.js 内容如下use strict; module.exports { logger: { consoleLevel: WARN, buffer: false, }, };两点值得注意consoleLevel: WARN测试时终端只输出 WARN 及以上日志避免海量 INFO 日志干扰用例输出buffer: false关闭日志缓冲测试中每条日志立即落盘方便断言与排查。3.3 运行特定用例文件npm test会自动执行test目录下所有以.test.js结尾的文件默认 glob 匹配规则为test/**/*.test.js。编写用例时若只想跑当前正在写的文件通过TESTS环境变量指定支持 glob 规则$ TESTStest/x.test.js npm test3.4 指定 reporterMocha 支持多种 reporteregg-bin test默认使用spec。可通过TEST_REPORTER环境变量切换例如使用dot输出紧凑结果$ TEST_REPORTERdot npm test3.5 指定用例超时时间用例默认超时时间为30 秒可通过TEST_TIMEOUT环境变量调整单位毫秒例如设置为 5 秒$ TEST_TIMEOUT5000 npm test3.6 通过 argv 直接传参除了环境变量egg-bin test也支持直接传参可透传 Mocha 的全部参数。注意通过 npm script 传参时需额外加一个--分隔符$ # 查看 egg-bin test 的完整帮助 $ npm test -- --help $ $ # 等同于 TESTStest/**/test.js npm test受限于 bashglob 最好加上双引号 $ npm test test/**/test.js $ $ # 等同于 TEST_REPORTERdot npm test $ npm test -- --reporterdot $ $ # 支持 mocha 的任意参数如 -t超时、--grep按描述过滤用例等 $ npm test -- -t 30000 --grepshould GET3.7 仓库中的真实用例组织在本仓库中测试用例统一放在 test 目录下既有框架核心的test/lib/core、test/lib/cluster、test/lib/plugins等单元测试也有大量集成测试夹具应用位于 test/fixtures/apps如demo、async-app、service-app等每个夹具都是一个带package.json和业务代码的迷你 Egg 应用。这种测试即应用的组织方式正是 Egg 生态中验证框架行为的标准做法。四、代码覆盖率npm run cov4.1 基本用法egg-bin内置了 nycIstanbul 工具链的覆盖率统计器无需额外安装。添加脚本{ scripts: { cov: egg-bin cov } }运行npm run cov后终端会依次输出测试结果与覆盖率摘要$ 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 ) 还可以打开生成的完整 HTML 报告逐文件、逐行查看覆盖情况$ open coverage/lcov-report/index.html4.2 环境配置cov命令与应用启动、测试一致同样以env: unittest运行读取config.default.js与config.unittest.js的合并配置。4.3 忽略指定文件某些文件如插件目录不需要纳入覆盖率统计可用COV_EXCLUDES环境变量排除支持 glob$ COV_EXCLUDESapp/plugins/c* npm run cov $ # 或者用传参方式效果相同 $ npm run cov -- --xapp/plugins/c*框架自身在 package.json 中通过cov: egg-bin cov --timeout 100000运行覆盖率这是对超时参数-t与 cov 组合使用的实际范例——当整个框架的用例较多、单条用例耗时较长时需要调大默认的 30 秒超时。五、调试5.1 使用框架内置 logger 输出调试信息框架内置了完整的 日志 体系应用业务代码推荐使用logger.debug()打印调试信息它会随应用日志一起写入文件并可在终端查看// 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/config.default.js 中config.loggerconfig.logger.level打印到日志文件的级别默认INFOconfig.logger.consoleLevel打印到终端的级别默认INFO。源码层面对此还有一个值得注意的保护逻辑见 lib/core/logger.js当应用运行在prod环境、且配置级别为DEBUG时除非显式设置allowDebugAtProd: true否则框架会把文件日志级别强制提升为INFO——防止生产环境输出过多调试日志。此外disableConsoleAfterReady默认在非local/unittest环境下为true即应用就绪后关闭终端日志输出见 config/config.default.js 与 lib/core/logger.js。5.2 使用 debug 模块观测执行过程debug是 Node.js 社区广泛使用的调试输出工具Egg 社区包括框架与众多插件也普遍用它打印调试信息框架和插件开发中推荐使用。它与日志模块不同日志会落盘、面向运行期debug的调试输出默认关闭只有通过DEBUG环境变量按需开启适合观测代码执行路径。开启所有模块的调试输出$ DEBUG* npm run dev开启指定命名空间如 egg 相关模块$ DEBUGegg* npm run dev单元测试同样适用$ DEBUG* npm test5.3 使用 egg-bin debug 断点调试添加命令{ scripts: { debug: egg-bin debug } }执行npm run debug即可进入断点调试模式。调试协议与端口分配egg-bin会自动选择调试协议Node.js 7.x 之后的版本使用 Inspector Protocol低版本使用 Legacy ProtocolV8 Debugger。也可以自定义调试参数$ egg-bin debug --proxy9999 --inspect9229 --inspect-brk各进程调试端口的分配规则如下master调试端口为 9229新协议或 5858旧协议agent调试端口固定为 5800worker调试端口为master端口依次递增如 9230、9231 …开发阶段 worker 在代码修改后会热重启导致调试端口自增因此egg-bin启动了代理服务你只需固定 attach 到--proxy指定的 9999 端口即可无需关心端口漂移。这一master / agent / worker的进程模型也印证了 Egg 的集群架构master 负责调度、agent 承载公共任务、worker 对外提供服务可结合 lib/egg.js 与调试输出日志对照理解。环境配置debug命令同样以env: local启动读取config.default.js与config.local.js合并后的配置。使用 DevTools 调试最新的 Chrome DevTools 只支持 Inspector Protocol因此需要 Node.js 7.x。执行npm run debug后控制台会输出类似如下的调试信息➜ showcase git:(master) ✗ npm run debug showcase1.0.0 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?experimentstruev8onlytruews127.0.0.1:9999/__ws_proxy__随后任选一种方式接入直接访问控制台最后输出的 DevTools 地址该地址是代理后的 worker无需担心 worker 重启导致断线或访问chrome://inspect配置对应端口9999点击Open dedicated DevTools for Node打开调试控制台。使用 WebStorm 调试egg-bin会自动读取 WebStorm 调试模式下设置的环境变量$NODE_DEBUG_OPTION。因此无需手工传参直接在 WebStorm 中以 npm 调试方式启动debug脚本即可断点调试。使用 VSCode 调试在 Node.js 7.x 及之后版本配置 .vscode/launch.json 如下F5 一键启动通过restart: true配合热重启自动重连// .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: 9999 } ] }在低于 Node.js 7.x 的版本中Inspector Protocol 不可用只能先在终端手动执行npm run debug然后通过以下 attach 配置接入代理端口// .vscode/launch.json { version: 0.2.0, configurations: [ { name: Attach Egg Worker, type: node, request: attach, restart: true, port: 9999 } ] }六、小结与延伸至此你已掌握 Egg 本地开发的完整闭环npm run dev热更新开发、npm test跑单测含TESTS/TEST_REPORTER/TEST_TIMEOUT环境变量与 Mocha argv 透传、npm run cov统计覆盖率含COV_EXCLUDES排除规则以及基于logger.debug/DEBUG/egg-bin debug的三层调试手段。如果希望对团队定制一套专属的本地开发工具例如统一脚手架、自定义命令别名可深入研究egg-bin自身的实现与扩展方式。文中涉及的配置合并、默认端口、日志级别与进程调试模型均可在 config/config.default.js、config/config.local.js、config/config.unittest.js、lib/core/logger.js、lib/egg.js 等源码文件中找到对应实现作为进一步学习的入口。赞分享后端Web框架【免费下载链接】egg Born to build better enterprise frameworks and apps with Node.js Koa项目地址https://gitcode.com/gh_mirrors/egg11/egg点击查看免费下载相关推荐终极Casbin测试覆盖率指南从单元测试到集成测试的完整策略终极Casbin测试覆盖率指南从单元测试到集成测试的完整策略 Casbin作为一款强大的开源授权库支持ACL、RBAC、ABAC等多种访问控制模型其稳定性后端认证鉴权compressorjs测试驱动开发从单元测试到覆盖率优化的完整指南compressorjs测试驱动开发从单元测试到覆盖率优化的完整指南 compressorjs是一个强大的JavaScript图像压缩库采用浏览器原生的ca图像处理前端DrawableToolbox源码解析从DrawableBuilder看设计模式的巧妙应用DrawableToolbox源码解析从DrawableBuilder看设计模式的巧妙应用 DrawableToolbox是Android开发中一个强大的开源上一篇H-Net未来展望层次化序列建模的完整技术路线图下一篇突破2000token限制MPT-7B-Instruct全链路优化实践指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考