Express 项目初始化与配置指南
一、项目创建与初始化
1. 安装 Express 生成器
npm install express-generator -g
2. 使用 EJS 模板引擎创建项目
express --view=ejs node-ruoyi
3. 安装项目依赖
cd node-ruoyi
npm install
4. 安装开发工具 Nodemon
npm install nodemon --save-dev
5. 配置启动脚本
修改 package.json 文件中的脚本配置:
修改前:
"scripts": {
"start": "node ./bin/www"
}
修改后:
"scripts": {
"start": "nodemon ./bin/www"
}
说明:使用 Nodemon 替代原生 Node.js 启动,可实现代码热重载,提升开发效率。
二、项目目录结构规划
node-ruoyi/
├─ bin/
│ └─ www # 应用启动入口
├─ config/
│ └─ index.js # 全局配置文件
├─ controllers/ # 控制器层
├─ db/
│ └─ db.js # 数据库连接配置
├─ models/ # 数据模型层
│ └─ index.js # 模型统一导出入口
├─ public/ # 静态资源目录
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets/
│ └─ style.css
├─ routes/ # 路由层
│ └─ index.js # 路由统一管理
├─ utils/ # 工具函数目录
│ └─ index.js
├─ views/ # 视图模板目录
│ ├─ error.ejs
│ └─ index.ejs
├─ app.js # Express 应用主文件
├─ package.json # 项目配置文件
├─ package-lock.json # 依赖锁定文件
└─ README.md # 项目说明文档
目录结构说明:
- bin/www:应用服务器启动入口,负责端口监听和服务启动
- config/:集中管理项目配置,如数据库连接、环境变量等
- controllers/:业务逻辑控制器,处理具体的业务请求
- db/:数据库连接和初始化相关配置
- models/:Mongoose 数据模型定义,对应数据库集合
- routes/:路由定义文件,将 URL 路径映射到对应控制器
- utils/:通用工具函数库
- views/:EJS 模板文件,负责视图渲染
三、启动项目并验证
1. 启动开发服务器
npm start
2. 访问应用
在浏览器中打开以下地址:
http://localhost:3000
3. 预期结果
成功启动后,浏览器将显示 Express 默认欢迎页面:
四、项目特点与优势
1. 架构清晰
采用 MVC(Model-View-Controller)设计模式,实现代码分层管理,便于团队协作和维护。
2. 开发高效
- 使用 Express Generator 快速搭建项目骨架
- 配置 Nodemon 实现实时热重载
- EJS 模板引擎简化视图渲染
3. 配置灵活
- 配置文件集中管理,便于不同环境部署
- 数据库连接可配置化,支持多种连接参数
4. 易于扩展
- 模块化目录结构便于功能扩展
- 中间件机制支持功能插拔
- 路由分层管理,逻辑清晰
五、下一步建议
- 配置数据库模型:在
models/目录下创建具体的 Mongoose 模型 - 定义业务路由:在
routes/目录中添加业务相关的路由配置 - 实现控制器:在
controllers/目录中编写具体的业务逻辑 - 添加中间件:根据需要添加身份验证、日志记录等中间件
- 配置环境变量:将敏感信息移至环境变量中管理
项目现已完成基础搭建,您可以开始根据具体业务需求进行功能开发。