LeoBlog-back 项目教程

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

LeoBlog-back 是一个基于 Flask 框架的博客后端项目。以下是项目的目录结构及其介绍：

LeoBlog-back/
├── src/
│   ├── main/
│   │   ├── config/          # 配置文件目录
│   │   ├── controllers/     # 控制器目录
│   │   ├── models/          # 数据模型目录
│   │   ├── services/        # 服务层目录
│   │   ├── utils/           # 工具类目录
│   │   └── app.py           # 应用启动文件
│   └── tests/               # 测试目录
├── .gitignore               # Git 忽略文件
├── LICENSE                  # 项目许可证
├── README.md                # 项目说明文档
├── pom.xml                  # Maven 配置文件
└── requirements.txt         # Python 依赖文件

目录结构详细介绍

• src/main/: 项目的主要代码目录。
  • config/: 包含项目的配置文件，如数据库配置、日志配置等。
  • controllers/: 包含处理 HTTP 请求的控制器文件。
  • models/: 包含数据库模型文件。
  • services/: 包含业务逻辑服务文件。
  • utils/: 包含各种工具类和辅助函数。
  • app.py: 应用的启动文件。
• src/tests/: 包含项目的测试代码。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• pom.xml: Maven 项目的配置文件。
• requirements.txt: Python 项目的依赖文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main/app.py。以下是该文件的简要介绍：

# src/main/app.py

from flask import Flask
from config import Config
from controllers import *
from models import db

def create_app():
    app = Flask(__name__)
    app.config.from_object(Config)

    db.init_app(app)

    with app.app_context():
        db.create_all()

    return app

if __name__ == "__main__":
    app = create_app()
    app.run(debug=True)

启动文件详细介绍

• 导入模块: 导入了 Flask 框架、配置文件、控制器和数据库模型。
• create_app 函数: 创建 Flask 应用实例，并进行配置。
• 数据库初始化: 初始化数据库并创建所有表。
• 运行应用: 启动 Flask 应用，开启调试模式。

3. 项目的配置文件介绍

项目的配置文件位于 src/main/config/ 目录下。以下是配置文件的简要介绍：

# src/main/config/config.py

import os

class Config:
    SECRET_KEY = os.getenv('SECRET_KEY', 'your_secret_key')
    SQLALCHEMY_DATABASE_URI = os.getenv('DATABASE_URL', 'sqlite:///leoblog.db')
    SQLALCHEMY_TRACK_MODIFICATIONS = False

配置文件详细介绍

• SECRET_KEY: 应用的密钥，用于加密和安全相关操作。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串，指定数据库类型和路径。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改，设置为 False 以减少内存消耗。

以上是 LeoBlog-back 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。