FastAPI SQLAlchemy MySQL 项目常见问题解决方案

FastAPI SQLAlchemy MySQL 项目常见问题解决方案

项目基础介绍

FastAPI SQLAlchemy MySQL 是一个基于 FastAPI、SQLAlchemy、Pydantic 和 MySQL 的开源项目。该项目旨在提供一个高效、易用的后端开发框架，支持异步设计、Restful API、数据库迁移等功能。主要使用的编程语言是 Python。

新手使用注意事项及解决方案

1. 环境配置问题

问题描述：新手在配置开发环境时，可能会遇到 Python 版本不匹配、依赖库安装失败等问题。

解决步骤：

1. 检查 Python 版本：确保本地安装的 Python 版本为 3.10+。可以通过命令 python --version 或 python3 --version 查看。
2. 安装依赖库：使用 pip install -r requirements.txt 命令安装项目所需的依赖库。如果安装失败，可以尝试使用虚拟环境（如 venv 或 conda）来隔离项目依赖。
3. 配置环境变量：在 backend 目录下创建 .env 文件，并根据 .env.example 文件的内容配置环境变量。

2. 数据库连接问题

问题描述：新手在连接 MySQL 数据库时，可能会遇到数据库连接失败、编码不匹配等问题。

解决步骤：

1. 检查 MySQL 配置：确保 MySQL 服务已启动，并且数据库的编码为 utf8mb4。可以通过命令 SHOW VARIABLES LIKE 'character_set_database'; 查看数据库编码。
2. 配置数据库连接：在 .env 文件中正确配置数据库连接信息，包括数据库地址、用户名、密码等。
3. 执行数据库迁移：使用 Alembic 进行数据库迁移，确保数据库结构与项目代码一致。命令如下：

   alembic revision --autogenerate
   alembic upgrade head
   

3. Docker 部署问题

问题描述：新手在使用 Docker 部署项目时，可能会遇到端口冲突、容器启动失败等问题。

解决步骤：

1. 检查端口占用：确保本地没有其他服务占用 8000、3306、6379 端口。可以通过命令 netstat -an | grep 8000 查看端口占用情况。
2. 配置 Docker 环境变量：在 deploy/docker-compose/ 目录下创建 .env 文件，并根据 .env.server 文件的内容配置环境变量。
3. 启动 Docker 容器：使用以下命令启动 Docker 容器：

   docker-compose up -d --build
   

   等待命令执行完成后，访问 http://127.0.0.1:8000/api/v1/docs 查看项目是否正常运行。

通过以上步骤，新手可以顺利解决在使用 FastAPI SQLAlchemy MySQL 项目时遇到的常见问题。