Egg.js 学习笔记——项目结构与配置指南

Egg.js 学习笔记——项目结构与配置指南

eggjs-note 《Egg.js 深入浅出学习笔记》(暂时停更) 项目地址: https://gitcode.com/gh_mirrors/eg/eggjs-note

1. 项目目录结构及介绍

《Egg.js 深入浅出学习笔记》项目的目录结构如下：

eggjs-note/
├── demo/                       # 示例代码目录
├── note/                       # 学习笔记和文章目录
│   ├── .gitkeep
│   ├── README.md               # 项目简介和目录
│   ├── SUMMARY.md              # 摘要文件
│   ├── about.md                # 关于本书和作者
│   ├── intro.md                # 前言
│   ├── ...
│   └── other-md-files.md       # 其他Markdown文件
├── .gitignore                  # Git忽略文件列表
├── LICENSE                     # 项目许可证文件
└── README.md                   # 项目说明文件

demo目录

demo/ 目录包含了用于演示Egg.js特性的示例代码，这些代码与学习笔记中的内容相对应，可以帮助读者更好地理解Egg.js的工作原理和实现细节。

note目录

note/ 目录是本项目的主要内容，包含了所有学习笔记和相关的Markdown文件。这些文件详细介绍了Egg.js的各个方面，包括但不限于其设计理念、核心体系、加载机制、启动流程等。

.gitignore文件

.gitignore 文件指定了Git在版本控制时需要忽略的文件和目录，以避免将一些不必要的文件（如本地设置文件、日志文件等）提交到代码库中。

LICENSE文件

LICENSE 文件包含了项目的许可证信息，本项目采用MIT许可证，这是一种宽松的许可证，允许用户自由使用、修改和分发项目代码。

README.md文件

README.md 是项目的说明文件，它通常包含了项目的介绍、使用方法、贡献指南、许可证信息等内容。

2. 项目的启动文件介绍

在Egg.js项目中，通常会使用egg-bin脚手架工具来启动项目。以下是启动项目的基本步骤：

1. 安装依赖：在项目根目录下运行npm install或yarn install来安装项目依赖。
2. 启动项目：使用npm run dev或yarn run dev命令来启动开发服务器。

Egg.js项目的启动文件通常位于项目的根目录，例如bin/www或app.js。以下是bin/www文件的基本内容：

#!/usr/bin/env node

/**
 * Module dependencies.
 */

const app = require('../app');
const debug = require('debug')('eggjs-note:server');
const http = require('http');

/**
 * Normalize a port into a number, string, or false.
 */

const normalizePort = port => {
  const normalizedPort = parseInt(port, 10);
  if (isNaN(normalizedPort)) {
    return port;
  }
  return normalizedPort;
};

/**
 * Get port from environment and store in Express.
 */

const port = normalizePort(process.env.PORT || '3000');
app.set('port', port);

/**
 * Create HTTP server.
 */

const server = http.createServer(app);

/**
 * Listen on provided port, on all network interfaces.
 */

server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

/**
 * Event listener for HTTP server "error" event.
 */

function onError(error) {
  if (error.syscall !== 'listen') {
    throw error;
  }

  const bind = typeof port === 'string' ? 'Pipe ' + port : 'Port ' + port;

  // Handle specific listen errors with friendly messages
  switch (error.code) {
    case 'EACCES':
      console.error(bind + ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind + ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  }
}

/**
 * Event listener for HTTP server "listening" event.
 */

function onListening() {
  const addr = server.address();
  const bind = typeof addr === 'string' ? 'pipe ' + addr : 'port ' + addr.port;
  debug('Listening on ' + bind);
}

这个文件设置了HTTP服务器，并监听在指定的端口上。

3. 项目的配置文件介绍

Egg.js项目的配置文件通常位于项目的config目录下。以下是Egg.js中几个重要的配置文件及其作用：

• config/config.default.js: 默认配置文件，包含了项目的通用配置。
• config/config.local.js: 本地开发环境特定的配置。
• config/config.prod.js: 生产环境特定的配置。

以下是config/config.default.js的一个示例：

// config/config.default.js
module.exports = appInfo => {
  const config = {};

  // 中间件配置
  config.middleware = [];

  // 模板引擎配置
  config.view = {
    defaultViewEngine: 'nunjucks',
    mapping: {
      '.html': 'nunjucks',
    },
  };

  // 更多配置...

  return config;
};

在这个配置文件中，你可以设置中间件、模板引擎以及其他应用级别的配置。不同环境的配置文件会覆盖默认配置文件中的相应配置项，以适应不同的运行环境。

eggjs-note 《Egg.js 深入浅出学习笔记》(暂时停更) 项目地址: https://gitcode.com/gh_mirrors/eg/eggjs-note