210 lines
7.3 KiB
Python
210 lines
7.3 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
|
||
"""
|
||
数据库表结构解析与代码生成命令行工具
|
||
=============================================================
|
||
|
||
本项目代码生成器的命令行入口，内部复用 src/modules/generator 下的引擎：
|
||
- parser.generate_config_from_table : 从数据库表解析生成配置
|
||
- code_generator.CodeGenerator : 根据配置生成后端三层模块代码与前端 Vue 页面
|
||
|
||
支持 --dry-run / --config / --output 参数：
|
||
- 默认从数据库表解析生成配置
|
||
- --config 加载已有的配置文件（兼容 config.json 参考配置）
|
||
- --dry-run 仅生成配置不写代码，--output 导出配置为 JSON
|
||
|
||
命令行示例：
|
||
# 方式1：解析表结构并生成模块（核心用法）
|
||
python generator.py flask_example
|
||
|
||
# 方式2：仅生成配置，不执行代码生成（预览模式）
|
||
python generator.py flask_example --dry-run
|
||
|
||
# 方式2.1：预览并导出配置为 JSON 文件
|
||
python generator.py flask_example --dry-run --output config.json
|
||
|
||
# 方式3：使用已有配置文件生成（跳过表解析，兼容 config.json 参考配置）
|
||
python generator.py --config config.json
|
||
|
||
# 方式4：生成代码并保存配置（解析 -> 保存 -> 生成）
|
||
python generator.py flask_example --output config.json
|
||
"""
|
||
|
||
import argparse
|
||
import json
|
||
import os
|
||
import sys
|
||
|
||
# 将项目根目录加入 sys.path，保证从任意目录运行都能导入 src
|
||
ROOT = os.path.dirname(os.path.abspath(__file__))
|
||
if ROOT not in sys.path:
|
||
sys.path.insert(0, ROOT)
|
||
|
||
|
||
def _get_flask_app():
|
||
"""
|
||
初始化 Flask 应用实例
|
||
|
||
代码生成引擎通过 Flask-SQLAlchemy 的 db 访问数据库，因此 CLI 需要
|
||
先创建应用并进入应用上下文。复用 src/app.py 的 create_app()，
|
||
保证与 Web 服务使用同一套配置（.env、Redis、MySQL）。
|
||
|
||
Returns:
|
||
Flask: 应用实例
|
||
"""
|
||
from src.app import create_app
|
||
return create_app()
|
||
|
||
|
||
def _resolve_config(args):
|
||
"""
|
||
根据命令行参数解析生成配置
|
||
|
||
Args:
|
||
args: argparse 解析结果
|
||
|
||
Returns:
|
||
dict: 生成配置
|
||
|
||
Raises:
|
||
SystemExit: 缺少表名且未指定配置文件时退出
|
||
"""
|
||
if args.config:
|
||
# 方式3：从配置文件加载（兼容 config.json 参考配置）
|
||
print(f"从配置文件加载: {args.config}")
|
||
with open(args.config, 'r', encoding='utf-8') as f:
|
||
config = json.load(f)
|
||
print("配置文件加载成功")
|
||
return config
|
||
|
||
if args.table_name:
|
||
# 方式1/2/4：从数据库表解析
|
||
from src.modules.generator.parser import generate_config_from_table
|
||
print(f"正在解析表: {args.table_name}")
|
||
config = generate_config_from_table(args.table_name)
|
||
print("表结构解析成功")
|
||
return config
|
||
|
||
# 缺少必要参数：打印帮助并退出
|
||
args_parser.print_help()
|
||
sys.exit(1)
|
||
|
||
|
||
def _print_config_summary(config):
|
||
"""
|
||
打印配置摘要，便于人工核对解析结果
|
||
|
||
Args:
|
||
config: 生成配置字典
|
||
"""
|
||
fields = config.get('fields', [])
|
||
print("\n" + "-" * 60)
|
||
print("生成配置摘要:")
|
||
print("-" * 60)
|
||
print(f" 应用名称: {config.get('app_name')}")
|
||
print(f" 模块名称: {config.get('module_comment')}")
|
||
print(f" 模型类名: {config.get('model_class_name')}")
|
||
print(f" 字段数量: {len(fields)}")
|
||
print(f" 是否有排序: {config.get('has_sort')}")
|
||
print(f" 是否有状态: {config.get('has_status')}")
|
||
|
||
# 字段列表（仅展示前 5 个，避免刷屏）
|
||
for field in fields[:5]:
|
||
print(f" - {field['name']}: {field.get('comment', '')} "
|
||
f"({field.get('db_type', field.get('type', ''))})")
|
||
if field.get('choices'):
|
||
print(f" 选项: {field['choices']}")
|
||
if len(fields) > 5:
|
||
print(f" ... 还有 {len(fields) - 5} 个字段")
|
||
|
||
|
||
def _run_code_generator(config):
|
||
"""
|
||
执行代码生成（写入模块文件 + 自动注册路由与模型）
|
||
|
||
Args:
|
||
config: 生成配置字典
|
||
"""
|
||
from src.modules.generator.code_generator import CodeGenerator
|
||
|
||
generator = CodeGenerator(config)
|
||
generator.generate(auto=True)
|
||
return True
|
||
|
||
|
||
def main():
|
||
"""
|
||
CLI 主入口
|
||
|
||
执行流程：
|
||
1. 初始化 Flask 应用（提供数据库连接）
|
||
2. 解析生成配置（表解析 / 配置文件加载）
|
||
3. 按需导出配置（--output）
|
||
4. 非预览模式下执行代码生成
|
||
"""
|
||
global args_parser
|
||
args_parser = argparse.ArgumentParser(
|
||
description='数据库表结构解析和代码生成工具',
|
||
)
|
||
args_parser.add_argument('table_name', nargs='?', help='数据库表名（如 flask_example）')
|
||
args_parser.add_argument('--config', '-c', help='使用已有的配置文件（JSON格式，兼容 config.json 参考配置）')
|
||
args_parser.add_argument('--dry-run', '-d', action='store_true', help='仅生成配置，不执行代码生成')
|
||
args_parser.add_argument('--output', '-o', help='输出配置文件路径')
|
||
|
||
args = args_parser.parse_args()
|
||
|
||
print("=" * 60)
|
||
print("数据库表结构解析和代码生成工具")
|
||
print("=" * 60)
|
||
|
||
# 初始化 Flask 应用：提供数据库连接与应用上下文
|
||
app = _get_flask_app()
|
||
with app.app_context():
|
||
try:
|
||
# 步骤1：解析生成配置
|
||
config = _resolve_config(args)
|
||
|
||
# 步骤2：导出配置（--output，仅表解析路径生效）
|
||
if args.output:
|
||
with open(args.output, 'w', encoding='utf-8') as f:
|
||
json.dump(config, f, ensure_ascii=False, indent=2)
|
||
print(f"配置已保存到: {args.output}")
|
||
|
||
# 步骤3：打印配置摘要
|
||
_print_config_summary(config)
|
||
|
||
# 步骤4：执行代码生成（预览模式跳过）
|
||
if args.dry_run:
|
||
print("\n" + "=" * 60)
|
||
print("预览模式 - 不执行代码生成（去掉 --dry-run 参数即可生成）")
|
||
print("=" * 60)
|
||
else:
|
||
print("\n" + "=" * 60)
|
||
print("开始执行代码生成")
|
||
print("=" * 60)
|
||
_run_code_generator(config)
|
||
print("代码生成完成！")
|
||
|
||
print("\n操作完成！")
|
||
|
||
except Exception as e: # noqa: BLE001 - CLI 顶层兜底，输出可读错误
|
||
print(f"\n操作失败: {str(e)}")
|
||
import traceback
|
||
traceback.print_exc()
|
||
sys.exit(1)
|
||
|
||
|
||
if __name__ == '__main__':
|
||
main()
|