Yiran 项目启动与配置教程

1. 项目目录结构及介绍

Yiran项目的目录结构如下：

yiran/
├── app/              # 应用程序目录
│   ├── __init__.py   # 初始化文件
│   ├── controllers/  # 控制器目录，存放处理请求的类
│   ├── models/       # 模型目录，存放数据库模型
│   ├── services/     # 服务层目录，存放业务逻辑
│   └── utils/        # 工具目录，存放通用工具类
├── config/           # 配置文件目录
│   └── settings.py   # 配置文件
├── database/         # 数据库迁移脚本目录
├── doc/              # 项目文档目录
├── migrations/       # 数据库迁移目录
├── requirements.txt  # 项目依赖文件
├── run.py            # 项目启动文件
└── tests/            # 测试目录

• app/: 包含应用程序的主要逻辑，分为控制器、模型、服务层和工具类。
• config/: 包含项目的配置文件。
• database/: 存放数据库初始化和迁移的脚本。
• doc/: 存放项目文档。
• migrations/: 存放数据库迁移脚本。
• requirements.txt: 列出了项目运行所需的第三方库。
• run.py: 项目的入口文件，用于启动应用程序。
• tests/: 存放项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件是run.py，其主要功能是初始化应用程序并启动服务。以下是run.py的主要代码：

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

create_app函数位于app/__init__.py文件中，它负责创建和配置应用程序实例。

3. 项目的配置文件介绍

项目的配置文件位于config/settings.py，该文件定义了项目运行时需要用到的各种配置项，例如数据库连接信息、服务器端口等。以下是settings.py的一个基本示例：

# 配置类
class Config:
    # 数据库配置
    SQLALCHEMY_DATABASE_URI = 'mysql://username:password@localhost/db_name'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    # 服务器配置
    HOST = '0.0.0.0'
    PORT = 5000

    # 其他配置项
    SECRET_KEY = 'your_secret_key'

在应用程序中，可以通过current_app.config来访问这些配置项。正确的配置是确保应用程序稳定运行的关键。在部署到生产环境时，建议根据实际环境对配置文件进行相应的调整。