Python-Flask-MySQL 模型类自动生成工具：从基础到进阶的实现与优化

最新推荐文章于 2025-10-20 17:02:57 发布

原创最新推荐文章于 2025-10-20 17:02:57 发布 · 1k 阅读

17 ·

CC 4.0 BY-SA版权

文章标签：

#python #flask #mysql

Python 专栏收录该内容

101 篇文章

订阅专栏

Python-Flask-MySQL 模型类自动生成工具：从基础到进阶的实现与优化

在 Flask 开发中，使用 SQLAlchemy 与 MySQL 数据库交互时，手动编写模型类往往繁琐且容易出错，尤其是面对复杂数据库结构时。本文将介绍一款 Python-Flask-MySQL 模型类自动生成工具的完整实现过程，从基础功能到高级优化，帮助开发者快速构建符合规范的数据库模型层。

工具概述

这款模型类自动生成工具能够直接连接 MySQL 数据库，自动分析表结构并生成对应的 Python-Flask-SQLAlchemy 模型类代码。工具支持表名前缀过滤、字段注释自动生成、时间字段默认值设置等实用功能，大幅减少手动编码工作量，提高开发效率。

功能演进历程

工具的开发经历了以下几个关键阶段的优化：

基础版本：实现数据库连接与表结构读取，生成基础模型类
进阶版本：添加表名前缀过滤功能，优化模型类命名
增强版本：完善字段注释生成，为时间字段自动添加默认值

完整实现代码

以下是最终优化后的完整代码,点击下载，集成了所有功能：
https://download.youkuaiyun.com/download/dengjianbin/91899374

核心功能解析

1. 数据库连接与表结构读取

工具通过 pymysql 库连接 MySQL 数据库，主要实现了两个核心方法：

get_db_connection()：根据用户输入的配置信息创建数据库连接
get_table_structure()：查询指定表的详细结构，包括字段信息、表注释和外键关系

通过查询 INFORMATION_SCHEMA.COLUMNS 系统表，工具能够获取完整的字段元数据，包括字段名、类型、约束、默认值和注释等关键信息。

2. 表名前缀过滤

在实际开发中，数据库表名常带有统一前缀（如 tb_user、t_post）。工具通过以下方法实现前缀过滤：

parse_db_config()：收集用户输入的前缀列表（如 tb_,t_）
remove_table_prefix()：自动识别并移除表名中的前缀

处理后的表名将用于生成模型类名和文件名，使代码更加简洁规范（如 tb_user → 类名 User，文件名 user.py）。

3. 类型转换机制

工具定义了完整的 MySQL 类型到 SQLAlchemy 类型的映射关系（type_mapping），通过 convert_type() 方法实现自动转换：

# 示例转换规则
'int' → 'db.Integer'
'varchar' → 'db.String'
'datetime' → 'db.DateTime'
'enum' → 'db.Enum'

同时，get_type_params() 方法处理类型参数（如 varchar(50) → db.String(50)），确保类型定义的准确性。

4. 字段注释与时间默认值

工具重点优化了字段注释和时间字段处理：

所有字段自动添加来自数据库的注释，提高代码可读性
时间类型字段（datetime、timestamp 等）自动添加 default=datetime.utcnow 默认值
智能识别时间字段，自动导入 datetime 模块

生成的字段示例：

create_time = db.Column(db.DateTime, nullable=False, default=datetime.utcnow, comment='创建时间')  # 创建时间
username = db.Column(db.String(50), unique=True, nullable=False, comment='用户名')  # 用户名

5. 外键关系处理

工具能够识别表之间的外键关系，并生成相应的 SQLAlchemy 关系定义：

自动处理关联表名的前缀
生成合理的关系名称和反向引用
保持模型间的关联完整性

关系定义示例：

# 外键关系
user = db.relationship('User', backref='posts', lazy='dynamic')

使用方法

1. 安装依赖

pip install pymysql flask-sqlalchemy

2. 运行工具

python auto_model_generator.py

3. 交互配置

工具会引导用户完成以下配置：

数据库连接信息（主机、端口、用户名、密码、数据库名）
表名前缀过滤（多个前缀用逗号分隔，如 tb_,t_）

4. 生成结果

工具会在当前目录创建 models 目录，并为每个表生成对应的模型类文件，同时自动更新 __init__.py 实现批量导入。

生成示例

假设数据库中有表 tb_user，结构如下：

字段名	类型	约束	注释
id	int	PRIMARY KEY, AUTO_INCREMENT	用户ID
username	varchar(50)	NOT NULL, UNIQUE	用户名
email	varchar(100)	NOT NULL, UNIQUE	邮箱
create_time	datetime	NOT NULL	创建时间

工具生成的 user.py 如下：

from app import db
from datetime import datetime


class User(db.Model):
    __tablename__ = 'tb_user'  # 原始表名（含前缀）
    # 表注释: 用户信息表
    __table_args__ = {
        'mysql_charset': 'utf8mb4',
        'mysql_collate': 'utf8mb4_general_ci'
    }

    id = db.Column(db.Integer, primary_key=True, autoincrement=True, comment='用户ID')  # 用户ID
    username = db.Column(db.String(50), unique=True, nullable=False, comment='用户名')  # 用户名
    email = db.Column(db.String(100), unique=True, nullable=False, comment='邮箱')  # 邮箱
    create_time = db.Column(db.DateTime, nullable=False, default=datetime.utcnow, comment='创建时间')  # 创建时间


    def __repr__(self):
        return f'<User {{self.id}}>'