常见问题

如果下面的内容无法解决你的问题，请查看 Egg issues。

如何高效地反馈问题？

感谢您向我们反馈问题。

  1. 我们推荐如果是小问题（错别字修改，小的 bug fix）直接提交 PR。
  2. 如果是一个新需求，请提供：详细需求描述，最好是有伪代码示意。
  3. 如果是一个 BUG，请提供：复现步骤，错误日志以及相关配置，并尽量填写下面的模板中的条目。
  4. 如果可以，尽可能使用 npm init egg --type=simple bug 提供一个最小可复现的代码仓库，方便我们排查问题。
  5. 不要挤牙膏似的交流，扩展阅读：如何向开源项目提交无法解答的问题

最重要的是，请明白一件事：开源项目的用户和维护者之间并不是甲方和乙方的关系，issue 也不是客服工单。在开 issue 的时候，请抱着一种『一起合作来解决这个问题』的心态，不要期待我们单方面地为你服务。

为什么我的配置不生效？

框架的配置功能比较强大，有不同环境变量，又有框架、插件、应用等很多地方配置。

如果你分析问题时，想知道当前运行时使用的最终配置，可以查看下 ${root}/run/application_config.json（worker 进程配置） 和 ${root}/run/agent_config.json（agent 进程配置） 这两个文件。（root 为应用根目录，只有在 local 和 unittest 环境下为项目所在目录，其他环境下都为 HOME 目录）

也可参见配置文件。

PS：请确保没有写出以下代码：

  1. // config/config.default.js
  2. exports.someKeys = 'abc';
  3. module.exports = appInfo => {
  4.   const config = {};
  5.   config.keys = '123456';
  6.   return config;
  7. };

线上的日志打印去哪里了？

默认配置下，本地开发环境的日志都会打印在应用根目录的 logs 文件夹下(${baseDir}/logs) ，但是在非开发期的环境（非 local 和 unittest 环境），所有的日志都会打印到 $HOME/logs 文件夹下（例如 /home/admin/logs）。这样可以让本地开发时应用日志互不影响，服务器运行时又有统一的日志输出目录。

进程管理为什么没有选型 PM2 ？

  1. PM2 模块本身复杂度很高，出了问题很难排查。我们认为框架使用的工具复杂度不应该过高，而 PM2 自身的复杂度超越了大部分应用本身。
  2. 没法做非常深的优化。
  3. 切实的需求问题，一个进程里跑 leader，其他进程代理到 leader 这种模式（多进程模型），在企业级开发中对于减少远端连接，降低数据通信压力等都是切实的需求。特别当应用规模大到一定程度，这就会是刚需。egg 本身起源于蚂蚁金服和阿里，我们对标的起点就是大规模企业应用的构建，所以要非常全面。这些特性通过 PM2 很难做到。

进程模型非常重要，会影响到开发模式，运行期间的深度优化等，我们认为可能由框架来控制比较合适。

如何使用 PM2 启动应用？

尽管我们不推荐使用 PM2 启动，但仍然是可以做到的。

首先，在项目根目录定义启动文件：

  1. // server.js
  2. const egg = require('egg');
  4. const workers = Number(process.argv[2] || require('os').cpus().length);
  5. egg.startCluster({
  6.   workers,
  7.   baseDir: __dirname,
  8. });

这样，我们就可以通过 PM2 进行启动了：

  1. pm2 start server.js

为什么会有 csrf 报错？

通常有两种 csrf 报错：

  • missing csrf token
  • invalid csrf token

Egg 内置的 egg-security 插件默认对所有『非安全』的方法，例如 POST，PUT，DELETE 都进行 CSRF 校验。

请求遇到 csrf 报错通常是因为没有加正确的 csrf token 导致，具体实现方式，请阅读安全威胁 CSRF 的防范。

本地开发时，修改代码后为什么 worker 进程没有自动重启？

没有自动重启的情况一般是在使用 Jetbrains 旗下软件（IntelliJ IDEA, WebStorm..），并且开启了 Safe Write 选项。

Jetbrains Safe Write 文档中有提到（翻译如下）：

如果此复选框打钩，变更的文件将首先被存储在一个临时文件中。如果成功保存了该文件，那么就会被这个文件所取代（从技术上来说，原文件被删除，临时文件被重命名）。

由于使用了重命名导致文件监听的失效。解决办法是关掉 Safe Write 选项。（Settings | Appearance & Behavior | System Settings | Use “safe write” 路径可能根据版本有所不同）