Evolution-App 后端项目教程

1. 项目目录结构及介绍

Backend/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── services/
├── config/
│   ├── default.json
│   └── production.json
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── test/
│   ├── integration/
│   └── unit/
├── .env
├── .gitignore
├── package.json
├── README.md
└── server.js

目录结构说明：

• app/: 包含应用程序的主要逻辑代码。
  • controllers/: 处理请求并返回响应的控制器。
  • models/: 数据库模型的定义。
  • routes/: 定义应用程序的路由。
  • services/: 业务逻辑服务。
• config/: 配置文件目录，包含不同环境的配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
• public/: 静态资源目录，包含CSS、JavaScript和图片文件。
• test/: 测试目录，包含集成测试和单元测试。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• server.js: 项目启动文件。

2. 项目启动文件介绍

server.js

server.js 是项目的启动文件，负责启动Express服务器并监听指定端口。以下是文件的主要内容：

const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

app.use(express.json());
app.use(express.urlencoded({ extended: true }));

app.use('/api', require('./app/routes'));

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件说明：

• express: 引入Express框架。
• app: 创建Express应用实例。
• port: 设置监听端口，优先使用环境变量中的端口，如果没有则使用3000端口。
• app.use(express.json()): 解析JSON格式的请求体。
• app.use(express.urlencoded({ extended: true })): 解析URL编码的请求体。
• app.use('/api', require('./app/routes')): 挂载路由，所有API请求都以/api为前缀。
• app.listen(port, ...): 启动服务器并监听指定端口。

3. 项目配置文件介绍

config/default.json

default.json 是项目的默认配置文件，包含所有环境的通用配置。以下是文件的主要内容：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "evolution_db"
  },
  "jwt": {
    "secret": "your_jwt_secret"
  }
}

配置文件说明：

• port: 服务器监听端口。
• database: 数据库配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • name: 数据库名称。
• jwt: JSON Web Token配置。
  • secret: JWT密钥。

config/production.json

production.json 是生产环境的配置文件，覆盖默认配置中的某些设置。以下是文件的主要内容：

{
  "port": 8080,
  "database": {
    "host": "production_db_host",
    "port": 27017,
    "name": "evolution_production_db"
  },
  "jwt": {
    "secret": "production_jwt_secret"
  }
}

配置文件说明：

• port: 生产环境服务器监听端口。
• database: 生产环境数据库配置。
  • host: 生产环境数据库主机地址。
  • port: 数据库端口。
  • name: 生产环境数据库名称。
• jwt: 生产环境JSON Web Token配置。
  • secret: 生产环境JWT密钥。

通过以上配置文件，项目可以根据不同的环境加载相应的配置，确保在不同环境下正常运行。