Gemini Balance 项目使用教程

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

Gemini Balance 项目的目录结构如下：

gemini-balance/
├── app/
│   ├── config/       # 配置管理
│   ├── core/         # 核心应用逻辑 (FastAPI 实例创建, 中间件等)
│   ├── database/     # 数据库模型和连接
│   ├── domain/       # 业务领域对象 (可选)
│   ├── exception/    # 自定义异常
│   ├── handler/      # 请求处理器 (可选, 或在 router 中处理)
│   ├── log/          # 日志配置
│   ├── main.py       # 应用入口
│   ├── middleware/   # FastAPI 中间件
│   ├── router/       # API 路由 (Gemini, OpenAI, 状态页等)
│   ├── scheduler/    # 定时任务 (如 Key 状态检查)
│   ├── service/      # 业务逻辑服务 (聊天, Key 管理, 统计等)
│   ├── static/       # 静态文件 (CSS, JS)
│   ├── templates/    # HTML 模板 (如 Key 状态页)
│   ├── utils/        # 工具函数
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── requirements.txt

• app/：应用程序的主要目录，包含了项目的所有逻辑和代码。
• config/：配置文件和类，用于管理项目中的各种配置。
• core/：FastAPI 实例的创建和配置，中间件等核心组件。
• database/：数据库模型和数据库连接相关的代码。
• domain/：业务领域模型，可选部分。
• exception/：自定义异常处理。
• handler/：请求处理器，可选部分。
• log/：日志配置。
• main.py：应用的入口文件，用于启动 FastAPI 服务。
• middleware/：FastAPI 中间件。
• router/：定义了 API 路由和相关的处理函数。
• scheduler/：定时任务，如 Key 状态检查。
• service/：业务逻辑服务，如聊天、Key 管理、统计等。
• static/：静态文件，如 CSS 和 JavaScript。
• templates/：HTML 模板文件。
• utils/：工具函数。

其他文件：

• .gitignore：指定 Git 忽略的文件和目录。
• Dockerfile：用于构建 Docker 镜像的文件。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• docker-compose.yml：用于定义和运行多容器 Docker 应用程序的配置文件。
• requirements.txt：项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py，以下是该文件的主要内容：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# 这里会包含其他路由和中间件的设置

在 main.py 文件中，首先从 fastapi 模块导入了 FastAPI 类。然后创建了一个 FastAPI 实例。之后定义了一个简单的路由 /，用于返回一个问候信息。在实际的项目中，这里会包含更多的路由定义和中间件配置。

启动项目时，通常会使用以下命令：

uvicorn app.main:app --host 0.0.0.0 --port 8000

这会启动 FastAPI 应用，并在 0.0.0.0 地址的 8000 端口上监听。

3. 项目的配置文件介绍

项目的配置文件位于 app/config/ 目录下，通常会有一个名为 settings.py 的文件，用于存储项目运行所需的配置信息。以下是配置文件的一个示例结构：

class Settings:
    :
    MYSQL_HOST: str
    MYSQL_PORT: int
    MYSQL_USER: str
    MYSQL_PASSWORD: str
    MYSQL_DATABASE: str
    # 其他配置项...

    def __init__(self):
        # 从环境变量或配置文件中加载配置
        self.MYSQL_HOST =.getenv("MYSQL_HOST", "localhost")
        self.MYSQL_PORT =.getenv("MYSQL_PORT", 3306)
        # 其他配置项的加载...

在 Settings 类中，定义了一系列的配置项，这些配置项通常会在类初始化时从环境变量或配置文件中加载。这样做的好处是可以根据不同的环境（开发、测试、生产等）来调整配置，而不需要修改代码。

在项目的 main.py 或其他需要使用配置的地方，可以通过创建 Settings 类的实例来获取配置信息：

from app.config.settings import Settings

settings = Settings()

这样就可以在代码中使用 settings.MYSQL_HOST 等变量来访问配置信息了。