Express-Starter 项目教程

1. 项目的目录结构及介绍

Express-Starter/
├── src/
│   ├── config/
│   ├── controllers/
│   ├── middlewares/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── utils/
│   └── index.js
├── .env
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• src/: 项目的源代码目录，包含所有的业务逻辑代码。

  • config/: 存放项目的配置文件，如数据库连接配置、环境变量配置等。
  • controllers/: 存放控制器文件，处理HTTP请求并返回响应。
  • middlewares/: 存放中间件文件，用于处理请求前后的逻辑。
  • models/: 存放数据模型文件，定义数据结构和数据库操作。
  • routes/: 存放路由文件，定义API的路由和请求处理逻辑。
  • services/: 存放服务层文件，处理业务逻辑。
  • utils/: 存放工具函数和辅助文件。
  • index.js: 项目的入口文件，启动Express服务器。

• .env: 环境变量配置文件，用于存储敏感信息和配置参数。

• .gitignore: Git忽略文件，指定哪些文件或目录不需要被Git管理。

• package.json: 项目的依赖管理文件，定义项目的依赖包和脚本命令。

• README.md: 项目的说明文档，介绍项目的基本信息和使用方法。

2. 项目的启动文件介绍

src/index.js

const express = require('express');
const app = express();
const config = require('./config');
const routes = require('./routes');

// 配置中间件
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// 挂载路由
app.use('/api', routes);

// 启动服务器
const PORT = config.port || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

启动文件介绍

• 引入依赖: 首先引入Express框架和其他必要的依赖模块。
• 创建Express应用: 使用express()创建一个Express应用实例。
• 配置中间件: 使用express.json()和express.urlencoded()中间件来解析请求体。
• 挂载路由: 使用app.use('/api', routes)将路由挂载到/api路径下。
• 启动服务器: 使用app.listen()方法启动服务器，监听指定的端口。

3. 项目的配置文件介绍

.env

PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=password
DB_NAME=mydatabase

配置文件介绍

• PORT: 指定服务器监听的端口号。
• DB_HOST: 数据库的主机地址。
• DB_USER: 数据库的用户名。
• DB_PASSWORD: 数据库的密码。
• DB_NAME: 数据库的名称。

src/config/index.js

const dotenv = require('dotenv');
dotenv.config();

module.exports = {
  port: process.env.PORT,
  db: {
    host: process.env.DB_HOST,
    user: process.env.DB_USER,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
  },
};

配置文件介绍

• dotenv.config(): 加载.env文件中的环境变量。
• port: 从环境变量中读取端口号。
• db: 从环境变量中读取数据库的配置信息，包括主机地址、用户名、密码和数据库名称。

通过以上配置文件，项目可以根据不同的环境变量进行灵活配置，确保在不同的开发和生产环境中都能正常运行。