Add code generator app

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-added-large-files
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-toml
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.4.2
+    rev: v0.5.1
     hooks:
       - id: ruff
         args:
@@ -20,7 +20,7 @@ repos:
       - id: ruff-format
 
   - repo: https://github.com/pdm-project/pdm
-    rev: 2.12.4
+    rev: 2.16.1
     hooks:
       - id: pdm-export
         args:

README.md

@@ -70,17 +70,18 @@ Luckily, we now have a demo site: [FBA UI](https://fba.xwboy.top/)
 
 ## Built-in features
 
-1. [x] User management: system user role management, permission assignment
-2. [x] Department Management: Configure the system organization (company, department, group...)
-3. [x] Menu Management: Configuration of system menus, user menus, button privilege identification
-4. [x] Role Management: Assign role menu privileges, assign role routing privileges
-5. [x] Dictionary Management: Maintain common fixed data or parameters within the system.
-6. [x] Operation Logs: logging and querying of normal and abnormal system operations.
-7. [x] Login Authentication: graphical authentication code background authentication login
-8. [x] Login Logs: Logging and querying of normal and abnormal user logins
-9. [x] Service Monitoring: server hardware device information and status
-10. [x] Scheduled tasks: automated tasks, asynchronous tasks, and function invocation are supported
-11. [x] Interface Documentation: Automatically generate online interactive API interface documentation.
+1. [x] User management: management of system user roles, assignment of permissions
+2. [x] Departmental management: Configuration of the system organization (company, department, group, ...)
+3. [x] Menu management: Configuration of system menus, user menus, button permission labels
+4. [x] Role management: assignment of role menu privileges, assignment of role routing privileges
+5. [x] Dictionary management: maintenance of commonly used fixed data or parameters within the system
+6. [x] Code generation: back-end code is automatically generated, supporting preview, write and download.
+7. [x] Operation log: logging and querying of normal and abnormal system operations.
+8. [x] Login authentication: graphical captcha backend authentication login
+9. [x] Logging: logging and querying of normal and abnormal user logins
+10. [x] Service monitoring: server hardware device information and status
+11. [x] Timed tasks: automated tasks, asynchronous tasks, support for function calls
+12. [x] Interface Documentation: Automatically generate online interactive API interface documentation.
 
 ## Local development
 

README.zh-CN.md

@@ -68,12 +68,13 @@ mvc 架构作为常规设计模式，在 python web 中也很常见，但是三
 3. [x] 菜单管理：配置系统菜单，用户菜单，按钮权限标识
 4. [x] 角色管理：角色菜单权限分配，角色路由权限分配
 5. [x] 字典管理：维护系统内部常用固定数据或参数
-6. [x] 操作日志：系统正常操作和异常操作日志记录和查询
-7. [x] 登录认证：图形验证码后台认证登录
-8. [x] 登录日志：用户正常登录和异常登录的日志记录与查询
-9. [x] 服务监控：服务器硬件设备信息与状态
-10. [x] 定时任务：自动化任务，异步任务，支持函数调用
-11. [x] 接口文档：自动生成在线交互式 API 接口文档
+6. [x] 代码生成：后端代码自动生成，支持预览，写入及下载
+7. [x] 操作日志：系统正常和异常操作的日志记录与查询
+8. [x] 登录认证：图形验证码后台认证登录
+9. [x] 登录日志：用户正常和异常登录的日志记录与查询
+10. [x] 服务监控：服务器硬件设备信息与状态
+11. [x] 定时任务：自动化任务，异步任务，支持函数调用
+12. [x] 接口文档：自动生成在线交互式 API 接口文档
 
 ## 本地开发
 

backend/.ruff.toml

@@ -26,7 +26,6 @@ select = [
     "UP007"
 ]
 preview = true
-ignore-init-module-imports = true
 ignore = ["FURB101"]
 
 [lint.flake8-pytest-style]

backend/alembic/env.py

@@ -30,9 +30,11 @@
 # for 'autogenerate' support
 # https://alembic.sqlalchemy.org/en/latest/autogenerate.html#autogenerating-multiple-metadata-collections
 from backend.app.admin.model import MappedBase as AdminBase
+from backend.app.generator.model import MappedBase as GeneratorBase
 
 target_metadata = [
     AdminBase.metadata,
+    GeneratorBase.metadata,
 ]
 
 # other values from the config, defined by the needs of env.py,

backend/app/admin/api/v1/auth/__init__.py

@@ -7,6 +7,5 @@
 
 router = APIRouter(prefix='/auth')
 
-
 router.include_router(auth_router, tags=['授权'])
 router.include_router(captcha_router, prefix='/captcha', tags=['验证码'])

backend/app/admin/model/sys_dict_data.py

@@ -19,5 +19,5 @@ class DictData(Base):
     status: Mapped[int] = mapped_column(default=1, comment='状态（0停用 1正常）')
     remark: Mapped[str | None] = mapped_column(LONGTEXT, default=None, comment='备注')
     # 字典类型一对多
-    type_id: Mapped[int] = mapped_column(ForeignKey('sys_dict_type.id'), default=None, comment='字典类型关联ID')
+    type_id: Mapped[int] = mapped_column(ForeignKey('sys_dict_type.id'), default=0, comment='字典类型关联ID')
     type: Mapped['DictType'] = relationship(init=False, back_populates='datas')  # noqa: F821

backend/app/generator/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/app/generator/api/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/app/generator/api/router.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from fastapi import APIRouter
+
+from backend.app.generator.api.v1.gen import router as gen_router
+
+v1 = APIRouter()
+
+v1.include_router(gen_router, prefix='/gen', tags=['代码生成'])

backend/app/generator/api/v1/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/app/generator/api/v1/gen.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from typing import Annotated
+
+from fastapi import APIRouter, Path, Query
+from fastapi.responses import StreamingResponse
+
+from backend.app.generator.conf import generator_settings
+from backend.app.generator.schema.gen_business import CreateGenBusinessParam, UpdateGenBusinessParam
+from backend.app.generator.schema.gen_model import CreateGenModelParam, UpdateGenModelParam
+from backend.app.generator.service.gen_business_service import gen_business_service
+from backend.app.generator.service.gen_model_service import gen_model_service
+from backend.app.generator.service.gen_service import gen_service
+from backend.common.response.response_schema import ResponseModel, response_base
+from backend.common.security.jwt import DependsJwtAuth
+from backend.common.security.rbac import DependsRBAC
+from backend.utils.serializers import select_list_serialize
+
+router = APIRouter()
+
+
+@router.get('/all', summary='获取所有代码生成业务', dependencies=[DependsJwtAuth])
+async def get_all_businesses() -> ResponseModel:
+    businesses = await gen_business_service.get_all()
+    data = await select_list_serialize(businesses)
+    return await response_base.success(data=data)
+
+
+@router.get('/businesses/{pk}', summary='获取代码生成业务详情', dependencies=[DependsJwtAuth])
+async def get_business(pk: Annotated[int, Path(...)]) -> ResponseModel:
+    data = await gen_service.get_business_and_model(pk=pk)
+    return await response_base.success(data=data)
+
+
+@router.post('/businesses', summary='创建代码生成业务', deprecated=True, dependencies=[DependsRBAC])
+async def create_business(obj: CreateGenBusinessParam) -> ResponseModel:
+    await gen_business_service.create(obj=obj)
+    return await response_base.success()
+
+
+@router.put('/businesses/{pk}', summary='更新代码生成业务', dependencies=[DependsRBAC])
+async def update_business(pk: Annotated[int, Path(...)], obj: UpdateGenBusinessParam) -> ResponseModel:
+    count = await gen_business_service.update(pk=pk, obj=obj)
+    if count > 0:
+        return await response_base.success()
+    return await response_base.fail()
+
+
+@router.delete('/businesses', summary='删除代码生成业务', dependencies=[DependsRBAC])
+async def delete_business(pk: Annotated[int, Query(...)]) -> ResponseModel:
+    count = await gen_business_service.delete(pk=pk)
+    if count > 0:
+        return await response_base.success()
+    return await response_base.fail()
+
+
+@router.post('/models', summary='创建代码生成模型', dependencies=[DependsRBAC])
+async def create_model(obj: CreateGenModelParam) -> ResponseModel:
+    await gen_model_service.create(obj=obj)
+    return await response_base.success()
+
+
+@router.put('/models/{pk}', summary='更新代码生成模型', dependencies=[DependsRBAC])
+async def update_model(pk: Annotated[int, Path(...)], obj: UpdateGenModelParam) -> ResponseModel:
+    count = await gen_model_service.update(pk=pk, obj=obj)
+    if count > 0:
+        return await response_base.success()
+    return await response_base.fail()
+
+
+@router.delete('/models/{pk}', summary='删除代码生成模型', dependencies=[DependsRBAC])
+async def delete_model(pk: Annotated[int, Path(...)]) -> ResponseModel:
+    count = await gen_model_service.delete(pk=pk)
+    if count > 0:
+        return await response_base.success()
+    return await response_base.fail()
+
+
+@router.get('/tables', summary='获取数据库表', dependencies=[DependsRBAC])
+async def get_all_tables(table_schema: Annotated[str, Query(..., description='数据库名')] = 'fba') -> ResponseModel:
+    data = await gen_service.get_tables(table_schema=table_schema)
+    return await response_base.success(data=data)
+
+
+@router.post('/import', summary='导入代码生成业务和模型列', dependencies=[DependsRBAC])
+async def import_table(
+    app: Annotated[str, Query(..., description='应用名称，用于代码生成到指定 app')],
+    table_name: Annotated[str, Query(..., description='数据库表名')],
+    table_schema: Annotated[str, Query(..., description='数据库名')] = 'fba',
+) -> ResponseModel:
+    await gen_service.import_business_and_model(app=app, table_schema=table_schema, table_name=table_name)
+    return await response_base.success()
+
+
+@router.get('/preview/{pk}', summary='生成代码预览', dependencies=[DependsJwtAuth])
+async def preview_code(pk: Annotated[int, Path(..., description='业务ID')]) -> ResponseModel:
+    data = await gen_service.preview(pk=pk)
+    return await response_base.success(data=data)
+
+
+@router.post('/generate/{pk}', summary='生成代码', description='文件磁盘写入，请谨慎操作', dependencies=[DependsRBAC])
+async def generate_code(pk: Annotated[int, Path(..., description='业务ID')]) -> ResponseModel:
+    await gen_service.generate(pk=pk)
+    return await response_base.success()
+
+
+@router.post('/download/{pk}', summary='下载代码', dependencies=[DependsRBAC])
+async def download_code(pk: Annotated[int, Path(..., description='业务ID')]):
+    bio = await gen_service.download(pk=pk)
+    return StreamingResponse(
+        bio,
+        media_type='application/x-zip-compressed',
+        headers={'Content-Disposition': f'attachment; filename={generator_settings.ZIP_FILENAME}.zip'},
+    )

backend/app/generator/conf.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from functools import lru_cache
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from backend.core.path_conf import BasePath
+
+
+class GeneratorSettings(BaseSettings):
+    """Admin Settings"""
+
+    model_config = SettingsConfigDict(env_file=f'{BasePath}/.env', env_file_encoding='utf-8', extra='ignore')
+
+    # 代码下载
+    ZIP_FILENAME: str = 'fba_generator'
+
+
+@lru_cache
+def get_generator_settings() -> GeneratorSettings:
+    """获取 generator 配置"""
+    return GeneratorSettings()
+
+
+generator_settings = get_generator_settings()

backend/app/generator/crud/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/app/generator/crud/crud_gen.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from typing import Sequence
+
+from sqlalchemy import Row, text
+from sqlalchemy.ext.asyncio import AsyncSession
+
+
+class CRUDGen:
+    @staticmethod
+    async def get_all_tables(db: AsyncSession, table_schema: str) -> Sequence[str]:
+        t = text(
+            'select table_name as table_name '
+            'from information_schema.tables '
+            'where table_name not like "sys_gen_%" '
+            'and table_schema = :table_schema;'
+        ).bindparams(table_schema=table_schema)
+        stmt = await db.execute(t)
+        return stmt.scalars().all()
+
+    @staticmethod
+    async def get_table(db: AsyncSession, table_name: str) -> Row[tuple]:
+        t = text(
+            'select table_name as table_name, table_comment as table_comment '
+            'from information_schema.tables '
+            'where table_name not like "sys_gen_%" '
+            'and table_name = :table_name;'
+        ).bindparams(table_name=table_name)
+        stmt = await db.execute(t)
+        return stmt.fetchone()
+
+    @staticmethod
+    async def get_all_columns(db: AsyncSession, table_schema: str, table_name: str) -> Sequence[Row[tuple]]:
+        t = text(
+            'select column_name AS column_name, '
+            'case when column_key = "PRI" then 1 else 0 end as is_pk, '
+            'case when is_nullable = "NO" or column_key = "PRI" then 0 else 1 end as is_nullable, '
+            'ordinal_position as sort, '
+            'column_comment as column_comment, '
+            'column_type as column_type '
+            'from information_schema.columns '
+            'where table_schema = :table_schema '
+            'and table_name = :table_name '
+            'and column_name != "id" '
+            'and column_name != "created_time" '
+            'and column_name != "updated_time" '
+            'order by sort;'
+        ).bindparams(table_schema=table_schema, table_name=table_name)
+        stmt = await db.execute(t)
+        return stmt.fetchall()
+
+
+gen_dao = CRUDGen()