Skip to content

业务模块总览

模块目录

后端所有业务模块位于 backend-fastapi/core/ 目录下,每个模块遵循统一的 model → schema → service → api 四层结构。

核心模块

组织架构

模块路径路由前缀说明
usercore/user//user用户管理
rolecore/role//role角色管理
deptcore/dept//dept部门管理(树形)
postcore/post//post岗位管理
menucore/menu//menu菜单管理(树形)
permissioncore/permission//permission权限管理
resource_scopecore/resource_scope//resource-scope数据权限配置

系统管理

模块路径路由前缀说明
applicationcore/application//application子应用管理
dict / dict_itemcore/dict//dict数据字典
regioncore/region//region省市区(5级)
system_configcore/system_config//system-config系统参数配置
ui_configcore/ui_config//ui-configUI 偏好配置
login_logcore/login_log//login-log登录日志

业务引擎

模块路径路由前缀说明
form_managercore/form_manager//form表单引擎
form_data_managercore/form_data_manager//form-data表单数据
workflowcore/workflow//workflow工作流引擎
page_managercore/page_manager//page页面/仪表盘
ai_platformcore/ai_platform//aiAI 平台

文件与通信

模块路径路由前缀说明
file_managercore/file_manager//file_manager文件管理
messagecore/message//message站内消息/公告
chatcore/chat//chat即时聊天(WebSocket)
websocketcore/websocket//wsWebSocket 管理

数据管理

模块路径路由前缀说明
database_managercore/database_manager//database数据库管理
database_monitorcore/database_monitor//db-monitor数据库监控
data_sourcecore/data_source//data-source数据源配置
query_buildercore/query_builder//query-builder可视化查询构建
redis_managercore/redis_manager//redisRedis 管理
redis_monitorcore/redis_monitor//redis-monitorRedis 监控

监控运维

模块路径路由前缀说明
server_monitorcore/server_monitor//server-monitor服务器监控

工具模块

模块路径路由前缀说明
code_generatorcore/code_generator//code-gen代码生成器
document_generatorcore/document_generator//doc-gen文档生成器
contractcore/contract//contract合同管理
electronic_sealcore/electronic_seal//seal电子印章
screen_designcore/screen_design//screen大屏设计
devicecore/device//device设备管理

组织架构模块详解

用户管理 (User)

数据模型

字段类型说明
usernameString(50)用户名(唯一)
passwordString(128)密码(bcrypt 加密)
nameString(50)姓名
emailString(100)邮箱
mobileString(20)手机号
avatarString(200)头像
genderInteger性别(0=未知, 1=男, 2=女)
user_typeInteger类型(1=普通, 2=管理员)
user_statusInteger状态(0=禁用, 1=正常, 2=锁定)
is_superuserBoolean超级管理员
dept_idString部门 ID(逻辑外键)
post_idString岗位 ID(逻辑外键)
manager_idString上级 ID(逻辑外键)

关联关系:用户 ↔ 角色 通过中间表 core_user_role 关联(多对多)

UserService 特有方法

  • authenticate(db, username, password) — 用户认证
  • update_login_info(db, user_id) — 更新登录信息
  • get_user_role_ids(db, user_id) — 获取用户角色 ID 列表
  • reset_password(db, user_id) — 重置密码

角色管理 (Role)

数据模型

字段类型说明
nameString(50)角色名称
codeString(50)角色编码(唯一)
statusBoolean是否启用
descriptionText描述

关联关系:角色 ↔ 菜单 通过中间表 core_role_menu 关联(多对多)

部门管理 (Dept)

数据模型

字段类型说明
nameString(100)部门名称
parent_idString父部门 ID(树形)
leader_idString负责人
phoneString(20)联系电话
emailString(100)邮箱
statusBoolean是否启用

特有方法

  • get_tree(db) — 获取部门树
  • get_children_ids(db, dept_id) — 获取所有子部门 ID(递归)

子应用管理 (Application)

每个子应用拥有独立的菜单、表单、工作流、页面:

字段类型说明
nameString(100)应用名称
codeString(50)应用编码(唯一)
iconString(100)图标
descriptionText描述
statusBoolean是否启用
sortInteger排序

通信模块详解

站内消息 (Message)

支持系统通知、公告、个人消息:

字段类型说明
titleString标题
contentText内容
message_typeStringnotice / announcement / personal
sender_idString发送人
target_typeStringall / role / dept / user
target_idsJSONB目标 ID 列表
statusStringdraft / published

消息阅读状态通过 MessageReadStatus 跟踪每个用户的已读状态。

即时聊天 (Chat + WebSocket)

基于 WebSocket 的实时通信:

  • Chat 模块:消息存储、会话管理、历史记录
  • WebSocket 模块:连接管理、心跳检测、消息推送

支持功能:

  • 文本消息、文件消息
  • 已读回执
  • 在线状态
  • 消息推送通知

数据管理模块详解

数据库管理 (DatabaseManager)

浏览和管理数据库结构:

  • 查看数据库连接、Schema、表列表
  • 查看表结构(字段、类型、约束)
  • 创建/修改表结构
  • SQL 查询执行

数据源 (DataSource)

为仪表盘和报表提供数据源配置:

  • 连接配置(数据库连接信息)
  • SQL 查询定义
  • 参数化查询
  • 数据缓存策略

可视化查询构建器 (QueryBuilder)

无需编写 SQL,通过可视化方式构建查询:

  • 选择表和字段
  • 设置过滤条件
  • 聚合函数
  • 关联查询
  • 排序和分页

工具模块详解

代码生成器 (CodeGenerator)

根据数据库表结构自动生成代码:

  • Model(SQLAlchemy 模型)
  • Schema(Pydantic Schema)
  • Service(业务服务层)
  • API(FastAPI 路由)
  • 前端页面(Vue 组件)

文档生成器 (DocumentGenerator)

基于模板生成文档:

  • 支持 Word(.docx)模板
  • 变量替换
  • 表格填充
  • 图片插入
  • 字体配置

电子印章 (ElectronicSeal)

电子签章功能:

  • 印章图片管理
  • 签署位置配置
  • PDF 签章
  • 签署记录

路由注册

所有模块路由在 core/router.py 中统一注册:

python
from fastapi import APIRouter

router = APIRouter(prefix="/api/core")

# 组织架构
router.include_router(auth_router)
router.include_router(user_router)
router.include_router(role_router)
router.include_router(dept_router)
router.include_router(menu_router)

# 业务引擎
router.include_router(form_router)
router.include_router(form_data_router)
router.include_router(workflow_router)
router.include_router(page_router)
router.include_router(ai_router)

# 文件与通信
router.include_router(file_manager_router)
router.include_router(message_router)

# 数据管理
router.include_router(database_router)
router.include_router(data_source_router)

# ... 更多模块

Released under the MIT License.