使用 node-express-boilerplate
的快速指南
1. 项目目录结构及介绍
在 node-express-boilerplate
中,目录结构设计得清晰且易于理解:
.
├── config # 配置文件夹
│ ├── env # 环境变量配置
│ └── index.js # 主配置文件
├── controllers # 控制器文件夹,处理业务逻辑
├── models # 数据模型文件夹,Mongoose 模型
├── middleware # 自定义中间件
├── routes # 路由文件夹,定义端点
├── bin # 包含启动脚本
│ └── www # 应用启动文件
├── public # 公共静态资源文件夹
└── ...
- config - 存储应用的配置信息,包括环境变量。
- controllers - 定义应用程序的业务逻辑操作。
- models - 包含数据库模型,使用 Mongoose 驱动。
- middleware - 自定义的应用级中间件,用于处理请求或响应。
- routes - 规定不同 URL 路径对应的处理函数。
- bin/www - 应用程序的启动文件。
- public - 通常存储 HTML、CSS 和 JavaScript 文件。
2. 项目的启动文件介绍
bin/www
是启动应用的入口文件。它主要执行以下任务:
const app = require('../app'); // 导入主应用对象
const debug = require('debug')('node-express-boilerplate:server');
const http = require('http');
const port = normalizePort(process.env.PORT || '3000'); // 获取或设置默认端口
app.set('port', port);
const server = http.createServer(app); // 创建 HTTP 服务器实例
server.listen(port);
server.on('error', onError);
server.on('listening', onListening);
// 错误处理和其他监听事件...
这里,app
对象来自 ../app.js
,它是 Express 应用实例。http.createServer()
使用该应用实例创建服务器,然后通过 server.listen()
启动监听指定端口。
3. 项目的配置文件介绍
配置文件位于 config
目录下,主要分为两部分:
3.1 环境变量 (env
目录)
每个环境(如开发、生产等)可能需要不同的配置。这些变量通常存储在 .env
文件中,例如开发环境的 .env.development
和生产环境的 .env.production
。它们包含数据库连接字符串、秘钥或其他敏感数据。
3.2 主配置文件 (index.js
)
config/index.js
将所有环境变量合并到一个对象中,方便在应用中使用。它可能看起来像这样:
const env = process.env.NODE_ENV || 'development';
require('dotenv').config({ path: `./env/.env.${env}` });
module.exports = {
env,
// 其他环境特定配置项...
};
这个文件加载了相应的 .env
文件,并导出配置对象,供其他模块使用。
通过以上内容,你应该对 node-express-boilerplate
有了基础的了解,可以开始基于此模板构建你的 Express 应用了。记得根据自己的需求调整配置并添加业务代码哦!