commit b5b4721456cb9f877e65fbb3bac9763f3908fd3e Author: 焦龙言 Date: Fri Jul 24 09:43:10 2026 +0800 初始提交 diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..ab1f416 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,10 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Ignored default folder with query files +/queries/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/ShiErFeng.iml b/.idea/ShiErFeng.iml new file mode 100644 index 0000000..003a080 --- /dev/null +++ b/.idea/ShiErFeng.iml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..8744b55 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,25 @@ + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..cfcba93 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..cb84345 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5f29546 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,547 @@ +# 更新日志 + +## ShiErFeng v1.9.0 + +### 项目依赖 + +前后端依赖均有升级,请升级依赖或重新创建环境。 + +### 新增功能 + +1.新增AI管理模块 (#69)。 +2.新增移动端模块 (#73)。 +3.新增多worker运行支持 (#76)。 +4.应用新增演示模式 (#78)。 + +### BUG修复 + +1.修复代码生成controller模板删除接口query_db参数异常的问题 (#63)。 +2.修复登录接口response_model声明错误 (#71)。 +3.修复无法直接通过后端地址访问API文档的问题 (#74)。 +4.修复create_app重复执行的问题 (#84)。 + +### 代码重构 + +1.移除对python3.9的支持 (#67)。 + +### 代码优化 + +1.优化alembic处理表模型逻辑,避免无关表影响 (#68)。 +2.优化代码生成后端模板 (#72)。 +3.自动注册路由出错时抛出异常以便于调试 (#79)。 +4.优化部分页面字段tooltip说明 (#80)。 +5.优化项目启动速度 (#82)。 +6.优化暗黑模式切换效果 (#83)。 +7.优化热重载模式或单worker下scheduler的任务状态同步机制 (#85)。 +8.优化防重提交间隔时间可自定义 (#87)。 +9.优化验证码计算结果为非负数 (#88)。 +10.优化ci测试稳定性 (#90)。 + +## ShiErFeng v1.8.1 + +### 新增功能 + +1.新增E2E测试 (#57)。 + +### BUG修复 + +1.修复DictTag组件渲染异常的问题 (#59)。 + +### 代码优化 + +1.优化数据权限依赖 (#55)。 +2.动态导入定时任务函数,移除eval (#56)。 +3.优化pg版本的docker compose配置文件 (#61)。 + +## ShiErFeng v1.8.0 + +### 项目依赖 + +#### 后端 + +1.后端依赖升级到最新版本,请升级依赖或重新创建环境。 + +### 新增功能 + +1.新增请求上下文管理类。 +2.新增`PreAuthDependency`、`CurrentUserDependency`、`DataScopeDependency`、`DBSessionDependency`、`UserInterfaceAuthDependency`和`RoleInterfaceAuthDependency`依赖函数。 +3.新增上下文清理中间件。 +4.新增公共vo模块。 +5.新增配置文档静态资源方法。 +6.新增自动注册路由功能。 +7.新增docker compose部署方式。 +8.菜单导航设置支持纯顶部。 + +### BUG修复 + +1.修复单账号登录模式下强退功能失效的问题 #52。 +2.确保ApschedulerJobs字段类型与apscheduler默认创建的表字段类型一致 #53。 +3.修复磁盘存在异常时服务监控无法正常运行的问题。 +4.移除代码生成表业务表外键,修复无法删除的问题。 +5.修复固定头部时出现的导航栏偏移问题。 +6.修复表单构建移除所有控件后切换路由回来空白问题。 +7.修复代码生成v3模板时间控件between选择后清空报错问题。 + +### 代码重构 + +1.增强ruff规则,完善类型提示。 +2.优化项目结构,新增common模块,原annotation、aspect、constant、enums模块移动至common模块下。 +3.重构app与server设计。 + +### 代码优化 + +1.controller层全部使用新依赖项。 +2.当前用户信息使用上下文变量。 +3.分页模型改为使用公共vo模块的PageModel。 +4.优化API文档的响应模型显示。 +5.操作响应模型改为使用公共vo模块的CrudResponseModel。 +6.优化API文档的接口描述信息。 +7.登录/注册页面底部版权信息修改为读取配置。 +8.优化生成代码下载的zip文件名。 +9.优化表单构建关闭页签销毁复制插件。 +10.行内表单默认设置固定宽度。 +11.优化操作日志详细请求参数显示。 +12.优化index页面标题读取配置。 +13.优化字典组件数字类型值处理逻辑。 +14.优化字典组件值宽松匹配。 +15.默认固定头部。 + +## ShiErFeng v1.7.1 + +### 项目依赖 + +1.后端依赖移除passlib,直接使用bcrypt。 + +### BUG修复 + +1.修复代码生成controller模板编辑接口异常生成字段的问题。 +2.移除passlib直接使用bcrypt修复密码校验异常的问题 #48 #49。 + +### 代码优化 + +1.代码生成do模板补充表描述。 + +## ShiErFeng v1.7.0 + +### 项目依赖 + +1.前后端依赖升级,请升级依赖或重新创建环境。 + +### 新增功能 + +1.新增alembic支持。 +2.文件&图片上传组件支持自定义地址&参数。 +3.新增默认打包配置项。 +4.显隐列组件支持全选/全不选。 +5.添加页签openPage支持传递参数。 +6.外链加载时遮罩信息提示。 +7.上传组件新增拖动排序属性。 +8.图片上传组件新增disabled属性。 +9.代码生成列支持拖动排序。 +10.新增用户默认初始化密码。 +11.新增页签图标显示开关功能。 +12.新增底部版权信息及开关。 +13.用户归属部门新增清除。 +14.用户导入新增验证提示。 +15.菜单搜索支持键盘选择&悬浮主题背景。 +16.新增apscheduler_jobs表对应sqlalchemy模型类。 +17.初始密码支持自定义修改策略。 +18.账号密码支持自定义更新周期。 +19.注册账号设置默认密码最后更新时间。 +20.显示列信息支持对象格式。 + +### BUG修复 + +1.修复logout接口未按照app_same_time_login配置项动态判断的问题 #IBZZ1S。 +2.修复上传组件被多次引用拖动仅对第一个有效的问题。 + +### 代码优化 + +1.优化接口耗时计算。 +2.优化启动信息显示。 +3.优化前端处理路由函数代码。 +4.登录页和注册页表头使用VITE_APP_BASE_API配置值。 +5.优化角色禁用不允许分配。 +6.优化富文本控制台警告异常。 +7.优化checkbox废弃API。 +8.优化导航栏显示昵称&设置。 + +### 代码重构 + +1.重构IP归属区域查询为异步调用。 +2.调整do与sql使其相互适配以支持alembic。 +3.富文本复制粘贴图片上传至url。 + +## ShiErFeng v1.6.2 + +### 新增功能 + +1.文件上传组件新增disabled属性。 +2.文件上传组件新增类型。 + +### BUG修复 + +1.修复日志管理时间查询报错 #27。 +2.修复定时任务状态暂停时执行单次任务会触发cron表达式的问题 #31。 +3.修复修改字典类型时获取dict_code异常的问题。 +4.修复修改字典类型时字典数据更新时间异常的问题。 +5.修复代码生成模板时间查询问题 #28。 +6.修复用户导出缺失部门名称的问题。 + +### 代码优化 + +1.优化代码生成新增和编辑字段显示和渲染。 +2.pagination更换成flex布局。 +3.优化代码生成vue模板 #23。 + +## ShiErFeng v1.6.1 + +### 项目依赖 + +#### 后端 + +1.新增sqlglot依赖 + +```bash +pip install sqlglot[rs]==26.6.0 -i https://pypi.tuna.tsinghua.edu.cn/simple +``` + +### BUG修复 + +1.引入sqlglot修复sql语句解析异常的问题。 +2.修复代码生成字段唯一性校验dao层模板判断异常的问题。 +3.引入泛型修复as_query和as_form装饰模型文档丢失的问题。 +4.修复代码生成主子表vo模板可能缺失NotBlank的问题。 + +## ShiErFeng v1.6.0 + +### 项目依赖 + +1.后端依赖升级到最新版本,请升级依赖或重新创建环境。 + +### 新增功能 + +1.新增代码生成功能,支持配置数据库表信息一键生成和下载前后端代码,需要重新执行sql文件,请先备份数据。 +2.新增表单构建功能。 +3.用户头像新增支持http(s)链接。 +4.新增trace中间件强化日志链路追踪和响应头 [@y1ren](https://gitee.com/y1ren)。 +5.用户管理支持分栏拖动。 +6.菜单面包屑导航支持多层级显示。 +7.白名单支持对通配符路径匹配。 +8.支持开启暗黑模式。 + +### BUG修复 + +1.修复默认关闭Tags-Views时,内链页面打不开。 +2.修复删除当前登录用户拦截失效的问题。 +3.修复定时任务目标字符串规则校验不全的问题。 +4.修复执行单次任务时会覆盖已启用任务的问题 #IBEKD2。 +5.修复个人中心特殊字符密码修改失败问题。 + +### 代码优化 + +1.优化导出方法。 +2.参数键值更换为多行文本。 +3.优化日志中操作方法显示。 +4.优化日志装饰器获取核心参数的方式。 +5.用户管理过滤掉已禁用部门。 +6.优化TopNav内链菜单点击没有高亮。 +7.ResponseUtil补充完整参数。 + +## ShiErFeng v1.5.1 + +### 新增功能 + +1.定时任务新增支持调用异步函数。 + +### 代码优化 + +1.优化字典数组条件判断。 +2.校检文件名是否包含特殊字符。 +3.移除已弃用的log_decorator装饰器。 + +## ShiErFeng v1.5.0 + +### 新增功能 + +1.新增对PostgreSQL数据库的支持。 + +### BUG修复 + +1.修复DictTag组件控制台抛异常的问题 #IAYSVZ。 +2.修复登录日志导出文件名称错误的问题。 + +### 代码回滚 + +1.因fastapi查询参数模型底层存在bug,回滚查询参数模型声明方式为as_query。 + +### 代码优化 + +1.优化CamelCaseUtil和SnakeCaseUtil以兼容更多转换场景。 +2.优化列表查询排序。 +3.优化参数设置页面。 +4.优化上传图片带域名时不增加前缀。 + +## ShiErFeng v1.4.0 + +### 项目依赖 + +#### 后端 + +1.更新fastapi版本为0.115.0 + +```bash +pip install fastapi[all]==0.115.0 -i https://pypi.tuna.tsinghua.edu.cn/simple +``` + +### 代码重构 + +1.基于fastapi 0.115.0版本新特性,直接使用pydantic模型接收查询参数和表单数据,移除原有as_query和as_form使用方式。 + +### BUG修复 + +1.修复角色管理service书写错误。 + +### 代码优化 + +1.优化前端登录请求方法。 + +## ShiErFeng v1.3.3 + +### 项目依赖 + +#### 后端 + +1.更新pydantic-validation-decorator版本为0.1.4,修复了一些底层bug。 + +### BUG修复 + +1.修复在线用户模块条件查询无效的问题。 + +### 代码优化 + +1.优化在线用户模块前后端字段描述一致。 +2.日志装饰器异常处理增加logger打印日志。 + +## ShiErFeng v1.3.2 + +### 新增功能 + +1.新增gzip压缩中间件。 + +### BUG修复 + +1.修复分页函数计算has_next错误的问题 #10。 +2.修复定时任务监听函数中事件没有job_id报错的问题。 + +### 代码优化 + +1.优化添加中间件函数注释。 + +## ShiErFeng v1.3.1 + +### BUG修复 + +1.修复1.3.0版本采用新的异常处理机制后日志装饰器无法记录异常日志的问题。 + +### 代码优化 + +1.补充定时任务违规字符串。 + +## ShiErFeng v1.3.0 + +### 项目依赖 + +1.前后端依赖均升级到最新版本,请升级依赖或重新创建环境。 +2.使用`PyJWT`替换`python-jose`以解决一些安全性问题。 + +### 新增功能 + +1.新增字段校验装饰器,支持手动触发校验,已封装为`pydantic-validation-decorator`库。 +2.各模块`service`层新增字段唯一性校验。 +3.全局新增`ServiceException`自定义服务异常和`ServiceWarning`自定义服务警告,无需在接口中写大量的异常捕获。 +4.菜单管理新增路由名称,请执行以下sql为数据库新增字段: + +```sql +ALTER TABLE sys_menu ADD COLUMN route_name varchar(50) DEFAULT ''; +``` + +5.新增`constant`常量配置及`enums`枚举类型配置。 +6.新增`StringUtil`、`CronUtil`工具类。 + +### BUG修复 + +1.修复用户管理、角色管理、部门管理越权漏洞。 +2.修复各模块`dao`层`status`、`del_flag`类型与数据库不一致的问题。 +3.修复移动端左侧菜单无法显示的问题。 +4.修复其他已知BUG。 + +### 代码重构 + +1.重构日志装饰器为`Log`,未来版本将删除`log_decorator`装饰器,请尽快迁移。 +2.重构`RedisInitKeyConfig`为枚举类型,现在可通过以下方式获取对应的`key`和`remark` +`RedisInitKeyConfig.ACCESS_TOKEN.key`、`RedisInitKeyConfig.ACCESS_TOKEN.remark`。 +3.重构数据权限逻辑,底层进行优化,使用方法与之前相同。 + +### 代码优化 + +1.引入`ruff`对后端代码进行格式化及检测修复,优化导入。 +2.各模块基于`ServiceException`自定义服务异常和`ServiceWarning`自定义服务警告优化了异常处理逻辑。 +3.各模块`vo`层使用`Field`声明字段。 +4.优化API文档字段描述显示。 + +## ShiErFeng v1.2.2 + +### BUG修复 + +1.修复删除定时任务时未移除调度中任务的问题。 +2.修复菜单生成路由时组件条件判断错误的问题。 + +## ShiErFeng v1.2.1 + +### BUG修复 + +1.修复各模块新增数据时创建时间记录异常的问题。 +2.修复菜单挂载到根目录时路由加载异常等一系列相关问题。 + +### 代码及性能优化 + +1.修改代理localhost为127.0.0.1以适配部分设备解析localhost异常的问题。 + +## ShiErFeng v1.2.0 + +### 重要说明 + +本次更新为 **_破坏性更新_** ,重构数据库orm为异步,代码改动很大,请谨慎升级。 +1.原有的Session类型声明统一变更为AsyncSession。 +2.service层和dao层的函数修改为异步函数,请使用await调用。 +3.orm查询不再支持query,请使用select、update、delete等语句,具体使用方法请参考[https://docs.sqlalchemy.org/en/20/orm/queryguide/index.html](https://docs.sqlalchemy.org/en/20/orm/queryguide/index.html)。 + +### 项目依赖 + +#### 后端 + +1.增加asyncmy依赖用于支持orm异步操作mysql,请重新安装依赖 + +```bash +pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple。 +``` + +### 新增功能 + +1.新增SnakeCaseUtil工具类,将原CamelCaseUtil工具类的camel_to_snake函数迁移至SnakeCaseUtil工具类。 + +### BUG修复 + +1.修复用户管理模块重置用户密码时会异常重置用户岗位和角色的问题。 +2.修复清空定时任务日志异常的问题。 + +## ShiErFeng v1.1.3 + +### 新增功能 + +1.用户密码新增非法字符验证。 + +### BUG修复 + +1.修复通知公告列表查询前后端字段不一致的问题。 +2.修复个人中心修改基本资料后端异常的问题。 + +## ShiErFeng v1.1.2 + +### 新增功能 + +1.配置文件新增数据库连接池相关配置。 + +### BUG修复 + +1.修复个人中心修改密码后端异常的问题。 + +### 代码及性能优化 + +1.使用@lru_cache缓存ip归属区域查询结果,避免重复调用ip归属区域查询接口以优化性能。 + +## ShiErFeng v1.1.1 + +### BUG修复 + +1.修复编辑定时任务时更新的信息未同步至scheduler的问题 #I9EK56。 +2.修复编辑角色数据权限时后端异常的问题 #I9ENQN。 +3.修复菜单配置路由参数不生效的问题。 +4.修复获取路由信息时菜单排序不生效的问题。 +5.修复添加菜单时是否外链和是否缓存回显异常的问题。 + +## ShiErFeng v1.1.0 + +### 新增功能 + +1.后端配置文件新增sqlalchemy日志开关配置。 +2.后端配置文件新增IP归属区域查询开关配置。 +3.后端配置文件新增账号同时登录开关配置。 + +### BUG修复 + +1.修复token本身过期时退出登录接口异常的问题 #I9CBWT。 +2.修复系统版本号或浏览器版本号无法获取时登录异常的问题 #I9CYNM。 + +## ShiErFeng v1.0.3 + +### 新增功能 + +1.账号密码登录新增IP黑名单校验。 + +### BUG修复 + +1.修复外链菜单无法打开的问题 #I95KBK。 +2.修复添加和编辑菜单页面中是否缓存和是否外链字段回显异常的问题 #I95KBK。 + +## ShiErFeng v1.0.2 + +### 新增功能 + +1.用户接口权限校验增加列表接收参数,实现同一接口支持多个权限标识校验。 +2.新增按角色校验接口权限依赖 + +### BUG修复 + +1.修复用户管理和部门管理模块数据权限异常的问题。 + +### 代码及性能优化 + +1.调整参数设置、部门管理、字典管理、定时任务、日志管理、角色管理、菜单管理模块部分接口权限标识。 + +## ShiErFeng v1.0.1 + +### 项目依赖 + +#### 后端 + +1.更新fastapi版本为0.109.1,修复一些安全性问题,命令: + +```bash +pip install fastapi[all]==0.109.1 -i https://mirrors.aliyun.com/pypi/simple/ +``` + +### 新增功能 + +1.日志管理模块新增字段排序查询。 + +## ShiErFeng v1.0.0 + +ShiErFeng第一个版本发布啦! +此版本功能如下: +1.用户管理:用户是系统操作者,该功能主要完成系统用户配置。 +2.角色管理:角色菜单权限分配。 +3.菜单管理:配置系统菜单,操作权限,按钮权限标识等。 +4.部门管理:配置系统组织机构(公司、部门、小组)。 +5.岗位管理:配置系统用户所属担任职务。 +6.字典管理:对系统中经常使用的一些较为固定的数据进行维护。 +7.参数管理:对系统动态配置常用参数。 +8.通知公告:系统通知公告信息发布维护。 +9.操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。 +10.登录日志:系统登录日志记录查询包含登录异常。 +11.在线用户:当前系统中活跃用户状态监控。 +12.定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。 +13.服务监控:监视当前系统CPU、内存、磁盘、堆栈等相关信息。 +14.缓存监控:对系统的缓存信息查询,命令统计等。 +15.系统接口:根据业务代码自动生成相关的api接口文档。 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4a3554d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 insistence + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..182656a --- /dev/null +++ b/README.md @@ -0,0 +1,168 @@ +# ShiErFeng + +基于 Vue3 与 FastAPI 的前后端分离快速开发框架。 + +## 平台简介 + +施尔丰是一套全部开源的快速开发平台,供个人及企业免费使用。 + +* 前端采用Vue3、Element Plus。 +* 移动端采用uni-app、Vue3、Vite,内置tailwindcss。 +* 后端采用FastAPI、sqlalchemy、MySQL(PostgreSQL)、Redis、OAuth2 & Jwt。 +* 权限认证使用OAuth2 & Jwt,支持多终端认证系统。 +* 支持加载动态权限菜单,多方式轻松权限控制。 +* 纯Python版本: + * Gitte仓库地址: + * GitHub仓库地址: + +## 内置功能 + +1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。 +2. 角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。 +3. 菜单管理:配置系统菜单,操作权限,按钮权限标识等。 +4. 部门管理:配置系统组织机构(公司、部门、小组)。 +5. 岗位管理:配置系统用户所属担任职务。 +6. 字典管理:对系统中经常使用的一些较为固定的数据进行维护。 +7. 参数管理:对系统动态配置常用参数。 +8. 通知公告:系统通知公告信息发布维护。 +9. 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。 +10. 登录日志:系统登录日志记录查询包含登录异常。 +11. 在线用户:当前系统中活跃用户状态监控。 +12. 定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。 +13. 服务监控:监视当前系统CPU、内存、磁盘、堆栈等相关信息。 +14. 缓存监控:对系统的缓存信息查询,命令统计等。 +15. 传输加密:支持前后端请求加密、响应解密、公钥轮换、运行策略下发与监控统计。 +16. 在线构建器:拖动表单元素生成相应的HTML代码。 +17. 系统接口:根据业务代码自动生成相关的api接口文档。 +18. 代码生成:配置数据库表信息一键生成前后端代码(python、sql、vue、js),支持下载。 +19. AI管理:提供AI模型管理和AI对话功能。 + +## 在线体验 + +* *账号:admin* +* *密码:admin123* +* 演示地址:vfadmin管理系统 + +## 项目开发及发布相关 + +### 传输层加解密配置说明 + +后端密钥配置与轮换说明:[shierfeng-fastapi-backend/docs/transport_crypto_config.md](./shierfeng-fastapi-backend/docs/transport_crypto_config.md) + +### 开发 + +```bash +# 克隆项目 +git clone https://git.yujiangrubber.cn/niuniu/ShiErFeng.git + +# 进入项目根目录 +cd ShiErFeng +``` + +#### 前端 + +```bash +# 进入前端目录 +cd shierfeng-fastapi-frontend + +# 安装依赖 +npm install 或 yarn --registry=https://registry.npmmirror.com + +# 建议不要直接使用 cnpm 安装依赖,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题 +npm install --registry=https://registry.npmmirror.com + +# 启动服务 +npm run dev 或 yarn dev +``` + +#### 移动端 + +```bash +# 进入移动端目录 +cd shierfeng-fastapi-app + +# 安装依赖 +npm install -g pnpm +pnpm install + +# 启动 H5 +pnpm dev:h5 + +# 启动微信小程序 +pnpm dev:mp-weixin +``` + +移动端详细文档请参考:[shierfeng-fastapi-app/README.md](./shierfeng-fastapi-app/README.md) + +#### 后端 + +```bash +# 进入后端目录 +cd shierfeng-fastapi-backend + +# 如果使用的是MySQL数据库,请执行以下命令安装项目依赖环境 +pip3 install -r requirements.txt +# 如果使用的是PostgreSQL数据库,请执行以下命令安装项目依赖环境 +pip3 install -r requirements-pg.txt + +# 配置环境 +在.env.dev文件中配置开发环境的数据库和redis + +# 运行sql文件 +1.新建数据库shierfeng-fastapi(默认,可修改) +2.如果使用的是MySQL数据库,使用命令或数据库连接工具运行sql文件夹下的shierfeng-fastapi.sql;如果使用的是PostgreSQL数据库,使用命令或数据库连接工具运行sql文件夹下的shierfeng-fastapi-pg.sql + +# 运行后端 +shierfeng app run --env=dev +``` + +后端 CLI 使用说明请参考:[shierfeng-fastapi-backend/docs/cli_usage.md](./shierfeng-fastapi-backend/docs/cli_usage.md) + +#### 访问 + +```bash +# 默认账号密码 +账号:admin +密码:admin123 + +# 浏览器访问 +地址:http://localhost:80 +``` + +### 发布 + +#### 前端 + +```bash +# 构建测试环境 +npm run build:stage 或 yarn build:stage + +# 构建生产环境 +npm run build:prod 或 yarn build:prod +``` + +#### 后端 + +```bash +# 配置环境 +在.env.prod文件中配置生产环境的数据库和redis + +# 运行后端 +shierfeng app run --env=prod +``` + +### Docker Compose部署方式 + +> ⚠️ **警告:** 默认未做数据持久化配置,请注意数据备份或自行配置持久化 + +#### MySQL版本 + +```bash +docker compose -f shierfeng-fastapi-test/docker-compose.test.my.yml up -d --build +``` + +#### PostgreSQL版本 + +```bash +docker compose -f shierfeng-fastapi-test/docker-compose.test.pg.yml up -d --build +``` diff --git a/shierfeng-fastapi-app/.editorconfig b/shierfeng-fastapi-app/.editorconfig new file mode 100644 index 0000000..ebe51d3 --- /dev/null +++ b/shierfeng-fastapi-app/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = false +insert_final_newline = false \ No newline at end of file diff --git a/shierfeng-fastapi-app/.gitignore b/shierfeng-fastapi-app/.gitignore new file mode 100644 index 0000000..0f36cd4 --- /dev/null +++ b/shierfeng-fastapi-app/.gitignore @@ -0,0 +1,27 @@ +.DS_Store +node_modules/ +unpackage/ +dist/ + +# local env files +.env.local +.env.*.local + +# Log files +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Editor directories and files +.project +.idea +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw* +# 要提交 .env 来确保 jit v2 的开发 watch mode +!.env + +src/ignore +pnpm-lock.yaml diff --git a/shierfeng-fastapi-app/.npmrc b/shierfeng-fastapi-app/.npmrc new file mode 100644 index 0000000..7bd33f5 --- /dev/null +++ b/shierfeng-fastapi-app/.npmrc @@ -0,0 +1,7 @@ +# 设置国内镜像地址 +registry=http://registry.npmmirror.com/ +# registry=http://registry.npmjs.com/ +# 这个是给 pnpm 用的 +shamefully-hoist=true + +ignore-engines=true diff --git a/shierfeng-fastapi-app/README.md b/shierfeng-fastapi-app/README.md new file mode 100644 index 0000000..a9af3c8 --- /dev/null +++ b/shierfeng-fastapi-app/README.md @@ -0,0 +1,78 @@ +# ShiErFeng 移动端 + +基于 `uni-app` 的 `vite` + `vue3` + `tailwindcss` 开发。 + +## 特性 + +- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/) - 快 & 稳定 + +- 🎨 [TailwindCSS](https://tailwindcss.com/) - 世界上最流行,生态最好的原子化CSS框架 + +- 😃 [集成 Iconify](https://github.com/egoist/tailwindcss-icons) - [icones.js.org](https://icones.js.org/) 中的所有图标都为你所用 + +- 📥 [API 自动加载](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 无需引入 + +- 🧬 [uni-app 条件编译样式](https://tw.icebreaker.top/docs/quick-start/uni-app-css-macro) - 帮助你在多端更灵活的使用 `TailwindCSS` + +- 🦾 [TypeScript](https://www.typescriptlang.org/) & [ESLint](https://eslint.org/) & [Stylelint](https://stylelint.io/) - 样式,类型,统一的校验与格式化规则,保证你的代码风格和质量 + +## 快速开始 + +> [!IMPORTANT] +> 推荐使用 `"node": "^20.19.0 || >=22.12.0"` 的 Node.js 版本进行开发! +> +> 另外谨慎升级 `package.json` 中锁定的 `pinia`/`vue`/`@vue/*` 相关包的版本,新版本可能 `uni-app` 没有兼容,造成一些奇怪的 bug + +### vscode + +使用 `vscode` 的开发者,请先安装 [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) 智能提示与感应插件 + +其他 IDE 请参考: + +### 更换 Appid + +把 `src/manifest.json` 中的 `appid`, 更换为你自己的 `appid`, 比如 `uni-app` / `mp-weixin` 平台。 + +## 升级依赖 + +- `pnpm up:pkg` 升级除了 `uni-app` 相关的其他依赖 +- `pnpm up:uniapp` 升级 `uni-app` 相关的依赖 + +推荐先使用 `pnpm up:pkg` 升级, 再使用 `pnpm up:uniapp` 进行升级,因为 `pnpm up:uniapp` 很有可能会进行版本的降级已达到和 `uni-app` 版本匹配的效果 + +## 切换镜像源 + +默认情况下,走的是淘宝镜像源 : `registry.npmmirror.com` + +假如你需要修改镜像源,请修改目录下的 `.npmrc` 文件,然后重新进行 `pnpm i` 安装包即可 + +## 包管理器 + +本项目默认使用 `pnpm@10` 进行管理,当然你也可以切换到其他包管理器,比如 `yarn`, `npm` + +你只需要把 `pnpm-lock.yaml` 删掉,然后把 `package.json` 中的 `packageManager` 字段去除或者换成你具体的包管理器版本,然后重新安装即可 + +### weapp-ide-cli + +本项目已经集成 `weapp-ide-cli` 可以通过 `cli` 对 `ide` 进行额外操作 + +- `pnpm open:dev` 打开微信开发者工具,引入 `dist/dev/mp-weixin` +- `pnpm open:build` 打开微信开发者工具,引入 `dist/build/mp-weixin` + +[详细信息](https://www.npmjs.com/package/weapp-ide-cli) + +## tailwindcss 生态 + +详见: + +你可以在这里找到许多现成的UI,组件模板。 + +## 单位转换 + +- `rem` -> `rpx` (默认开启, 见 `vite.config.ts` 中 `uvtw` 插件的 `rem2rpx` 选项) +- `px` -> `rpx` (默认不开启,可在 `postcss.config.ts` 中引入 `postcss-pxtransform` 开启配置) + +## Tips + +- 升级 `uni-app` 依赖的方式为 `npx @dcloudio/uvm` 后,选择对应的 `Package Manager` 即可。而升级其他包的方式,可以使用 `pnpm up -Li`,这个是 `pnpm` 自带的方式。 +- 使用 `vscode` 记得安装官方插件 `stylelint`,`tailwindcss`, 已在 `.vscode/extensions.json` 中设置推荐 diff --git a/shierfeng-fastapi-app/index.html b/shierfeng-fastapi-app/index.html new file mode 100644 index 0000000..1afa688 --- /dev/null +++ b/shierfeng-fastapi-app/index.html @@ -0,0 +1,29 @@ + + + + + + + + + + + +
+ + + diff --git a/shierfeng-fastapi-app/netlify.toml b/shierfeng-fastapi-app/netlify.toml new file mode 100644 index 0000000..96c3c5d --- /dev/null +++ b/shierfeng-fastapi-app/netlify.toml @@ -0,0 +1,13 @@ +# netlify 部署文件 +# 用于部署此项目的 h5 产物,可删除 +[build] +publish = "dist/build/h5" +command = "pnpm run build:h5" + +[build.environment] +NODE_VERSION = "20" + +[[redirects]] +from = "/*" +to = "/index.html" +status = 200 diff --git a/shierfeng-fastapi-app/package.json b/shierfeng-fastapi-app/package.json new file mode 100644 index 0000000..75c2e4a --- /dev/null +++ b/shierfeng-fastapi-app/package.json @@ -0,0 +1,98 @@ +{ + "name": "shierfeng-fastapi-app", + "version": "1.9.0", + "packageManager": "pnpm@10.28.1", + "scripts": { + "dev": "uni -p mp-weixin", + "build": "npm run build:mp-weixin", + "dev:app": "uni -p app", + "dev:custom": "uni -p", + "dev:h5": "uni --host", + "dev:h5:ssr": "uni --ssr", + "dev:mp-alipay": "uni -p mp-alipay", + "dev:mp-baidu": "uni -p mp-baidu", + "dev:mp-kuaishou": "uni -p mp-kuaishou", + "dev:mp-lark": "uni -p mp-lark", + "dev:mp-qq": "uni -p mp-qq", + "dev:mp-toutiao": "uni -p mp-toutiao", + "dev:mp-weixin": "uni -p mp-weixin", + "dev:quickapp-webview": "uni -p quickapp-webview", + "dev:quickapp-webview-huawei": "uni -p quickapp-webview-huawei", + "dev:quickapp-webview-union": "uni -p quickapp-webview-union", + "build:app": "uni build -p app", + "build:custom": "uni build -p", + "build:h5": "uni build", + "build:h5:ssr": "uni build --ssr", + "build:mp-alipay": "uni build -p mp-alipay", + "build:mp-baidu": "uni build -p mp-baidu", + "build:mp-kuaishou": "uni build -p mp-kuaishou", + "build:mp-lark": "uni build -p mp-lark", + "build:mp-qq": "uni build -p mp-qq", + "build:mp-toutiao": "uni build -p mp-toutiao", + "build:mp-weixin": "uni build -p mp-weixin", + "build:quickapp-webview": "uni build -p quickapp-webview", + "build:quickapp-webview-huawei": "uni build -p quickapp-webview-huawei", + "build:quickapp-webview-union": "uni build -p quickapp-webview-union", + "open:dev": "weapp open -p dist/dev/mp-weixin", + "open:build": "weapp open -p dist/build/mp-weixin", + "weapp:login": "weapp login", + "upload:dev": "weapp upload -p dist/dev/mp-weixin -v 1.0.0 -d \"dev version\"", + "upload:build": "weapp upload -p dist/build/mp-weixin -v 1.0.0 -d \"release version\"", + "postinstall": "weapp-tw patch", + "up:pkg": "pnpm up -rLi \"!@dcloudio/*\"", + "up:uniapp": "pnpx @dcloudio/uvm@latest" + }, + "dependencies": { + "@dcloudio/uni-app": "3.0.0-4080720251210001", + "@dcloudio/uni-app-harmony": "3.0.0-4080720251210001", + "@dcloudio/uni-app-plus": "3.0.0-4080720251210001", + "@dcloudio/uni-components": "3.0.0-4080720251210001", + "@dcloudio/uni-h5": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-alipay": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-baidu": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-harmony": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-jd": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-kuaishou": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-lark": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-qq": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-toutiao": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-weixin": "3.0.0-4080720251210001", + "@dcloudio/uni-mp-xhs": "3.0.0-4080720251210001", + "@dcloudio/uni-quickapp-webview": "3.0.0-4080720251210001", + "@vue/shared": "3.4.21", + "@weapp-tailwindcss/merge-v3": "^0.1.5", + "node-forge": "^1.4.0", + "pinia": "2.2.4", + "vue": "^3.4.21", + "vue-i18n": "^9.1.9", + "vuex": "^4.0.2" + }, + "devDependencies": { + "@dcloudio/types": "^3.4.8", + "@dcloudio/uni-automator": "3.0.0-4080720251210001", + "@dcloudio/uni-cli-shared": "3.0.0-4080720251210001", + "@dcloudio/uni-stacktracey": "3.0.0-4080720251210001", + "@dcloudio/vite-plugin-uni": "3.0.0-4080720251210001", + "@egoist/tailwindcss-icons": "^1.9.2", + "@icebreakers/stylelint-config": "^1.2.5", + "@iconify-json/mdi": "^1.2.3", + "@iconify-json/svg-spinners": "^1.2.4", + "@types/node": "^24.10.1", + "@vue/runtime-core": "^3.5.27", + "autoprefixer": "^10.4.24", + "postcss": "^8.5.6", + "sass": "^1.97.3", + "tailwindcss": "^3.4.19", + "typescript": "^5.9.3", + "unplugin-auto-import": "^20.3.0", + "vite": "5.4.21", + "weapp-ide-cli": "^5.0.1", + "weapp-tailwindcss": "^4.9.8" + }, + "pnpm": { + "onlyBuiltDependencies": [ + "weapp-tailwindcss", + "@weapp-tailwindcss/merge-v3" + ] + } +} diff --git a/shierfeng-fastapi-app/platform.ts b/shierfeng-fastapi-app/platform.ts new file mode 100644 index 0000000..92d71dd --- /dev/null +++ b/shierfeng-fastapi-app/platform.ts @@ -0,0 +1,8 @@ +import process from "node:process"; + +const isH5 = process.env.UNI_PLATFORM === "h5"; +const isApp = process.env.UNI_PLATFORM === "app"; +const WeappTailwindcssDisabled = isH5 || isApp; +const isMp = !isH5 && !isApp; + +export { isApp, isH5, isMp, WeappTailwindcssDisabled }; diff --git a/shierfeng-fastapi-app/postcss.config.ts b/shierfeng-fastapi-app/postcss.config.ts new file mode 100644 index 0000000..791cf15 --- /dev/null +++ b/shierfeng-fastapi-app/postcss.config.ts @@ -0,0 +1,13 @@ +import type { AcceptedPlugin } from "postcss"; +import autoprefixer from "autoprefixer"; +import tailwindcss from "tailwindcss"; +import cssMacro from "weapp-tailwindcss/css-macro/postcss"; + +const plugins: AcceptedPlugin[] = [tailwindcss(), autoprefixer()]; + +// 可以使用 postcss-pxtransform 来进行 px 转 rpx 的功能 +// 详见: https://tw.icebreaker.top/docs/quick-start/css-unit-transform#px-%E8%BD%AC-rpx + +plugins.push(cssMacro); + +export default plugins; diff --git a/shierfeng-fastapi-app/src/App.vue b/shierfeng-fastapi-app/src/App.vue new file mode 100644 index 0000000..1dfc678 --- /dev/null +++ b/shierfeng-fastapi-app/src/App.vue @@ -0,0 +1,79 @@ + + + diff --git a/shierfeng-fastapi-app/src/api/login.js b/shierfeng-fastapi-app/src/api/login.js new file mode 100644 index 0000000..3733b15 --- /dev/null +++ b/shierfeng-fastapi-app/src/api/login.js @@ -0,0 +1,62 @@ +import request from "@/utils/request"; + +// 登录方法 +export function login(username, password, code, uuid) { + const data = { + username, + password, + code, + uuid, + }; + return request({ + url: "/login", + header: { + "Content-Type": "application/x-www-form-urlencoded", + }, + headers: { + isToken: false, + }, + method: "post", + data: data, + }); +} + +// 注册方法 +export function register(data) { + return request({ + url: "/register", + headers: { + isToken: false, + }, + method: "post", + data: data, + }); +} + +// 获取用户详细信息 +export function getInfo() { + return request({ + url: "/getInfo", + method: "get", + }); +} + +// 退出方法 +export function logout() { + return request({ + url: "/logout", + method: "post", + }); +} + +// 获取验证码 +export function getCodeImg() { + return request({ + url: "/captchaImage", + headers: { + isToken: false, + }, + method: "get", + timeout: 20000, + }); +} diff --git a/shierfeng-fastapi-app/src/api/system/dict/data.js b/shierfeng-fastapi-app/src/api/system/dict/data.js new file mode 100644 index 0000000..3fd149f --- /dev/null +++ b/shierfeng-fastapi-app/src/api/system/dict/data.js @@ -0,0 +1,52 @@ +import request from "@/utils/request"; + +// 查询字典数据列表 +export function listData(query) { + return request({ + url: "/system/dict/data/list", + method: "get", + params: query, + }); +} + +// 查询字典数据详细 +export function getData(dictCode) { + return request({ + url: "/system/dict/data/" + dictCode, + method: "get", + }); +} + +// 根据字典类型查询字典数据信息 +export function getDicts(dictType) { + return request({ + url: "/system/dict/data/type/" + dictType, + method: "get", + }); +} + +// 新增字典数据 +export function addData(data) { + return request({ + url: "/system/dict/data", + method: "post", + data: data, + }); +} + +// 修改字典数据 +export function updateData(data) { + return request({ + url: "/system/dict/data", + method: "put", + data: data, + }); +} + +// 删除字典数据 +export function delData(dictCode) { + return request({ + url: "/system/dict/data/" + dictCode, + method: "delete", + }); +} diff --git a/shierfeng-fastapi-app/src/api/system/dict/type.js b/shierfeng-fastapi-app/src/api/system/dict/type.js new file mode 100644 index 0000000..a0c99f6 --- /dev/null +++ b/shierfeng-fastapi-app/src/api/system/dict/type.js @@ -0,0 +1,60 @@ +import request from "@/utils/request"; + +// 查询字典类型列表 +export function listType(query) { + return request({ + url: "/system/dict/type/list", + method: "get", + params: query, + }); +} + +// 查询字典类型详细 +export function getType(dictId) { + return request({ + url: "/system/dict/type/" + dictId, + method: "get", + }); +} + +// 新增字典类型 +export function addType(data) { + return request({ + url: "/system/dict/type", + method: "post", + data: data, + }); +} + +// 修改字典类型 +export function updateType(data) { + return request({ + url: "/system/dict/type", + method: "put", + data: data, + }); +} + +// 删除字典类型 +export function delType(dictId) { + return request({ + url: "/system/dict/type/" + dictId, + method: "delete", + }); +} + +// 刷新字典缓存 +export function refreshCache() { + return request({ + url: "/system/dict/type/refreshCache", + method: "delete", + }); +} + +// 获取字典选择框列表 +export function optionselect() { + return request({ + url: "/system/dict/type/optionselect", + method: "get", + }); +} diff --git a/shierfeng-fastapi-app/src/api/system/user.js b/shierfeng-fastapi-app/src/api/system/user.js new file mode 100644 index 0000000..2daec2d --- /dev/null +++ b/shierfeng-fastapi-app/src/api/system/user.js @@ -0,0 +1,41 @@ +import upload from "@/utils/upload"; +import request from "@/utils/request"; + +// 用户密码重置 +export function updateUserPwd(oldPassword, newPassword) { + const data = { + oldPassword, + newPassword, + }; + return request({ + url: "/system/user/profile/updatePwd", + method: "put", + data: data, + }); +} + +// 查询用户个人信息 +export function getUserProfile() { + return request({ + url: "/system/user/profile", + method: "get", + }); +} + +// 修改用户个人信息 +export function updateUserProfile(data) { + return request({ + url: "/system/user/profile", + method: "put", + data: data, + }); +} + +// 用户头像上传 +export function uploadAvatar(data) { + return upload({ + url: "/system/user/profile/avatar", + name: data.name, + filePath: data.filePath, + }); +} diff --git a/shierfeng-fastapi-app/src/auto-imports.d.ts b/shierfeng-fastapi-app/src/auto-imports.d.ts new file mode 100644 index 0000000..9c97fd2 --- /dev/null +++ b/shierfeng-fastapi-app/src/auto-imports.d.ts @@ -0,0 +1,109 @@ +/* eslint-disable */ +/* prettier-ignore */ +// @ts-nocheck +// noinspection JSUnusedGlobalSymbols +// Generated by unplugin-auto-import +// biome-ignore lint: disable +export {} +declare global { + const EffectScope: typeof import('vue').EffectScope + const acceptHMRUpdate: typeof import('pinia').acceptHMRUpdate + const computed: typeof import('vue').computed + const createApp: typeof import('vue').createApp + const createPinia: typeof import('pinia').createPinia + const customRef: typeof import('vue').customRef + const defineAsyncComponent: typeof import('vue').defineAsyncComponent + const defineComponent: typeof import('vue').defineComponent + const defineStore: typeof import('pinia').defineStore + const effectScope: typeof import('vue').effectScope + const getActivePinia: typeof import('pinia').getActivePinia + const getCurrentInstance: typeof import('vue').getCurrentInstance + const getCurrentScope: typeof import('vue').getCurrentScope + const getCurrentWatcher: typeof import('vue').getCurrentWatcher + const h: typeof import('vue').h + const inject: typeof import('vue').inject + const isProxy: typeof import('vue').isProxy + const isReactive: typeof import('vue').isReactive + const isReadonly: typeof import('vue').isReadonly + const isRef: typeof import('vue').isRef + const isShallow: typeof import('vue').isShallow + const mapActions: typeof import('pinia').mapActions + const mapGetters: typeof import('pinia').mapGetters + const mapState: typeof import('pinia').mapState + const mapStores: typeof import('pinia').mapStores + const mapWritableState: typeof import('pinia').mapWritableState + const markRaw: typeof import('vue').markRaw + const nextTick: typeof import('vue').nextTick + const onActivated: typeof import('vue').onActivated + const onAddToFavorites: typeof import('@dcloudio/uni-app').onAddToFavorites + const onBackPress: typeof import('@dcloudio/uni-app').onBackPress + const onBeforeMount: typeof import('vue').onBeforeMount + const onBeforeUnmount: typeof import('vue').onBeforeUnmount + const onBeforeUpdate: typeof import('vue').onBeforeUpdate + const onDeactivated: typeof import('vue').onDeactivated + const onError: typeof import('@dcloudio/uni-app').onError + const onErrorCaptured: typeof import('vue').onErrorCaptured + const onHide: typeof import('@dcloudio/uni-app').onHide + const onLaunch: typeof import('@dcloudio/uni-app').onLaunch + const onLoad: typeof import('@dcloudio/uni-app').onLoad + const onMounted: typeof import('vue').onMounted + const onNavigationBarButtonTap: typeof import('@dcloudio/uni-app').onNavigationBarButtonTap + const onNavigationBarSearchInputChanged: typeof import('@dcloudio/uni-app').onNavigationBarSearchInputChanged + const onNavigationBarSearchInputClicked: typeof import('@dcloudio/uni-app').onNavigationBarSearchInputClicked + const onNavigationBarSearchInputConfirmed: typeof import('@dcloudio/uni-app').onNavigationBarSearchInputConfirmed + const onNavigationBarSearchInputFocusChanged: typeof import('@dcloudio/uni-app').onNavigationBarSearchInputFocusChanged + const onPageNotFound: typeof import('@dcloudio/uni-app').onPageNotFound + const onPageScroll: typeof import('@dcloudio/uni-app').onPageScroll + const onPullDownRefresh: typeof import('@dcloudio/uni-app').onPullDownRefresh + const onReachBottom: typeof import('@dcloudio/uni-app').onReachBottom + const onReady: typeof import('@dcloudio/uni-app').onReady + const onRenderTracked: typeof import('vue').onRenderTracked + const onRenderTriggered: typeof import('vue').onRenderTriggered + const onResize: typeof import('@dcloudio/uni-app').onResize + const onScopeDispose: typeof import('vue').onScopeDispose + const onServerPrefetch: typeof import('vue').onServerPrefetch + const onShareAppMessage: typeof import('@dcloudio/uni-app').onShareAppMessage + const onShareTimeline: typeof import('@dcloudio/uni-app').onShareTimeline + const onShow: typeof import('@dcloudio/uni-app').onShow + const onTabItemTap: typeof import('@dcloudio/uni-app').onTabItemTap + const onThemeChange: typeof import('@dcloudio/uni-app').onThemeChange + const onUnhandledRejection: typeof import('@dcloudio/uni-app').onUnhandledRejection + const onUnload: typeof import('@dcloudio/uni-app').onUnload + const onUnmounted: typeof import('vue').onUnmounted + const onUpdated: typeof import('vue').onUpdated + const onWatcherCleanup: typeof import('vue').onWatcherCleanup + const provide: typeof import('vue').provide + const reactive: typeof import('vue').reactive + const readonly: typeof import('vue').readonly + const ref: typeof import('vue').ref + const resolveComponent: typeof import('vue').resolveComponent + const setActivePinia: typeof import('pinia').setActivePinia + const setMapStoreSuffix: typeof import('pinia').setMapStoreSuffix + const shallowReactive: typeof import('vue').shallowReactive + const shallowReadonly: typeof import('vue').shallowReadonly + const shallowRef: typeof import('vue').shallowRef + const storeToRefs: typeof import('pinia').storeToRefs + const toRaw: typeof import('vue').toRaw + const toRef: typeof import('vue').toRef + const toRefs: typeof import('vue').toRefs + const toValue: typeof import('vue').toValue + const triggerRef: typeof import('vue').triggerRef + const unref: typeof import('vue').unref + const useAttrs: typeof import('vue').useAttrs + const useCssModule: typeof import('vue').useCssModule + const useCssVars: typeof import('vue').useCssVars + const useId: typeof import('vue').useId + const useModel: typeof import('vue').useModel + const useSlots: typeof import('vue').useSlots + const useTemplateRef: typeof import('vue').useTemplateRef + const watch: typeof import('vue').watch + const watchEffect: typeof import('vue').watchEffect + const watchPostEffect: typeof import('vue').watchPostEffect + const watchSyncEffect: typeof import('vue').watchSyncEffect +} +// for type re-export +declare global { + // @ts-ignore + export type { Component, Slot, Slots, ComponentPublicInstance, ComputedRef, DirectiveBinding, ExtractDefaultPropTypes, ExtractPropTypes, ExtractPublicPropTypes, InjectionKey, PropType, Ref, ShallowRef, MaybeRef, MaybeRefOrGetter, VNode, WritableComputedRef } from 'vue' + import('vue') +} diff --git a/shierfeng-fastapi-app/src/config.js b/shierfeng-fastapi-app/src/config.js new file mode 100644 index 0000000..297587f --- /dev/null +++ b/shierfeng-fastapi-app/src/config.js @@ -0,0 +1,26 @@ +// 应用全局配置 +export default { + baseUrl: "http://localhost:9099", + // 应用信息 + appInfo: { + // 应用名称 + name: "ShiErFeng-FastAPI-APP", + // 应用版本 + version: "1.9.0", + // 应用logo + logo: "/static/logo.png", + // 官方网站 + site_url: "https://vfadmin.insistence.tech", + // 政策协议 + agreements: [ + { + title: "隐私政策", + url: "/pages/common/privacy/index", + }, + { + title: "用户服务协议", + url: "/pages/common/agreement/index", + }, + ], + }, +}; diff --git a/shierfeng-fastapi-app/src/env.d.ts b/shierfeng-fastapi-app/src/env.d.ts new file mode 100644 index 0000000..f5d8917 --- /dev/null +++ b/shierfeng-fastapi-app/src/env.d.ts @@ -0,0 +1,8 @@ +/// + +declare module "*.vue" { + import type { DefineComponent } from "vue"; + + const component: DefineComponent; + export default component; +} diff --git a/shierfeng-fastapi-app/src/main.ts b/shierfeng-fastapi-app/src/main.ts new file mode 100644 index 0000000..255aa09 --- /dev/null +++ b/shierfeng-fastapi-app/src/main.ts @@ -0,0 +1,17 @@ +// @ts-nocheck +import { createSSRApp } from "vue"; +import App from "./App.vue"; +import store from "./store"; // store +import { install } from "./plugins"; // plugins +import "./permission"; // permission +import { useDict } from "@/utils/dict"; + +export function createApp() { + const app = createSSRApp(App); + app.use(store); + app.config.globalProperties.useDict = useDict; + install(app); + return { + app, + }; +} diff --git a/shierfeng-fastapi-app/src/manifest.json b/shierfeng-fastapi-app/src/manifest.json new file mode 100644 index 0000000..b9f9167 --- /dev/null +++ b/shierfeng-fastapi-app/src/manifest.json @@ -0,0 +1,70 @@ +{ + "name": "ShiErFeng-FastAPI移动端", + "appid": "__UNI__25A9D80", + "description": "", + "versionName": "1.9.0", + "versionCode": "100", + "transformPx": false, + "app-plus": { + "usingComponents": true, + "nvueCompiler": "uni-app", + "splashscreen": { + "alwaysShowBeforeRender": true, + "waiting": true, + "autoclose": true, + "delay": 0 + }, + "modules": {}, + "distribute": { + "android": { + "permissions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "ios": { + "dSYMs": false + }, + "sdkConfigs": {} + } + }, + "quickapp": {}, + "mp-weixin": { + "appid": "wxccd7e2a0911b3397", + "setting": { + "urlCheck": false, + "es6": false, + "minified": true, + "postcss": true + }, + "optimization": { + "subPackages": true + }, + "usingComponents": true + }, + "vueVersion": "3", + "h5": { + "devServer": { + "port": 9090, + "https": false + }, + "title": "ShiErFeng-FastAPI-APP", + "router": { + "mode": "hash", + "base": "./" + } + } +} diff --git a/shierfeng-fastapi-app/src/pages.json b/shierfeng-fastapi-app/src/pages.json new file mode 100644 index 0000000..8216113 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages.json @@ -0,0 +1,132 @@ +{ + "pages": [ + { + "path": "pages/login", + "style": { + "navigationBarTitleText": "登录" + } + }, + { + "path": "pages/register", + "style": { + "navigationBarTitleText": "注册" + } + }, + { + "path": "pages/index", + "style": { + "navigationBarTitleText": "ShiErFeng-FastAPI移动端", + "navigationStyle": "custom" + } + }, + { + "path": "pages/work/index", + "style": { + "navigationBarTitleText": "工作台" + } + }, + { + "path": "pages/mine/index", + "style": { + "navigationBarTitleText": "我的" + } + }, + { + "path": "pages/mine/avatar/index", + "style": { + "navigationBarTitleText": "修改头像" + } + }, + { + "path": "pages/mine/info/index", + "style": { + "navigationBarTitleText": "个人信息" + } + }, + { + "path": "pages/mine/info/edit", + "style": { + "navigationBarTitleText": "编辑资料" + } + }, + { + "path": "pages/mine/pwd/index", + "style": { + "navigationBarTitleText": "修改密码" + } + }, + { + "path": "pages/mine/setting/index", + "style": { + "navigationBarTitleText": "应用设置" + } + }, + { + "path": "pages/mine/help/index", + "style": { + "navigationBarTitleText": "常见问题" + } + }, + { + "path": "pages/mine/about/index", + "style": { + "navigationBarTitleText": "关于我们" + } + }, + { + "path": "pages/common/agreement/index", + "style": { + "navigationBarTitleText": "用户协议" + } + }, + { + "path": "pages/common/privacy/index", + "style": { + "navigationBarTitleText": "隐私协议" + } + }, + { + "path": "pages/common/webview/index", + "style": { + "navigationBarTitleText": "浏览网页" + } + }, + { + "path": "pages/common/textview/index", + "style": { + "navigationBarTitleText": "浏览文本" + } + } + ], + "tabBar": { + "color": "#000000", + "selectedColor": "#000000", + "borderStyle": "white", + "backgroundColor": "#ffffff", + "list": [ + { + "pagePath": "pages/index", + "iconPath": "static/images/tabbar/home.png", + "selectedIconPath": "static/images/tabbar/home_.png", + "text": "首页" + }, + { + "pagePath": "pages/work/index", + "iconPath": "static/images/tabbar/work.png", + "selectedIconPath": "static/images/tabbar/work_.png", + "text": "工作台" + }, + { + "pagePath": "pages/mine/index", + "iconPath": "static/images/tabbar/mine.png", + "selectedIconPath": "static/images/tabbar/mine_.png", + "text": "我的" + } + ] + }, + "globalStyle": { + "navigationBarTextStyle": "black", + "navigationBarTitleText": "ShiErFeng", + "navigationBarBackgroundColor": "#FFFFFF" + } +} diff --git a/shierfeng-fastapi-app/src/pages/common/agreement/index.vue b/shierfeng-fastapi-app/src/pages/common/agreement/index.vue new file mode 100644 index 0000000..503928b --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/common/agreement/index.vue @@ -0,0 +1,63 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/common/privacy/index.vue b/shierfeng-fastapi-app/src/pages/common/privacy/index.vue new file mode 100644 index 0000000..13f72c8 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/common/privacy/index.vue @@ -0,0 +1,87 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/common/textview/index.vue b/shierfeng-fastapi-app/src/pages/common/textview/index.vue new file mode 100644 index 0000000..fa6d984 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/common/textview/index.vue @@ -0,0 +1,37 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/common/webview/index.vue b/shierfeng-fastapi-app/src/pages/common/webview/index.vue new file mode 100644 index 0000000..12087db --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/common/webview/index.vue @@ -0,0 +1,33 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/index.vue b/shierfeng-fastapi-app/src/pages/index.vue new file mode 100644 index 0000000..5b5f1a4 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/index.vue @@ -0,0 +1,208 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/login.vue b/shierfeng-fastapi-app/src/pages/login.vue new file mode 100644 index 0000000..4c80816 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/login.vue @@ -0,0 +1,224 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/about/index.vue b/shierfeng-fastapi-app/src/pages/mine/about/index.vue new file mode 100644 index 0000000..5606daf --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/about/index.vue @@ -0,0 +1,68 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/avatar/index.vue b/shierfeng-fastapi-app/src/pages/mine/avatar/index.vue new file mode 100644 index 0000000..4451768 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/avatar/index.vue @@ -0,0 +1,678 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/help/index.vue b/shierfeng-fastapi-app/src/pages/mine/help/index.vue new file mode 100644 index 0000000..01ae6b9 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/help/index.vue @@ -0,0 +1,91 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/index.vue b/shierfeng-fastapi-app/src/pages/mine/index.vue new file mode 100644 index 0000000..cbbca90 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/index.vue @@ -0,0 +1,209 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/info/edit.vue b/shierfeng-fastapi-app/src/pages/mine/info/edit.vue new file mode 100644 index 0000000..91e009c --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/info/edit.vue @@ -0,0 +1,145 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/info/index.vue b/shierfeng-fastapi-app/src/pages/mine/info/index.vue new file mode 100644 index 0000000..f62fd1e --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/info/index.vue @@ -0,0 +1,121 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/pwd/index.vue b/shierfeng-fastapi-app/src/pages/mine/pwd/index.vue new file mode 100644 index 0000000..97cca3f --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/pwd/index.vue @@ -0,0 +1,90 @@ + + + diff --git a/shierfeng-fastapi-app/src/pages/mine/setting/index.vue b/shierfeng-fastapi-app/src/pages/mine/setting/index.vue new file mode 100644 index 0000000..2000a42 --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/mine/setting/index.vue @@ -0,0 +1,87 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/register.vue b/shierfeng-fastapi-app/src/pages/register.vue new file mode 100644 index 0000000..fbcd29d --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/register.vue @@ -0,0 +1,206 @@ + + + + + diff --git a/shierfeng-fastapi-app/src/pages/work/index.vue b/shierfeng-fastapi-app/src/pages/work/index.vue new file mode 100644 index 0000000..0d8072a --- /dev/null +++ b/shierfeng-fastapi-app/src/pages/work/index.vue @@ -0,0 +1,235 @@ + + + diff --git a/shierfeng-fastapi-app/src/permission.js b/shierfeng-fastapi-app/src/permission.js new file mode 100644 index 0000000..8b45534 --- /dev/null +++ b/shierfeng-fastapi-app/src/permission.js @@ -0,0 +1,43 @@ +import { getToken } from "@/utils/auth"; + +// 登录页面 +const loginPage = "/pages/login"; + +// 页面白名单 +const whiteList = [ + "/pages/login", + "/pages/register", + "/pages/common/webview/index", + "/pages/common/agreement/index", + "/pages/common/privacy/index", +]; + +// 检查地址白名单 +function checkWhite(url) { + const path = url.split("?")[0]; + return whiteList.indexOf(path) !== -1; +} + +// 页面跳转验证拦截器 +let list = ["navigateTo", "redirectTo", "reLaunch", "switchTab"]; +list.forEach((item) => { + uni.addInterceptor(item, { + invoke(to) { + if (getToken()) { + if (to.url === loginPage) { + uni.reLaunch({ url: "/" }); + } + return true; + } else { + if (checkWhite(to.url)) { + return true; + } + uni.reLaunch({ url: loginPage }); + return false; + } + }, + fail(err) { + console.log(err); + }, + }); +}); diff --git a/shierfeng-fastapi-app/src/plugins/auth.js b/shierfeng-fastapi-app/src/plugins/auth.js new file mode 100644 index 0000000..ba7b6d5 --- /dev/null +++ b/shierfeng-fastapi-app/src/plugins/auth.js @@ -0,0 +1,60 @@ +import { useUserStore } from "@/store"; + +function authPermission(permission) { + const all_permission = "*:*:*"; + const permissions = useUserStore().permissions; + if (permission && permission.length > 0) { + return permissions.some((v) => { + return all_permission === v || v === permission; + }); + } else { + return false; + } +} + +function authRole(role) { + const super_admin = "admin"; + const roles = useUserStore().roles; + if (role && role.length > 0) { + return roles.some((v) => { + return super_admin === v || v === role; + }); + } else { + return false; + } +} + +export default { + // 验证用户是否具备某权限 + hasPermi(permission) { + return authPermission(permission); + }, + // 验证用户是否含有指定权限,只需包含其中一个 + hasPermiOr(permissions) { + return permissions.some((item) => { + return authPermission(item); + }); + }, + // 验证用户是否含有指定权限,必须全部拥有 + hasPermiAnd(permissions) { + return permissions.every((item) => { + return authPermission(item); + }); + }, + // 验证用户是否具备某角色 + hasRole(role) { + return authRole(role); + }, + // 验证用户是否含有指定角色,只需包含其中一个 + hasRoleOr(roles) { + return roles.some((item) => { + return authRole(item); + }); + }, + // 验证用户是否含有指定角色,必须全部拥有 + hasRoleAnd(roles) { + return roles.every((item) => { + return authRole(item); + }); + }, +}; diff --git a/shierfeng-fastapi-app/src/plugins/index.js b/shierfeng-fastapi-app/src/plugins/index.js new file mode 100644 index 0000000..886e74a --- /dev/null +++ b/shierfeng-fastapi-app/src/plugins/index.js @@ -0,0 +1,12 @@ +import tab from "./tab"; +import auth from "./auth"; +import modal from "./modal"; + +export function install(app) { + // 页签操作 + app.config.globalProperties.$tab = tab; + // 认证对象 + app.config.globalProperties.$auth = auth; + // 模态框对象 + app.config.globalProperties.$modal = modal; +} diff --git a/shierfeng-fastapi-app/src/plugins/modal.js b/shierfeng-fastapi-app/src/plugins/modal.js new file mode 100644 index 0000000..175d11c --- /dev/null +++ b/shierfeng-fastapi-app/src/plugins/modal.js @@ -0,0 +1,78 @@ +export default { + // 消息提示 + msg(content) { + uni.showToast({ + title: content, + icon: "none", + }); + }, + // 错误消息 + msgError(content) { + uni.showToast({ + title: content, + icon: "error", + }); + }, + // 成功消息 + msgSuccess(content) { + uni.showToast({ + title: content, + icon: "success", + }); + }, + // 隐藏消息 + hideMsg(content) { + uni.hideToast(); + }, + // 弹出提示 + alert(content, title) { + uni.showModal({ + title: title || "系统提示", + content: content, + showCancel: false, + }); + }, + // 确认窗体 + confirm(content, title) { + return new Promise((resolve, reject) => { + uni.showModal({ + title: title || "系统提示", + content: content, + cancelText: "取消", + confirmText: "确定", + success: function (res) { + if (res.confirm) { + resolve(res.confirm); + } + }, + }); + }); + }, + // 提示信息 + showToast(option) { + if (typeof option === "object") { + uni.showToast(option); + } else { + uni.showToast({ + title: option, + icon: "none", + duration: 2500, + }); + } + }, + // 打开遮罩层 + loading(content) { + uni.showLoading({ + title: content, + icon: "none", + }); + }, + // 关闭遮罩层 + closeLoading() { + try { + uni.hideLoading(); + } catch (e) { + console.log(e); + } + }, +}; diff --git a/shierfeng-fastapi-app/src/plugins/tab.js b/shierfeng-fastapi-app/src/plugins/tab.js new file mode 100644 index 0000000..c68475b --- /dev/null +++ b/shierfeng-fastapi-app/src/plugins/tab.js @@ -0,0 +1,30 @@ +export default { + // 关闭所有页面,打开到应用内的某个页面 + reLaunch(url) { + return uni.reLaunch({ + url: url, + }); + }, + // 跳转到tabBar页面,并关闭其他所有非tabBar页面 + switchTab(url) { + return uni.switchTab({ + url: url, + }); + }, + // 关闭当前页面,跳转到应用内的某个页面 + redirectTo(url) { + return uni.redirectTo({ + url: url, + }); + }, + // 保留当前页面,跳转到应用内的某个页面 + navigateTo(url) { + return uni.navigateTo({ + url: url, + }); + }, + // 关闭当前页面,返回上一页面或多级页面 + navigateBack() { + return uni.navigateBack(); + }, +}; diff --git a/shierfeng-fastapi-app/src/static/favicon.ico b/shierfeng-fastapi-app/src/static/favicon.ico new file mode 100644 index 0000000..6f07782 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/favicon.ico differ diff --git a/shierfeng-fastapi-app/src/static/images/banner/banner01.jpg b/shierfeng-fastapi-app/src/static/images/banner/banner01.jpg new file mode 100644 index 0000000..c44d84c Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/banner/banner01.jpg differ diff --git a/shierfeng-fastapi-app/src/static/images/banner/banner02.jpg b/shierfeng-fastapi-app/src/static/images/banner/banner02.jpg new file mode 100644 index 0000000..1086afd Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/banner/banner02.jpg differ diff --git a/shierfeng-fastapi-app/src/static/images/banner/banner03.jpg b/shierfeng-fastapi-app/src/static/images/banner/banner03.jpg new file mode 100644 index 0000000..092a5fc Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/banner/banner03.jpg differ diff --git a/shierfeng-fastapi-app/src/static/images/profile.jpg b/shierfeng-fastapi-app/src/static/images/profile.jpg new file mode 100644 index 0000000..94efdf3 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/profile.jpg differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/home.png b/shierfeng-fastapi-app/src/static/images/tabbar/home.png new file mode 100644 index 0000000..50acdfd Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/home.png differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/home_.png b/shierfeng-fastapi-app/src/static/images/tabbar/home_.png new file mode 100644 index 0000000..a408f71 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/home_.png differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/mine.png b/shierfeng-fastapi-app/src/static/images/tabbar/mine.png new file mode 100644 index 0000000..f13fe44 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/mine.png differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/mine_.png b/shierfeng-fastapi-app/src/static/images/tabbar/mine_.png new file mode 100644 index 0000000..8a0a742 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/mine_.png differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/work.png b/shierfeng-fastapi-app/src/static/images/tabbar/work.png new file mode 100644 index 0000000..21e130d Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/work.png differ diff --git a/shierfeng-fastapi-app/src/static/images/tabbar/work_.png b/shierfeng-fastapi-app/src/static/images/tabbar/work_.png new file mode 100644 index 0000000..80b979c Binary files /dev/null and b/shierfeng-fastapi-app/src/static/images/tabbar/work_.png differ diff --git a/shierfeng-fastapi-app/src/static/logo.png b/shierfeng-fastapi-app/src/static/logo.png new file mode 100644 index 0000000..d4ebbf0 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/logo.png differ diff --git a/shierfeng-fastapi-app/src/static/logo200.png b/shierfeng-fastapi-app/src/static/logo200.png new file mode 100644 index 0000000..ffa9988 Binary files /dev/null and b/shierfeng-fastapi-app/src/static/logo200.png differ diff --git a/shierfeng-fastapi-app/src/store/index.js b/shierfeng-fastapi-app/src/store/index.js new file mode 100644 index 0000000..bebd245 --- /dev/null +++ b/shierfeng-fastapi-app/src/store/index.js @@ -0,0 +1,9 @@ +import { createPinia } from "pinia"; +import { useUserStore } from "./modules/user"; +import { useConfigStore } from "./modules/config"; + +const pinia = createPinia(); + +export default pinia; + +export { useUserStore, useConfigStore }; diff --git a/shierfeng-fastapi-app/src/store/modules/config.js b/shierfeng-fastapi-app/src/store/modules/config.js new file mode 100644 index 0000000..be427ee --- /dev/null +++ b/shierfeng-fastapi-app/src/store/modules/config.js @@ -0,0 +1,13 @@ +import { defineStore } from "pinia"; +import { ref } from "vue"; + +export const useConfigStore = defineStore("config", () => { + const config = ref(); + const setConfig = (val) => { + config.value = val; + }; + return { + config, + setConfig, + }; +}); diff --git a/shierfeng-fastapi-app/src/store/modules/dict.js b/shierfeng-fastapi-app/src/store/modules/dict.js new file mode 100644 index 0000000..489f59d --- /dev/null +++ b/shierfeng-fastapi-app/src/store/modules/dict.js @@ -0,0 +1,56 @@ +import { defineStore } from "pinia"; + +const useDictStore = defineStore("dict", { + state: () => ({ + dict: new Array(), + }), + actions: { + // 获取字典 + getDict(_key) { + if (_key == null && _key == "") { + return null; + } + try { + for (let i = 0; i < this.dict.length; i++) { + if (this.dict[i].key == _key) { + return this.dict[i].value; + } + } + } catch (e) { + return null; + } + }, + // 设置字典 + setDict(_key, value) { + if (_key !== null && _key !== "") { + this.dict.push({ + key: _key, + value: value, + }); + } + }, + // 删除字典 + removeDict(_key) { + var bln = false; + try { + for (let i = 0; i < this.dict.length; i++) { + if (this.dict[i].key == _key) { + this.dict.splice(i, 1); + return true; + } + } + } catch (e) { + bln = false; + } + return bln; + }, + // 清空字典 + cleanDict() { + this.dict = new Array(); + }, + // 初始字典 + initDict() {}, + }, +}); + +export default useDictStore; diff --git a/shierfeng-fastapi-app/src/store/modules/user.js b/shierfeng-fastapi-app/src/store/modules/user.js new file mode 100644 index 0000000..de08f28 --- /dev/null +++ b/shierfeng-fastapi-app/src/store/modules/user.js @@ -0,0 +1,125 @@ +import { defineStore } from "pinia"; +import { ref } from "vue"; +import config from "@/config"; +import storage from "@/utils/storage"; +import constant from "@/utils/constant"; +import { isHttp, isEmpty } from "@/utils/validate"; +import { getInfo, login, logout } from "@/api/login"; +import { getToken, removeToken, setToken } from "@/utils/auth"; +import defAva from "@/static/images/profile.jpg"; + +const baseUrl = config.baseUrl; + +export const useUserStore = defineStore("user", () => { + const token = ref(getToken()); + const id = ref(storage.get(constant.id)); + const name = ref(storage.get(constant.name)); + const avatar = ref(storage.get(constant.avatar)); + const roles = ref(storage.get(constant.roles)); + const permissions = ref(storage.get(constant.permissions)); + + const SET_TOKEN = (val) => { + token.value = val; + }; + const SET_ID = (val) => { + id.value = val; + storage.set(constant.id, val); + }; + const SET_NAME = (val) => { + name.value = val; + storage.set(constant.name, val); + }; + const SET_AVATAR = (val) => { + avatar.value = val; + storage.set(constant.avatar, val); + }; + const SET_ROLES = (val) => { + roles.value = val; + storage.set(constant.roles, val); + }; + const SET_PERMISSIONS = (val) => { + permissions.value = val; + storage.set(constant.permissions, val); + }; + + // 登录 + const loginAction = (userInfo) => { + const username = userInfo.username.trim(); + const password = userInfo.password; + const code = userInfo.code; + const uuid = userInfo.uuid; + return new Promise((resolve, reject) => { + login(username, password, code, uuid) + .then((res) => { + setToken(res.token); + SET_TOKEN(res.token); + resolve(); + }) + .catch((error) => { + reject(error); + }); + }); + }; + + // 获取用户信息 + const getInfoAction = () => { + return new Promise((resolve, reject) => { + getInfo() + .then((res) => { + const user = res.user; + let avatar = user.avatar || ""; + if (!isHttp(avatar)) { + avatar = isEmpty(avatar) ? defAva : baseUrl + avatar; + } + const userid = + isEmpty(user) || isEmpty(user.userId) ? "" : user.userId; + const username = + isEmpty(user) || isEmpty(user.userName) ? "" : user.userName; + if (res.roles && res.roles.length > 0) { + SET_ROLES(res.roles); + SET_PERMISSIONS(res.permissions); + } else { + SET_ROLES(["ROLE_DEFAULT"]); + } + SET_ID(userid); + SET_NAME(username); + SET_AVATAR(avatar); + resolve(res); + }) + .catch((error) => { + reject(error); + }); + }); + }; + + // 退出系统 + const logOutAction = () => { + return new Promise((resolve, reject) => { + logout(token.value) + .then(() => { + SET_TOKEN(""); + SET_ROLES([]); + SET_PERMISSIONS([]); + removeToken(); + storage.clean(); + resolve(); + }) + .catch((error) => { + reject(error); + }); + }); + }; + + return { + token, + id, + name, + avatar, + roles, + permissions, + SET_AVATAR, + login: loginAction, + getInfo: getInfoAction, + logOut: logOutAction, + }; +}); diff --git a/shierfeng-fastapi-app/src/theme.json b/shierfeng-fastapi-app/src/theme.json new file mode 100644 index 0000000..c1ec2c9 --- /dev/null +++ b/shierfeng-fastapi-app/src/theme.json @@ -0,0 +1,10 @@ +{ + "light": { + "navBgColor": "#f6f6f6", + "navTxtStyle": "black" + }, + "dark": { + "navBgColor": "#191919", + "navTxtStyle": "white" + } +} diff --git a/shierfeng-fastapi-app/src/uni.scss b/shierfeng-fastapi-app/src/uni.scss new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-app/src/utils/auth.js b/shierfeng-fastapi-app/src/utils/auth.js new file mode 100644 index 0000000..0e5b269 --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/auth.js @@ -0,0 +1,13 @@ +const TokenKey = "App-Token"; + +export function getToken() { + return uni.getStorageSync(TokenKey); +} + +export function setToken(token) { + return uni.setStorageSync(TokenKey, token); +} + +export function removeToken() { + return uni.removeStorageSync(TokenKey); +} diff --git a/shierfeng-fastapi-app/src/utils/common.js b/shierfeng-fastapi-app/src/utils/common.js new file mode 100644 index 0000000..0791a37 --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/common.js @@ -0,0 +1,58 @@ +/** + * 显示消息提示框 + * @param content 提示的标题 + */ +export function toast(content) { + uni.showToast({ + icon: "none", + title: content, + }); +} + +/** + * 显示模态弹窗 + * @param content 提示的标题 + */ +export function showConfirm(content) { + return new Promise((resolve, reject) => { + uni.showModal({ + title: "提示", + content: content, + cancelText: "取消", + confirmText: "确定", + success: function (res) { + resolve(res); + }, + }); + }); +} + +/** + * 参数处理 + * @param params 参数 + */ +export function tansParams(params) { + let result = ""; + for (const propName of Object.keys(params)) { + const value = params[propName]; + var part = encodeURIComponent(propName) + "="; + if (value !== null && value !== "" && typeof value !== "undefined") { + if (typeof value === "object") { + for (const key of Object.keys(value)) { + if ( + value[key] !== null && + value[key] !== "" && + typeof value[key] !== "undefined" + ) { + let params = propName + "[" + key + "]"; + var subPart = encodeURIComponent(params) + "="; + result += subPart + encodeURIComponent(value[key]) + "&"; + } + } + } else { + result += part + encodeURIComponent(value) + "&"; + } + } + } + return result; +} diff --git a/shierfeng-fastapi-app/src/utils/constant.js b/shierfeng-fastapi-app/src/utils/constant.js new file mode 100644 index 0000000..198fb6f --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/constant.js @@ -0,0 +1,9 @@ +const constant = { + avatar: "user_avatar", + id: "user_id", + name: "user_name", + roles: "user_roles", + permissions: "user_permissions", +}; + +export default constant; diff --git a/shierfeng-fastapi-app/src/utils/dict.js b/shierfeng-fastapi-app/src/utils/dict.js new file mode 100644 index 0000000..b90c9a0 --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/dict.js @@ -0,0 +1,30 @@ +import useDictStore from "@/store/modules/dict"; +import { getDicts } from "@/api/system/dict/data"; +import { ref, toRefs } from "vue"; + +/** + * 获取字典数据 + */ +export function useDict(...args) { + const res = ref({}); + return (() => { + args.forEach((dictType, index) => { + res.value[dictType] = []; + const dicts = useDictStore().getDict(dictType); + if (dicts) { + res.value[dictType] = dicts; + } else { + getDicts(dictType).then((resp) => { + res.value[dictType] = resp.data.map((p) => ({ + label: p.dictLabel, + value: p.dictValue, + elTagType: p.listClass, + elTagClass: p.cssClass, + })); + useDictStore().setDict(dictType, res.value[dictType]); + }); + } + }); + return toRefs(res.value); + })(); +} diff --git a/shierfeng-fastapi-app/src/utils/errorCode.js b/shierfeng-fastapi-app/src/utils/errorCode.js new file mode 100644 index 0000000..984fded --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/errorCode.js @@ -0,0 +1,6 @@ +export default { + 401: "认证失败,无法访问系统资源", + 403: "当前操作没有权限", + 404: "访问资源不存在", + default: "系统未知错误,请反馈给管理员", +}; diff --git a/shierfeng-fastapi-app/src/utils/permission.js b/shierfeng-fastapi-app/src/utils/permission.js new file mode 100644 index 0000000..e30a24c --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/permission.js @@ -0,0 +1,55 @@ +import store from "@/store"; + +/** + * 字符权限校验 + * @param {Array} value 校验值 + * @returns {Boolean} + */ +export function checkPermi(value) { + if (value && value instanceof Array && value.length > 0) { + const permissions = store.getters && store.getters.permissions; + const permissionDatas = value; + const all_permission = "*:*:*"; + + const hasPermission = permissions.some((permission) => { + return ( + all_permission === permission || permissionDatas.includes(permission) + ); + }); + + if (!hasPermission) { + return false; + } + return true; + } else { + console.error( + `need roles! Like checkPermi="['system:user:add','system:user:edit']"`, + ); + return false; + } +} + +/** + * 角色权限校验 + * @param {Array} value 校验值 + * @returns {Boolean} + */ +export function checkRole(value) { + if (value && value instanceof Array && value.length > 0) { + const roles = store.getters && store.getters.roles; + const permissionRoles = value; + const super_admin = "admin"; + + const hasRole = roles.some((role) => { + return super_admin === role || permissionRoles.includes(role); + }); + + if (!hasRole) { + return false; + } + return true; + } else { + console.error(`need roles! Like checkRole="['admin','editor']"`); + return false; + } +} diff --git a/shierfeng-fastapi-app/src/utils/request.js b/shierfeng-fastapi-app/src/utils/request.js new file mode 100644 index 0000000..35188a8 --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/request.js @@ -0,0 +1,131 @@ +import config from "@/config"; +import { getToken } from "@/utils/auth"; +import errorCode from "@/utils/errorCode"; +import { useUserStore } from "@/store/modules/user"; +import { toast, showConfirm, tansParams } from "@/utils/common"; +import { + decryptTransportErrorResponse, + decryptTransportResponse, + encryptTransportRequest, + invalidateTransportKeyMeta, + resetTransportRequestConfig, + shouldRetryTransportWithFreshKey, +} from "@/utils/transportCrypto"; + +let timeout = 10000; +const baseUrl = config.baseUrl; + +const request = async (config) => { + // 是否需要设置 token + const isToken = (config.headers || {}).isToken === false; + config.header = config.header || {}; + config.headers = config.headers || {}; + if (getToken() && !isToken) { + config.header["Authorization"] = "Bearer " + getToken(); + } + + try { + config = await encryptTransportRequest(config); + + // get请求映射params参数 + if (config.params) { + let url = config.url + "?" + tansParams(config.params); + url = url.slice(0, -1); + config.url = url; + } + + return await new Promise((resolve, reject) => { + uni.request({ + method: config.method || "get", + timeout: config.timeout || timeout, + url: config.baseUrl || baseUrl + config.url, + data: config.data, + header: config.header, + dataType: "json", + success: async (response) => { + try { + const res = await decryptTransportResponse(response, config); + + if (shouldRetryTransportWithFreshKey(res) && !config.__transportRetried) { + invalidateTransportKeyMeta(); + config.__transportRetried = true; + config.headers.repeatSubmit = false; + resetTransportRequestConfig(config); + resolve(await request(config)); + return; + } + + const code = res.data.code || 200; + const msg = errorCode[code] || res.data.msg || errorCode["default"]; + if (code === 401) { + showConfirm( + "登录状态已过期,您可以继续留在该页面,或者重新登录?", + ).then((res) => { + if (res.confirm) { + useUserStore() + .logOut() + .then(() => { + uni.reLaunch({ url: "/pages/login" }); + }); + } + }); + const error = new Error("无效的会话,或者会话已过期,请重新登录。"); + error.response = res; + reject(error); + } else if (code === 500) { + const error = new Error(msg); + error.response = res; + reject(error); + } else if (code !== 200) { + const error = new Error(msg); + error.response = res; + reject(error); + } else { + resolve(res.data); + } + } catch (error) { + reject(error); + } + }, + fail: reject, + }); + }); + } catch (error) { + error = await decryptTransportErrorResponse(error, config); + if (shouldRetryTransportWithFreshKey(error) && !config.__transportRetried) { + invalidateTransportKeyMeta(); + config.__transportRetried = true; + config.headers.repeatSubmit = false; + resetTransportRequestConfig(config); + return request(config); + } + + const response = error.response; + const responseStatus = response?.status ?? response?.statusCode; + const responseCode = response?.data?.code; + const responseMsg = response?.data?.msg; + if (responseMsg) { + uni.showToast({ + title: responseMsg, + icon: "none", + duration: responseStatus === 429 || responseCode === 429 ? 5000 : 3000, + }); + throw error; + } + + let { message } = error; + if (message === "Network Error") { + message = "后端接口连接异常"; + } else if (message && message.includes("timeout")) { + message = "系统接口请求超时"; + } else if (message && message.includes("Request failed with status code")) { + message = "系统接口" + message.substr(message.length - 3) + "异常"; + } + if (message) { + toast(message); + } + throw error; + } +}; + +export default request; diff --git a/shierfeng-fastapi-app/src/utils/storage.js b/shierfeng-fastapi-app/src/utils/storage.js new file mode 100644 index 0000000..957579e --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/storage.js @@ -0,0 +1,38 @@ +import constant from "./constant"; + +// 存储变量名 +let storageKey = "storage_data"; + +// 存储节点变量名 +let storageNodeKeys = [ + constant.avatar, + constant.id, + constant.name, + constant.roles, + constant.permissions, +]; + +const storage = { + set: function (key, value) { + if (storageNodeKeys.indexOf(key) != -1) { + let tmp = uni.getStorageSync(storageKey); + tmp = tmp ? tmp : {}; + tmp[key] = value; + uni.setStorageSync(storageKey, tmp); + } + }, + get: function (key) { + let storageData = uni.getStorageSync(storageKey) || {}; + return storageData[key] || ""; + }, + remove: function (key) { + let storageData = uni.getStorageSync(storageKey) || {}; + delete storageData[key]; + uni.setStorageSync(storageKey, storageData); + }, + clean: function () { + uni.removeStorageSync(storageKey); + }, +}; + +export default storage; diff --git a/shierfeng-fastapi-app/src/utils/transportCrypto.js b/shierfeng-fastapi-app/src/utils/transportCrypto.js new file mode 100644 index 0000000..0251aa6 --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/transportCrypto.js @@ -0,0 +1,1236 @@ +import config from "@/config"; +import forge, { primeForgeRandomBytes } from "@/utils/transportForge"; +import { + ensureTransportCryptoPolicyLoaded, + getTransportCryptoPolicy, + getTransportRequestPath, + shouldEncryptQuery, + shouldEncryptRequest, + shouldEncryptResponse, +} from "@/utils/transportCryptoPolicy"; + +const TRANSPORT_BASE_URL = config.baseUrl; +const TRANSPORT_ENABLE_HEADER = "X-Transport-Encrypt"; +const TRANSPORT_KEY_ID_HEADER = "X-Key-Id"; +const ENCRYPTED_RESPONSE_HEADER = "x-body-encrypted"; +const DEFAULT_TRANSPORT_ENVELOPE_VERSION = "1"; +const KEY_REFRESH_BUFFER_MIN_SECONDS = 30; +const KEY_REFRESH_BUFFER_MAX_SECONDS = 300; +const TRANSPORT_KEY_META_CACHE_KEY = "transportCryptoKeyMeta"; +const TRANSPORT_RETRYABLE_ERROR_MESSAGES = new Set([ + "Decryption failed", + "密钥版本不存在", +]); +const AES_GCM_TAG_LENGTH_BYTES = 16; +const FORGE_RANDOM_POOL_BYTES = 4096; + +let cachedKeyMeta = null; +let inflightKeyMetaPromise = null; + +/** + * 获取当前运行时的全局对象引用。 + * + * @returns {Object|undefined} 全局对象 + */ +function getRuntimeGlobal() { + if (typeof globalThis !== "undefined") { + return globalThis; + } + if (typeof self !== "undefined") { + return self; + } + if (typeof window !== "undefined") { + return window; + } + if (typeof global !== "undefined") { + return global; + } + return undefined; +} + +/** + * 为 Forge 补齐运行时依赖的全局对象别名。 + * + * @returns {void} + */ +function ensureForgeRuntimeGlobal() { + const runtimeGlobal = getRuntimeGlobal(); + if (!runtimeGlobal) { + return; + } + if (typeof runtimeGlobal.self === "undefined") { + runtimeGlobal.self = runtimeGlobal; + } + if (typeof runtimeGlobal.window === "undefined") { + runtimeGlobal.window = runtimeGlobal; + } + if (typeof runtimeGlobal.global === "undefined") { + runtimeGlobal.global = runtimeGlobal; + } +} + +/** + * 获取已完成运行时适配的 Forge 实例。 + * + * @returns {Promise} Forge 实例 + */ +async function getForge() { + ensureForgeRuntimeGlobal(); + return forge; +} + +/** + * 从请求头对象中读取指定字段。 + * + * @param {Object} headers 请求头对象 + * @param {string} name 请求头名称 + * @returns {*} 请求头值 + */ +function getHeaderValue(headers, name) { + if (!headers) { + return undefined; + } + return headers[name] ?? headers[name.toLowerCase()] ?? headers[name.toUpperCase()]; +} + +/** + * 为请求头对象设置指定字段。 + * + * @param {Object} headers 请求头对象 + * @param {string} name 请求头名称 + * @param {*} value 请求头值 + * @returns {void} + */ +function setHeaderValue(headers, name, value) { + if (!headers) { + return; + } + headers[name] = value; +} + +/** + * 获取 Uni 响应对象中的响应头映射,兼容 H5 与其它平台字段差异。 + * + * @param {Object} response Uni 响应对象 + * @returns {Object|undefined} 响应头对象 + */ +function getResponseHeaders(response) { + return response?.header || response?.headers; +} + +/** + * 将文本编码为 UTF-8 二进制字符串。 + * + * @param {string} text 原始文本 + * @returns {string} UTF-8 二进制字符串 + */ +function encodeUtf8(text) { + if (typeof TextEncoder !== "undefined") { + return uint8ArrayToBytes(new TextEncoder().encode(String(text || ""))); + } + return unescape(encodeURIComponent(String(text || ""))); +} + +/** + * 将 UTF-8 二进制字符串解码为文本。 + * + * @param {string} bytes UTF-8 二进制字符串 + * @returns {string} 解码后的文本 + */ +function decodeUtf8(bytes) { + if (typeof TextDecoder !== "undefined") { + return new TextDecoder().decode(bytesToUint8Array(bytes)); + } + return decodeURIComponent(escape(bytes)); +} + +/** + * 将 Uint8Array 转为 Forge 兼容的二进制字符串。 + * + * @param {Uint8Array} uint8Array 字节数组 + * @returns {string} 二进制字符串 + */ +function uint8ArrayToBytes(uint8Array) { + return Array.from(uint8Array, (item) => String.fromCharCode(item)).join(""); +} + +/** + * 将二进制字符串还原为 Uint8Array。 + * + * @param {string} bytes 二进制字符串 + * @returns {Uint8Array} 字节数组 + */ +function bytesToUint8Array(bytes) { + return Uint8Array.from(String(bytes || ""), (item) => item.charCodeAt(0)); +} + +/** + * 获取对象的内部类型标签。 + * + * @param {*} value 待检测值 + * @returns {string} 内部类型标签 + */ +function getObjectTag(value) { + return Object.prototype.toString.call(value); +} + +/** + * 判断对象是否为 ArrayBuffer 视图。 + * + * @param {*} value 待检测值 + * @returns {boolean} 是否为视图对象 + */ +function isArrayBufferView(value) { + return typeof ArrayBuffer !== "undefined" && ArrayBuffer.isView(value); +} + +/** + * 判断对象是否表现为 ArrayBuffer。 + * + * @param {*} value 待检测值 + * @returns {boolean} 是否可按 ArrayBuffer 处理 + */ +function isArrayBufferLike(value) { + return ( + value instanceof ArrayBuffer || + getObjectTag(value) === "[object ArrayBuffer]" || + (value && + typeof value === "object" && + typeof value.byteLength === "number" && + typeof value.slice === "function" && + !("length" in value)) + ); +} + +/** + * 判断对象是否为数组风格的字节容器。 + * + * @param {*} value 待检测值 + * @returns {boolean} 是否可按字节数组处理 + */ +function isByteArrayLikeObject(value) { + return ( + value && + typeof value === "object" && + typeof value.length === "number" && + value.length >= 0 + ); +} + +/** + * 尝试通过平台 Base64 API 归一化原生 ArrayBuffer 对象。 + * + * @param {*} randomValues 平台返回的随机数字节对象 + * @returns {string|null} 归一化后的字节串,失败时返回 null + */ +function tryNormalizeArrayBufferLikeResult(randomValues) { + const arrayBufferToBase64Api = + (typeof uni !== "undefined" && uni.arrayBufferToBase64) || + (typeof wx !== "undefined" && wx.arrayBufferToBase64); + const base64ToArrayBufferApi = + (typeof uni !== "undefined" && uni.base64ToArrayBuffer) || + (typeof wx !== "undefined" && wx.base64ToArrayBuffer); + + if (!arrayBufferToBase64Api || !base64ToArrayBufferApi) { + return null; + } + + try { + const base64Text = arrayBufferToBase64Api(randomValues); + const arrayBuffer = base64ToArrayBufferApi(base64Text); + return uint8ArrayToBytes(new Uint8Array(arrayBuffer)); + } catch (error) { + return null; + } +} + +/** + * 将平台返回的随机数字节结果统一转换为二进制字符串。 + * + * @param {*} randomValues 平台返回结果 + * @param {number} expectedLength 期望字节长度 + * @returns {string} 归一化后的二进制字符串 + */ +function normalizeRandomBytesResult(randomValues, expectedLength) { + if (randomValues instanceof Uint8Array) { + return uint8ArrayToBytes(randomValues); + } + if (isArrayBufferView(randomValues)) { + return uint8ArrayToBytes( + new Uint8Array( + randomValues.buffer, + randomValues.byteOffset || 0, + randomValues.byteLength, + ), + ); + } + if (randomValues instanceof ArrayBuffer) { + return uint8ArrayToBytes(new Uint8Array(randomValues)); + } + if (Array.isArray(randomValues)) { + return uint8ArrayToBytes(Uint8Array.from(randomValues)); + } + if (randomValues && typeof randomValues === "object") { + if (randomValues.randomValues) { + return normalizeRandomBytesResult( + randomValues.randomValues, + expectedLength, + ); + } + if (randomValues.value) { + return normalizeRandomBytesResult(randomValues.value, expectedLength); + } + if (randomValues.data) { + return normalizeRandomBytesResult(randomValues.data, expectedLength); + } + if (randomValues.buffer instanceof ArrayBuffer) { + return normalizeRandomBytesResult( + new Uint8Array( + randomValues.buffer, + randomValues.byteOffset || 0, + randomValues.byteLength || expectedLength, + ), + expectedLength, + ); + } + if (isArrayBufferLike(randomValues)) { + const normalizedBytes = tryNormalizeArrayBufferLikeResult(randomValues); + if (normalizedBytes !== null) { + return normalizedBytes; + } + } + if (isByteArrayLikeObject(randomValues)) { + return uint8ArrayToBytes(Uint8Array.from(randomValues)); + } + } + if (typeof randomValues === "string" && randomValues.length === expectedLength) { + return randomValues; + } + throw new Error( + `平台随机数返回结果格式不受支持: tag=${getObjectTag(randomValues)}, keys=${Object.keys( + randomValues || {}, + ).join(",")}`, + ); +} + +/** + * 请求平台随机数字节并统一为二进制字符串。 + * + * @param {Function} api 平台随机数 API + * @param {number} length 需要的字节长度 + * @returns {Promise} 随机数字节串 + */ +function requestPlatformRandomBytes(api, length) { + return new Promise((resolve, reject) => { + let settled = false; + const resolveOnce = (result) => { + if (settled) { + return; + } + settled = true; + resolve(normalizeRandomBytesResult(result, length)); + }; + const rejectOnce = (error) => { + if (settled) { + return; + } + settled = true; + reject(error); + }; + + try { + const maybeResult = api({ + length, + success: resolveOnce, + fail: rejectOnce, + }); + if (maybeResult && typeof maybeResult.then === "function") { + maybeResult.then(resolveOnce).catch(rejectOnce); + return; + } + if ( + maybeResult && + (maybeResult.randomValues || maybeResult.value || maybeResult.data) + ) { + resolveOnce(maybeResult); + } + } catch (error) { + rejectOnce(error); + } + }); +} + +/** + * 在 app-plus iOS 端通过原生 NSUUID 获取随机字节兜底。 + * + * @param {number} length 需要的字节长度 + * @returns {string|null} 随机数字节串,当前平台不支持时返回 null + */ +function getAppPlusIosRandomBytes(length) { + // #ifdef APP-PLUS + if (typeof plus === "undefined") { + return null; + } + const osName = String(plus.os?.name || "").toLowerCase(); + if (osName !== "ios" || typeof plus.ios?.importClass !== "function") { + return null; + } + + try { + const uuidClass = plus.ios.importClass("NSUUID"); + let randomBytes = ""; + while (randomBytes.length < length) { + const uuidObject = plus.ios.invoke(uuidClass, "UUID"); + const uuidText = String(plus.ios.invoke(uuidObject, "UUIDString") || "") + .replace(/-/g, "") + .toLowerCase(); + plus.ios.deleteObject(uuidObject); + if (!uuidText) { + return null; + } + for (let index = 0; index < uuidText.length && randomBytes.length < length; index += 2) { + const byteValue = parseInt(uuidText.slice(index, index + 2), 16); + if (isNaN(byteValue)) { + return null; + } + randomBytes += String.fromCharCode(byteValue); + } + } + return randomBytes; + } catch (error) { + console.warn("iOS NSUUID 初始化失败,继续尝试其它随机数能力", error); + } + // #endif + return null; +} + +/** + * 在 app-plus Android 端通过原生 SecureRandom 获取随机字节。 + * + * @param {number} length 需要的字节长度 + * @returns {string|null} 随机数字节串,当前平台不支持时返回 null + */ +function getAppPlusAndroidRandomBytes(length) { + // #ifdef APP-PLUS + if (typeof plus === "undefined") { + return null; + } + const osName = String(plus.os?.name || "").toLowerCase(); + if (osName !== "android" || typeof plus.android?.importClass !== "function") { + return null; + } + + try { + plus.android.importClass("java.security.SecureRandom"); + const secureRandom = + typeof plus.android.newObject === "function" + ? plus.android.newObject("java.security.SecureRandom") + : null; + if (!secureRandom) { + return null; + } + plus.android.importClass(secureRandom); + let randomBytes = ""; + for (let index = 0; index < length; index += 1) { + randomBytes += String.fromCharCode(secureRandom.nextInt(256)); + } + if (typeof plus.android.autoCollection === "function") { + plus.android.autoCollection(secureRandom); + } + return randomBytes; + } catch (error) { + console.warn("Android SecureRandom 初始化失败,继续尝试其它随机数能力", error); + } + // #endif + return null; +} + +/** + * 获取当前运行环境下的安全随机数字节。 + * + * @param {number} length 需要的字节长度 + * @returns {Promise} 随机数字节串 + */ +async function getRandomBytes(length) { + const runtimeGlobal = getRuntimeGlobal(); + const runtimeCrypto = runtimeGlobal?.crypto; + if (runtimeCrypto?.getRandomValues) { + const bytes = new Uint8Array(length); + runtimeCrypto.getRandomValues(bytes); + return uint8ArrayToBytes(bytes); + } + if (typeof uni !== "undefined" && typeof uni.getRandomValues === "function") { + return requestPlatformRandomBytes(uni.getRandomValues, length); + } + if (typeof wx !== "undefined" && typeof wx.getRandomValues === "function") { + return requestPlatformRandomBytes(wx.getRandomValues, length); + } + const appPlusRandomBytes = + getAppPlusAndroidRandomBytes(length) || getAppPlusIosRandomBytes(length); + if (appPlusRandomBytes !== null) { + return appPlusRandomBytes; + } + throw new Error("当前运行环境缺少安全随机数能力"); +} + +/** + * 预填充 Forge 需要的随机数字节池。 + * + * @param {number} length 预填充长度 + * @returns {Promise} + */ +async function primeForgeRandomPool(length = FORGE_RANDOM_POOL_BYTES) { + primeForgeRandomBytes(await getRandomBytes(length)); +} + +/** + * 将二进制字符串编码为 Base64URL 文本。 + * + * @param {string} bytes 二进制字符串 + * @returns {string} Base64URL 文本 + */ +function toBase64Url(bytes) { + const base64Text = uni.arrayBufferToBase64(bytesToUint8Array(bytes).buffer); + return base64Text.replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/g, ""); +} + +/** + * 将 Base64URL 文本还原为二进制字符串。 + * + * @param {string} text Base64URL 文本 + * @returns {string} 二进制字符串 + */ +function fromBase64Url(text) { + const normalizedText = String(text || "").replace(/-/g, "+").replace(/_/g, "/"); + const paddingLength = (4 - (normalizedText.length % 4 || 4)) % 4; + const arrayBuffer = uni.base64ToArrayBuffer( + normalizedText + "=".repeat(paddingLength), + ); + return uint8ArrayToBytes(new Uint8Array(arrayBuffer)); +} + +/** + * 将查询信封编码为可放入 URL 的字符串。 + * + * @param {Object} envelope 查询信封 + * @returns {string} 编码后的查询参数值 + */ +function encodeQueryEnvelope(envelope) { + return toBase64Url(encodeUtf8(JSON.stringify(envelope))); +} + +/** + * 计算加密查询参数最终生成的 URL 长度。 + * + * @param {string} url 请求地址 + * @param {Object} params 查询参数 + * @returns {number} URL 长度 + */ +function buildQueryUrlLength(url = "", params = {}) { + const queryText = Object.keys(params) + .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`) + .join("&"); + if (!queryText) { + return String(url || "").length; + } + const normalizedUrl = String(url || ""); + const separator = normalizedUrl.includes("?") ? "&" : "?"; + return `${normalizedUrl}${separator}${queryText}`.length; +} + +/** + * 构建请求方向的 AAD 元数据。 + * + * @param {Object} requestConfig 请求配置 + * @returns {Object} 请求 AAD + */ +function buildRequestAad(requestConfig) { + return { + method: (requestConfig.method || "get").toUpperCase(), + path: getTransportRequestPath( + requestConfig.url, + requestConfig.baseUrl || TRANSPORT_BASE_URL, + ), + }; +} + +/** + * 构建响应方向的 AAD 元数据。 + * + * @param {Object} requestConfig 请求配置 + * @returns {Object} 响应 AAD + */ +function buildResponseAad(requestConfig) { + return { + method: (requestConfig.method || "get").toUpperCase(), + path: getTransportRequestPath( + requestConfig.url, + requestConfig.baseUrl || TRANSPORT_BASE_URL, + ), + direction: "response", + }; +} + +/** + * 将空值载荷规范化为可序列化对象。 + * + * @param {*} payload 原始载荷 + * @returns {*} 规范化后的载荷 + */ +function normalizePlainPayload(payload) { + if (payload === undefined || payload === null) { + return {}; + } + return payload; +} + +/** + * 将请求载荷序列化为 JSON 文本。 + * + * @param {*} payload 原始载荷 + * @returns {string} JSON 文本 + */ +function stringifyPayload(payload) { + return JSON.stringify(normalizePlainPayload(payload)); +} + +/** + * 克隆请求配置中的可变字段,便于失败重试恢复。 + * + * @param {*} value 待克隆值 + * @returns {*} 克隆结果 + */ +function cloneRequestValue(value) { + if (value === undefined || value === null) { + return value; + } + const runtimeGlobal = getRuntimeGlobal(); + if (typeof runtimeGlobal?.structuredClone === "function") { + return runtimeGlobal.structuredClone(value); + } + if (typeof value === "object") { + return JSON.parse(JSON.stringify(value)); + } + return value; +} + +/** + * 将信封字段转换为适合表单提交的字符串。 + * + * @param {*} value 字段值 + * @returns {string} 序列化文本 + */ +function stringifyEnvelopeField(value) { + if (value && typeof value === "object") { + return JSON.stringify(value); + } + return String(value); +} + +/** + * 将加密信封编码为 x-www-form-urlencoded 文本。 + * + * @param {Object} envelope 信封对象 + * @returns {string} 表单编码文本 + */ +function encodeFormEnvelope(envelope) { + return Object.entries(envelope) + .map( + ([key, value]) => + `${encodeURIComponent(key)}=${encodeURIComponent( + stringifyEnvelopeField(value), + )}`, + ) + .join("&"); +} + +/** + * 将输入解析为 JSON 对象并校验结构。 + * + * @param {*} payload 原始数据 + * @param {string} errorMessage 失败提示 + * @returns {Object} 解析后的对象 + */ +function parseJsonObject(payload, errorMessage) { + const parsedPayload = typeof payload === "string" ? JSON.parse(payload) : payload; + if (!parsedPayload || typeof parsedPayload !== "object" || Array.isArray(parsedPayload)) { + throw new Error(errorMessage); + } + return parsedPayload; +} + +/** + * 基于随机字节生成 UUID v4 字符串。 + * + * @returns {Promise} UUID 文本 + */ +async function createUuid() { + const bytes = (await getRandomBytes(16)) + .split("") + .map((item) => item.charCodeAt(0)); + bytes[6] = (bytes[6] & 0x0f) | 0x40; + bytes[8] = (bytes[8] & 0x3f) | 0x80; + const hexText = bytes + .map((item) => item.toString(16).padStart(2, "0")) + .join(""); + return `${hexText.slice(0, 8)}-${hexText.slice(8, 12)}-${hexText.slice( + 12, + 16, + )}-${hexText.slice(16, 20)}-${hexText.slice(20)}`; +} + +/** + * 校验公钥接口响应壳是否有效。 + * + * @param {Object} responsePayload 公钥接口原始响应 + * @returns {void} + */ +function validateTransportPublicKeyResponse(responsePayload) { + if ( + responsePayload?.code !== 200 || + !responsePayload?.data || + typeof responsePayload.data !== "object" + ) { + throw new Error(responsePayload?.msg || "获取传输层公钥失败"); + } +} + +/** + * 校验公钥业务载荷是否满足当前协议要求。 + * + * @param {Object} payload 公钥业务载荷 + * @param {Object} transportPolicy 当前传输策略 + * @returns {void} + */ +function validateTransportPublicKeyPayload(payload, transportPolicy) { + if (!payload?.publicKey || !payload?.kid) { + throw new Error("获取传输层公钥失败"); + } + if ( + String(payload.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION) !== + transportPolicy.envelopeVersion + ) { + throw new Error("传输层公钥协议版本不受支持"); + } + if (payload.alg !== transportPolicy.requestEnvelopeAlgorithm) { + throw new Error("传输层公钥算法不受支持"); + } +} + +/** + * 校验响应信封与当前请求上下文是否一致。 + * + * @param {Object} envelope 响应信封 + * @param {Object} response 原始响应对象 + * @param {Object} requestConfig 请求配置 + * @param {Object} transportContext 请求加密上下文 + * @param {Object} transportPolicy 当前传输策略 + * @returns {void} + */ +function validateResponseEnvelope( + envelope, + response, + requestConfig, + transportContext, + transportPolicy, +) { + const expectedAad = buildResponseAad(requestConfig); + const responseKid = getHeaderValue( + getResponseHeaders(response), + TRANSPORT_KEY_ID_HEADER, + ); + const aad = envelope.aad; + + if (String(envelope.v || "") !== transportPolicy.envelopeVersion) { + throw new Error("传输层响应协议版本不受支持"); + } + if (String(envelope.alg || "") !== transportPolicy.responseEnvelopeAlgorithm) { + throw new Error("传输层响应算法不受支持"); + } + if (String(envelope.kid || "") !== String(transportContext.kid)) { + throw new Error("传输层响应密钥版本不匹配"); + } + if (responseKid && String(envelope.kid) !== String(responseKid)) { + throw new Error("传输层响应头与响应体密钥版本不一致"); + } + if (!aad || typeof aad !== "object" || Array.isArray(aad)) { + throw new Error("传输层响应AAD不合法"); + } + if ( + String(aad.method || "").toUpperCase() !== expectedAad.method || + String(aad.path || "") !== expectedAad.path + ) { + throw new Error("传输层响应的method/path与当前请求不匹配"); + } + if (String(aad.direction || "") !== expectedAad.direction) { + throw new Error("传输层响应方向标识不合法"); + } +} + +/** + * 记录原始请求快照,供密钥刷新后重试恢复。 + * + * @param {Object} requestConfig 请求配置 + * @returns {void} + */ +function rememberOriginalRequestSnapshot(requestConfig) { + if (requestConfig.__transportOriginalSnapshot) { + return; + } + requestConfig.__transportOriginalSnapshot = { + url: requestConfig.url, + params: cloneRequestValue(requestConfig.params), + data: cloneRequestValue(requestConfig.data), + contentType: getHeaderValue(requestConfig.header, "Content-Type"), + }; +} + +/** + * 获取当前 Unix 秒级时间戳。 + * + * @returns {number} 当前时间戳 + */ +function getNowTimestamp() { + return Math.floor(Date.now() / 1000); +} + +/** + * 根据公钥有效期计算本地提前刷新时间。 + * + * @param {number} expireAt 公钥过期时间 + * @param {number} fetchedAt 公钥获取时间 + * @returns {number} 建议刷新时间 + */ +function buildKeyRefreshAt(expireAt, fetchedAt = getNowTimestamp()) { + const normalizedExpireAt = Number(expireAt || 0); + const normalizedFetchedAt = Number(fetchedAt || 0); + const ttlSeconds = Math.max(normalizedExpireAt - normalizedFetchedAt, 0); + if (!normalizedExpireAt || !ttlSeconds) { + return 0; + } + const refreshBufferSeconds = Math.min( + KEY_REFRESH_BUFFER_MAX_SECONDS, + Math.max(KEY_REFRESH_BUFFER_MIN_SECONDS, Math.floor(ttlSeconds * 0.1)), + ); + return Math.max(normalizedFetchedAt, normalizedExpireAt - refreshBufferSeconds); +} + +/** + * 判断当前缓存的公钥元数据是否仍可使用。 + * + * @param {Object} keyMeta 公钥元数据 + * @param {number} nowTimestamp 当前时间戳 + * @returns {boolean} 是否仍可使用 + */ +function isUsableKeyMeta(keyMeta, nowTimestamp = getNowTimestamp()) { + if (!keyMeta?.publicKeyPem || !keyMeta?.kid || !keyMeta?.expireAt) { + return false; + } + const refreshAt = Number( + keyMeta.refreshAt || + buildKeyRefreshAt(keyMeta.expireAt, keyMeta.fetchedAt || nowTimestamp), + ); + return refreshAt > nowTimestamp; +} + +/** + * 请求后端公钥接口。 + * 这里故意直接使用原始 uni.request,避免在获取公钥前再次进入统一 request + * 包装器而形成“加密请求依赖公钥、公钥请求又依赖加密请求”的启动环路。 + * + * @param {string} publicKeyUrl 公钥接口地址 + * @returns {Promise} Uni 请求响应 + */ +function requestPublicKey(publicKeyUrl) { + return new Promise((resolve, reject) => { + uni.request({ + url: `${TRANSPORT_BASE_URL}${publicKeyUrl}`, + method: "GET", + timeout: 10000, + success: resolve, + fail: reject, + }); + }); +} + +/** + * 获取当前可用的后端公钥元信息。 + * + * @param {boolean} forceRefresh 是否强制刷新 + * @returns {Promise} 公钥元信息 + */ +async function getTransportKeyMeta(forceRefresh = false) { + const transportPolicy = await ensureTransportCryptoPolicyLoaded(); + const nowTimestamp = getNowTimestamp(); + if (!forceRefresh && !cachedKeyMeta) { + const persistedKeyMeta = uni.getStorageSync(TRANSPORT_KEY_META_CACHE_KEY); + if (isUsableKeyMeta(persistedKeyMeta, nowTimestamp)) { + cachedKeyMeta = { + kid: persistedKeyMeta.kid, + alg: persistedKeyMeta.alg, + envelopeVersion: + persistedKeyMeta.envelopeVersion || transportPolicy.envelopeVersion, + publicKeyPem: persistedKeyMeta.publicKeyPem, + expireAt: persistedKeyMeta.expireAt, + fetchedAt: persistedKeyMeta.fetchedAt || nowTimestamp, + refreshAt: + persistedKeyMeta.refreshAt || + buildKeyRefreshAt( + persistedKeyMeta.expireAt, + persistedKeyMeta.fetchedAt || nowTimestamp, + ), + }; + } + } + if (!forceRefresh && isUsableKeyMeta(cachedKeyMeta, nowTimestamp)) { + return cachedKeyMeta; + } + if (inflightKeyMetaPromise) { + return inflightKeyMetaPromise; + } + inflightKeyMetaPromise = requestPublicKey( + transportPolicy.publicKeyUrl || "/transport/crypto/public-key", + ) + .then((response) => { + const responsePayload = response.data || {}; + const payload = responsePayload.data || {}; + const fetchedAt = getNowTimestamp(); + validateTransportPublicKeyResponse(responsePayload); + validateTransportPublicKeyPayload(payload, transportPolicy); + cachedKeyMeta = { + kid: payload.kid, + alg: payload.alg, + envelopeVersion: String( + payload.envelopeVersion || transportPolicy.envelopeVersion, + ), + publicKeyPem: payload.publicKey, + expireAt: payload.expireAt, + fetchedAt, + refreshAt: buildKeyRefreshAt(payload.expireAt, fetchedAt), + }; + uni.setStorageSync(TRANSPORT_KEY_META_CACHE_KEY, cachedKeyMeta); + inflightKeyMetaPromise = null; + return cachedKeyMeta; + }) + .catch((error) => { + inflightKeyMetaPromise = null; + throw error; + }); + return inflightKeyMetaPromise; +} + +/** + * 使用 RSA-OAEP 加密当前请求的 AES 会话密钥。 + * + * @param {string} publicKeyPem PEM 格式公钥 + * @param {string} aesKeyBytes AES 会话密钥字节串 + * @returns {Promise} 加密后的会话密钥 + */ +async function rsaEncryptAesKey(publicKeyPem, aesKeyBytes) { + const cryptoForge = await getForge(); + await primeForgeRandomPool(); + const publicKey = cryptoForge.pki.publicKeyFromPem(String(publicKeyPem || "")); + return publicKey.encrypt(aesKeyBytes, "RSA-OAEP", { + md: cryptoForge.md.sha256.create(), + mgf1: { + md: cryptoForge.md.sha256.create(), + }, + }); +} + +/** + * 为当前请求构建一次性的传输加密上下文。 + * + * @returns {Promise} 请求级传输上下文 + */ +async function buildTransportContext() { + const keyMeta = await getTransportKeyMeta(); + const aesKey = await getRandomBytes(32); + const encryptedAesKey = await rsaEncryptAesKey(keyMeta.publicKeyPem, aesKey); + return { + kid: keyMeta.kid, + alg: keyMeta.alg, + envelopeVersion: keyMeta.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION, + aesKey, + ek: toBase64Url(encryptedAesKey), + }; +} + +/** + * 使用 AES-GCM 对明文载荷执行信封加密。 + * + * @param {Object} context 请求级传输上下文 + * @param {string} plainText 明文内容 + * @param {Object} aad AAD 元数据 + * @returns {Promise} 加密信封 + */ +async function encryptPayloadText(context, plainText, aad) { + const cryptoForge = await getForge(); + const iv = await getRandomBytes(12); + const cipher = cryptoForge.cipher.createCipher("AES-GCM", context.aesKey); + cipher.start({ + iv, + additionalData: encodeUtf8(JSON.stringify(aad)), + tagLength: AES_GCM_TAG_LENGTH_BYTES * 8, + }); + cipher.update(cryptoForge.util.createBuffer(encodeUtf8(plainText))); + if (!cipher.finish()) { + throw new Error("Encryption failed"); + } + const ciphertext = cipher.output.getBytes() + cipher.mode.tag.getBytes(); + return { + v: context.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION, + kid: context.kid, + alg: context.alg, + ts: getNowTimestamp(), + nonce: await createUuid(), + ek: context.ek, + aad, + iv: toBase64Url(iv), + ct: toBase64Url(ciphertext), + }; +} + +/** + * 使用请求上下文中的 AES 密钥解密响应信封。 + * + * @param {Object} envelope 响应信封 + * @param {Object} context 请求级传输上下文 + * @returns {Promise} 解密后的明文 + */ +async function decryptEnvelope(envelope, context) { + const cryptoForge = await getForge(); + const encryptedPayload = fromBase64Url(envelope.ct); + if (encryptedPayload.length <= AES_GCM_TAG_LENGTH_BYTES) { + throw new Error("Decryption failed"); + } + const ciphertext = encryptedPayload.slice(0, -AES_GCM_TAG_LENGTH_BYTES); + const tag = encryptedPayload.slice(-AES_GCM_TAG_LENGTH_BYTES); + const decipher = cryptoForge.cipher.createDecipher("AES-GCM", context.aesKey); + decipher.start({ + iv: fromBase64Url(envelope.iv), + additionalData: encodeUtf8(JSON.stringify(envelope.aad || {})), + tagLength: AES_GCM_TAG_LENGTH_BYTES * 8, + tag, + }); + decipher.update(cryptoForge.util.createBuffer(ciphertext)); + if (!decipher.finish()) { + throw new Error("Decryption failed"); + } + return decodeUtf8(decipher.output.getBytes()); +} + +/** + * 复用同一次请求内的传输上下文,避免重复生成密钥。 + * + * @param {Object} requestConfig 请求配置 + * @returns {Promise} 请求级传输上下文 + */ +function getOrCreateTransportContext(requestConfig) { + if (requestConfig.__transportCryptoContextPromise) { + return requestConfig.__transportCryptoContextPromise; + } + requestConfig.__transportCryptoContextPromise = buildTransportContext(); + return requestConfig.__transportCryptoContextPromise; +} + +/** + * 对 Uni 请求配置执行传输层加密封装。 + * + * @param {Object} requestConfig 请求配置 + * @returns {Promise} 加密后的请求配置 + */ +export async function encryptTransportRequest(requestConfig) { + const transportPolicy = await ensureTransportCryptoPolicyLoaded(); + if (!shouldEncryptRequest(requestConfig, transportPolicy)) { + requestConfig.__transportCryptoEnabledForRequest = false; + return requestConfig; + } + + rememberOriginalRequestSnapshot(requestConfig); + const transportContext = await getOrCreateTransportContext(requestConfig); + const contentType = String( + getHeaderValue(requestConfig.header, "Content-Type") || "application/json", + ).toLowerCase(); + const method = (requestConfig.method || "get").toLowerCase(); + const requestAad = buildRequestAad(requestConfig); + + if ( + shouldEncryptQuery(requestConfig, transportPolicy) && + (requestConfig.params || method === "get" || method === "delete") + ) { + const queryEnvelope = await encryptPayloadText( + transportContext, + JSON.stringify(normalizePlainPayload(requestConfig.params)), + requestAad, + ); + requestConfig.params = { __enc: encodeQueryEnvelope(queryEnvelope) }; + if ( + buildQueryUrlLength(requestConfig.url, requestConfig.params) > + Number(transportPolicy.maxEncryptedGetUrlLength || 4096) + ) { + throw new Error( + "当前GET/DELETE请求参数加密后长度超限,请改用POST请求或精简查询条件", + ); + } + } + + if (["post", "put", "patch", "delete"].includes(method)) { + const plainText = stringifyPayload(requestConfig.data); + const bodyEnvelope = await encryptPayloadText( + transportContext, + plainText, + requestAad, + ); + if (contentType.includes("application/x-www-form-urlencoded")) { + requestConfig.data = encodeFormEnvelope(bodyEnvelope); + } else { + requestConfig.data = bodyEnvelope; + setHeaderValue( + requestConfig.header, + "Content-Type", + "application/json;charset=utf-8", + ); + } + } + + setHeaderValue(requestConfig.header, TRANSPORT_ENABLE_HEADER, "1"); + setHeaderValue(requestConfig.header, TRANSPORT_KEY_ID_HEADER, transportContext.kid); + requestConfig.__transportCryptoContext = transportContext; + requestConfig.__transportCryptoEnabledForRequest = true; + return requestConfig; +} + +/** + * 清空当前缓存的公钥元数据。 + * + * @returns {void} + */ +export function invalidateTransportKeyMeta() { + cachedKeyMeta = null; + inflightKeyMetaPromise = null; + uni.removeStorageSync(TRANSPORT_KEY_META_CACHE_KEY); +} + +/** + * 将被加密改写过的请求恢复为原始形态。 + * + * @param {Object} requestConfig 请求配置 + * @returns {Object} 恢复后的请求配置 + */ +export function resetTransportRequestConfig(requestConfig) { + const originalSnapshot = requestConfig?.__transportOriginalSnapshot; + if (!requestConfig || !originalSnapshot) { + return requestConfig; + } + + requestConfig.url = originalSnapshot.url; + requestConfig.params = cloneRequestValue(originalSnapshot.params); + requestConfig.data = cloneRequestValue(originalSnapshot.data); + if (originalSnapshot.contentType) { + setHeaderValue(requestConfig.header, "Content-Type", originalSnapshot.contentType); + } + delete requestConfig.__transportCryptoContext; + delete requestConfig.__transportCryptoContextPromise; + delete requestConfig.__transportCryptoEnabledForRequest; + return requestConfig; +} + +/** + * 判断错误是否属于可通过刷新公钥进行重试的场景。 + * + * @param {Object} responseOrError 响应对象或错误对象 + * @returns {boolean} 是否可刷新密钥重试 + */ +export function shouldRetryTransportWithFreshKey(responseOrError) { + const responseMsg = responseOrError?.data?.msg || responseOrError?.response?.data?.msg; + const errorMessage = responseOrError?.message; + return ( + TRANSPORT_RETRYABLE_ERROR_MESSAGES.has(responseMsg) || + TRANSPORT_RETRYABLE_ERROR_MESSAGES.has(errorMessage) + ); +} + +/** + * 解密成功响应中的传输层信封。 + * + * @param {Object} response 原始响应对象 + * @param {Object} requestConfig 请求配置 + * @returns {Promise} 解密后的响应对象 + */ +export async function decryptTransportResponse(response, requestConfig) { + const encryptedResponseFlag = String( + getHeaderValue(getResponseHeaders(response), ENCRYPTED_RESPONSE_HEADER) || "", + ); + if (encryptedResponseFlag !== "1") { + return response; + } + if (!shouldEncryptResponse(requestConfig, getTransportCryptoPolicy())) { + return response; + } + const transportPolicy = getTransportCryptoPolicy(); + const transportContext = requestConfig.__transportCryptoContext; + if (!transportContext) { + throw new Error("缺少响应解密上下文"); + } + + const envelope = parseJsonObject(response.data, "传输层响应信封格式不合法"); + validateResponseEnvelope( + envelope, + response, + requestConfig, + transportContext, + transportPolicy, + ); + const plaintext = await decryptEnvelope(envelope, transportContext); + response.data = JSON.parse(plaintext); + return response; +} + +/** + * 尝试解密异常响应中的传输层信封。 + * + * @param {Object} error 错误对象 + * @param {Object} requestConfig 原始请求配置 + * @returns {Promise} 原始或已解密的错误对象 + */ +export async function decryptTransportErrorResponse(error, requestConfig) { + const response = + error?.response || + (error && (error.data !== undefined || error.header || error.headers || error.statusCode) + ? error + : null); + const encryptedResponseFlag = String( + getHeaderValue(getResponseHeaders(response), ENCRYPTED_RESPONSE_HEADER) || "", + ); + if (!response || encryptedResponseFlag !== "1") { + return error; + } + if (!shouldEncryptResponse(requestConfig || {}, getTransportCryptoPolicy())) { + return error; + } + const transportPolicy = getTransportCryptoPolicy(); + const transportContext = requestConfig?.__transportCryptoContext; + if (!transportContext) { + return error; + } + + try { + const envelope = parseJsonObject(response.data, "传输层响应信封格式不合法"); + validateResponseEnvelope( + envelope, + response, + requestConfig, + transportContext, + transportPolicy, + ); + const plaintext = await decryptEnvelope(envelope, transportContext); + response.data = JSON.parse(plaintext); + if (!error.response) { + error.response = response; + } + } catch (decryptError) { + console.error(decryptError); + } + return error; +} diff --git a/shierfeng-fastapi-app/src/utils/transportCryptoPolicy.js b/shierfeng-fastapi-app/src/utils/transportCryptoPolicy.js new file mode 100644 index 0000000..022d4ef --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/transportCryptoPolicy.js @@ -0,0 +1,436 @@ +import config from "@/config"; + +const TRANSPORT_BASE_URL = config.baseUrl; +const EXCLUDED_URL_PATTERNS = [ + "/transport/crypto/frontend-config", + "/transport/crypto/public-key", + "/common/download", + "/common/download/resource", +]; +const TRANSPORT_FRONTEND_CONFIG_CACHE_KEY = "transportCryptoFrontendConfig"; +const TRANSPORT_FRONTEND_CONFIG_URL = "/transport/crypto/frontend-config"; +const TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS = 60; +const DEFAULT_TRANSPORT_ENVELOPE_VERSION = "1"; +const DEFAULT_REQUEST_ENVELOPE_ALGORITHM = "RSA_OAEP_AES_256_GCM"; +const DEFAULT_RESPONSE_ENVELOPE_ALGORITHM = "AES_256_GCM"; +const DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH = 4096; + +let cachedTransportPolicy = null; +let inflightTransportPolicyPromise = null; + +/** + * 获取当前 Unix 秒级时间戳。 + * + * @returns {number} 当前时间戳 + */ +function getNowTimestamp() { + return Math.floor(Date.now() / 1000); +} + +/** + * 判断请求地址是否命中固定排除名单。 + * + * @param {string} url 请求地址 + * @returns {boolean} 是否命中排除规则 + */ +function matchExcludedUrl(url = "") { + return EXCLUDED_URL_PATTERNS.some((pattern) => url.includes(pattern)); +} + +/** + * 判断请求路径是否命中路径前缀列表。 + * + * @param {string} path 待匹配路径 + * @param {string[]} pathPatterns 路径前缀集合 + * @returns {boolean} 是否匹配成功 + */ +function matchPathPrefix(path = "", pathPatterns = []) { + return pathPatterns.some( + (pattern) => path === pattern || path.startsWith(`${pattern}/`), + ); +} + +/** + * 从绝对地址中提取 pathname,或直接返回相对地址的路径部分。 + * + * @param {string} url 请求地址 + * @returns {string} 标准化后的路径 + */ +function parseAbsoluteUrlPath(url = "") { + const normalizedUrl = String(url || ""); + if (!normalizedUrl) { + return "/"; + } + if ( + !normalizedUrl.startsWith("http://") && + !normalizedUrl.startsWith("https://") + ) { + return normalizedUrl.split("?")[0] || "/"; + } + const pathMatch = normalizedUrl.match(/^https?:\/\/[^/]+(\/[^?#]*)?/i); + return pathMatch?.[1] || "/"; +} + +/** + * 解析基础 API 地址对应的路径前缀。 + * + * @param {string} baseUrl 基础 API 地址 + * @returns {string} 基础路径前缀 + */ +function getBaseApiPath(baseUrl = TRANSPORT_BASE_URL) { + if (!baseUrl) { + return ""; + } + const baseApiPath = parseAbsoluteUrlPath(baseUrl); + return baseApiPath === "/" ? "" : baseApiPath; +} + +/** + * 计算后端用于 AAD 与策略匹配的标准请求路径。 + * + * @param {string} url 请求地址 + * @param {string} baseUrl 基础 API 地址 + * @returns {string} 标准化请求路径 + */ +function getRequestPath(url = "", baseUrl = TRANSPORT_BASE_URL) { + const baseApiPath = getBaseApiPath(baseUrl); + const pathname = parseAbsoluteUrlPath(url); + if (baseApiPath && pathname.startsWith(baseApiPath)) { + const normalizedPath = pathname.slice(baseApiPath.length); + return normalizedPath || "/"; + } + return pathname || "/"; +} + +/** + * 标准化后端下发的路径列表配置。 + * + * @param {Array} paths 原始路径集合 + * @returns {string[]} 标准化后的路径数组 + */ +function normalizePaths(paths) { + if (!Array.isArray(paths)) { + return []; + } + return paths.map((path) => String(path || "").trim()).filter(Boolean); +} + +/** + * 从请求头对象中读取指定字段。 + * + * @param {Object} headers 请求头对象 + * @param {string} name 请求头名称 + * @returns {*} 请求头值 + */ +function getHeaderValue(headers, name) { + if (!headers) { + return undefined; + } + return headers[name] ?? headers[name.toLowerCase()] ?? headers[name.toUpperCase()]; +} + +/** + * 将后端配置响应转换为前端统一使用的策略对象。 + * + * @param {Object} payload 后端返回的配置数据 + * @returns {Object} 标准化后的传输加密策略 + */ +function normalizeTransportPolicy(payload) { + return { + transportCryptoEnabled: Boolean(payload?.transportCryptoEnabled), + transportCryptoMode: String(payload?.transportCryptoMode || "off"), + transportCryptoActive: Boolean(payload?.transportCryptoActive), + envelopeVersion: String( + payload?.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION, + ), + publicKeyUrl: String(payload?.publicKeyUrl || "/transport/crypto/public-key"), + requestEnvelopeAlgorithm: String( + payload?.requestEnvelopeAlgorithm || DEFAULT_REQUEST_ENVELOPE_ALGORITHM, + ), + responseEnvelopeAlgorithm: String( + payload?.responseEnvelopeAlgorithm || DEFAULT_RESPONSE_ENVELOPE_ALGORITHM, + ), + enabledPaths: normalizePaths(payload?.enabledPaths), + requiredPaths: normalizePaths(payload?.requiredPaths), + excludePaths: normalizePaths(payload?.excludePaths), + maxEncryptedGetUrlLength: Number( + payload?.maxEncryptedGetUrlLength || DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH, + ), + configExpireAt: Number(payload?.configExpireAt || 0), + retryAt: Number(payload?.retryAt || payload?.configExpireAt || 0), + }; +} + +/** + * 构建不可用场景下的本地兜底策略。 + * + * @returns {Object} 明文回退策略 + */ +function buildFallbackTransportPolicy() { + const nowTimestamp = getNowTimestamp(); + return { + transportCryptoEnabled: false, + transportCryptoMode: "off", + transportCryptoActive: false, + envelopeVersion: DEFAULT_TRANSPORT_ENVELOPE_VERSION, + publicKeyUrl: "/transport/crypto/public-key", + requestEnvelopeAlgorithm: DEFAULT_REQUEST_ENVELOPE_ALGORITHM, + responseEnvelopeAlgorithm: DEFAULT_RESPONSE_ENVELOPE_ALGORITHM, + enabledPaths: [], + requiredPaths: [], + excludePaths: [...EXCLUDED_URL_PATTERNS], + maxEncryptedGetUrlLength: DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH, + configExpireAt: + nowTimestamp + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS, + retryAt: nowTimestamp + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS, + }; +} + +/** + * 基于旧策略生成短期可重试的缓存策略。 + * + * @param {Object} policy 旧的策略对象 + * @returns {Object} 可重试策略 + */ +function buildRetryableTransportPolicy(policy) { + const normalizedPolicy = normalizeTransportPolicy(policy); + return { + ...normalizedPolicy, + retryAt: getNowTimestamp() + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS, + }; +} + +/** + * 判断当前策略是否仍在可用期内。 + * + * @param {Object} policy 待校验策略 + * @returns {boolean} 是否可继续使用 + */ +function isUsableTransportPolicy(policy) { + if (!policy || !policy.publicKeyUrl || !policy.retryAt) { + return false; + } + return policy.retryAt > getNowTimestamp(); +} + +/** + * 从本地缓存加载最近一次持久化的策略。 + * + * @returns {Object|null} 缓存策略 + */ +function loadPersistedTransportPolicy() { + const persistedTransportPolicy = uni.getStorageSync( + TRANSPORT_FRONTEND_CONFIG_CACHE_KEY, + ); + if (!persistedTransportPolicy) { + return null; + } + return normalizeTransportPolicy(persistedTransportPolicy); +} + +/** + * 请求后端传输加密前端配置。 + * 这里直接使用原始 uni.request,避免策略初始化阶段反向依赖统一 request + * 包装器,导致“是否加密尚未判定时又要先走加密请求”的循环依赖。 + * + * @returns {Promise} Uni 请求响应结果 + */ +function requestFrontendConfig() { + return new Promise((resolve, reject) => { + uni.request({ + url: `${TRANSPORT_BASE_URL}${TRANSPORT_FRONTEND_CONFIG_URL}`, + method: "GET", + timeout: 10000, + success: resolve, + fail: reject, + }); + }); +} + +/** + * 获取请求加密使用的标准路径。 + * + * @param {string} url 请求地址 + * @param {string} baseUrl 基础 API 地址 + * @returns {string} 标准请求路径 + */ +export function getTransportRequestPath( + url = "", + baseUrl = TRANSPORT_BASE_URL, +) { + return getRequestPath(url, baseUrl); +} + +/** + * 获取当前生效的传输加密策略。 + * + * @returns {Object} 当前策略对象 + */ +export function getTransportCryptoPolicy() { + return cachedTransportPolicy || buildFallbackTransportPolicy(); +} + +/** + * 清空当前策略缓存与持久化数据。 + * + * @returns {void} + */ +export function invalidateTransportCryptoPolicy() { + cachedTransportPolicy = null; + inflightTransportPolicyPromise = null; + uni.removeStorageSync(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY); +} + +/** + * 确保本地已加载一份可用的传输加密策略。 + * + * @param {boolean} forceRefresh 是否强制从后端刷新 + * @returns {Promise} 当前可用策略 + */ +export async function ensureTransportCryptoPolicyLoaded(forceRefresh = false) { + if (!forceRefresh && !cachedTransportPolicy) { + const persistedTransportPolicy = loadPersistedTransportPolicy(); + if (isUsableTransportPolicy(persistedTransportPolicy)) { + cachedTransportPolicy = persistedTransportPolicy; + } + } + + if (!forceRefresh && isUsableTransportPolicy(cachedTransportPolicy)) { + return cachedTransportPolicy; + } + + if (inflightTransportPolicyPromise) { + return inflightTransportPolicyPromise; + } + + inflightTransportPolicyPromise = requestFrontendConfig() + .then((response) => { + const payload = normalizeTransportPolicy(response?.data?.data || {}); + cachedTransportPolicy = payload; + uni.setStorageSync(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY, payload); + inflightTransportPolicyPromise = null; + return cachedTransportPolicy; + }) + .catch((error) => { + const staleTransportPolicy = + cachedTransportPolicy || loadPersistedTransportPolicy(); + inflightTransportPolicyPromise = null; + cachedTransportPolicy = staleTransportPolicy + ? buildRetryableTransportPolicy(staleTransportPolicy) + : buildFallbackTransportPolicy(); + uni.setStorageSync( + TRANSPORT_FRONTEND_CONFIG_CACHE_KEY, + cachedTransportPolicy, + ); + if (staleTransportPolicy) { + console.warn( + "加载传输加密前端配置失败,当前继续沿用最近一次后端策略", + error, + ); + } else { + console.warn("加载传输加密前端配置失败,当前回退为明文请求策略", error); + } + return cachedTransportPolicy; + }); + + return inflightTransportPolicyPromise; +} + +/** + * 判断当前请求是否需要执行请求体加密。 + * + * @param {Object} requestConfig 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否启用请求加密 + */ +export function shouldEncryptRequest( + requestConfig, + transportPolicy = getTransportCryptoPolicy(), +) { + if (!transportPolicy.transportCryptoActive) { + return false; + } + const requestPath = getRequestPath( + requestConfig.url, + requestConfig.baseUrl || TRANSPORT_BASE_URL, + ); + if (matchPathPrefix(requestPath, transportPolicy.excludePaths || [])) { + return false; + } + if ( + (transportPolicy.enabledPaths || []).length && + !matchPathPrefix(requestPath, transportPolicy.enabledPaths || []) + ) { + return false; + } + if ((requestConfig.headers || {}).encrypt === false) { + return false; + } + if (matchExcludedUrl(requestConfig.url)) { + return false; + } + const contentType = + getHeaderValue(requestConfig.header, "Content-Type") || + getHeaderValue(requestConfig.headers, "Content-Type") || + ""; + if (String(contentType).includes("multipart/form-data")) { + return false; + } + return true; +} + +/** + * 判断当前响应是否需要执行自动解密。 + * + * @param {Object} requestConfig 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否启用响应解密 + */ +export function shouldEncryptResponse( + requestConfig, + transportPolicy = getTransportCryptoPolicy(), +) { + const requestPath = getRequestPath( + requestConfig.url, + requestConfig.baseUrl || TRANSPORT_BASE_URL, + ); + if (matchPathPrefix(requestPath, transportPolicy.excludePaths || [])) { + return false; + } + if ( + (transportPolicy.enabledPaths || []).length && + !matchPathPrefix(requestPath, transportPolicy.enabledPaths || []) + ) { + return false; + } + if ((requestConfig.headers || {}).encryptResponse === false) { + return false; + } + if (matchExcludedUrl(requestConfig.url)) { + return false; + } + if (requestConfig.__transportCryptoEnabledForRequest === true) { + return true; + } + if (requestConfig.__transportCryptoEnabledForRequest === false) { + return false; + } + return transportPolicy.transportCryptoActive; +} + +/** + * 判断查询参数是否需要封装为加密信封。 + * + * @param {Object} requestConfig 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否启用查询参数加密 + */ +export function shouldEncryptQuery( + requestConfig, + transportPolicy = getTransportCryptoPolicy(), +) { + if ((requestConfig.headers || {}).encryptQuery === false) { + return false; + } + return shouldEncryptRequest(requestConfig, transportPolicy); +} diff --git a/shierfeng-fastapi-app/src/utils/transportForge.js b/shierfeng-fastapi-app/src/utils/transportForge.js new file mode 100644 index 0000000..cac307f --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/transportForge.js @@ -0,0 +1,214 @@ +import forge from "node-forge/lib/forge"; +import "node-forge/lib/util"; +import "node-forge/lib/asn1"; +import "node-forge/lib/oids"; +import "node-forge/lib/cipher"; +import "node-forge/lib/cipherModes"; +import "node-forge/lib/aes"; +import "node-forge/lib/jsbn"; +import "node-forge/lib/pkcs1"; +import "node-forge/lib/prime"; +import "node-forge/lib/random"; +import "node-forge/lib/md"; +import "node-forge/lib/sha256"; +import "node-forge/lib/mgf1"; +import "node-forge/lib/pem"; +import "node-forge/lib/pki"; + +let randomBytePool = ""; +const FORGE_RANDOM_REFILL_BYTES = 4096; + +/** + * 将 Uint8Array 转为 Forge 兼容的二进制字符串。 + * + * @param {Uint8Array} uint8Array 字节数组 + * @returns {string} 二进制字符串 + */ +function uint8ArrayToBytes(uint8Array) { + return Array.from(uint8Array, (item) => String.fromCharCode(item)).join(""); +} + +/** + * 获取当前运行时的全局对象引用。 + * + * @returns {Object|undefined} 全局对象 + */ +function getRuntimeGlobal() { + if (typeof globalThis !== "undefined") { + return globalThis; + } + if (typeof self !== "undefined") { + return self; + } + if (typeof window !== "undefined") { + return window; + } + if (typeof global !== "undefined") { + return global; + } + return undefined; +} + +/** + * 通过 Web Crypto 同步获取随机字节。 + * + * @param {number} length 需要的字节长度 + * @returns {string|null} 随机字节串,当前运行环境不支持时返回 null + */ +function getWebCryptoRandomBytes(length) { + const runtimeCrypto = getRuntimeGlobal()?.crypto; + if (!runtimeCrypto?.getRandomValues) { + return null; + } + const bytes = new Uint8Array(length); + runtimeCrypto.getRandomValues(bytes); + return uint8ArrayToBytes(bytes); +} + +/** + * 在 app-plus iOS 端通过原生 NSUUID 获取随机字节兜底。 + * + * @param {number} length 需要的字节长度 + * @returns {string|null} 随机字节串,当前运行环境不支持时返回 null + */ +function getAppPlusIosRandomBytes(length) { + // #ifdef APP-PLUS + if (typeof plus === "undefined") { + return null; + } + const osName = String(plus.os?.name || "").toLowerCase(); + if (osName !== "ios" || typeof plus.ios?.importClass !== "function") { + return null; + } + + try { + const uuidClass = plus.ios.importClass("NSUUID"); + let randomBytes = ""; + while (randomBytes.length < length) { + const uuidObject = plus.ios.invoke(uuidClass, "UUID"); + const uuidText = String(plus.ios.invoke(uuidObject, "UUIDString") || "") + .replace(/-/g, "") + .toLowerCase(); + plus.ios.deleteObject(uuidObject); + if (!uuidText) { + return null; + } + for ( + let index = 0; + index < uuidText.length && randomBytes.length < length; + index += 2 + ) { + const byteValue = parseInt(uuidText.slice(index, index + 2), 16); + if (isNaN(byteValue)) { + return null; + } + randomBytes += String.fromCharCode(byteValue); + } + } + return randomBytes; + } catch (error) { + return null; + } + // #endif + return null; +} + +/** + * 在 app-plus Android 端通过原生 SecureRandom 获取随机字节兜底。 + * + * @param {number} length 需要的字节长度 + * @returns {string|null} 随机字节串,当前运行环境不支持时返回 null + */ +function getAppPlusAndroidRandomBytes(length) { + // #ifdef APP-PLUS + if (typeof plus === "undefined") { + return null; + } + const osName = String(plus.os?.name || "").toLowerCase(); + if (osName !== "android" || typeof plus.android?.importClass !== "function") { + return null; + } + + try { + plus.android.importClass("java.security.SecureRandom"); + const secureRandom = + typeof plus.android.newObject === "function" + ? plus.android.newObject("java.security.SecureRandom") + : null; + if (!secureRandom) { + return null; + } + plus.android.importClass(secureRandom); + let randomBytes = ""; + for (let index = 0; index < length; index += 1) { + randomBytes += String.fromCharCode(secureRandom.nextInt(256)); + } + if (typeof plus.android.autoCollection === "function") { + plus.android.autoCollection(secureRandom); + } + return randomBytes; + } catch (error) { + return null; + } + // #endif + return null; +} + +/** + * 在随机池不足时尝试同步补充一段新的随机字节。 + * + * @param {number} length 当前至少需要的字节长度 + * @returns {void} + */ +function refillRandomBytePool(length) { + const refillLength = Math.max(length, FORGE_RANDOM_REFILL_BYTES); + const randomBytes = + getWebCryptoRandomBytes(refillLength) || + getAppPlusAndroidRandomBytes(refillLength) || + getAppPlusIosRandomBytes(refillLength); + if (randomBytes) { + randomBytePool += randomBytes; + } +} + +/** + * 从随机数池中按需提取字节串。 + * + * @param {number} length 需要提取的字节长度 + * @returns {string} Forge 使用的二进制字符串 + */ +function consumeRandomBytes(length) { + if (randomBytePool.length < length) { + refillRandomBytePool(length); + } + if (randomBytePool.length < length) { + throw new Error("传输加密随机数池不足,且当前运行环境无法同步补充安全随机数"); + } + const bytes = randomBytePool.slice(0, length); + randomBytePool = randomBytePool.slice(length); + return bytes; +} + +forge.random.getBytesSync = function getBytesSync(length) { + return consumeRandomBytes(length); +}; + +forge.random.getBytes = function getBytes(length, callback) { + const bytes = consumeRandomBytes(length); + if (typeof callback === "function") { + callback(null, bytes); + } + return bytes; +}; + +/** + * 向 Forge 随机数池预填充平台侧生成的随机字节。 + * + * @param {string} bytes 待注入的二进制字符串 + * @returns {void} + */ +export function primeForgeRandomBytes(bytes) { + randomBytePool += String(bytes || ""); +} + +export default forge; diff --git a/shierfeng-fastapi-app/src/utils/upload.js b/shierfeng-fastapi-app/src/utils/upload.js new file mode 100644 index 0000000..632983b --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/upload.js @@ -0,0 +1,72 @@ +import { useUserStore } from "@/store"; +import config from "@/config"; +import { getToken } from "@/utils/auth"; +import errorCode from "@/utils/errorCode"; +import { toast, showConfirm, tansParams } from "@/utils/common"; + +let timeout = 10000; +const baseUrl = config.baseUrl; + +export default function upload(config) { + // 是否需要设置 token + const isToken = (config.headers || {}).isToken === false; + config.header = config.header || {}; + if (getToken() && !isToken) { + config.header["Authorization"] = "Bearer " + getToken(); + } + // get请求映射params参数 + if (config.params) { + let url = config.url + "?" + tansParams(config.params); + url = url.slice(0, -1); + config.url = url; + } + return new Promise((resolve, reject) => { + uni.uploadFile({ + timeout: config.timeout || timeout, + url: baseUrl + config.url, + filePath: config.filePath, + name: config.name || "file", + header: config.header, + formData: config.formData, + success: (res) => { + let result = JSON.parse(res.data); + const code = result.code || 200; + const msg = errorCode[code] || result.msg || errorCode["default"]; + if (code === 200) { + resolve(result); + } else if (code == 401) { + showConfirm( + "登录状态已过期,您可以继续留在该页面,或者重新登录?", + ).then((res) => { + if (res.confirm) { + useUserStore() + .logOut() + .then((res) => { + uni.reLaunch({ url: "/pages/login/login" }); + }); + } + }); + reject("无效的会话,或者会话已过期,请重新登录。"); + } else if (code === 500) { + toast(msg); + reject("500"); + } else if (code !== 200) { + toast(msg); + reject(code); + } + }, + fail: (error) => { + let { message } = error; + if (message == "Network Error") { + message = "后端接口连接异常"; + } else if (message.includes("timeout")) { + message = "系统接口请求超时"; + } else if (message.includes("Request failed with status code")) { + message = "系统接口" + message.substr(message.length - 3) + "异常"; + } + toast(message); + reject(error); + }, + }); + }); +} diff --git a/shierfeng-fastapi-app/src/utils/validate.js b/shierfeng-fastapi-app/src/utils/validate.js new file mode 100644 index 0000000..76b2b8d --- /dev/null +++ b/shierfeng-fastapi-app/src/utils/validate.js @@ -0,0 +1,124 @@ +/** + * 路径匹配器 + * @param {string} pattern + * @param {string} path + * @returns {Boolean} + */ +export function isPathMatch(pattern, path) { + const regexPattern = pattern + .replace(/\//g, "\\/") + .replace(/\*\*/g, ".*") + .replace(/\*/g, "[^\\/]*"); + const regex = new RegExp(`^${regexPattern}$`); + return regex.test(path); +} + +/** + * 判断value字符串是否为空 + * @param {string} value + * @returns {Boolean} + */ +export function isEmpty(value) { + if ( + value == null || + value == "" || + value == undefined || + value == "undefined" + ) { + return true; + } + return false; +} + +/** + * 判断url是否是http或https + * @param {string} url + * @returns {Boolean} + */ +export function isHttp(url) { + return url.indexOf("http://") !== -1 || url.indexOf("https://") !== -1; +} + +/** + * 判断path是否为外链 + * @param {string} path + * @returns {Boolean} + */ +export function isExternal(path) { + return /^(https?:|mailto:|tel:)/.test(path); +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validUsername(str) { + const valid_map = ["admin", "editor"]; + return valid_map.indexOf(str.trim()) >= 0; +} + +/** + * @param {string} url + * @returns {Boolean} + */ +export function validURL(url) { + const reg = + /^(https?|ftp):\/\/([a-zA-Z0-9.-]+(:[a-zA-Z0-9.&%$-]+)*@)*((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|([a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]+\.(com|edu|gov|int|mil|net|org|biz|arpa|info|name|pro|aero|coop|museum|[a-zA-Z]{2}))(:[0-9]+)*(\/($|[a-zA-Z0-9.,?'\\+&%$#=~_-]+))*$/; + return reg.test(url); +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validLowerCase(str) { + const reg = /^[a-z]+$/; + return reg.test(str); +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validUpperCase(str) { + const reg = /^[A-Z]+$/; + return reg.test(str); +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validAlphabets(str) { + const reg = /^[A-Za-z]+$/; + return reg.test(str); +} + +/** + * @param {string} email + * @returns {Boolean} + */ +export function validEmail(email) { + const reg = + /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/; + return reg.test(email); +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function isString(str) { + return typeof str === "string" || str instanceof String; +} + +/** + * @param {Array} arg + * @returns {Boolean} + */ +export function isArray(arg) { + if (typeof Array.isArray === "undefined") { + return Object.prototype.toString.call(arg) === "[object Array]"; + } + return Array.isArray(arg); +} diff --git a/shierfeng-fastapi-app/stylelint.config.mjs b/shierfeng-fastapi-app/stylelint.config.mjs new file mode 100644 index 0000000..3690858 --- /dev/null +++ b/shierfeng-fastapi-app/stylelint.config.mjs @@ -0,0 +1,3 @@ +import { icebreaker } from "@icebreakers/stylelint-config"; + +export default icebreaker(); diff --git a/shierfeng-fastapi-app/tailwind.config.ts b/shierfeng-fastapi-app/tailwind.config.ts new file mode 100644 index 0000000..d857f80 --- /dev/null +++ b/shierfeng-fastapi-app/tailwind.config.ts @@ -0,0 +1,53 @@ +import type { Config } from "tailwindcss"; +import { getIconCollections, iconsPlugin } from "@egoist/tailwindcss-icons"; +import cssMacro from "weapp-tailwindcss/css-macro"; +import { isMp } from "./platform"; + +export default { + content: ["./index.html", "./src/**/*.{html,js,ts,jsx,tsx,vue}"], + theme: { + extend: { + // colors: { + // // 你可以在这里进行颜色的扩展 + // primary: { + // 'DEFAULT': 'var(--color-primary, #0089FF)', + // 'light-3': 'var(--color-primary-light-3, rgb(85, 199, 255))', + // 'light-5': 'var(--color-primary-light-5, rgb(130, 217, 255))', + // 'light-7': 'var(--color-primary-light-7, rgb(175, 235, 255))', + // 'light-9': 'var(--color-primary-light-9, rgb(219, 252, 255))', + // 'dark-2': 'var(--color-primary-dark-2, rgb(0, 135, 204))', + // }, + // }, + }, + }, + // https://tw.icebreaker.top/docs/quick-start/uni-app-css-macro + plugins: [ + cssMacro({ + variantsMap: { + wx: "MP-WEIXIN", + "-wx": { + value: "MP-WEIXIN", + negative: true, + }, + // 定义多个条件判断 + // mv: { + // value: 'H5 || MP-WEIXIN' + // }, + // '-mv': { + // value: 'H5 || MP-WEIXIN', + // negative: true + // } + }, + }), + iconsPlugin({ + // 在这里可以选择你要使用的 icon, 更多详见: + // https://icon-sets.iconify.design/ + collections: getIconCollections(["svg-spinners", "mdi"]), + }), + ], + corePlugins: { + // 小程序去使用 h5 的 preflight 和响应式 container 没有意义 + preflight: !isMp, + container: !isMp, + }, +}; diff --git a/shierfeng-fastapi-app/tsconfig.json b/shierfeng-fastapi-app/tsconfig.json new file mode 100644 index 0000000..bf039d7 --- /dev/null +++ b/shierfeng-fastapi-app/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "esnext", + "outDir": "true", + "jsx": "preserve", + "lib": ["esnext", "dom"], + "useDefineForClassFields": true, + "baseUrl": ".", + "module": "esnext", + "moduleResolution": "bundler", + "paths": { + "@/*": ["src/*"] + }, + "resolveJsonModule": true, + "types": ["@dcloudio/types"], + "allowJs": true, + "strict": true, + "sourceMap": true, + "esModuleInterop": true + }, + "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"] +} diff --git a/shierfeng-fastapi-app/vite.config.ts b/shierfeng-fastapi-app/vite.config.ts new file mode 100644 index 0000000..8888b9a --- /dev/null +++ b/shierfeng-fastapi-app/vite.config.ts @@ -0,0 +1,70 @@ +import uni from "@dcloudio/vite-plugin-uni"; +import { defineConfig } from "vite"; +import { UnifiedViteWeappTailwindcssPlugin } from "weapp-tailwindcss/vite"; +import { WeappTailwindcssDisabled } from "./platform"; +import postcssPlugins from "./postcss.config"; + +function patchNodeForgeMiniProgramRuntime() { + return { + name: "patch-node-forge-mini-program-runtime", + enforce: "pre", + transform(code: string, id: string) { + if (id.includes("node-forge/lib/util.js")) { + return { + code: code.replace( + /return typeof self === 'undefined' \? window : self;/, + "return typeof globalThis !== 'undefined' ? globalThis : (typeof self === 'undefined' ? (typeof window === 'undefined' ? {} : window) : self);", + ), + map: null, + }; + } + + if (id.includes("node-forge/lib/random.js")) { + return { + code: code.replace( + /var _crypto = globalScope\.crypto \|\| globalScope\.msCrypto;/, + "var _crypto = (globalScope && (globalScope.crypto || globalScope.msCrypto)) || null;", + ), + map: null, + }; + } + + return null; + }, + }; +} + +// https://vitejs.dev/config/ +export default defineConfig(async () => { + // 新版本的 unplugin-auto-import 改成了只有 esm 格式的产物,而 uni-app 目前必须 cjs 格式 + // 所以需要改成动态 import 的写法来进行引入 + // 详见 https://github.com/sonofmagic/uni-app-vite-vue3-tailwind-vscode-template/issues/29 + const { default: AutoImport } = await import("unplugin-auto-import/vite"); + return { + // uvtw 一定要放在 uni 后面 + plugins: [ + uni(), + patchNodeForgeMiniProgramRuntime(), + UnifiedViteWeappTailwindcssPlugin({ + rem2rpx: true, + disabled: WeappTailwindcssDisabled, + }), + AutoImport({ + imports: ["vue", "uni-app", "pinia"], + dts: "./src/auto-imports.d.ts", + }), + ], + // 内联 postcss 注册 tailwindcss + css: { + postcss: { + plugins: postcssPlugins, + }, + // https://vitejs.dev/config/shared-options.html#css-preprocessoroptions + preprocessorOptions: { + scss: { + silenceDeprecations: ["legacy-js-api"], + }, + }, + }, + }; +}); diff --git a/shierfeng-fastapi-backend/.env.dev b/shierfeng-fastapi-backend/.env.dev new file mode 100644 index 0000000..5548461 --- /dev/null +++ b/shierfeng-fastapi-backend/.env.dev @@ -0,0 +1,173 @@ +# -------- 应用配置 -------- +# 应用运行环境 +APP_ENV = 'dev' +# 应用名称 +APP_NAME = 'ShiErFeng-FastAPI' +# 应用代理路径 +APP_ROOT_PATH = '/dev-api' +# 应用主机 +APP_HOST = '0.0.0.0' +# 应用端口 +APP_PORT = 9099 +# 应用版本 +APP_VERSION= '1.9.0' +# 应用是否开启热重载 +APP_RELOAD = true +# 应用工作进程数 +APP_WORKERS = 1 +# 应用是否开启IP归属区域查询 +APP_IP_LOCATION_QUERY = true +# 应用是否允许账号同时登录 +APP_SAME_TIME_LOGIN = true +# 应用是否为演示模式 +APP_DEMO_MODE = false +# 应用是否禁用Swagger文档 +APP_DISABLE_SWAGGER = false +# 应用是否禁用ReDoc文档 +APP_DISABLE_REDOC = false +# 可信代理IP列表,多个值使用逗号分隔 +APP_TRUSTED_PROXY_IPS = '127.0.0.1,::1' +# 可信代理跳数,单层Nginx代理通常为1 +APP_TRUSTED_PROXY_HOPS = 1 + +# -------- Jwt配置 -------- +# Jwt秘钥 +JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55' +# Jwt算法 +JWT_ALGORITHM = 'HS256' +# 令牌过期时间 +JWT_EXPIRE_MINUTES = 1440 +# redis中令牌过期时间 +JWT_REDIS_EXPIRE_MINUTES = 30 + + +# -------- 数据库配置 -------- +# 数据库类型,可选的有'mysql'、'postgresql',默认为'mysql' +DB_TYPE = 'mysql' +# 数据库主机 +DB_HOST = '127.0.0.1' +# 数据库端口 +DB_PORT = 3306 +# 数据库用户名 +DB_USERNAME = 'root' +# 数据库密码 +DB_PASSWORD = 'mysqlroot' +# 数据库名称 +DB_DATABASE = 'shierfeng-fastapi' +# 是否开启sqlalchemy日志 +DB_ECHO = true +# 允许溢出连接池大小的最大连接数 +DB_MAX_OVERFLOW = 10 +# 连接池大小,0表示连接数无限制 +DB_POOL_SIZE = 50 +# 连接回收时间(单位:秒) +DB_POOL_RECYCLE = 3600 +# 连接池中没有线程可用时,最多等待的时间(单位:秒) +DB_POOL_TIMEOUT = 30 + +# -------- Redis配置 -------- +# Redis主机 +REDIS_HOST = '127.0.0.1' +# Redis端口 +REDIS_PORT = 6379 +# Redis用户名 +REDIS_USERNAME = '' +# Redis密码 +REDIS_PASSWORD = '' +# Redis数据库 +REDIS_DATABASE = 2 + +# -------- 日志配置 -------- +# 是否启用日志脱敏 +LOG_MASK_ENABLED = false +# 日志脱敏占位符 +LOG_MASK_PLACEHOLDER = '******' +# 以下三项为互补关系(非互斥): +# 1) LOG_MASK_FIELDS:命中后执行全量脱敏 +# 2) LOG_PARTIAL_MASK_FIELDS:命中后执行部分脱敏 +# 3) LOG_CONFIG_SECRET_PATTERNS:按 configKey 关键词决定是否脱敏 configValue +# 全量脱敏字段,多个值使用逗号分隔 +LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt' +# 部分脱敏字段,多个值使用逗号分隔 +# 当前默认不对IP脱敏;如后期需要开启,可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务 +LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email' +# 按配置键名识别敏感配置的关键词,多个值使用逗号分隔 +LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms' +# Redis Stream Key +LOG_STREAM_KEY = 'log:stream' +# Redis Stream 消费组名称 +LOG_STREAM_GROUP = 'log_aggregator' +# Redis Stream 消费者名称前缀 +LOG_STREAM_CONSUMER_PREFIX = 'worker' +# 每次读取的最大消息数量 +LOG_STREAM_BATCH_SIZE = 100 +# 阻塞读取等待时间(毫秒) +LOG_STREAM_BLOCK_MS = 2000 +# Stream 最大长度(近似裁剪) +LOG_STREAM_MAXLEN = 100000 +# Pending 回收最小空闲时间(毫秒) +LOG_STREAM_CLAIM_IDLE_MS = 60000 +# Pending 回收检查间隔(毫秒) +LOG_STREAM_CLAIM_INTERVAL_MS = 5000 +# 每次回收的最大消息数量 +LOG_STREAM_CLAIM_BATCH_SIZE = 100 +# 去重 Key 过期时间(秒) +LOG_STREAM_DEDUP_TTL = 3600 +# 去重 Key 前缀 +LOG_STREAM_DEDUP_PREFIX = 'log:dedup' +# stdout 输出是否为 JSON +LOGURU_JSON = false +# Loguru 最低输出级别 +LOGURU_LEVEL = 'INFO' +# 是否输出到 stdout +LOGURU_STDOUT = true +# 是否启用文件日志 +LOG_FILE_ENABLED = true +# 文件日志根目录 +LOG_FILE_BASE_DIR = 'logs' +# 文件滚动策略 +LOGURU_ROTATION = '50MB' +# 文件保留策略 +LOGURU_RETENTION = '30 days' +# 文件压缩格式 +LOGURU_COMPRESSION = 'zip' +# 实例标识(用于区分实例) +LOG_INSTANCE_ID = 'dev' +# 服务名称(用于统一标识服务) +LOG_SERVICE_NAME = 'shierfeng-fastapi-backend' +# Worker 标识(auto 自动生成) +LOG_WORKER_ID = 'auto' + +# -------- 传输层加解密配置 -------- +# 是否启用传输层加解密 +TRANSPORT_CRYPTO_ENABLED = false +# 传输层加解密模式:off=关闭,optional=明文/密文兼容,required=命中接口强制加密 +TRANSPORT_CRYPTO_MODE = 'off' +# 传输层加解密算法标识 +TRANSPORT_CRYPTO_ALGORITHM = 'RSA_OAEP_AES_256_GCM' +# 当前启用的密钥版本标识 +TRANSPORT_CRYPTO_KID = 'default' +# 传输层RSA位数,需与下方密钥对匹配 +TRANSPORT_CRYPTO_RSA_KEY_SIZE = 4096 +# 传输层公钥,默认提供一套可用示例值;团队使用时可按需替换 +TRANSPORT_CRYPTO_PUBLIC_KEY = '-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwA2ooWpsxLzIVMJp7Wcv\nvR0Bu8paFn8NVPpzz+wGpUlwP5DGK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6Ub\nQVyHJ6BXXIMs/BpzcHCbyXR/wWG+pKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEs\nA81kskVlDdGeNyaOJg5QuofEErCfR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu\n9YbEbKs7JvNle5vjc72ebbMIeGejHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj\n8F/TySLuOy37iVWfD+5ikLyou4ZDI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6\nSrldwZfZDBl3EGgRby8yJqO6SqGgyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqX\nhK67kbYaA9xJeHRaP04cg16imB7sBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6d\nWdJA3qe3iBSSM8pmedv+Jgfau/PFam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIa\nQ6acv+v5N6QVFptlcx6I7j8yZJ7WUHZlB1IxVqfPb69+985eknZyLul60gyu0kPG\nYUecypUu2wiNDBAErZlUxEujMWgJDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSo\nRYxPhTbwo68RJDpImBjn+YsCAwEAAQ==\n-----END PUBLIC KEY-----' +# 传输层私钥,必须与上方公钥成对使用 +TRANSPORT_CRYPTO_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIIJKAIBAAKCAgEAwA2ooWpsxLzIVMJp7WcvvR0Bu8paFn8NVPpzz+wGpUlwP5DG\nK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6UbQVyHJ6BXXIMs/BpzcHCbyXR/wWG+\npKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEsA81kskVlDdGeNyaOJg5QuofEErCf\nR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu9YbEbKs7JvNle5vjc72ebbMIeGej\nHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj8F/TySLuOy37iVWfD+5ikLyou4ZD\nI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6SrldwZfZDBl3EGgRby8yJqO6SqGg\nyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqXhK67kbYaA9xJeHRaP04cg16imB7s\nBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6dWdJA3qe3iBSSM8pmedv+Jgfau/PF\nam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIaQ6acv+v5N6QVFptlcx6I7j8yZJ7W\nUHZlB1IxVqfPb69+985eknZyLul60gyu0kPGYUecypUu2wiNDBAErZlUxEujMWgJ\nDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSoRYxPhTbwo68RJDpImBjn+YsCAwEA\nAQKCAgEAtH7hwjp8WPY3rPk+hqEYy7psO6q0ujnUNM5hc8MWh9caSJNuu/D51vCK\nHX3d63hITNK+x9ZaM2Jcj/9XC56vm+EzILngARFDgPf3EHC06UO1IfEUND3CoMqs\njS/sEDCwiXpccc/JgkUT7EgluwDL5hLuFWGE1NTxxlFU/U0s7/HTA+G9AFuPQHjt\nZNJxxozscOh0W44OM4/jdebJ4TBEaDqtdpgDMttDwEVFIizOrbi6ODbmpCQaZzDq\nJczGoTZG7c5w5jfRnD1NnDzB0apjr3DQYVOT5EiWA39Vy6o2NmMojX1ksfxKZtll\n83vYZ91vSR5waQvo5nFJB5+vJ0CCy4BZaV9/gQBP/OSElELfD0bGYidO7NURAJMW\njGc2B6uIog8BZ3ix02FO/30i5rWeDWM7McLol8+IP0Qcg473YvrCgmRZpprdc9HT\nHnB6BgIwu0ZBoP7CxW7pBm0ApwmOf7OvUdAu68kFQ4KxABuv+Qegu0vSsktBtmIs\ngUDzu/ekoayyOvFHVwVTd4QKOSa2gXb3TS7PP22j6QLL1OPy2fK2NBW0xrRDIgtw\nSx3Yo0dxCYkxJWz1nQYsdIjZbz2/xQPZZQ5yNeePwxaOKyDuA50elN86I9RR2gjL\nh9QMrvPG7DOlgmBG9+JsydQZf00G+x45Su/1fydA09X3AFtZLkkCggEBAOj8NY/x\n3G3/1qAkrcQYLwB0mjLNkgKchRIP8NMildk0nSub5SRUxleW2wp0kM0WqkFTXLMa\nFR0qCRjiyPOtBBZxLobIfGc6568LTKfg4N7VsCeAcTjFjSOE57iX5XzwhTy6ZCKe\nZFGFWfhj/a9lNQHneTcklDHq/oHjLJQ1FacbWNycIOX2Hk7SZKyJvyMutAem3BI+\nm5SLyj5648N2ylmz6f3eaTn8CyNCrUKWnPriQZfV0XF/Aalh4sq/I3fI6pqnYkHK\nuSoG9YHujGXKN2iOV/0krCiGj94l7JqvKGs4ZRoZdD+s1EugGD7qBK1wGATuEseg\nR6mS74ylgD88JPcCggEBANMGWrqhHOAtGeIewLbNob54+nqdwU/O+zk0RcTZErcD\naRZMTLPRlpdbgWbNgdfjFnbUx0WmIeTIboD2MaW5KOnDfV/x+eRhGtEmtNRvHA/o\nHK6uYzok7Ekm7oc298CYrfRbEWVx3m4+mHmU+rsvBeof664zpEEIsSwm+NaAnjz8\nru0U8xw8KWLB8F/Q4J4p4D0yVKCmAXmrrTgEYm1H355JlAlmiu6t6YPS2Xd+gNFD\ntWBsQXYnxEZyPhoD1Q4SQjQmQMEN7+lIHm8f/nMwwUkAd3y6D1w/Uu81Gqa/9eAh\nz3woK++tj/U1CMMTWXJumIyJdH28CWQJa9VdJBoFbw0CggEAdIBhPDhh1DNhHDUb\nGvpIzn5/+LVotJuVwwFrl/gsXC9+BCdxPmiRwYyyvRiqq5MQ0ZegvAJn2myBngsR\nFyBF8f7omAc6hdgjsBkDXNMLPwI1kpscgpnuSHuV720tGPugdExz9Ael/EmlQpql\naQY/qlMX/uXwoMF0QHjbesTMrgHzvmTn4nXek+WK5+f9Rtd8uHLMiub5nx8Do5iJ\nudz1tENN119W2OLaougdgTWVC7MFv6nwkENFDnDfGijX0HcMMQdQD7wSORy/uRgS\n5ndmm4bKItAqsh0PZbMrC/JYUL0jeRiPU6PViHdmiFc2vY9Ww2hUxbO1Aetyk67S\nYUxu4wKCAQAvSOQ5n3JV9SUwms156LfOc1NE+GZhmLKITeM4SZ+87IG2omAphtQk\nlDd5rqDinBrjg6gnPiOoHRVNxly3krbNMqW8Qv9Iok2dAfxRAZibI9qRdbf8Rlu/\nxH58Q9/eAxgvgdxzC8HYmCQYUj6ghNfhb0ejICU1AVqZ1x25CtbqOYCE1UXoVL69\nR1GyVp6OMjnx3H5EBQ6dkc9dlvXrIMjFshz+wkBtXQDPLgbWlL0OpwpUUc2VSTHc\nyyqJL8Skw4icINovqAzTC/rt0ZB1hT46OmWLyDE67WGLAi43oRnaIBla67F0okJ4\nomqVM5e+YXPDQeWdau37wXStOZKmVgNdAoIBADojGo0h9mBgnr+u1oYB+mKx6LVD\n3TTy45IB1ikqprBnSjgXNbQycsTbl+qDo5ge+KqlPNk6Scvn0L7k43/VB9Y5qK2s\nBgxa1KgdeC5WUNU0rs/1UKIODA5SlWIk6JqekiAE+glljVZ5E53l93gPL3uRcvr5\nSD5CPe+qqoBh9nYIRJDogP0e2xV11EuE10j1WxuLkHL5//hePGPpgnb0/rZkP+vb\nkzwz1fTv88kQDnRk6uIe0L78iFTpEwAnlDmuMJ4KafKnujaR5VVCoI7bwryCp4+f\n8zyU7ZpKo/2EE8bYmxHMDPiYByJxCwAbm2Xn7Kw4H/17MLJOxg8685A8jyA=\n-----END RSA PRIVATE KEY-----' +# 历史密钥对配置,JSON数组格式 +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS = '[]' +# 公钥缓存有效期(秒) +TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS = 3600 +# 前端传输加密策略缓存有效期(秒) +TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS = 300 +# GET/DELETE 请求参数加密后的最大 URL 长度 +TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH = 4096 +# 请求时间窗允许偏差(秒) +TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS = 120 +# 防重放随机数有效期(秒) +TRANSPORT_CRYPTO_REPLAY_TTL_SECONDS = 300 +# 启用传输层加密的路径列表,多个值使用逗号分隔,留空表示默认全部启用 +TRANSPORT_CRYPTO_ENABLED_PATHS = '' +# 强制要求传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_REQUIRED_PATHS = '' +# 排除传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_EXCLUDE_PATHS = '/openapi.json,/docs,/docs/oauth2-redirect,/redoc,/transport/crypto/frontend-config,/transport/crypto/public-key,/common/download,/common/download/resource' diff --git a/shierfeng-fastapi-backend/.env.dockermy b/shierfeng-fastapi-backend/.env.dockermy new file mode 100644 index 0000000..9e19cb7 --- /dev/null +++ b/shierfeng-fastapi-backend/.env.dockermy @@ -0,0 +1,173 @@ +# -------- 应用配置 -------- +# 应用运行环境 +APP_ENV = 'prod' +# 应用名称 +APP_NAME = 'ShiErFeng-FastAPI' +# 应用代理路径 +APP_ROOT_PATH = '/docker-api' +# 应用主机 +APP_HOST = '0.0.0.0' +# 应用端口 +APP_PORT = 9099 +# 应用版本 +APP_VERSION= '1.9.0' +# 应用是否开启热重载 +APP_RELOAD = false +# 应用工作进程数 +APP_WORKERS = 1 +# 应用是否开启IP归属区域查询 +APP_IP_LOCATION_QUERY = true +# 应用是否允许账号同时登录 +APP_SAME_TIME_LOGIN = true +# 应用是否为演示模式 +APP_DEMO_MODE = false +# 应用是否禁用Swagger文档 +APP_DISABLE_SWAGGER = true +# 应用是否禁用ReDoc文档 +APP_DISABLE_REDOC = true +# 可信代理IP列表,多个值使用逗号分隔 +APP_TRUSTED_PROXY_IPS = '127.0.0.1,::1' +# 可信代理跳数,单层Nginx代理通常为1 +APP_TRUSTED_PROXY_HOPS = 1 + +# -------- Jwt配置 -------- +# Jwt秘钥 +JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55' +# Jwt算法 +JWT_ALGORITHM = 'HS256' +# 令牌过期时间 +JWT_EXPIRE_MINUTES = 1440 +# redis中令牌过期时间 +JWT_REDIS_EXPIRE_MINUTES = 30 + + +# -------- 数据库配置 -------- +# 数据库类型,可选的有'mysql'、'postgresql',默认为'mysql' +DB_TYPE = 'mysql' +# 数据库主机 +DB_HOST = 'shierfeng-mysql' +# 数据库端口 +DB_PORT = 3306 +# 数据库用户名 +DB_USERNAME = 'root' +# 数据库密码 +DB_PASSWORD = 'root' +# 数据库名称 +DB_DATABASE = 'shierfeng-fastapi' +# 是否开启sqlalchemy日志 +DB_ECHO = true +# 允许溢出连接池大小的最大连接数 +DB_MAX_OVERFLOW = 10 +# 连接池大小,0表示连接数无限制 +DB_POOL_SIZE = 50 +# 连接回收时间(单位:秒) +DB_POOL_RECYCLE = 3600 +# 连接池中没有线程可用时,最多等待的时间(单位:秒) +DB_POOL_TIMEOUT = 30 + +# -------- Redis配置 -------- +# Redis主机 +REDIS_HOST = 'shierfeng-redis' +# Redis端口 +REDIS_PORT = 6379 +# Redis用户名 +REDIS_USERNAME = '' +# Redis密码 +REDIS_PASSWORD = '' +# Redis数据库 +REDIS_DATABASE = 2 + +# -------- 日志配置 -------- +# 是否启用日志脱敏 +LOG_MASK_ENABLED = true +# 日志脱敏占位符 +LOG_MASK_PLACEHOLDER = '******' +# 以下三项为互补关系(非互斥): +# 1) LOG_MASK_FIELDS:命中后执行全量脱敏 +# 2) LOG_PARTIAL_MASK_FIELDS:命中后执行部分脱敏 +# 3) LOG_CONFIG_SECRET_PATTERNS:按 configKey 关键词决定是否脱敏 configValue +# 全量脱敏字段,多个值使用逗号分隔 +LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt' +# 部分脱敏字段,多个值使用逗号分隔 +# 当前默认不对IP脱敏;如后期需要开启,可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务 +LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email' +# 按配置键名识别敏感配置的关键词,多个值使用逗号分隔 +LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms' +# Redis Stream Key +LOG_STREAM_KEY = 'log:stream' +# Redis Stream 消费组名称 +LOG_STREAM_GROUP = 'log_aggregator' +# Redis Stream 消费者名称前缀 +LOG_STREAM_CONSUMER_PREFIX = 'worker' +# 每次读取的最大消息数量 +LOG_STREAM_BATCH_SIZE = 100 +# 阻塞读取等待时间(毫秒) +LOG_STREAM_BLOCK_MS = 2000 +# Stream 最大长度(近似裁剪) +LOG_STREAM_MAXLEN = 100000 +# Pending 回收最小空闲时间(毫秒) +LOG_STREAM_CLAIM_IDLE_MS = 60000 +# Pending 回收检查间隔(毫秒) +LOG_STREAM_CLAIM_INTERVAL_MS = 5000 +# 每次回收的最大消息数量 +LOG_STREAM_CLAIM_BATCH_SIZE = 100 +# 去重 Key 过期时间(秒) +LOG_STREAM_DEDUP_TTL = 3600 +# 去重 Key 前缀 +LOG_STREAM_DEDUP_PREFIX = 'log:dedup' +# stdout 输出是否为 JSON +LOGURU_JSON = false +# Loguru 最低输出级别 +LOGURU_LEVEL = 'INFO' +# 是否输出到 stdout +LOGURU_STDOUT = true +# 是否启用文件日志 +LOG_FILE_ENABLED = true +# 文件日志根目录 +LOG_FILE_BASE_DIR = 'logs' +# 文件滚动策略 +LOGURU_ROTATION = '50MB' +# 文件保留策略 +LOGURU_RETENTION = '30 days' +# 文件压缩格式 +LOGURU_COMPRESSION = 'zip' +# 实例标识(用于区分实例) +LOG_INSTANCE_ID = 'dockermy' +# 服务名称(用于统一标识服务) +LOG_SERVICE_NAME = 'shierfeng-fastapi-backend' +# Worker 标识(auto 自动生成) +LOG_WORKER_ID = 'auto' + +# -------- 传输层加解密配置 -------- +# 是否启用传输层加解密 +TRANSPORT_CRYPTO_ENABLED = true +# 传输层加解密模式:off=关闭,optional=明文/密文兼容,required=命中接口强制加密 +TRANSPORT_CRYPTO_MODE = 'optional' +# 传输层加解密算法标识 +TRANSPORT_CRYPTO_ALGORITHM = 'RSA_OAEP_AES_256_GCM' +# 当前启用的密钥版本标识 +TRANSPORT_CRYPTO_KID = 'default' +# 传输层RSA位数,需与下方密钥对匹配 +TRANSPORT_CRYPTO_RSA_KEY_SIZE = 4096 +# 传输层公钥,默认提供一套可用示例值;Docker 部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PUBLIC_KEY = '-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwA2ooWpsxLzIVMJp7Wcv\nvR0Bu8paFn8NVPpzz+wGpUlwP5DGK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6Ub\nQVyHJ6BXXIMs/BpzcHCbyXR/wWG+pKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEs\nA81kskVlDdGeNyaOJg5QuofEErCfR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu\n9YbEbKs7JvNle5vjc72ebbMIeGejHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj\n8F/TySLuOy37iVWfD+5ikLyou4ZDI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6\nSrldwZfZDBl3EGgRby8yJqO6SqGgyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqX\nhK67kbYaA9xJeHRaP04cg16imB7sBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6d\nWdJA3qe3iBSSM8pmedv+Jgfau/PFam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIa\nQ6acv+v5N6QVFptlcx6I7j8yZJ7WUHZlB1IxVqfPb69+985eknZyLul60gyu0kPG\nYUecypUu2wiNDBAErZlUxEujMWgJDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSo\nRYxPhTbwo68RJDpImBjn+YsCAwEAAQ==\n-----END PUBLIC KEY-----' +# 传输层私钥,必须与上方公钥成对使用;Docker 部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIIJKAIBAAKCAgEAwA2ooWpsxLzIVMJp7WcvvR0Bu8paFn8NVPpzz+wGpUlwP5DG\nK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6UbQVyHJ6BXXIMs/BpzcHCbyXR/wWG+\npKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEsA81kskVlDdGeNyaOJg5QuofEErCf\nR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu9YbEbKs7JvNle5vjc72ebbMIeGej\nHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj8F/TySLuOy37iVWfD+5ikLyou4ZD\nI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6SrldwZfZDBl3EGgRby8yJqO6SqGg\nyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqXhK67kbYaA9xJeHRaP04cg16imB7s\nBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6dWdJA3qe3iBSSM8pmedv+Jgfau/PF\nam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIaQ6acv+v5N6QVFptlcx6I7j8yZJ7W\nUHZlB1IxVqfPb69+985eknZyLul60gyu0kPGYUecypUu2wiNDBAErZlUxEujMWgJ\nDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSoRYxPhTbwo68RJDpImBjn+YsCAwEA\nAQKCAgEAtH7hwjp8WPY3rPk+hqEYy7psO6q0ujnUNM5hc8MWh9caSJNuu/D51vCK\nHX3d63hITNK+x9ZaM2Jcj/9XC56vm+EzILngARFDgPf3EHC06UO1IfEUND3CoMqs\njS/sEDCwiXpccc/JgkUT7EgluwDL5hLuFWGE1NTxxlFU/U0s7/HTA+G9AFuPQHjt\nZNJxxozscOh0W44OM4/jdebJ4TBEaDqtdpgDMttDwEVFIizOrbi6ODbmpCQaZzDq\nJczGoTZG7c5w5jfRnD1NnDzB0apjr3DQYVOT5EiWA39Vy6o2NmMojX1ksfxKZtll\n83vYZ91vSR5waQvo5nFJB5+vJ0CCy4BZaV9/gQBP/OSElELfD0bGYidO7NURAJMW\njGc2B6uIog8BZ3ix02FO/30i5rWeDWM7McLol8+IP0Qcg473YvrCgmRZpprdc9HT\nHnB6BgIwu0ZBoP7CxW7pBm0ApwmOf7OvUdAu68kFQ4KxABuv+Qegu0vSsktBtmIs\ngUDzu/ekoayyOvFHVwVTd4QKOSa2gXb3TS7PP22j6QLL1OPy2fK2NBW0xrRDIgtw\nSx3Yo0dxCYkxJWz1nQYsdIjZbz2/xQPZZQ5yNeePwxaOKyDuA50elN86I9RR2gjL\nh9QMrvPG7DOlgmBG9+JsydQZf00G+x45Su/1fydA09X3AFtZLkkCggEBAOj8NY/x\n3G3/1qAkrcQYLwB0mjLNkgKchRIP8NMildk0nSub5SRUxleW2wp0kM0WqkFTXLMa\nFR0qCRjiyPOtBBZxLobIfGc6568LTKfg4N7VsCeAcTjFjSOE57iX5XzwhTy6ZCKe\nZFGFWfhj/a9lNQHneTcklDHq/oHjLJQ1FacbWNycIOX2Hk7SZKyJvyMutAem3BI+\nm5SLyj5648N2ylmz6f3eaTn8CyNCrUKWnPriQZfV0XF/Aalh4sq/I3fI6pqnYkHK\nuSoG9YHujGXKN2iOV/0krCiGj94l7JqvKGs4ZRoZdD+s1EugGD7qBK1wGATuEseg\nR6mS74ylgD88JPcCggEBANMGWrqhHOAtGeIewLbNob54+nqdwU/O+zk0RcTZErcD\naRZMTLPRlpdbgWbNgdfjFnbUx0WmIeTIboD2MaW5KOnDfV/x+eRhGtEmtNRvHA/o\nHK6uYzok7Ekm7oc298CYrfRbEWVx3m4+mHmU+rsvBeof664zpEEIsSwm+NaAnjz8\nru0U8xw8KWLB8F/Q4J4p4D0yVKCmAXmrrTgEYm1H355JlAlmiu6t6YPS2Xd+gNFD\ntWBsQXYnxEZyPhoD1Q4SQjQmQMEN7+lIHm8f/nMwwUkAd3y6D1w/Uu81Gqa/9eAh\nz3woK++tj/U1CMMTWXJumIyJdH28CWQJa9VdJBoFbw0CggEAdIBhPDhh1DNhHDUb\nGvpIzn5/+LVotJuVwwFrl/gsXC9+BCdxPmiRwYyyvRiqq5MQ0ZegvAJn2myBngsR\nFyBF8f7omAc6hdgjsBkDXNMLPwI1kpscgpnuSHuV720tGPugdExz9Ael/EmlQpql\naQY/qlMX/uXwoMF0QHjbesTMrgHzvmTn4nXek+WK5+f9Rtd8uHLMiub5nx8Do5iJ\nudz1tENN119W2OLaougdgTWVC7MFv6nwkENFDnDfGijX0HcMMQdQD7wSORy/uRgS\n5ndmm4bKItAqsh0PZbMrC/JYUL0jeRiPU6PViHdmiFc2vY9Ww2hUxbO1Aetyk67S\nYUxu4wKCAQAvSOQ5n3JV9SUwms156LfOc1NE+GZhmLKITeM4SZ+87IG2omAphtQk\nlDd5rqDinBrjg6gnPiOoHRVNxly3krbNMqW8Qv9Iok2dAfxRAZibI9qRdbf8Rlu/\nxH58Q9/eAxgvgdxzC8HYmCQYUj6ghNfhb0ejICU1AVqZ1x25CtbqOYCE1UXoVL69\nR1GyVp6OMjnx3H5EBQ6dkc9dlvXrIMjFshz+wkBtXQDPLgbWlL0OpwpUUc2VSTHc\nyyqJL8Skw4icINovqAzTC/rt0ZB1hT46OmWLyDE67WGLAi43oRnaIBla67F0okJ4\nomqVM5e+YXPDQeWdau37wXStOZKmVgNdAoIBADojGo0h9mBgnr+u1oYB+mKx6LVD\n3TTy45IB1ikqprBnSjgXNbQycsTbl+qDo5ge+KqlPNk6Scvn0L7k43/VB9Y5qK2s\nBgxa1KgdeC5WUNU0rs/1UKIODA5SlWIk6JqekiAE+glljVZ5E53l93gPL3uRcvr5\nSD5CPe+qqoBh9nYIRJDogP0e2xV11EuE10j1WxuLkHL5//hePGPpgnb0/rZkP+vb\nkzwz1fTv88kQDnRk6uIe0L78iFTpEwAnlDmuMJ4KafKnujaR5VVCoI7bwryCp4+f\n8zyU7ZpKo/2EE8bYmxHMDPiYByJxCwAbm2Xn7Kw4H/17MLJOxg8685A8jyA=\n-----END RSA PRIVATE KEY-----' +# 历史密钥对配置,JSON数组格式,密钥轮换说明见 docs/transport_crypto_deployment.md +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS = '[]' +# 公钥缓存有效期(秒) +TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS = 3600 +# 前端传输加密策略缓存有效期(秒) +TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS = 300 +# GET/DELETE 请求参数加密后的最大 URL 长度 +TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH = 4096 +# 请求时间窗允许偏差(秒) +TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS = 120 +# 防重放随机数有效期(秒) +TRANSPORT_CRYPTO_REPLAY_TTL_SECONDS = 300 +# 启用传输层加密的路径列表,多个值使用逗号分隔,留空表示默认全部启用 +TRANSPORT_CRYPTO_ENABLED_PATHS = '' +# 强制要求传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_REQUIRED_PATHS = '' +# 排除传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_EXCLUDE_PATHS = '/openapi.json,/docs,/docs/oauth2-redirect,/redoc,/transport/crypto/frontend-config,/transport/crypto/public-key,/common/download,/common/download/resource' diff --git a/shierfeng-fastapi-backend/.env.dockerpg b/shierfeng-fastapi-backend/.env.dockerpg new file mode 100644 index 0000000..25b825e --- /dev/null +++ b/shierfeng-fastapi-backend/.env.dockerpg @@ -0,0 +1,173 @@ +# -------- 应用配置 -------- +# 应用运行环境 +APP_ENV = 'prod' +# 应用名称 +APP_NAME = 'ShiErFeng-FastAPI' +# 应用代理路径 +APP_ROOT_PATH = '/docker-api' +# 应用主机 +APP_HOST = '0.0.0.0' +# 应用端口 +APP_PORT = 9099 +# 应用版本 +APP_VERSION= '1.9.0' +# 应用是否开启热重载 +APP_RELOAD = false +# 应用工作进程数 +APP_WORKERS = 1 +# 应用是否开启IP归属区域查询 +APP_IP_LOCATION_QUERY = true +# 应用是否为演示模式 +APP_DEMO_MODE = false +# 应用是否允许账号同时登录 +APP_SAME_TIME_LOGIN = true +# 应用是否禁用Swagger文档 +APP_DISABLE_SWAGGER = true +# 应用是否禁用ReDoc文档 +APP_DISABLE_REDOC = true +# 可信代理IP列表,多个值使用逗号分隔 +APP_TRUSTED_PROXY_IPS = '127.0.0.1,::1' +# 可信代理跳数,单层Nginx代理通常为1 +APP_TRUSTED_PROXY_HOPS = 1 + +# -------- Jwt配置 -------- +# Jwt秘钥 +JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55' +# Jwt算法 +JWT_ALGORITHM = 'HS256' +# 令牌过期时间 +JWT_EXPIRE_MINUTES = 1440 +# redis中令牌过期时间 +JWT_REDIS_EXPIRE_MINUTES = 30 + + +# -------- 数据库配置 -------- +# 数据库类型,可选的有'mysql'、'postgresql',默认为'mysql' +DB_TYPE = 'postgresql' +# 数据库主机 +DB_HOST = 'shierfeng-pg' +# 数据库端口 +DB_PORT = 5432 +# 数据库用户名 +DB_USERNAME = 'postgres' +# 数据库密码 +DB_PASSWORD = 'root' +# 数据库名称 +DB_DATABASE = 'shierfeng-fastapi' +# 是否开启sqlalchemy日志 +DB_ECHO = true +# 允许溢出连接池大小的最大连接数 +DB_MAX_OVERFLOW = 10 +# 连接池大小,0表示连接数无限制 +DB_POOL_SIZE = 50 +# 连接回收时间(单位:秒) +DB_POOL_RECYCLE = 3600 +# 连接池中没有线程可用时,最多等待的时间(单位:秒) +DB_POOL_TIMEOUT = 30 + +# -------- Redis配置 -------- +# Redis主机 +REDIS_HOST = 'shierfeng-redis' +# Redis端口 +REDIS_PORT = 6379 +# Redis用户名 +REDIS_USERNAME = '' +# Redis密码 +REDIS_PASSWORD = '' +# Redis数据库 +REDIS_DATABASE = 2 + +# -------- 日志配置 -------- +# 是否启用日志脱敏 +LOG_MASK_ENABLED = true +# 日志脱敏占位符 +LOG_MASK_PLACEHOLDER = '******' +# 以下三项为互补关系(非互斥): +# 1) LOG_MASK_FIELDS:命中后执行全量脱敏 +# 2) LOG_PARTIAL_MASK_FIELDS:命中后执行部分脱敏 +# 3) LOG_CONFIG_SECRET_PATTERNS:按 configKey 关键词决定是否脱敏 configValue +# 全量脱敏字段,多个值使用逗号分隔 +LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt' +# 部分脱敏字段,多个值使用逗号分隔 +# 当前默认不对IP脱敏;如后期需要开启,可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务 +LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email' +# 按配置键名识别敏感配置的关键词,多个值使用逗号分隔 +LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms' +# Redis Stream Key +LOG_STREAM_KEY = 'log:stream' +# Redis Stream 消费组名称 +LOG_STREAM_GROUP = 'log_aggregator' +# Redis Stream 消费者名称前缀 +LOG_STREAM_CONSUMER_PREFIX = 'worker' +# 每次读取的最大消息数量 +LOG_STREAM_BATCH_SIZE = 100 +# 阻塞读取等待时间(毫秒) +LOG_STREAM_BLOCK_MS = 2000 +# Stream 最大长度(近似裁剪) +LOG_STREAM_MAXLEN = 100000 +# Pending 回收最小空闲时间(毫秒) +LOG_STREAM_CLAIM_IDLE_MS = 60000 +# Pending 回收检查间隔(毫秒) +LOG_STREAM_CLAIM_INTERVAL_MS = 5000 +# 每次回收的最大消息数量 +LOG_STREAM_CLAIM_BATCH_SIZE = 100 +# 去重 Key 过期时间(秒) +LOG_STREAM_DEDUP_TTL = 3600 +# 去重 Key 前缀 +LOG_STREAM_DEDUP_PREFIX = 'log:dedup' +# stdout 输出是否为 JSON +LOGURU_JSON = false +# Loguru 最低输出级别 +LOGURU_LEVEL = 'INFO' +# 是否输出到 stdout +LOGURU_STDOUT = true +# 是否启用文件日志 +LOG_FILE_ENABLED = true +# 文件日志根目录 +LOG_FILE_BASE_DIR = 'logs' +# 文件滚动策略 +LOGURU_ROTATION = '50MB' +# 文件保留策略 +LOGURU_RETENTION = '30 days' +# 文件压缩格式 +LOGURU_COMPRESSION = 'zip' +# 实例标识(用于区分实例) +LOG_INSTANCE_ID = 'dockerpg' +# 服务名称(用于统一标识服务) +LOG_SERVICE_NAME = 'shierfeng-fastapi-backend' +# Worker 标识(auto 自动生成) +LOG_WORKER_ID = 'auto' + +# -------- 传输层加解密配置 -------- +# 是否启用传输层加解密 +TRANSPORT_CRYPTO_ENABLED = true +# 传输层加解密模式:off=关闭,optional=明文/密文兼容,required=命中接口强制加密 +TRANSPORT_CRYPTO_MODE = 'optional' +# 传输层加解密算法标识 +TRANSPORT_CRYPTO_ALGORITHM = 'RSA_OAEP_AES_256_GCM' +# 当前启用的密钥版本标识 +TRANSPORT_CRYPTO_KID = 'default' +# 传输层RSA位数,需与下方密钥对匹配 +TRANSPORT_CRYPTO_RSA_KEY_SIZE = 4096 +# 传输层公钥,默认提供一套可用示例值;Docker 部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PUBLIC_KEY = '-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwA2ooWpsxLzIVMJp7Wcv\nvR0Bu8paFn8NVPpzz+wGpUlwP5DGK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6Ub\nQVyHJ6BXXIMs/BpzcHCbyXR/wWG+pKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEs\nA81kskVlDdGeNyaOJg5QuofEErCfR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu\n9YbEbKs7JvNle5vjc72ebbMIeGejHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj\n8F/TySLuOy37iVWfD+5ikLyou4ZDI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6\nSrldwZfZDBl3EGgRby8yJqO6SqGgyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqX\nhK67kbYaA9xJeHRaP04cg16imB7sBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6d\nWdJA3qe3iBSSM8pmedv+Jgfau/PFam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIa\nQ6acv+v5N6QVFptlcx6I7j8yZJ7WUHZlB1IxVqfPb69+985eknZyLul60gyu0kPG\nYUecypUu2wiNDBAErZlUxEujMWgJDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSo\nRYxPhTbwo68RJDpImBjn+YsCAwEAAQ==\n-----END PUBLIC KEY-----' +# 传输层私钥,必须与上方公钥成对使用;Docker 部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIIJKAIBAAKCAgEAwA2ooWpsxLzIVMJp7WcvvR0Bu8paFn8NVPpzz+wGpUlwP5DG\nK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6UbQVyHJ6BXXIMs/BpzcHCbyXR/wWG+\npKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEsA81kskVlDdGeNyaOJg5QuofEErCf\nR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu9YbEbKs7JvNle5vjc72ebbMIeGej\nHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj8F/TySLuOy37iVWfD+5ikLyou4ZD\nI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6SrldwZfZDBl3EGgRby8yJqO6SqGg\nyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqXhK67kbYaA9xJeHRaP04cg16imB7s\nBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6dWdJA3qe3iBSSM8pmedv+Jgfau/PF\nam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIaQ6acv+v5N6QVFptlcx6I7j8yZJ7W\nUHZlB1IxVqfPb69+985eknZyLul60gyu0kPGYUecypUu2wiNDBAErZlUxEujMWgJ\nDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSoRYxPhTbwo68RJDpImBjn+YsCAwEA\nAQKCAgEAtH7hwjp8WPY3rPk+hqEYy7psO6q0ujnUNM5hc8MWh9caSJNuu/D51vCK\nHX3d63hITNK+x9ZaM2Jcj/9XC56vm+EzILngARFDgPf3EHC06UO1IfEUND3CoMqs\njS/sEDCwiXpccc/JgkUT7EgluwDL5hLuFWGE1NTxxlFU/U0s7/HTA+G9AFuPQHjt\nZNJxxozscOh0W44OM4/jdebJ4TBEaDqtdpgDMttDwEVFIizOrbi6ODbmpCQaZzDq\nJczGoTZG7c5w5jfRnD1NnDzB0apjr3DQYVOT5EiWA39Vy6o2NmMojX1ksfxKZtll\n83vYZ91vSR5waQvo5nFJB5+vJ0CCy4BZaV9/gQBP/OSElELfD0bGYidO7NURAJMW\njGc2B6uIog8BZ3ix02FO/30i5rWeDWM7McLol8+IP0Qcg473YvrCgmRZpprdc9HT\nHnB6BgIwu0ZBoP7CxW7pBm0ApwmOf7OvUdAu68kFQ4KxABuv+Qegu0vSsktBtmIs\ngUDzu/ekoayyOvFHVwVTd4QKOSa2gXb3TS7PP22j6QLL1OPy2fK2NBW0xrRDIgtw\nSx3Yo0dxCYkxJWz1nQYsdIjZbz2/xQPZZQ5yNeePwxaOKyDuA50elN86I9RR2gjL\nh9QMrvPG7DOlgmBG9+JsydQZf00G+x45Su/1fydA09X3AFtZLkkCggEBAOj8NY/x\n3G3/1qAkrcQYLwB0mjLNkgKchRIP8NMildk0nSub5SRUxleW2wp0kM0WqkFTXLMa\nFR0qCRjiyPOtBBZxLobIfGc6568LTKfg4N7VsCeAcTjFjSOE57iX5XzwhTy6ZCKe\nZFGFWfhj/a9lNQHneTcklDHq/oHjLJQ1FacbWNycIOX2Hk7SZKyJvyMutAem3BI+\nm5SLyj5648N2ylmz6f3eaTn8CyNCrUKWnPriQZfV0XF/Aalh4sq/I3fI6pqnYkHK\nuSoG9YHujGXKN2iOV/0krCiGj94l7JqvKGs4ZRoZdD+s1EugGD7qBK1wGATuEseg\nR6mS74ylgD88JPcCggEBANMGWrqhHOAtGeIewLbNob54+nqdwU/O+zk0RcTZErcD\naRZMTLPRlpdbgWbNgdfjFnbUx0WmIeTIboD2MaW5KOnDfV/x+eRhGtEmtNRvHA/o\nHK6uYzok7Ekm7oc298CYrfRbEWVx3m4+mHmU+rsvBeof664zpEEIsSwm+NaAnjz8\nru0U8xw8KWLB8F/Q4J4p4D0yVKCmAXmrrTgEYm1H355JlAlmiu6t6YPS2Xd+gNFD\ntWBsQXYnxEZyPhoD1Q4SQjQmQMEN7+lIHm8f/nMwwUkAd3y6D1w/Uu81Gqa/9eAh\nz3woK++tj/U1CMMTWXJumIyJdH28CWQJa9VdJBoFbw0CggEAdIBhPDhh1DNhHDUb\nGvpIzn5/+LVotJuVwwFrl/gsXC9+BCdxPmiRwYyyvRiqq5MQ0ZegvAJn2myBngsR\nFyBF8f7omAc6hdgjsBkDXNMLPwI1kpscgpnuSHuV720tGPugdExz9Ael/EmlQpql\naQY/qlMX/uXwoMF0QHjbesTMrgHzvmTn4nXek+WK5+f9Rtd8uHLMiub5nx8Do5iJ\nudz1tENN119W2OLaougdgTWVC7MFv6nwkENFDnDfGijX0HcMMQdQD7wSORy/uRgS\n5ndmm4bKItAqsh0PZbMrC/JYUL0jeRiPU6PViHdmiFc2vY9Ww2hUxbO1Aetyk67S\nYUxu4wKCAQAvSOQ5n3JV9SUwms156LfOc1NE+GZhmLKITeM4SZ+87IG2omAphtQk\nlDd5rqDinBrjg6gnPiOoHRVNxly3krbNMqW8Qv9Iok2dAfxRAZibI9qRdbf8Rlu/\nxH58Q9/eAxgvgdxzC8HYmCQYUj6ghNfhb0ejICU1AVqZ1x25CtbqOYCE1UXoVL69\nR1GyVp6OMjnx3H5EBQ6dkc9dlvXrIMjFshz+wkBtXQDPLgbWlL0OpwpUUc2VSTHc\nyyqJL8Skw4icINovqAzTC/rt0ZB1hT46OmWLyDE67WGLAi43oRnaIBla67F0okJ4\nomqVM5e+YXPDQeWdau37wXStOZKmVgNdAoIBADojGo0h9mBgnr+u1oYB+mKx6LVD\n3TTy45IB1ikqprBnSjgXNbQycsTbl+qDo5ge+KqlPNk6Scvn0L7k43/VB9Y5qK2s\nBgxa1KgdeC5WUNU0rs/1UKIODA5SlWIk6JqekiAE+glljVZ5E53l93gPL3uRcvr5\nSD5CPe+qqoBh9nYIRJDogP0e2xV11EuE10j1WxuLkHL5//hePGPpgnb0/rZkP+vb\nkzwz1fTv88kQDnRk6uIe0L78iFTpEwAnlDmuMJ4KafKnujaR5VVCoI7bwryCp4+f\n8zyU7ZpKo/2EE8bYmxHMDPiYByJxCwAbm2Xn7Kw4H/17MLJOxg8685A8jyA=\n-----END RSA PRIVATE KEY-----' +# 历史密钥对配置,JSON数组格式,密钥轮换说明见 docs/transport_crypto_deployment.md +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS = '[]' +# 公钥缓存有效期(秒) +TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS = 3600 +# 前端传输加密策略缓存有效期(秒) +TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS = 300 +# GET/DELETE 请求参数加密后的最大 URL 长度 +TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH = 4096 +# 请求时间窗允许偏差(秒) +TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS = 120 +# 防重放随机数有效期(秒) +TRANSPORT_CRYPTO_REPLAY_TTL_SECONDS = 300 +# 启用传输层加密的路径列表,多个值使用逗号分隔,留空表示默认全部启用 +TRANSPORT_CRYPTO_ENABLED_PATHS = '' +# 强制要求传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_REQUIRED_PATHS = '' +# 排除传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_EXCLUDE_PATHS = '/openapi.json,/docs,/docs/oauth2-redirect,/redoc,/transport/crypto/frontend-config,/transport/crypto/public-key,/common/download,/common/download/resource' diff --git a/shierfeng-fastapi-backend/.env.prod b/shierfeng-fastapi-backend/.env.prod new file mode 100644 index 0000000..7c52633 --- /dev/null +++ b/shierfeng-fastapi-backend/.env.prod @@ -0,0 +1,173 @@ +# -------- 应用配置 -------- +# 应用运行环境 +APP_ENV = 'prod' +# 应用名称 +APP_NAME = 'ShiErFeng-FastAPI' +# 应用代理路径 +APP_ROOT_PATH = '/prod-api' +# 应用主机 +APP_HOST = '0.0.0.0' +# 应用端口 +APP_PORT = 9099 +# 应用版本 +APP_VERSION= '1.9.0' +# 应用是否开启热重载 +APP_RELOAD = false +# 应用工作进程数 +APP_WORKERS = 1 +# 应用是否开启IP归属区域查询 +APP_IP_LOCATION_QUERY = true +# 应用是否允许账号同时登录 +APP_SAME_TIME_LOGIN = true +# 应用是否为演示模式 +APP_DEMO_MODE = false +# 应用是否禁用Swagger文档 +APP_DISABLE_SWAGGER = true +# 应用是否禁用ReDoc文档 +APP_DISABLE_REDOC = true +# 可信代理IP列表,多个值使用逗号分隔 +APP_TRUSTED_PROXY_IPS = '127.0.0.1,::1' +# 可信代理跳数,单层Nginx代理通常为1 +APP_TRUSTED_PROXY_HOPS = 1 + +# -------- Jwt配置 -------- +# Jwt秘钥 +JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55' +# Jwt算法 +JWT_ALGORITHM = 'HS256' +# 令牌过期时间 +JWT_EXPIRE_MINUTES = 1440 +# redis中令牌过期时间 +JWT_REDIS_EXPIRE_MINUTES = 30 + + +# -------- 数据库配置 -------- +# 数据库类型,可选的有'mysql'、'postgresql',默认为'mysql' +DB_TYPE = 'mysql' +# 数据库主机 +DB_HOST = '127.0.0.1' +# 数据库端口 +DB_PORT = 3306 +# 数据库用户名 +DB_USERNAME = 'root' +# 数据库密码 +DB_PASSWORD = 'root' +# 数据库名称 +DB_DATABASE = 'shierfeng-fastapi' +# 是否开启sqlalchemy日志 +DB_ECHO = true +# 允许溢出连接池大小的最大连接数 +DB_MAX_OVERFLOW = 10 +# 连接池大小,0表示连接数无限制 +DB_POOL_SIZE = 50 +# 连接回收时间(单位:秒) +DB_POOL_RECYCLE = 3600 +# 连接池中没有线程可用时,最多等待的时间(单位:秒) +DB_POOL_TIMEOUT = 30 + +# -------- Redis配置 -------- +# Redis主机 +REDIS_HOST = '127.0.0.1' +# Redis端口 +REDIS_PORT = 6379 +# Redis用户名 +REDIS_USERNAME = '' +# Redis密码 +REDIS_PASSWORD = '' +# Redis数据库 +REDIS_DATABASE = 2 + +# -------- 日志配置 -------- +# 是否启用日志脱敏 +LOG_MASK_ENABLED = true +# 日志脱敏占位符 +LOG_MASK_PLACEHOLDER = '******' +# 以下三项为互补关系(非互斥): +# 1) LOG_MASK_FIELDS:命中后执行全量脱敏 +# 2) LOG_PARTIAL_MASK_FIELDS:命中后执行部分脱敏 +# 3) LOG_CONFIG_SECRET_PATTERNS:按 configKey 关键词决定是否脱敏 configValue +# 全量脱敏字段,多个值使用逗号分隔 +LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt' +# 部分脱敏字段,多个值使用逗号分隔 +# 当前默认不对IP脱敏;如后期需要开启,可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务 +LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email' +# 按配置键名识别敏感配置的关键词,多个值使用逗号分隔 +LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms' +# Redis Stream Key +LOG_STREAM_KEY = 'log:stream' +# Redis Stream 消费组名称 +LOG_STREAM_GROUP = 'log_aggregator' +# Redis Stream 消费者名称前缀 +LOG_STREAM_CONSUMER_PREFIX = 'worker' +# 每次读取的最大消息数量 +LOG_STREAM_BATCH_SIZE = 100 +# 阻塞读取等待时间(毫秒) +LOG_STREAM_BLOCK_MS = 2000 +# Stream 最大长度(近似裁剪) +LOG_STREAM_MAXLEN = 100000 +# Pending 回收最小空闲时间(毫秒) +LOG_STREAM_CLAIM_IDLE_MS = 60000 +# Pending 回收检查间隔(毫秒) +LOG_STREAM_CLAIM_INTERVAL_MS = 5000 +# 每次回收的最大消息数量 +LOG_STREAM_CLAIM_BATCH_SIZE = 100 +# 去重 Key 过期时间(秒) +LOG_STREAM_DEDUP_TTL = 3600 +# 去重 Key 前缀 +LOG_STREAM_DEDUP_PREFIX = 'log:dedup' +# stdout 输出是否为 JSON +LOGURU_JSON = false +# Loguru 最低输出级别 +LOGURU_LEVEL = 'INFO' +# 是否输出到 stdout +LOGURU_STDOUT = true +# 是否启用文件日志 +LOG_FILE_ENABLED = true +# 文件日志根目录 +LOG_FILE_BASE_DIR = 'logs' +# 文件滚动策略 +LOGURU_ROTATION = '50MB' +# 文件保留策略 +LOGURU_RETENTION = '30 days' +# 文件压缩格式 +LOGURU_COMPRESSION = 'zip' +# 实例标识(用于区分实例) +LOG_INSTANCE_ID = 'prod' +# 服务名称(用于统一标识服务) +LOG_SERVICE_NAME = 'shierfeng-fastapi-backend' +# Worker 标识(auto 自动生成) +LOG_WORKER_ID = 'auto' + +# -------- 传输层加解密配置 -------- +# 是否启用传输层加解密 +TRANSPORT_CRYPTO_ENABLED = true +# 传输层加解密模式:off=关闭,optional=明文/密文兼容,required=命中接口强制加密 +TRANSPORT_CRYPTO_MODE = 'optional' +# 传输层加解密算法标识 +TRANSPORT_CRYPTO_ALGORITHM = 'RSA_OAEP_AES_256_GCM' +# 当前启用的密钥版本标识 +TRANSPORT_CRYPTO_KID = 'default' +# 传输层RSA位数,需与下方密钥对匹配 +TRANSPORT_CRYPTO_RSA_KEY_SIZE = 4096 +# 传输层公钥,默认提供一套可用示例值;生产部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PUBLIC_KEY = '-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwA2ooWpsxLzIVMJp7Wcv\nvR0Bu8paFn8NVPpzz+wGpUlwP5DGK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6Ub\nQVyHJ6BXXIMs/BpzcHCbyXR/wWG+pKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEs\nA81kskVlDdGeNyaOJg5QuofEErCfR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu\n9YbEbKs7JvNle5vjc72ebbMIeGejHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj\n8F/TySLuOy37iVWfD+5ikLyou4ZDI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6\nSrldwZfZDBl3EGgRby8yJqO6SqGgyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqX\nhK67kbYaA9xJeHRaP04cg16imB7sBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6d\nWdJA3qe3iBSSM8pmedv+Jgfau/PFam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIa\nQ6acv+v5N6QVFptlcx6I7j8yZJ7WUHZlB1IxVqfPb69+985eknZyLul60gyu0kPG\nYUecypUu2wiNDBAErZlUxEujMWgJDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSo\nRYxPhTbwo68RJDpImBjn+YsCAwEAAQ==\n-----END PUBLIC KEY-----' +# 传输层私钥,必须与上方公钥成对使用;生产部署前请替换为正式密钥 +TRANSPORT_CRYPTO_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIIJKAIBAAKCAgEAwA2ooWpsxLzIVMJp7WcvvR0Bu8paFn8NVPpzz+wGpUlwP5DG\nK6pBGItsglNMZx56MSYMp3zVyqB95XUVZ6UbQVyHJ6BXXIMs/BpzcHCbyXR/wWG+\npKxQ8UEwaHVhK8X21xW1R0kzzwhgMw51unEsA81kskVlDdGeNyaOJg5QuofEErCf\nR1y0e+iqd1PBpIwdEY5L+BzvbVtyhsPz6dBu9YbEbKs7JvNle5vjc72ebbMIeGej\nHFQRYxihuamPCAEylj1qqpHk8U+r+3icxQsj8F/TySLuOy37iVWfD+5ikLyou4ZD\nI3hOYnIYHl194ZM5xVyOGBD/xdqZadXTLqL6SrldwZfZDBl3EGgRby8yJqO6SqGg\nyvyGWXZAaHoPMmF+quu/nUooqnp0fpl+LCqXhK67kbYaA9xJeHRaP04cg16imB7s\nBIXBqzkyZtkhC2BtlL0h5X7dRlAddrQ23z6dWdJA3qe3iBSSM8pmedv+Jgfau/PF\nam2051HqFxvJEh/jnc6rq1aIjL/d4Kk5imIaQ6acv+v5N6QVFptlcx6I7j8yZJ7W\nUHZlB1IxVqfPb69+985eknZyLul60gyu0kPGYUecypUu2wiNDBAErZlUxEujMWgJ\nDFYCSonHxtwr88gDInjP0lvwd/OgqjDQ7hSoRYxPhTbwo68RJDpImBjn+YsCAwEA\nAQKCAgEAtH7hwjp8WPY3rPk+hqEYy7psO6q0ujnUNM5hc8MWh9caSJNuu/D51vCK\nHX3d63hITNK+x9ZaM2Jcj/9XC56vm+EzILngARFDgPf3EHC06UO1IfEUND3CoMqs\njS/sEDCwiXpccc/JgkUT7EgluwDL5hLuFWGE1NTxxlFU/U0s7/HTA+G9AFuPQHjt\nZNJxxozscOh0W44OM4/jdebJ4TBEaDqtdpgDMttDwEVFIizOrbi6ODbmpCQaZzDq\nJczGoTZG7c5w5jfRnD1NnDzB0apjr3DQYVOT5EiWA39Vy6o2NmMojX1ksfxKZtll\n83vYZ91vSR5waQvo5nFJB5+vJ0CCy4BZaV9/gQBP/OSElELfD0bGYidO7NURAJMW\njGc2B6uIog8BZ3ix02FO/30i5rWeDWM7McLol8+IP0Qcg473YvrCgmRZpprdc9HT\nHnB6BgIwu0ZBoP7CxW7pBm0ApwmOf7OvUdAu68kFQ4KxABuv+Qegu0vSsktBtmIs\ngUDzu/ekoayyOvFHVwVTd4QKOSa2gXb3TS7PP22j6QLL1OPy2fK2NBW0xrRDIgtw\nSx3Yo0dxCYkxJWz1nQYsdIjZbz2/xQPZZQ5yNeePwxaOKyDuA50elN86I9RR2gjL\nh9QMrvPG7DOlgmBG9+JsydQZf00G+x45Su/1fydA09X3AFtZLkkCggEBAOj8NY/x\n3G3/1qAkrcQYLwB0mjLNkgKchRIP8NMildk0nSub5SRUxleW2wp0kM0WqkFTXLMa\nFR0qCRjiyPOtBBZxLobIfGc6568LTKfg4N7VsCeAcTjFjSOE57iX5XzwhTy6ZCKe\nZFGFWfhj/a9lNQHneTcklDHq/oHjLJQ1FacbWNycIOX2Hk7SZKyJvyMutAem3BI+\nm5SLyj5648N2ylmz6f3eaTn8CyNCrUKWnPriQZfV0XF/Aalh4sq/I3fI6pqnYkHK\nuSoG9YHujGXKN2iOV/0krCiGj94l7JqvKGs4ZRoZdD+s1EugGD7qBK1wGATuEseg\nR6mS74ylgD88JPcCggEBANMGWrqhHOAtGeIewLbNob54+nqdwU/O+zk0RcTZErcD\naRZMTLPRlpdbgWbNgdfjFnbUx0WmIeTIboD2MaW5KOnDfV/x+eRhGtEmtNRvHA/o\nHK6uYzok7Ekm7oc298CYrfRbEWVx3m4+mHmU+rsvBeof664zpEEIsSwm+NaAnjz8\nru0U8xw8KWLB8F/Q4J4p4D0yVKCmAXmrrTgEYm1H355JlAlmiu6t6YPS2Xd+gNFD\ntWBsQXYnxEZyPhoD1Q4SQjQmQMEN7+lIHm8f/nMwwUkAd3y6D1w/Uu81Gqa/9eAh\nz3woK++tj/U1CMMTWXJumIyJdH28CWQJa9VdJBoFbw0CggEAdIBhPDhh1DNhHDUb\nGvpIzn5/+LVotJuVwwFrl/gsXC9+BCdxPmiRwYyyvRiqq5MQ0ZegvAJn2myBngsR\nFyBF8f7omAc6hdgjsBkDXNMLPwI1kpscgpnuSHuV720tGPugdExz9Ael/EmlQpql\naQY/qlMX/uXwoMF0QHjbesTMrgHzvmTn4nXek+WK5+f9Rtd8uHLMiub5nx8Do5iJ\nudz1tENN119W2OLaougdgTWVC7MFv6nwkENFDnDfGijX0HcMMQdQD7wSORy/uRgS\n5ndmm4bKItAqsh0PZbMrC/JYUL0jeRiPU6PViHdmiFc2vY9Ww2hUxbO1Aetyk67S\nYUxu4wKCAQAvSOQ5n3JV9SUwms156LfOc1NE+GZhmLKITeM4SZ+87IG2omAphtQk\nlDd5rqDinBrjg6gnPiOoHRVNxly3krbNMqW8Qv9Iok2dAfxRAZibI9qRdbf8Rlu/\nxH58Q9/eAxgvgdxzC8HYmCQYUj6ghNfhb0ejICU1AVqZ1x25CtbqOYCE1UXoVL69\nR1GyVp6OMjnx3H5EBQ6dkc9dlvXrIMjFshz+wkBtXQDPLgbWlL0OpwpUUc2VSTHc\nyyqJL8Skw4icINovqAzTC/rt0ZB1hT46OmWLyDE67WGLAi43oRnaIBla67F0okJ4\nomqVM5e+YXPDQeWdau37wXStOZKmVgNdAoIBADojGo0h9mBgnr+u1oYB+mKx6LVD\n3TTy45IB1ikqprBnSjgXNbQycsTbl+qDo5ge+KqlPNk6Scvn0L7k43/VB9Y5qK2s\nBgxa1KgdeC5WUNU0rs/1UKIODA5SlWIk6JqekiAE+glljVZ5E53l93gPL3uRcvr5\nSD5CPe+qqoBh9nYIRJDogP0e2xV11EuE10j1WxuLkHL5//hePGPpgnb0/rZkP+vb\nkzwz1fTv88kQDnRk6uIe0L78iFTpEwAnlDmuMJ4KafKnujaR5VVCoI7bwryCp4+f\n8zyU7ZpKo/2EE8bYmxHMDPiYByJxCwAbm2Xn7Kw4H/17MLJOxg8685A8jyA=\n-----END RSA PRIVATE KEY-----' +# 历史密钥对配置,JSON数组格式,密钥轮换说明见 docs/transport_crypto_deployment.md +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS = '[]' +# 公钥缓存有效期(秒) +TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS = 3600 +# 前端传输加密策略缓存有效期(秒) +TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS = 300 +# GET/DELETE 请求参数加密后的最大 URL 长度 +TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH = 4096 +# 请求时间窗允许偏差(秒) +TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS = 120 +# 防重放随机数有效期(秒) +TRANSPORT_CRYPTO_REPLAY_TTL_SECONDS = 300 +# 启用传输层加密的路径列表,多个值使用逗号分隔,留空表示默认全部启用 +TRANSPORT_CRYPTO_ENABLED_PATHS = '' +# 强制要求传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_REQUIRED_PATHS = '' +# 排除传输层加密的路径列表,多个值使用逗号分隔 +TRANSPORT_CRYPTO_EXCLUDE_PATHS = '/openapi.json,/docs,/docs/oauth2-redirect,/redoc,/transport/crypto/frontend-config,/transport/crypto/public-key,/common/download,/common/download/resource' diff --git a/shierfeng-fastapi-backend/Dockerfile.my b/shierfeng-fastapi-backend/Dockerfile.my new file mode 100644 index 0000000..49cff5b --- /dev/null +++ b/shierfeng-fastapi-backend/Dockerfile.my @@ -0,0 +1,14 @@ +FROM python:3.10 +WORKDIR /app + +# 复制源代码 +COPY . . + +# 安装依赖 +RUN pip install --no-cache-dir -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple + +# 暴露端口 +EXPOSE 9099 + +# 启动命令 +CMD ["shierfeng", "app", "run", "--env=dockermy"] diff --git a/shierfeng-fastapi-backend/Dockerfile.pg b/shierfeng-fastapi-backend/Dockerfile.pg new file mode 100644 index 0000000..e725883 --- /dev/null +++ b/shierfeng-fastapi-backend/Dockerfile.pg @@ -0,0 +1,14 @@ +FROM python:3.10 +WORKDIR /app + +# 复制源代码 +COPY . . + +# 安装依赖 +RUN pip install --no-cache-dir -r requirements-pg.txt -i https://pypi.tuna.tsinghua.edu.cn/simple + +# 暴露端口 +EXPOSE 9099 + +# 启动命令 +CMD ["shierfeng", "app", "run", "--env=dockerpg"] diff --git a/shierfeng-fastapi-backend/alembic.ini b/shierfeng-fastapi-backend/alembic.ini new file mode 100644 index 0000000..d9a7ee9 --- /dev/null +++ b/shierfeng-fastapi-backend/alembic.ini @@ -0,0 +1,153 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library. +# Any required deps can installed by adding `alembic[tz]` to the pip requirements +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to /versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +sqlalchemy.url = driver://user:pass@localhost/dbname + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S + +[settings] +# This section is used to set environment variables for the alembic. +# The env option is used to specify the environment for the alembic. +# It can be set to dev or prod. +env = dev diff --git a/shierfeng-fastapi-backend/alembic/README b/shierfeng-fastapi-backend/alembic/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/shierfeng-fastapi-backend/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/shierfeng-fastapi-backend/alembic/env.py b/shierfeng-fastapi-backend/alembic/env.py new file mode 100644 index 0000000..922aa03 --- /dev/null +++ b/shierfeng-fastapi-backend/alembic/env.py @@ -0,0 +1,135 @@ +import asyncio +import os +from collections.abc import Iterable, MutableMapping +from logging.config import fileConfig +from typing import Literal + +from alembic import context +from alembic.migration import MigrationContext +from alembic.operations.ops import MigrationScript +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config + +from config.database import ASYNC_SQLALCHEMY_DATABASE_URL, Base +from utils.import_util import ImportUtil + +# 判断vesrions目录是否存在,如果不存在则创建 +alembic_veresions_path = 'alembic/versions' +if not os.path.exists(alembic_veresions_path): + os.makedirs(alembic_veresions_path) + + +# 自动查找所有模型 +found_models = ImportUtil.find_models(Base) + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +alembic_config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if alembic_config.config_file_name is not None: + fileConfig(alembic_config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +target_metadata = Base.metadata +# ASYNC_SQLALCHEMY_DATABASE_URL = 'mysql+asyncmy://root:mysqlroot@127.0.0.1:3306/shierfeng-fastapi' +# other values from the config, defined by the needs of env.py, +alembic_config.set_main_option('sqlalchemy.url', ASYNC_SQLALCHEMY_DATABASE_URL) + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = alembic_config.get_main_option('sqlalchemy.url') + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={'paramstyle': 'named'}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def do_run_migrations(connection: Connection) -> None: + def include_name( + name: str | None, + type_: Literal['schema', 'table', 'column', 'index', 'unique_constraint', 'foreign_key_constraint'], + parent_names: MutableMapping[Literal['schema_name', 'table_name', 'schema_qualified_table_name'], str | None], + ) -> bool: + if type_ == 'table': + return name in target_metadata.tables + return True + + def process_revision_directives( + context: MigrationContext, + revision: str | Iterable[str | None] | Iterable[str], + directives: list[MigrationScript], + ) -> None: + script = directives[0] + + # 检查所有操作集是否为空 + all_empty = all(ops.is_empty() for ops in script.upgrade_ops_list) + + if all_empty: + # 如果没有实际变更,不生成迁移文件 + directives[:] = [] + print('❎️ 未检测到模型变更,不生成迁移文件') + else: + print('✅️ 检测到模型变更,生成迁移文件') + + context.configure( + connection=connection, + target_metadata=target_metadata, + compare_type=True, + compare_server_default=True, + transaction_per_migration=True, + include_name=include_name, + process_revision_directives=process_revision_directives, + ) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + connectable = async_engine_from_config( + alembic_config.get_section(alembic_config.config_ini_section, {}), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/shierfeng-fastapi-backend/alembic/script.py.mako b/shierfeng-fastapi-backend/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/shierfeng-fastapi-backend/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/shierfeng-fastapi-backend/app.py b/shierfeng-fastapi-backend/app.py new file mode 100644 index 0000000..1ae0470 --- /dev/null +++ b/shierfeng-fastapi-backend/app.py @@ -0,0 +1,18 @@ +import uvicorn + +from config.env import AppConfig +from server import create_app + +if __name__ != '__main__': + app = create_app() + +if __name__ == '__main__': + uvicorn.run( + app='server:create_app', + host=AppConfig.app_host, + port=AppConfig.app_port, + root_path=AppConfig.app_root_path, + reload=AppConfig.app_reload, + workers=AppConfig.app_workers, + factory=True, + ) diff --git a/shierfeng-fastapi-backend/assets/font/Arial.ttf b/shierfeng-fastapi-backend/assets/font/Arial.ttf new file mode 100644 index 0000000..9512aea Binary files /dev/null and b/shierfeng-fastapi-backend/assets/font/Arial.ttf differ diff --git a/shierfeng-fastapi-backend/cli/__init__.py b/shierfeng-fastapi-backend/cli/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/bootstrap.py b/shierfeng-fastapi-backend/cli/bootstrap.py new file mode 100644 index 0000000..b70f42f --- /dev/null +++ b/shierfeng-fastapi-backend/cli/bootstrap.py @@ -0,0 +1,56 @@ +import os + +from cli.runtime import RUNTIME_ENVIRONMENT, RuntimeEnvironmentService + + +class AppBootstrapService: + """ + 应用引导服务。 + + 该服务负责解析应用原始入口路径、构建启动命令,并以 `exec` + 方式将当前 CLI 进程切换为 FastAPI 应用入口进程。 + """ + + def __init__(self, *, runtime_environment: RuntimeEnvironmentService | None = None) -> None: + """ + 初始化应用引导服务。 + + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.runtime_environment = runtime_environment or RUNTIME_ENVIRONMENT + + def get_app_entry_path(self) -> str: + """ + 获取应用启动入口路径。 + + :return: 应用启动入口绝对路径 + """ + return os.path.join(self.runtime_environment.get_backend_dir(), 'app.py') + + def build_app_run_command(self, env: str) -> list[str]: + """ + 构建应用启动命令。 + + :param env: 运行环境 + :return: 应用启动命令参数列表 + """ + return [ + self.runtime_environment.get_python_executable(), + self.get_app_entry_path(), + '--env', + env, + ] + + def exec_app_run_command(self, env: str) -> None: + """ + 以应用原始入口进程启动当前 FastAPI 应用。 + + :param env: 运行环境 + :return: None + """ + command = self.build_app_run_command(env) + os.execvp(command[0], command) + + +APP_BOOTSTRAP = AppBootstrapService() diff --git a/shierfeng-fastapi-backend/cli/completion/__init__.py b/shierfeng-fastapi-backend/cli/completion/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/completion/commands.py b/shierfeng-fastapi-backend/cli/completion/commands.py new file mode 100644 index 0000000..1dce26b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/commands.py @@ -0,0 +1,155 @@ +from dataclasses import dataclass, field +from pathlib import Path + +import typer + +from cli.completion.controller import CompletionCommandController +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY, CompletionProviderGateway +from cli.context import OutputOption + + +@dataclass(frozen=True) +class CompletionCommandRegistration: + """ + completion 子命令注册描述。 + + :param name: 子命令名称 + :param help_text: 子命令帮助文本 + """ + + name: str + help_text: str + + +@dataclass +class CompletionSubcommandRegistrar: + """ + completion 子命令注册器。 + + 该对象负责将 `show/install/doctor` 子命令挂载到 completion 应用, + 将 Typer 命令声明细节从构建器主体中拆出。 + + :param completion_provider_gateway: completion 提供器对外网关 + """ + + completion_provider_gateway: CompletionProviderGateway = field(default_factory=lambda: COMPLETION_PROVIDER_GATEWAY) + + @staticmethod + def build_registrations() -> tuple[CompletionCommandRegistration, ...]: + """ + 返回 completion 子命令注册描述列表。 + + :return: 子命令注册描述元组 + """ + return ( + CompletionCommandRegistration(name='show', help_text='输出指定 shell 的 completion 脚本'), + CompletionCommandRegistration(name='install', help_text='安装指定 shell 的 completion 脚本'), + CompletionCommandRegistration(name='doctor', help_text='检查当前 completion 配置状态'), + ) + + def register(self, app: typer.Typer, *, controller: CompletionCommandController) -> None: + """ + 向 completion 应用注册全部子命令。 + + :param app: completion 子应用 + :param controller: completion 命令控制器 + :return: None + """ + registrations = {registration.name: registration for registration in self.build_registrations()} + + @app.command(registrations['show'].name, help=registrations['show'].help_text) + def show( + shell: str = typer.Argument( + ..., + help='shell 名称,如 bash、zsh、fish', + autocompletion=self.completion_provider_gateway.complete_shell_names, + ), + ) -> None: + """ + 输出指定 shell 的 completion 脚本。 + + :param shell: shell 名称 + :return: None + """ + controller.show(shell) + + @app.command(registrations['install'].name, help=registrations['install'].help_text) + def install( + shell: str | None = typer.Option( + None, + '--shell', + help='shell 名称,默认自动识别当前 shell', + autocompletion=self.completion_provider_gateway.complete_shell_names, + ), + output: OutputOption = 'text', + target_file: Path | None = typer.Option(None, '--target-file', help='completion 脚本目标文件路径'), + activate: bool = typer.Option(False, '--activate', help='将激活命令写入 shell rc 文件'), + rc_file: Path | None = typer.Option(None, '--rc-file', help='自定义 shell rc 文件路径'), + force: bool = typer.Option(False, '--force', help='覆盖已存在且内容不同的目标文件'), + ) -> None: + """ + 安装指定 shell 的 completion 脚本。 + + :param shell: shell 名称,默认自动识别当前 shell + :param output: 输出格式 + :param target_file: completion 脚本目标文件路径 + :param activate: 是否写入 shell rc 文件激活命令 + :param rc_file: 自定义 shell rc 文件路径 + :param force: 是否强制覆盖已存在文件 + :return: None + """ + controller.install( + output, + shell=shell, + target_file=target_file, + activate=activate, + rc_file=rc_file, + force=force, + ) + + @app.command(registrations['doctor'].name, help=registrations['doctor'].help_text) + def doctor( + output: OutputOption = 'text', + ) -> None: + """ + 检查当前 completion 配置状态。 + + :param output: 输出格式 + :return: None + """ + controller.doctor(output) + + +@dataclass +class CompletionCommandBuilder: + """ + completion 子应用构建器。 + + 该构建器负责装配 `completion` 子应用,并将控制器实例和子命令注册 + 细节收口到类式对象协作中。 + + :param completion_subcommand_registrar: completion 子命令注册器 + """ + + completion_subcommand_registrar: CompletionSubcommandRegistrar = field( + default_factory=CompletionSubcommandRegistrar + ) + + def build(self, root_cli: typer.Typer) -> typer.Typer: + """ + 构建 completion 命令组。 + + :param root_cli: 根 Typer 应用 + :return: completion 子应用 + """ + app = typer.Typer( + help='shell completion 相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, + ) + completion_command_controller = CompletionCommandController(root_cli) + self.completion_subcommand_registrar.register(app, controller=completion_command_controller) + return app + + +COMPLETION_COMMAND_BUILDER = CompletionCommandBuilder() diff --git a/shierfeng-fastapi-backend/cli/completion/controller.py b/shierfeng-fastapi-backend/cli/completion/controller.py new file mode 100644 index 0000000..16a7632 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/controller.py @@ -0,0 +1,116 @@ +from pathlib import Path + +import typer + +from cli.completion.doctor import COMPLETION_DOCTOR, CompletionDoctorService +from cli.completion.installers import COMPLETION_INSTALLER, CompletionInstallerService +from cli.completion.presenter import CompletionCommandPresenter +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) + + +class CompletionCommandController: + """ + completion 命令控制器。 + + 该控制器负责组织 `completion` 命令组的上下文准备、payload 生成、 + 文本渲染与脚本输出收口。 + + :param root_cli: 根 Typer 应用 + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: completion 命令文本渲染器 + :param installer_service: completion 安装与脚本生成服务 + :param doctor_service: completion 诊断服务 + """ + + def __init__( + self, + root_cli: typer.Typer, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: CompletionCommandPresenter | None = None, + installer_service: CompletionInstallerService | None = None, + doctor_service: CompletionDoctorService | None = None, + ) -> None: + """ + 初始化 completion 命令控制器。 + + :param root_cli: 根 Typer 应用 + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: completion 命令文本渲染器 + :param installer_service: completion 安装与脚本生成服务 + :param doctor_service: completion 诊断服务 + :return: None + """ + self.root_cli = root_cli + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or CompletionCommandPresenter() + self.installer_service = installer_service or COMPLETION_INSTALLER + self.doctor_service = doctor_service or COMPLETION_DOCTOR + + def show(self, shell: str) -> None: + """ + 输出指定 shell 的 completion 脚本。 + + :param shell: shell 名称 + :return: None + """ + typer.echo(self.installer_service.render_completion_script(self.root_cli, shell), nl=False) + + def install( + self, + output: str, + *, + shell: str | None, + target_file: Path | None, + activate: bool, + rc_file: Path | None, + force: bool, + ) -> None: + """ + 安装指定 shell 的 completion 脚本。 + + :param output: 输出格式 + :param shell: shell 名称 + :param target_file: completion 脚本目标文件路径 + :param activate: 是否写入 shell rc 文件激活命令 + :param rc_file: 自定义 shell rc 文件路径 + :param force: 是否强制覆盖已存在文件 + :return: None + """ + ctx = self.context_factory.build_readonly('dev', output) + payload = self.installer_service.install_completion_script( + self.root_cli, + shell, + target_file=target_file, + activate=activate, + rc_file=rc_file, + force=force, + ) + self.execution_service.complete_payload_result( + ctx, + payload, + text_builder=self.presenter.build_completion_install_text, + ) + + def doctor(self, output: str) -> None: + """ + 检查当前 completion 配置状态。 + + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly('dev', output) + payload = self.doctor_service.build_completion_doctor_payload() + self.execution_service.complete_payload_result( + ctx, + payload, + text_builder=self.presenter.build_completion_doctor_text, + ) diff --git a/shierfeng-fastapi-backend/cli/completion/doctor.py b/shierfeng-fastapi-backend/cli/completion/doctor.py new file mode 100644 index 0000000..7d18d29 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/doctor.py @@ -0,0 +1,95 @@ +from pathlib import Path +from typing import Any + +from cli.completion.installers import ( + CLICK_COMPLETE_ENV_VAR, + COMPLETION_INSTALLER, + CompletionInstallerService, +) +from cli.metadata import ( + COMPLETION_SHELL_SPEC_REGISTRY, + ENVIRONMENT_OPTION_SERVICE, + CompletionShellSpecRegistry, + EnvironmentOptionService, +) + + +class CompletionDoctorService: + """ + completion 诊断服务。 + + 该服务负责汇总活跃 shell、目标脚本路径、rc 文件状态、推荐安装命令 + 与环境候选列表,生成 `completion doctor` 所需的结构化结果。 + + :param installer_service: completion 安装服务 + :param shell_spec_registry: shell 元数据注册表 + :param environment_option_service: 环境选项服务 + """ + + def __init__( + self, + *, + installer_service: CompletionInstallerService | None = None, + shell_spec_registry: CompletionShellSpecRegistry | None = None, + environment_option_service: EnvironmentOptionService | None = None, + ) -> None: + """ + 初始化 completion 诊断服务。 + + :param installer_service: completion 安装服务 + :param shell_spec_registry: shell 元数据注册表 + :param environment_option_service: 环境选项服务 + :return: None + """ + self.installer_service = installer_service or COMPLETION_INSTALLER + self.shell_spec_registry = shell_spec_registry or COMPLETION_SHELL_SPEC_REGISTRY + self.environment_option_service = environment_option_service or ENVIRONMENT_OPTION_SERVICE + + def build_completion_doctor_payload(self) -> dict[str, Any]: + """ + 构建 completion 诊断结果。 + + :return: 诊断结果字典 + """ + active_shell = self.installer_service.detect_active_shell() + shells: dict[str, dict[str, Any]] = {} + for shell_name, shell_spec in self.shell_spec_registry.specs.items(): + target_file = self.installer_service.resolve_completion_target(shell_name) + rc_file = self.installer_service.resolve_completion_rc_file(shell_name) + source_command = None + if shell_spec.supported and shell_spec.generator in {'click', 'custom'}: + source_command = self.installer_service.build_source_command(target_file, shell_name) + recommended_install_command = f'shierfeng completion install --shell={shell_name}' + if shell_spec.supported and not shell_spec.auto_discovery: + recommended_install_command = f'{recommended_install_command} --activate' + shells[shell_name] = { + 'supported': shell_spec.supported, + 'detected': shell_name == active_shell, + 'description': shell_spec.description, + 'targetFile': str(target_file), + 'targetFileExists': target_file.exists(), + 'rcFile': str(rc_file) if rc_file is not None else None, + 'rcFileExists': rc_file.exists() if rc_file is not None else None, + 'autoDiscovery': shell_spec.auto_discovery, + 'sourceCommand': source_command, + 'recommendedInstallCommand': recommended_install_command, + } + + recommended_shell = active_shell if self.shell_spec_registry.get_spec(active_shell) is not None else None + recommended_install_command = None + if recommended_shell is not None: + recommended_install_command = shells[recommended_shell]['recommendedInstallCommand'] + + return { + 'ok': True, + 'message': 'completion 诊断信息已生成', + 'activeShell': active_shell or None, + 'projectDir': str(Path.cwd().resolve()), + 'envChoices': self.environment_option_service.discover_env_names(), + 'completeEnvVar': CLICK_COMPLETE_ENV_VAR, + 'recommendedInstallCommand': recommended_install_command, + 'shells': shells, + } + + +COMPLETION_DOCTOR = CompletionDoctorService() diff --git a/shierfeng-fastapi-backend/cli/completion/installers.py b/shierfeng-fastapi-backend/cli/completion/installers.py new file mode 100644 index 0000000..d57050c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/installers.py @@ -0,0 +1,465 @@ +import io +import os +from contextlib import redirect_stderr +from dataclasses import dataclass +from pathlib import Path +from typing import Any + +import click +import typer +import typer.main +from click.shell_completion import BashComplete, FishComplete, ZshComplete + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY, CompletionProviderGateway +from cli.completion.shells import PowerShellComplete, ensure_custom_completion_classes_registered +from cli.exit_codes import ARGUMENT_ERROR, RUNTIME_ERROR +from cli.metadata import COMPLETION_SHELL_SPEC_REGISTRY, CompletionShellSpec, CompletionShellSpecRegistry + +CLICK_COMPLETE_ENV_VAR = '_SHIERFENG_COMPLETE' + + +class CompletionInstallerShellSupport: + """ + completion shell 差异支持对象。 + + 该对象负责封装不同 shell 在脚本兼容处理和 source 命令构建上的差异, + 供安装服务通过轻量 strategy 协作对象统一复用。 + """ + + @staticmethod + def keep_script_text(script_text: str) -> str: + """ + 保持脚本文本原样返回。 + + :param script_text: 原始脚本文本 + :return: 原样脚本文本 + """ + return script_text + + @staticmethod + def make_bash_completion_script_compatible(script_text: str) -> str: + """ + 对 Click 生成的 Bash completion 脚本做旧版本兼容处理。 + + 兼容目标主要包括 macOS 默认 Bash 3.2: + + - `complete -o nosort` 在旧 Bash 上会在 `source` 阶段直接报错 + - `compopt` 在旧 Bash 上可能不存在 + + :param script_text: Click 原始 Bash completion 脚本文本 + :return: 兼容处理后的脚本文本 + """ + compatible_lines: list[str] = [] + for line in script_text.splitlines(): + stripped_line = line.strip() + if stripped_line == 'compopt -o dirnames': + indent = line[: len(line) - len(line.lstrip(' '))] + compatible_lines.extend( + [ + f'{indent}if command -v compopt >/dev/null 2>&1; then', + f'{indent} compopt -o dirnames', + f'{indent}fi', + ] + ) + continue + if stripped_line == 'compopt -o default': + indent = line[: len(line) - len(line.lstrip(' '))] + compatible_lines.extend( + [ + f'{indent}if command -v compopt >/dev/null 2>&1; then', + f'{indent} compopt -o default', + f'{indent}fi', + ] + ) + continue + if stripped_line.startswith('complete -o nosort -F '): + compatibility_line = stripped_line.replace('complete -o nosort -F ', '', 1) + function_name, command_name = compatibility_line.split(' ', 1) + compatible_lines.extend( + [ + f'if complete -o nosort -F {function_name} {command_name} 2>/dev/null; then', + ' :', + 'else', + f' complete -F {function_name} {command_name}', + 'fi', + ] + ) + continue + compatible_lines.append(line) + return '\n'.join(compatible_lines) + '\n' + + @staticmethod + def build_posix_source_command(target_file: Path) -> str: + """ + 构建 POSIX shell 使用的 source 命令。 + + :param target_file: completion 脚本文件路径 + :return: source 命令 + """ + return f'source {target_file}' + + @staticmethod + def build_fish_source_command(target_file: Path) -> str: + """ + 构建 Fish shell 使用的 source 命令。 + + :param target_file: completion 脚本文件路径 + :return: source 命令 + """ + return f'status --is-interactive; and source {target_file}' + + @staticmethod + def build_powershell_source_command(target_file: Path) -> str: + """ + 构建 PowerShell 使用的 source 命令。 + + :param target_file: completion 脚本文件路径 + :return: source 命令 + """ + return f'. "{target_file}"' + + +@dataclass(frozen=True) +class CompletionShellRuntimePolicy: + """ + completion shell 运行时策略定义。 + + :param name: shell 名称 + :param click_completion_class: Click completion 生成器类型 + :param script_transformer: 脚本文本后处理函数 + :param source_command_builder: 激活命令构建函数 + """ + + name: str + click_completion_class: type[Any] + script_transformer: Any + source_command_builder: Any + + +@dataclass(frozen=True) +class CompletionShellRuntimePolicyRegistry: + """ + completion shell 运行时策略注册表。 + + :param policies: 按 shell 名称索引的运行时策略映射 + """ + + policies: dict[str, CompletionShellRuntimePolicy] + + def get(self, shell_name: str) -> CompletionShellRuntimePolicy | None: + """ + 获取指定 shell 的运行时策略。 + + :param shell_name: shell 名称 + :return: 运行时策略,不存在时返回 None + """ + return self.policies.get(shell_name) + + +DEFAULT_COMPLETION_SHELL_RUNTIME_POLICIES = CompletionShellRuntimePolicyRegistry( + policies={ + 'bash': CompletionShellRuntimePolicy( + name='bash', + click_completion_class=BashComplete, + script_transformer=CompletionInstallerShellSupport.make_bash_completion_script_compatible, + source_command_builder=CompletionInstallerShellSupport.build_posix_source_command, + ), + 'zsh': CompletionShellRuntimePolicy( + name='zsh', + click_completion_class=ZshComplete, + script_transformer=CompletionInstallerShellSupport.keep_script_text, + source_command_builder=CompletionInstallerShellSupport.build_posix_source_command, + ), + 'fish': CompletionShellRuntimePolicy( + name='fish', + click_completion_class=FishComplete, + script_transformer=CompletionInstallerShellSupport.keep_script_text, + source_command_builder=CompletionInstallerShellSupport.build_fish_source_command, + ), + 'powershell': CompletionShellRuntimePolicy( + name='powershell', + click_completion_class=PowerShellComplete, + script_transformer=CompletionInstallerShellSupport.keep_script_text, + source_command_builder=CompletionInstallerShellSupport.build_powershell_source_command, + ), + } +) + + +class CompletionInstallerService: + """ + completion 安装与脚本生成服务。 + + 该服务负责 shell 元数据解析、脚本生成、目标路径解析、激活命令构建、 + rc 文件写入以及安装结果收口。 + + :param completion_provider_gateway: completion 提供器对外网关 + :param shell_spec_registry: shell 元数据注册表 + :param shell_runtime_policy_registry: shell 运行时策略注册表 + """ + + def __init__( + self, + *, + completion_provider_gateway: CompletionProviderGateway | None = None, + shell_spec_registry: CompletionShellSpecRegistry | None = None, + shell_runtime_policy_registry: CompletionShellRuntimePolicyRegistry | None = None, + ) -> None: + """ + 初始化 completion 安装服务。 + + :param completion_provider_gateway: completion 提供器对外网关 + :param shell_spec_registry: shell 元数据注册表 + :param shell_runtime_policy_registry: shell 运行时策略注册表 + :return: None + """ + self.completion_provider_gateway = completion_provider_gateway or COMPLETION_PROVIDER_GATEWAY + self.shell_spec_registry = shell_spec_registry or COMPLETION_SHELL_SPEC_REGISTRY + self.shell_runtime_policy_registry = shell_runtime_policy_registry or DEFAULT_COMPLETION_SHELL_RUNTIME_POLICIES + ensure_custom_completion_classes_registered() + + def resolve_completion_shell_spec(self, shell: str) -> CompletionShellSpec: + """ + 获取指定 shell 的 completion 元数据。 + + :param shell: shell 名称 + :return: shell 元数据 + :raises typer.BadParameter: shell 不存在时抛出异常 + """ + normalized_shell = shell.strip().lower() + shell_spec = self.shell_spec_registry.get_spec(normalized_shell) + if shell_spec is None: + supported_shells = ', '.join(self.completion_provider_gateway.list_completion_shells()) + raise typer.BadParameter(f'不支持的 shell:{shell},可选值为 {supported_shells}') + return shell_spec + + def resolve_shell_runtime_policy(self, shell: str) -> CompletionShellRuntimePolicy: + """ + 获取指定 shell 的运行时策略。 + + :param shell: shell 名称 + :return: shell 运行时策略 + :raises typer.BadParameter: 当前 shell 未实现运行时策略时抛出异常 + """ + shell_spec = self.resolve_completion_shell_spec(shell) + runtime_policy = self.shell_runtime_policy_registry.get(shell_spec.name) + if runtime_policy is None: + raise typer.BadParameter(f'{shell_spec.name} completion 当前版本未实现') + return runtime_policy + + @staticmethod + def build_completion_click_command(root_cli: typer.Typer) -> click.Command: + """ + 将 Typer 根应用转换为 Click 命令对象,供 shell completion 生成使用。 + + :param root_cli: Typer 根应用 + :return: Click 命令对象 + """ + return typer.main.get_command(root_cli) + + def render_completion_script(self, root_cli: typer.Typer, shell: str) -> str: + """ + 生成指定 shell 的 completion 脚本文本。 + + :param root_cli: Typer 根应用 + :param shell: shell 名称 + :return: completion 脚本文本 + :raises typer.BadParameter: 当前 shell 未实现脚本生成时抛出异常 + """ + shell_spec = self.resolve_completion_shell_spec(shell) + if not shell_spec.supported or shell_spec.generator not in {'click', 'custom'}: + raise typer.BadParameter(f'{shell_spec.name} completion 当前版本未实现') + + runtime_policy = self.resolve_shell_runtime_policy(shell_spec.name) + click_command = self.build_completion_click_command(root_cli) + stderr_buffer = io.StringIO() + with redirect_stderr(stderr_buffer): + script_text = runtime_policy.click_completion_class( + click_command, + {}, + 'shierfeng', + CLICK_COMPLETE_ENV_VAR, + ).source() + return runtime_policy.script_transformer(script_text) + + def resolve_completion_target(self, shell: str, target_file: Path | None = None) -> Path: + """ + 解析 completion 脚本目标文件路径。 + + :param shell: shell 名称 + :param target_file: 用户显式指定的目标文件 + :return: 目标文件绝对路径 + """ + if target_file is not None: + return target_file.expanduser().resolve() + + shell_spec = self.resolve_completion_shell_spec(shell) + return (Path.home() / shell_spec.default_target).expanduser().resolve() + + def resolve_completion_rc_file(self, shell: str, rc_file: Path | None = None) -> Path | None: + """ + 解析 completion 激活所使用的 rc 文件路径。 + + :param shell: shell 名称 + :param rc_file: 用户显式指定的 rc 文件 + :return: rc 文件绝对路径,若当前 shell 无 rc 文件则返回 None + """ + if rc_file is not None: + return rc_file.expanduser().resolve() + + shell_spec = self.resolve_completion_shell_spec(shell) + if shell_spec.default_rc_file is None: + return None + return (Path.home() / shell_spec.default_rc_file).expanduser().resolve() + + def build_source_command(self, target_file: Path, shell: str) -> str: + """ + 构建当前 shell 对应的激活命令。 + + :param target_file: completion 脚本文件路径 + :param shell: shell 名称 + :return: 激活命令文本 + """ + runtime_policy = self.resolve_shell_runtime_policy(shell) + return runtime_policy.source_command_builder(target_file) + + @staticmethod + def detect_active_shell() -> str: + """ + 检测当前进程环境下的活跃 shell 名称。 + + :return: shell 名称,未知时返回空字符串 + """ + shell_path = os.environ.get('SHELL', '').strip() + if not shell_path: + return '' + return Path(shell_path).name.lower() + + def resolve_install_shell(self, shell: str | None) -> str: + """ + 解析安装命令实际使用的 shell。 + + :param shell: 用户显式指定的 shell,允许为空 + :return: 实际使用的 shell 名称 + :raises typer.BadParameter: 无法推断或不支持时抛出异常 + """ + if shell and shell.strip(): + return self.resolve_completion_shell_spec(shell).name + + active_shell = self.detect_active_shell() + if not active_shell: + raise typer.BadParameter('未检测到当前 shell,请显式传入 --shell') + + shell_spec = self.shell_spec_registry.get_spec(active_shell) + if shell_spec is None: + supported_shells = ', '.join(self.completion_provider_gateway.list_completion_shells()) + raise typer.BadParameter( + f'当前 shell `{active_shell}` 不在支持列表中,请显式传入 --shell,可选值为 {supported_shells}' + ) + return shell_spec.name + + @staticmethod + def append_activation_line(rc_file: Path, source_command: str) -> bool: + """ + 将激活命令追加到 rc 文件,若已存在则不重复写入。 + + :param rc_file: rc 文件路径 + :param source_command: 激活命令文本 + :return: 本次是否发生写入 + """ + existing_text = '' + if rc_file.exists(): + existing_text = rc_file.read_text(encoding='utf-8') + if source_command in existing_text: + return False + + rc_file.parent.mkdir(parents=True, exist_ok=True) + with rc_file.open('a', encoding='utf-8') as file_object: + if existing_text and not existing_text.endswith('\n'): + file_object.write('\n') + file_object.write(f'{source_command}\n') + return True + + def install_completion_script( + self, + root_cli: typer.Typer, + shell: str | None, + *, + target_file: Path | None = None, + activate: bool = False, + rc_file: Path | None = None, + force: bool = False, + ) -> dict[str, Any]: + """ + 安装指定 shell 的 completion 脚本文件。 + + :param root_cli: Typer 根应用 + :param shell: shell 名称 + :param target_file: completion 脚本目标文件 + :param activate: 是否写入 rc 文件激活命令 + :param rc_file: 自定义 rc 文件路径 + :param force: 目标文件已存在时是否强制覆盖 + :return: 安装结果字典 + """ + resolved_shell = self.resolve_install_shell(shell) + shell_spec = self.resolve_completion_shell_spec(resolved_shell) + if not shell_spec.supported: + return { + 'ok': False, + 'message': f'{shell_spec.name} completion 当前版本未实现', + 'shell': shell_spec.name, + 'exit_code': ARGUMENT_ERROR, + } + + resolved_target_file = self.resolve_completion_target(shell_spec.name, target_file) + script_text = self.render_completion_script(root_cli, shell_spec.name) + existing_text = resolved_target_file.read_text(encoding='utf-8') if resolved_target_file.exists() else None + + if existing_text is not None and existing_text != script_text and not force: + return { + 'ok': False, + 'message': '目标文件已存在且内容不同,请传入 --force 覆盖', + 'shell': shell_spec.name, + 'targetFile': str(resolved_target_file), + 'exit_code': RUNTIME_ERROR, + } + + resolved_target_file.parent.mkdir(parents=True, exist_ok=True) + resolved_target_file.write_text(script_text, encoding='utf-8') + + source_command = self.build_source_command(resolved_target_file, shell_spec.name) + activated = shell_spec.auto_discovery + rc_file_path = self.resolve_completion_rc_file(shell_spec.name, rc_file) + rc_file_updated = False + activation_required = not shell_spec.auto_discovery + detected_shell = self.detect_active_shell() or None + + if activate and rc_file_path is not None: + rc_file_updated = self.append_activation_line(rc_file_path, source_command) + activated = True + + next_step = '当前 shell 会自动发现 completion 脚本,无需额外 source 命令' + if activation_required and not activate: + next_step = f'请执行 `{source_command}`,或重新运行并传入 --activate' + elif activation_required and activate: + next_step = '请重启当前 shell,或手动执行 rc 文件中的 source 命令使其立即生效' + + return { + 'ok': True, + 'message': 'completion 脚本已安装', + 'shell': shell_spec.name, + 'detectedShell': detected_shell, + 'targetFile': str(resolved_target_file), + 'activated': activated, + 'activateRequested': activate, + 'rcFile': str(rc_file_path) if rc_file_path is not None else None, + 'rcFileUpdated': rc_file_updated, + 'sourceCommand': source_command, + 'autoDiscovery': shell_spec.auto_discovery, + 'activationRequired': activation_required, + 'nextStep': next_step, + 'completeEnvVar': CLICK_COMPLETE_ENV_VAR, + } + + +COMPLETION_INSTALLER = CompletionInstallerService() diff --git a/shierfeng-fastapi-backend/cli/completion/presenter.py b/shierfeng-fastapi-backend/cli/completion/presenter.py new file mode 100644 index 0000000..f15667f --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/presenter.py @@ -0,0 +1,83 @@ +from typing import Any + + +class CompletionCommandPresenter: + """ + completion 命令文本渲染器。 + + 该渲染器负责将 `completion` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_completion_doctor_text(self, payload: dict[str, Any]) -> str: + """ + 将 completion 诊断结果渲染为文本摘要。 + + :param payload: completion 诊断结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'message: {payload.get("message", "-")}', + f'active_shell: {payload.get("activeShell") or "-"}', + f'project_dir: {payload.get("projectDir", "-")}', + f'complete_env_var: {payload.get("completeEnvVar", "-")}', + ] + if payload.get('recommendedInstallCommand'): + lines.append(f'recommended_install_command: {payload.get("recommendedInstallCommand")}') + env_choices = payload.get('envChoices') + if isinstance(env_choices, list) and env_choices: + lines.append('env_choices:') + lines.extend(f' - {env_name}' for env_name in env_choices) + shells = payload.get('shells') + if isinstance(shells, dict) and shells: + lines.append('shells:') + for shell_name, shell_payload in shells.items(): + if not isinstance(shell_payload, dict): + continue + lines.extend( + [ + f' {shell_name}:', + f' supported: {str(shell_payload.get("supported", False)).lower()}', + f' detected: {str(shell_payload.get("detected", False)).lower()}', + f' target_file: {shell_payload.get("targetFile", "-")}', + f' target_file_exists: {str(shell_payload.get("targetFileExists", False)).lower()}', + f' rc_file: {shell_payload.get("rcFile", "-") or "-"}', + f' rc_file_exists: {str(shell_payload.get("rcFileExists", False)).lower()}', + f' auto_discovery: {str(shell_payload.get("autoDiscovery", False)).lower()}', + f' source_command: {shell_payload.get("sourceCommand", "-")}', + f' recommended_install_command: {shell_payload.get("recommendedInstallCommand", "-")}', + ] + ) + return '\n'.join(lines) + + @staticmethod + def build_completion_install_text(payload: dict[str, Any]) -> str: + """ + 将 completion 安装结果渲染为文本摘要。 + + :param payload: completion 安装结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'message: {payload.get("message", "-")}', + f'shell: {payload.get("shell", "-")}', + ] + field_label_mapping = { + 'detectedShell': 'detected_shell', + 'targetFile': 'target_file', + 'activated': 'activated', + 'activateRequested': 'activate_requested', + 'rcFile': 'rc_file', + 'rcFileUpdated': 'rc_file_updated', + 'sourceCommand': 'source_command', + 'autoDiscovery': 'auto_discovery', + 'activationRequired': 'activation_required', + 'nextStep': 'next_step', + 'completeEnvVar': 'complete_env_var', + } + for field_name, field_label in field_label_mapping.items(): + if field_name in payload: + lines.append(f'{field_label}: {payload.get(field_name)}') + return '\n'.join(lines) diff --git a/shierfeng-fastapi-backend/cli/completion/providers.py b/shierfeng-fastapi-backend/cli/completion/providers.py new file mode 100644 index 0000000..1b9dadf --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/providers.py @@ -0,0 +1,1022 @@ +import asyncio +import os +from dataclasses import dataclass, field +from importlib import import_module +from pathlib import Path +from typing import Any + +import click + +from cli.metadata import ( + COMPLETION_SHELL_SPEC_REGISTRY, + ENVIRONMENT_OPTION_SERVICE, + CompletionShellSpecRegistry, + EnvironmentOptionService, +) + +DEFAULT_ALEMBIC_REVISION_CHOICES = ('head', 'base', 'current', '-1') +DYNAMIC_COMPLETION_TIMEOUT_SECONDS = 0.8 + + +@dataclass(frozen=True) +class CompletionContextResolver: + """ + shell completion 上下文解析器。 + + 该对象负责解析当前补全场景下的环境、缓存名称和项目目录, + 将原本散落的参数与环境变量解析逻辑收口到单一职责对象中。 + """ + + def resolve_completion_env(self, ctx: click.Context | None) -> str: + """ + 解析当前 completion 场景使用的环境名称。 + + :param ctx: Click 上下文 + :return: 环境名称,默认返回 `dev` + """ + if ctx is not None: + env_value = getattr(ctx, 'params', {}).get('env') + if isinstance(env_value, str) and env_value.strip(): + return env_value.strip() + + comp_words = os.environ.get('COMP_WORDS', '').strip() + if comp_words: + tokens = comp_words.split() + for index, token in enumerate(tokens): + if token.startswith('--env='): + env_value = token.split('=', 1)[1].strip() + if env_value: + return env_value + if token == '--env' and index + 1 < len(tokens): + env_value = tokens[index + 1].strip() + if env_value: + return env_value + + return 'dev' + + def resolve_cache_name_for_completion(self, ctx: click.Context | None) -> str: + """ + 解析当前 cache key 补全场景使用的缓存名称。 + + :param ctx: Click 上下文 + :return: 缓存名称,缺失时返回空字符串 + """ + if ctx is not None: + cache_name = getattr(ctx, 'params', {}).get('cache_name') + if isinstance(cache_name, str) and cache_name.strip(): + return cache_name.strip() + + comp_words = os.environ.get('COMP_WORDS', '').strip() + if not comp_words: + return '' + + tokens = comp_words.split() + try: + cache_index = tokens.index('cache') + except ValueError: + return '' + + if cache_index + 2 >= len(tokens): + return '' + + subcommand = tokens[cache_index + 1] + if subcommand not in {'get', 'ttl'}: + return '' + + cache_name = tokens[cache_index + 2].strip() + if cache_name.startswith('-'): + return '' + return cache_name + + @staticmethod + def resolve_project_dir() -> Path: + """ + 获取当前 CLI 工作目录对应的项目根目录。 + + :return: 当前项目根目录 + """ + return Path.cwd().resolve() + + @staticmethod + def normalize_completion_prefix(incomplete: str) -> str: + """ + 规范化补全输入前缀。 + + :param incomplete: 原始未完成输入 + :return: 规范化后的前缀文本 + """ + return incomplete.strip() + + @staticmethod + def to_display_path(path: Path, *, project_dir: Path) -> str: + """ + 将绝对路径转换为适合补全显示的路径文本。 + + :param path: 原始路径 + :param project_dir: 项目根目录 + :return: 用于 shell completion 的显示路径 + """ + try: + relative_path = path.relative_to(project_dir) + return str(relative_path) or '.' + except ValueError: + return str(path) + + +@dataclass +class DynamicCompletionService: + """ + 动态补全执行服务。 + + 该服务负责 runtime 模块导入、只读协程执行、标准 payload 提取与 + 候选过滤,从而避免各补全函数继续复制相同的模板。 + + :param context_resolver: completion 上下文解析器 + :param timeout_seconds: 动态补全超时时间 + """ + + context_resolver: CompletionContextResolver = field(default_factory=CompletionContextResolver) + timeout_seconds: float = DYNAMIC_COMPLETION_TIMEOUT_SECONDS + + @staticmethod + def _scoped_app_env(env: str) -> Any: + """ + 为动态补全临时注入 `APP_ENV` 环境变量。 + + `config.env` 在导入阶段会优先读取 `APP_ENV`,因此补全场景下 + 直接切换进程环境变量比改写 `sys.argv` 更稳定,也更符合当前 + 后端配置模块的解析约束。 + + :param env: 当前补全环境名称 + :return: 环境变量恢复上下文 + """ + + class _CompletionEnvScope: + def __enter__(self) -> None: + self._original_app_env = os.environ.get('APP_ENV') + os.environ['APP_ENV'] = env + + def __exit__(self, exc_type: object, exc: object, traceback: object) -> None: + if self._original_app_env is None: + os.environ.pop('APP_ENV', None) + else: + os.environ['APP_ENV'] = self._original_app_env + + return _CompletionEnvScope() + + def load_runtime_module(self, module_name: str) -> Any: + """ + 加载动态补全依赖的 runtime 模块。 + + :param module_name: runtime 模块名 + :return: 已导入模块 + """ + return import_module(module_name) + + def run_completion_coroutine(self, coroutine: Any, *, env: str) -> Any: + """ + 在补全场景下执行异步只读查询,并临时注入 `APP_ENV`。 + + :param coroutine: 待执行协程 + :param env: 当前补全环境名称 + :return: 协程执行结果 + """ + try: + with self._scoped_app_env(env): + return asyncio.run(asyncio.wait_for(coroutine, timeout=self.timeout_seconds)) + finally: + if asyncio.iscoroutine(coroutine): + coroutine.close() + + @staticmethod + def extract_completion_items(payload: dict[str, Any], field_name: str) -> list[str]: + """ + 从 CLI 标准结果中提取补全候选字段列表。 + + :param payload: CLI 标准结果字典 + :param field_name: 需要提取的字段名 + :return: 去重后的字符串列表 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return [] + + items = payload.get('items') + if not isinstance(items, list): + page_payload = payload.get('page') + if isinstance(page_payload, dict): + items = page_payload.get('rows') + if not isinstance(items, list): + return [] + + candidates = [] + for item in items: + if not isinstance(item, dict): + continue + value = item.get(field_name) + if isinstance(value, str) and value.strip(): + candidates.append(value.strip()) + return sorted(set(candidates)) + + @staticmethod + def extract_completion_values(payload: dict[str, Any], field_name: str) -> list[str]: + """ + 从 CLI 标准结果中提取字符串或整数类型的补全候选值。 + + :param payload: CLI 标准结果字典 + :param field_name: 需要提取的字段名 + :return: 去重后的字符串列表 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return [] + + items = payload.get('items') + if not isinstance(items, list): + page_payload = payload.get('page') + if isinstance(page_payload, dict): + items = page_payload.get('rows') + if not isinstance(items, list): + return [] + + candidates = [] + for item in items: + if not isinstance(item, dict): + continue + value = item.get(field_name) + if isinstance(value, str) and value.strip(): + candidates.append(value.strip()) + elif isinstance(value, int): + candidates.append(str(value)) + return sorted(set(candidates)) + + @staticmethod + def extract_completion_list(payload: dict[str, Any], field_name: str) -> list[str]: + """ + 从 CLI 标准结果中提取直接位于顶层字段的字符串列表。 + + 该方法用于缓存键名等不走 `items/page.rows` 结构的场景, + 使这类动态补全也能统一复用 runtime 对象加载与协程执行逻辑。 + + :param payload: CLI 标准结果字典 + :param field_name: 需要提取的顶层字段名 + :return: 去重后的字符串列表 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return [] + + items = payload.get(field_name) + if not isinstance(items, list): + return [] + + candidates = [item.strip() for item in items if isinstance(item, str) and item.strip()] + return sorted(set(candidates)) + + @staticmethod + def filter_candidates(candidates: list[str], incomplete: str) -> list[str]: + """ + 按未完成输入前缀过滤候选值。 + + :param candidates: 原始候选列表 + :param incomplete: 当前未完成输入 + :return: 过滤后的候选列表 + """ + normalized_incomplete = incomplete.strip().lower() + return [candidate for candidate in candidates if candidate.lower().startswith(normalized_incomplete)] + + def complete_dynamic_items( + self, + ctx: click.Context | None, + incomplete: str, + *, + runtime_module_name: str, + runtime_object_name: str | None = None, + runtime_method_name: str, + runtime_kwargs: dict[str, Any], + field_name: str, + allow_int_values: bool = False, + ) -> list[str]: + """ + 执行通用的动态只读补全查询。 + + :param ctx: Click 上下文 + :param incomplete: 当前未完成输入 + :param runtime_module_name: runtime 模块名 + :param runtime_object_name: runtime 对象名,为空时直接使用模块 + :param runtime_method_name: runtime 方法名 + :param runtime_kwargs: runtime 调用参数 + :param field_name: 待提取字段名 + :param allow_int_values: 是否允许整数候选 + :return: 过滤后的候选列表 + """ + env = self.context_resolver.resolve_completion_env(ctx) + try: + runtime_module = self.load_runtime_module(runtime_module_name) + runtime_target = getattr(runtime_module, runtime_object_name) if runtime_object_name else runtime_module + runtime_method = getattr(runtime_target, runtime_method_name) + payload = self.run_completion_coroutine(runtime_method(**runtime_kwargs), env=env) + except Exception: + return [] + + if allow_int_values: + candidates = self.extract_completion_values(payload, field_name) + else: + candidates = self.extract_completion_items(payload, field_name) + return self.filter_candidates(candidates, incomplete) + + def complete_dynamic_list( + self, + ctx: click.Context | None, + incomplete: str, + *, + runtime_module_name: str, + runtime_object_name: str | None = None, + runtime_method_name: str, + runtime_args: tuple[Any, ...] = (), + runtime_kwargs: dict[str, Any] | None = None, + field_name: str, + ) -> list[str]: + """ + 执行返回顶层字符串列表字段的动态只读补全查询。 + + :param ctx: Click 上下文 + :param incomplete: 当前未完成输入 + :param runtime_module_name: runtime 模块名 + :param runtime_object_name: runtime 对象名,为空时直接使用模块 + :param runtime_method_name: runtime 方法名 + :param runtime_args: runtime 位置参数 + :param runtime_kwargs: runtime 关键字参数 + :param field_name: 顶层列表字段名 + :return: 过滤后的候选列表 + """ + env = self.context_resolver.resolve_completion_env(ctx) + try: + runtime_module = self.load_runtime_module(runtime_module_name) + runtime_target = getattr(runtime_module, runtime_object_name) if runtime_object_name else runtime_module + runtime_method = getattr(runtime_target, runtime_method_name) + payload = self.run_completion_coroutine( + runtime_method(*runtime_args, **(runtime_kwargs or {})), + env=env, + ) + except Exception: + return [] + + candidates = self.extract_completion_list(payload, field_name) + return self.filter_candidates(candidates, incomplete) + + +@dataclass +class StaticCompletionProvider: + """ + 静态 completion 提供器。 + + 该对象负责 shell、环境、缓存名称以及 Alembic revision 等静态或 + 本地推导型补全候选。 + + :param context_resolver: completion 上下文解析器 + :param dynamic_service: 动态补全执行服务 + :param shell_spec_registry: shell 元数据注册表 + :param environment_option_service: 环境选项服务 + """ + + context_resolver: CompletionContextResolver = field(default_factory=CompletionContextResolver) + dynamic_service: DynamicCompletionService = field( + default_factory=lambda: DynamicCompletionService(context_resolver=CompletionContextResolver()) + ) + shell_spec_registry: CompletionShellSpecRegistry = field(default_factory=lambda: COMPLETION_SHELL_SPEC_REGISTRY) + environment_option_service: EnvironmentOptionService = field(default_factory=lambda: ENVIRONMENT_OPTION_SERVICE) + + def list_completion_shells(self) -> list[str]: + """ + 获取已声明的 completion shell 列表。 + + :return: shell 名称列表 + """ + return self.shell_spec_registry.list_shell_names() + + def list_static_cache_names(self) -> list[str]: + """ + 读取系统内置缓存名称列表。 + + :return: 缓存名称列表 + """ + try: + redis_init_key_config = self.dynamic_service.load_runtime_module('common.enums').RedisInitKeyConfig + except Exception: + return [] + return [key_config.key for key_config in redis_init_key_config if getattr(key_config, 'key', '')] + + def complete_env_values( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 `--env` 选项提供可补全的环境名称。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 匹配的环境名称列表 + """ + del ctx, args + normalized_incomplete = incomplete.strip().lower() + return [ + env_name + for env_name in self.environment_option_service.discover_env_names() + if env_name.lower().startswith(normalized_incomplete) + ] + + def complete_shell_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 shell 参数提供静态补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: shell 名称列表 + """ + del ctx, args + normalized_incomplete = incomplete.strip().lower() + return [ + shell_name for shell_name in self.list_completion_shells() if shell_name.startswith(normalized_incomplete) + ] + + def complete_cache_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为缓存名称参数提供静态补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 缓存名称列表 + """ + del ctx, args + normalized_incomplete = incomplete.strip().lower() + return [ + cache_name + for cache_name in sorted(self.list_static_cache_names()) + if cache_name.lower().startswith(normalized_incomplete) + ] + + def complete_alembic_revisions( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为数据库迁移版本参数提供本地补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 迁移版本候选列表 + """ + del ctx, args + normalized_incomplete = self.context_resolver.normalize_completion_prefix(incomplete).lower() + revision_choices = set(DEFAULT_ALEMBIC_REVISION_CHOICES) + versions_dir = self.context_resolver.resolve_project_dir() / 'alembic' / 'versions' + if versions_dir.is_dir(): + for revision_file in versions_dir.glob('*.py'): + revision_stem = revision_file.stem + revision_id = revision_stem.split('-', 1)[-1].split('_', 1)[0].strip() + if revision_id: + revision_choices.add(revision_id) + return sorted(choice for choice in revision_choices if choice.lower().startswith(normalized_incomplete)) + + +@dataclass +class PathCompletionProvider: + """ + 路径 completion 提供器。 + + 该对象负责项目相对 SQL 文件路径和输出路径补全。 + + :param context_resolver: completion 上下文解析器 + """ + + context_resolver: CompletionContextResolver = field(default_factory=CompletionContextResolver) + + def complete_sql_files( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 SQL 文件参数提供项目内 `.sql` 文件补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: SQL 文件路径列表 + """ + del ctx, args + normalized_incomplete = self.context_resolver.normalize_completion_prefix(incomplete).lower() + project_dir = self.context_resolver.resolve_project_dir() + candidates = [] + for sql_file in project_dir.rglob('*.sql'): + if '.git' in sql_file.parts or '__pycache__' in sql_file.parts: + continue + display_path = self.context_resolver.to_display_path(sql_file, project_dir=project_dir) + if display_path.lower().startswith(normalized_incomplete): + candidates.append(display_path) + return sorted(candidates) + + def complete_output_paths( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为导出文件参数提供目录和 `.zip` 文件补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 目录或 zip 文件路径列表 + """ + del ctx, args + raw_incomplete = self.context_resolver.normalize_completion_prefix(incomplete) + project_dir = self.context_resolver.resolve_project_dir() + + expanded_input = Path(raw_incomplete).expanduser() + input_is_absolute = expanded_input.is_absolute() + if raw_incomplete.endswith(('/', os.sep)): + search_dir = expanded_input if input_is_absolute else (project_dir / expanded_input).resolve() + partial_name = '' + else: + search_dir = ( + expanded_input.parent + if input_is_absolute + else ( + project_dir / expanded_input.parent if str(expanded_input.parent) != '.' else project_dir + ).resolve() + ) + partial_name = expanded_input.name + + if not search_dir.exists() or not search_dir.is_dir(): + return [] + + candidates = [] + for child_path in sorted(search_dir.iterdir()): + if not child_path.name.startswith(partial_name): + continue + if child_path.is_dir(): + display_path = self.context_resolver.to_display_path(child_path, project_dir=project_dir) + candidates.append(f'{display_path}/') + continue + if child_path.suffix.lower() == '.zip': + candidates.append(self.context_resolver.to_display_path(child_path, project_dir=project_dir)) + return candidates + + +@dataclass +class DomainDynamicCompletionProvider: + """ + 业务域动态 completion 提供器。 + + 该对象负责配置、代码生成、缓存、任务等运行时驱动的只读补全。 + + :param context_resolver: completion 上下文解析器 + :param dynamic_service: 动态补全执行服务 + """ + + context_resolver: CompletionContextResolver = field(default_factory=CompletionContextResolver) + dynamic_service: DynamicCompletionService = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化动态补全执行服务。 + + :return: None + """ + self.dynamic_service = DynamicCompletionService(context_resolver=self.context_resolver) + + def complete_config_keys( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为参数键名提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 参数键名列表 + """ + del args + return self.dynamic_service.complete_dynamic_items( + ctx, + incomplete, + runtime_module_name='cli.runtime.config', + runtime_object_name='CONFIG_RUNTIME', + runtime_method_name='list_configs', + runtime_kwargs={'config_key': incomplete, 'paged': True, 'page_num': 1, 'page_size': 20}, + field_name='configKey', + ) + + def complete_gen_table_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为代码生成业务表名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 业务表名称列表 + """ + del args + return self.dynamic_service.complete_dynamic_items( + ctx, + incomplete, + runtime_module_name='cli.runtime.gen', + runtime_object_name='GEN_RUNTIME', + runtime_method_name='list_gen_tables', + runtime_kwargs={'table_name': incomplete, 'paged': True, 'page_num': 1, 'page_size': 20}, + field_name='tableName', + ) + + def complete_gen_db_table_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为数据库物理表名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 数据库物理表名称列表 + """ + del args + return self.dynamic_service.complete_dynamic_items( + ctx, + incomplete, + runtime_module_name='cli.runtime.gen', + runtime_object_name='GEN_RUNTIME', + runtime_method_name='list_gen_db_tables', + runtime_kwargs={'table_name': incomplete, 'paged': True, 'page_num': 1, 'page_size': 20}, + field_name='tableName', + ) + + def complete_cache_keys( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为缓存键名提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 缓存键名列表 + """ + del args + cache_name = self.context_resolver.resolve_cache_name_for_completion(ctx) + if not cache_name: + return [] + return self.dynamic_service.complete_dynamic_list( + ctx, + incomplete, + runtime_module_name='cli.runtime.cache', + runtime_object_name='CACHE_RUNTIME', + runtime_method_name='list_cache_keys', + runtime_args=(cache_name,), + field_name='keys', + ) + + def complete_job_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为任务名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 任务名称列表 + """ + del args + return self.dynamic_service.complete_dynamic_items( + ctx, + incomplete, + runtime_module_name='cli.runtime.job', + runtime_object_name='JOB_RUNTIME', + runtime_method_name='list_jobs', + runtime_kwargs={'job_name': incomplete, 'paged': True, 'page_num': 1, 'page_size': 20}, + field_name='jobName', + ) + + def complete_job_ids( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为任务 ID 提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 任务 ID 列表 + """ + del args + return self.dynamic_service.complete_dynamic_items( + ctx, + incomplete, + runtime_module_name='cli.runtime.job', + runtime_object_name='JOB_RUNTIME', + runtime_method_name='list_jobs', + runtime_kwargs={'paged': True, 'page_num': 1, 'page_size': 20}, + field_name='jobId', + allow_int_values=True, + ) + + +@dataclass +class CompletionProviderRegistry: + """ + completion 提供器注册表。 + + 该注册表只负责持有静态补全、路径补全与动态只读补全 provider, + 供上层 gateway、安装器与其他协作者按职责选择使用。 + + :param context_resolver: completion 上下文解析器 + :param dynamic_service: 动态补全执行服务 + :param static_provider: 静态 completion 提供器 + :param path_provider: 路径 completion 提供器 + :param domain_provider: 业务域动态 completion 提供器 + """ + + context_resolver: CompletionContextResolver = field(default_factory=CompletionContextResolver) + dynamic_service: DynamicCompletionService = field(init=False) + static_provider: StaticCompletionProvider = field(init=False) + path_provider: PathCompletionProvider = field(init=False) + domain_provider: DomainDynamicCompletionProvider = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化聚合 provider 依赖。 + + :return: None + """ + self.dynamic_service = DynamicCompletionService(context_resolver=self.context_resolver) + self.static_provider = StaticCompletionProvider( + context_resolver=self.context_resolver, + dynamic_service=self.dynamic_service, + ) + self.path_provider = PathCompletionProvider(context_resolver=self.context_resolver) + self.domain_provider = DomainDynamicCompletionProvider(context_resolver=self.context_resolver) + self.domain_provider.dynamic_service = self.dynamic_service + + +@dataclass +class CompletionProviderGateway: + """ + completion 对外网关。 + + 该对象负责对命令声明层、上下文层和 TUI 层暴露统一的 completion 入口, + 避免 `CompletionProviderRegistry` 本体继续膨胀为大而全的委托门面。 + + :param provider_registry: completion provider 注册表 + """ + + provider_registry: CompletionProviderRegistry = field(default_factory=CompletionProviderRegistry) + + def list_completion_shells(self) -> list[str]: + """ + 获取已声明的 completion shell 列表。 + + :return: shell 名称列表 + """ + return self.provider_registry.static_provider.list_completion_shells() + + def list_static_cache_names(self) -> list[str]: + """ + 读取系统内置缓存名称列表。 + + :return: 缓存名称列表 + """ + return self.provider_registry.static_provider.list_static_cache_names() + + def complete_env_values( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 `--env` 选项提供可补全的环境名称。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 匹配的环境名称列表 + """ + return self.provider_registry.static_provider.complete_env_values(ctx, args, incomplete) + + def complete_shell_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 shell 参数提供静态补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: shell 名称列表 + """ + return self.provider_registry.static_provider.complete_shell_names(ctx, args, incomplete) + + def complete_cache_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为缓存名称参数提供静态补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 缓存名称列表 + """ + return self.provider_registry.static_provider.complete_cache_names(ctx, args, incomplete) + + def complete_alembic_revisions( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为数据库迁移版本参数提供本地补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 迁移版本候选列表 + """ + return self.provider_registry.static_provider.complete_alembic_revisions(ctx, args, incomplete) + + def complete_sql_files( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为 SQL 文件参数提供项目内 `.sql` 文件补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: SQL 文件路径列表 + """ + return self.provider_registry.path_provider.complete_sql_files(ctx, args, incomplete) + + def complete_output_paths( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为导出文件参数提供目录和 `.zip` 文件补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 目录或 zip 文件路径列表 + """ + return self.provider_registry.path_provider.complete_output_paths(ctx, args, incomplete) + + def complete_config_keys( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为参数键名提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 参数键名列表 + """ + return self.provider_registry.domain_provider.complete_config_keys(ctx, args, incomplete) + + def complete_gen_table_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为代码生成业务表名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 业务表名称列表 + """ + return self.provider_registry.domain_provider.complete_gen_table_names(ctx, args, incomplete) + + def complete_gen_db_table_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为数据库物理表名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 数据库物理表名称列表 + """ + return self.provider_registry.domain_provider.complete_gen_db_table_names(ctx, args, incomplete) + + def complete_cache_keys( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为缓存键名提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 缓存键名列表 + """ + return self.provider_registry.domain_provider.complete_cache_keys(ctx, args, incomplete) + + def complete_job_names( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为任务名称提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 任务名称列表 + """ + return self.provider_registry.domain_provider.complete_job_names(ctx, args, incomplete) + + def complete_job_ids( + self, + ctx: click.Context | None, + args: list[str] | None, + incomplete: str, + ) -> list[str]: + """ + 为任务 ID 提供动态只读补全结果。 + + :param ctx: Click 上下文 + :param args: 当前命令参数列表 + :param incomplete: 当前未完成输入片段 + :return: 任务 ID 列表 + """ + return self.provider_registry.domain_provider.complete_job_ids(ctx, args, incomplete) + + +COMPLETION_PROVIDER_REGISTRY = CompletionProviderRegistry() +COMPLETION_PROVIDER_GATEWAY = CompletionProviderGateway(provider_registry=COMPLETION_PROVIDER_REGISTRY) diff --git a/shierfeng-fastapi-backend/cli/completion/shells.py b/shierfeng-fastapi-backend/cli/completion/shells.py new file mode 100644 index 0000000..1bd8fc5 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/completion/shells.py @@ -0,0 +1,113 @@ +import os + +from click.shell_completion import ( + CompletionItem, + ShellComplete, + add_completion_class, + get_completion_class, + split_arg_string, +) + +_SOURCE_POWERSHELL = """\ +$%(complete_func)s = { + param($wordToComplete, $commandAst, $cursorPosition) + + $previousCompWords = $env:COMP_WORDS + $previousCompCword = $env:COMP_CWORD + $previousCompleteInstruction = $env:%(complete_var)s + + $commandLine = $commandAst.ToString() + if ($cursorPosition -lt $commandLine.Length) { + $commandLine = $commandLine.Substring(0, $cursorPosition) + } + + $env:COMP_WORDS = $commandLine + $env:COMP_CWORD = $wordToComplete + $env:%(complete_var)s = "powershell_complete" + + try { + %(prog_name)s | ForEach-Object { + $line = $_.ToString() + if ([string]::IsNullOrWhiteSpace($line)) { + return + } + $parts = $line -split "`t", 3 + $completionValue = if ($parts.Length -ge 2) { $parts[1] } else { "" } + $completionHelp = if ($parts.Length -ge 3 -and $parts[2]) { $parts[2] } else { $completionValue } + [System.Management.Automation.CompletionResult]::new( + $completionValue, + $completionValue, + [System.Management.Automation.CompletionResultType]::ParameterValue, + $completionHelp + ) + } + } finally { + if ($null -ne $previousCompWords) { + $env:COMP_WORDS = $previousCompWords + } else { + Remove-Item Env:\\COMP_WORDS -ErrorAction SilentlyContinue + } + if ($null -ne $previousCompCword) { + $env:COMP_CWORD = $previousCompCword + } else { + Remove-Item Env:\\COMP_CWORD -ErrorAction SilentlyContinue + } + if ($null -ne $previousCompleteInstruction) { + $env:%(complete_var)s = $previousCompleteInstruction + } else { + Remove-Item Env:\\%(complete_var)s -ErrorAction SilentlyContinue + } + } +} + +Register-ArgumentCompleter -Native -CommandName %(prog_name)s -ScriptBlock $%(complete_func)s +""" + + +class PowerShellComplete(ShellComplete): + """ + PowerShell shell completion 支持。 + + 基于 PowerShell `Register-ArgumentCompleter -Native` 协议,将当前 + 命令行和光标位置传回 Click completion 分发器,再把返回的候选项转换为 + `CompletionResult` 对象。 + """ + + name = 'powershell' + source_template = _SOURCE_POWERSHELL + + def get_completion_args(self) -> tuple[list[str], str]: + """ + 从 PowerShell 注入的环境变量中恢复 CLI 上下文。 + + :return: 已解析的完整参数与当前不完整输入 + """ + cwords = split_arg_string(os.environ.get('COMP_WORDS', '')) + incomplete = os.environ.get('COMP_CWORD', '') + if incomplete: + incomplete_parts = split_arg_string(incomplete) + incomplete = incomplete_parts[0] if incomplete_parts else incomplete + args = cwords[1:] + if incomplete and args and args[-1] == incomplete: + args.pop() + return args, incomplete + + def format_completion(self, item: CompletionItem) -> str: + """ + 将候选项格式化为 PowerShell 脚本可解析的文本行。 + + :param item: Click completion 候选项 + :return: 格式化后的文本 + """ + help_text = item.help or item.value + return f'{item.type}\t{item.value}\t{help_text}' + + +def ensure_custom_completion_classes_registered() -> None: + """ + 确保自定义 shell completion 类已注册到 Click。 + + :return: None + """ + if get_completion_class(PowerShellComplete.name) is None: + add_completion_class(PowerShellComplete) diff --git a/shierfeng-fastapi-backend/cli/context.py b/shierfeng-fastapi-backend/cli/context.py new file mode 100644 index 0000000..adbfab9 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/context.py @@ -0,0 +1,74 @@ +from dataclasses import dataclass +from typing import Annotated, Literal + +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY + + +@dataclass +class CliContext: + """ + CLI 运行上下文。 + + env: 当前命令使用的环境名称 + output: 结果输出格式 + operator: 操作者标识,后续用于审计 + allow_prod: 是否显式允许生产环境执行危险命令 + yes: 是否跳过二次确认 + dry_run: 是否执行演练模式 + """ + + env: str = 'dev' + output: Literal['text', 'json'] = 'text' + operator: str | None = None + allow_prod: bool = False + yes: bool = False + dry_run: bool = False + + +class CliContextBuilder: + """ + CLI 上下文构建器。 + + 该对象负责将命令层显式参数收口为统一的 `CliContext` 数据对象, + 供上下文工厂与测试场景复用。 + """ + + @staticmethod + def build( + env: str, + output: Literal['text', 'json'], + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> CliContext: + """ + 构建命令执行上下文。 + + :param env: 当前命令环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过二次确认 + :param dry_run: 是否执行演练模式 + :return: 构建完成的 CLI 上下文 + """ + return CliContext( + env=env, + output=output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ) + + +CLI_CONTEXT_BUILDER = CliContextBuilder() + +EnvOption = Annotated[ + str, + typer.Option('--env', help='运行环境名称', autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_env_values), +] +OutputOption = Annotated[Literal['text', 'json'], typer.Option('--output', help='输出格式,支持 text 或 json')] +AllowProdOption = Annotated[bool, typer.Option('--allow-prod', help='允许在生产环境中执行危险命令')] +YesOption = Annotated[bool, typer.Option('--yes', help='跳过危险命令确认')] +DryRunOption = Annotated[bool, typer.Option('--dry-run', help='仅执行预演,不落地实际变更')] diff --git a/shierfeng-fastapi-backend/cli/core/__init__.py b/shierfeng-fastapi-backend/cli/core/__init__.py new file mode 100644 index 0000000..17df42c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/core/__init__.py @@ -0,0 +1,51 @@ +from dataclasses import dataclass, field + +from cli.core.app_builder import CliApplicationBuilder, ProjectRuntimeLocator +from cli.core.completion_dispatcher import CompletionDispatcher +from cli.core.context_factory import CliContextFactory, CliRuntimeState +from cli.core.execution import CliExecutionService +from cli.output import OutputRenderer + + +@dataclass +class CoreServiceContainer: + """ + CLI 核心服务容器。 + + 该容器负责统一装配输出渲染器、运行期状态、上下文工厂与执行服务, + 作为控制器、向导和 TUI 等编排层的默认依赖入口。 + + :param output_renderer: 输出渲染器 + :param runtime_state: CLI 运行期状态对象 + """ + + output_renderer: OutputRenderer = field(default_factory=OutputRenderer) + runtime_state: CliRuntimeState = field(default_factory=CliRuntimeState) + context_factory: CliContextFactory = field(init=False) + execution_service: CliExecutionService = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化核心服务依赖图。 + + :return: None + """ + self.context_factory = CliContextFactory( + runtime_state=self.runtime_state, + output_renderer=self.output_renderer, + ) + self.execution_service = CliExecutionService(output_renderer=self.output_renderer) + + +DEFAULT_CORE_SERVICES = CoreServiceContainer() + +__all__ = [ + 'DEFAULT_CORE_SERVICES', + 'CliApplicationBuilder', + 'CliContextFactory', + 'CliExecutionService', + 'CliRuntimeState', + 'CompletionDispatcher', + 'CoreServiceContainer', + 'ProjectRuntimeLocator', +] diff --git a/shierfeng-fastapi-backend/cli/core/app_builder.py b/shierfeng-fastapi-backend/cli/core/app_builder.py new file mode 100644 index 0000000..a6ad2ab --- /dev/null +++ b/shierfeng-fastapi-backend/cli/core/app_builder.py @@ -0,0 +1,363 @@ +import importlib +import sys +from collections.abc import Callable +from dataclasses import dataclass, field +from pathlib import Path +from typing import Annotated, Literal + +import typer + +from cli.output import OutputRenderer +from cli.runtime.base import RUNTIME_ENVIRONMENT + + +@dataclass(frozen=True) +class ProjectRuntimeLocator: + """ + CLI 项目运行时定位器。 + + 该对象负责判断当前目录是否为后端项目根目录、注入 `sys.path`, + 并为配置导入阶段提取最小化的 `argv` 参数。 + """ + + def is_backend_project_dir(self, project_dir: Path) -> bool: + """ + 判断给定目录是否为后端项目根目录。 + + :param project_dir: 待检查目录 + :return: 是否为后端项目根目录 + """ + return RUNTIME_ENVIRONMENT.is_backend_project_dir(project_dir) + + def ensure_backend_dir_on_sys_path(self) -> Path: + """ + 将当前后端项目根目录加入 `sys.path` 首位。 + + :return: 当前后端项目根目录 + :raises typer.Exit: 当前目录不是后端项目根目录时退出命令 + """ + project_dir = Path.cwd().resolve() + if not self.is_backend_project_dir(project_dir): + typer.echo('`shierfeng` 命令需在 `shierfeng-fastapi-backend` 目录下执行', err=True) + raise typer.Exit(code=2) + + project_dir_str = str(project_dir) + if sys.path and sys.path[0] == project_dir_str: + return project_dir + + sys.path.insert(0, project_dir_str) + return project_dir + + def extract_import_argv(self, argv: list[str] | None = None) -> list[str]: + """ + 提取供配置模块导入阶段使用的最小参数集。 + + :param argv: 原始命令行参数列表 + :return: 仅保留程序名和 `--env` 的参数列表 + """ + current_argv = argv or sys.argv + program_name = current_argv[0] if current_argv else 'shierfeng' + import_argv = [program_name] + env_value = '' + current_args = current_argv[1:] + for index, argument in enumerate(current_args): + if argument.startswith('--env='): + env_value = argument.split('=', 1)[1].strip() + break + if argument == '--env' and index + 1 < len(current_args): + env_value = current_args[index + 1].strip() + break + + if env_value: + import_argv.extend(['--env', env_value]) + return import_argv + + +@dataclass(frozen=True) +class CliCommandGroupRegistry: + """ + CLI 命令组注册表。 + + 该注册表集中维护根 CLI 需要挂载的业务命令组模块路径, + 避免命令组声明散落在应用构建器主体中。 + + :param command_modules: 命令组到模块路径的映射 + """ + + command_modules: dict[str, str] + + +@dataclass(frozen=True) +class CliExtensionRegistration: + """ + CLI 扩展入口注册描述。 + + :param module_path: 扩展模块导入路径 + :param attach: 已加载模块挂载到根 CLI 的函数 + """ + + module_path: str + attach: Callable[[typer.Typer, object], None] + + +@dataclass(frozen=True) +class CliExtensionRegistry: + """ + CLI 扩展入口注册表。 + + 该注册表集中维护 completion、wizard、TUI 等扩展入口的模块路径与 + 挂载方式,避免这些规则继续散落在注册器主体中。 + + :param registrations: 扩展注册描述列表 + """ + + registrations: tuple[CliExtensionRegistration, ...] + + +@dataclass(frozen=True) +class CliCommandGroupRegistrar: + """ + CLI 命令组注册器。 + + 该对象负责根据命令组注册表向根 Typer 应用挂载业务命令组。 + + :param command_group_registry: CLI 命令组注册表 + """ + + command_group_registry: CliCommandGroupRegistry + module_loader: 'CliModuleLoader' = field(default_factory=lambda: DEFAULT_CLI_MODULE_LOADER) + + def register(self, cli: typer.Typer) -> None: + """ + 向根应用注册业务命令组。 + + :param cli: 根 Typer 应用 + :return: None + """ + for command_name, module_path in self.command_group_registry.command_modules.items(): + command_module = self.module_loader.load(module_path) + cli.add_typer(command_module.app, name=command_name) + + +class CliExtensionMountSupport: + """ + CLI 扩展入口挂载支持对象。 + + 该对象负责封装不同扩展模块挂载到根 CLI 的差异,避免扩展注册器本体 + 继续堆积 `if/else` 或硬编码模块处理逻辑。 + """ + + @staticmethod + def attach_completion(cli: typer.Typer, module: object) -> None: + """ + 挂载 completion 扩展入口。 + + :param cli: 根 Typer 应用 + :param module: 已加载模块 + :return: None + """ + cli.add_typer(module.COMPLETION_COMMAND_BUILDER.build(cli), name='completion') + + @staticmethod + def attach_wizard(cli: typer.Typer, module: object) -> None: + """ + 挂载 wizard 扩展入口。 + + :param cli: 根 Typer 应用 + :param module: 已加载模块 + :return: None + """ + cli.add_typer(module.WIZARD_COMMAND_BUILDER.build(), name='wizard') + + @staticmethod + def attach_tui(cli: typer.Typer, module: object) -> None: + """ + 挂载 TUI 扩展入口。 + + :param cli: 根 Typer 应用 + :param module: 已加载模块 + :return: None + """ + module.TUI_COMMAND_REGISTRATION.register(cli) + + +@dataclass(frozen=True) +class CliExtensionRegistrar: + """ + CLI 扩展入口注册器。 + + 该对象负责向根 Typer 应用挂载 completion、wizard 与 TUI + 等扩展入口。 + """ + + extension_registry: CliExtensionRegistry + module_loader: 'CliModuleLoader' = field(default_factory=lambda: DEFAULT_CLI_MODULE_LOADER) + + def register(self, cli: typer.Typer) -> None: + """ + 向根应用注册扩展入口。 + + :param cli: 根 Typer 应用 + :return: None + """ + for registration in self.extension_registry.registrations: + extension_module = self.module_loader.load(registration.module_path) + registration.attach(cli, extension_module) + + +@dataclass(frozen=True) +class CliRootOptionInitializer: + """ + CLI 根级选项初始化器。 + + 该对象负责将根级 `--color`、`--icon` 选项映射到共享输出渲染器, + 避免根回调继续内联输出配置逻辑。 + + :param output_renderer: 根命令共享的输出渲染器 + """ + + output_renderer: OutputRenderer + + def initialize(self, *, color: str, icon: str) -> None: + """ + 初始化根级输出选项。 + + :param color: 文本输出颜色模式 + :param icon: 文本输出图标模式 + :return: None + """ + self.output_renderer.set_color_mode(color) + self.output_renderer.set_icon_mode(icon) + + +@dataclass(frozen=True) +class CliRootCallbackRegistrar: + """ + CLI 根回调注册器。 + + 该对象负责把根级 `--color`、`--icon` 选项回调挂载到 Typer 根应用, + 让 `CliApplicationBuilder` 更专注于整体装配流程。 + + :param root_option_initializer: 根级选项初始化器 + """ + + root_option_initializer: CliRootOptionInitializer + + def register(self, cli: typer.Typer) -> None: + """ + 向根应用注册回调。 + + :param cli: 根 Typer 应用 + :return: None + """ + + @cli.callback() + def root_callback( + color: Annotated[ + Literal['auto', 'always', 'never'], + typer.Option('--color', help='文本输出颜色模式'), + ] = 'always', + icon: Annotated[ + Literal['emoji', 'ascii', 'none'], + typer.Option('--icon', help='文本输出图标模式'), + ] = 'emoji', + ) -> None: + """ + 初始化 CLI 根级运行参数。 + + :param color: 文本输出颜色模式 + :param icon: 文本输出图标模式 + :return: None + """ + self.root_option_initializer.initialize(color=color, icon=icon) + + +@dataclass(frozen=True) +class CliModuleLoader: + """ + CLI 模块加载服务。 + + 该对象负责集中执行命令组与扩展入口所需的延迟导入, + 让注册器本身更专注于挂载动作。 + """ + + @staticmethod + def load(module_path: str) -> object: + """ + 按模块路径加载模块对象。 + + :param module_path: 模块导入路径 + :return: 已加载模块 + """ + return importlib.import_module(module_path) + + +@dataclass +class CliApplicationBuilder: + """ + CLI 根应用构建器。 + + :param output_renderer: 根命令共享的输出渲染器 + :param command_group_registrar: CLI 命令组注册器 + :param extension_registrar: CLI 扩展入口注册器 + """ + + output_renderer: OutputRenderer + command_group_registrar: CliCommandGroupRegistrar = field( + default_factory=lambda: CliCommandGroupRegistrar(DEFAULT_COMMAND_GROUP_REGISTRY) + ) + extension_registrar: CliExtensionRegistrar = field( + default_factory=lambda: CliExtensionRegistrar(DEFAULT_CLI_EXTENSION_REGISTRY) + ) + root_option_initializer: CliRootOptionInitializer = field(init=False) + root_callback_registrar: CliRootCallbackRegistrar = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化根应用构建器依赖。 + + :return: None + """ + self.root_option_initializer = CliRootOptionInitializer(self.output_renderer) + self.root_callback_registrar = CliRootCallbackRegistrar(self.root_option_initializer) + + def build(self) -> typer.Typer: + """ + 构建 Typer 根应用并注册全部命令组。 + + :return: Typer 根应用 + """ + cli = typer.Typer( + name='shierfeng', + help='ShiErFeng FastAPI 后端统一命令入口', + no_args_is_help=True, + add_completion=False, + context_settings={'help_option_names': ['-h', '--help']}, + ) + self.root_callback_registrar.register(cli) + self.command_group_registrar.register(cli) + self.extension_registrar.register(cli) + return cli + + +DEFAULT_COMMAND_GROUP_REGISTRY = CliCommandGroupRegistry( + command_modules={ + 'app': 'cli.groups.app', + 'db': 'cli.groups.db', + 'ops': 'cli.groups.ops', + 'cache': 'cli.groups.cache', + 'job': 'cli.groups.job', + 'config': 'cli.groups.config', + 'crypto': 'cli.groups.crypto', + 'gen': 'cli.groups.gen', + 'dev': 'cli.groups.dev', + } +) +DEFAULT_CLI_EXTENSION_REGISTRY = CliExtensionRegistry( + registrations=( + CliExtensionRegistration('cli.completion.commands', CliExtensionMountSupport.attach_completion), + CliExtensionRegistration('cli.wizard.commands', CliExtensionMountSupport.attach_wizard), + CliExtensionRegistration('cli.tui', CliExtensionMountSupport.attach_tui), + ) +) +DEFAULT_CLI_MODULE_LOADER = CliModuleLoader() diff --git a/shierfeng-fastapi-backend/cli/core/completion_dispatcher.py b/shierfeng-fastapi-backend/cli/core/completion_dispatcher.py new file mode 100644 index 0000000..d09cd54 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/core/completion_dispatcher.py @@ -0,0 +1,121 @@ +import os +from dataclasses import dataclass, field + +import typer +from click.shell_completion import shell_complete as click_shell_complete +from typer.completion import shell_complete as typer_shell_complete + +from cli.completion.shells import ensure_custom_completion_classes_registered + + +@dataclass(frozen=True) +class CompletionInstructionSupport: + """ + completion 指令解析支持对象。 + + 该对象负责管理 completion 环境变量名、受支持 shell 列表,以及 + Click / Typer 两种指令格式的判定逻辑。 + + :param complete_env_var: completion 环境变量名 + :param supported_shells: 支持的 shell 名称列表 + """ + + complete_env_var: str = '_SHIERFENG_COMPLETE' + supported_shells: tuple[str, ...] = ('bash', 'zsh', 'fish', 'powershell') + + def is_click_style_instruction(self, instruction: str) -> bool: + """ + 判断 completion 指令是否为 Click 原生格式。 + + Click 原生格式为 `_`,例如 `bash_complete`。 + + :param instruction: completion 指令文本 + :return: 是否为 Click 风格指令 + """ + return any(instruction.startswith(f'{shell}_') for shell in self.supported_shells) + + def is_typer_style_instruction(self, instruction: str) -> bool: + """ + 判断 completion 指令是否为 Typer 兼容格式。 + + Typer 兼容格式为 `_`,例如 `complete_bash`。 + + :param instruction: completion 指令文本 + :return: 是否为 Typer 风格指令 + """ + return any(instruction.endswith(f'_{shell}') for shell in self.supported_shells) + + +@dataclass(frozen=True) +class CompletionInstructionReader: + """ + completion 指令读取器。 + + 该对象负责从当前进程环境中读取并规范化 completion 指令。 + + :param support: completion 指令解析支持对象 + """ + + support: CompletionInstructionSupport + + def read_instruction(self) -> str: + """ + 读取当前进程中的 completion 指令文本。 + + :return: 规范化后的 completion 指令文本 + """ + return os.environ.get(self.support.complete_env_var, '').strip() + + +@dataclass(frozen=True) +class CompletionDispatcher: + """ + shell completion 请求分发器。 + + 该对象负责识别 Click 与 Typer 两种 completion 指令格式, + 并在命中时直接执行补全流程后退出当前进程。 + + :param support: completion 指令解析支持对象 + :param instruction_reader: completion 指令读取器 + """ + + support: CompletionInstructionSupport = field(default_factory=CompletionInstructionSupport) + instruction_reader: CompletionInstructionReader = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化 completion 指令读取器。 + + :return: None + """ + object.__setattr__(self, 'instruction_reader', CompletionInstructionReader(self.support)) + + def dispatch(self, cli: typer.Typer) -> None: + """ + 处理 shell completion 请求并在命中时直接退出。 + + 这里同时兼容 Click 与 Typer 两种 completion 指令格式,避免 + 生成脚本格式和运行时解析格式不一致时出现 `Shell complete not supported.`。 + + :param cli: Typer 根应用 + :return: None + """ + ensure_custom_completion_classes_registered() + instruction = self.instruction_reader.read_instruction() + if not instruction: + return + + click_command = typer.main.get_command(cli) + if self.support.is_click_style_instruction(instruction): + raise SystemExit( + click_shell_complete(click_command, {}, 'shierfeng', self.support.complete_env_var, instruction) + ) + if self.support.is_typer_style_instruction(instruction): + raise SystemExit( + typer_shell_complete(click_command, {}, 'shierfeng', self.support.complete_env_var, instruction) + ) + + raise SystemExit(1) + + +DEFAULT_COMPLETION_INSTRUCTION_SUPPORT = CompletionInstructionSupport() diff --git a/shierfeng-fastapi-backend/cli/core/context_factory.py b/shierfeng-fastapi-backend/cli/core/context_factory.py new file mode 100644 index 0000000..23adf62 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/core/context_factory.py @@ -0,0 +1,239 @@ +import logging +from dataclasses import dataclass, field +from importlib import import_module +from typing import Any + +from cli.context import CLI_CONTEXT_BUILDER, CliContext, CliContextBuilder +from cli.guards import ( + DEFAULT_DANGEROUS_COMMAND_GUARD, + DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY, + DangerousCommandGuardService, + DangerousCommandRuleRegistry, +) +from cli.output import OutputRenderer + + +@dataclass +class CliRuntimeState: + """ + CLI 运行期状态。 + + :param logs_suppressed: 当前进程日志是否已切换为静默模式 + """ + + logs_suppressed: bool = False + sqlalchemy_logs_suppressed: bool = False + + def get_logger(self) -> Any: + """ + 获取 CLI 使用的日志对象。 + + :return: 日志对象 + """ + return import_module('utils.log_util').logger + + def suppress_logs(self) -> None: + """ + 关闭 CLI 进程中的终端日志输出。 + + :return: None + """ + if self.logs_suppressed: + return + self.get_logger().remove() + self.logs_suppressed = True + + def suppress_sqlalchemy_logs(self) -> None: + """ + 关闭 CLI 进程中的 SQLAlchemy 终端 SQL 日志输出。 + + 该逻辑同时处理两类来源: + + 1. 将 `config.env.DataBaseConfig.db_echo` 强制关闭,避免后续新建 Engine 时 + 继续打开 SQLAlchemy echo。 + 2. 将已知 SQLAlchemy logger 级别提升到 WARNING,避免已有 logger 配置把 + `INFO sqlalchemy.engine.Engine ...` 继续打到标准输出。 + + :return: None + """ + if self.sqlalchemy_logs_suppressed: + return + env_module = import_module('config.env') + database_config = getattr(env_module, 'DataBaseConfig', None) + if database_config is not None and hasattr(database_config, 'db_echo'): + database_config.db_echo = False + for logger_name in ( + 'sqlalchemy', + 'sqlalchemy.engine', + 'sqlalchemy.engine.Engine', + 'sqlalchemy.pool', + ): + logging.getLogger(logger_name).setLevel(logging.WARNING) + self.sqlalchemy_logs_suppressed = True + + +@dataclass +class CliLogPolicy: + """ + CLI 日志策略服务。 + + 该对象负责在上下文构建前应用统一的日志输出策略, + 将“是否静默日志”这一策略从上下文工厂主体中拆出。 + + :param runtime_state: CLI 运行期状态对象 + """ + + runtime_state: CliRuntimeState + + def prepare_regular_command(self) -> None: + """ + 为普通 CLI 命令应用默认日志策略。 + + :return: None + """ + self.runtime_state.suppress_logs() + self.runtime_state.suppress_sqlalchemy_logs() + + +@dataclass +class DangerousCommandContextSupport: + """ + 危险命令上下文支持服务。 + + 该对象负责危险命令规则查询、保护执行与拒绝结果收口, + 让上下文工厂本体只保留装配职责。 + + :param dangerous_command_rule_registry: 危险命令规则注册表 + :param dangerous_command_guard_service: 危险命令保护执行服务 + :param output_renderer: 输出渲染器 + """ + + dangerous_command_rule_registry: DangerousCommandRuleRegistry + dangerous_command_guard_service: DangerousCommandGuardService + output_renderer: OutputRenderer + + def guard_context(self, ctx: CliContext, *, command_name: str) -> CliContext: + """ + 对危险命令上下文执行统一保护。 + + :param ctx: 已构建的 CLI 上下文 + :param command_name: 命令唯一标识 + :return: 通过保护后的 CLI 上下文 + """ + rule = self.dangerous_command_rule_registry.require_rule(command_name) + guard_result = self.dangerous_command_guard_service.guard(ctx, rule=rule) + if guard_result is not None: + self.output_renderer.complete_command(guard_result, ctx) + return ctx + + +@dataclass +class CliContextFactory: + """ + 统一构建 CLI 命令上下文。 + + :param runtime_state: CLI 运行期状态对象 + :param output_renderer: 输出渲染器 + :param cli_context_builder: CLI 上下文构建器 + :param dangerous_command_rule_registry: 危险命令规则注册表 + :param dangerous_command_guard_service: 危险命令保护执行服务 + """ + + runtime_state: CliRuntimeState = field(default_factory=CliRuntimeState) + output_renderer: OutputRenderer = field(default_factory=OutputRenderer) + cli_context_builder: CliContextBuilder = field(default_factory=lambda: CLI_CONTEXT_BUILDER) + dangerous_command_rule_registry: DangerousCommandRuleRegistry = field( + default_factory=lambda: DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY + ) + dangerous_command_guard_service: DangerousCommandGuardService = field( + default_factory=lambda: DEFAULT_DANGEROUS_COMMAND_GUARD + ) + _log_policy: CliLogPolicy | None = field(default=None, init=False, repr=False) + _dangerous_command_support: DangerousCommandContextSupport | None = field( + default=None, + init=False, + repr=False, + ) + + def get_log_policy(self) -> CliLogPolicy: + """ + 获取当前上下文工厂使用的日志策略服务。 + + :return: CLI 日志策略服务 + """ + if self._log_policy is None: + self._log_policy = CliLogPolicy(runtime_state=self.runtime_state) + return self._log_policy + + def get_dangerous_command_support(self) -> DangerousCommandContextSupport: + """ + 获取当前上下文工厂使用的危险命令上下文支持服务。 + + :return: 危险命令上下文支持服务 + """ + if self._dangerous_command_support is None: + self._dangerous_command_support = DangerousCommandContextSupport( + dangerous_command_rule_registry=self.dangerous_command_rule_registry, + dangerous_command_guard_service=self.dangerous_command_guard_service, + output_renderer=self.output_renderer, + ) + return self._dangerous_command_support + + def build_regular( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> CliContext: + """ + 构建普通命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :return: CLI 上下文 + """ + self.get_log_policy().prepare_regular_command() + return self.cli_context_builder.build(env, output, allow_prod, yes, dry_run) + + def build_readonly( + self, + env: str, + output: str, + ) -> CliContext: + """ + 构建只读命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_regular(env, output, False, False, False) + + def build_dangerous( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + command_name: str, + ) -> CliContext: + """ + 构建危险命令上下文并执行统一保护。 + + :param env: 运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param command_name: 命令唯一标识 + :return: CLI 上下文 + """ + ctx = self.build_regular(env, output, allow_prod, yes, dry_run) + return self.get_dangerous_command_support().guard_context(ctx, command_name=command_name) diff --git a/shierfeng-fastapi-backend/cli/core/execution.py b/shierfeng-fastapi-backend/cli/core/execution.py new file mode 100644 index 0000000..2afd47c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/core/execution.py @@ -0,0 +1,137 @@ +import asyncio +from collections.abc import Callable +from dataclasses import dataclass, field +from typing import Any + +from cli.context import CliContext +from cli.exit_codes import RUNTIME_ERROR +from cli.output import CommandResult, OutputRenderer + + +@dataclass +class CliExecutionService: + """ + CLI 执行与结果收口服务。 + + :param output_renderer: 输出渲染器 + """ + + output_renderer: OutputRenderer = field(default_factory=OutputRenderer) + + def run_async(self, coroutine: Any) -> Any: + """ + 执行异步协程并返回结果。 + + :param coroutine: 待执行协程 + :return: 协程执行结果 + """ + return asyncio.run(coroutine) + + def complete_payload( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + default_exit_code: int = 0, + ) -> None: + """ + 输出标准字典负载并结束命令。 + + :param ctx: CLI 上下文 + :param payload: 标准结果字典 + :param default_exit_code: 默认退出码 + :return: None + """ + self.output_renderer.complete_command(self.build_result(payload, default_exit_code=default_exit_code), ctx) + + def complete_result( + self, + ctx: CliContext, + result: CommandResult, + ) -> None: + """ + 输出命令结果对象并结束命令。 + + :param ctx: CLI 上下文 + :param result: 命令执行结果对象 + :return: None + """ + self.output_renderer.complete_command(result, ctx) + + def complete_payload_with_text( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + text_builder: Callable[[dict[str, Any]], Any], + default_exit_code: int = 0, + text_condition: Callable[[dict[str, Any]], bool] | None = None, + ) -> None: + """ + 按输出格式收口标准负载,必要时先转换为文本结果。 + + :param ctx: CLI 上下文 + :param payload: 标准结果字典 + :param text_builder: 文本结果构建函数 + :param default_exit_code: 默认退出码 + :param text_condition: 文本模式下是否应用构建函数的判定函数 + :return: None + """ + if ctx.output != 'text': + self.complete_payload(ctx, payload, default_exit_code=default_exit_code) + return + + result = self.build_result(payload, default_exit_code=default_exit_code) + should_build_text = True + if callable(text_condition) and isinstance(result.data, dict): + should_build_text = bool(text_condition(result.data)) + if should_build_text and isinstance(result.data, dict): + result.data = text_builder(result.data) + self.complete_result(ctx, result) + + def complete_payload_result( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + text_builder: Callable[[dict[str, Any]], Any] | None = None, + default_exit_code: int = 0, + text_condition: Callable[[dict[str, Any]], bool] | None = None, + ) -> None: + """ + 统一收口标准负载,按输出格式决定是否渲染为文本结果。 + + :param ctx: CLI 上下文 + :param payload: 标准结果字典 + :param text_builder: 文本结果构建函数 + :param default_exit_code: 默认退出码 + :param text_condition: 文本模式下是否应用构建函数的判定函数 + :return: None + """ + if text_builder is None: + self.complete_payload(ctx, payload, default_exit_code=default_exit_code) + return + self.complete_payload_with_text( + ctx, + payload, + text_builder=text_builder, + default_exit_code=default_exit_code, + text_condition=text_condition, + ) + + @staticmethod + def build_result(payload: dict[str, Any], *, default_exit_code: int = 0) -> CommandResult: + """ + 将标准字典负载转换为命令结果对象。 + + :param payload: 标准结果字典 + :param default_exit_code: 默认退出码;当 payload 未显式提供 exit_code 且 + 该值仍为 0 时,失败结果会统一回退到 `RUNTIME_ERROR` + :return: 命令结果对象 + """ + result_payload = dict(payload) + exit_code = result_payload.pop('exit_code', None) + if exit_code is None: + is_ok = bool(result_payload.get('ok', True)) + exit_code = default_exit_code if is_ok or default_exit_code != 0 else RUNTIME_ERROR + return CommandResult(data=result_payload, exit_code=exit_code) diff --git a/shierfeng-fastapi-backend/cli/exit_codes.py b/shierfeng-fastapi-backend/cli/exit_codes.py new file mode 100644 index 0000000..ead6bb0 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/exit_codes.py @@ -0,0 +1,8 @@ +SUCCESS = 0 +ARGUMENT_ERROR = 2 +DEPENDENCY_ERROR = 10 +DATABASE_ERROR = 20 +REDIS_ERROR = 21 +SCHEDULER_ERROR = 22 +GUARD_REJECTED = 30 +RUNTIME_ERROR = 50 diff --git a/shierfeng-fastapi-backend/cli/groups/__init__.py b/shierfeng-fastapi-backend/cli/groups/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/groups/app/__init__.py b/shierfeng-fastapi-backend/cli/groups/app/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/app/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/app/command.py b/shierfeng-fastapi-backend/cli/groups/app/command.py new file mode 100644 index 0000000..40bcea4 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/app/command.py @@ -0,0 +1,102 @@ +from typing import Annotated, Literal + +import typer + +from cli.context import EnvOption, OutputOption + +from .controller import AppCommandController + +app = typer.Typer( + help='应用相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_APP_COMMAND_CONTROLLER = AppCommandController() + + +@app.command('run', help='启动当前 FastAPI 应用') +def run_app( + env: EnvOption = 'dev', +) -> None: + """ + 启动当前 FastAPI 应用。 + + :param env: 当前命令运行环境 + :return: None + """ + _APP_COMMAND_CONTROLLER.run_app(env) + + +@app.command('doctor', help='执行应用启动前检查') +def doctor( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 执行应用启动前检查。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _APP_COMMAND_CONTROLLER.doctor(env, output) + + +@app.command('config', help='查看当前应用配置快照') +def app_config( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 输出当前应用配置快照。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _APP_COMMAND_CONTROLLER.show_config(env, output) + + +@app.command('env', help='查看当前 CLI 解析到的应用环境信息') +def app_env( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 输出当前 CLI 解析到的应用环境信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _APP_COMMAND_CONTROLLER.show_env(env, output) + + +@app.command('routes', help='查看当前应用注册路由清单') +def routes( + env: EnvOption = 'dev', + output: OutputOption = 'text', + path_prefix: Annotated[str, typer.Option('--path-prefix', help='按路由前缀过滤')] = '', + method: Annotated[str, typer.Option('--method', help='按请求方法过滤,如 GET、POST')] = '', + group_by: Annotated[Literal['none', 'tag'], typer.Option('--group-by', help='路由分组方式')] = 'none', + include_hidden: Annotated[bool, typer.Option('--include-hidden', help='包含未出现在 OpenAPI 中的路由')] = False, +) -> None: + """ + 输出当前应用注册路由清单。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param path_prefix: 路由前缀过滤条件 + :param method: 请求方法过滤条件 + :param group_by: 路由分组方式 + :param include_hidden: 是否包含隐藏路由 + :return: None + """ + _APP_COMMAND_CONTROLLER.show_routes( + env, + output, + path_prefix=path_prefix, + method=method, + group_by=group_by, + include_hidden=include_hidden, + ) diff --git a/shierfeng-fastapi-backend/cli/groups/app/controller.py b/shierfeng-fastapi-backend/cli/groups/app/controller.py new file mode 100644 index 0000000..2e4a4e8 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/app/controller.py @@ -0,0 +1,236 @@ +from collections import defaultdict +from typing import Any + +from fastapi.routing import APIRoute + +from cli.bootstrap import APP_BOOTSTRAP, AppBootstrapService +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.exit_codes import DEPENDENCY_ERROR, SUCCESS +from cli.runtime.app import APP_RUNTIME, AppRuntimeService +from cli.runtime.crypto import CRYPTO_RUNTIME, CryptoRuntimeService +from cli.runtime.db import DATABASE_RUNTIME, DatabaseRuntimeService +from cli.runtime.ops import OPERATIONS_RUNTIME, OperationsRuntimeService + +from .presenter import AppCommandPresenter + + +class AppCommandController: + """ + 应用命令控制器。 + + 该控制器负责组织 `app` 命令组的上下文准备、runtime 调用、 + payload 构建,以及基于输出格式选择 presenter 或直接返回 JSON。 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: AppCommandPresenter | None = None, + runtime_service: AppRuntimeService | None = None, + database_runtime: DatabaseRuntimeService | None = None, + operations_runtime: OperationsRuntimeService | None = None, + crypto_runtime: CryptoRuntimeService | None = None, + bootstrap_service: AppBootstrapService | None = None, + ) -> None: + """ + 初始化应用命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 应用命令文本渲染器 + :param runtime_service: 应用运行时服务 + :param database_runtime: 数据库运行时服务 + :param operations_runtime: 运维运行时服务 + :param crypto_runtime: 传输加密运行时服务 + :param bootstrap_service: 应用引导服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or AppCommandPresenter() + self.runtime_service = runtime_service or APP_RUNTIME + self.database_runtime = database_runtime or DATABASE_RUNTIME + self.operations_runtime = operations_runtime or OPERATIONS_RUNTIME + self.crypto_runtime = crypto_runtime or CRYPTO_RUNTIME + self.bootstrap_service = bootstrap_service or APP_BOOTSTRAP + + def run_app(self, env: str) -> None: + """ + 启动当前 FastAPI 应用。 + + :param env: 当前命令运行环境 + :return: None + """ + self.bootstrap_service.exec_app_run_command(env) + + def doctor(self, env: str, output: str) -> None: + """ + 执行应用启动前检查。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + db_status = self.execution_service.run_async(self.database_runtime.ping_database()) + redis_status = self.execution_service.run_async(self.operations_runtime.ping_redis()) + crypto_status = self.crypto_runtime.validate_crypto_config() + payload = { + 'env': ctx.env, + 'database': db_status, + 'redis': redis_status, + 'crypto': crypto_status, + } + payload['ok'] = all(item.get('ok', False) for item in (db_status, redis_status, crypto_status)) + exit_code = SUCCESS if payload['ok'] else DEPENDENCY_ERROR + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_doctor_text, + default_exit_code=exit_code, + ) + + def show_config(self, env: str, output: str) -> None: + """ + 输出当前应用配置快照。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload_result( + ctx, + {'ok': True, 'env': ctx.env, 'config': self.runtime_service.get_app_config_snapshot()}, + text_builder=self.presenter.build_app_config_text, + default_exit_code=SUCCESS, + ) + + def show_env(self, env: str, output: str) -> None: + """ + 输出当前 CLI 解析到的应用环境信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload_result( + ctx, + {'ok': True, 'env': ctx.env, 'runtime': self.runtime_service.get_app_env_snapshot()}, + text_builder=self.presenter.build_app_env_text, + default_exit_code=SUCCESS, + ) + + def show_routes( + self, + env: str, + output: str, + *, + path_prefix: str, + method: str, + group_by: str, + include_hidden: bool, + ) -> None: + """ + 输出当前应用注册路由清单。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param path_prefix: 路由前缀过滤条件 + :param method: 请求方法过滤条件 + :param group_by: 路由分组方式 + :param include_hidden: 是否包含隐藏路由 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + routes_payload = self._serialize_routes( + self.runtime_service.build_app_instance(), + path_prefix=path_prefix, + method=method, + include_hidden=include_hidden, + ) + grouped_routes = self._group_routes_by_tag(routes_payload) if group_by == 'tag' else None + payload = { + 'ok': True, + 'env': ctx.env, + 'count': len(routes_payload), + 'filters': { + 'pathPrefix': path_prefix, + 'method': method.upper().strip(), + 'groupBy': group_by, + 'includeHidden': include_hidden, + }, + 'routes': routes_payload, + 'groupedRoutes': grouped_routes, + } + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_routes_text, + default_exit_code=SUCCESS, + text_condition=lambda data: data.get('ok', False), + ) + + @staticmethod + def _serialize_routes( + app_instance: Any, + *, + path_prefix: str = '', + method: str = '', + include_hidden: bool = False, + ) -> list[dict[str, Any]]: + """ + 序列化 FastAPI 路由信息。 + + :param app_instance: FastAPI 应用实例 + :param path_prefix: 路径前缀过滤条件 + :param method: 请求方法过滤条件 + :param include_hidden: 是否包含未出现在 OpenAPI 中的路由 + :return: 序列化后的路由列表 + """ + normalized_method = method.upper().strip() + routes = [] + for route in app_instance.routes: + if not isinstance(route, APIRoute): + continue + if not include_hidden and not route.include_in_schema: + continue + if path_prefix and not route.path.startswith(path_prefix): + continue + route_methods = sorted(item for item in route.methods if item not in {'HEAD', 'OPTIONS'}) + if normalized_method and normalized_method not in route_methods: + continue + routes.append( + { + 'path': route.path, + 'methods': route_methods, + 'name': route.name, + 'summary': route.summary or '', + 'operationId': route.operation_id or '', + 'tags': route.tags or [], + 'includeInSchema': route.include_in_schema, + } + ) + return sorted(routes, key=lambda item: (item['path'], ','.join(item['methods']))) + + @staticmethod + def _group_routes_by_tag(routes_payload: list[dict[str, Any]]) -> dict[str, list[dict[str, Any]]]: + """ + 按标签对路由信息分组。 + + :param routes_payload: 原始路由列表 + :return: 按标签分组后的路由映射 + """ + grouped_routes: dict[str, list[dict[str, Any]]] = defaultdict(list) + for route in routes_payload: + tags = route.get('tags') or ['__untagged__'] + for tag in tags: + grouped_routes[tag].append(route) + return dict(sorted(grouped_routes.items(), key=lambda item: item[0])) diff --git a/shierfeng-fastapi-backend/cli/groups/app/presenter.py b/shierfeng-fastapi-backend/cli/groups/app/presenter.py new file mode 100644 index 0000000..7a6cb79 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/app/presenter.py @@ -0,0 +1,210 @@ +from typing import Any + +from cli.utils import SHELL_TEXT_FORMATTER + + +class AppCommandPresenter: + """ + 应用命令文本渲染器。 + + 该渲染器负责将 `app` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_routes_text(self, payload: dict[str, Any]) -> str: + """ + 将路由列表结果渲染为文本摘要。 + + :param payload: 路由列表结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'count: {payload.get("count", 0)}', + ] + filters = payload.get('filters') + if isinstance(filters, dict): + lines.extend(self._build_route_filter_lines(filters)) + + grouped_routes = payload.get('groupedRoutes') + if filters and filters.get('groupBy') == 'tag' and isinstance(grouped_routes, dict): + lines.extend(self._build_grouped_routes_text(grouped_routes)) + return '\n'.join(lines) + + routes = payload.get('routes') + if not isinstance(routes, list) or not routes: + lines.append('routes: none') + return '\n'.join(lines) + + lines.append('routes:') + for route in routes: + if isinstance(route, dict): + lines.extend([f' {line}' for line in self._build_route_item_lines(route)]) + return '\n'.join(lines) + + def build_app_config_text(self, payload: dict[str, Any]) -> str: + """ + 将应用配置快照渲染为文本摘要。 + + :param payload: 应用配置结果字典 + :return: 文本摘要 + """ + config = payload.get('config') + if not isinstance(config, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'config: none', + ] + ) + + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'application:', + f' name: {config.get("name", "-")}', + f' host: {config.get("host", "-")}:{config.get("port", "-")}', + f' root_path: {config.get("rootPath", "-") or "/"}', + f' reload: {str(config.get("reload", False)).lower()}', + f' workers: {config.get("workers", "-")}', + f' disable_swagger: {str(config.get("disableSwagger", False)).lower()}', + f' disable_redoc: {str(config.get("disableRedoc", False)).lower()}', + 'database:', + f' type: {config.get("dbType", "-")}', + f' host: {config.get("dbHost", "-")}:{config.get("dbPort", "-")}', + f' name: {config.get("dbDatabase", "-")}', + 'redis:', + f' host: {config.get("redisHost", "-")}:{config.get("redisPort", "-")}', + 'logging:', + f' level: {config.get("logLevel", "-")}', + 'transport_crypto:', + f' enabled: {str(config.get("transportCryptoEnabled", False)).lower()}', + f' mode: {config.get("transportCryptoMode", "-")}', + ] + return '\n'.join(lines) + + def build_app_env_text(self, payload: dict[str, Any]) -> str: + """ + 将应用环境解析结果渲染为文本摘要。 + + :param payload: 应用环境结果字典 + :return: 文本摘要 + """ + runtime = payload.get('runtime') + if not isinstance(runtime, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'runtime: none', + ] + ) + + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'runtime:', + f' cli_env: {runtime.get("cliEnv", "-")}', + f' config_env: {runtime.get("configEnv", "-")}', + f' app_env: {runtime.get("appEnv", "-")}', + f' env_file: {runtime.get("envFile", "-")}', + f' env_file_exists: {str(runtime.get("envFileExists", False)).lower()}', + f' backend_dir: {runtime.get("backendDir", "-")}', + f' python_executable: {runtime.get("pythonExecutable", "-")}', + ] + ) + + def build_doctor_text(self, payload: dict[str, Any]) -> str: + """ + 将应用启动前检查结果渲染为文本摘要。 + + :param payload: 启动前检查结果字典 + :return: 文本摘要 + """ + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'checks:', + self._build_check_status_line('database', payload.get('database')), + self._build_check_status_line('redis', payload.get('redis')), + self._build_check_status_line('crypto', payload.get('crypto')), + ] + ) + + @staticmethod + def _build_route_filter_lines(filters: dict[str, object]) -> list[str]: + """ + 构建路由过滤条件文本行。 + + :param filters: 过滤条件字典 + :return: 过滤条件文本行列表 + """ + active_filters = [] + for key, value in filters.items(): + if value in (None, '', False, 'none'): + continue + active_filters.append(f'{SHELL_TEXT_FORMATTER.to_snake_case(key)}={value}') + if not active_filters: + return ['filters: none'] + return ['filters:', *[f' - {item}' for item in active_filters]] + + @staticmethod + def _build_route_item_lines(route_item: dict[str, Any]) -> list[str]: + """ + 构建单条路由记录的文本行。 + + :param route_item: 单条路由记录 + :return: 文本行列表 + """ + methods = ','.join(route_item.get('methods', [])) or '-' + path = SHELL_TEXT_FORMATTER.truncate_text(route_item.get('path', ''), 72) + tags = ','.join(route_item.get('tags', [])) or '-' + summary = SHELL_TEXT_FORMATTER.truncate_text(route_item.get('summary', ''), 60) + name = SHELL_TEXT_FORMATTER.truncate_text(route_item.get('name', ''), 40) + return [ + f'- [{methods}] {path}', + f' name: {name or "-"} | tags: {tags}', + f' summary: {summary or "-"}', + ] + + def _build_grouped_routes_text(self, grouped_routes: dict[str, Any]) -> list[str]: + """ + 将按标签分组后的路由结果渲染为文本行。 + + :param grouped_routes: 按标签分组后的路由映射 + :return: 文本行列表 + """ + if not grouped_routes: + return ['groups: none'] + + lines = [f'groups: {len(grouped_routes)}'] + for tag, routes in grouped_routes.items(): + route_items = routes if isinstance(routes, list) else [] + lines.append(f' {tag}: {len(route_items)}') + for route in route_items: + if isinstance(route, dict): + lines.extend([f' {line}' for line in self._build_route_item_lines(route)]) + return lines + + @staticmethod + def _build_check_status_line(name: str, status_payload: dict[str, Any] | None) -> str: + """ + 构建单项检查结果摘要行。 + + :param name: 检查项名称 + :param status_payload: 检查结果字典 + :return: 摘要行文本 + """ + if not isinstance(status_payload, dict): + return f' {name}: unknown' + + ok = str(status_payload.get('ok', False)).lower() + message = status_payload.get('message', '-') or '-' + error = status_payload.get('error') + if error: + return f' {name}: {ok} | {message} | error: {SHELL_TEXT_FORMATTER.truncate_text(error, 120)}' + return f' {name}: {ok} | {message}' diff --git a/shierfeng-fastapi-backend/cli/groups/cache/__init__.py b/shierfeng-fastapi-backend/cli/groups/cache/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/cache/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/cache/command.py b/shierfeng-fastapi-backend/cli/groups/cache/command.py new file mode 100644 index 0000000..6f803df --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/cache/command.py @@ -0,0 +1,163 @@ +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY +from cli.context import AllowProdOption, DryRunOption, EnvOption, OutputOption, YesOption + +from .controller import CacheCommandController + +app = typer.Typer( + help='缓存相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_CACHE_COMMAND_CONTROLLER = CacheCommandController() + + +@app.command('stats', help='查看缓存统计信息') +def stats( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看缓存统计信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.stats(env, output) + + +@app.command('keys', help='查看指定缓存名称下的键名列表') +def keys( + cache_name: str = typer.Argument( + ..., + help='缓存名称', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_names, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看指定缓存名称下的键名列表。 + + :param cache_name: 缓存名称 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.keys(cache_name, env, output) + + +@app.command('get', help='查看指定缓存内容') +def get( + cache_name: str = typer.Argument( + ..., + help='缓存名称', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_names, + ), + cache_key: str = typer.Argument( + ..., + help='缓存键名', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_keys, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看指定缓存内容。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.get(cache_name, cache_key, env, output) + + +@app.command('clear', help='执行缓存清理') +def clear( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + cache_name: str = typer.Option( + '', + '--cache-name', + help='按缓存名称前缀清理', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_names, + ), + cache_key: str = typer.Option('', '--cache-key', help='按缓存键名模糊清理'), + clear_all: bool = typer.Option(False, '--all', help='清理全部缓存并重建系统基础缓存'), +) -> None: + """ + 清理缓存。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param cache_name: 缓存名称前缀 + :param cache_key: 缓存键名 + :param clear_all: 是否清理全部缓存 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.clear( + env, + output, + allow_prod, + yes, + dry_run, + cache_name=cache_name, + cache_key=cache_key, + clear_all=clear_all, + ) + + +@app.command('ttl', help='查看指定缓存键的剩余过期时间') +def ttl( + cache_name: str = typer.Argument( + ..., + help='缓存名称', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_names, + ), + cache_key: str = typer.Argument( + ..., + help='缓存键名', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_cache_keys, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看指定缓存键的剩余过期时间。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.ttl(cache_name, cache_key, env, output) + + +@app.command('warmup', help='执行系统缓存预热') +def warmup( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 执行系统缓存预热。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _CACHE_COMMAND_CONTROLLER.warmup(env, output, allow_prod, yes) diff --git a/shierfeng-fastapi-backend/cli/groups/cache/controller.py b/shierfeng-fastapi-backend/cli/groups/cache/controller.py new file mode 100644 index 0000000..92fd656 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/cache/controller.py @@ -0,0 +1,183 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.cache import CACHE_RUNTIME, CacheRuntimeService + +from .presenter import CacheCommandPresenter + + +class CacheCommandController: + """ + 缓存命令控制器。 + + 该控制器负责组织 `cache` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 缓存命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: CacheCommandPresenter | None = None, + runtime_service: CacheRuntimeService | None = None, + ) -> None: + """ + 初始化缓存命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 缓存命令文本渲染器 + :param runtime_service: 缓存运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or CacheCommandPresenter() + self.runtime_service = runtime_service or CACHE_RUNTIME + + def stats(self, env: str, output: str) -> None: + """ + 查看缓存统计信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.get_cache_stats()) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_cache_stats_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def keys(self, cache_name: str, env: str, output: str) -> None: + """ + 查看指定缓存名称下的键名列表。 + + :param cache_name: 缓存名称 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.list_cache_keys(cache_name)) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_cache_keys_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def get(self, cache_name: str, cache_key: str, env: str, output: str) -> None: + """ + 查看指定缓存内容。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.get_cache_value(cache_name, cache_key)) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_cache_value_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def clear( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + cache_name: str, + cache_key: str, + clear_all: bool, + ) -> None: + """ + 清理缓存。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param cache_name: 缓存名称前缀 + :param cache_key: 缓存键名 + :param clear_all: 是否清理全部缓存 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='cache clear', + ) + self.execution_service.complete_payload( + ctx, + self.execution_service.run_async( + self.runtime_service.clear_cache( + cache_name=cache_name, + cache_key=cache_key, + clear_all=clear_all, + dry_run=dry_run, + ) + ), + ) + + def ttl(self, cache_name: str, cache_key: str, env: str, output: str) -> None: + """ + 查看指定缓存键的剩余过期时间。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.get_cache_ttl(cache_name, cache_key)) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_cache_ttl_text, + text_condition=lambda result_data: 'error' not in result_data, + ) + + def warmup(self, env: str, output: str, allow_prod: bool, yes: bool) -> None: + """ + 执行系统缓存预热。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + False, + command_name='cache warmup', + ) + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.runtime_service.warmup_cache()) + ) diff --git a/shierfeng-fastapi-backend/cli/groups/cache/presenter.py b/shierfeng-fastapi-backend/cli/groups/cache/presenter.py new file mode 100644 index 0000000..6b96052 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/cache/presenter.py @@ -0,0 +1,150 @@ +from cli.utils import SHELL_TEXT_FORMATTER + + +class CacheCommandPresenter: + """ + 缓存命令文本渲染器。 + + 该渲染器负责将 `cache` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_cache_stats_text(self, payload: dict[str, object]) -> str: + """ + 将缓存统计结果渲染为文本摘要。 + + :param payload: 缓存统计结果 + :return: 文本摘要 + """ + info = payload.get('info') + command_stats = payload.get('commandStats') + cache_names = payload.get('cacheNames') + + redis_version = '-' + connected_clients = '-' + used_memory = '-' + uptime_seconds = '-' + keyspace_hits = '-' + keyspace_misses = '-' + if isinstance(info, dict): + redis_version = info.get('redis_version', '-') + connected_clients = info.get('connected_clients', '-') + used_memory = info.get('used_memory_human', info.get('used_memory', '-')) + uptime_seconds = info.get('uptime_in_seconds', '-') + keyspace_hits = info.get('keyspace_hits', '-') + keyspace_misses = info.get('keyspace_misses', '-') + + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'db_size: {payload.get("dbSize", 0)}', + 'redis:', + f' version: {redis_version}', + f' connected_clients: {connected_clients}', + f' used_memory: {used_memory}', + f' uptime_seconds: {uptime_seconds}', + f' keyspace_hits: {keyspace_hits}', + f' keyspace_misses: {keyspace_misses}', + ] + + if isinstance(command_stats, list) and command_stats: + lines.append('command_stats_top10:') + lines.extend( + f' - {item.get("name", "-")}: {item.get("value", 0)}' + for item in command_stats[:10] + if isinstance(item, dict) + ) + else: + lines.append('command_stats_top10: none') + + if isinstance(cache_names, list) and cache_names: + lines.append(f'cache_names: {len(cache_names)}') + lines.append('cache_name_samples:') + lines.extend( + f' - {item.get("cacheName", "-")}: {self._build_cache_name_remark(item.get("remark", ""))}' + for item in cache_names[:10] + if isinstance(item, dict) + ) + else: + lines.append('cache_names: 0') + + return '\n'.join(lines) + + def build_cache_keys_text(self, payload: dict[str, object]) -> str: + """ + 将缓存键列表结果渲染为文本摘要。 + + :param payload: 缓存键列表结果 + :return: 文本摘要 + """ + keys = payload.get('keys') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'cache_name: {payload.get("cacheName", "")}', + f'count: {payload.get("count", 0)}', + ] + if not isinstance(keys, list) or not keys: + lines.append('keys: none') + return '\n'.join(lines) + + lines.append('keys:') + lines.extend(f' - {key}' for key in keys) + return '\n'.join(lines) + + def build_cache_value_text(self, payload: dict[str, object]) -> str: + """ + 将缓存值读取结果渲染为文本摘要。 + + :param payload: 缓存值读取结果字典 + :return: 文本摘要 + """ + cache_value = '' if payload.get('cacheValue') is None else str(payload.get('cacheValue')) + cache_value_lines = cache_value.splitlines() if cache_value else [] + if not cache_value_lines: + rendered_value_lines = [' -'] + elif len(cache_value_lines) == 1: + rendered_value_lines = [f' {SHELL_TEXT_FORMATTER.truncate_text(cache_value_lines[0], 200)}'] + else: + rendered_value_lines = [' |', *[f' {line}' for line in cache_value_lines]] + + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'cache_name: {payload.get("cacheName", "")}', + f'cache_key: {payload.get("cacheKey", "")}', + f'full_cache_key: {payload.get("fullCacheKey", "")}', + 'cache_value:', + *rendered_value_lines, + ] + ) + + @staticmethod + def build_cache_ttl_text(payload: dict[str, object]) -> str: + """ + 将缓存 TTL 结果渲染为文本摘要。 + + :param payload: 缓存 TTL 结果字典 + :return: 文本摘要 + """ + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'cache_name: {payload.get("cacheName", "")}', + f'cache_key: {payload.get("cacheKey", "")}', + f'full_cache_key: {payload.get("fullCacheKey", "")}', + f'message: {payload.get("message", "-")}', + f'ttl_seconds: {payload.get("ttlSeconds", "-")}', + f'persistent: {str(payload.get("persistent", False)).lower()}', + f'expires: {str(payload.get("expires", False)).lower()}', + ] + ) + + @staticmethod + def _build_cache_name_remark(remark: object) -> str: + """ + 规范化缓存名称备注文本。 + + :param remark: 原始备注 + :return: 规范化后的备注 + """ + text = '' if remark is None else str(remark).strip() + return text or '-' diff --git a/shierfeng-fastapi-backend/cli/groups/config/__init__.py b/shierfeng-fastapi-backend/cli/groups/config/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/config/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/config/command.py b/shierfeng-fastapi-backend/cli/groups/config/command.py new file mode 100644 index 0000000..ed0b695 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/config/command.py @@ -0,0 +1,173 @@ +from typing import Annotated, Literal + +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY +from cli.context import AllowProdOption, DryRunOption, EnvOption, OutputOption, YesOption + +from .controller import ConfigCommandController + +app = typer.Typer( + help='参数配置相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_CONFIG_COMMAND_CONTROLLER = ConfigCommandController() + + +@app.command('list', help='查看参数配置列表') +def list_command( + env: EnvOption = 'dev', + output: OutputOption = 'text', + config_name: Annotated[str, typer.Option('--config-name', help='按参数名称过滤')] = '', + config_key: Annotated[ + str, + typer.Option( + '--config-key', + help='按参数键名过滤', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_config_keys, + ), + ] = '', + config_type: Annotated[Literal['Y', 'N'] | None, typer.Option('--config-type', help='按系统内置标记过滤')] = None, + begin_date: Annotated[str, typer.Option('--begin-date', help='按创建时间开始日期过滤,格式 YYYY-MM-DD')] = '', + end_date: Annotated[str, typer.Option('--end-date', help='按创建时间结束日期过滤,格式 YYYY-MM-DD')] = '', + paged: Annotated[bool, typer.Option('--paged/--no-paged', help='是否启用分页结果')] = False, + page_num: Annotated[int, typer.Option('--page-num', min=1, help='分页页码')] = 1, + page_size: Annotated[int, typer.Option('--page-size', min=1, help='分页每页数量')] = 20, +) -> None: + """ + 查看参数配置列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param config_name: 参数名称过滤条件 + :param config_key: 参数键名过滤条件 + :param config_type: 参数类型过滤条件 + :param begin_date: 查询开始日期 + :param end_date: 查询结束日期 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + _CONFIG_COMMAND_CONTROLLER.list_configs( + env, + output, + config_name=config_name, + config_key=config_key, + config_type=config_type, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + + +@app.command('get', help='查看单个参数配置详情') +def get_command( + config_key: Annotated[ + str, + typer.Argument( + help='需要查询的参数键名', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_config_keys, + ), + ], + env: EnvOption = 'dev', + output: OutputOption = 'text', + source: Annotated[Literal['db', 'cache', 'both'], typer.Option('--source', help='读取来源')] = 'both', +) -> None: + """ + 查看单个参数配置详情。 + + :param config_key: 需要查询的参数键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param source: 配置读取来源 + :return: None + """ + _CONFIG_COMMAND_CONTROLLER.get_config(config_key, env, output, source=source) + + +@app.command('set', help='新增或更新单个参数配置') +def set_command( + config_key: Annotated[ + str, + typer.Argument( + help='需要写入的参数键名', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_config_keys, + ), + ], + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + value: Annotated[str, typer.Option('--value', help='参数键值')] = ..., + name: Annotated[str | None, typer.Option('--name', help='参数名称,新增时必填')] = None, + config_type: Annotated[Literal['Y', 'N'] | None, typer.Option('--config-type', help='系统内置标记')] = None, + remark: Annotated[str | None, typer.Option('--remark', help='参数备注')] = None, +) -> None: + """ + 新增或更新单个参数配置。 + + :param config_key: 需要写入的参数键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param value: 参数键值 + :param name: 参数名称 + :param config_type: 参数类型 + :param remark: 参数备注 + :return: None + """ + _CONFIG_COMMAND_CONTROLLER.set_config( + config_key, + env, + output, + allow_prod, + yes, + dry_run, + value=value, + name=name, + config_type=config_type, + remark=remark, + ) + + +@app.command('sync-cache', help='刷新参数配置缓存') +def sync_cache( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 刷新参数配置缓存。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _CONFIG_COMMAND_CONTROLLER.sync_cache(env, output, allow_prod, yes) + + +@app.command('doctor', help='诊断参数配置数据库与缓存是否一致') +def doctor( + env: EnvOption = 'dev', + output: OutputOption = 'text', + sample_limit: Annotated[int, typer.Option('--sample-limit', min=1, help='问题示例键名输出上限')] = 10, +) -> None: + """ + 诊断参数配置数据库与缓存是否一致。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param sample_limit: 问题示例键名输出上限 + :return: None + """ + _CONFIG_COMMAND_CONTROLLER.doctor(env, output, sample_limit=sample_limit) diff --git a/shierfeng-fastapi-backend/cli/groups/config/controller.py b/shierfeng-fastapi-backend/cli/groups/config/controller.py new file mode 100644 index 0000000..1404898 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/config/controller.py @@ -0,0 +1,225 @@ +from typing import Literal + +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.config import CONFIG_RUNTIME, ConfigRuntimeService + +from .presenter import ConfigCommandPresenter + + +class ConfigCommandController: + """ + 参数配置命令控制器。 + + 该控制器负责组织 `config` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 参数配置命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: ConfigCommandPresenter | None = None, + runtime_service: ConfigRuntimeService | None = None, + ) -> None: + """ + 初始化参数配置命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 参数配置命令文本渲染器 + :param runtime_service: 参数配置运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or ConfigCommandPresenter() + self.runtime_service = runtime_service or CONFIG_RUNTIME + + def list_configs( + self, + env: str, + output: str, + *, + config_name: str, + config_key: str, + config_type: Literal['Y', 'N'] | None, + begin_date: str, + end_date: str, + paged: bool, + page_num: int, + page_size: int, + ) -> None: + """ + 查看参数配置列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param config_name: 参数名称过滤条件 + :param config_key: 参数键名过滤条件 + :param config_type: 参数类型过滤条件 + :param begin_date: 查询开始日期 + :param end_date: 查询结束日期 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async( + self.runtime_service.list_configs( + config_name=config_name, + config_key=config_key, + config_type=config_type, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + ) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_config_list_text, + text_condition=lambda data: data.get('ok', False), + ) + + def get_config( + self, + config_key: str, + env: str, + output: str, + *, + source: Literal['db', 'cache', 'both'], + ) -> None: + """ + 查看单个参数配置详情。 + + :param config_key: 需要查询的参数键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param source: 配置读取来源 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.get_config(config_key, source=source)) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_config_get_text, + text_condition=lambda data: data.get('ok', False), + ) + + def set_config( + self, + config_key: str, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + value: str, + name: str | None, + config_type: Literal['Y', 'N'] | None, + remark: str | None, + ) -> None: + """ + 新增或更新单个参数配置。 + + :param config_key: 需要写入的参数键名 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param value: 参数键值 + :param name: 参数名称 + :param config_type: 参数类型 + :param remark: 参数备注 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='config set', + ) + payload = self.execution_service.run_async( + self.runtime_service.set_config( + config_key, + value, + config_name=name, + config_type=config_type, + remark=remark, + dry_run=dry_run, + ) + ) + payload['env'] = ctx.env + self.execution_service.complete_payload(ctx, payload) + + def sync_cache( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + ) -> None: + """ + 刷新参数配置缓存。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + False, + command_name='config sync-cache', + ) + payload = self.execution_service.run_async(self.runtime_service.sync_config_cache()) + payload['env'] = ctx.env + self.execution_service.complete_payload(ctx, payload) + + def doctor( + self, + env: str, + output: str, + *, + sample_limit: int, + ) -> None: + """ + 诊断参数配置数据库与缓存是否一致。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param sample_limit: 问题示例键名输出上限 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.diagnose_config(sample_limit=sample_limit)) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_config_doctor_text, + text_condition=lambda data: 'error' not in data, + ) diff --git a/shierfeng-fastapi-backend/cli/groups/config/presenter.py b/shierfeng-fastapi-backend/cli/groups/config/presenter.py new file mode 100644 index 0000000..cde9693 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/config/presenter.py @@ -0,0 +1,180 @@ +from cli.utils import SHELL_TEXT_FORMATTER + + +class ConfigCommandPresenter: + """ + 参数配置命令文本渲染器。 + + 该渲染器负责将 `config` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_config_list_text(self, payload: dict[str, object]) -> str: + """ + 将参数配置列表结果渲染为文本摘要。 + + :param payload: 参数配置列表结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + ] + + filters = payload.get('filters') + if isinstance(filters, dict): + lines.extend(self._build_config_filter_lines(filters)) + + page_payload = payload.get('page') + if isinstance(page_payload, dict): + rows = page_payload.get('rows') + lines.append( + 'page: ' + f'{page_payload.get("pageNum", "-")}/{page_payload.get("pages", "-")} ' + f'(page_size={page_payload.get("pageSize", "-")}, total={page_payload.get("total", "-")})' + ) + lines.append(f'count: {len(rows) if isinstance(rows, list) else 0}') + if not isinstance(rows, list) or not rows: + lines.append('configs: none') + return '\n'.join(lines) + lines.append('configs:') + for row in rows: + if isinstance(row, dict): + lines.extend([f' {item}' for item in self._build_config_item_lines(row)]) + return '\n'.join(lines) + + items = payload.get('items') + lines.append(f'count: {payload.get("count", 0)}') + if not isinstance(items, list) or not items: + lines.append('configs: none') + return '\n'.join(lines) + + lines.append('configs:') + for item in items: + if isinstance(item, dict): + lines.extend([f' {line}' for line in self._build_config_item_lines(item)]) + return '\n'.join(lines) + + def build_config_get_text(self, payload: dict[str, object]) -> str: + """ + 将单个参数配置详情结果渲染为文本摘要。 + + :param payload: 参数配置详情结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'key: {payload.get("key", "")}', + f'source: {payload.get("source", "")}', + ] + + if payload.get('source') == 'both': + lines.append(f'in_sync: {str(payload.get("inSync", False)).lower()}') + + if payload.get('source') in {'db', 'both'}: + lines.extend(self._build_config_detail_section('database', payload.get('database'))) + if payload.get('source') in {'cache', 'both'}: + lines.extend(self._build_config_detail_section('cache', payload.get('cache'))) + return '\n'.join(lines) + + def build_config_doctor_text(self, payload: dict[str, object]) -> str: + """ + 将参数配置诊断结果渲染为文本摘要。 + + :param payload: 参数配置诊断结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'message: {payload.get("message", "-")}', + f'database_count: {payload.get("databaseCount", 0)}', + f'cache_count: {payload.get("cacheCount", 0)}', + f'missing_in_cache_count: {payload.get("missingInCacheCount", 0)}', + f'orphan_in_cache_count: {payload.get("orphanInCacheCount", 0)}', + f'mismatch_count: {payload.get("mismatchCount", 0)}', + f'sample_limit: {payload.get("sampleLimit", 0)}', + ] + lines.extend(self._build_config_doctor_items('missing_in_cache', payload.get('missingInCache'))) + lines.extend(self._build_config_doctor_items('orphan_in_cache', payload.get('orphanInCache'))) + lines.extend(self._build_config_doctor_items('mismatch_keys', payload.get('mismatchKeys'))) + return '\n'.join(lines) + + @staticmethod + def _build_config_filter_lines(filters: dict[str, object]) -> list[str]: + """ + 构建参数配置过滤条件文本行。 + + :param filters: 过滤条件字典 + :return: 过滤条件文本行列表 + """ + active_filters = [] + for key, value in filters.items(): + if value in (None, '', False): + continue + active_filters.append(f'{SHELL_TEXT_FORMATTER.to_snake_case(key)}={value}') + if not active_filters: + return ['filters: none'] + return ['filters:', *[f' - {item}' for item in active_filters]] + + @staticmethod + def _build_config_item_lines(config_item: dict[str, object]) -> list[str]: + """ + 构建单条参数配置记录的文本行。 + + :param config_item: 单条参数配置记录 + :return: 文本行列表 + """ + config_id = config_item.get('configId', '-') + config_key = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configKey', ''), 50) + config_name = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configName', ''), 24) + config_type = config_item.get('configType', '-') + config_value = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configValue', ''), 80) + remark = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('remark', ''), 60) + return [ + f'- [{config_id}] {config_key} | 名称: {config_name} | 内置: {config_type}', + f' value: {config_value or "-"}', + f' remark: {remark or "-"}', + ] + + @staticmethod + def _build_config_detail_section(title: str, config_item: dict[str, object] | None) -> list[str]: + """ + 构建单个配置来源的详情文本段落。 + + :param title: 段落标题 + :param config_item: 配置详情字典 + :return: 文本行列表 + """ + if not isinstance(config_item, dict): + return [f'{title}: none'] + + config_key = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configKey', ''), 60) + config_name = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configName', ''), 30) + config_value = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('configValue', ''), 120) + config_type = config_item.get('configType', '-') + remark = SHELL_TEXT_FORMATTER.truncate_text(config_item.get('remark', ''), 80) + config_id = config_item.get('configId', '-') + return [ + f'{title}:', + f' id: {config_id}', + f' key: {config_key or "-"}', + f' name: {config_name or "-"}', + f' value: {config_value or "-"}', + f' type: {config_type}', + f' remark: {remark or "-"}', + ] + + @staticmethod + def _build_config_doctor_items(title: str, items: list[object] | object) -> list[str]: + """ + 构建配置诊断问题示例段落。 + + :param title: 段落标题 + :param items: 问题键名列表 + :return: 文本行列表 + """ + if not isinstance(items, list) or not items: + return [f'{title}: none'] + return [f'{title}:', *[f' - {item}' for item in items]] diff --git a/shierfeng-fastapi-backend/cli/groups/crypto/__init__.py b/shierfeng-fastapi-backend/cli/groups/crypto/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/crypto/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/crypto/command.py b/shierfeng-fastapi-backend/cli/groups/crypto/command.py new file mode 100644 index 0000000..391199b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/crypto/command.py @@ -0,0 +1,94 @@ +import typer + +from cli.context import AllowProdOption, DryRunOption, EnvOption, OutputOption, YesOption + +from .controller import CryptoCommandController + +app = typer.Typer( + help='传输加密相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_CRYPTO_COMMAND_CONTROLLER = CryptoCommandController() + + +@app.command('validate', help='校验传输加密配置') +def validate( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 校验传输加密配置。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CRYPTO_COMMAND_CONTROLLER.validate(env, output) + + +@app.command('keygen', help='生成新的传输加密密钥对') +def keygen( + env: EnvOption = 'dev', + output: OutputOption = 'text', + kid: str = typer.Option('default', '--kid', help='生成的密钥版本标识'), + key_size: int = typer.Option(2048, '--key-size', help='RSA 密钥长度'), +) -> None: + """ + 生成新的传输加密密钥对。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param kid: 生成的密钥版本标识 + :param key_size: RSA 密钥长度 + :return: None + """ + _CRYPTO_COMMAND_CONTROLLER.keygen(env, output, kid=kid, key_size=key_size) + + +@app.command('rotate', help='生成传输加密密钥轮换辅助结果') +def rotate( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + next_kid: str = typer.Option('rotated', '--next-kid', help='轮换后的新密钥版本标识'), + key_size: int = typer.Option(2048, '--key-size', help='新密钥的 RSA 长度'), +) -> None: + """ + 生成传输加密密钥轮换辅助结果。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param next_kid: 轮换后的新密钥版本标识 + :param key_size: 新密钥的 RSA 长度 + :return: None + """ + _CRYPTO_COMMAND_CONTROLLER.rotate( + env, + output, + allow_prod, + yes, + dry_run, + next_kid=next_kid, + key_size=key_size, + ) + + +@app.command('export-public', help='查看当前运行环境的公钥信息') +def export_public( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 导出当前运行环境的公钥信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _CRYPTO_COMMAND_CONTROLLER.export_public(env, output) diff --git a/shierfeng-fastapi-backend/cli/groups/crypto/controller.py b/shierfeng-fastapi-backend/cli/groups/crypto/controller.py new file mode 100644 index 0000000..919e4f4 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/crypto/controller.py @@ -0,0 +1,125 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.crypto import CRYPTO_RUNTIME, CryptoRuntimeService + +from .presenter import CryptoCommandPresenter + + +class CryptoCommandController: + """ + 传输加密命令控制器。 + + 该控制器负责组织 `crypto` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 传输加密命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: CryptoCommandPresenter | None = None, + runtime_service: CryptoRuntimeService | None = None, + ) -> None: + """ + 初始化传输加密命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 传输加密命令文本渲染器 + :param runtime_service: 传输加密运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or CryptoCommandPresenter() + self.runtime_service = runtime_service or CRYPTO_RUNTIME + + def validate(self, env: str, output: str) -> None: + """ + 校验传输加密配置。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload(ctx, self.runtime_service.validate_crypto_config()) + + def keygen(self, env: str, output: str, *, kid: str, key_size: int) -> None: + """ + 生成新的传输加密密钥对。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param kid: 生成的密钥版本标识 + :param key_size: RSA 密钥长度 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.generate_crypto_key_pair(kid, key_size) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_crypto_keygen_text, + text_condition=lambda data: data.get('ok', False), + ) + + def rotate( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + next_kid: str, + key_size: int, + ) -> None: + """ + 生成传输加密密钥轮换辅助结果。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param next_kid: 轮换后的新密钥版本标识 + :param key_size: 新密钥的 RSA 长度 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='crypto rotate', + ) + self.execution_service.complete_payload(ctx, self.runtime_service.build_rotation_payload(next_kid, key_size)) + + def export_public(self, env: str, output: str) -> None: + """ + 导出当前运行环境的公钥信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.export_public_key() + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_export_public_text, + text_condition=lambda data: data.get('ok', False), + ) diff --git a/shierfeng-fastapi-backend/cli/groups/crypto/presenter.py b/shierfeng-fastapi-backend/cli/groups/crypto/presenter.py new file mode 100644 index 0000000..cf5f542 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/crypto/presenter.py @@ -0,0 +1,79 @@ +class CryptoCommandPresenter: + """ + 传输加密命令文本渲染器。 + + 该渲染器负责将 `crypto` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_crypto_keygen_text(self, payload: dict[str, object]) -> str: + """ + 将密钥生成结果渲染为文本摘要。 + + :param payload: 密钥生成结果字典 + :return: 文本摘要 + """ + env_patch = payload.get('envPatch') + env_patch_keys = sorted(env_patch.keys()) if isinstance(env_patch, dict) else [] + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'kid: {payload.get("kid", "-")}', + f'key_size: {payload.get("keySize", "-")}', + ] + lines.extend(self._build_multiline_block('public_key', payload.get('publicKey'))) + lines.extend(self._build_multiline_block('private_key', payload.get('privateKey'))) + if env_patch_keys: + lines.append('env_patch_keys:') + lines.extend(f' - {key}' for key in env_patch_keys) + else: + lines.append('env_patch_keys: none') + return '\n'.join(lines) + + def build_export_public_text(self, payload: dict[str, object]) -> str: + """ + 将公钥导出结果渲染为文本摘要。 + + :param payload: 公钥导出结果字典 + :return: 文本摘要 + """ + public_key_payload = payload.get('publicKey') + if not isinstance(public_key_payload, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'public_key: none', + ] + ) + + supported_kids = public_key_payload.get('supportedKids') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'kid: {public_key_payload.get("kid", "-")}', + f'alg: {public_key_payload.get("alg", "-")}', + f'envelope_version: {public_key_payload.get("envelopeVersion", "-")}', + f'expire_at: {public_key_payload.get("expireAt", "-")}', + ] + if isinstance(supported_kids, list) and supported_kids: + lines.append('supported_kids:') + lines.extend(f' - {kid}' for kid in supported_kids) + else: + lines.append('supported_kids: none') + lines.extend(self._build_multiline_block('public_key_pem', public_key_payload.get('publicKey'))) + return '\n'.join(lines) + + @staticmethod + def _build_multiline_block(title: str, value: object) -> list[str]: + """ + 将多行文本构建为带标题的块级文本。 + + :param title: 块标题 + :param value: 原始文本值 + :return: 文本行列表 + """ + text = '' if value is None else str(value).strip() + if not text: + return [f'{title}: -'] + return [f'{title}:', ' |', *[f' {line}' for line in text.splitlines()]] diff --git a/shierfeng-fastapi-backend/cli/groups/db/__init__.py b/shierfeng-fastapi-backend/cli/groups/db/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/db/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/db/command.py b/shierfeng-fastapi-backend/cli/groups/db/command.py new file mode 100644 index 0000000..80063de --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/db/command.py @@ -0,0 +1,191 @@ +from typing import Annotated + +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY +from cli.context import AllowProdOption, DryRunOption, EnvOption, OutputOption, YesOption + +from .controller import DbCommandController + +app = typer.Typer( + help='数据库相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_DB_COMMAND_CONTROLLER = DbCommandController() + + +@app.command('check', help='检查数据库连接状态') +def check( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 检查数据库连接状态。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _DB_COMMAND_CONTROLLER.check(env, output) + + +@app.command('current', help='查看当前数据库迁移版本') +def current( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看数据库当前迁移版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _DB_COMMAND_CONTROLLER.current(env, output) + + +@app.command('upgrade', help='执行数据库升级') +def upgrade( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + revision: Annotated[ + str, + typer.Option( + '--revision', + help='目标迁移版本', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_alembic_revisions, + ), + ] = 'head', +) -> None: + """ + 执行数据库升级。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param revision: 目标迁移版本 + :return: None + """ + _DB_COMMAND_CONTROLLER.upgrade(env, output, allow_prod, yes, dry_run, revision=revision) + + +@app.command('init', help='初始化数据库到最新迁移版本') +def init( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, +) -> None: + """ + 初始化数据库到最新迁移版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :return: None + """ + _DB_COMMAND_CONTROLLER.init(env, output, allow_prod, yes, dry_run) + + +@app.command('downgrade', help='执行数据库回退') +def downgrade( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + revision: Annotated[ + str, + typer.Option( + '--revision', + help='目标回退版本', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_alembic_revisions, + ), + ] = '-1', +) -> None: + """ + 执行数据库回退。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param revision: 目标回退版本 + :return: None + """ + _DB_COMMAND_CONTROLLER.downgrade(env, output, allow_prod, yes, dry_run, revision=revision) + + +@app.command('revision', help='创建新的数据库迁移版本文件') +def revision( + message: Annotated[str, typer.Option('--message', '-m', help='迁移说明')], + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + autogenerate: bool = typer.Option(False, '--autogenerate/--no-autogenerate', help='是否自动生成迁移内容'), +) -> None: + """ + 创建新的数据库迁移版本文件。 + + :param message: 迁移说明 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param autogenerate: 是否自动生成迁移内容 + :return: None + """ + _DB_COMMAND_CONTROLLER.revision( + message, + env, + output, + allow_prod, + yes, + dry_run, + autogenerate=autogenerate, + ) + + +@app.command('heads', help='查看当前代码仓库中的 Alembic heads') +def heads( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看当前代码仓库中的 Alembic heads。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _DB_COMMAND_CONTROLLER.heads(env, output) + + +@app.command('history', help='查看当前代码仓库中的 Alembic 历史版本') +def history( + env: EnvOption = 'dev', + output: OutputOption = 'text', + limit: Annotated[int, typer.Option('--limit', min=1, help='输出的最大历史记录数量')] = 20, +) -> None: + """ + 查看当前代码仓库中的 Alembic 历史版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param limit: 输出的最大历史记录数量 + :return: None + """ + _DB_COMMAND_CONTROLLER.history(env, output, limit=limit) diff --git a/shierfeng-fastapi-backend/cli/groups/db/controller.py b/shierfeng-fastapi-backend/cli/groups/db/controller.py new file mode 100644 index 0000000..7e4bb3c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/db/controller.py @@ -0,0 +1,237 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.db import DATABASE_RUNTIME, DatabaseRuntimeService + +from .presenter import DbCommandPresenter + + +class DbCommandController: + """ + 数据库命令控制器。 + + 该控制器负责组织 `db` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 数据库命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: DbCommandPresenter | None = None, + runtime_service: DatabaseRuntimeService | None = None, + ) -> None: + """ + 初始化数据库命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 数据库命令文本渲染器 + :param runtime_service: 数据库运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or DbCommandPresenter() + self.runtime_service = runtime_service or DATABASE_RUNTIME + + def check(self, env: str, output: str) -> None: + """ + 检查数据库连接状态。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.runtime_service.ping_database()) + ) + + def current(self, env: str, output: str) -> None: + """ + 查看数据库当前迁移版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.get_current_revision() + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_current_revision_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def upgrade( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + revision: str, + ) -> None: + """ + 执行数据库升级。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param revision: 目标迁移版本 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='db upgrade', + ) + self.execution_service.complete_payload(ctx, self.runtime_service.upgrade_database(revision, dry_run=dry_run)) + + def init( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> None: + """ + 初始化数据库到最新迁移版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='db init', + ) + self.execution_service.complete_payload(ctx, self.runtime_service.init_database(dry_run=dry_run)) + + def downgrade( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + revision: str, + ) -> None: + """ + 执行数据库回退。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param revision: 目标回退版本 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='db downgrade', + ) + self.execution_service.complete_payload(ctx, self.runtime_service.downgrade_database(revision, dry_run=dry_run)) + + def revision( + self, + message: str, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + autogenerate: bool, + ) -> None: + """ + 创建新的数据库迁移版本文件。 + + :param message: 迁移说明 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param autogenerate: 是否自动生成迁移内容 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='db revision', + ) + self.execution_service.complete_payload( + ctx, + self.runtime_service.create_revision(message, autogenerate=autogenerate, dry_run=dry_run), + ) + + def heads(self, env: str, output: str) -> None: + """ + 查看当前代码仓库中的 Alembic heads。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.get_alembic_heads() + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_alembic_revisions_text, + text_condition=lambda result_data: 'error' not in result_data, + ) + + def history(self, env: str, output: str, *, limit: int) -> None: + """ + 查看当前代码仓库中的 Alembic 历史版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param limit: 输出的最大历史记录数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.get_alembic_history(limit=limit) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_alembic_revisions_text, + text_condition=lambda result_data: 'error' not in result_data, + ) diff --git a/shierfeng-fastapi-backend/cli/groups/db/presenter.py b/shierfeng-fastapi-backend/cli/groups/db/presenter.py new file mode 100644 index 0000000..72d04b1 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/db/presenter.py @@ -0,0 +1,71 @@ +class DbCommandPresenter: + """ + 数据库命令文本渲染器。 + + 该渲染器负责将 `db` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + @staticmethod + def build_current_revision_text(payload: dict[str, object]) -> str: + """ + 将数据库当前迁移版本结果渲染为文本摘要。 + + :param payload: 当前迁移版本结果字典 + :return: 文本摘要 + """ + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'current_revision: {payload.get("currentRevision", "-")}', + ] + ) + + def build_alembic_revisions_text(self, payload: dict[str, object]) -> str: + """ + 将 Alembic 修订版本结果渲染为文本摘要。 + + :param payload: 修订版本结果字典 + :return: 文本摘要 + """ + items = payload.get('items') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'message: {payload.get("message", "-")}', + f'count: {payload.get("count", 0)}', + ] + if 'totalCount' in payload: + lines.append(f'total_count: {payload.get("totalCount", 0)}') + if 'limit' in payload: + lines.append(f'limit: {payload.get("limit", 0)}') + if not isinstance(items, list) or not items: + lines.append('items: none') + return '\n'.join(lines) + + lines.append('items:') + for item in items: + if isinstance(item, dict): + lines.extend([f' {line}' for line in self._build_alembic_revision_item_lines(item)]) + return '\n'.join(lines) + + @staticmethod + def _build_alembic_revision_item_lines(revision_item: dict[str, object]) -> list[str]: + """ + 构建单个 Alembic 修订版本的文本行。 + + :param revision_item: 修订版本结果字典 + :return: 文本行列表 + """ + down_revisions = revision_item.get('downRevisions') + branch_labels = revision_item.get('branchLabels') + depends_on = revision_item.get('dependsOn') + return [ + f'- revision: {revision_item.get("revision", "-")}', + f' down_revisions: {",".join(down_revisions) if isinstance(down_revisions, list) and down_revisions else "-"}', + f' branch_labels: {",".join(branch_labels) if isinstance(branch_labels, list) and branch_labels else "-"}', + f' depends_on: {",".join(depends_on) if isinstance(depends_on, list) and depends_on else "-"}', + f' doc: {revision_item.get("doc", "") or "-"}', + f' path: {revision_item.get("path", "-")}', + ] diff --git a/shierfeng-fastapi-backend/cli/groups/dev/__init__.py b/shierfeng-fastapi-backend/cli/groups/dev/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/dev/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/dev/command.py b/shierfeng-fastapi-backend/cli/groups/dev/command.py new file mode 100644 index 0000000..0a0f905 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/dev/command.py @@ -0,0 +1,74 @@ +from typing import Annotated + +import typer + +from cli.context import EnvOption, OutputOption + +from .controller import DevCommandController + +app = typer.Typer( + help='开发相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_DEV_COMMAND_CONTROLLER = DevCommandController() + + +@app.command('lint', help='执行 Ruff 格式化与静态检查') +def lint( + targets: Annotated[list[str] | None, typer.Argument(help='待检查路径,可传多个')] = None, + env: EnvOption = 'dev', + output: OutputOption = 'text', + check_only: bool = typer.Option(False, '--check-only', help='仅检查,不写回格式化结果'), + fix: bool = typer.Option(False, '--fix', help='执行 ruff check --fix'), + unsafe_fixes: bool = typer.Option(False, '--unsafe-fixes', help='允许 Ruff 不安全修复'), +) -> None: + """ + 执行 Ruff 格式化与静态检查。 + + :param targets: 待检查路径列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param check_only: 是否仅检查不写回 + :param fix: 是否自动修复可修复问题 + :param unsafe_fixes: 是否允许不安全修复 + :return: None + """ + _DEV_COMMAND_CONTROLLER.lint( + targets, + env, + output, + check_only=check_only, + fix=fix, + unsafe_fixes=unsafe_fixes, + ) + + +@app.command('test', help='执行项目测试') +def test( + targets: Annotated[list[str] | None, typer.Argument(help='待执行的测试路径,可传多个')] = None, + env: EnvOption = 'dev', + output: OutputOption = 'text', + keyword: str = typer.Option('', '--keyword', '-k', help='pytest -k 过滤表达式'), + maxfail: int = typer.Option(0, '--maxfail', min=0, help='最大失败数,0 表示不限制'), + quiet: bool = typer.Option(False, '--quiet', '-q', help='启用简洁输出'), +) -> None: + """ + 执行项目测试。 + + :param targets: 测试目标路径列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param keyword: pytest 关键字过滤表达式 + :param maxfail: 最大失败数 + :param quiet: 是否启用简洁输出 + :return: None + """ + _DEV_COMMAND_CONTROLLER.test( + targets, + env, + output, + keyword=keyword, + maxfail=maxfail, + quiet=quiet, + ) diff --git a/shierfeng-fastapi-backend/cli/groups/dev/controller.py b/shierfeng-fastapi-backend/cli/groups/dev/controller.py new file mode 100644 index 0000000..ccd8682 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/dev/controller.py @@ -0,0 +1,103 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.dev import DEVELOPMENT_RUNTIME, DevelopmentRuntimeService + +from .presenter import DevCommandPresenter + + +class DevCommandController: + """ + 开发命令控制器。 + + 该控制器负责组织 `dev` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 开发命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: DevCommandPresenter | None = None, + runtime_service: DevelopmentRuntimeService | None = None, + ) -> None: + """ + 初始化开发命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 开发命令文本渲染器 + :param runtime_service: 开发运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or DevCommandPresenter() + self.runtime_service = runtime_service or DEVELOPMENT_RUNTIME + + def lint( + self, + targets: list[str] | None, + env: str, + output: str, + *, + check_only: bool, + fix: bool, + unsafe_fixes: bool, + ) -> None: + """ + 执行 Ruff 格式化与静态检查。 + + :param targets: 待检查路径列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param check_only: 是否仅检查不写回 + :param fix: 是否自动修复可修复问题 + :param unsafe_fixes: 是否允许不安全修复 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.run_lint(targets, check_only=check_only, fix=fix, unsafe_fixes=unsafe_fixes) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_dev_lint_text, + ) + + def test( + self, + targets: list[str] | None, + env: str, + output: str, + *, + keyword: str, + maxfail: int, + quiet: bool, + ) -> None: + """ + 执行项目测试。 + + :param targets: 测试目标路径列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param keyword: pytest 关键字过滤表达式 + :param maxfail: 最大失败数 + :param quiet: 是否启用简洁输出 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.runtime_service.run_tests(targets, keyword=keyword, maxfail=maxfail, quiet=quiet) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_dev_test_text, + ) diff --git a/shierfeng-fastapi-backend/cli/groups/dev/presenter.py b/shierfeng-fastapi-backend/cli/groups/dev/presenter.py new file mode 100644 index 0000000..b5fc144 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/dev/presenter.py @@ -0,0 +1,96 @@ +class DevCommandPresenter: + """ + 开发命令文本渲染器。 + + 该渲染器负责将 `dev` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_dev_lint_text(self, payload: dict[str, object]) -> str: + """ + 将 lint 执行结果渲染为文本摘要。 + + :param payload: lint 执行结果字典 + :return: 文本摘要 + """ + targets = payload.get('targets') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'check_only: {str(payload.get("checkOnly", False)).lower()}', + f'fix: {str(payload.get("fix", False)).lower()}', + f'unsafe_fixes: {str(payload.get("unsafeFixes", False)).lower()}', + ] + if isinstance(targets, list) and targets: + lines.append('targets:') + lines.extend(f' - {target}' for target in targets) + else: + lines.append('targets: none') + lines.extend(self._build_command_result_section('format', payload.get('format'))) + lines.extend(self._build_command_result_section('check', payload.get('check'))) + return '\n'.join(lines) + + def build_dev_test_text(self, payload: dict[str, object]) -> str: + """ + 将测试执行结果渲染为文本摘要。 + + :param payload: 测试执行结果字典 + :return: 文本摘要 + """ + targets = payload.get('targets') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'keyword: {payload.get("keyword", "") or "-"}', + f'maxfail: {payload.get("maxfail", 0)}', + f'quiet: {str(payload.get("quiet", False)).lower()}', + ] + if isinstance(targets, list) and targets: + lines.append('targets:') + lines.extend(f' - {target}' for target in targets) + else: + lines.append('targets: none') + lines.extend(self._build_command_result_section('test', payload.get('test'))) + return '\n'.join(lines) + + @staticmethod + def _build_command_result_section(title: str, payload: dict[str, object] | None) -> list[str]: + """ + 构建单个子命令执行结果段落。 + + :param title: 段落标题 + :param payload: 子命令执行结果 + :return: 文本行列表 + """ + if not isinstance(payload, dict): + return [f'{title}: none'] + + lines = [ + f'{title}:', + f' ok: {str(payload.get("ok", False)).lower()}', + f' return_code: {payload.get("returnCode", "-")}', + f' command: {DevCommandPresenter._format_command_text(payload.get("command"))}', + ] + stdout = payload.get('stdout') + stderr = payload.get('stderr') + if stdout: + lines.append(' stdout:') + lines.append(' |') + lines.extend(f' {line}' for line in str(stdout).splitlines()) + if stderr: + lines.append(' stderr:') + lines.append(' |') + lines.extend(f' {line}' for line in str(stderr).splitlines()) + return lines + + @staticmethod + def _format_command_text(command: object) -> str: + """ + 将命令参数列表格式化为可读文本。 + + :param command: 命令参数列表 + :return: 格式化后的命令文本 + """ + if not isinstance(command, list): + return '-' + return ' '.join(str(item) for item in command) or '-' diff --git a/shierfeng-fastapi-backend/cli/groups/gen/__init__.py b/shierfeng-fastapi-backend/cli/groups/gen/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/gen/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/gen/command.py b/shierfeng-fastapi-backend/cli/groups/gen/command.py new file mode 100644 index 0000000..e4aac33 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/gen/command.py @@ -0,0 +1,273 @@ +from typing import Annotated, Literal + +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY +from cli.context import AllowProdOption, DryRunOption, EnvOption, OutputOption, YesOption + +from .controller import GenCommandController + +app = typer.Typer( + help='代码生成相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_GEN_COMMAND_CONTROLLER = GenCommandController() + + +@app.command('import-table', help='导入数据库表到代码生成业务表') +def import_table( + table_names: Annotated[ + list[str], + typer.Argument( + help='待导入的数据库表名,可传多个', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_gen_db_table_names, + ), + ], + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, +) -> None: + """ + 导入数据库表到代码生成业务表。 + + :param table_names: 待导入表名列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :return: None + """ + _GEN_COMMAND_CONTROLLER.import_table( + table_names, + env, + output, + allow_prod, + yes, + dry_run, + ) + + +@app.command('list', help='查看代码生成业务表列表') +def list_command( + env: EnvOption = 'dev', + output: OutputOption = 'text', + table_name: str = typer.Option( + '', + '--table-name', + help='按表名称过滤', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_gen_table_names, + ), + table_comment: str = typer.Option('', '--table-comment', help='按表描述过滤'), + paged: bool = typer.Option(False, '--paged/--no-paged', help='是否启用分页结果'), + page_num: int = typer.Option(1, '--page-num', min=1, help='分页页码'), + page_size: int = typer.Option(20, '--page-size', min=1, help='分页每页数量'), +) -> None: + """ + 查看代码生成业务表列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + _GEN_COMMAND_CONTROLLER.list_tables( + env, + output, + table_name=table_name, + table_comment=table_comment, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + + +@app.command('db-list', help='查看数据库中可导入的物理表列表') +def db_list( + env: EnvOption = 'dev', + output: OutputOption = 'text', + table_name: str = typer.Option( + '', + '--table-name', + help='按表名称过滤', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_gen_db_table_names, + ), + table_comment: str = typer.Option('', '--table-comment', help='按表描述过滤'), + paged: bool = typer.Option(False, '--paged/--no-paged', help='是否启用分页结果'), + page_num: int = typer.Option(1, '--page-num', min=1, help='分页页码'), + page_size: int = typer.Option(20, '--page-size', min=1, help='分页每页数量'), +) -> None: + """ + 查看数据库中可导入的物理表列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + _GEN_COMMAND_CONTROLLER.list_db_tables( + env, + output, + table_name=table_name, + table_comment=table_comment, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + + +@app.command('detail', help='查看单个代码生成业务表详情') +def detail( + table_id: Annotated[int, typer.Argument(help='业务表 ID')], + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看单个代码生成业务表详情。 + + :param table_id: 业务表 ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _GEN_COMMAND_CONTROLLER.show_detail(table_id, env, output) + + +@app.command('create-table', help='根据建表 SQL 创建表结构并导入代码生成业务表') +def create_table( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + sql: str = typer.Option('', '--sql', help='直接传入建表 SQL 文本'), + sql_file: str = typer.Option( + '', + '--sql-file', + help='从文件读取建表 SQL', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_sql_files, + ), +) -> None: + """ + 根据建表 SQL 创建表结构并导入代码生成业务表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param sql: 直接传入的 SQL 文本 + :param sql_file: SQL 文件路径 + :return: None + """ + _GEN_COMMAND_CONTROLLER.create_table( + env, + output, + allow_prod, + yes, + dry_run, + sql=sql, + sql_file=sql_file, + ) + + +@app.command('preview', help='查看指定业务表的代码生成结果预览') +def preview( + table_id: Annotated[int, typer.Argument(help='业务表 ID')], + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 预览指定业务表的代码生成结果。 + + :param table_id: 业务表 ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _GEN_COMMAND_CONTROLLER.preview(table_id, env, output) + + +@app.command('export', help='导出代码生成结果') +def export( + table_names: Annotated[ + list[str], + typer.Argument( + help='待导出的业务表名,可传多个', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_gen_table_names, + ), + ], + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, + dry_run: DryRunOption = False, + mode: Annotated[Literal['zip', 'local'], typer.Option('--mode', help='导出模式')] = 'zip', + output_file: str = typer.Option( + '', + '--output-file', + help='zip 导出目标文件路径', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_output_paths, + ), +) -> None: + """ + 导出代码生成结果。 + + :param table_names: 业务表名称列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param mode: 导出模式 + :param output_file: zip 导出目标文件路径 + :return: None + """ + _GEN_COMMAND_CONTROLLER.export( + table_names, + env, + output, + allow_prod, + yes, + dry_run, + mode=mode, + output_file=output_file, + ) + + +@app.command('sync-db', help='同步指定业务表的数据库表结构') +def sync_db( + table_name: Annotated[ + str, + typer.Argument( + help='业务表名称', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_gen_table_names, + ), + ], + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 同步指定业务表的数据库表结构。 + + :param table_name: 业务表名称 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _GEN_COMMAND_CONTROLLER.sync_db(table_name, env, output, allow_prod, yes) diff --git a/shierfeng-fastapi-backend/cli/groups/gen/controller.py b/shierfeng-fastapi-backend/cli/groups/gen/controller.py new file mode 100644 index 0000000..84fb446 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/gen/controller.py @@ -0,0 +1,304 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.gen import GEN_RUNTIME, GenRuntimeService + +from .presenter import GenCommandPresenter + + +class GenCommandController: + """ + 代码生成命令控制器。 + + 该控制器负责组织 `gen` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 代码生成命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: GenCommandPresenter | None = None, + runtime_service: GenRuntimeService | None = None, + ) -> None: + """ + 初始化代码生成命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 代码生成命令文本渲染器 + :param runtime_service: 代码生成运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or GenCommandPresenter() + self.runtime_service = runtime_service or GEN_RUNTIME + + def import_table( + self, + table_names: list[str], + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> None: + """ + 导入数据库表到代码生成业务表。 + + :param table_names: 待导入表名列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='gen import-table', + ) + payload = self.execution_service.run_async(self.runtime_service.import_tables(table_names, dry_run=dry_run)) + payload['env'] = ctx.env + self.execution_service.complete_payload(ctx, payload) + + def list_tables( + self, + env: str, + output: str, + *, + table_name: str, + table_comment: str, + paged: bool, + page_num: int, + page_size: int, + ) -> None: + """ + 查看代码生成业务表列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async( + self.runtime_service.list_gen_tables( + table_name=table_name, + table_comment=table_comment, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + ) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=lambda data: self.presenter.build_gen_table_list_text(data, db_mode=False), + text_condition=lambda data: data.get('ok', False), + ) + + def list_db_tables( + self, + env: str, + output: str, + *, + table_name: str, + table_comment: str, + paged: bool, + page_num: int, + page_size: int, + ) -> None: + """ + 查看数据库中可导入的物理表列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async( + self.runtime_service.list_gen_db_tables( + table_name=table_name, + table_comment=table_comment, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + ) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=lambda data: self.presenter.build_gen_table_list_text(data, db_mode=True), + text_condition=lambda data: data.get('ok', False), + ) + + def show_detail(self, table_id: int, env: str, output: str) -> None: + """ + 查看单个代码生成业务表详情。 + + :param table_id: 业务表 ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.get_gen_table_detail(table_id)) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_gen_detail_text, + text_condition=lambda data: 'error' not in data, + ) + + def create_table( + self, + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + sql: str, + sql_file: str, + ) -> None: + """ + 根据建表 SQL 创建表结构并导入代码生成业务表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param sql: 直接传入的 SQL 文本 + :param sql_file: SQL 文件路径 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='gen create-table', + ) + payload = self.execution_service.run_async(self.runtime_service.create_tables(sql, sql_file, dry_run=dry_run)) + payload['env'] = ctx.env + self.execution_service.complete_payload(ctx, payload) + + def preview(self, table_id: int, env: str, output: str) -> None: + """ + 预览指定业务表的代码生成结果。 + + :param table_id: 业务表 ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.runtime_service.preview_code(table_id)) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_gen_preview_text, + text_condition=lambda data: data.get('ok', False), + ) + + def export( + self, + table_names: list[str], + env: str, + output: str, + allow_prod: bool, + yes: bool, + dry_run: bool, + *, + mode: str, + output_file: str, + ) -> None: + """ + 导出代码生成结果。 + + :param table_names: 业务表名称列表 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :param dry_run: 是否演练执行 + :param mode: 导出模式 + :param output_file: zip 导出目标文件路径 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + dry_run, + command_name='gen export', + ) + payload = self.execution_service.run_async( + self.runtime_service.export_code(table_names, mode=mode, output_file=output_file, dry_run=dry_run) + ) + payload['env'] = ctx.env + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_gen_export_text, + text_condition=lambda data: data.get('ok', False), + ) + + def sync_db( + self, + table_name: str, + env: str, + output: str, + allow_prod: bool, + yes: bool, + ) -> None: + """ + 同步指定业务表的数据库表结构。 + + :param table_name: 业务表名称 + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous( + env, + output, + allow_prod, + yes, + False, + command_name='gen sync-db', + ) + payload = self.execution_service.run_async(self.runtime_service.sync_gen_table_from_db(table_name)) + payload['env'] = ctx.env + self.execution_service.complete_payload(ctx, payload) diff --git a/shierfeng-fastapi-backend/cli/groups/gen/presenter.py b/shierfeng-fastapi-backend/cli/groups/gen/presenter.py new file mode 100644 index 0000000..92844bf --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/gen/presenter.py @@ -0,0 +1,231 @@ +from cli.utils import SHELL_TEXT_FORMATTER + + +class GenCommandPresenter: + """ + 代码生成命令文本渲染器。 + + 该渲染器负责将 `gen` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_gen_preview_text(self, payload: dict[str, object]) -> str: + """ + 将代码预览结果渲染为文本摘要。 + + :param payload: 代码预览结果字典 + :return: 文本摘要 + """ + preview_payload = payload.get('preview') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'table_id: {payload.get("tableId", "-")}', + f'template_count: {payload.get("templateCount", 0)}', + ] + if not isinstance(preview_payload, dict) or not preview_payload: + lines.append('templates: none') + return '\n'.join(lines) + + lines.append('templates:') + for template_name, template_content in preview_payload.items(): + lines.extend([f' {line}' for line in self._build_text_block(str(template_name), template_content)]) + return '\n'.join(lines) + + def build_gen_export_text(self, payload: dict[str, object]) -> str: + """ + 将代码导出结果渲染为文本摘要。 + + :param payload: 代码导出结果字典 + :return: 文本摘要 + """ + table_names = payload.get('tableNames') + results = payload.get('results') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + f'mode: {payload.get("mode", "-")}', + f'dry_run: {str(payload.get("dryRun", False)).lower()}', + f'message: {payload.get("message", "-")}', + ] + if isinstance(table_names, list) and table_names: + lines.append('table_names:') + lines.extend(f' - {table_name}' for table_name in table_names) + else: + lines.append('table_names: none') + + if payload.get('outputFile'): + lines.append(f'output_file: {payload.get("outputFile")}') + if payload.get('genPath'): + lines.append(f'gen_path: {payload.get("genPath")}') + if payload.get('size') is not None: + lines.append(f'size: {payload.get("size")}') + + if isinstance(results, list) and results: + lines.append('results:') + lines.extend( + f' - {item.get("tableName", "-")}: {str(item.get("ok", False)).lower()} | {item.get("message", "-")}' + for item in results + if isinstance(item, dict) + ) + return '\n'.join(lines) + + def build_gen_table_list_text(self, payload: dict[str, object], *, db_mode: bool = False) -> str: + """ + 将代码生成表列表或数据库表列表渲染为文本摘要。 + + :param payload: 列表结果字典 + :param db_mode: 是否为数据库物理表列表模式 + :return: 文本摘要 + """ + lines = [f'ok: {str(payload.get("ok", False)).lower()}'] + filters = payload.get('filters') + if isinstance(filters, dict): + lines.extend(self._build_gen_filter_lines(filters)) + + page_payload = payload.get('page') + if isinstance(page_payload, dict): + rows = page_payload.get('rows', []) + lines.append( + 'page: ' + f'{page_payload.get("pageNum", "-")}/{page_payload.get("pages", "-")} ' + f'(page_size={page_payload.get("pageSize", "-")}, total={page_payload.get("total", "-")})' + ) + lines.append(f'count: {len(rows) if isinstance(rows, list) else 0}') + if not isinstance(rows, list) or not rows: + lines.append('items: none') + return '\n'.join(lines) + lines.append('items:') + for row in rows: + if isinstance(row, dict): + item_lines = ( + self._build_gen_db_table_item_lines(row) if db_mode else self._build_gen_table_item_lines(row) + ) + lines.extend([f' {item}' for item in item_lines]) + return '\n'.join(lines) + + items = payload.get('items') + lines.append(f'count: {payload.get("count", 0)}') + if not isinstance(items, list) or not items: + lines.append('items: none') + return '\n'.join(lines) + + lines.append('items:') + for item in items: + if isinstance(item, dict): + item_lines = ( + self._build_gen_db_table_item_lines(item) if db_mode else self._build_gen_table_item_lines(item) + ) + lines.extend([f' {line}' for line in item_lines]) + return '\n'.join(lines) + + def build_gen_detail_text(self, payload: dict[str, object]) -> str: + """ + 将代码生成业务表详情渲染为文本摘要。 + + :param payload: 详情结果字典 + :return: 文本摘要 + """ + detail = payload.get('detail') + if not isinstance(detail, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'table_id: {payload.get("tableId", "-")}', + 'detail: none', + ] + ) + + info = detail.get('info') + if not isinstance(info, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'table_id: {payload.get("tableId", "-")}', + 'info: none', + ] + ) + + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'table_id: {payload.get("tableId", "-")}', + f'table_name: {payload.get("tableName", "-")}', + f'column_count: {payload.get("columnCount", 0)}', + f'table_count: {payload.get("tableCount", 0)}', + f'table_comment: {SHELL_TEXT_FORMATTER.truncate_text(info.get("tableComment", ""), 80) or "-"}', + f'class_name: {info.get("className", "-")}', + f'tpl_category: {info.get("tplCategory", "-")}', + f'tpl_web_type: {info.get("tplWebType", "-")}', + f'package_name: {SHELL_TEXT_FORMATTER.truncate_text(info.get("packageName", ""), 80) or "-"}', + f'module_name: {info.get("moduleName", "-")}', + f'business_name: {info.get("businessName", "-")}', + f'function_name: {info.get("functionName", "-")}', + f'function_author: {info.get("functionAuthor", "-")}', + f'gen_type: {info.get("genType", "-")}', + f'gen_path: {SHELL_TEXT_FORMATTER.truncate_text(info.get("genPath", ""), 120) or "-"}', + f'remark: {SHELL_TEXT_FORMATTER.truncate_text(info.get("remark", ""), 160) or "-"}', + ] + ) + + @staticmethod + def _build_text_block(title: str, value: object) -> list[str]: + """ + 将多行文本构建为带标题的块级文本。 + + :param title: 块标题 + :param value: 原始文本值 + :return: 文本行列表 + """ + text = '' if value is None else str(value) + if not text.strip(): + return [f'{title}: -'] + return [f'{title}:', ' |', *[f' {line}' for line in text.splitlines()]] + + @staticmethod + def _build_gen_filter_lines(filters: dict[str, object]) -> list[str]: + """ + 构建代码生成表过滤条件文本行。 + + :param filters: 过滤条件字典 + :return: 过滤条件文本行列表 + """ + active_filters = [] + for key, value in filters.items(): + if value in (None, '', False): + continue + active_filters.append(f'{SHELL_TEXT_FORMATTER.to_snake_case(key)}={value}') + if not active_filters: + return ['filters: none'] + return ['filters:', *[f' - {item}' for item in active_filters]] + + @staticmethod + def _build_gen_table_item_lines(table_item: dict[str, object]) -> list[str]: + """ + 构建单条代码生成表记录的文本行。 + + :param table_item: 代码生成表记录 + :return: 文本行列表 + """ + return [ + f'- [{table_item.get("tableId", "-")}] {SHELL_TEXT_FORMATTER.truncate_text(table_item.get("tableName", ""), 40) or "-"}', + f' comment: {SHELL_TEXT_FORMATTER.truncate_text(table_item.get("tableComment", ""), 60) or "-"}', + f' class_name: {table_item.get("className", "-")}', + f' tpl_category: {table_item.get("tplCategory", "-")} | module_name: {table_item.get("moduleName", "-")}', + f' business_name: {table_item.get("businessName", "-")} | function_name: {table_item.get("functionName", "-")}', + ] + + @staticmethod + def _build_gen_db_table_item_lines(table_item: dict[str, object]) -> list[str]: + """ + 构建单条数据库物理表记录的文本行。 + + :param table_item: 数据库物理表记录 + :return: 文本行列表 + """ + return [ + f'- {SHELL_TEXT_FORMATTER.truncate_text(table_item.get("tableName", ""), 48) or "-"}', + f' comment: {SHELL_TEXT_FORMATTER.truncate_text(table_item.get("tableComment", ""), 80) or "-"}', + f' create_time: {table_item.get("createTime", "-")}', + f' update_time: {table_item.get("updateTime", "-")}', + ] diff --git a/shierfeng-fastapi-backend/cli/groups/job/__init__.py b/shierfeng-fastapi-backend/cli/groups/job/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/job/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/job/command.py b/shierfeng-fastapi-backend/cli/groups/job/command.py new file mode 100644 index 0000000..af62ea7 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/job/command.py @@ -0,0 +1,216 @@ +import typer + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY +from cli.context import AllowProdOption, EnvOption, OutputOption, YesOption + +from .controller import JobCommandController + +app = typer.Typer( + help='定时任务相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_JOB_COMMAND_CONTROLLER = JobCommandController() + + +@app.command('list', help='查看定时任务列表') +def list_command( + env: EnvOption = 'dev', + output: OutputOption = 'text', + job_name: str = typer.Option( + '', + '--job-name', + help='按任务名称过滤', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_names, + ), + job_group: str = typer.Option('', '--job-group', help='按任务组过滤'), + status: str | None = typer.Option(None, '--status', help='按任务状态过滤,0正常 1暂停'), + paged: bool = typer.Option(False, '--paged/--no-paged', help='是否启用分页结果'), + page_num: int = typer.Option(1, '--page-num', min=1, help='分页页码'), + page_size: int = typer.Option(20, '--page-size', min=1, help='分页每页数量'), +) -> None: + """ + 查看定时任务列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 状态过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + _JOB_COMMAND_CONTROLLER.list( + env, + output, + job_name=job_name, + job_group=job_group, + status=status, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + + +@app.command('run-once', help='执行一次定时任务') +def run_once( + job_id: int = typer.Argument( + ..., + help='任务ID', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_ids, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 执行一次定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _JOB_COMMAND_CONTROLLER.run_once(job_id, env, output, allow_prod, yes) + + +@app.command('detail', help='查看单个定时任务详情') +def detail( + job_id: int = typer.Argument( + ..., + help='任务ID', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_ids, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 查看单个定时任务详情。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _JOB_COMMAND_CONTROLLER.detail(job_id, env, output) + + +@app.command('logs', help='查看定时任务执行日志列表') +def logs( + env: EnvOption = 'dev', + output: OutputOption = 'text', + job_name: str = typer.Option( + '', + '--job-name', + help='按任务名称过滤', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_names, + ), + job_group: str = typer.Option('', '--job-group', help='按任务组过滤'), + status: str | None = typer.Option(None, '--status', help='按执行状态过滤,0成功 1失败'), + begin_date: str = typer.Option('', '--begin-date', help='按创建时间开始日期过滤,格式 YYYY-MM-DD'), + end_date: str = typer.Option('', '--end-date', help='按创建时间结束日期过滤,格式 YYYY-MM-DD'), + paged: bool = typer.Option(False, '--paged/--no-paged', help='是否启用分页结果'), + page_num: int = typer.Option(1, '--page-num', min=1, help='分页页码'), + page_size: int = typer.Option(20, '--page-size', min=1, help='分页每页数量'), +) -> None: + """ + 查看定时任务执行日志列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 执行状态过滤条件 + :param begin_date: 查询开始日期 + :param end_date: 查询结束日期 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + _JOB_COMMAND_CONTROLLER.logs( + env, + output, + job_name=job_name, + job_group=job_group, + status=status, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + + +@app.command('pause', help='暂停定时任务') +def pause( + job_id: int = typer.Argument( + ..., + help='任务ID', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_ids, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 暂停定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _JOB_COMMAND_CONTROLLER.pause(job_id, env, output, allow_prod, yes) + + +@app.command('resume', help='恢复定时任务') +def resume( + job_id: int = typer.Argument( + ..., + help='任务ID', + autocompletion=COMPLETION_PROVIDER_GATEWAY.complete_job_ids, + ), + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 恢复定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _JOB_COMMAND_CONTROLLER.resume(job_id, env, output, allow_prod, yes) + + +@app.command('sync', help='同步调度任务配置') +def sync( + env: EnvOption = 'dev', + output: OutputOption = 'text', + allow_prod: AllowProdOption = False, + yes: YesOption = False, +) -> None: + """ + 同步调度任务配置。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + _JOB_COMMAND_CONTROLLER.sync(env, output, allow_prod, yes) diff --git a/shierfeng-fastapi-backend/cli/groups/job/controller.py b/shierfeng-fastapi-backend/cli/groups/job/controller.py new file mode 100644 index 0000000..92bc252 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/job/controller.py @@ -0,0 +1,221 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.runtime.job import JOB_RUNTIME, JobRuntimeService +from cli.runtime.ops import OPERATIONS_RUNTIME, OperationsRuntimeService + +from .presenter import JobCommandPresenter + + +class JobCommandController: + """ + 定时任务命令控制器。 + + 该控制器负责组织 `job` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 定时任务命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: JobCommandPresenter | None = None, + operations_runtime: OperationsRuntimeService | None = None, + job_runtime: JobRuntimeService | None = None, + ) -> None: + """ + 初始化定时任务命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 定时任务命令文本渲染器 + :param operations_runtime: 运维运行时服务 + :param job_runtime: 定时任务运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or JobCommandPresenter() + self.operations_runtime = operations_runtime or OPERATIONS_RUNTIME + self.job_runtime = job_runtime or JOB_RUNTIME + + def list( + self, + env: str, + output: str, + *, + job_name: str, + job_group: str, + status: str | None, + paged: bool, + page_num: int, + page_size: int, + ) -> None: + """ + 查看定时任务列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 状态过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async( + self.job_runtime.list_jobs( + job_name=job_name, + job_group=job_group, + status=status, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + ) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_job_list_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def run_once(self, job_id: int, env: str, output: str, allow_prod: bool, yes: bool) -> None: + """ + 执行一次定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous(env, output, allow_prod, yes, False, command_name='job run-once') + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.job_runtime.run_job_once(job_id)) + ) + + def detail(self, job_id: int, env: str, output: str) -> None: + """ + 查看单个定时任务详情。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.job_runtime.get_job_detail(job_id)) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_job_detail_text, + text_condition=lambda result_data: 'error' not in result_data, + ) + + def logs( + self, + env: str, + output: str, + *, + job_name: str, + job_group: str, + status: str | None, + begin_date: str, + end_date: str, + paged: bool, + page_num: int, + page_size: int, + ) -> None: + """ + 查看定时任务执行日志列表。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 执行状态过滤条件 + :param begin_date: 查询开始日期 + :param end_date: 查询结束日期 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async( + self.job_runtime.list_job_logs( + job_name=job_name, + job_group=job_group, + status=status, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + ) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_job_logs_text, + text_condition=lambda result_data: bool(result_data.get('ok', False)), + ) + + def pause(self, job_id: int, env: str, output: str, allow_prod: bool, yes: bool) -> None: + """ + 暂停定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous(env, output, allow_prod, yes, False, command_name='job pause') + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.job_runtime.pause_job(job_id)) + ) + + def resume(self, job_id: int, env: str, output: str, allow_prod: bool, yes: bool) -> None: + """ + 恢复定时任务。 + + :param job_id: 任务ID + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous(env, output, allow_prod, yes, False, command_name='job resume') + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.job_runtime.resume_job(job_id)) + ) + + def sync(self, env: str, output: str, allow_prod: bool, yes: bool) -> None: + """ + 同步调度任务配置。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境危险命令 + :param yes: 是否跳过确认 + :return: None + """ + ctx = self.context_factory.build_dangerous(env, output, allow_prod, yes, False, command_name='job sync') + self.execution_service.complete_payload( + ctx, + self.execution_service.run_async(self.operations_runtime.sync_jobs()), + ) diff --git a/shierfeng-fastapi-backend/cli/groups/job/presenter.py b/shierfeng-fastapi-backend/cli/groups/job/presenter.py new file mode 100644 index 0000000..e52f570 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/job/presenter.py @@ -0,0 +1,197 @@ +from cli.utils import SHELL_TEXT_FORMATTER + + +class JobCommandPresenter: + """ + 定时任务命令文本渲染器。 + + 该渲染器负责将 `job` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_job_list_text(self, payload: dict[str, object]) -> str: + """ + 将任务列表结果渲染为文本摘要。 + + :param payload: 任务列表结果字典 + :return: 文本摘要 + """ + lines = [f'ok: {str(payload.get("ok", False)).lower()}'] + + filters = payload.get('filters') + if isinstance(filters, dict): + lines.extend(self._build_job_filter_lines(filters)) + + page_payload = payload.get('page') + if isinstance(page_payload, dict): + rows = page_payload.get('rows', []) + lines.append( + 'page: ' + f'{page_payload.get("pageNum", "-")}/{page_payload.get("pages", "-")} ' + f'(page_size={page_payload.get("pageSize", "-")}, total={page_payload.get("total", "-")})' + ) + lines.append(f'count: {len(rows) if isinstance(rows, list) else 0}') + if not isinstance(rows, list) or not rows: + lines.append('jobs: none') + return '\n'.join(lines) + lines.append('jobs:') + for row in rows: + if isinstance(row, dict): + lines.extend([f' {item}' for item in self._build_job_item_lines(row)]) + return '\n'.join(lines) + + items = payload.get('items') + lines.append(f'count: {payload.get("count", 0)}') + if not isinstance(items, list) or not items: + lines.append('jobs: none') + return '\n'.join(lines) + + lines.append('jobs:') + for item in items: + if isinstance(item, dict): + lines.extend([f' {line}' for line in self._build_job_item_lines(item)]) + return '\n'.join(lines) + + def build_job_detail_text(self, payload: dict[str, object]) -> str: + """ + 将单个定时任务详情渲染为文本摘要。 + + :param payload: 定时任务详情结果字典 + :return: 文本摘要 + """ + job = payload.get('job') + if not isinstance(job, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'job_id: {payload.get("jobId", "-")}', + 'job: none', + ] + ) + + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'job_id: {job.get("jobId", "-")}', + f'job_name: {job.get("jobName", "-")}', + f'job_group: {job.get("jobGroup", "-")}', + f'job_executor: {job.get("jobExecutor", "-")}', + f'status: {job.get("status", "-")}', + f'cron_expression: {job.get("cronExpression", "-")}', + f'invoke_target: {SHELL_TEXT_FORMATTER.truncate_text(job.get("invokeTarget", ""), 160) or "-"}', + f'job_args: {SHELL_TEXT_FORMATTER.truncate_text(job.get("jobArgs", ""), 120) or "-"}', + f'job_kwargs: {SHELL_TEXT_FORMATTER.truncate_text(job.get("jobKwargs", ""), 120) or "-"}', + f'misfire_policy: {job.get("misfirePolicy", "-")}', + f'concurrent: {job.get("concurrent", "-")}', + f'remark: {SHELL_TEXT_FORMATTER.truncate_text(job.get("remark", ""), 160) or "-"}', + f'create_by: {job.get("createBy", "-")}', + f'create_time: {job.get("createTime", "-")}', + f'update_by: {job.get("updateBy", "-")}', + f'update_time: {job.get("updateTime", "-")}', + ] + ) + + def build_job_logs_text(self, payload: dict[str, object]) -> str: + """ + 将定时任务日志列表结果渲染为文本摘要。 + + :param payload: 定时任务日志列表结果字典 + :return: 文本摘要 + """ + lines = [f'ok: {str(payload.get("ok", False)).lower()}'] + + filters = payload.get('filters') + if isinstance(filters, dict): + lines.extend(self._build_job_filter_lines(filters)) + + page_payload = payload.get('page') + if isinstance(page_payload, dict): + rows = page_payload.get('rows', []) + lines.append( + 'page: ' + f'{page_payload.get("pageNum", "-")}/{page_payload.get("pages", "-")} ' + f'(page_size={page_payload.get("pageSize", "-")}, total={page_payload.get("total", "-")})' + ) + lines.append(f'count: {len(rows) if isinstance(rows, list) else 0}') + if not isinstance(rows, list) or not rows: + lines.append('logs: none') + return '\n'.join(lines) + lines.append('logs:') + for row in rows: + if isinstance(row, dict): + lines.extend([f' {item}' for item in self._build_job_log_item_lines(row)]) + return '\n'.join(lines) + + items = payload.get('items') + lines.append(f'count: {payload.get("count", 0)}') + if not isinstance(items, list) or not items: + lines.append('logs: none') + return '\n'.join(lines) + + lines.append('logs:') + for item in items: + if isinstance(item, dict): + lines.extend([f' {line}' for line in self._build_job_log_item_lines(item)]) + return '\n'.join(lines) + + @staticmethod + def _build_job_filter_lines(filters: dict[str, object]) -> list[str]: + """ + 构建任务列表过滤条件文本行。 + + :param filters: 过滤条件字典 + :return: 过滤条件文本行列表 + """ + active_filters = [] + for key, value in filters.items(): + if value in (None, '', False): + continue + active_filters.append(f'{SHELL_TEXT_FORMATTER.to_snake_case(key)}={value}') + if not active_filters: + return ['filters: none'] + return ['filters:', *[f' - {item}' for item in active_filters]] + + @staticmethod + def _build_job_item_lines(job_item: dict[str, object]) -> list[str]: + """ + 构建单条任务记录的文本行。 + + :param job_item: 单条任务记录 + :return: 任务记录文本行列表 + """ + job_id = job_item.get('jobId', '-') + job_name = SHELL_TEXT_FORMATTER.truncate_text(job_item.get('jobName', ''), 30) + job_group = SHELL_TEXT_FORMATTER.truncate_text(job_item.get('jobGroup', ''), 16) + status = job_item.get('status', '-') + cron_expression = SHELL_TEXT_FORMATTER.truncate_text(job_item.get('cronExpression', ''), 40) + invoke_target = SHELL_TEXT_FORMATTER.truncate_text(job_item.get('invokeTarget', ''), 80) + executor = SHELL_TEXT_FORMATTER.truncate_text(job_item.get('jobExecutor', ''), 24) + return [ + f'- [{job_id}] {job_name} | 组: {job_group} | 状态: {status}', + f' cron: {cron_expression or "-"}', + f' invoke: {invoke_target or "-"}', + f' executor: {executor or "-"}', + ] + + @staticmethod + def _build_job_log_item_lines(job_log_item: dict[str, object]) -> list[str]: + """ + 构建单条定时任务日志记录的文本行。 + + :param job_log_item: 单条定时任务日志记录 + :return: 文本行列表 + """ + job_log_id = job_log_item.get('jobLogId', '-') + job_name = SHELL_TEXT_FORMATTER.truncate_text(job_log_item.get('jobName', ''), 30) + job_group = SHELL_TEXT_FORMATTER.truncate_text(job_log_item.get('jobGroup', ''), 16) + status = job_log_item.get('status', '-') + job_trigger = SHELL_TEXT_FORMATTER.truncate_text(job_log_item.get('jobTrigger', ''), 40) + job_message = SHELL_TEXT_FORMATTER.truncate_text(job_log_item.get('jobMessage', ''), 80) + exception_info = SHELL_TEXT_FORMATTER.truncate_text(job_log_item.get('exceptionInfo', ''), 120) + return [ + f'- [{job_log_id}] {job_name} | 组: {job_group} | 状态: {status}', + f' trigger: {job_trigger or "-"}', + f' message: {job_message or "-"}', + f' exception: {exception_info or "-"}', + f' create_time: {job_log_item.get("createTime", "-")}', + ] diff --git a/shierfeng-fastapi-backend/cli/groups/ops/__init__.py b/shierfeng-fastapi-backend/cli/groups/ops/__init__.py new file mode 100644 index 0000000..0a2282e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/ops/__init__.py @@ -0,0 +1,3 @@ +from .command import app + +__all__ = ['app'] diff --git a/shierfeng-fastapi-backend/cli/groups/ops/command.py b/shierfeng-fastapi-backend/cli/groups/ops/command.py new file mode 100644 index 0000000..c12530d --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/ops/command.py @@ -0,0 +1,89 @@ +import typer + +from cli.context import EnvOption, OutputOption + +from .controller import OpsCommandController + +app = typer.Typer( + help='运维相关命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, +) +_OPS_COMMAND_CONTROLLER = OpsCommandController() + + +@app.command('ping-db', help='检查数据库连接') +def ping_db( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 检查数据库连接。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _OPS_COMMAND_CONTROLLER.ping_db(env, output) + + +@app.command('ping-redis', help='检查 Redis 连接') +def ping_redis_command( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 检查 Redis 连接。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _OPS_COMMAND_CONTROLLER.ping_redis(env, output) + + +@app.command('health', help='查看基础健康检查结果') +def health( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 输出基础健康检查结果。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _OPS_COMMAND_CONTROLLER.health(env, output) + + +@app.command('deps', help='查看当前 CLI 和后端运行依赖版本') +def deps( + env: EnvOption = 'dev', + output: OutputOption = 'text', + include_dev: bool = typer.Option(False, '--include-dev', help='附带输出开发依赖'), +) -> None: + """ + 检查当前 CLI 和后端运行依赖版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param include_dev: 是否附带输出开发依赖 + :return: None + """ + _OPS_COMMAND_CONTROLLER.deps(env, output, include_dev=include_dev) + + +@app.command('server-info', help='查看服务器运行时信息') +def server_info( + env: EnvOption = 'dev', + output: OutputOption = 'text', +) -> None: + """ + 输出服务器运行时信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + _OPS_COMMAND_CONTROLLER.server_info(env, output) diff --git a/shierfeng-fastapi-backend/cli/groups/ops/controller.py b/shierfeng-fastapi-backend/cli/groups/ops/controller.py new file mode 100644 index 0000000..346abeb --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/ops/controller.py @@ -0,0 +1,137 @@ +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliContextFactory, + CliExecutionService, +) +from cli.exit_codes import DEPENDENCY_ERROR, SUCCESS +from cli.runtime.db import DATABASE_RUNTIME, DatabaseRuntimeService +from cli.runtime.ops import OPERATIONS_RUNTIME, OperationsRuntimeService + +from .presenter import OpsCommandPresenter + + +class OpsCommandController: + """ + 运维命令控制器。 + + 该控制器负责组织 `ops` 命令组的上下文准备、runtime 调用、 + payload 注入,以及基于输出格式选择 presenter 或直接返回 JSON。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 运维命令文本渲染器 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory | None = None, + execution_service: CliExecutionService | None = None, + presenter: OpsCommandPresenter | None = None, + database_runtime: DatabaseRuntimeService | None = None, + operations_runtime: OperationsRuntimeService | None = None, + ) -> None: + """ + 初始化运维命令控制器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param presenter: 运维命令文本渲染器 + :param database_runtime: 数据库运行时服务 + :param operations_runtime: 运维运行时服务 + :return: None + """ + self.context_factory = context_factory or DEFAULT_CORE_SERVICES.context_factory + self.execution_service = execution_service or DEFAULT_CORE_SERVICES.execution_service + self.presenter = presenter or OpsCommandPresenter() + self.database_runtime = database_runtime or DATABASE_RUNTIME + self.operations_runtime = operations_runtime or OPERATIONS_RUNTIME + + def ping_db(self, env: str, output: str) -> None: + """ + 检查数据库连接。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload( + ctx, self.execution_service.run_async(self.database_runtime.ping_database()) + ) + + def ping_redis(self, env: str, output: str) -> None: + """ + 检查 Redis 连接。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + self.execution_service.complete_payload( + ctx, + self.execution_service.run_async(self.operations_runtime.ping_redis()), + ) + + def health(self, env: str, output: str) -> None: + """ + 输出基础健康检查结果。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + db_status = self.execution_service.run_async(self.database_runtime.ping_database()) + redis_status = self.execution_service.run_async(self.operations_runtime.ping_redis()) + payload = { + 'env': ctx.env, + 'database': db_status, + 'redis': redis_status, + 'ok': db_status.get('ok', False) and redis_status.get('ok', False), + } + exit_code = SUCCESS if payload['ok'] else DEPENDENCY_ERROR + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_health_text, + default_exit_code=exit_code, + ) + + def deps(self, env: str, output: str, *, include_dev: bool) -> None: + """ + 检查当前 CLI 和后端运行依赖版本。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :param include_dev: 是否附带输出开发依赖 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.operations_runtime.get_dependency_versions(include_dev=include_dev) + exit_code = SUCCESS if payload.get('ok', False) else DEPENDENCY_ERROR + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_dependencies_text, + default_exit_code=exit_code, + ) + + def server_info(self, env: str, output: str) -> None: + """ + 输出服务器运行时信息。 + + :param env: 当前命令运行环境 + :param output: 输出格式 + :return: None + """ + ctx = self.context_factory.build_readonly(env, output) + payload = self.execution_service.run_async(self.operations_runtime.get_server_info()) + self.execution_service.complete_payload_with_text( + ctx, + payload, + text_builder=self.presenter.build_server_info_text, + default_exit_code=SUCCESS, + text_condition=lambda data: data.get('ok', False), + ) diff --git a/shierfeng-fastapi-backend/cli/groups/ops/presenter.py b/shierfeng-fastapi-backend/cli/groups/ops/presenter.py new file mode 100644 index 0000000..31aa1ab --- /dev/null +++ b/shierfeng-fastapi-backend/cli/groups/ops/presenter.py @@ -0,0 +1,177 @@ +from cli.utils import SHELL_TEXT_FORMATTER + + +class OpsCommandPresenter: + """ + 运维命令文本渲染器。 + + 该渲染器负责将 `ops` 命令组产生的结构化 payload 转换为稳定的文本摘要, + 同时保持 JSON 输出仍由控制器直接返回,不在此处做契约变形。 + """ + + def build_health_text(self, payload: dict[str, object]) -> str: + """ + 将基础健康检查结果渲染为文本摘要。 + + :param payload: 健康检查结果字典 + :return: 文本摘要 + """ + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "")}', + 'checks:', + self._build_check_status_line('database', payload.get('database')), + self._build_check_status_line('redis', payload.get('redis')), + ] + ) + + def build_server_info_text(self, payload: dict[str, object]) -> str: + """ + 将服务器运行时信息渲染为文本摘要。 + + :param payload: 服务器运行时信息结果字典 + :return: 文本摘要 + """ + server = payload.get('server') + if not isinstance(server, dict): + return '\n'.join( + [ + f'ok: {str(payload.get("ok", False)).lower()}', + 'server: none', + ] + ) + + sys_info = server.get('sys') + cpu_info = server.get('cpu') + mem_info = server.get('mem') + py_info = server.get('py') + sys_files = server.get('sysFiles') + + lines = [f'ok: {str(payload.get("ok", False)).lower()}'] + if isinstance(sys_info, dict): + lines.extend( + [ + 'host:', + f' name: {sys_info.get("computerName", "-")}', + f' ip: {sys_info.get("computerIp", "-")}', + f' os: {SHELL_TEXT_FORMATTER.truncate_text(sys_info.get("osName", "-"), 90)}', + f' arch: {sys_info.get("osArch", "-")}', + f' user_dir: {SHELL_TEXT_FORMATTER.truncate_text(sys_info.get("userDir", "-"), 100)}', + ] + ) + + if isinstance(cpu_info, dict): + lines.extend( + [ + 'cpu:', + f' cores: {cpu_info.get("cpuNum", "-")}', + f' used: {cpu_info.get("used", "-")}%', + f' sys: {cpu_info.get("sys", "-")}%', + f' free: {cpu_info.get("free", "-")}%', + ] + ) + + if isinstance(mem_info, dict): + lines.extend( + [ + 'memory:', + f' total: {mem_info.get("total", "-")}', + f' used: {mem_info.get("used", "-")}', + f' free: {mem_info.get("free", "-")}', + f' usage: {mem_info.get("usage", "-")}%', + ] + ) + + if isinstance(py_info, dict): + lines.extend( + [ + 'python:', + f' name: {py_info.get("name", "-")}', + f' version: {py_info.get("version", "-")}', + f' start_time: {py_info.get("startTime", "-")}', + f' run_time: {py_info.get("runTime", "-")}', + f' home: {SHELL_TEXT_FORMATTER.truncate_text(py_info.get("home", "-"), 100)}', + f' process_memory: {py_info.get("used", "-")} / {py_info.get("total", "-")} ({py_info.get("usage", "-")}%)', + ] + ) + + if isinstance(sys_files, list): + lines.append(f'disks: {len(sys_files)}') + if sys_files: + lines.append('disk_samples:') + lines.extend( + f' - {item.get("dirName", "-")} | used: {item.get("used", "-")} / {item.get("total", "-")} | usage: {item.get("usage", "-")}' + for item in sys_files[:10] + if isinstance(item, dict) + ) + + return '\n'.join(lines) + + def build_dependencies_text(self, payload: dict[str, object]) -> str: + """ + 将依赖版本检查结果渲染为文本摘要。 + + :param payload: 依赖版本检查结果字典 + :return: 文本摘要 + """ + packages = payload.get('packages') + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'message: {payload.get("message", "-")}', + f'include_dev: {str(payload.get("includeDev", False)).lower()}', + ] + missing_required = payload.get('missingRequired') + if isinstance(missing_required, list) and missing_required: + lines.append('missing_required:') + lines.extend(f' - {item}' for item in missing_required) + else: + lines.append('missing_required: none') + + if not isinstance(packages, dict) or not packages: + lines.append('packages: none') + return '\n'.join(lines) + + lines.append('packages:') + for package_name in sorted(packages): + dependency_payload = packages.get(package_name) + if isinstance(dependency_payload, dict): + lines.append(self._build_dependency_line(package_name, dependency_payload)) + return '\n'.join(lines) + + @staticmethod + def _build_check_status_line(name: str, status_payload: dict[str, object] | None) -> str: + """ + 构建单项检查结果摘要行。 + + :param name: 检查项名称 + :param status_payload: 检查结果字典 + :return: 摘要行文本 + """ + if not isinstance(status_payload, dict): + return f' {name}: unknown' + + ok = str(status_payload.get('ok', False)).lower() + message = status_payload.get('message', '-') or '-' + error = status_payload.get('error') + if error: + return f' {name}: {ok} | {message} | error: {SHELL_TEXT_FORMATTER.truncate_text(error, 120)}' + return f' {name}: {ok} | {message}' + + @staticmethod + def _build_dependency_line(name: str, dependency_payload: dict[str, object] | None) -> str: + """ + 构建单个依赖项的文本摘要行。 + + :param name: 依赖项名称 + :param dependency_payload: 依赖项结果字典 + :return: 文本摘要行 + """ + if not isinstance(dependency_payload, dict): + return f' {name}: not-installed' + + installed = str(dependency_payload.get('installed', False)).lower() + version = dependency_payload.get('version', '-') or '-' + required = str(dependency_payload.get('required', False)).lower() + distribution = dependency_payload.get('distribution', '') or name + return f' {name}: {installed} | version: {version} | required: {required} | dist: {distribution}' diff --git a/shierfeng-fastapi-backend/cli/guards.py b/shierfeng-fastapi-backend/cli/guards.py new file mode 100644 index 0000000..8f1c708 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/guards.py @@ -0,0 +1,210 @@ +import sys +from dataclasses import dataclass, field +from typing import Literal + +import click +import typer + +from cli.context import CliContext +from cli.exit_codes import GUARD_REJECTED +from cli.output import CommandResult + +DangerousCommandRiskLevel = Literal['high', 'normal'] + + +@dataclass(frozen=True) +class DangerousCommandRule: + """ + 危险命令保护规则。 + + :param command_name: 命令唯一标识 + :param risk_level: 风险级别 + :param supports_dry_run: 是否支持演练执行 + """ + + command_name: str + risk_level: DangerousCommandRiskLevel + supports_dry_run: bool + + +@dataclass(frozen=True) +class DangerousCommandRuleRegistry: + """ + 危险命令规则注册表。 + + 该注册表负责维护 CLI 内所有危险命令的风险元数据,并提供查询与 + 强制获取能力,作为上下文工厂、风险元数据与测试的统一入口。 + + :param rules: 按命令名索引的危险命令规则表 + """ + + rules: dict[str, DangerousCommandRule] + + def get_rule(self, command_name: str) -> DangerousCommandRule | None: + """ + 获取指定命令的危险命令规则。 + + :param command_name: 命令唯一标识 + :return: 命令规则,不存在时返回 None + """ + return self.rules.get(command_name) + + def require_rule(self, command_name: str) -> DangerousCommandRule: + """ + 获取指定命令的危险命令规则,不存在时抛出异常。 + + :param command_name: 命令唯一标识 + :return: 命令规则 + :raises ValueError: 命令未注册危险命令规则时抛出 + """ + rule = self.get_rule(command_name) + if rule is None: + raise ValueError(f'危险命令未注册保护规则:{command_name}') + return rule + + +@dataclass(frozen=True) +class DangerousCommandResultBuilder: + """ + 危险命令结果构建器。 + + 该对象负责统一构建危险命令拒绝结果,避免保护服务内部继续拼装 + 结构化负载细节。 + """ + + @staticmethod + def build_guard_reject_result(message: str, hint: str) -> CommandResult: + """ + 构建危险命令拒绝结果。 + + :param message: 拒绝原因 + :param hint: 补充提示 + :return: 命令拒绝结果 + """ + return CommandResult( + data={ + 'ok': False, + 'message': message, + 'hint': hint, + }, + exit_code=GUARD_REJECTED, + ) + + +@dataclass(frozen=True) +class DangerousCommandConfirmationService: + """ + 危险命令确认服务。 + + 该对象负责处理 TTY 检测、确认提示与交互取消异常收口。 + + :param result_builder: 危险命令结果构建器 + """ + + result_builder: DangerousCommandResultBuilder + + def confirm(self, ctx: CliContext, *, command_name: str) -> CommandResult | None: + """ + 执行危险命令交互确认。 + + :param ctx: CLI 上下文 + :param command_name: 命令唯一标识 + :return: 拒绝结果或 None + """ + if ctx.yes: + return None + + if not sys.stdin.isatty(): + return self.result_builder.build_guard_reject_result( + f'已取消危险命令执行:{command_name}', + '当前命令需要交互确认;如需非交互执行,请传入 --yes', + ) + + try: + confirmed = typer.confirm( + f'确认执行危险命令 `{command_name}` 吗? 当前环境:{ctx.env}{"(dry-run)" if ctx.dry_run else ""}', + default=False, + ) + except (click.Abort, EOFError, KeyboardInterrupt): + return self.result_builder.build_guard_reject_result( + f'已取消危险命令执行:{command_name}', + '当前命令需要交互确认;如需非交互执行,请传入 --yes', + ) + if confirmed: + return None + + return self.result_builder.build_guard_reject_result( + f'已取消危险命令执行:{command_name}', + '如需跳过确认,请传入 --yes', + ) + + +@dataclass +class DangerousCommandGuardService: + """ + 危险命令保护执行服务。 + + 该服务负责根据命令规则和 CLI 上下文执行生产环境保护、交互确认 + 与拒绝结果收口。 + + :param rule_registry: 危险命令规则注册表 + :param result_builder: 危险命令结果构建器 + :param confirmation_service: 危险命令确认服务 + """ + + rule_registry: DangerousCommandRuleRegistry + result_builder: DangerousCommandResultBuilder = field(default_factory=DangerousCommandResultBuilder) + confirmation_service: DangerousCommandConfirmationService = field(init=False) + + def __post_init__(self) -> None: + """ + 初始化危险命令保护服务依赖。 + + :return: None + """ + self.confirmation_service = DangerousCommandConfirmationService(self.result_builder) + + def guard(self, ctx: CliContext, *, rule: DangerousCommandRule) -> CommandResult | None: + """ + 执行危险命令保护与确认。 + + :param ctx: CLI 上下文 + :param rule: 危险命令规则 + :return: 拒绝结果或 None + """ + command_name = rule.command_name + if ctx.env == 'prod' and not ctx.allow_prod: + return self.result_builder.build_guard_reject_result( + f'生产环境默认禁止直接执行危险命令:{command_name}', + '如确认执行,请传入 --allow-prod;如需跳过确认,请同时传入 --yes', + ) + + return self.confirmation_service.confirm(ctx, command_name=command_name) + + +DEFAULT_DANGEROUS_COMMAND_RULES: dict[str, DangerousCommandRule] = { + 'cache clear': DangerousCommandRule(command_name='cache clear', risk_level='high', supports_dry_run=True), + 'cache warmup': DangerousCommandRule(command_name='cache warmup', risk_level='normal', supports_dry_run=False), + 'db upgrade': DangerousCommandRule(command_name='db upgrade', risk_level='high', supports_dry_run=True), + 'db init': DangerousCommandRule(command_name='db init', risk_level='high', supports_dry_run=True), + 'db downgrade': DangerousCommandRule(command_name='db downgrade', risk_level='high', supports_dry_run=True), + 'db revision': DangerousCommandRule(command_name='db revision', risk_level='high', supports_dry_run=True), + 'config set': DangerousCommandRule(command_name='config set', risk_level='high', supports_dry_run=True), + 'config sync-cache': DangerousCommandRule( + command_name='config sync-cache', + risk_level='normal', + supports_dry_run=False, + ), + 'crypto rotate': DangerousCommandRule(command_name='crypto rotate', risk_level='high', supports_dry_run=True), + 'job run-once': DangerousCommandRule(command_name='job run-once', risk_level='normal', supports_dry_run=False), + 'job pause': DangerousCommandRule(command_name='job pause', risk_level='normal', supports_dry_run=False), + 'job resume': DangerousCommandRule(command_name='job resume', risk_level='normal', supports_dry_run=False), + 'job sync': DangerousCommandRule(command_name='job sync', risk_level='normal', supports_dry_run=False), + 'gen import-table': DangerousCommandRule(command_name='gen import-table', risk_level='high', supports_dry_run=True), + 'gen create-table': DangerousCommandRule(command_name='gen create-table', risk_level='high', supports_dry_run=True), + 'gen export': DangerousCommandRule(command_name='gen export', risk_level='high', supports_dry_run=True), + 'gen sync-db': DangerousCommandRule(command_name='gen sync-db', risk_level='normal', supports_dry_run=False), +} + +DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY = DangerousCommandRuleRegistry(rules=DEFAULT_DANGEROUS_COMMAND_RULES) +DEFAULT_DANGEROUS_COMMAND_GUARD = DangerousCommandGuardService(rule_registry=DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY) diff --git a/shierfeng-fastapi-backend/cli/main.py b/shierfeng-fastapi-backend/cli/main.py new file mode 100644 index 0000000..32c59bf --- /dev/null +++ b/shierfeng-fastapi-backend/cli/main.py @@ -0,0 +1,100 @@ +import sys +from dataclasses import dataclass + +from cli.core import ( + DEFAULT_CORE_SERVICES, + CliApplicationBuilder, + CompletionDispatcher, + ProjectRuntimeLocator, +) + + +@dataclass(frozen=True) +class CliImportArgvScope: + """ + CLI 导入期参数作用域。 + + 该对象负责在根应用构建阶段暂时切换 `sys.argv`,只保留导入期 + 需要的最小参数集,避免该过程继续以内联 `try/finally` 形式散落 + 在入口运行器中。 + + :param project_runtime_locator: CLI 项目运行时定位器 + """ + + project_runtime_locator: ProjectRuntimeLocator + + def run(self, callback: object) -> object: + """ + 在导入期参数作用域内执行回调。 + + :param callback: 待执行回调 + :return: 回调执行结果 + """ + original_argv = list(sys.argv) + try: + sys.argv = self.project_runtime_locator.extract_import_argv(original_argv) + return callback() + finally: + sys.argv = original_argv + + +@dataclass(frozen=True) +class CliMainRunner: + """ + CLI 根入口运行器。 + + 该运行器负责串联项目目录定位、导入期参数裁剪、根应用构建、 + completion 分发与 Typer 应用启动,避免 `main.py` 继续停留在 + 模块级散乱编排状态。 + + :param project_runtime_locator: CLI 项目运行时定位器 + :param completion_dispatcher: shell completion 分发器 + :param application_builder: 根应用构建器 + """ + + project_runtime_locator: ProjectRuntimeLocator + completion_dispatcher: CompletionDispatcher + application_builder: CliApplicationBuilder + import_argv_scope: CliImportArgvScope + + def build_cli(self) -> object: + """ + 构建 CLI 根应用,并在导入期仅保留最小化参数集。 + + :return: Typer 根应用 + """ + self.project_runtime_locator.ensure_backend_dir_on_sys_path() + return self.import_argv_scope.run(self.application_builder.build) + + def run(self) -> None: + """ + 执行 Typer CLI 根应用。 + + :return: None + """ + cli = self.build_cli() + self.completion_dispatcher.dispatch(cli) + cli(prog_name='shierfeng') + + +CLI_APPLICATION_BUILDER = CliApplicationBuilder(output_renderer=DEFAULT_CORE_SERVICES.output_renderer) +PROJECT_RUNTIME_LOCATOR = ProjectRuntimeLocator() +CLI_MAIN_RUNNER = CliMainRunner( + project_runtime_locator=PROJECT_RUNTIME_LOCATOR, + completion_dispatcher=CompletionDispatcher(), + application_builder=CLI_APPLICATION_BUILDER, + import_argv_scope=CliImportArgvScope(project_runtime_locator=PROJECT_RUNTIME_LOCATOR), +) + + +def main() -> None: + """ + 执行 CLI 根入口运行器。 + + :return: None + """ + CLI_MAIN_RUNNER.run() + + +if __name__ == '__main__': + main() diff --git a/shierfeng-fastapi-backend/cli/metadata/__init__.py b/shierfeng-fastapi-backend/cli/metadata/__init__.py new file mode 100644 index 0000000..0d626c8 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/metadata/__init__.py @@ -0,0 +1,10 @@ +from cli.metadata.command_specs import COMPLETION_SHELL_SPEC_REGISTRY, CompletionShellSpec, CompletionShellSpecRegistry +from cli.metadata.option_specs import ENVIRONMENT_OPTION_SERVICE, EnvironmentOptionService + +__all__ = [ + 'COMPLETION_SHELL_SPEC_REGISTRY', + 'ENVIRONMENT_OPTION_SERVICE', + 'CompletionShellSpec', + 'CompletionShellSpecRegistry', + 'EnvironmentOptionService', +] diff --git a/shierfeng-fastapi-backend/cli/metadata/command_specs.py b/shierfeng-fastapi-backend/cli/metadata/command_specs.py new file mode 100644 index 0000000..0b1fa5b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/metadata/command_specs.py @@ -0,0 +1,98 @@ +from dataclasses import dataclass +from typing import Literal + + +@dataclass(frozen=True) +class CompletionShellSpec: + """ + Shell completion 元数据定义。 + + name: shell 名称 + description: shell 描述文本 + generator: 脚本生成方式 + default_target: 默认脚本落盘路径,相对于用户 home 目录 + default_rc_file: 默认 rc 文件路径,相对于用户 home 目录 + auto_discovery: 是否会被 shell 自动发现 + supported: 当前版本是否已支持 + """ + + name: str + description: str + generator: Literal['click', 'custom', 'unsupported'] + default_target: str + default_rc_file: str | None + auto_discovery: bool + supported: bool + + +@dataclass(frozen=True) +class CompletionShellSpecRegistry: + """ + completion shell 元数据注册表。 + + 该注册表集中维护 CLI 当前支持的 shell completion 元数据, + 供 installer、doctor 和 provider 等场景统一查询。 + + :param specs: 按 shell 名称索引的元数据表 + """ + + specs: dict[str, CompletionShellSpec] + + def get_spec(self, shell_name: str) -> CompletionShellSpec | None: + """ + 获取指定 shell 的 completion 元数据。 + + :param shell_name: shell 名称 + :return: shell 元数据,不存在时返回 None + """ + return self.specs.get(shell_name) + + def list_shell_names(self) -> list[str]: + """ + 获取已注册的 shell 名称列表。 + + :return: shell 名称列表 + """ + return list(self.specs) + + +DEFAULT_COMPLETION_SHELL_SPECS: dict[str, CompletionShellSpec] = { + 'bash': CompletionShellSpec( + name='bash', + description='GNU Bash shell completion', + generator='click', + default_target='.local/share/shierfeng/completion/shierfeng.bash', + default_rc_file='.bashrc', + auto_discovery=False, + supported=True, + ), + 'zsh': CompletionShellSpec( + name='zsh', + description='Zsh shell completion', + generator='click', + default_target='.local/share/shierfeng/completion/shierfeng.zsh', + default_rc_file='.zshrc', + auto_discovery=False, + supported=True, + ), + 'fish': CompletionShellSpec( + name='fish', + description='Fish shell completion', + generator='click', + default_target='.config/fish/completions/shierfeng.fish', + default_rc_file=None, + auto_discovery=True, + supported=True, + ), + 'powershell': CompletionShellSpec( + name='powershell', + description='Windows PowerShell / PowerShell 7 completion', + generator='custom', + default_target='Documents/PowerShell/Profile/shierfeng.ps1', + default_rc_file='Documents/PowerShell/Microsoft.PowerShell_profile.ps1', + auto_discovery=False, + supported=True, + ), +} + +COMPLETION_SHELL_SPEC_REGISTRY = CompletionShellSpecRegistry(specs=DEFAULT_COMPLETION_SHELL_SPECS) diff --git a/shierfeng-fastapi-backend/cli/metadata/option_specs.py b/shierfeng-fastapi-backend/cli/metadata/option_specs.py new file mode 100644 index 0000000..557e986 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/metadata/option_specs.py @@ -0,0 +1,36 @@ +from dataclasses import dataclass +from pathlib import Path + +DEFAULT_ENVIRONMENTS = ('dev', 'prod', 'dockermy', 'dockerpg') + + +@dataclass(frozen=True) +class EnvironmentOptionService: + """ + CLI 环境选项服务。 + + 该服务负责发现当前项目下可用的环境名称集合,供 completion、 + wizard 和诊断信息等场景复用。 + + :param default_environments: 默认内置环境名称列表 + """ + + default_environments: tuple[str, ...] = DEFAULT_ENVIRONMENTS + + def discover_env_names(self, project_dir: Path | None = None) -> list[str]: + """ + 发现当前项目可用的环境名称列表。 + + :param project_dir: 后端项目目录,默认使用当前工作目录 + :return: 去重且排序后的环境名称列表 + """ + resolved_project_dir = (project_dir or Path.cwd()).resolve() + env_names = set(self.default_environments) + for env_file in resolved_project_dir.glob('.env.*'): + suffix = env_file.name.removeprefix('.env.').strip() + if suffix: + env_names.add(suffix) + return sorted(env_names) + + +ENVIRONMENT_OPTION_SERVICE = EnvironmentOptionService() diff --git a/shierfeng-fastapi-backend/cli/metadata/risk_specs.py b/shierfeng-fastapi-backend/cli/metadata/risk_specs.py new file mode 100644 index 0000000..d009304 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/metadata/risk_specs.py @@ -0,0 +1,75 @@ +from dataclasses import dataclass +from typing import Literal + +from cli.guards import DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY, DangerousCommandRuleRegistry + +CommandRiskLevel = Literal['readonly', 'normal', 'high'] + + +@dataclass(frozen=True) +class CommandRiskSpec: + """ + CLI 命令风险元数据定义。 + + :param command_name: 命令唯一标识 + :param risk_level: 风险级别 + :param supports_dry_run: 是否支持演练执行 + """ + + command_name: str + risk_level: CommandRiskLevel + supports_dry_run: bool + + +@dataclass(frozen=True) +class CommandRiskSpecRegistry: + """ + CLI 命令风险元数据注册表。 + + 该注册表负责从危险命令规则注册表派生风险元数据,供 TUI、文档、 + 诊断提示等只读场景统一查询。 + + :param specs: 按命令名索引的风险元数据表 + """ + + specs: dict[str, CommandRiskSpec] + + def get_spec(self, command_name: str) -> CommandRiskSpec | None: + """ + 获取指定命令的风险元数据。 + + :param command_name: 命令唯一标识 + :return: 风险元数据,不存在时返回 None + """ + return self.specs.get(command_name) + + +class CommandRiskSpecRegistryBuilder: + """ + CLI 命令风险元数据注册表构建器。 + + 该构建器负责基于危险命令规则注册表生成命令风险元数据注册表, + 避免模块导入阶段散落重复的字典推导逻辑。 + """ + + @staticmethod + def build(rule_registry: DangerousCommandRuleRegistry) -> CommandRiskSpecRegistry: + """ + 基于危险命令规则注册表构建风险元数据注册表。 + + :param rule_registry: 危险命令规则注册表 + :return: 风险元数据注册表 + """ + return CommandRiskSpecRegistry( + specs={ + command_name: CommandRiskSpec( + command_name=rule.command_name, + risk_level=rule.risk_level, + supports_dry_run=rule.supports_dry_run, + ) + for command_name, rule in rule_registry.rules.items() + } + ) + + +COMMAND_RISK_SPEC_REGISTRY = CommandRiskSpecRegistryBuilder.build(DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY) diff --git a/shierfeng-fastapi-backend/cli/output.py b/shierfeng-fastapi-backend/cli/output.py new file mode 100644 index 0000000..121ff17 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/output.py @@ -0,0 +1,873 @@ +import json +import os +import re +import sys +from dataclasses import dataclass +from typing import Any + +import typer + +from cli.context import CliContext + + +@dataclass +class OutputSettings: + """ + 输出渲染配置。 + + :param color_mode: 颜色模式 + :param icon_mode: 图标模式 + """ + + color_mode: str = 'always' + icon_mode: str = 'emoji' + + +@dataclass(frozen=True) +class StatusTokenDefinition: + """ + 状态标签定义。 + + :param emoji: emoji 模式文案 + :param ascii: ASCII 模式文案 + :param none: 无图标模式文案 + :param color: 默认前景色 + """ + + emoji: str + ascii: str + none: str + color: str + + +@dataclass +class CommandResult: + """ + 统一命令执行结果。 + + :param data: 命令结果负载 + :param exit_code: 命令退出码 + :param already_printed: 是否已由上层提前输出 + """ + + data: Any = None + exit_code: int = 0 + already_printed: bool = False + + +class OutputStatusStyler: + """ + 统一负责状态标签与单行文本样式。 + + :param settings: 输出配置 + """ + + _STATUS_DEFINITIONS = { + 'ok': StatusTokenDefinition(emoji='✅ OK', ascii='[OK]', none='OK', color='green'), + 'fail': StatusTokenDefinition(emoji='❌ FAIL', ascii='[FAIL]', none='FAIL', color='red'), + 'warn': StatusTokenDefinition(emoji='💡 HINT', ascii='[HINT]', none='HINT', color='yellow'), + 'error': StatusTokenDefinition(emoji='🚨 ERROR', ascii='[ERROR]', none='ERROR', color='red'), + 'info': StatusTokenDefinition(emoji='💬 INFO', ascii='[INFO]', none='INFO', color='blue'), + } + _STATUS_FIELD_KIND_MAPPING = { + 'message': 'info', + 'info': 'info', + 'hint': 'warn', + 'warn': 'warn', + 'warning': 'warn', + 'error': 'error', + } + + def __init__(self, settings: OutputSettings) -> None: + """ + 初始化状态样式器。 + + :param settings: 输出配置 + :return: None + """ + self.settings = settings + + def supports_color(self, stream: Any) -> bool: + """ + 判断当前输出流是否应启用颜色。 + + :param stream: 输出流对象 + :return: 是否启用颜色 + """ + if self.settings.color_mode == 'always': + return True + if self.settings.color_mode == 'never': + return False + if os.environ.get('NO_COLOR'): + return False + if os.environ.get('TERM') == 'dumb': + return False + return bool(getattr(stream, 'isatty', lambda: False)()) + + @staticmethod + def style_text(text: str, *, fg: str | None = None, bold: bool = False, dim: bool = False) -> str: + """ + 为文本附加终端样式。 + + :param text: 原始文本 + :param fg: 前景色 + :param bold: 是否加粗 + :param dim: 是否弱化显示 + :return: 样式化后的文本 + """ + return typer.style(text, fg=fg, bold=bold, dim=dim) + + def get_status_definition(self, kind: str) -> StatusTokenDefinition: + """ + 获取状态标签定义。 + + :param kind: 状态类型 + :return: 状态标签定义 + """ + return self._STATUS_DEFINITIONS.get(kind, self._STATUS_DEFINITIONS['info']) + + def build_status_token(self, kind: str) -> str: + """ + 根据当前图标模式构建状态标签文本。 + + :param kind: 标签类型 + :return: 标签文本 + """ + definition = self.get_status_definition(kind) + return getattr(definition, self.settings.icon_mode, definition.none) + + def style_status_token(self, kind: str, *, fg: str | None = None) -> str: + """ + 将状态标签渲染为高亮样式。 + + :param kind: 标签类型 + :param fg: 前景色 + :return: 样式化后的标签文本 + """ + definition = self.get_status_definition(kind) + return self.style_text(self.build_status_token(kind), fg=fg or definition.color, bold=True) + + def style_status_message(self, kind: str, text: str) -> str: + """ + 使用统一状态图标和颜色渲染消息文本。 + + :param kind: 状态类型 + :param text: 原始消息文本 + :return: 样式化后的消息文本 + """ + color = self.get_status_definition(kind).color + return f'{self.style_status_token(kind, fg=color)} {self.style_text(text, fg=color, bold=kind == "error")}' + + def build_result_header(self, is_ok: bool) -> str: + """ + 构建统一的结果头部文本。 + + :param is_ok: 是否成功 + :return: 结果头部文本 + """ + if is_ok: + return f'{self.build_status_token("ok")} SUCCESS' + return f'{self.build_status_token("fail")} FAILED' + + def style_scalar_text(self, value: str) -> str: + """ + 为标量文本值应用颜色样式。 + + :param value: 原始标量文本 + :return: 样式化后的文本 + """ + normalized_value = value.strip().lower() + if normalized_value == 'true': + return self.style_text(value, fg='green', bold=True) + if normalized_value == 'false': + return self.style_text(value, fg='red', bold=True) + if normalized_value in {'null', 'none', '-'}: + return self.style_text(value, fg='bright_black') + return value + + def style_inline_status_segment(self, segment: str) -> str: + """ + 为行内状态片段应用样式。 + + :param segment: 原始片段文本 + :return: 样式化后的片段文本 + """ + normalized_segment = segment.strip().lower() + if normalized_segment == 'true': + return self.style_status_token('ok', fg='green') + if normalized_segment == 'false': + return self.style_status_token('fail', fg='red') + for prefix, kind in self._STATUS_FIELD_KIND_MAPPING.items(): + if normalized_segment.startswith(f'{prefix}:'): + status_message = segment.split(':', 1)[1].strip() + return self.style_status_message(kind, status_message) + if ': ' in segment: + segment_key, segment_value = segment.split(': ', 1) + styled_segment_value = self.style_inline_status_value(segment_value) + if styled_segment_value != segment_value: + return f'{segment_key}: {styled_segment_value}' + return segment + + def style_inline_status_value(self, value: str) -> str: + """ + 为带分隔符的行内状态值应用样式。 + + :param value: 原始字段值 + :return: 样式化后的字段值 + """ + if ' | ' not in value: + styled_value = self.style_inline_status_segment(value) + if styled_value != value: + return styled_value + return self.style_scalar_text(value) + return ' | '.join(self.style_inline_status_segment(segment) for segment in value.split(' | ')) + + def style_named_value(self, key: str, value: str) -> str: + """ + 按字段语义为值应用样式。 + + :param key: 字段名 + :param value: 原始字段值 + :return: 样式化后的字段值 + """ + normalized_key = key.strip().lower() + normalized_value = value.strip().lower() + + if normalized_key == 'ok': + if normalized_value == 'true': + return self.style_status_token('ok', fg='green') + if normalized_value == 'false': + return self.style_status_token('fail', fg='red') + + status_kind = self._STATUS_FIELD_KIND_MAPPING.get(normalized_key) + if status_kind: + return self.style_status_message(status_kind, value) + + return self.style_inline_status_value(value) + + def style_line(self, line: str) -> str: + """ + 对单行文本输出应用可读性增强样式。 + + :param line: 原始输出行 + :return: 样式化后的输出行 + """ + if not line.strip(): + return line + + leading_spaces = len(line) - len(line.lstrip(' ')) + indent = line[:leading_spaces] + content = line[leading_spaces:] + + if content == self.build_result_header(True): + return ( + f'{indent}{self.style_status_token("ok", fg="green")} ' + f'{self.style_text("SUCCESS", fg="green", bold=True)}' + ) + if content == self.build_result_header(False): + return ( + f'{indent}{self.style_status_token("fail", fg="red")} {self.style_text("FAILED", fg="red", bold=True)}' + ) + + if content.startswith('- '): + return ( + f'{indent}{self.style_text("-", fg="bright_black", bold=True)} ' + f'{self.style_inline_status_value(content[2:])}' + ) + + if ': ' in content: + key, value = content.split(': ', 1) + styled_key = self.style_text(f'{key}:', fg='cyan', bold=leading_spaces == 0) + return f'{indent}{styled_key} {self.style_named_value(key, value)}' + + if content.endswith(':'): + return f'{indent}{self.style_text(content, fg="blue", bold=True)}' + + if content == '|': + return f'{indent}{self.style_text(content, fg="bright_black")}' + + return line + + def render_error_text(self, message: str, exit_code: int, stream: Any) -> str: + """ + 渲染标准错误输出文本。 + + :param message: 错误消息 + :param exit_code: 退出码 + :param stream: 输出流对象 + :return: 渲染后的错误文本 + """ + error_prefix = f'{self.build_status_token("error")}[{exit_code}]:' + if not self.supports_color(stream): + return f'{error_prefix} {message}' + return ( + f'{self.style_status_token("error", fg="red")}[{exit_code}]: ' + f'{self.style_text(message, fg="red", bold=True)}' + ) + + +class StructuredTextRenderer: + """ + 负责结构化数据到文本的转换与装饰。 + + :param status_styler: 状态样式器 + """ + + _SNAKE_CASE_BOUNDARY_PATTERN = re.compile(r'(? None: + """ + 初始化结构化文本渲染器。 + + :param status_styler: 状态样式器 + :return: None + """ + self.status_styler = status_styler + + def render_text_output(self, data: Any) -> str: + """ + 将任意数据渲染为纯文本输出。 + + :param data: 待渲染数据 + :return: 文本输出结果 + """ + if isinstance(data, str): + return data + return '\n'.join(self.render_text_lines(data)) + + def colorize_text_output(self, text: str, stream: Any) -> str: + """ + 按终端能力为文本输出增加颜色。 + + :param text: 原始文本输出 + :param stream: 输出流对象 + :return: 样式化后的文本输出 + """ + if not self.status_styler.supports_color(stream): + return text + return '\n'.join(self.status_styler.style_line(line) for line in text.splitlines()) + + def decorate_text_output(self, text: str) -> str: + """ + 对文本输出进行结构化装饰。 + + :param text: 原始文本输出 + :return: 装饰后的文本输出 + """ + lines = text.splitlines() + if not lines: + return text + + first_non_empty_index = next((index for index, line in enumerate(lines) if line.strip()), None) + if first_non_empty_index is None: + return text + + first_line = lines[first_non_empty_index].strip().lower() + if first_line == 'ok: true': + decorated_lines = list(lines) + decorated_lines[first_non_empty_index] = self.status_styler.build_result_header(True) + return '\n'.join(decorated_lines) + if first_line == 'ok: false': + decorated_lines = list(lines) + decorated_lines[first_non_empty_index] = self.status_styler.build_result_header(False) + return '\n'.join(decorated_lines) + return text + + @staticmethod + def format_scalar(value: Any) -> str: + """ + 将标量值格式化为文本输出。 + + :param value: 待格式化的值 + :return: 文本格式化结果 + """ + if value is None: + return 'null' + if isinstance(value, bool): + return 'true' if value else 'false' + return str(value) + + @classmethod + def format_field_name(cls, key: object) -> str: + """ + 将字段名标准化为文本输出使用的 `snake_case` 形式。 + + :param key: 原始字段名 + :return: 标准化后的字段名 + """ + text = str(key).strip() + if not text: + return '' + normalized_text = text.replace('-', '_').replace(' ', '_') + return cls._SNAKE_CASE_BOUNDARY_PATTERN.sub('_', normalized_text).lower() + + def append_multiline_text(self, lines: list[str], prefix: str, value: str, indent: str) -> None: + """ + 将多行文本追加到输出行列表中。 + + :param lines: 输出行列表 + :param prefix: 当前字段前缀 + :param value: 多行文本内容 + :param indent: 子级缩进 + :return: None + """ + lines.append(f'{prefix} |') + lines.extend(f'{indent}{line}' for line in value.splitlines()) + + def render_nested_lines(self, prefix: str, nested_data: dict[str, Any] | list[Any], indent_level: int) -> list[str]: + """ + 渲染嵌套字典或列表字段。 + + :param prefix: 当前字段前缀 + :param nested_data: 嵌套数据 + :param indent_level: 当前缩进层级 + :return: 渲染后的文本行列表 + """ + nested_lines = self.render_text_lines(nested_data, indent_level=indent_level + 1) + if len(nested_lines) == 1 and nested_lines[0].strip() in {'{}', '[]'}: + return [f'{prefix} {nested_lines[0].strip()}'] + return [prefix, *nested_lines] + + def render_mapping_lines(self, data: dict[str, Any], *, indent_level: int) -> list[str]: + """ + 将字典渲染为层级化文本输出。 + + :param data: 待渲染字典 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + indent = ' ' * indent_level + child_indent = ' ' * (indent_level + 1) + if not data: + return [f'{indent}{{}}'] + + lines: list[str] = [] + for key, value in data.items(): + field_name = self.format_field_name(key) + prefix = f'{indent}{field_name}:' + if isinstance(value, str) and '\n' in value: + self.append_multiline_text(lines, prefix, value, child_indent) + continue + if isinstance(value, dict | list): + lines.extend(self.render_nested_lines(prefix, value, indent_level)) + continue + lines.append(f'{prefix} {self.format_scalar(value)}') + return lines + + def render_list_lines(self, data: list[Any], *, indent_level: int) -> list[str]: + """ + 将列表渲染为层级化文本输出。 + + :param data: 待渲染列表 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + indent = ' ' * indent_level + child_indent = ' ' * (indent_level + 1) + if not data: + return [f'{indent}[]'] + + lines: list[str] = [] + for item in data: + item_prefix = f'{indent}-' + if isinstance(item, str) and '\n' in item: + self.append_multiline_text(lines, item_prefix, item, child_indent) + continue + if isinstance(item, dict | list): + lines.extend(self.render_nested_lines(item_prefix, item, indent_level)) + continue + lines.append(f'{item_prefix} {self.format_scalar(item)}') + return lines + + def render_text_lines(self, data: Any, *, indent_level: int = 0) -> list[str]: + """ + 将任意数据结构渲染为层级化文本输出。 + + :param data: 待渲染数据 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + if isinstance(data, dict): + return self.render_mapping_lines(data, indent_level=indent_level) + + if isinstance(data, list): + return self.render_list_lines(data, indent_level=indent_level) + + indent = ' ' * indent_level + if isinstance(data, str) and '\n' in data: + return [f'{indent}{line}' for line in data.splitlines()] + + return [f'{indent}{self.format_scalar(data)}'] + + +class OutputEmitter: + """ + 负责标准输出、标准错误与命令退出收口。 + + :param text_renderer: 结构化文本渲染器 + :param status_styler: 状态样式器 + """ + + def __init__(self, text_renderer: StructuredTextRenderer, status_styler: OutputStatusStyler) -> None: + """ + 初始化输出发射器。 + + :param text_renderer: 结构化文本渲染器 + :param status_styler: 状态样式器 + :return: None + """ + self.text_renderer = text_renderer + self.status_styler = status_styler + + def emit_output(self, data: Any, output_format: str) -> None: + """ + 输出命令结果。 + + :param data: 输出数据 + :param output_format: 输出格式 + :return: None + """ + if data is None: + return + if output_format == 'json': + print(json.dumps(data, ensure_ascii=False, indent=2, default=str)) + return + rendered_text = self.text_renderer.decorate_text_output(self.text_renderer.render_text_output(data)) + print(self.text_renderer.colorize_text_output(rendered_text, sys.stdout)) + + def emit_error(self, message: str, output_format: str, *, exit_code: int) -> None: + """ + 输出错误信息。 + + :param message: 错误消息 + :param output_format: 输出格式 + :param exit_code: 退出码 + :return: None + """ + if output_format == 'json': + print( + json.dumps({'ok': False, 'error': message, 'exitCode': exit_code}, ensure_ascii=False), + file=sys.stderr, + ) + return + print(self.status_styler.render_error_text(message, exit_code, sys.stderr), file=sys.stderr) + + def complete_command(self, result: CommandResult, ctx: CliContext) -> None: + """ + 输出命令结果并结束当前命令。 + + :param result: 命令执行结果 + :param ctx: CLI 上下文 + :return: None + :raises typer.Exit: 始终通过 Typer 退出并返回对应退出码 + """ + if not result.already_printed: + self.emit_output(result.data, ctx.output) + raise typer.Exit(code=result.exit_code) + + +class OutputRenderer: + """ + CLI 输出渲染门面。 + + :param color_mode: 颜色模式 + :param icon_mode: 图标模式 + """ + + def __init__(self, *, color_mode: str = 'always', icon_mode: str = 'emoji') -> None: + """ + 初始化输出渲染器。 + + :param color_mode: 颜色模式,支持 `auto`、`always`、`never` + :param icon_mode: 图标模式,支持 `emoji`、`ascii`、`none` + :return: None + """ + self.settings = OutputSettings(color_mode=color_mode, icon_mode=icon_mode) + self.status_styler = OutputStatusStyler(self.settings) + self.text_renderer = StructuredTextRenderer(self.status_styler) + self.emitter = OutputEmitter(self.text_renderer, self.status_styler) + + @property + def color_mode(self) -> str: + """ + 返回当前颜色模式。 + + :return: 颜色模式 + """ + return self.settings.color_mode + + @property + def icon_mode(self) -> str: + """ + 返回当前图标模式。 + + :return: 图标模式 + """ + return self.settings.icon_mode + + def set_color_mode(self, color_mode: str) -> None: + """ + 设置颜色模式。 + + :param color_mode: 颜色模式 + :return: None + """ + self.settings.color_mode = color_mode + + def set_icon_mode(self, icon_mode: str) -> None: + """ + 设置图标模式。 + + :param icon_mode: 图标模式 + :return: None + """ + self.settings.icon_mode = icon_mode + + def supports_color(self, stream: Any) -> bool: + """ + 判断当前输出流是否应启用颜色。 + + :param stream: 输出流对象 + :return: 是否启用颜色 + """ + return self.status_styler.supports_color(stream) + + @staticmethod + def style_text(text: str, *, fg: str | None = None, bold: bool = False, dim: bool = False) -> str: + """ + 为文本附加终端样式。 + + :param text: 原始文本 + :param fg: 前景色 + :param bold: 是否加粗 + :param dim: 是否弱化显示 + :return: 样式化后的文本 + """ + return OutputStatusStyler.style_text(text, fg=fg, bold=bold, dim=dim) + + def build_status_token(self, kind: str) -> str: + """ + 根据当前图标模式构建状态标签文本。 + + :param kind: 标签类型 + :return: 标签文本 + """ + return self.status_styler.build_status_token(kind) + + def style_status_token(self, kind: str, *, fg: str) -> str: + """ + 将状态标签渲染为高亮样式。 + + :param kind: 标签类型 + :param fg: 前景色 + :return: 样式化后的标签文本 + """ + return self.status_styler.style_status_token(kind, fg=fg) + + def style_status_message(self, kind: str, text: str) -> str: + """ + 使用统一状态图标和颜色渲染消息文本。 + + :param kind: 状态类型 + :param text: 原始消息文本 + :return: 样式化后的消息文本 + """ + return self.status_styler.style_status_message(kind, text) + + def build_result_header(self, is_ok: bool) -> str: + """ + 构建统一的结果头部文本。 + + :param is_ok: 是否成功 + :return: 结果头部文本 + """ + return self.status_styler.build_result_header(is_ok) + + def style_scalar_text(self, value: str) -> str: + """ + 为标量文本值应用颜色样式。 + + :param value: 原始标量文本 + :return: 样式化后的文本 + """ + return self.status_styler.style_scalar_text(value) + + def style_inline_status_segment(self, segment: str) -> str: + """ + 为行内状态片段应用样式。 + + :param segment: 原始片段文本 + :return: 样式化后的片段文本 + """ + return self.status_styler.style_inline_status_segment(segment) + + def style_inline_status_value(self, value: str) -> str: + """ + 为带分隔符的行内状态值应用样式。 + + :param value: 原始字段值 + :return: 样式化后的字段值 + """ + return self.status_styler.style_inline_status_value(value) + + def style_named_value(self, key: str, value: str) -> str: + """ + 按字段语义为值应用样式。 + + :param key: 字段名 + :param value: 原始字段值 + :return: 样式化后的字段值 + """ + return self.status_styler.style_named_value(key, value) + + def style_line(self, line: str) -> str: + """ + 对单行文本输出应用可读性增强样式。 + + :param line: 原始输出行 + :return: 样式化后的输出行 + """ + return self.status_styler.style_line(line) + + def render_text_output(self, data: Any) -> str: + """ + 将任意数据渲染为纯文本输出。 + + :param data: 待渲染数据 + :return: 文本输出结果 + """ + return self.text_renderer.render_text_output(data) + + def colorize_text_output(self, text: str, stream: Any) -> str: + """ + 按终端能力为文本输出增加颜色。 + + :param text: 原始文本输出 + :param stream: 输出流对象 + :return: 样式化后的文本输出 + """ + return self.text_renderer.colorize_text_output(text, stream) + + def decorate_text_output(self, text: str) -> str: + """ + 对文本输出进行结构化装饰。 + + :param text: 原始文本输出 + :return: 装饰后的文本输出 + """ + return self.text_renderer.decorate_text_output(text) + + @staticmethod + def format_scalar(value: Any) -> str: + """ + 将标量值格式化为文本输出。 + + :param value: 待格式化的值 + :return: 文本格式化结果 + """ + return StructuredTextRenderer.format_scalar(value) + + @staticmethod + def format_field_name(key: object) -> str: + """ + 将字段名标准化为文本输出使用的 `snake_case` 形式。 + + :param key: 原始字段名 + :return: 标准化后的字段名 + """ + return StructuredTextRenderer.format_field_name(key) + + def append_multiline_text(self, lines: list[str], prefix: str, value: str, indent: str) -> None: + """ + 将多行文本追加到输出行列表中。 + + :param lines: 输出行列表 + :param prefix: 当前字段前缀 + :param value: 多行文本内容 + :param indent: 子级缩进 + :return: None + """ + self.text_renderer.append_multiline_text(lines, prefix, value, indent) + + def render_nested_lines(self, prefix: str, nested_data: dict[str, Any] | list[Any], indent_level: int) -> list[str]: + """ + 渲染嵌套字典或列表字段。 + + :param prefix: 当前字段前缀 + :param nested_data: 嵌套数据 + :param indent_level: 当前缩进层级 + :return: 渲染后的文本行列表 + """ + return self.text_renderer.render_nested_lines(prefix, nested_data, indent_level) + + def render_mapping_lines(self, data: dict[str, Any], *, indent_level: int) -> list[str]: + """ + 将字典渲染为层级化文本输出。 + + :param data: 待渲染字典 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + return self.text_renderer.render_mapping_lines(data, indent_level=indent_level) + + def render_list_lines(self, data: list[Any], *, indent_level: int) -> list[str]: + """ + 将列表渲染为层级化文本输出。 + + :param data: 待渲染列表 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + return self.text_renderer.render_list_lines(data, indent_level=indent_level) + + def render_text_lines(self, data: Any, *, indent_level: int = 0) -> list[str]: + """ + 将任意数据结构渲染为层级化文本输出。 + + :param data: 待渲染数据 + :param indent_level: 当前缩进层级 + :return: 文本输出行列表 + """ + return self.text_renderer.render_text_lines(data, indent_level=indent_level) + + def emit_output(self, data: Any, output_format: str) -> None: + """ + 输出命令结果。 + + :param data: 输出数据 + :param output_format: 输出格式 + :return: None + """ + self.emitter.emit_output(data, output_format) + + def render_error_text(self, message: str, exit_code: int, stream: Any) -> str: + """ + 渲染标准错误输出文本。 + + :param message: 错误消息 + :param exit_code: 退出码 + :param stream: 输出流对象 + :return: 渲染后的错误文本 + """ + return self.status_styler.render_error_text(message, exit_code, stream) + + def emit_error(self, message: str, output_format: str, *, exit_code: int) -> None: + """ + 输出错误信息。 + + :param message: 错误消息 + :param output_format: 输出格式 + :param exit_code: 退出码 + :return: None + """ + self.emitter.emit_error(message, output_format, exit_code=exit_code) + + def complete_command(self, result: CommandResult, ctx: CliContext) -> None: + """ + 输出命令结果并结束当前命令。 + + :param result: 命令执行结果 + :param ctx: CLI 上下文 + :return: None + """ + self.emitter.complete_command(result, ctx) diff --git a/shierfeng-fastapi-backend/cli/runtime/__init__.py b/shierfeng-fastapi-backend/cli/runtime/__init__.py new file mode 100644 index 0000000..efb1257 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/__init__.py @@ -0,0 +1,3 @@ +from cli.runtime.base import RUNTIME_ENVIRONMENT, RuntimeEnvironmentService + +__all__ = ['RUNTIME_ENVIRONMENT', 'RuntimeEnvironmentService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/app/__init__.py b/shierfeng-fastapi-backend/cli/runtime/app/__init__.py new file mode 100644 index 0000000..47ddfc7 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/app/__init__.py @@ -0,0 +1,3 @@ +from .service import APP_RUNTIME, AppRuntimeService + +__all__ = ['APP_RUNTIME', 'AppRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/app/gateway.py b/shierfeng-fastapi-backend/cli/runtime/app/gateway.py new file mode 100644 index 0000000..2c46c3a --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/app/gateway.py @@ -0,0 +1,29 @@ +from importlib import import_module +from types import ModuleType + + +class AppInfrastructureGateway: + """ + 应用基础设施网关。 + + 该对象负责延迟加载应用实例构建和环境配置模块, + 供应用运行时 facade 与其协作对象统一复用。 + """ + + @staticmethod + def get_server_module() -> ModuleType: + """ + 获取应用 server 模块。 + + :return: server 模块 + """ + return import_module('server') + + @staticmethod + def get_env_module() -> ModuleType: + """ + 获取环境配置模块。 + + :return: 环境配置模块 + """ + return import_module('config.env') diff --git a/shierfeng-fastapi-backend/cli/runtime/app/service.py b/shierfeng-fastapi-backend/cli/runtime/app/service.py new file mode 100644 index 0000000..5cf5225 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/app/service.py @@ -0,0 +1,69 @@ +from typing import Any + +from cli.runtime.base import RUNTIME_ENVIRONMENT, RuntimeEnvironmentService + +from .gateway import AppInfrastructureGateway +from .support import AppSnapshotSupport + + +class AppRuntimeService: + """ + 应用运行时服务。 + + 该服务作为应用运行时 facade,对外统一暴露应用实例构建、 + 应用配置快照与环境信息快照入口。 + + :param runtime_environment: 运行时环境服务 + :param infrastructure_gateway: 应用基础设施网关 + :param snapshot_support: 应用快照支持对象 + """ + + def __init__( + self, + *, + runtime_environment: RuntimeEnvironmentService | None = None, + infrastructure_gateway: AppInfrastructureGateway | None = None, + snapshot_support: AppSnapshotSupport | None = None, + ) -> None: + """ + 初始化应用运行时服务。 + + :param runtime_environment: 运行时环境服务 + :param infrastructure_gateway: 应用基础设施网关 + :param snapshot_support: 应用快照支持对象 + :return: None + """ + self.runtime_environment = runtime_environment or RUNTIME_ENVIRONMENT + self.infrastructure_gateway = infrastructure_gateway or AppInfrastructureGateway() + self.snapshot_support = snapshot_support or AppSnapshotSupport( + self.infrastructure_gateway, + self.runtime_environment, + ) + + def build_app_instance(self) -> Any: + """ + 构建当前环境下的 FastAPI 应用实例。 + + :return: FastAPI 应用实例 + """ + server_module = self.infrastructure_gateway.get_server_module() + return server_module.create_app() + + def get_app_config_snapshot(self) -> dict[str, Any]: + """ + 读取当前运行环境的应用配置快照。 + + :return: 应用配置快照 + """ + return self.snapshot_support.build_app_config_snapshot() + + def get_app_env_snapshot(self) -> dict[str, Any]: + """ + 读取当前 CLI 进程的环境解析结果快照。 + + :return: 环境解析结果快照 + """ + return self.snapshot_support.build_app_env_snapshot() + + +APP_RUNTIME = AppRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/app/support.py b/shierfeng-fastapi-backend/cli/runtime/app/support.py new file mode 100644 index 0000000..169054c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/app/support.py @@ -0,0 +1,90 @@ +import os +from pathlib import Path +from typing import Any + +from cli.runtime.base import RuntimeEnvironmentService + +from .gateway import AppInfrastructureGateway + + +class AppSnapshotSupport: + """ + 应用快照支持对象。 + + 该对象负责应用配置快照和环境快照的构建, + 避免主运行时服务继续承载快照字段拼装细节。 + + :param infrastructure_gateway: 应用基础设施网关 + :param runtime_environment: 运行时环境服务 + """ + + def __init__( + self, + infrastructure_gateway: AppInfrastructureGateway, + runtime_environment: RuntimeEnvironmentService, + ) -> None: + """ + 初始化应用快照支持对象。 + + :param infrastructure_gateway: 应用基础设施网关 + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + self.runtime_environment = runtime_environment + + def build_app_config_snapshot(self) -> dict[str, Any]: + """ + 读取当前运行环境的应用配置快照。 + + :return: 应用配置快照 + """ + env_module = self.infrastructure_gateway.get_env_module() + app_config = env_module.AppConfig + database_config = env_module.DataBaseConfig + log_config = env_module.LogConfig + redis_config = env_module.RedisConfig + transport_crypto_config = env_module.TransportCryptoConfig + return { + 'env': app_config.app_env, + 'name': app_config.app_name, + 'host': app_config.app_host, + 'port': app_config.app_port, + 'rootPath': app_config.app_root_path, + 'reload': app_config.app_reload, + 'workers': app_config.app_workers, + 'disableSwagger': app_config.app_disable_swagger, + 'disableRedoc': app_config.app_disable_redoc, + 'dbType': database_config.db_type, + 'dbHost': database_config.db_host, + 'dbPort': database_config.db_port, + 'dbDatabase': database_config.db_database, + 'redisHost': redis_config.redis_host, + 'redisPort': redis_config.redis_port, + 'logLevel': log_config.loguru_level, + 'transportCryptoEnabled': transport_crypto_config.transport_crypto_enabled, + 'transportCryptoMode': transport_crypto_config.transport_crypto_mode, + } + + def build_app_env_snapshot(self) -> dict[str, Any]: + """ + 读取当前 CLI 进程的环境解析结果快照。 + + :return: 环境解析结果快照 + """ + env_module = self.infrastructure_gateway.get_env_module() + app_config = env_module.AppConfig + backend_dir = Path(self.runtime_environment.get_backend_dir()) + resolved_env = os.environ.get('APP_ENV', '') or 'dev' + env_file_name = f'.env.{resolved_env}' + env_file_path = backend_dir / env_file_name + return { + 'cliEnv': resolved_env, + 'configEnv': app_config.app_env, + 'appEnv': os.environ.get('APP_ENV', ''), + 'envFile': env_file_name, + 'envFilePath': str(env_file_path), + 'envFileExists': env_file_path.exists(), + 'backendDir': str(backend_dir), + 'pythonExecutable': self.runtime_environment.get_python_executable(), + } diff --git a/shierfeng-fastapi-backend/cli/runtime/base.py b/shierfeng-fastapi-backend/cli/runtime/base.py new file mode 100644 index 0000000..c9b37f5 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/base.py @@ -0,0 +1,72 @@ +import getpass +import os +import sys +from pathlib import Path + + +class RuntimeEnvironmentService: + """ + CLI 运行时环境服务。 + + 该服务集中管理后端根目录解析、Python 解释器定位等稳定运行时能力, + 避免调用方继续依赖零散模块级函数。 + """ + + @staticmethod + def is_backend_project_dir(project_dir: Path) -> bool: + """ + 判断目录是否为后端项目根目录。 + + :param project_dir: 待检查目录 + :return: 是否为后端项目根目录 + """ + return ( + (project_dir / 'app.py').exists() + and (project_dir / 'config' / 'env.py').exists() + and (project_dir / 'cli').is_dir() + ) + + def get_backend_dir(self) -> str: + """ + 获取后端根目录绝对路径。 + + :return: 后端根目录绝对路径 + """ + current_dir = Path.cwd().resolve() + if self.is_backend_project_dir(current_dir): + return str(current_dir) + return os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + @staticmethod + def get_python_executable() -> str: + """ + 获取当前 CLI 进程使用的 Python 解释器。 + + :return: Python 解释器路径或命令名 + """ + return sys.executable or 'python' + + +class RuntimeOperatorService: + """ + CLI 运行时操作者解析服务。 + + 该服务集中提供当前 CLI 进程的操作者名称解析能力, + 避免各领域运行时对象继续复制相同的 `getpass.getuser()` 回退逻辑。 + """ + + @staticmethod + def resolve_operator() -> str: + """ + 解析当前 CLI 操作者名称。 + + :return: 操作者名称 + """ + try: + return getpass.getuser() or 'shierfeng-cli' + except Exception: + return 'shierfeng-cli' + + +RUNTIME_ENVIRONMENT = RuntimeEnvironmentService() +RUNTIME_OPERATOR = RuntimeOperatorService() diff --git a/shierfeng-fastapi-backend/cli/runtime/cache/__init__.py b/shierfeng-fastapi-backend/cli/runtime/cache/__init__.py new file mode 100644 index 0000000..2b6dbb9 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/cache/__init__.py @@ -0,0 +1,3 @@ +from .service import CACHE_RUNTIME, CacheRuntimeService + +__all__ = ['CACHE_RUNTIME', 'CacheRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/cache/gateway.py b/shierfeng-fastapi-backend/cli/runtime/cache/gateway.py new file mode 100644 index 0000000..9dd40a1 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/cache/gateway.py @@ -0,0 +1,41 @@ +from importlib import import_module +from typing import Any + +REDIS_TTL_KEY_NOT_FOUND = -2 +REDIS_TTL_PERSISTENT = -1 + + +class CacheInfrastructureGateway: + """ + 缓存基础设施网关。 + + 该对象负责延迟加载 Redis 相关基础设施依赖, + 供缓存运行时 facade 和其协作对象统一复用。 + """ + + @staticmethod + def get_redis_error_class() -> type[Exception]: + """ + 获取 Redis 异常类型。 + + :return: Redis 异常类型 + """ + return import_module('redis.exceptions').RedisError + + @staticmethod + def get_redis_init_key_config() -> Any: + """ + 获取系统缓存初始化键枚举。 + + :return: 缓存初始化键枚举 + """ + return import_module('common.enums').RedisInitKeyConfig + + @staticmethod + def get_redis_util() -> Any: + """ + 获取 Redis 工具类。 + + :return: Redis 工具类 + """ + return import_module('config.get_redis').RedisUtil diff --git a/shierfeng-fastapi-backend/cli/runtime/cache/service.py b/shierfeng-fastapi-backend/cli/runtime/cache/service.py new file mode 100644 index 0000000..b6a9cf7 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/cache/service.py @@ -0,0 +1,216 @@ +from typing import Any + +from cli.exit_codes import RUNTIME_ERROR + +from .gateway import REDIS_TTL_KEY_NOT_FOUND, REDIS_TTL_PERSISTENT, CacheInfrastructureGateway +from .support import CacheDomainSupport, CacheRedisSupport + + +class CacheRuntimeService: + """ + 缓存运行时服务。 + + 该服务作为缓存运行时 facade,对外统一暴露缓存统计、键列表、键值、 + TTL 读取,以及缓存清理和预热入口。 + + :param infrastructure_gateway: 缓存基础设施网关 + :param domain_support: 缓存领域支持对象 + :param redis_support: 缓存 Redis 访问支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: CacheInfrastructureGateway | None = None, + domain_support: CacheDomainSupport | None = None, + redis_support: CacheRedisSupport | None = None, + ) -> None: + """ + 初始化缓存运行时服务。 + + :param infrastructure_gateway: 缓存基础设施网关 + :param domain_support: 缓存领域支持对象 + :param redis_support: 缓存 Redis 访问支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or CacheInfrastructureGateway() + self.domain_support = domain_support or CacheDomainSupport(self.infrastructure_gateway) + self.redis_support = redis_support or CacheRedisSupport(self.infrastructure_gateway, self.domain_support) + + async def get_cache_stats(self) -> dict[str, Any]: + """ + 获取缓存统计信息。 + + :return: 缓存统计结果 + """ + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with self.redis_support.redis_session() as (redis, _redis_util): + info = await redis.info() + db_size = await redis.dbsize() + command_stats_dict = await redis.info('commandstats') + command_stats = [ + {'name': key.split('_', 1)[1], 'value': int(value.get('calls', 0))} + for key, value in sorted(command_stats_dict.items(), key=lambda item: item[0]) + ] + return { + 'ok': True, + 'dbSize': db_size, + 'commandStats': command_stats, + 'cacheNames': self.domain_support.build_cache_name_items(), + 'info': info, + } + except redis_error as exc: + return self.redis_support.build_redis_error_result('读取缓存统计失败', exc) + + async def list_cache_keys(self, cache_name: str) -> dict[str, Any]: + """ + 列出指定缓存名称下的键名。 + + :param cache_name: 缓存名称 + :return: 缓存键名列表结果 + """ + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with self.redis_support.redis_session() as (redis, _redis_util): + cache_keys: list[str] = await redis.keys(self.redis_support.build_cache_name_keys_pattern(cache_name)) + key_items = self.domain_support.extract_cache_key_items(cache_name, cache_keys) + return {'ok': True, 'cacheName': cache_name, 'count': len(key_items), 'keys': key_items} + except redis_error as exc: + return self.redis_support.build_redis_error_result('读取缓存键名失败', exc) + + async def get_cache_value(self, cache_name: str, cache_key: str) -> dict[str, Any]: + """ + 读取指定缓存键值。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :return: 缓存值结果 + """ + redis_error = self.infrastructure_gateway.get_redis_error_class() + full_cache_key = self.domain_support.build_full_cache_key(cache_name, cache_key) + try: + async with self.redis_support.redis_session() as (redis, _redis_util): + cache_value = await redis.get(full_cache_key) + if cache_value is None: + return self.domain_support.build_missing_cache_result(cache_name, cache_key) + return { + 'ok': True, + 'cacheName': cache_name, + 'cacheKey': cache_key, + 'fullCacheKey': full_cache_key, + 'cacheValue': cache_value, + } + except redis_error as exc: + return self.redis_support.build_redis_error_result('读取缓存内容失败', exc) + + async def get_cache_ttl(self, cache_name: str, cache_key: str) -> dict[str, Any]: + """ + 读取指定缓存键的剩余过期时间。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :return: 缓存 TTL 结果 + """ + redis_error = self.infrastructure_gateway.get_redis_error_class() + full_cache_key = self.domain_support.build_full_cache_key(cache_name, cache_key) + try: + async with self.redis_support.redis_session() as (redis, _redis_util): + ttl_seconds = await redis.ttl(full_cache_key) + if ttl_seconds == REDIS_TTL_KEY_NOT_FOUND: + return self.domain_support.build_missing_cache_result(cache_name, cache_key) + return { + 'ok': True, + 'message': '缓存剩余过期时间读取成功' if ttl_seconds >= 0 else '缓存存在且未设置过期时间', + 'cacheName': cache_name, + 'cacheKey': cache_key, + 'fullCacheKey': full_cache_key, + 'ttlSeconds': ttl_seconds, + 'persistent': ttl_seconds == REDIS_TTL_PERSISTENT, + 'expires': ttl_seconds >= 0, + } + except redis_error as exc: + return self.redis_support.build_redis_error_result('读取缓存剩余过期时间失败', exc) + + async def clear_cache( + self, + *, + cache_name: str = '', + cache_key: str = '', + clear_all: bool = False, + dry_run: bool = False, + ) -> dict[str, Any]: + """ + 清理缓存。 + + :param cache_name: 需要按缓存名称清理的前缀 + :param cache_key: 需要按缓存键名模糊清理的键 + :param clear_all: 是否清理全部缓存 + :param dry_run: 是否仅演练执行 + :return: 缓存清理结果 + """ + selected_modes = [bool(cache_name), bool(cache_key), clear_all] + if sum(selected_modes) != 1: + return { + 'ok': False, + 'message': '必须且只能指定一种清理方式:--cache-name、--cache-key 或 --all', + 'exit_code': RUNTIME_ERROR, + } + + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with self.redis_support.redis_session() as (redis, redis_util): + target_pattern = self.redis_support.build_clear_target_pattern( + cache_name=cache_name, + cache_key=cache_key, + clear_all=clear_all, + ) + if target_pattern is None: + target_keys = sorted(await redis.keys()) + else: + target_keys = sorted(await redis.keys(target_pattern)) + + result = { + 'ok': True, + 'dryRun': dry_run, + 'matchedCount': len(target_keys), + 'matchedKeys': target_keys, + 'scope': self.domain_support.build_clear_scope( + cache_name=cache_name, + cache_key=cache_key, + clear_all=clear_all, + ), + } + if dry_run: + result['message'] = '缓存清理演练完成,未执行实际删除' + return result + + if target_keys: + await redis.delete(*target_keys) + + if clear_all: + await redis_util.init_sys_dict(redis) + await redis_util.init_sys_config(redis) + + result['message'] = '缓存清理完成' + return result + except redis_error as exc: + return self.redis_support.build_redis_error_result('清理缓存失败', exc) + + async def warmup_cache(self) -> dict[str, Any]: + """ + 预热系统缓存。 + + :return: 缓存预热执行结果 + """ + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with self.redis_support.redis_session() as (redis, redis_util): + await redis_util.init_sys_dict(redis) + await redis_util.init_sys_config(redis) + return {'ok': True, 'message': '缓存预热完成'} + except redis_error as exc: + return self.redis_support.build_redis_error_result('缓存预热失败', exc) + + +CACHE_RUNTIME = CacheRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/cache/support.py b/shierfeng-fastapi-backend/cli/runtime/cache/support.py new file mode 100644 index 0000000..72db4df --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/cache/support.py @@ -0,0 +1,201 @@ +from contextlib import asynccontextmanager +from typing import Any + +from cli.exit_codes import REDIS_ERROR, RUNTIME_ERROR + +from .gateway import CacheInfrastructureGateway + + +class CacheDomainSupport: + """ + 缓存领域支持对象。 + + 该对象负责缓存名称列表构建、键范围解析和 TTL 结果判定等 + 局部缓存规则,避免主运行时服务继续承载细碎领域判断。 + + :param infrastructure_gateway: 缓存基础设施网关 + """ + + def __init__(self, infrastructure_gateway: CacheInfrastructureGateway) -> None: + """ + 初始化缓存领域支持对象。 + + :param infrastructure_gateway: 缓存基础设施网关 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + + def build_cache_name_items(self) -> list[dict[str, Any]]: + """ + 构建系统内置缓存名称列表。 + + :return: 缓存名称列表 + """ + redis_init_key_config = self.infrastructure_gateway.get_redis_init_key_config() + return [ + { + 'cacheName': key_config.key, + 'remark': key_config.remark, + } + for key_config in redis_init_key_config + ] + + @staticmethod + def build_full_cache_key(cache_name: str, cache_key: str) -> str: + """ + 构建缓存完整键名。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :return: 完整缓存键名 + """ + return f'{cache_name}:{cache_key}' + + def build_missing_cache_result(self, cache_name: str, cache_key: str) -> dict[str, Any]: + """ + 构建缓存不存在的统一结果。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :return: 缓存不存在结果 + """ + full_cache_key = self.build_full_cache_key(cache_name, cache_key) + return { + 'ok': False, + 'message': f'缓存不存在:{full_cache_key}', + 'cacheName': cache_name, + 'cacheKey': cache_key, + 'fullCacheKey': full_cache_key, + 'exit_code': RUNTIME_ERROR, + } + + @staticmethod + def build_cache_name_pattern(cache_name: str) -> str: + """ + 构建按缓存名称扫描时使用的 Redis 键模式。 + + :param cache_name: 缓存名称 + :return: Redis 键匹配模式 + """ + return f'{cache_name}:*' + + @staticmethod + def extract_cache_key_items(cache_name: str, cache_keys: list[str]) -> list[str]: + """ + 从缓存完整键名列表中提取相对键名。 + + :param cache_name: 缓存名称 + :param cache_keys: 完整缓存键名列表 + :return: 相对键名列表 + """ + return [key.split(':', 1)[1] for key in sorted(cache_keys) if key.startswith(f'{cache_name}:')] + + @staticmethod + def build_clear_scope( + *, + cache_name: str, + cache_key: str, + clear_all: bool, + ) -> dict[str, str]: + """ + 构建缓存清理范围定义。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名片段 + :param clear_all: 是否清理全部缓存 + :return: 清理范围定义 + """ + if clear_all: + return {'mode': 'all'} + if cache_name: + return {'mode': 'cacheName', 'cacheName': cache_name} + return {'mode': 'cacheKey', 'cacheKey': cache_key} + + +class CacheRedisSupport: + """ + 缓存 Redis 访问支持对象。 + + 该对象负责 Redis 连接生命周期、错误结果规整和缓存键模式拼装, + 避免主运行时服务继续承载基础设施桥接细节。 + + :param infrastructure_gateway: 缓存基础设施网关 + :param domain_support: 缓存领域支持对象 + """ + + def __init__( + self, + infrastructure_gateway: CacheInfrastructureGateway, + domain_support: CacheDomainSupport, + ) -> None: + """ + 初始化缓存 Redis 访问支持对象。 + + :param infrastructure_gateway: 缓存基础设施网关 + :param domain_support: 缓存领域支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + self.domain_support = domain_support + + @asynccontextmanager + async def redis_session(self) -> Any: + """ + 创建并托管 Redis 会话。 + + :return: `(redis, redis_util)` 元组 + """ + redis = None + redis_util = self.infrastructure_gateway.get_redis_util() + try: + redis = await redis_util.create_redis_pool(log_enabled=False) + yield redis, redis_util + finally: + if redis is not None: + await redis.close() + + @staticmethod + def build_redis_error_result(message: str, exc: Exception) -> dict[str, Any]: + """ + 构建统一 Redis 异常结果。 + + :param message: 失败消息 + :param exc: 原始异常 + :return: 标准失败结果 + """ + return { + 'ok': False, + 'message': message, + 'error': str(exc), + 'exit_code': REDIS_ERROR, + } + + def build_cache_name_keys_pattern(self, cache_name: str) -> str: + """ + 构建按缓存名称读取键列表时使用的模式。 + + :param cache_name: 缓存名称 + :return: Redis 键匹配模式 + """ + return self.domain_support.build_cache_name_pattern(cache_name) + + def build_clear_target_pattern( + self, + *, + cache_name: str, + cache_key: str, + clear_all: bool, + ) -> str | None: + """ + 构建缓存清理目标的 Redis 键匹配模式。 + + :param cache_name: 缓存名称 + :param cache_key: 缓存键名片段 + :param clear_all: 是否清理全部缓存 + :return: Redis 键匹配模式;全部清理时返回 `None` + """ + if clear_all: + return None + if cache_name: + return self.domain_support.build_cache_name_pattern(cache_name) + return f'*{cache_key}' diff --git a/shierfeng-fastapi-backend/cli/runtime/config/__init__.py b/shierfeng-fastapi-backend/cli/runtime/config/__init__.py new file mode 100644 index 0000000..3f60116 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/config/__init__.py @@ -0,0 +1,3 @@ +from .service import CONFIG_RUNTIME, ConfigRuntimeService + +__all__ = ['CONFIG_RUNTIME', 'ConfigRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/config/gateway.py b/shierfeng-fastapi-backend/cli/runtime/config/gateway.py new file mode 100644 index 0000000..bd4eb6c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/config/gateway.py @@ -0,0 +1,101 @@ +from importlib import import_module +from typing import Any + + +class ConfigInfrastructureGateway: + """ + 参数配置基础设施网关。 + + 该对象负责延迟加载数据库会话、Redis、DAO、Service 与脱敏工具依赖, + 供参数配置运行时 facade 和其协作对象统一复用。 + """ + + @staticmethod + def get_redis_error_class() -> type[Exception]: + """ + 获取 Redis 异常类型。 + + :return: Redis 异常类型 + """ + return import_module('redis.exceptions').RedisError + + @staticmethod + def get_common_constant() -> Any: + """ + 获取公共常量定义。 + + :return: 公共常量定义模块 + """ + return import_module('common.constant').CommonConstant + + @staticmethod + def get_redis_init_key_config() -> Any: + """ + 获取 Redis 初始化键枚举。 + + :return: Redis 初始化键枚举 + """ + return import_module('common.enums').RedisInitKeyConfig + + @staticmethod + def get_page_model() -> Any: + """ + 获取分页模型类型。 + + :return: 分页模型类型 + """ + return import_module('common.vo').PageModel + + @staticmethod + def get_async_session_local() -> Any: + """ + 获取异步数据库会话工厂。 + + :return: 异步数据库会话工厂 + """ + return import_module('config.database').AsyncSessionLocal + + @staticmethod + def get_redis_util() -> Any: + """ + 获取 Redis 工具类。 + + :return: Redis 工具类 + """ + return import_module('config.get_redis').RedisUtil + + @staticmethod + def get_config_dao() -> Any: + """ + 获取参数配置 DAO。 + + :return: 参数配置 DAO + """ + return import_module('module_admin.dao.config_dao').ConfigDao + + @staticmethod + def get_config_vo_module() -> Any: + """ + 获取参数配置 VO 模块。 + + :return: 参数配置 VO 模块 + """ + return import_module('module_admin.entity.vo.config_vo') + + @staticmethod + def get_config_service() -> Any: + """ + 获取参数配置服务类。 + + :return: 参数配置服务类 + """ + return import_module('module_admin.service.config_service').ConfigService + + @staticmethod + def get_log_sanitizer() -> Any: + """ + 获取日志脱敏工具类。 + + :return: 日志脱敏工具类 + """ + return import_module('utils.log_util').LogSanitizer diff --git a/shierfeng-fastapi-backend/cli/runtime/config/service.py b/shierfeng-fastapi-backend/cli/runtime/config/service.py new file mode 100644 index 0000000..af5331a --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/config/service.py @@ -0,0 +1,406 @@ +from typing import Any, Literal + +from cli.exit_codes import ARGUMENT_ERROR, DATABASE_ERROR, REDIS_ERROR + +from .gateway import ConfigInfrastructureGateway +from .support import ConfigDomainSupport + + +class ConfigRuntimeService: + """ + 参数配置运行时服务。 + + 该服务作为参数配置运行时 facade,对外统一暴露参数配置列表、详情、 + 写入、缓存刷新与一致性诊断入口。 + + :param infrastructure_gateway: 参数配置基础设施网关 + :param domain_support: 参数配置领域支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: ConfigInfrastructureGateway | None = None, + domain_support: ConfigDomainSupport | None = None, + ) -> None: + """ + 初始化参数配置运行时服务。 + + :param infrastructure_gateway: 参数配置基础设施网关 + :param domain_support: 参数配置领域支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or ConfigInfrastructureGateway() + self.domain_support = domain_support or ConfigDomainSupport(self.infrastructure_gateway) + + @staticmethod + def build_cli_config_model(config_vo_module: Any, config_record: Any) -> Any | None: + """ + 将 ORM 配置记录显式转换为 CLI 可用的配置模型。 + + `ConfigModel` 当前未统一开启 `populate_by_name`,因此 CLI 侧在处理 + ORM 蛇形字段对象时,需要主动映射为驼峰 alias 输入,避免详情查询结果 + 被静默序列化为空。 + + :param config_vo_module: 配置 VO 模块 + :param config_record: ORM 配置记录 + :return: CLI 可用配置模型 + """ + if config_record is None: + return None + return config_vo_module.ConfigModel( + configId=getattr(config_record, 'config_id', None), + configName=getattr(config_record, 'config_name', None), + configKey=getattr(config_record, 'config_key', None), + configValue=getattr(config_record, 'config_value', None), + configType=getattr(config_record, 'config_type', None), + createBy=getattr(config_record, 'create_by', None), + createTime=getattr(config_record, 'create_time', None), + updateBy=getattr(config_record, 'update_by', None), + updateTime=getattr(config_record, 'update_time', None), + remark=getattr(config_record, 'remark', None), + ) + + async def load_config_from_database( + self, + config_key: str, + ) -> tuple[Any | None, dict[str, Any] | None] | dict[str, Any]: + """ + 从数据库加载参数配置。 + + :param config_key: 参数键名 + :return: 成功时返回配置模型与序列化结果,失败时返回错误结果字典 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + config_dao = self.infrastructure_gateway.get_config_dao() + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + try: + async with async_session_local() as session: + config_record = await config_dao.get_config_detail_by_info( + session, + config_vo_module.ConfigModel(configKey=config_key), + ) + except Exception as exc: + return {'ok': False, 'message': '读取参数配置失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + database_model = self.build_cli_config_model(config_vo_module, config_record) + return database_model, self.domain_support.serialize_config_model(database_model) + + async def load_config_from_cache( + self, + config_key: str, + ) -> tuple[str | None, dict[str, Any] | None] | dict[str, Any]: + """ + 从缓存加载参数配置。 + + :param config_key: 参数键名 + :return: 成功时返回原始缓存值与序列化结果,失败时返回错误结果字典 + """ + redis = None + redis_util = self.infrastructure_gateway.get_redis_util() + config_service = self.infrastructure_gateway.get_config_service() + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + redis = await redis_util.create_redis_pool(log_enabled=False) + cache_value = await config_service.query_config_list_from_cache_services(redis, config_key) + return cache_value, self.domain_support.serialize_cache_payload(config_key, cache_value) + except redis_error as exc: + return {'ok': False, 'message': '读取参数缓存失败', 'error': str(exc), 'exit_code': REDIS_ERROR} + finally: + if redis is not None: + await redis.close() + + async def list_configs( + self, + config_name: str = '', + config_key: str = '', + config_type: Literal['Y', 'N'] | None = None, + begin_date: str = '', + end_date: str = '', + *, + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 查询参数配置列表。 + + :param config_name: 参数名称过滤条件 + :param config_key: 参数键名过滤条件 + :param config_type: 参数类型过滤条件 + :param begin_date: 开始日期 + :param end_date: 结束日期 + :param paged: 是否开启分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: CLI 标准结果字典 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + config_service = self.infrastructure_gateway.get_config_service() + query_model = self.domain_support.build_config_query( + config_name, + config_key, + config_type, + begin_date, + end_date, + page_num, + page_size, + ) + try: + async with async_session_local() as session: + result = await config_service.get_config_list_services(session, query_model, is_page=paged) + except Exception as exc: + return {'ok': False, 'message': '读取参数配置列表失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + filters = self.domain_support.build_list_filters( + config_name=config_name, + config_key=config_key, + config_type=config_type, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + if paged and isinstance(result, self.infrastructure_gateway.get_page_model()): + page_payload = result.model_dump(by_alias=True) + page_payload['rows'] = [ + self.domain_support.sanitize_config_mapping(item) for item in page_payload.get('rows', []) + ] + return {'ok': True, 'filters': filters, 'page': page_payload} + + items = [self.domain_support.sanitize_config_mapping(item) for item in result] + return {'ok': True, 'filters': filters, 'count': len(items), 'items': items} + + async def get_config( + self, + config_key: str, + *, + source: Literal['db', 'cache', 'both'] = 'both', + ) -> dict[str, Any]: + """ + 按参数键读取配置详情。 + + :param config_key: 参数键名 + :param source: 读取来源 + :return: CLI 标准结果字典 + """ + database_model: Any | None = None + database_payload: dict[str, Any] | None = None + cache_value: str | None = None + cache_payload: dict[str, Any] | None = None + + if source in {'db', 'both'}: + database_result = await self.load_config_from_database(config_key) + if isinstance(database_result, dict): + return database_result + database_model, database_payload = database_result + + if source in {'cache', 'both'}: + cache_result = await self.load_config_from_cache(config_key) + if isinstance(cache_result, dict): + error_payload = {**cache_result, 'source': source} + if database_payload is not None: + error_payload['database'] = database_payload + return error_payload + cache_value, cache_payload = cache_result + + if source == 'db' and database_payload is None: + return self.domain_support.build_missing_config_result(config_key, source) + if source == 'cache' and cache_payload is None: + return self.domain_support.build_missing_config_result(config_key, source) + if source == 'both' and database_payload is None and cache_payload is None: + return self.domain_support.build_missing_config_result(config_key, source) + + payload = {'ok': True, 'key': config_key, 'source': source} + if source in {'db', 'both'}: + payload['database'] = database_payload + if source in {'cache', 'both'}: + payload['cache'] = cache_payload + if source == 'both': + payload['inSync'] = (database_model.config_value if database_model else None) == cache_value + return payload + + async def set_config( + self, + config_key: str, + config_value: str, + *, + config_name: str | None = None, + config_type: Literal['Y', 'N'] | None = None, + remark: str | None = None, + dry_run: bool = False, + ) -> dict[str, Any]: + """ + 新增或更新参数配置,并同步缓存。 + + :param config_key: 参数键名 + :param config_value: 参数键值 + :param config_name: 参数名称 + :param config_type: 参数类型 + :param remark: 备注 + :param dry_run: 是否仅执行演练 + :return: CLI 标准结果字典 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + config_dao = self.infrastructure_gateway.get_config_dao() + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + redis_util = self.infrastructure_gateway.get_redis_util() + redis_init_key_config = self.infrastructure_gateway.get_redis_init_key_config() + redis_error = self.infrastructure_gateway.get_redis_error_class() + existing_config = None + target_config = None + try: + async with async_session_local() as session: + config_record = await config_dao.get_config_detail_by_info( + session, + config_vo_module.ConfigModel(configKey=config_key), + ) + existing_config = self.build_cli_config_model(config_vo_module, config_record) + if existing_config is None and not config_name: + return { + 'ok': False, + 'message': '新增参数配置时必须传入 --name', + 'exit_code': ARGUMENT_ERROR, + } + + target_config = self.domain_support.build_target_config_model( + config_key, + config_value, + config_name, + config_type, + remark, + existing_config, + ) + if dry_run: + return { + 'ok': True, + 'message': '参数配置演练完成,未执行实际写入', + 'dryRun': True, + 'action': 'update' if existing_config else 'create', + 'config': self.domain_support.serialize_config_model(target_config), + } + + if existing_config: + await config_dao.edit_config_dao(session, target_config.model_dump(exclude_none=True)) + else: + await config_dao.add_config_dao(session, target_config) + await session.commit() + except Exception as exc: + return {'ok': False, 'message': '写入参数配置失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + redis = None + try: + redis = await redis_util.create_redis_pool(log_enabled=False) + await redis.set(f'{redis_init_key_config.SYS_CONFIG.key}:{config_key}', config_value) + except redis_error as exc: + return { + 'ok': False, + 'message': '参数配置已写入数据库,但同步缓存失败', + 'error': str(exc), + 'config': self.domain_support.serialize_config_model(target_config), + 'databaseCommitted': True, + 'exit_code': REDIS_ERROR, + } + finally: + if redis is not None: + await redis.close() + + return { + 'ok': True, + 'message': '参数配置已同步到数据库和缓存', + 'action': 'update' if existing_config else 'create', + 'config': self.domain_support.serialize_config_model(target_config), + } + + async def sync_config_cache(self) -> dict[str, Any]: + """ + 刷新参数配置缓存。 + + :return: CLI 标准结果字典 + """ + redis = None + async_session_local = self.infrastructure_gateway.get_async_session_local() + config_service = self.infrastructure_gateway.get_config_service() + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + redis_util = self.infrastructure_gateway.get_redis_util() + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with async_session_local() as session: + config_list = await config_service.get_config_list_services( + session, + config_vo_module.ConfigPageQueryModel(), + is_page=False, + ) + redis = await redis_util.create_redis_pool(log_enabled=False) + await config_service.init_cache_sys_config_services(session, redis) + except redis_error as exc: + return {'ok': False, 'message': '刷新参数缓存失败', 'error': str(exc), 'exit_code': REDIS_ERROR} + except Exception as exc: + return {'ok': False, 'message': '刷新参数缓存失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + finally: + if redis is not None: + await redis.close() + + return {'ok': True, 'message': '参数缓存刷新成功', 'count': len(config_list)} + + async def diagnose_config(self, *, sample_limit: int = 10) -> dict[str, Any]: + """ + 诊断数据库参数配置与 Redis 缓存的一致性状态。 + + :param sample_limit: 示例键名输出上限 + :return: CLI 标准结果字典 + """ + redis = None + async_session_local = self.infrastructure_gateway.get_async_session_local() + config_service = self.infrastructure_gateway.get_config_service() + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + redis_util = self.infrastructure_gateway.get_redis_util() + redis_init_key_config = self.infrastructure_gateway.get_redis_init_key_config() + redis_error = self.infrastructure_gateway.get_redis_error_class() + try: + async with async_session_local() as session: + config_list = await config_service.get_config_list_services( + session, + config_vo_module.ConfigPageQueryModel(), + is_page=False, + ) + redis = await redis_util.create_redis_pool(log_enabled=False) + cache_prefix = f'{redis_init_key_config.SYS_CONFIG.key}:' + cache_keys = sorted(await redis.keys(f'{cache_prefix}*')) + cache_values = await redis.mget(*cache_keys) if cache_keys else [] + except redis_error as exc: + return {'ok': False, 'message': '读取参数缓存诊断信息失败', 'error': str(exc), 'exit_code': REDIS_ERROR} + except Exception as exc: + return {'ok': False, 'message': '读取参数配置诊断信息失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + finally: + if redis is not None: + await redis.close() + + database_map = {str(item.get('configKey')): str(item.get('configValue', '')) for item in config_list} + cache_map = { + cache_key.replace(cache_prefix, '', 1): '' if cache_value is None else str(cache_value) + for cache_key, cache_value in zip(cache_keys, cache_values, strict=False) + } + missing_in_cache = sorted(key for key in database_map if key not in cache_map) + orphan_in_cache = sorted(key for key in cache_map if key not in database_map) + mismatch_keys = sorted( + key for key, database_value in database_map.items() if key in cache_map and database_value != cache_map[key] + ) + in_sync = not missing_in_cache and not orphan_in_cache and not mismatch_keys + return { + 'ok': in_sync, + 'message': '参数配置数据库与缓存一致' if in_sync else '参数配置存在数据库与缓存不一致项', + 'databaseCount': len(database_map), + 'cacheCount': len(cache_map), + 'missingInCacheCount': len(missing_in_cache), + 'orphanInCacheCount': len(orphan_in_cache), + 'mismatchCount': len(mismatch_keys), + 'sampleLimit': sample_limit, + 'missingInCache': missing_in_cache[:sample_limit], + 'orphanInCache': orphan_in_cache[:sample_limit], + 'mismatchKeys': mismatch_keys[:sample_limit], + } + + +CONFIG_RUNTIME = ConfigRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/config/support.py b/shierfeng-fastapi-backend/cli/runtime/config/support.py new file mode 100644 index 0000000..268b1fd --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/config/support.py @@ -0,0 +1,191 @@ +from datetime import datetime +from typing import Any, Literal + +from cli.exit_codes import RUNTIME_ERROR +from cli.runtime.base import RUNTIME_OPERATOR, RuntimeOperatorService + +from .gateway import ConfigInfrastructureGateway + + +class ConfigDomainSupport: + """ + 参数配置领域支持对象。 + + 该对象负责操作者解析、配置脱敏、序列化、查询模型构建与缺失结果构建, + 避免主运行时服务继续承载大量领域规则。 + + :param infrastructure_gateway: 参数配置基础设施网关 + """ + + def __init__( + self, + infrastructure_gateway: ConfigInfrastructureGateway, + operator_service: RuntimeOperatorService = RUNTIME_OPERATOR, + ) -> None: + """ + 初始化参数配置领域支持对象。 + + :param infrastructure_gateway: 参数配置基础设施网关 + :param operator_service: 运行时操作者解析服务 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + self.operator_service = operator_service + + def sanitize_config_mapping(self, config_mapping: dict[str, Any]) -> dict[str, Any]: + """ + 对配置字典进行脱敏处理。 + + :param config_mapping: 原始配置字典 + :return: 脱敏后的配置字典 + """ + return self.infrastructure_gateway.get_log_sanitizer().sanitize_data(config_mapping) + + def serialize_config_model(self, config_model: Any | None) -> dict[str, Any] | None: + """ + 将配置模型序列化为 CLI 输出字典。 + + :param config_model: 配置模型对象 + :return: 序列化后的配置字典 + """ + if config_model is None or config_model.config_id is None: + return None + return self.sanitize_config_mapping(config_model.model_dump(by_alias=True, exclude_none=True)) + + def serialize_cache_payload(self, config_key: str, config_value: str | None) -> dict[str, Any] | None: + """ + 将缓存中的配置值序列化为 CLI 输出字典。 + + :param config_key: 参数键名 + :param config_value: 参数键值 + :return: 序列化后的缓存配置字典 + """ + if config_value is None: + return None + return self.sanitize_config_mapping({'configKey': config_key, 'configValue': config_value}) + + @staticmethod + def build_missing_config_result( + config_key: str, + source: Literal['db', 'cache', 'both'], + ) -> dict[str, Any]: + """ + 构建配置不存在的统一结果。 + + :param config_key: 参数键名 + :param source: 读取来源 + :return: 配置不存在的结果字典 + """ + message = f'参数缓存不存在:{config_key}' if source == 'cache' else f'参数配置不存在:{config_key}' + return {'ok': False, 'message': message, 'source': source, 'exit_code': RUNTIME_ERROR} + + def build_config_query( + self, + config_name: str, + config_key: str, + config_type: Literal['Y', 'N'] | None, + begin_date: str, + end_date: str, + page_num: int, + page_size: int, + ) -> Any: + """ + 构建配置列表查询对象。 + + :param config_name: 参数名称过滤条件 + :param config_key: 参数键名过滤条件 + :param config_type: 参数类型过滤条件 + :param begin_date: 开始日期 + :param end_date: 结束日期 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 配置分页查询模型 + """ + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + return config_vo_module.ConfigPageQueryModel( + configName=config_name or None, + configKey=config_key or None, + configType=config_type, + beginTime=begin_date or None, + endTime=end_date or None, + pageNum=page_num, + pageSize=page_size, + ) + + def build_target_config_model( + self, + config_key: str, + config_value: str, + config_name: str | None, + config_type: Literal['Y', 'N'] | None, + remark: str | None, + existing_config: Any | None, + ) -> Any: + """ + 基于当前状态构建目标配置模型。 + + :param config_key: 参数键名 + :param config_value: 参数键值 + :param config_name: 参数名称 + :param config_type: 参数类型 + :param remark: 参数备注 + :param existing_config: 已存在的配置模型 + :return: 目标配置模型 + """ + operator = self.operator_service.resolve_operator() + current_time = datetime.now() + common_constant = self.infrastructure_gateway.get_common_constant() + config_vo_module = self.infrastructure_gateway.get_config_vo_module() + default_config_type = existing_config.config_type if existing_config else common_constant.NO + target_config = config_vo_module.ConfigModel( + configId=existing_config.config_id if existing_config else None, + configName=config_name + if config_name is not None + else (existing_config.config_name if existing_config else None), + configKey=config_key, + configValue=config_value, + configType=config_type if config_type is not None else default_config_type, + createBy=existing_config.create_by if existing_config else operator, + createTime=existing_config.create_time if existing_config else current_time, + updateBy=operator, + updateTime=current_time, + remark=remark if remark is not None else (existing_config.remark if existing_config else None), + ) + target_config.validate_fields() + return target_config + + def build_list_filters( + self, + *, + config_name: str, + config_key: str, + config_type: Literal['Y', 'N'] | None, + begin_date: str, + end_date: str, + paged: bool, + page_num: int, + page_size: int, + ) -> dict[str, Any]: + """ + 构建配置列表过滤条件。 + + :param config_name: 参数名称 + :param config_key: 参数键名 + :param config_type: 参数类型 + :param begin_date: 开始日期 + :param end_date: 结束日期 + :param paged: 是否分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 过滤条件字典 + """ + return { + 'configName': config_name, + 'configKey': config_key, + 'configType': config_type, + 'beginDate': begin_date, + 'endDate': end_date, + 'paged': paged, + 'pageNum': page_num, + 'pageSize': page_size, + } diff --git a/shierfeng-fastapi-backend/cli/runtime/crypto/__init__.py b/shierfeng-fastapi-backend/cli/runtime/crypto/__init__.py new file mode 100644 index 0000000..17dc068 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/crypto/__init__.py @@ -0,0 +1,3 @@ +from .service import CRYPTO_RUNTIME, CryptoRuntimeService + +__all__ = ['CRYPTO_RUNTIME', 'CryptoRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/crypto/gateway.py b/shierfeng-fastapi-backend/cli/runtime/crypto/gateway.py new file mode 100644 index 0000000..85b5ad5 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/crypto/gateway.py @@ -0,0 +1,56 @@ +from importlib import import_module +from typing import Any + + +class CryptoInfrastructureGateway: + """ + 传输加密基础设施网关。 + + 该对象负责延迟加载 cryptography、环境配置和传输加密工具依赖, + 供传输加密运行时 facade 与其协作对象统一复用。 + """ + + @staticmethod + def get_serialization_module() -> Any: + """ + 获取 cryptography 序列化模块。 + + :return: 序列化模块 + """ + return import_module('cryptography.hazmat.primitives.serialization') + + @staticmethod + def get_rsa_module() -> Any: + """ + 获取 RSA 非对称算法模块。 + + :return: RSA 模块 + """ + return import_module('cryptography.hazmat.primitives.asymmetric.rsa') + + @staticmethod + def get_transport_crypto_config() -> Any: + """ + 获取传输加密配置对象。 + + :return: 传输加密配置对象 + """ + return import_module('config.env').TransportCryptoConfig + + @staticmethod + def get_transport_crypto_util() -> Any: + """ + 获取传输加密工具类。 + + :return: 传输加密工具类 + """ + return import_module('utils.transport_crypto_util').TransportCryptoUtil + + @staticmethod + def get_transport_key_provider() -> Any: + """ + 获取传输加密密钥提供者。 + + :return: 传输加密密钥提供者 + """ + return import_module('utils.transport_crypto_util').TransportKeyProvider diff --git a/shierfeng-fastapi-backend/cli/runtime/crypto/service.py b/shierfeng-fastapi-backend/cli/runtime/crypto/service.py new file mode 100644 index 0000000..1e6ed69 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/crypto/service.py @@ -0,0 +1,141 @@ +from datetime import datetime +from typing import Any + +from .gateway import CryptoInfrastructureGateway +from .support import CryptoDomainSupport, CryptoResultSupport + + +class CryptoRuntimeService: + """ + 传输加密运行时服务。 + + 该服务作为传输加密运行时 facade,对外统一暴露配置校验、 + 公钥导出、密钥生成和轮换辅助方案构建入口。 + + :param infrastructure_gateway: 传输加密基础设施网关 + :param domain_support: 传输加密领域支持对象 + :param result_support: 传输加密结果支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: CryptoInfrastructureGateway | None = None, + domain_support: CryptoDomainSupport | None = None, + result_support: CryptoResultSupport | None = None, + ) -> None: + """ + 初始化传输加密运行时服务。 + + :param infrastructure_gateway: 传输加密基础设施网关 + :param domain_support: 传输加密领域支持对象 + :param result_support: 传输加密结果支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or CryptoInfrastructureGateway() + self.domain_support = domain_support or CryptoDomainSupport(self.infrastructure_gateway) + self.result_support = result_support or CryptoResultSupport() + + def generate_crypto_key_pair(self, kid: str, key_size: int) -> dict[str, Any]: + """ + 生成新的传输加密密钥对。 + + :param kid: 目标密钥版本标识 + :param key_size: RSA 密钥长度 + :return: 密钥生成结果 + """ + + def _operation() -> dict[str, Any]: + self.domain_support.validate_rsa_key_size(key_size) + private_key_pem, public_key_pem = self.domain_support.generate_rsa_key_pair(key_size) + return { + 'ok': True, + 'message': '传输加密密钥生成完成', + 'kid': kid, + 'keySize': key_size, + 'privateKey': private_key_pem, + 'publicKey': public_key_pem, + 'envPatch': self.domain_support.build_key_pair_env_patch(kid, private_key_pem, public_key_pem), + } + + return self.result_support.run_argument_guarded(_operation, failure_message='生成传输加密密钥失败') + + def validate_crypto_config(self) -> dict[str, Any]: + """ + 校验传输加密运行配置。 + + :return: 传输加密配置校验结果 + """ + transport_key_provider = self.infrastructure_gateway.get_transport_key_provider() + + def _operation() -> dict[str, Any]: + transport_key_provider.validate_runtime_configuration() + return {'ok': True, 'message': '传输加密配置校验通过'} + + return self.result_support.run_runtime_guarded(_operation, failure_message='传输加密配置校验失败') + + def export_public_key(self) -> dict[str, Any]: + """ + 导出当前运行环境的传输加密公钥信息。 + + :return: 公钥导出结果 + """ + transport_key_provider = self.infrastructure_gateway.get_transport_key_provider() + transport_crypto_util = self.infrastructure_gateway.get_transport_crypto_util() + + def _operation() -> dict[str, Any]: + transport_key_provider.validate_runtime_configuration() + return {'ok': True, 'publicKey': transport_crypto_util.build_public_key_payload()} + + return self.result_support.run_runtime_guarded(_operation, failure_message='导出传输加密公钥失败') + + def build_rotation_payload(self, next_kid: str, key_size: int) -> dict[str, Any]: + """ + 生成传输加密密钥轮换辅助结果。 + + :param next_kid: 新密钥版本标识 + :param key_size: 新密钥的 RSA 长度 + :return: 轮换辅助结果 + """ + transport_key_provider = self.infrastructure_gateway.get_transport_key_provider() + + def _operation() -> dict[str, Any]: + self.domain_support.validate_rsa_key_size(key_size) + transport_key_provider.validate_runtime_configuration() + current_key_pair = transport_key_provider.get_current_key_pair() + if next_kid == current_key_pair.kid: + raise ValueError('新密钥版本不能与当前版本相同') + + private_key_pem, public_key_pem = self.domain_support.generate_rsa_key_pair(key_size) + legacy_key_pairs = self.domain_support.load_existing_legacy_key_pairs() + merged_legacy_key_pairs = self.domain_support.merge_rotation_legacy_key_pairs( + legacy_key_pairs, + current_key_pair, + next_kid, + ) + return { + 'ok': True, + 'message': '传输加密密钥轮换方案已生成', + 'currentKid': current_key_pair.kid, + 'nextKid': next_kid, + 'keySize': key_size, + 'generatedAt': datetime.now().isoformat(), + 'nextKeyPair': { + 'kid': next_kid, + 'privateKey': private_key_pem, + 'publicKey': public_key_pem, + }, + 'legacyKeyPairs': merged_legacy_key_pairs, + 'envPatch': self.domain_support.build_rotation_env_patch( + next_kid, + private_key_pem, + public_key_pem, + merged_legacy_key_pairs, + ), + 'applySteps': self.result_support.build_rotation_apply_steps(), + } + + return self.result_support.run_argument_guarded(_operation, failure_message='生成密钥轮换方案失败') + + +CRYPTO_RUNTIME = CryptoRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/crypto/support.py b/shierfeng-fastapi-backend/cli/runtime/crypto/support.py new file mode 100644 index 0000000..73f2e81 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/crypto/support.py @@ -0,0 +1,234 @@ +import json +from collections.abc import Callable +from typing import Any + +from cli.exit_codes import ARGUMENT_ERROR, RUNTIME_ERROR + +from .gateway import CryptoInfrastructureGateway + +MIN_RSA_KEY_SIZE = 2048 +RSA_KEY_SIZE_STEP = 256 + + +class CryptoDomainSupport: + """ + 传输加密领域支持对象。 + + 该对象负责 RSA 密钥规则校验、密钥对生成和历史密钥规整, + 避免主运行时服务继续承载局部安全规则和数据拼装细节。 + + :param infrastructure_gateway: 传输加密基础设施网关 + """ + + def __init__(self, infrastructure_gateway: CryptoInfrastructureGateway) -> None: + """ + 初始化传输加密领域支持对象。 + + :param infrastructure_gateway: 传输加密基础设施网关 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + + @staticmethod + def validate_rsa_key_size(key_size: int) -> None: + """ + 校验 RSA 密钥长度是否合法。 + + :param key_size: RSA 密钥长度 + :return: None + :raises ValueError: 密钥长度不满足约束时抛出异常 + """ + if key_size < MIN_RSA_KEY_SIZE or key_size % RSA_KEY_SIZE_STEP != 0: + raise ValueError('RSA 密钥长度必须大于等于 2048,且为 256 的整数倍') + + def generate_rsa_key_pair(self, key_size: int) -> tuple[str, str]: + """ + 生成 PEM 格式的 RSA 密钥对。 + + :param key_size: RSA 密钥长度 + :return: 私钥与公钥 PEM 字符串 + """ + rsa_module = self.infrastructure_gateway.get_rsa_module() + serialization_module = self.infrastructure_gateway.get_serialization_module() + private_key = rsa_module.generate_private_key(public_exponent=65537, key_size=key_size) + private_key_pem = private_key.private_bytes( + encoding=serialization_module.Encoding.PEM, + format=serialization_module.PrivateFormat.PKCS8, + encryption_algorithm=serialization_module.NoEncryption(), + ).decode('utf-8') + public_key_pem = ( + private_key.public_key() + .public_bytes( + encoding=serialization_module.Encoding.PEM, + format=serialization_module.PublicFormat.SubjectPublicKeyInfo, + ) + .decode('utf-8') + ) + return private_key_pem, public_key_pem + + def load_existing_legacy_key_pairs(self) -> list[dict[str, str]]: + """ + 解析当前配置中的历史密钥列表。 + + :return: 历史密钥列表 + :raises ValueError: 历史密钥配置非法时抛出异常 + """ + transport_crypto_config = self.infrastructure_gateway.get_transport_crypto_config() + raw_legacy_key_pairs = transport_crypto_config.transport_crypto_legacy_key_pairs or '[]' + parsed_legacy_key_pairs = json.loads(raw_legacy_key_pairs) + if not isinstance(parsed_legacy_key_pairs, list): + raise ValueError('TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS 必须为 JSON 数组') + return [item for item in parsed_legacy_key_pairs if isinstance(item, dict)] + + @staticmethod + def merge_rotation_legacy_key_pairs( + legacy_key_pairs: list[dict[str, str]], + current_key_pair: Any, + next_kid: str, + ) -> list[dict[str, str]]: + """ + 合并轮换后的历史密钥列表。 + + :param legacy_key_pairs: 当前历史密钥列表 + :param current_key_pair: 当前生效密钥对对象 + :param next_kid: 即将切换的新密钥版本 + :return: 合并后的历史密钥列表 + """ + normalized_legacy_key_pairs: dict[str, dict[str, str]] = { + str(item.get('kid')): item for item in legacy_key_pairs if item.get('kid') + } + normalized_legacy_key_pairs[current_key_pair.kid] = { + 'kid': current_key_pair.kid, + 'privateKey': current_key_pair.private_key_pem, + 'publicKey': current_key_pair.public_key_pem, + } + normalized_legacy_key_pairs.pop(next_kid, None) + return list(normalized_legacy_key_pairs.values()) + + @staticmethod + def build_key_pair_env_patch(kid: str, private_key_pem: str, public_key_pem: str) -> dict[str, str]: + """ + 构建密钥对写回环境变量所需的补丁数据。 + + :param kid: 密钥版本标识 + :param private_key_pem: 私钥 PEM 文本 + :param public_key_pem: 公钥 PEM 文本 + :return: 环境变量补丁数据 + """ + return { + 'TRANSPORT_CRYPTO_KID': kid, + 'TRANSPORT_CRYPTO_PRIVATE_KEY': private_key_pem, + 'TRANSPORT_CRYPTO_PUBLIC_KEY': public_key_pem, + } + + def build_rotation_env_patch( + self, + next_kid: str, + private_key_pem: str, + public_key_pem: str, + merged_legacy_key_pairs: list[dict[str, str]], + ) -> dict[str, str]: + """ + 构建密钥轮换写回环境变量所需的补丁数据。 + + :param next_kid: 新密钥版本标识 + :param private_key_pem: 新私钥 PEM 文本 + :param public_key_pem: 新公钥 PEM 文本 + :param merged_legacy_key_pairs: 合并后的历史密钥列表 + :return: 环境变量补丁数据 + """ + env_patch = self.build_key_pair_env_patch(next_kid, private_key_pem, public_key_pem) + env_patch['TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS'] = json.dumps(merged_legacy_key_pairs, ensure_ascii=False) + return env_patch + + +class CryptoResultSupport: + """ + 传输加密结果支持对象。 + + 该对象负责参数错误/运行时错误结果翻译,以及固定轮换提示文案构建, + 避免主运行时服务继续承载重复异常映射与静态 payload 片段。 + """ + + @staticmethod + def build_argument_error_result(message: str, exc: Exception) -> dict[str, Any]: + """ + 构建参数错误结果。 + + :param message: 失败消息 + :param exc: 原始异常 + :return: 标准参数错误结果 + """ + return { + 'ok': False, + 'message': message, + 'error': str(exc), + 'exit_code': ARGUMENT_ERROR, + } + + @staticmethod + def build_runtime_error_result(message: str, exc: Exception) -> dict[str, Any]: + """ + 构建运行时错误结果。 + + :param message: 失败消息 + :param exc: 原始异常 + :return: 标准运行时错误结果 + """ + return { + 'ok': False, + 'message': message, + 'error': str(exc), + 'exit_code': RUNTIME_ERROR, + } + + def run_argument_guarded( + self, + operation: Callable[[], dict[str, Any]], + *, + failure_message: str, + ) -> dict[str, Any]: + """ + 以统一参数/运行时错误翻译执行操作。 + + :param operation: 待执行操作 + :param failure_message: 失败消息 + :return: 操作结果 + """ + try: + return operation() + except ValueError as exc: + return self.build_argument_error_result(failure_message, exc) + except Exception as exc: + return self.build_runtime_error_result(failure_message, exc) + + def run_runtime_guarded( + self, + operation: Callable[[], dict[str, Any]], + *, + failure_message: str, + ) -> dict[str, Any]: + """ + 以统一运行时错误翻译执行操作。 + + :param operation: 待执行操作 + :param failure_message: 失败消息 + :return: 操作结果 + """ + try: + return operation() + except Exception as exc: + return self.build_runtime_error_result(failure_message, exc) + + @staticmethod + def build_rotation_apply_steps() -> list[str]: + """ + 构建密钥轮换后的应用步骤说明。 + + :return: 轮换应用步骤列表 + """ + return [ + '将 envPatch 中的新密钥写入目标环境配置', + '发布后保留 legacyKeyPairs,确保旧请求在轮换窗口内可解密', + '确认前端已刷新到 nextKid 后,再移除不再需要的历史密钥', + ] diff --git a/shierfeng-fastapi-backend/cli/runtime/db/__init__.py b/shierfeng-fastapi-backend/cli/runtime/db/__init__.py new file mode 100644 index 0000000..2b1832e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/db/__init__.py @@ -0,0 +1,3 @@ +from .service import DATABASE_RUNTIME, DatabaseRuntimeService + +__all__ = ['DATABASE_RUNTIME', 'DatabaseRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/db/gateway.py b/shierfeng-fastapi-backend/cli/runtime/db/gateway.py new file mode 100644 index 0000000..20798e4 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/db/gateway.py @@ -0,0 +1,56 @@ +from importlib import import_module +from typing import Any + + +class DatabaseInfrastructureGateway: + """ + 数据库基础设施网关。 + + 该对象负责延迟加载数据库引擎、SQLAlchemy 和 Alembic 相关依赖, + 供数据库运行时 facade 与其协作对象统一复用。 + """ + + @staticmethod + def get_async_db_engine_factory() -> Any: + """ + 获取异步数据库引擎工厂函数。 + + :return: 异步数据库引擎工厂函数 + """ + return import_module('config.database').create_async_db_engine + + @staticmethod + def get_sync_db_engine_factory() -> Any: + """ + 获取同步数据库引擎工厂函数。 + + :return: 同步数据库引擎工厂函数 + """ + return import_module('config.database').create_sync_db_engine + + @staticmethod + def get_sqlalchemy_text() -> Any: + """ + 获取 SQLAlchemy `text` 构造函数。 + + :return: SQLAlchemy `text` 函数 + """ + return import_module('sqlalchemy').text + + @staticmethod + def get_alembic_config_class() -> Any: + """ + 获取 Alembic 配置类。 + + :return: Alembic 配置类 + """ + return import_module('alembic.config').Config + + @staticmethod + def get_alembic_script_directory_class() -> Any: + """ + 获取 Alembic 脚本目录类。 + + :return: Alembic 脚本目录类 + """ + return import_module('alembic.script').ScriptDirectory diff --git a/shierfeng-fastapi-backend/cli/runtime/db/service.py b/shierfeng-fastapi-backend/cli/runtime/db/service.py new file mode 100644 index 0000000..f3ea221 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/db/service.py @@ -0,0 +1,199 @@ +from typing import Any + +from cli.exit_codes import DATABASE_ERROR +from cli.runtime.base import RUNTIME_ENVIRONMENT, RuntimeEnvironmentService + +from .gateway import DatabaseInfrastructureGateway +from .support import DatabaseAlembicCommandSupport, DatabaseRevisionSupport + + +class DatabaseRuntimeService: + """ + 数据库运行时服务。 + + 该服务作为数据库运行时 facade,对外统一暴露数据库连通性检查、 + Alembic 版本读取与迁移命令执行入口。 + + :param runtime_environment: 运行时环境服务 + :param infrastructure_gateway: 数据库基础设施网关 + :param revision_support: 数据库迁移版本支持对象 + :param alembic_command_support: 数据库 Alembic 命令支持对象 + """ + + def __init__( + self, + *, + runtime_environment: RuntimeEnvironmentService | None = None, + infrastructure_gateway: DatabaseInfrastructureGateway | None = None, + revision_support: DatabaseRevisionSupport | None = None, + alembic_command_support: DatabaseAlembicCommandSupport | None = None, + ) -> None: + """ + 初始化数据库运行时服务。 + + :param runtime_environment: 运行时环境服务 + :param infrastructure_gateway: 数据库基础设施网关 + :param revision_support: 数据库迁移版本支持对象 + :param alembic_command_support: 数据库 Alembic 命令支持对象 + :return: None + """ + self.runtime_environment = runtime_environment or RUNTIME_ENVIRONMENT + self.infrastructure_gateway = infrastructure_gateway or DatabaseInfrastructureGateway() + self.revision_support = revision_support or DatabaseRevisionSupport( + self.infrastructure_gateway, + self.runtime_environment, + ) + self.alembic_command_support = alembic_command_support or DatabaseAlembicCommandSupport( + self.runtime_environment + ) + + async def ping_database(self) -> dict[str, Any]: + """ + 检查数据库连通性。 + + :return: 数据库检查结果 + """ + create_async_db_engine = self.infrastructure_gateway.get_async_db_engine_factory() + text = self.infrastructure_gateway.get_sqlalchemy_text() + engine = create_async_db_engine(echo=False) + try: + async with engine.connect() as connection: + await connection.execute(text('SELECT 1')) + return {'ok': True, 'message': '数据库连接成功'} + except Exception as exc: + return {'ok': False, 'message': '数据库连接失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + finally: + await engine.dispose() + + def get_current_revision(self) -> dict[str, Any]: + """ + 获取数据库当前迁移版本。 + + :return: 当前迁移版本信息 + """ + create_sync_db_engine = self.infrastructure_gateway.get_sync_db_engine_factory() + text = self.infrastructure_gateway.get_sqlalchemy_text() + engine = create_sync_db_engine(echo=False) + try: + with engine.connect() as connection: + revision = connection.execute(text('SELECT version_num FROM alembic_version')).scalar() + return {'ok': True, 'currentRevision': revision} + except Exception as exc: + return {'ok': False, 'message': '读取数据库迁移版本失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + finally: + engine.dispose() + + def upgrade_database(self, revision: str = 'head', *, dry_run: bool = False) -> dict[str, Any]: + """ + 执行数据库迁移升级。 + + :param revision: 目标迁移版本,默认为 `head` + :param dry_run: 是否仅演练执行 + :return: 数据库迁移执行结果 + """ + return self.alembic_command_support.run_alembic_command( + 'upgrade', + revision, + success_message=f'数据库已升级到 {revision}', + failure_message='数据库升级失败', + dry_run=dry_run, + ) + + def init_database(self, *, dry_run: bool = False) -> dict[str, Any]: + """ + 初始化数据库到最新迁移版本。 + + :param dry_run: 是否仅演练执行 + :return: 数据库初始化结果 + """ + return self.alembic_command_support.run_alembic_command( + 'upgrade', + 'head', + success_message='数据库初始化完成,当前版本已同步到 head', + failure_message='数据库初始化失败', + dry_run=dry_run, + ) + + def downgrade_database(self, revision: str = '-1', *, dry_run: bool = False) -> dict[str, Any]: + """ + 执行数据库回退。 + + :param revision: 目标回退版本,默认为 `-1` + :param dry_run: 是否仅演练执行 + :return: 数据库回退结果 + """ + return self.alembic_command_support.run_alembic_command( + 'downgrade', + revision, + success_message=f'数据库已回退到 {revision}', + failure_message='数据库回退失败', + dry_run=dry_run, + ) + + def create_revision(self, message: str, *, autogenerate: bool = False, dry_run: bool = False) -> dict[str, Any]: + """ + 创建新的 Alembic 迁移版本文件。 + + :param message: 迁移说明 + :param autogenerate: 是否自动生成变更 + :param dry_run: 是否仅演练执行 + :return: 迁移版本创建结果 + """ + arguments: list[str] = ['-m', message] + if autogenerate: + arguments.append('--autogenerate') + return self.alembic_command_support.run_alembic_command( + 'revision', + *arguments, + success_message='数据库迁移版本文件创建完成', + failure_message='数据库迁移版本文件创建失败', + dry_run=dry_run, + ) + + def get_alembic_heads(self) -> dict[str, Any]: + """ + 读取当前代码仓库中的 Alembic heads 信息。 + + :return: Alembic heads 结果 + """ + try: + script_directory = self.revision_support.build_alembic_script_directory() + items = [ + self.revision_support.serialize_revision(revision) + for revision in script_directory.get_revisions('heads') + ] + return { + 'ok': True, + 'message': '已读取 Alembic heads', + 'count': len(items), + 'items': items, + } + except Exception as exc: + return {'ok': False, 'message': '读取 Alembic heads 失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + def get_alembic_history(self, *, limit: int = 20) -> dict[str, Any]: + """ + 读取当前代码仓库中的 Alembic 历史版本信息。 + + :param limit: 返回的最大历史记录数量 + :return: Alembic 历史版本结果 + """ + try: + script_directory = self.revision_support.build_alembic_script_directory() + history_items = [ + self.revision_support.serialize_revision(revision) for revision in script_directory.walk_revisions() + ] + limited_items = history_items[:limit] + return { + 'ok': True, + 'message': '已读取 Alembic 历史版本', + 'count': len(limited_items), + 'totalCount': len(history_items), + 'limit': limit, + 'items': limited_items, + } + except Exception as exc: + return {'ok': False, 'message': '读取 Alembic 历史版本失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + +DATABASE_RUNTIME = DatabaseRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/db/support.py b/shierfeng-fastapi-backend/cli/runtime/db/support.py new file mode 100644 index 0000000..2f1cfcc --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/db/support.py @@ -0,0 +1,160 @@ +import os +import subprocess +from typing import Any + +from cli.exit_codes import DATABASE_ERROR +from cli.runtime.base import RuntimeEnvironmentService + +from .gateway import DatabaseInfrastructureGateway + + +class DatabaseRevisionSupport: + """ + 数据库迁移版本支持对象。 + + 该对象负责 Alembic script directory 构建、修订版本规整和 + 版本对象序列化,避免主运行时服务继续承载迁移元数据细节。 + + :param infrastructure_gateway: 数据库基础设施网关 + :param runtime_environment: 运行时环境服务 + """ + + def __init__( + self, + infrastructure_gateway: DatabaseInfrastructureGateway, + runtime_environment: RuntimeEnvironmentService, + ) -> None: + """ + 初始化数据库迁移版本支持对象。 + + :param infrastructure_gateway: 数据库基础设施网关 + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + self.runtime_environment = runtime_environment + + def build_alembic_script_directory(self) -> Any: + """ + 基于当前后端目录构建 Alembic 脚本目录对象。 + + :return: Alembic 脚本目录对象 + """ + config_class = self.infrastructure_gateway.get_alembic_config_class() + script_directory_class = self.infrastructure_gateway.get_alembic_script_directory_class() + config = config_class(os.path.join(self.runtime_environment.get_backend_dir(), 'alembic.ini')) + return script_directory_class.from_config(config) + + @staticmethod + def normalize_revision_value(value: Any) -> list[str]: + """ + 规范化 Alembic 修订版本引用值。 + + :param value: 原始修订版本引用 + :return: 规范化后的修订版本列表 + """ + if value is None: + return [] + if isinstance(value, str): + return [value] + return [str(item) for item in value] + + def serialize_revision(self, script_revision: Any) -> dict[str, Any]: + """ + 序列化 Alembic 修订版本对象。 + + :param script_revision: Alembic 修订版本对象 + :return: 序列化后的修订版本字典 + """ + return { + 'revision': str(script_revision.revision), + 'downRevisions': self.normalize_revision_value(script_revision.down_revision), + 'branchLabels': sorted(str(item) for item in script_revision.branch_labels or []), + 'dependsOn': self.normalize_revision_value(script_revision.dependencies), + 'doc': (script_revision.doc or '').strip(), + 'path': str(script_revision.path), + } + + +class DatabaseAlembicCommandSupport: + """ + 数据库 Alembic 命令支持对象。 + + 该对象负责 Alembic 命令组装与子进程执行, + 避免主运行时服务继续承载命令行桥接细节。 + + :param runtime_environment: 运行时环境服务 + """ + + def __init__(self, runtime_environment: RuntimeEnvironmentService) -> None: + """ + 初始化数据库 Alembic 命令支持对象。 + + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.runtime_environment = runtime_environment + + def build_alembic_command(self, command: str, *arguments: str) -> list[str]: + """ + 构建 Alembic 命令。 + + :param command: Alembic 子命令名称 + :param arguments: Alembic 子命令参数列表 + :return: Alembic 命令参数列表 + """ + alembic_ini_path = os.path.join(self.runtime_environment.get_backend_dir(), 'alembic.ini') + return ['alembic', '-c', alembic_ini_path, command, *arguments] + + def run_alembic_command( + self, + command: str, + *arguments: str, + success_message: str, + failure_message: str, + dry_run: bool = False, + ) -> dict[str, Any]: + """ + 执行 Alembic 命令并返回统一结果。 + + :param command: Alembic 子命令名称 + :param arguments: Alembic 子命令参数列表 + :param success_message: 成功提示信息 + :param failure_message: 失败提示信息 + :param dry_run: 是否仅演练执行 + :return: Alembic 执行结果 + """ + command_arguments = self.build_alembic_command(command, *arguments) + if dry_run: + return { + 'ok': True, + 'message': f'{success_message}(dry-run)', + 'dryRun': True, + 'command': command_arguments, + 'cwd': self.runtime_environment.get_backend_dir(), + } + + try: + completed = subprocess.run( + command_arguments, + cwd=self.runtime_environment.get_backend_dir(), + env={**os.environ, 'APP_ENV': os.environ.get('APP_ENV', 'dev')}, + capture_output=True, + text=True, + check=False, + ) + if completed.returncode != 0: + return { + 'ok': False, + 'message': failure_message, + 'error': completed.stderr.strip() or completed.stdout.strip(), + 'exit_code': DATABASE_ERROR, + } + + payload: dict[str, Any] = {'ok': True, 'message': success_message} + stdout = completed.stdout.strip() + if stdout: + payload['stdout'] = stdout + return payload + except Exception as exc: + return {'ok': False, 'message': failure_message, 'error': str(exc), 'exit_code': DATABASE_ERROR} diff --git a/shierfeng-fastapi-backend/cli/runtime/dev/__init__.py b/shierfeng-fastapi-backend/cli/runtime/dev/__init__.py new file mode 100644 index 0000000..e5316cd --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/dev/__init__.py @@ -0,0 +1,3 @@ +from .service import DEVELOPMENT_RUNTIME, DevelopmentRuntimeService + +__all__ = ['DEVELOPMENT_RUNTIME', 'DevelopmentRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/dev/gateway.py b/shierfeng-fastapi-backend/cli/runtime/dev/gateway.py new file mode 100644 index 0000000..7ea2c11 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/dev/gateway.py @@ -0,0 +1,60 @@ +import subprocess +from typing import Any + +from cli.exit_codes import RUNTIME_ERROR +from cli.runtime.base import RuntimeEnvironmentService + + +class DevelopmentProcessGateway: + """ + 开发子进程执行网关。 + + 该对象负责统一执行开发工具子进程命令, + 避免支持对象直接依赖 `subprocess` 细节。 + + :param runtime_environment: 运行时环境服务 + """ + + def __init__(self, runtime_environment: RuntimeEnvironmentService) -> None: + """ + 初始化开发子进程执行网关。 + + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.runtime_environment = runtime_environment + + def run_command(self, command: list[str]) -> dict[str, Any]: + """ + 执行子进程命令并返回统一结果。 + + :param command: 待执行命令 + :return: 命令执行结果 + """ + try: + completed = subprocess.run( + command, + cwd=self.runtime_environment.get_backend_dir(), + capture_output=True, + text=True, + check=False, + ) + except Exception as exc: + return { + 'ok': False, + 'message': '开发命令执行失败', + 'error': str(exc), + 'command': command, + 'exit_code': RUNTIME_ERROR, + } + + payload: dict[str, Any] = { + 'ok': completed.returncode == 0, + 'command': command, + 'returnCode': completed.returncode, + } + if completed.stdout.strip(): + payload['stdout'] = completed.stdout.strip() + if completed.stderr.strip(): + payload['stderr'] = completed.stderr.strip() + return payload diff --git a/shierfeng-fastapi-backend/cli/runtime/dev/service.py b/shierfeng-fastapi-backend/cli/runtime/dev/service.py new file mode 100644 index 0000000..5812c75 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/dev/service.py @@ -0,0 +1,158 @@ +from typing import Any + +from cli.exit_codes import DEPENDENCY_ERROR, RUNTIME_ERROR +from cli.runtime.base import RUNTIME_ENVIRONMENT, RuntimeEnvironmentService + +from .gateway import DevelopmentProcessGateway +from .support import DevelopmentCommandSupport, DevelopmentToolingSupport + + +class DevelopmentRuntimeService: + """ + 开发运行时服务。 + + 该服务作为开发运行时 facade,对外统一暴露 lint/format 和 pytest + 执行入口。 + + :param runtime_environment: 运行时环境服务 + :param tooling_support: 开发工具支持对象 + :param command_support: 开发命令构建支持对象 + :param process_gateway: 开发子进程执行网关 + """ + + def __init__( + self, + *, + runtime_environment: RuntimeEnvironmentService | None = None, + tooling_support: DevelopmentToolingSupport | None = None, + command_support: DevelopmentCommandSupport | None = None, + process_gateway: DevelopmentProcessGateway | None = None, + ) -> None: + """ + 初始化开发运行时服务。 + + :param runtime_environment: 运行时环境服务 + :param tooling_support: 开发工具支持对象 + :param command_support: 开发命令构建支持对象 + :param process_gateway: 开发子进程执行网关 + :return: None + """ + self.runtime_environment = runtime_environment or RUNTIME_ENVIRONMENT + self.tooling_support = tooling_support or DevelopmentToolingSupport() + self.command_support = command_support or DevelopmentCommandSupport(self.runtime_environment) + self.process_gateway = process_gateway or DevelopmentProcessGateway(self.runtime_environment) + + def run_lint( + self, + targets: list[str] | None, + *, + check_only: bool = False, + fix: bool = False, + unsafe_fixes: bool = False, + ) -> dict[str, Any]: + """ + 执行仓库 lint/format 检查。 + + :param targets: 目标路径列表 + :param check_only: 是否仅检查不写回 + :param fix: 是否允许 `ruff check --fix` + :param unsafe_fixes: 是否允许不安全修复 + :return: lint 执行结果 + """ + normalized_targets = self.tooling_support.resolve_targets(targets) + format_command = self.command_support.build_format_command(normalized_targets, check_only=check_only) + format_result = self.process_gateway.run_command(format_command) + if not format_result.get('ok', False): + return { + 'ok': False, + 'message': 'Ruff format 阶段失败', + 'targets': normalized_targets, + 'format': format_result, + 'exit_code': RUNTIME_ERROR, + } + + check_command = self.command_support.build_check_command( + normalized_targets, + check_only=check_only, + fix=fix, + unsafe_fixes=unsafe_fixes, + ) + check_result = self.process_gateway.run_command(check_command) + if not check_result.get('ok', False): + return { + 'ok': False, + 'message': 'Ruff check 阶段失败', + 'targets': normalized_targets, + 'format': format_result, + 'check': check_result, + 'exit_code': RUNTIME_ERROR, + } + + return { + 'ok': True, + 'message': '开发检查已完成', + 'targets': normalized_targets, + 'checkOnly': check_only, + 'fix': fix and not check_only, + 'unsafeFixes': unsafe_fixes and fix and not check_only, + 'format': format_result, + 'check': check_result, + } + + def run_tests( + self, + targets: list[str] | None, + *, + keyword: str = '', + maxfail: int = 0, + quiet: bool = False, + ) -> dict[str, Any]: + """ + 执行项目测试。 + + :param targets: 目标测试路径列表 + :param keyword: pytest `-k` 过滤表达式 + :param maxfail: 最大失败数,0 表示不限制 + :param quiet: 是否启用简洁输出 + :return: 测试执行结果 + """ + if not self.tooling_support.is_pytest_available(): + return { + 'ok': False, + 'message': 'pytest 未安装,无法执行 dev test', + 'hint': '请在当前环境安装 pytest 后重试', + 'exit_code': DEPENDENCY_ERROR, + } + + normalized_targets = self.tooling_support.resolve_targets(targets) + command = self.command_support.build_pytest_command( + normalized_targets, + keyword=keyword, + maxfail=maxfail, + quiet=quiet, + ) + test_result = self.process_gateway.run_command(command) + if not test_result.get('ok', False): + return { + 'ok': False, + 'message': '测试执行失败', + 'targets': normalized_targets, + 'keyword': keyword, + 'maxfail': maxfail, + 'quiet': quiet, + 'test': test_result, + 'exit_code': RUNTIME_ERROR, + } + + return { + 'ok': True, + 'message': '测试执行完成', + 'targets': normalized_targets, + 'keyword': keyword, + 'maxfail': maxfail, + 'quiet': quiet, + 'test': test_result, + } + + +DEVELOPMENT_RUNTIME = DevelopmentRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/dev/support.py b/shierfeng-fastapi-backend/cli/runtime/dev/support.py new file mode 100644 index 0000000..4f37d2b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/dev/support.py @@ -0,0 +1,118 @@ +import importlib.util + +from cli.runtime.base import RuntimeEnvironmentService + + +class DevelopmentToolingSupport: + """ + 开发工具支持对象。 + + 该对象负责目标列表规整与开发依赖可用性检查, + 避免主运行时服务继续承载轻量工具规则。 + """ + + @staticmethod + def resolve_targets(targets: list[str] | None) -> list[str]: + """ + 规范化命令目标列表。 + + :param targets: 原始目标列表 + :return: 规范化后的目标列表 + """ + normalized_targets = [target.strip() for target in (targets or []) if target.strip()] + return normalized_targets or ['.'] + + @staticmethod + def is_pytest_available() -> bool: + """ + 检查 pytest 是否已安装。 + + :return: pytest 是否可用 + """ + return importlib.util.find_spec('pytest') is not None + + +class DevelopmentCommandSupport: + """ + 开发命令构建支持对象。 + + 该对象负责开发工具命令参数拼装, + 避免主运行时服务继续承载命令行桥接细节。 + + :param runtime_environment: 运行时环境服务 + """ + + def __init__(self, runtime_environment: RuntimeEnvironmentService) -> None: + """ + 初始化开发命令构建支持对象。 + + :param runtime_environment: 运行时环境服务 + :return: None + """ + self.runtime_environment = runtime_environment + + def build_format_command(self, normalized_targets: list[str], *, check_only: bool) -> list[str]: + """ + 构建 Ruff format 命令。 + + :param normalized_targets: 已规整目标列表 + :param check_only: 是否仅检查 + :return: 格式化命令参数列表 + """ + command = [self.runtime_environment.get_python_executable(), '-m', 'ruff', 'format'] + if check_only: + command.append('--check') + command.extend(normalized_targets) + return command + + def build_check_command( + self, + normalized_targets: list[str], + *, + check_only: bool, + fix: bool, + unsafe_fixes: bool, + ) -> list[str]: + """ + 构建 Ruff check 命令。 + + :param normalized_targets: 已规整目标列表 + :param check_only: 是否仅检查 + :param fix: 是否允许自动修复 + :param unsafe_fixes: 是否允许不安全修复 + :return: 检查命令参数列表 + """ + command = [self.runtime_environment.get_python_executable(), '-m', 'ruff', 'check'] + if fix and not check_only: + command.append('--fix') + if unsafe_fixes: + command.append('--unsafe-fixes') + command.extend(normalized_targets) + return command + + def build_pytest_command( + self, + normalized_targets: list[str], + *, + keyword: str, + maxfail: int, + quiet: bool, + ) -> list[str]: + """ + 构建 pytest 命令。 + + :param normalized_targets: 已规整目标列表 + :param keyword: pytest `-k` 表达式 + :param maxfail: 最大失败数 + :param quiet: 是否启用简洁输出 + :return: pytest 命令参数列表 + """ + command = [self.runtime_environment.get_python_executable(), '-m', 'pytest'] + if quiet: + command.append('-q') + if keyword: + command.extend(['-k', keyword]) + if maxfail > 0: + command.append(f'--maxfail={maxfail}') + command.extend(normalized_targets) + return command diff --git a/shierfeng-fastapi-backend/cli/runtime/gen/__init__.py b/shierfeng-fastapi-backend/cli/runtime/gen/__init__.py new file mode 100644 index 0000000..0f23c5c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/gen/__init__.py @@ -0,0 +1,3 @@ +from .service import GEN_RUNTIME, GenRuntimeService + +__all__ = ['GEN_RUNTIME', 'GenRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/gen/gateway.py b/shierfeng-fastapi-backend/cli/runtime/gen/gateway.py new file mode 100644 index 0000000..e099a6a --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/gen/gateway.py @@ -0,0 +1,110 @@ +from importlib import import_module +from typing import Any + + +class GenInfrastructureGateway: + """ + 代码生成基础设施网关。 + + 该对象负责延迟加载 sqlglot、数据库会话、分页模型、配置对象、 + 业务异常和代码生成服务依赖,供代码生成运行时 facade 与其协作对象统一复用。 + """ + + @staticmethod + def get_sqlglot_module() -> Any: + """ + 获取 `sqlglot` 模块。 + + :return: `sqlglot` 模块 + """ + return import_module('sqlglot') + + @staticmethod + def get_sqlglot_expressions_module() -> Any: + """ + 获取 `sqlglot.expressions` 模块。 + + :return: `sqlglot.expressions` 模块 + """ + return import_module('sqlglot.expressions') + + @staticmethod + def get_async_session_local() -> Any: + """ + 获取异步数据库会话工厂。 + + :return: 异步数据库会话工厂 + """ + return import_module('config.database').AsyncSessionLocal + + @staticmethod + def get_page_model() -> Any: + """ + 获取分页模型类型。 + + :return: 分页模型类型 + """ + return import_module('common.vo').PageModel + + @staticmethod + def get_database_config() -> Any: + """ + 获取数据库配置对象。 + + :return: 数据库配置对象 + """ + return import_module('config.env').DataBaseConfig + + @staticmethod + def get_gen_config() -> Any: + """ + 获取代码生成配置对象。 + + :return: 代码生成配置对象 + """ + return import_module('config.env').GenConfig + + @staticmethod + def get_service_exception_class() -> type[Exception]: + """ + 获取业务异常类型。 + + :return: 业务异常类型 + """ + return import_module('exceptions.exception').ServiceException + + @staticmethod + def get_user_vo_module() -> Any: + """ + 获取用户 VO 模块。 + + :return: 用户 VO 模块 + """ + return import_module('module_admin.entity.vo.user_vo') + + @staticmethod + def get_gen_vo_module() -> Any: + """ + 获取代码生成 VO 模块。 + + :return: 代码生成 VO 模块 + """ + return import_module('module_generator.entity.vo.gen_vo') + + @staticmethod + def get_gen_table_service() -> Any: + """ + 获取代码生成服务类。 + + :return: 代码生成服务类 + """ + return import_module('module_generator.service.gen_service').GenTableService + + @staticmethod + def get_gen_table_column_service() -> Any: + """ + 获取代码生成字段服务类。 + + :return: 代码生成字段服务类 + """ + return import_module('module_generator.service.gen_service').GenTableColumnService diff --git a/shierfeng-fastapi-backend/cli/runtime/gen/service.py b/shierfeng-fastapi-backend/cli/runtime/gen/service.py new file mode 100644 index 0000000..e760da9 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/gen/service.py @@ -0,0 +1,412 @@ +from typing import Any + +from cli.exit_codes import ARGUMENT_ERROR, DATABASE_ERROR, RUNTIME_ERROR + +from .gateway import GenInfrastructureGateway +from .support import GenDomainSupport + + +class GenRuntimeService: + """ + 代码生成运行时服务。 + + 该服务作为代码生成运行时 facade,对外统一暴露业务表、数据库物理表、 + 建表 SQL、代码预览、导出与数据库同步等入口。 + + :param infrastructure_gateway: 代码生成基础设施网关 + :param domain_support: 代码生成领域支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: GenInfrastructureGateway | None = None, + domain_support: GenDomainSupport | None = None, + ) -> None: + """ + 初始化代码生成运行时服务。 + + :param infrastructure_gateway: 代码生成基础设施网关 + :param domain_support: 代码生成领域支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or GenInfrastructureGateway() + self.domain_support = domain_support or GenDomainSupport(self.infrastructure_gateway) + + async def import_tables(self, table_names: list[str], *, dry_run: bool = False) -> dict[str, Any]: + """ + 导入数据库表到代码生成业务表。 + + :param table_names: 待导入表名列表 + :param dry_run: 是否仅演练执行 + :return: 导入结果 + """ + normalized_table_names = self.domain_support.normalize_table_names(table_names) + if not normalized_table_names: + return {'ok': False, 'message': '至少需要传入一个表名', 'exit_code': ARGUMENT_ERROR} + + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + service_exception = self.infrastructure_gateway.get_service_exception_class() + try: + async with async_session_local() as session: + gen_table_list = await gen_table_service.get_gen_db_table_list_by_name_services( + session, + normalized_table_names, + ) + matched_table_names = [gen_table.table_name for gen_table in gen_table_list if gen_table.table_name] + missing_table_names = [ + table_name for table_name in normalized_table_names if table_name not in matched_table_names + ] + + if dry_run: + return { + 'ok': True, + 'message': '导入表结构演练完成,未执行实际写入', + 'dryRun': True, + 'requestedTables': normalized_table_names, + 'matchedTables': matched_table_names, + 'missingTables': missing_table_names, + } + + result = await gen_table_service.import_gen_table_services( + session, + gen_table_list, + self.domain_support.build_cli_current_user(), + ) + except service_exception as exc: + return {'ok': False, 'message': '导入表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + except Exception as exc: + return {'ok': False, 'message': '导入表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + return { + 'ok': bool(result.is_success), + 'message': result.message, + 'requestedTables': normalized_table_names, + } + + async def list_gen_tables( + self, + *, + table_name: str = '', + table_comment: str = '', + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 查询代码生成业务表列表。 + + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 查询结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + try: + gen_vo_module = self.infrastructure_gateway.get_gen_vo_module() + query_model = gen_vo_module.GenTablePageQueryModel( + tableName=table_name or None, + tableComment=table_comment or None, + pageNum=page_num, + pageSize=page_size, + ) + async with async_session_local() as session: + result = await gen_table_service.get_gen_table_list_services(session, query_model, is_page=paged) + except Exception as exc: + return { + 'ok': False, + 'message': '读取代码生成业务表列表失败', + 'error': str(exc), + 'exit_code': DATABASE_ERROR, + } + + filters = { + 'tableName': table_name, + 'tableComment': table_comment, + 'paged': paged, + 'pageNum': page_num, + 'pageSize': page_size, + } + return self.domain_support.build_list_payload(result, filters=filters, paged=paged) + + async def list_gen_db_tables( + self, + *, + table_name: str = '', + table_comment: str = '', + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 查询数据库中可导入的物理表列表。 + + :param table_name: 表名称过滤条件 + :param table_comment: 表描述过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 查询结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + try: + gen_vo_module = self.infrastructure_gateway.get_gen_vo_module() + query_model = gen_vo_module.GenTablePageQueryModel( + tableName=table_name or None, + tableComment=table_comment or None, + pageNum=page_num, + pageSize=page_size, + ) + async with async_session_local() as session: + result = await gen_table_service.get_gen_db_table_list_services(session, query_model, is_page=paged) + except Exception as exc: + return {'ok': False, 'message': '读取数据库表列表失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + filters = { + 'tableName': table_name, + 'tableComment': table_comment, + 'paged': paged, + 'pageNum': page_num, + 'pageSize': page_size, + } + return self.domain_support.build_list_payload(result, filters=filters, paged=paged) + + async def create_tables(self, sql: str, sql_file: str, *, dry_run: bool = False) -> dict[str, Any]: + """ + 根据 SQL 创建表并导入代码生成业务表。 + + :param sql: 直接传入的 SQL 文本 + :param sql_file: SQL 文件路径 + :param dry_run: 是否仅演练执行 + :return: 创建结果 + """ + try: + sql_text = self.domain_support.resolve_sql_text(sql, sql_file) + sql_statements, table_names = self.domain_support.parse_create_table_sql(sql_text) + except ValueError as exc: + return {'ok': False, 'message': '创建表结构失败', 'error': str(exc), 'exit_code': ARGUMENT_ERROR} + except Exception as exc: + return {'ok': False, 'message': '创建表结构失败', 'error': str(exc), 'exit_code': RUNTIME_ERROR} + + if dry_run: + return { + 'ok': True, + 'message': '建表语句演练完成,未执行实际建表', + 'dryRun': True, + 'statementCount': len(sql_statements), + 'tableNames': table_names, + 'sql': sql_text, + } + + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + service_exception = self.infrastructure_gateway.get_service_exception_class() + try: + async with async_session_local() as session: + result = await gen_table_service.create_table_services( + session, + sql_text, + self.domain_support.build_cli_current_user(), + ) + except service_exception as exc: + return {'ok': False, 'message': '创建表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + except Exception as exc: + return {'ok': False, 'message': '创建表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + return { + 'ok': bool(result.is_success), + 'message': result.message, + 'tableNames': table_names, + } + + async def preview_code(self, table_id: int) -> dict[str, Any]: + """ + 预览指定业务表的代码生成结果。 + + :param table_id: 业务表 ID + :return: 预览结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + service_exception = self.infrastructure_gateway.get_service_exception_class() + try: + async with async_session_local() as session: + preview_payload = await gen_table_service.preview_code_services(session, table_id) + except service_exception as exc: + return {'ok': False, 'message': '预览代码失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + except Exception as exc: + return {'ok': False, 'message': '预览代码失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + return { + 'ok': True, + 'tableId': table_id, + 'templateCount': len(preview_payload), + 'preview': preview_payload, + } + + async def get_gen_table_detail(self, table_id: int) -> dict[str, Any]: + """ + 读取单个代码生成业务表详情。 + + :param table_id: 业务表 ID + :return: 详情结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + gen_table_column_service = self.infrastructure_gateway.get_gen_table_column_service() + try: + async with async_session_local() as session: + info = await gen_table_service.get_gen_table_by_id_services(session, table_id) + if not getattr(info, 'table_id', None): + return { + 'ok': False, + 'message': f'代码生成业务表不存在:{table_id}', + 'tableId': table_id, + 'exit_code': RUNTIME_ERROR, + } + rows = await gen_table_column_service.get_gen_table_column_list_by_table_id_services(session, table_id) + tables = await gen_table_service.get_gen_table_all_services(session) + except Exception as exc: + return { + 'ok': False, + 'message': '读取代码生成业务表详情失败', + 'error': str(exc), + 'exit_code': DATABASE_ERROR, + } + + detail_payload = { + 'info': self.domain_support.serialize_gen_item(info), + 'rows': self.domain_support.serialize_gen_items(rows), + 'tables': self.domain_support.serialize_gen_items(tables), + } + return { + 'ok': True, + 'tableId': table_id, + 'tableName': detail_payload['info'].get('tableName', ''), + 'columnCount': len(detail_payload['rows']), + 'tableCount': len(detail_payload['tables']), + 'detail': detail_payload, + } + + async def export_code( + self, + table_names: list[str], + *, + mode: str = 'zip', + output_file: str = '', + dry_run: bool = False, + ) -> dict[str, Any]: + """ + 导出代码生成结果。 + + :param table_names: 业务表名称列表 + :param mode: 导出模式,支持 `zip` 与 `local` + :param output_file: zip 导出目标文件路径 + :param dry_run: 是否仅演练执行 + :return: 导出结果 + """ + normalized_table_names = self.domain_support.normalize_table_names(table_names) + if not normalized_table_names: + return {'ok': False, 'message': '至少需要传入一个表名', 'exit_code': ARGUMENT_ERROR} + if mode not in {'zip', 'local'}: + return {'ok': False, 'message': '导出模式仅支持 zip 或 local', 'exit_code': ARGUMENT_ERROR} + + gen_config = self.infrastructure_gateway.get_gen_config() + if mode == 'local' and not gen_config.allow_overwrite: + return { + 'ok': False, + 'message': '当前系统配置不允许生成文件覆盖到本地', + 'hint': '请检查 GenConfig.allow_overwrite 配置', + 'exit_code': RUNTIME_ERROR, + } + + if dry_run: + dry_run_payload: dict[str, Any] = { + 'ok': True, + 'message': '代码导出演练完成,未执行实际导出', + 'dryRun': True, + 'mode': mode, + 'tableNames': normalized_table_names, + } + if mode == 'zip': + target_file = output_file.strip() or f'gen_code_{"_".join(normalized_table_names)}.zip' + dry_run_payload['outputFile'] = self.domain_support.resolve_output_file_path(target_file) + else: + dry_run_payload['genPath'] = gen_config.GEN_PATH + return dry_run_payload + + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + service_exception = self.infrastructure_gateway.get_service_exception_class() + try: + async with async_session_local() as session: + if mode == 'zip': + zip_bytes = await gen_table_service.batch_gen_code_services(session, normalized_table_names) + else: + messages = [] + for table_name in normalized_table_names: + result = await gen_table_service.generate_code_services(session, table_name) + messages.append({'tableName': table_name, 'message': result.message, 'ok': result.is_success}) + return { + 'ok': True, + 'message': '代码已生成到本地目录', + 'mode': mode, + 'tableNames': normalized_table_names, + 'genPath': gen_config.GEN_PATH, + 'results': messages, + } + except service_exception as exc: + return {'ok': False, 'message': '导出代码失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + except Exception as exc: + return {'ok': False, 'message': '导出代码失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + target_file = output_file.strip() or f'gen_code_{"_".join(normalized_table_names)}.zip' + try: + target_path = self.domain_support.write_export_zip(target_file, zip_bytes) + except Exception as exc: + return {'ok': False, 'message': '写出导出文件失败', 'error': str(exc), 'exit_code': RUNTIME_ERROR} + + return { + 'ok': True, + 'message': '代码压缩包导出完成', + 'mode': mode, + 'tableNames': normalized_table_names, + 'outputFile': target_path, + 'size': len(zip_bytes), + } + + async def sync_gen_table_from_db(self, table_name: str) -> dict[str, Any]: + """ + 将指定代码生成业务表与数据库表结构进行同步。 + + :param table_name: 业务表名称 + :return: 同步结果 + """ + normalized_table_name = table_name.strip() + if not normalized_table_name: + return {'ok': False, 'message': '表名不能为空', 'exit_code': ARGUMENT_ERROR} + + async_session_local = self.infrastructure_gateway.get_async_session_local() + gen_table_service = self.infrastructure_gateway.get_gen_table_service() + service_exception = self.infrastructure_gateway.get_service_exception_class() + try: + async with async_session_local() as session: + result = await gen_table_service.sync_db_services(session, normalized_table_name) + except service_exception as exc: + return {'ok': False, 'message': '同步数据库表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + except Exception as exc: + return {'ok': False, 'message': '同步数据库表结构失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + return { + 'ok': bool(result.is_success), + 'message': result.message, + 'tableName': normalized_table_name, + } + + +GEN_RUNTIME = GenRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/gen/support.py b/shierfeng-fastapi-backend/cli/runtime/gen/support.py new file mode 100644 index 0000000..6f92be7 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/gen/support.py @@ -0,0 +1,191 @@ +from pathlib import Path +from typing import Any + +from cli.runtime.base import RUNTIME_OPERATOR, RuntimeOperatorService + +from .gateway import GenInfrastructureGateway + + +class GenDomainSupport: + """ + 代码生成领域支持对象。 + + 该对象负责 CLI 当前用户构建、表名规整、记录序列化、SQL 解析 + 以及导出路径处理,避免主运行时服务继续承载过多局部规则。 + + :param infrastructure_gateway: 代码生成基础设施网关 + """ + + def __init__( + self, + infrastructure_gateway: GenInfrastructureGateway, + operator_service: RuntimeOperatorService = RUNTIME_OPERATOR, + ) -> None: + """ + 初始化代码生成领域支持对象。 + + :param infrastructure_gateway: 代码生成基础设施网关 + :param operator_service: 运行时操作者解析服务 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + self.operator_service = operator_service + + def build_cli_current_user(self) -> Any: + """ + 构建 CLI 场景使用的最小当前用户模型。 + + :return: CLI 当前用户模型 + """ + operator = self.operator_service.resolve_operator() + user_vo_module = self.infrastructure_gateway.get_user_vo_module() + return user_vo_module.CurrentUserModel( + permissions=[], + roles=['admin'], + user=user_vo_module.UserInfoModel( + user_id=1, + user_name=operator, + nick_name=operator, + user_type='00', + status='0', + del_flag='0', + ), + ) + + @staticmethod + def normalize_table_names(table_names: list[str]) -> list[str]: + """ + 规范化表名列表。 + + :param table_names: 原始表名列表 + :return: 规范化后的表名列表 + """ + return [table_name.strip() for table_name in table_names if table_name.strip()] + + @staticmethod + def serialize_gen_item(item: Any) -> dict[str, Any]: + """ + 序列化单个代码生成表记录。 + + :param item: 原始记录对象 + :return: 可输出的字典 + """ + if hasattr(item, 'model_dump'): + return dict(item.model_dump(by_alias=True, exclude_none=True)) + return dict(item) + + def serialize_gen_items(self, items: list[Any]) -> list[dict[str, Any]]: + """ + 序列化代码生成表记录列表。 + + :param items: 原始记录列表 + :return: 序列化后的字典列表 + """ + return [self.serialize_gen_item(item) for item in items] + + def parse_create_table_sql(self, sql: str) -> tuple[list[Any], list[str]]: + """ + 解析建表 SQL 并提取建表语句信息。 + + :param sql: 原始 SQL 文本 + :return: SQL AST 列表与建表表名列表 + :raises ValueError: SQL 非法时抛出异常 + """ + sqlglot_module = self.infrastructure_gateway.get_sqlglot_module() + expressions_module = self.infrastructure_gateway.get_sqlglot_expressions_module() + database_config = self.infrastructure_gateway.get_database_config() + sql_statements = sqlglot_module.parse(sql, dialect=database_config.sqlglot_parse_dialect) + has_create = any(isinstance(sql_statement, expressions_module.Create) for sql_statement in sql_statements) + has_forbidden_keyword = any( + isinstance( + sql_statement, + ( + expressions_module.Add, + expressions_module.Alter, + expressions_module.Delete, + expressions_module.Drop, + expressions_module.Insert, + expressions_module.TruncateTable, + expressions_module.Update, + ), + ) + for sql_statement in sql_statements + ) + if not has_create or has_forbidden_keyword: + raise ValueError('建表语句不合法,仅允许 CREATE TABLE 语句') + + table_names = [ + sql_statement.find(expressions_module.Table).name + for sql_statement in sql_statements + if isinstance(sql_statement, expressions_module.Create) + ] + if not table_names: + raise ValueError('未解析到建表表名') + return sql_statements, table_names + + @staticmethod + def resolve_sql_text(sql: str, sql_file: str) -> str: + """ + 解析命令输入中的 SQL 文本。 + + :param sql: 直接传入的 SQL 文本 + :param sql_file: SQL 文件路径 + :return: 最终 SQL 文本 + :raises ValueError: 参数非法时抛出异常 + """ + if bool(sql.strip()) == bool(sql_file.strip()): + raise ValueError('必须且只能传入 --sql 或 --sql-file 其中一种方式') + if sql.strip(): + return sql.strip() + + sql_path = Path(sql_file).expanduser().resolve() + if not sql_path.is_file(): + raise ValueError(f'SQL 文件不存在:{sql_path}') + return sql_path.read_text(encoding='utf-8').strip() + + @staticmethod + def resolve_output_file_path(target_file: str) -> str: + """ + 解析导出文件绝对路径。 + + :param target_file: 原始导出文件路径 + :return: 绝对路径字符串 + """ + return str(Path(target_file).expanduser().resolve()) + + @staticmethod + def write_export_zip(target_file: str, zip_bytes: bytes) -> str: + """ + 将导出的 zip 数据写入目标文件。 + + :param target_file: 目标文件路径 + :param zip_bytes: zip 二进制内容 + :return: 实际写入的绝对路径 + """ + target_path = Path(target_file).expanduser().resolve() + target_path.parent.mkdir(parents=True, exist_ok=True) + target_path.write_bytes(zip_bytes) + return str(target_path) + + def build_list_payload( + self, + result: Any, + *, + filters: dict[str, Any], + paged: bool, + ) -> dict[str, Any]: + """ + 统一构建代码生成列表返回结构。 + + :param result: 原始结果对象 + :param filters: 查询过滤条件 + :param paged: 是否分页 + :return: 可输出结果 + """ + if paged and isinstance(result, self.infrastructure_gateway.get_page_model()): + page_payload = result.model_dump(by_alias=True) + page_payload['rows'] = self.serialize_gen_items(page_payload.get('rows', [])) + return {'ok': True, 'filters': filters, 'page': page_payload} + + items = self.serialize_gen_items(result) + return {'ok': True, 'filters': filters, 'count': len(items), 'items': items} diff --git a/shierfeng-fastapi-backend/cli/runtime/job/__init__.py b/shierfeng-fastapi-backend/cli/runtime/job/__init__.py new file mode 100644 index 0000000..214da66 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/job/__init__.py @@ -0,0 +1,3 @@ +from .service import JOB_RUNTIME, JobRuntimeService + +__all__ = ['JOB_RUNTIME', 'JobRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/job/gateway.py b/shierfeng-fastapi-backend/cli/runtime/job/gateway.py new file mode 100644 index 0000000..b2491d4 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/job/gateway.py @@ -0,0 +1,74 @@ +from importlib import import_module +from typing import Any + + +class JobInfrastructureGateway: + """ + 定时任务基础设施网关。 + + 该对象负责延迟加载数据库会话、Redis、调度器和任务服务依赖, + 供定时任务运行时 facade 与其协作对象统一复用。 + """ + + @staticmethod + def get_page_model() -> Any: + """ + 获取分页模型类型。 + + :return: 分页模型类型 + """ + return import_module('common.vo').PageModel + + @staticmethod + def get_async_session_local() -> Any: + """ + 获取异步数据库会话工厂。 + + :return: 异步数据库会话工厂 + """ + return import_module('config.database').AsyncSessionLocal + + @staticmethod + def get_redis_util() -> Any: + """ + 获取 Redis 工具类。 + + :return: Redis 工具类 + """ + return import_module('config.get_redis').RedisUtil + + @staticmethod + def get_scheduler_util() -> Any: + """ + 获取调度器工具类。 + + :return: 调度器工具类 + """ + return import_module('config.get_scheduler').SchedulerUtil + + @staticmethod + def get_job_vo_module() -> Any: + """ + 获取定时任务 VO 模块。 + + :return: 定时任务 VO 模块 + """ + return import_module('module_admin.entity.vo.job_vo') + + @staticmethod + def get_job_service() -> Any: + """ + 获取定时任务服务类。 + + :return: 定时任务服务类 + """ + return import_module('module_admin.service.job_service').JobService + + @staticmethod + def get_job_log_service() -> Any: + """ + 获取定时任务日志服务类。 + + :return: 定时任务日志服务类 + """ + return import_module('module_admin.service.job_log_service').JobLogService diff --git a/shierfeng-fastapi-backend/cli/runtime/job/service.py b/shierfeng-fastapi-backend/cli/runtime/job/service.py new file mode 100644 index 0000000..9cf8e62 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/job/service.py @@ -0,0 +1,246 @@ +from typing import Any + +from cli.exit_codes import DATABASE_ERROR, RUNTIME_ERROR + +from .gateway import JobInfrastructureGateway +from .support import JobDomainSupport, JobSchedulerSupport + + +class JobRuntimeService: + """ + 定时任务运行时服务。 + + 该服务作为定时任务运行时 facade,对外统一暴露任务列表、详情、日志、 + 执行一次、暂停与恢复入口。 + + :param infrastructure_gateway: 定时任务基础设施网关 + :param domain_support: 定时任务领域支持对象 + :param scheduler_support: 定时任务调度上下文支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: JobInfrastructureGateway | None = None, + domain_support: JobDomainSupport | None = None, + scheduler_support: JobSchedulerSupport | None = None, + ) -> None: + """ + 初始化定时任务运行时服务。 + + :param infrastructure_gateway: 定时任务基础设施网关 + :param domain_support: 定时任务领域支持对象 + :param scheduler_support: 定时任务调度上下文支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or JobInfrastructureGateway() + self.domain_support = domain_support or JobDomainSupport(self.infrastructure_gateway) + self.scheduler_support = scheduler_support or JobSchedulerSupport(self.infrastructure_gateway) + + async def list_jobs( + self, + *, + job_name: str = '', + job_group: str = '', + status: str | None = None, + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 查询定时任务列表。 + + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 状态过滤条件 + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 定时任务列表结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + job_vo_module = self.infrastructure_gateway.get_job_vo_module() + job_service = self.infrastructure_gateway.get_job_service() + query_model = job_vo_module.JobPageQueryModel( + jobName=job_name or None, + jobGroup=job_group or None, + status=status, + pageNum=page_num, + pageSize=page_size, + ) + try: + async with async_session_local() as session: + result = await job_service.get_job_list_services(session, query_model, is_page=paged) + except Exception as exc: + return {'ok': False, 'message': '读取定时任务列表失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + filters = self.domain_support.build_filters( + job_name=job_name, + job_group=job_group, + status=status, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + return self.domain_support.build_list_payload(result, filters=filters, paged=paged) + + async def get_job_detail(self, job_id: int) -> dict[str, Any]: + """ + 读取单个定时任务详情。 + + :param job_id: 任务 ID + :return: 定时任务详情结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + job_service = self.infrastructure_gateway.get_job_service() + try: + async with async_session_local() as session: + job_model = await job_service.job_detail_services(session, job_id) + except Exception as exc: + return {'ok': False, 'message': '读取定时任务详情失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + job_payload = self.domain_support.serialize_job_item(job_model) + if not job_payload.get('jobId'): + return { + 'ok': False, + 'message': f'定时任务不存在:{job_id}', + 'jobId': job_id, + 'exit_code': RUNTIME_ERROR, + } + return {'ok': True, 'job': job_payload} + + async def list_job_logs( + self, + *, + job_name: str = '', + job_group: str = '', + status: str | None = None, + begin_date: str = '', + end_date: str = '', + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 查询定时任务执行日志列表。 + + :param job_name: 任务名称过滤条件 + :param job_group: 任务组过滤条件 + :param status: 执行状态过滤条件 + :param begin_date: 开始日期,格式 `YYYY-MM-DD` + :param end_date: 结束日期,格式 `YYYY-MM-DD` + :param paged: 是否启用分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 定时任务日志列表结果 + """ + async_session_local = self.infrastructure_gateway.get_async_session_local() + job_log_service = self.infrastructure_gateway.get_job_log_service() + job_vo_module = self.infrastructure_gateway.get_job_vo_module() + query_model = job_vo_module.JobLogPageQueryModel( + jobName=job_name or None, + jobGroup=job_group or None, + status=status, + beginTime=begin_date or None, + endTime=end_date or None, + pageNum=page_num, + pageSize=page_size, + ) + try: + async with async_session_local() as session: + result = await job_log_service.get_job_log_list_services(session, query_model, is_page=paged) + except Exception as exc: + return {'ok': False, 'message': '读取定时任务日志列表失败', 'error': str(exc), 'exit_code': DATABASE_ERROR} + + filters = self.domain_support.build_filters( + job_name=job_name, + job_group=job_group, + status=status, + begin_date=begin_date, + end_date=end_date, + paged=paged, + page_num=page_num, + page_size=page_size, + ) + return self.domain_support.build_list_payload(result, filters=filters, paged=paged) + + async def run_with_scheduler_context( + self, + operation: str, + job_id: int, + *, + status: str | None = None, + ) -> dict[str, Any]: + """ + 在调度器上下文中执行任务操作。 + + :param operation: 操作名称 + :param job_id: 任务ID + :param status: 目标状态 + :return: 任务操作结果 + """ + operation_metadata = self.domain_support.build_job_operation_metadata(operation) + redis = None + async_session_local = self.infrastructure_gateway.get_async_session_local() + redis_util = self.infrastructure_gateway.get_redis_util() + scheduler_util = self.infrastructure_gateway.get_scheduler_util() + job_vo_module = self.infrastructure_gateway.get_job_vo_module() + job_service = self.infrastructure_gateway.get_job_service() + try: + async with async_session_local() as session: + redis = await redis_util.create_redis_pool(log_enabled=False) + await scheduler_util.init_system_scheduler(redis) + + if operation == 'run-once': + result = await job_service.execute_job_once_services(session, job_vo_module.JobModel(jobId=job_id)) + elif operation in {'pause', 'resume'}: + result = await job_service.edit_job_services( + session, + job_vo_module.EditJobModel(jobId=job_id, status=status, type='status'), + ) + else: + raise ValueError(f'不支持的任务操作:{operation}') + except Exception as exc: + return {'ok': False, 'message': '执行定时任务操作失败', 'error': str(exc), 'exit_code': 22} + finally: + await self.scheduler_support.close_scheduler_context(redis) + + return { + 'ok': bool(result.is_success), + 'jobId': job_id, + 'operation': operation, + 'operationLabel': operation_metadata['operationLabel'], + 'targetStatus': status, + 'message': operation_metadata['successMessage'] if result.is_success else '定时任务操作执行失败', + 'serviceMessage': result.message, + } + + async def run_job_once(self, job_id: int) -> dict[str, Any]: + """ + 执行一次指定定时任务。 + + :param job_id: 任务ID + :return: 执行结果 + """ + return await self.run_with_scheduler_context('run-once', job_id) + + async def pause_job(self, job_id: int) -> dict[str, Any]: + """ + 暂停指定定时任务。 + + :param job_id: 任务ID + :return: 暂停结果 + """ + return await self.run_with_scheduler_context('pause', job_id, status='1') + + async def resume_job(self, job_id: int) -> dict[str, Any]: + """ + 恢复指定定时任务。 + + :param job_id: 任务ID + :return: 恢复结果 + """ + return await self.run_with_scheduler_context('resume', job_id, status='0') + + +JOB_RUNTIME = JobRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/job/support.py b/shierfeng-fastapi-backend/cli/runtime/job/support.py new file mode 100644 index 0000000..19578b2 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/job/support.py @@ -0,0 +1,173 @@ +from typing import Any + +from .gateway import JobInfrastructureGateway + + +class JobDomainSupport: + """ + 定时任务领域支持对象。 + + 该对象负责任务序列化、分页结果规整和任务操作元数据定义, + 避免主运行时服务继续承载细碎领域规则。 + + :param infrastructure_gateway: 定时任务基础设施网关 + """ + + def __init__(self, infrastructure_gateway: JobInfrastructureGateway) -> None: + """ + 初始化定时任务领域支持对象。 + + :param infrastructure_gateway: 定时任务基础设施网关 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + + @staticmethod + def serialize_job_item(job_item: Any) -> dict[str, Any]: + """ + 序列化单个定时任务模型。 + + :param job_item: 原始定时任务模型或字典 + :return: 可输出的定时任务字典 + """ + if hasattr(job_item, 'model_dump'): + return dict(job_item.model_dump(by_alias=True, exclude_none=True)) + return dict(job_item) + + def serialize_job_items(self, job_items: list[dict[str, Any]]) -> list[dict[str, Any]]: + """ + 序列化任务列表结果。 + + :param job_items: 原始任务列表 + :return: 可输出的任务列表 + """ + return [self.serialize_job_item(item) for item in job_items] + + @staticmethod + def build_job_operation_metadata(operation: str) -> dict[str, str]: + """ + 构建任务操作的统一元数据。 + + :param operation: 操作名称 + :return: 操作元数据字典 + :raises ValueError: 操作名称不受支持时抛出异常 + """ + metadata_mapping = { + 'run-once': { + 'operationLabel': '执行一次任务', + 'successMessage': '定时任务已触发一次执行', + }, + 'pause': { + 'operationLabel': '暂停任务', + 'successMessage': '定时任务已暂停', + }, + 'resume': { + 'operationLabel': '恢复任务', + 'successMessage': '定时任务已恢复', + }, + } + if operation not in metadata_mapping: + raise ValueError(f'不支持的任务操作:{operation}') + return metadata_mapping[operation] + + def build_filters( + self, + *, + job_name: str = '', + job_group: str = '', + status: str | None = None, + begin_date: str = '', + end_date: str = '', + paged: bool = False, + page_num: int = 1, + page_size: int = 20, + ) -> dict[str, Any]: + """ + 构建任务列表或日志查询过滤条件。 + + :param job_name: 任务名称 + :param job_group: 任务分组 + :param status: 状态 + :param begin_date: 开始日期 + :param end_date: 结束日期 + :param paged: 是否分页 + :param page_num: 页码 + :param page_size: 每页数量 + :return: 过滤条件字典 + """ + filters = { + 'jobName': job_name, + 'jobGroup': job_group, + 'status': status, + 'paged': paged, + 'pageNum': page_num, + 'pageSize': page_size, + } + if begin_date or end_date: + filters['beginDate'] = begin_date + filters['endDate'] = end_date + return filters + + def build_list_payload( + self, + result: Any, + *, + filters: dict[str, Any], + paged: bool, + ) -> dict[str, Any]: + """ + 统一构建任务列表或日志列表返回结构。 + + :param result: 原始结果对象 + :param filters: 查询过滤条件 + :param paged: 是否分页 + :return: 可输出结果 + """ + if paged and isinstance(result, self.infrastructure_gateway.get_page_model()): + page_payload = result.model_dump(by_alias=True) + page_payload['rows'] = self.serialize_job_items(page_payload.get('rows', [])) + return {'ok': True, 'filters': filters, 'page': page_payload} + + items = self.serialize_job_items(result) + return {'ok': True, 'filters': filters, 'count': len(items), 'items': items} + + +class JobSchedulerSupport: + """ + 定时任务调度上下文支持对象。 + + 该对象负责统一关闭调度器上下文资源,避免调度型操作在 facade 中 + 持续堆叠资源清理细节。 + + :param infrastructure_gateway: 定时任务基础设施网关 + """ + + def __init__(self, infrastructure_gateway: JobInfrastructureGateway) -> None: + """ + 初始化定时任务调度上下文支持对象。 + + :param infrastructure_gateway: 定时任务基础设施网关 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + + async def close_scheduler_context(self, redis: Any) -> None: + """ + 安全关闭任务调度相关资源。 + + :param redis: Redis 客户端实例 + :return: None + """ + scheduler_util = self.infrastructure_gateway.get_scheduler_util() + try: + await scheduler_util.close_system_scheduler() + except Exception: + pass + + if redis is None: + return + + try: + await redis.close() + except Exception: + pass diff --git a/shierfeng-fastapi-backend/cli/runtime/ops/__init__.py b/shierfeng-fastapi-backend/cli/runtime/ops/__init__.py new file mode 100644 index 0000000..9c60709 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/ops/__init__.py @@ -0,0 +1,3 @@ +from .service import OPERATIONS_RUNTIME, OperationsRuntimeService + +__all__ = ['OPERATIONS_RUNTIME', 'OperationsRuntimeService'] diff --git a/shierfeng-fastapi-backend/cli/runtime/ops/gateway.py b/shierfeng-fastapi-backend/cli/runtime/ops/gateway.py new file mode 100644 index 0000000..261c202 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/ops/gateway.py @@ -0,0 +1,65 @@ +from importlib import import_module +from typing import Any + + +class OperationsInfrastructureGateway: + """ + 运维基础设施网关。 + + 该对象负责延迟加载 Redis、调度器、服务器监控与系统工具依赖, + 供运维运行时 facade 和其协作对象统一复用。 + """ + + @staticmethod + def get_redis_util() -> Any: + """ + 获取 Redis 工具类。 + + :return: Redis 工具类 + """ + return import_module('config.get_redis').RedisUtil + + @staticmethod + def get_redis_error_class() -> type[Exception]: + """ + 获取 Redis 异常类型。 + + :return: Redis 异常类型 + """ + return import_module('redis.exceptions').RedisError + + @staticmethod + def get_scheduler_util() -> Any: + """ + 获取调度器工具类。 + + :return: 调度器工具类 + """ + return import_module('config.get_scheduler').SchedulerUtil + + @staticmethod + def get_server_service() -> Any: + """ + 获取服务器监控服务类。 + + :return: 服务器监控服务类 + """ + return import_module('module_admin.service.server_service').ServerService + + @staticmethod + def get_psutil_module() -> Any: + """ + 获取 `psutil` 模块。 + + :return: `psutil` 模块 + """ + return import_module('psutil') + + @staticmethod + def get_bytes2human() -> Any: + """ + 获取字节数转可读文本函数。 + + :return: `bytes2human` 函数 + """ + return import_module('utils.common_util').bytes2human diff --git a/shierfeng-fastapi-backend/cli/runtime/ops/service.py b/shierfeng-fastapi-backend/cli/runtime/ops/service.py new file mode 100644 index 0000000..cfff10c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/ops/service.py @@ -0,0 +1,132 @@ +import socket +from typing import Any + +from cli.exit_codes import REDIS_ERROR, RUNTIME_ERROR, SCHEDULER_ERROR + +from .gateway import OperationsInfrastructureGateway +from .support import ( + OperationsDependencyInspector, + OperationsServerInfoSupport, +) + + +class OperationsRuntimeService: + """ + 运维运行时服务。 + + 该服务作为运维运行时 facade,对外统一暴露依赖版本检查、Redis 探活、 + 调度同步以及服务器运行时信息采集入口。 + + :param infrastructure_gateway: 运维基础设施网关 + :param dependency_inspector: 运维依赖检查器 + :param server_info_support: 服务器信息支持对象 + """ + + def __init__( + self, + *, + infrastructure_gateway: OperationsInfrastructureGateway | None = None, + dependency_inspector: OperationsDependencyInspector | None = None, + server_info_support: OperationsServerInfoSupport | None = None, + ) -> None: + """ + 初始化运维运行时服务。 + + :param infrastructure_gateway: 运维基础设施网关 + :param dependency_inspector: 运维依赖检查器 + :param server_info_support: 服务器信息支持对象 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway or OperationsInfrastructureGateway() + self.dependency_inspector = dependency_inspector or OperationsDependencyInspector() + self.server_info_support = server_info_support or OperationsServerInfoSupport(self.infrastructure_gateway) + + def get_dependency_versions(self, *, include_dev: bool = False) -> dict[str, Any]: + """ + 读取 CLI 和后端运行所依赖的核心 Python 包版本。 + + :param include_dev: 是否附带开发阶段依赖 + :return: 依赖检查结果 + """ + return self.dependency_inspector.inspect(include_dev=include_dev) + + async def ping_redis(self) -> dict[str, Any]: + """ + 检查 Redis 连通性。 + + :return: Redis 检查结果 + """ + redis_util = self.infrastructure_gateway.get_redis_util() + redis_error = self.infrastructure_gateway.get_redis_error_class() + redis = await redis_util.create_redis_pool(log_enabled=False) + try: + await redis.ping() + return {'ok': True, 'message': 'Redis连接成功'} + except redis_error as exc: + return {'ok': False, 'message': 'Redis连接失败', 'error': str(exc), 'exit_code': REDIS_ERROR} + finally: + await redis.close() + + async def sync_jobs(self) -> dict[str, Any]: + """ + 同步调度任务配置。 + + :return: 任务同步执行结果 + """ + redis = None + scheduler_util = None + try: + redis_util = self.infrastructure_gateway.get_redis_util() + scheduler_util = self.infrastructure_gateway.get_scheduler_util() + redis = await redis_util.create_redis_pool(log_enabled=False) + await scheduler_util.init_system_scheduler(redis) + await scheduler_util.request_scheduler_sync() + return { + 'ok': True, + 'operation': 'sync', + 'operationLabel': '同步调度配置', + 'schedulerSyncRequested': True, + 'message': '调度配置同步请求已发送', + 'isLeader': scheduler_util._is_leader, + } + except Exception as exc: + return { + 'ok': False, + 'operation': 'sync', + 'operationLabel': '同步调度配置', + 'schedulerSyncRequested': False, + 'message': '调度配置同步失败', + 'error': str(exc), + 'exit_code': SCHEDULER_ERROR, + } + finally: + if scheduler_util is not None: + try: + await scheduler_util.close_system_scheduler() + except Exception: + pass + if redis is not None: + try: + await redis.close() + except Exception: + pass + + async def get_server_info(self) -> dict[str, Any]: + """ + 获取服务器运行信息。 + + :return: 服务器运行信息字典 + """ + try: + server_service = self.infrastructure_gateway.get_server_service() + return {'ok': True, 'server': (await server_service.get_server_monitor_info()).model_dump(by_alias=True)} + except socket.gaierror: + try: + return {'ok': True, 'server': self.server_info_support.build_server_info_fallback()} + except Exception as exc: + return {'ok': False, 'message': '读取服务器运行信息失败', 'error': str(exc), 'exit_code': RUNTIME_ERROR} + except Exception as exc: + return {'ok': False, 'message': '读取服务器运行信息失败', 'error': str(exc), 'exit_code': RUNTIME_ERROR} + + +OPERATIONS_RUNTIME = OperationsRuntimeService() diff --git a/shierfeng-fastapi-backend/cli/runtime/ops/support.py b/shierfeng-fastapi-backend/cli/runtime/ops/support.py new file mode 100644 index 0000000..f891c14 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/runtime/ops/support.py @@ -0,0 +1,241 @@ +import os +import platform +import socket +import time +from dataclasses import dataclass +from importlib import metadata +from typing import Any + +from cli.exit_codes import RUNTIME_ERROR + +from .gateway import OperationsInfrastructureGateway + + +@dataclass(frozen=True) +class OperationsDependencySpec: + """ + 运维依赖检查项定义。 + + :param package_name: CLI 展示用包名 + :param distribution: Python 分发名称 + :param required: 是否为必需依赖 + :param version: 显式版本,存在时跳过环境读取 + """ + + package_name: str + distribution: str + required: bool + version: str | None = None + + +class OperationsDependencyInspector: + """ + 运维依赖检查器。 + + 该对象负责核心依赖声明、版本探测与依赖检查结果构建, + 使运行时 facade 不再直接维护细碎依赖定义。 + """ + + @staticmethod + def read_package_version(distribution_name: str) -> str | None: + """ + 读取指定 Python 包的已安装版本号。 + + :param distribution_name: Python 包分发名称 + :return: 已安装版本号,未安装时返回 `None` + """ + try: + return metadata.version(distribution_name) + except metadata.PackageNotFoundError: + return None + + @staticmethod + def build_dependency_specs(*, include_dev: bool = False) -> list[OperationsDependencySpec]: + """ + 构建当前依赖检查项列表。 + + :param include_dev: 是否附带开发阶段依赖 + :return: 依赖检查项列表 + """ + dependency_specs = [ + OperationsDependencySpec('python', '', True, platform.python_version()), + OperationsDependencySpec('fastapi', 'fastapi', True), + OperationsDependencySpec('uvicorn', 'uvicorn', True), + OperationsDependencySpec('sqlalchemy', 'SQLAlchemy', True), + OperationsDependencySpec('alembic', 'alembic', True), + OperationsDependencySpec('redis', 'redis', True), + OperationsDependencySpec('pydantic', 'pydantic', True), + OperationsDependencySpec('pydantic-settings', 'pydantic-settings', True), + OperationsDependencySpec('typer', 'typer', True), + ] + if include_dev: + dependency_specs.extend( + [ + OperationsDependencySpec('pytest', 'pytest', False), + OperationsDependencySpec('ruff', 'ruff', False), + ] + ) + return dependency_specs + + def inspect(self, *, include_dev: bool = False) -> dict[str, Any]: + """ + 读取 CLI 和后端运行所依赖的核心 Python 包版本。 + + :param include_dev: 是否附带开发阶段依赖 + :return: 依赖检查结果 + """ + packages: dict[str, dict[str, Any]] = {} + missing_required: list[str] = [] + for dependency_spec in self.build_dependency_specs(include_dev=include_dev): + version = dependency_spec.version or self.read_package_version(dependency_spec.distribution) + installed = bool(version) + package_payload = { + 'installed': installed, + 'version': version or '', + 'required': dependency_spec.required, + } + if dependency_spec.distribution: + package_payload['distribution'] = dependency_spec.distribution + packages[dependency_spec.package_name] = package_payload + if dependency_spec.required and not installed: + missing_required.append(dependency_spec.package_name) + + if missing_required: + return { + 'ok': False, + 'message': '存在缺失的核心运行依赖', + 'missingRequired': missing_required, + 'includeDev': include_dev, + 'packages': packages, + 'exit_code': RUNTIME_ERROR, + } + + return { + 'ok': True, + 'message': '核心运行依赖已安装', + 'missingRequired': [], + 'includeDev': include_dev, + 'packages': packages, + } + + +class OperationsServerInfoSupport: + """ + 运维服务器信息支持对象。 + + 该对象负责 CLI 兜底服务器信息构建与 IP 解析逻辑, + 避免主运行时服务继续承载大量平台采集细节。 + + :param infrastructure_gateway: 运维基础设施网关 + """ + + def __init__(self, infrastructure_gateway: OperationsInfrastructureGateway) -> None: + """ + 初始化服务器信息支持对象。 + + :param infrastructure_gateway: 运维基础设施网关 + :return: None + """ + self.infrastructure_gateway = infrastructure_gateway + + def resolve_server_ip(self, hostname: str) -> str: + """ + 解析服务器 IP,优先使用主机名解析,失败时回退到网卡地址。 + + :param hostname: 当前主机名 + :return: 可用的 IPv4 地址 + """ + psutil = self.infrastructure_gateway.get_psutil_module() + try: + resolved_ip = socket.gethostbyname(hostname) + if resolved_ip: + return resolved_ip + except OSError: + pass + + for interface_addresses in psutil.net_if_addrs().values(): + for address_info in interface_addresses: + if ( + address_info.family == socket.AF_INET + and address_info.address + and not address_info.address.startswith('127.') + ): + return address_info.address + + return '127.0.0.1' + + def build_server_info_fallback(self) -> dict[str, Any]: + """ + 构建 CLI 使用的服务器运行信息兜底数据。 + + :return: 与原服务输出结构兼容的服务器运行信息字典 + """ + psutil = self.infrastructure_gateway.get_psutil_module() + bytes2human = self.infrastructure_gateway.get_bytes2human() + cpu_num = psutil.cpu_count(logical=True) + cpu_usage_percent = psutil.cpu_times_percent() + memory_info = psutil.virtual_memory() + + hostname = socket.gethostname() + current_process = psutil.Process(os.getpid()) + start_time_stamp = current_process.create_time() + current_time_stamp = time.time() + difference = current_time_stamp - start_time_stamp + days = int(difference // (24 * 60 * 60)) + hours = int((difference % (24 * 60 * 60)) // (60 * 60)) + minutes = int((difference % (60 * 60)) // 60) + process_memory_info = current_process.memory_info() + + sys_files: list[dict[str, Any]] = [] + for partition in psutil.disk_partitions(): + try: + disk_usage = psutil.disk_usage(partition.mountpoint) + except Exception: + continue + + mountpoint = partition.mountpoint.replace('\\', '') + sys_files.append( + { + 'dirName': partition.device, + 'sysTypeName': partition.fstype, + 'typeName': f'本地固定磁盘({mountpoint})', + 'total': bytes2human(disk_usage.total), + 'used': bytes2human(disk_usage.used), + 'free': bytes2human(disk_usage.free), + 'usage': f'{disk_usage.percent}%', + } + ) + + return { + 'cpu': { + 'cpuNum': cpu_num, + 'used': cpu_usage_percent.user, + 'sys': cpu_usage_percent.system, + 'free': cpu_usage_percent.idle, + }, + 'mem': { + 'total': bytes2human(memory_info.total), + 'used': bytes2human(memory_info.used), + 'free': bytes2human(memory_info.free), + 'usage': memory_info.percent, + }, + 'sys': { + 'computerIp': self.resolve_server_ip(hostname), + 'computerName': platform.node(), + 'osArch': platform.machine(), + 'osName': platform.platform(), + 'userDir': os.getcwd(), + }, + 'py': { + 'name': current_process.name(), + 'version': platform.python_version(), + 'startTime': time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(start_time_stamp)), + 'runTime': f'{days}天{hours}小时{minutes}分钟', + 'home': current_process.exe(), + 'total': bytes2human(memory_info.available), + 'used': bytes2human(process_memory_info.rss), + 'free': bytes2human(memory_info.available - process_memory_info.rss), + 'usage': round((process_memory_info.rss / memory_info.available) * 100, 2), + }, + 'sysFiles': sys_files, + } diff --git a/shierfeng-fastapi-backend/cli/tui/__init__.py b/shierfeng-fastapi-backend/cli/tui/__init__.py new file mode 100644 index 0000000..a21e01d --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/__init__.py @@ -0,0 +1,3 @@ +from cli.tui.commands import TUI_COMMAND_REGISTRATION + +__all__ = ['TUI_COMMAND_REGISTRATION'] diff --git a/shierfeng-fastapi-backend/cli/tui/actions/__init__.py b/shierfeng-fastapi-backend/cli/tui/actions/__init__.py new file mode 100644 index 0000000..5272c71 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/__init__.py @@ -0,0 +1,10 @@ +from cli.tui.actions.bootstrap import TUI_ACTION_EXECUTION_SERVICE, TUI_ACTION_PRESENTATION_SERVICE, TUI_ACTION_REGISTRY +from cli.tui.actions.models import TuiActionResult, TuiActionSpec + +__all__ = [ + 'TUI_ACTION_EXECUTION_SERVICE', + 'TUI_ACTION_PRESENTATION_SERVICE', + 'TUI_ACTION_REGISTRY', + 'TuiActionResult', + 'TuiActionSpec', +] diff --git a/shierfeng-fastapi-backend/cli/tui/actions/assembly.py b/shierfeng-fastapi-backend/cli/tui/actions/assembly.py new file mode 100644 index 0000000..1496f75 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/assembly.py @@ -0,0 +1,103 @@ +from dataclasses import dataclass + +from cli.tui.actions.builders import TuiActionSpecFactory +from cli.tui.actions.factories.cache import CacheActionTemplateFactory +from cli.tui.actions.factories.gen import GenActionTemplateFactory +from cli.tui.actions.factories.jobs import JobActionTemplateFactory +from cli.tui.actions.factories.static import StaticActionTemplateFactory +from cli.tui.actions.registry import TuiActionRegistry, TuiActionSlotResolver + + +@dataclass(frozen=True) +class TuiActionRegistryBuilder: + """ + TUI 动作注册表构建器。 + + 该对象负责装配各领域动作模板工厂,最终输出浏览页和详情页共用的 + 动作注册表,避免模板常量继续散落在模块底部。 + + :param jobs: 任务页动作模板工厂 + :param cache: 缓存页动作模板工厂 + :param gen: 代码生成页动作模板工厂 + :param static: 静态页面动作模板工厂 + :param spec_factory: 动作规格构建器 + """ + + jobs: JobActionTemplateFactory + cache: CacheActionTemplateFactory + gen: GenActionTemplateFactory + static: StaticActionTemplateFactory + spec_factory: TuiActionSpecFactory + + def build(self) -> TuiActionRegistry: + """ + 构建 TUI 动作注册表。 + + :return: 动作注册表 + """ + return TuiActionRegistry( + browser_resolvers={ + 'jobs': TuiActionSlotResolver( + slot_templates={ + 'primary': self.jobs.create_run_once_template(), + 'secondary': self.jobs.create_toggle_template(), + 'global': self.jobs.create_sync_template(), + }, + spec_factory=self.spec_factory, + ), + 'configs': TuiActionSlotResolver( + slot_templates={ + 'global': self.static.create_config_sync_template(), + }, + spec_factory=self.spec_factory, + ), + 'cache': TuiActionSlotResolver( + slot_templates={ + 'global': self.cache.create_clear_wizard_template(), + 'utility': self.cache.create_warmup_template(), + }, + spec_factory=self.spec_factory, + ), + 'gen': TuiActionSlotResolver( + slot_templates={ + 'primary': self.gen.create_export_wizard_template(), + 'secondary': self.gen.create_import_wizard_template(), + 'global': self.gen.create_export_dry_run_template(), + 'utility': self.gen.create_sync_db_template(), + }, + spec_factory=self.spec_factory, + ), + }, + detail_resolvers={ + 'app': TuiActionSlotResolver( + slot_templates={ + 'primary': self.static.create_app_run_template(), + 'global': self.static.create_app_run_wizard_template(), + 'utility': self.static.create_completion_install_template(), + }, + spec_factory=self.spec_factory, + ), + 'database': TuiActionSlotResolver( + slot_templates={ + 'global': self.static.create_db_upgrade_wizard_template(), + 'utility': self.static.create_db_init_dry_run_template(), + }, + spec_factory=self.spec_factory, + ), + 'ops': TuiActionSlotResolver( + slot_templates={ + 'primary': self.static.create_ops_ping_db_template(), + 'secondary': self.static.create_ops_ping_redis_template(), + 'global': self.static.create_prod_check_wizard_template(), + }, + spec_factory=self.spec_factory, + ), + 'crypto': TuiActionSlotResolver( + slot_templates={ + 'primary': self.static.create_crypto_keygen_template(), + 'global': self.static.create_crypto_rotate_dry_run_template(), + }, + spec_factory=self.spec_factory, + ), + }, + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/bootstrap.py b/shierfeng-fastapi-backend/cli/tui/actions/bootstrap.py new file mode 100644 index 0000000..a89c859 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/bootstrap.py @@ -0,0 +1,31 @@ +from cli.tui.actions.assembly import TuiActionRegistryBuilder +from cli.tui.actions.builders import TuiActionSpecFactory, TuiActionTemplateSupport +from cli.tui.actions.execution import TuiActionExecutionService +from cli.tui.actions.factories.cache import CacheActionTemplateFactory +from cli.tui.actions.factories.gen import GenActionTemplateFactory +from cli.tui.actions.factories.jobs import JobActionTemplateFactory +from cli.tui.actions.factories.static import StaticActionTemplateFactory +from cli.tui.actions.presentation import TuiActionPresentationService +from cli.tui.capabilities import TUI_CAPABILITY_REGISTRY + +_ACTION_SPEC_FACTORY = TuiActionSpecFactory() +TUI_ACTION_EXECUTION_SERVICE = TuiActionExecutionService() + +_ACTION_TEMPLATE_SUPPORT = TuiActionTemplateSupport(spec_factory=_ACTION_SPEC_FACTORY) +_JOB_ACTION_TEMPLATE_FACTORY = JobActionTemplateFactory(support=_ACTION_TEMPLATE_SUPPORT) +_CACHE_ACTION_TEMPLATE_FACTORY = CacheActionTemplateFactory(support=_ACTION_TEMPLATE_SUPPORT) +_GEN_ACTION_TEMPLATE_FACTORY = GenActionTemplateFactory(support=_ACTION_TEMPLATE_SUPPORT) +_STATIC_ACTION_TEMPLATE_FACTORY = StaticActionTemplateFactory(support=_ACTION_TEMPLATE_SUPPORT) +_ACTION_REGISTRY_BUILDER = TuiActionRegistryBuilder( + jobs=_JOB_ACTION_TEMPLATE_FACTORY, + cache=_CACHE_ACTION_TEMPLATE_FACTORY, + gen=_GEN_ACTION_TEMPLATE_FACTORY, + static=_STATIC_ACTION_TEMPLATE_FACTORY, + spec_factory=_ACTION_SPEC_FACTORY, +) +TUI_ACTION_REGISTRY = _ACTION_REGISTRY_BUILDER.build() + +TUI_ACTION_PRESENTATION_SERVICE = TuiActionPresentationService( + capability_registry=TUI_CAPABILITY_REGISTRY, + action_registry=TUI_ACTION_REGISTRY, +) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/builders.py b/shierfeng-fastapi-backend/cli/tui/actions/builders.py new file mode 100644 index 0000000..830a65d --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/builders.py @@ -0,0 +1,329 @@ +from __future__ import annotations + +from dataclasses import dataclass +from typing import TYPE_CHECKING + +from cli.tui.actions.models import ( + ActionCommandBuilder, + ActionExecutionMode, + ActionSummaryBuilder, + ActionTextBuilder, + TuiActionSpec, +) +from cli.tui.copy import TUI_COPY +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + +if TYPE_CHECKING: + from cli.tui.adapters.models import BrowserRecordSnapshot + + +@dataclass(frozen=True) +class TuiActionSpecFactory: + """ + TUI 动作规格构建器。 + + 该对象负责统一构建动作预览文本与 `TuiActionSpec`, + 避免各动作函数继续手工拼接重复的预览和规格对象。 + """ + + @staticmethod + def parse_record_suffix(record: BrowserRecordSnapshot, prefix: str) -> str: + """ + 从记录键中提取指定前缀后的标识。 + + :param record: 浏览记录 + :param prefix: 键名前缀 + :return: 后缀标识 + """ + raw_key = str(record.key).strip() + token_prefix = f'{prefix}:' + if not raw_key.startswith(token_prefix): + return '' + return raw_key[len(token_prefix) :].strip() + + def build_command_preview_lines( + self, + *, + env: str, + summary_lines: list[str], + command_args: tuple[str, ...], + append_yes: bool = True, + consequence_text: str = TUI_COPY.build_action_consequence_text('preview'), + ) -> list[str]: + """ + 构建统一的动作预览文本。 + + :param env: 当前运行环境 + :param summary_lines: 业务摘要文本 + :param command_args: 对应 CLI 命令参数 + :param consequence_text: 结果影响说明 + :return: 预览文本 + """ + nested_cli_arguments = [ + *command_args, + f'--env={env}', + '--output=json', + ] + if append_yes: + nested_cli_arguments.append('--yes') + command = SHELL_TEXT_FORMATTER.format_shell_command( + NESTED_CLI_SUPPORT.build_nested_cli_command(*nested_cli_arguments) + ) + return [ + TUI_COPY.build_action_preview_title('summary'), + *summary_lines, + '', + TUI_COPY.build_action_preview_title('env'), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('target_env'), env), + '', + TUI_COPY.build_action_preview_title('command'), + command, + '', + TUI_COPY.build_action_preview_title('consequence'), + consequence_text, + ] + + def build_external_command_preview_lines( + self, + *, + env: str, + summary_lines: list[str], + command_args: tuple[str, ...], + append_yes: bool = True, + consequence_text: str = TUI_COPY.build_action_consequence_text('wizard'), + ) -> list[str]: + """ + 构建外部交互命令的预览文本。 + + :param env: 当前运行环境 + :param summary_lines: 业务摘要文本 + :param command_args: 对应 CLI 命令参数 + :param consequence_text: 结果影响说明 + :return: 预览文本 + """ + return self.build_command_preview_lines( + env=env, + summary_lines=summary_lines, + command_args=command_args, + append_yes=append_yes, + consequence_text=consequence_text, + ) + + def build_nested_json_action( + self, + *, + action_id: str, + label: str, + command_args: tuple[str, ...], + env: str, + summary_lines: list[str], + preview_title: str | None = None, + consequence_text: str = TUI_COPY.build_action_consequence_text('preview'), + append_yes: bool = True, + refresh_view: bool = True, + ) -> TuiActionSpec: + """ + 构建标准 nested JSON 动作。 + + :param action_id: 动作唯一标识 + :param label: 动作显示名称 + :param command_args: 对应 CLI 命令参数 + :param env: 当前运行环境 + :param summary_lines: 业务摘要文本 + :param preview_title: 预览标题 + :param consequence_text: 结果影响说明 + :param refresh_view: 执行后是否刷新视图 + :return: 动作定义 + """ + return TuiActionSpec( + action_id=action_id, + label=label, + command_args=command_args, + preview_title=preview_title or label, + preview_lines=self.build_command_preview_lines( + env=env, + summary_lines=summary_lines, + command_args=command_args, + append_yes=append_yes, + consequence_text=consequence_text, + ), + append_yes=append_yes, + refresh_view=refresh_view, + ) + + def build_external_action( + self, + *, + action_id: str, + label: str, + command_args: tuple[str, ...], + env: str, + summary_lines: list[str], + preview_title: str | None = None, + consequence_text: str = TUI_COPY.build_action_consequence_text('wizard'), + append_yes: bool = True, + refresh_view: bool = True, + ) -> TuiActionSpec: + """ + 构建标准外部交互动作。 + + :param action_id: 动作唯一标识 + :param label: 动作显示名称 + :param command_args: 对应 CLI 命令参数 + :param env: 当前运行环境 + :param summary_lines: 业务摘要文本 + :param preview_title: 预览标题 + :param consequence_text: 结果影响说明 + :param refresh_view: 执行后是否刷新视图 + :return: 动作定义 + """ + return TuiActionSpec( + action_id=action_id, + label=label, + command_args=command_args, + preview_title=preview_title or label, + preview_lines=self.build_external_command_preview_lines( + env=env, + summary_lines=summary_lines, + command_args=command_args, + append_yes=append_yes, + consequence_text=consequence_text, + ), + execution_mode='external', + append_yes=append_yes, + refresh_view=refresh_view, + ) + + +@dataclass(frozen=True) +class TuiActionTemplate: + """ + TUI 动作模板。 + + 该模板将命令参数构建、摘要构建与执行模式收敛为统一对象, + 使动作注册层可以直接声明“某个槽位对应哪类动作”。 + + :param action_id: 动作唯一标识 + :param label: 动作显示名称 + :param command_builder: 命令参数构建器 + :param summary_builder: 预览摘要构建器 + :param action_id_builder: 动态动作标识构建器 + :param label_builder: 动态动作标题构建器 + :param preview_title: 预览标题 + :param consequence_text: 结果影响说明 + :param execution_mode: 执行模式 + :param append_yes: 是否在命令执行与预览中自动追加 `--yes` + :param refresh_view: 执行后是否刷新视图 + :param preview_env_override: 预览中展示的环境名覆盖值 + """ + + action_id: str + label: str + command_builder: ActionCommandBuilder + summary_builder: ActionSummaryBuilder + action_id_builder: ActionTextBuilder | None = None + label_builder: ActionTextBuilder | None = None + preview_title: str | None = None + consequence_text: str = TUI_COPY.build_action_consequence_text('preview') + execution_mode: ActionExecutionMode = 'nested_json' + append_yes: bool = True + refresh_view: bool = True + preview_env_override: str | None = None + + def build( + self, + *, + record: BrowserRecordSnapshot | None, + env: str, + spec_factory: TuiActionSpecFactory, + ) -> TuiActionSpec | None: + """ + 根据当前页面上下文构建动作定义。 + + :param record: 当前选中记录 + :param env: 当前运行环境 + :param spec_factory: 动作规格构建器 + :return: 动作定义 + """ + command_args = self.command_builder(record, env) + if command_args is None: + return None + preview_env = self.preview_env_override or env + summary_lines = self.summary_builder(record, env) + action_id = self.action_id_builder(record, env) if self.action_id_builder is not None else self.action_id + label = self.label_builder(record, env) if self.label_builder is not None else self.label + if self.execution_mode == 'external': + return spec_factory.build_external_action( + action_id=action_id, + label=label, + command_args=command_args, + env=preview_env, + summary_lines=summary_lines, + preview_title=self.preview_title, + consequence_text=self.consequence_text, + append_yes=self.append_yes, + refresh_view=self.refresh_view, + ) + return spec_factory.build_nested_json_action( + action_id=action_id, + label=label, + command_args=command_args, + env=preview_env, + summary_lines=summary_lines, + preview_title=self.preview_title, + consequence_text=self.consequence_text, + append_yes=self.append_yes, + refresh_view=self.refresh_view, + ) + + +@dataclass(frozen=True) +class TuiActionTemplateSupport: + """ + TUI 动作模板共享构建支持。 + + 该对象集中封装多个动作模板都会复用的记录解析与摘要拼装逻辑, + 避免这些基础能力继续散落在模块级函数中。 + + :param spec_factory: 动作规格构建器 + """ + + spec_factory: TuiActionSpecFactory + + def build_scope_purpose_summary(self, scope: str, purpose: str) -> list[str]: + """ + 构建通用的作用范围与目的摘要。 + + :param scope: 作用范围说明 + :param purpose: 目的说明 + :return: 预览摘要 + """ + return [ + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('scope'), scope), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('purpose'), purpose), + ] + + def extract_job_id(self, record: BrowserRecordSnapshot | None) -> str | None: + """ + 从任务记录中提取任务 ID。 + + :param record: 当前记录 + :return: 任务 ID + """ + if record is None: + return None + job_id = self.spec_factory.parse_record_suffix(record, 'job') + return job_id if job_id.isdigit() else None + + @staticmethod + def require_record_title(record: BrowserRecordSnapshot | None) -> str | None: + """ + 提取记录标题作为命令目标。 + + :param record: 当前记录 + :return: 标题文本 + """ + if record is None: + return None + title = str(record.title).strip() + return title or None diff --git a/shierfeng-fastapi-backend/cli/tui/actions/execution.py b/shierfeng-fastapi-backend/cli/tui/actions/execution.py new file mode 100644 index 0000000..cb15a63 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/execution.py @@ -0,0 +1,121 @@ +from dataclasses import dataclass + +from cli.tui.actions.models import TuiActionResult, TuiActionSpec +from cli.tui.copy import TUI_COPY +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class TuiActionExecutionService: + """ + TUI 动作执行服务。 + + 该对象负责统一封装 nested JSON 动作、外部交互动作 + 与结果文本行的收口逻辑。 + """ + + def execute(self, spec: TuiActionSpec, env: str) -> TuiActionResult: + """ + 执行指定 TUI 动作。 + + :param spec: 动作定义 + :param env: 当前运行环境 + :return: 动作执行结果 + """ + command_arguments = [ + *spec.command_args, + f'--env={env}', + '--output=json', + ] + if spec.append_yes: + command_arguments.append('--yes') + payload = NESTED_CLI_SUPPORT.run(*command_arguments, parse_json=True).payload + return TuiActionResult(spec=spec, payload=payload) + + def execute_external(self, spec: TuiActionSpec) -> TuiActionResult: + """ + 在当前终端中执行交互式 TUI 动作。 + + :param spec: 动作定义 + :return: 动作执行结果 + """ + completed = NESTED_CLI_SUPPORT.run_live(*spec.command_args) + if completed.returncode == 0: + message = '外部交互命令已执行完成' + else: + message = f'外部交互命令执行失败,退出码 {completed.returncode}' + return TuiActionResult( + spec=spec, + external_exit_code=completed.returncode, + external_message=message, + ) + + def build_result_lines(self, result: TuiActionResult) -> list[str]: + """ + 构建动作结果详情文本。 + + :param result: 动作执行结果 + :return: 结果文本行 + """ + payload = result.payload if isinstance(result.payload, dict) else {} + lines = [ + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('name'), + result.spec.label, + ), + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('outcome'), + TUI_COPY.build_action_result_field_label('success') + if result.ok + else TUI_COPY.build_action_result_field_label('fail'), + ), + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('summary'), + SHELL_TEXT_FORMATTER.truncate_text(result.message, 88), + ), + ] + service_message = str(payload.get('serviceMessage', '') or '').strip() + if service_message: + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('service'), + SHELL_TEXT_FORMATTER.truncate_text(service_message, 88), + ) + ) + if payload.get('hint'): + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('hint'), + SHELL_TEXT_FORMATTER.truncate_text(str(payload.get('hint', '') or ''), 88), + ) + ) + if payload.get('count') is not None: + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('count'), + str(payload.get('count')), + ) + ) + if payload.get('jobId') is not None: + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('job_id'), + str(payload.get('jobId')), + ) + ) + if result.external_exit_code is not None: + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('exit_code'), + str(result.external_exit_code), + ) + ) + operation_label = str(payload.get('operationLabel', '') or '').strip() + if operation_label and operation_label != result.spec.label: + lines.append( + TUI_COPY.build_action_result_message_line( + TUI_COPY.build_action_result_field_label('operation'), + SHELL_TEXT_FORMATTER.truncate_text(operation_label, 64), + ) + ) + return lines diff --git a/shierfeng-fastapi-backend/cli/tui/actions/factories/__init__.py b/shierfeng-fastapi-backend/cli/tui/actions/factories/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/tui/actions/factories/cache.py b/shierfeng-fastapi-backend/cli/tui/actions/factories/cache.py new file mode 100644 index 0000000..293b301 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/factories/cache.py @@ -0,0 +1,83 @@ +from dataclasses import dataclass + +from cli.tui.actions.builders import TuiActionTemplate, TuiActionTemplateSupport +from cli.tui.adapters.models import BrowserRecordSnapshot +from cli.tui.copy import TUI_COPY + + +@dataclass(frozen=True) +class CacheActionTemplateFactory: + """ + 缓存页动作模板工厂。 + + 该对象负责生成缓存浏览页相关动作模板,统一缓存清理向导和预热动作 + 的命令与预览摘要构建。 + + :param support: 动作模板共享构建支持 + """ + + support: TuiActionTemplateSupport + + def build_clear_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建缓存清理向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + cache_name = record.title if record is not None else '' + return ( + 'wizard', + 'cache-clear', + '--output=text', + f'--default-env={env}', + '--default-mode=cache-name', + f'--default-cache-name={cache_name}', + '--default-dry-run', + ) + + def build_clear_summary(self, record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建缓存清理向导摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del record, env + return self.support.build_scope_purpose_summary( + '当前环境缓存清理流程', + '进入向导后确认缓存名、键前缀和 dry-run 范围', + ) + + def create_warmup_template(self) -> TuiActionTemplate: + """ + 创建缓存预热动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='cache-warmup', + label=TUI_COPY.build_action_label('cache_warmup'), + command_builder=lambda record, env: ('cache', 'warmup'), + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('cache_warmup'), + TUI_COPY.build_action_purpose_label('cache_warmup'), + ), + ) + + def create_clear_wizard_template(self) -> TuiActionTemplate: + """ + 创建缓存清理向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-cache-clear', + label=TUI_COPY.build_action_label('cache_clear_wizard'), + command_builder=self.build_clear_command, + summary_builder=self.build_clear_summary, + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/factories/gen.py b/shierfeng-fastapi-backend/cli/tui/actions/factories/gen.py new file mode 100644 index 0000000..40bd68b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/factories/gen.py @@ -0,0 +1,254 @@ +from dataclasses import dataclass + +from cli.tui.actions.builders import TuiActionTemplate, TuiActionTemplateSupport +from cli.tui.adapters.models import BrowserRecordSnapshot +from cli.tui.copy import TUI_COPY + + +@dataclass(frozen=True) +class GenActionTemplateFactory: + """ + 代码生成页动作模板工厂。 + + 该对象负责生成代码生成浏览页相关动作模板,统一记录标题提取、 + 导出导入向导和表结构同步动作的构建逻辑。 + + :param support: 动作模板共享构建支持 + """ + + support: TuiActionTemplateSupport + + def build_export_wizard_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建代码生成导出向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + table_name = self.support.require_record_title(record) + if table_name is None: + return None + return ( + 'wizard', + 'gen-export', + '--output=text', + f'--default-env={env}', + f'--default-table-names={table_name}', + '--default-mode=zip', + '--default-dry-run', + ) + + def build_import_wizard_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建代码生成导入向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + table_name = self.support.require_record_title(record) + if table_name is None: + return None + return ( + 'wizard', + 'gen-import', + '--output=text', + f'--default-env={env}', + f'--default-table-names={table_name}', + '--default-dry-run', + ) + + def build_export_dry_run_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建代码生成导出 dry-run 命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del env + table_name = self.support.require_record_title(record) + if table_name is None: + return None + return ('gen', 'export', table_name, '--dry-run', '--mode=zip') + + def build_sync_db_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建代码生成表结构同步命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del env + table_name = self.support.require_record_title(record) + if table_name is None: + return None + return ('gen', 'sync-db', table_name) + + @staticmethod + def build_export_wizard_summary(record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建代码生成导出向导摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + return [ + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('scope'), f'当前业务表 {record.title}' + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('purpose'), + '进入向导后选择业务表、输出目录和覆盖策略', + ), + ] + + @staticmethod + def build_import_wizard_summary(record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建代码生成导入向导摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + return [ + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('scope'), f'当前物理表 {record.title}' + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('purpose'), + '进入向导后确认物理表列表,并先执行 dry-run 导入预演', + ), + ] + + @staticmethod + def build_export_dry_run_summary(record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建代码生成导出预演摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + return [ + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('scope'), + TUI_COPY.build_action_scope_label('gen_export_dry_run'), + ), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job'), record.title), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('purpose'), + TUI_COPY.build_action_purpose_label('gen_export_dry_run'), + ), + ] + + @staticmethod + def build_sync_db_summary(record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建代码生成表结构同步摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + return [ + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('scope'), + TUI_COPY.build_action_scope_label('gen_sync_db'), + ), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job'), record.title), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('purpose'), + TUI_COPY.build_action_purpose_label('gen_sync_db'), + ), + ] + + def create_export_wizard_template(self) -> TuiActionTemplate: + """ + 创建代码生成导出向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-gen-export', + label=TUI_COPY.build_action_label('gen_export_wizard'), + command_builder=self.build_export_wizard_command, + summary_builder=self.build_export_wizard_summary, + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + refresh_view=False, + ) + + def create_import_wizard_template(self) -> TuiActionTemplate: + """ + 创建代码生成导入向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-gen-import', + label=TUI_COPY.build_action_label('gen_import_wizard'), + command_builder=self.build_import_wizard_command, + summary_builder=self.build_import_wizard_summary, + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + refresh_view=False, + ) + + def create_export_dry_run_template(self) -> TuiActionTemplate: + """ + 创建代码生成导出预演动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='gen-export-dry-run', + label=TUI_COPY.build_action_label('gen_export_dry_run'), + command_builder=self.build_export_dry_run_command, + summary_builder=self.build_export_dry_run_summary, + ) + + def create_sync_db_template(self) -> TuiActionTemplate: + """ + 创建代码生成表结构同步动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='gen-sync-db', + label=TUI_COPY.build_action_label('gen_sync_db'), + command_builder=self.build_sync_db_command, + summary_builder=self.build_sync_db_summary, + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/factories/jobs.py b/shierfeng-fastapi-backend/cli/tui/actions/factories/jobs.py new file mode 100644 index 0000000..1e5032f --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/factories/jobs.py @@ -0,0 +1,171 @@ +from dataclasses import dataclass + +from cli.tui.actions.builders import TuiActionTemplate, TuiActionTemplateSupport +from cli.tui.adapters.models import BrowserRecordSnapshot +from cli.tui.copy import TUI_COPY + + +@dataclass(frozen=True) +class JobActionTemplateFactory: + """ + 任务页动作模板工厂。 + + 该对象负责生成任务浏览页相关动作模板,收口任务 ID 解析、 + 暂停/恢复切换和摘要拼装逻辑。 + + :param support: 动作模板共享构建支持 + """ + + support: TuiActionTemplateSupport + + def build_run_once_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建任务执行一次命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del env + job_id = self.support.extract_job_id(record) + if job_id is None: + return None + return ('job', 'run-once', job_id) + + def build_run_once_summary(self, record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建任务执行一次动作摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + job_id = self.support.extract_job_id(record) or '' + return [ + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job'), record.title), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job_id'), job_id), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + ] + + def build_toggle_command(self, record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...] | None: + """ + 构建任务暂停或恢复命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del env + if record is None: + return None + job_id = self.support.extract_job_id(record) + if job_id is None: + return None + if record.status == 'warn': + return ('job', 'resume', job_id) + return ('job', 'pause', job_id) + + def build_toggle_summary(self, record: BrowserRecordSnapshot | None, env: str) -> list[str]: + """ + 构建任务暂停或恢复动作摘要。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 预览摘要 + """ + del env + if record is None: + return [] + job_id = self.support.extract_job_id(record) or '' + label = ( + TUI_COPY.build_action_label('job_resume') + if record.status == 'warn' + else TUI_COPY.build_action_label('job_pause') + ) + return [ + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job'), record.title), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('job_id'), job_id), + TUI_COPY.build_labeled_value_line( + TUI_COPY.build_action_preview_field_label('current_status'), + record.summary, + ), + TUI_COPY.build_labeled_value_line(TUI_COPY.build_action_preview_field_label('target_action'), label), + ] + + @staticmethod + def build_toggle_action_id(record: BrowserRecordSnapshot | None, env: str) -> str: + """ + 构建任务暂停或恢复动作标识。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 动作标识 + """ + del env + if record is not None and record.status == 'warn': + return 'job-resume' + return 'job-pause' + + @staticmethod + def build_toggle_label(record: BrowserRecordSnapshot | None, env: str) -> str: + """ + 构建任务暂停或恢复动作标题。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 动作标题 + """ + del env + if record is not None and record.status == 'warn': + return TUI_COPY.build_action_label('job_resume') + return TUI_COPY.build_action_label('job_pause') + + def create_run_once_template(self) -> TuiActionTemplate: + """ + 创建任务执行一次动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='job-run-once', + label=TUI_COPY.build_action_label('job_run_once'), + command_builder=self.build_run_once_command, + summary_builder=self.build_run_once_summary, + ) + + def create_toggle_template(self) -> TuiActionTemplate: + """ + 创建任务暂停或恢复动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='job-toggle', + label=TUI_COPY.build_action_label('job_pause'), + command_builder=self.build_toggle_command, + summary_builder=self.build_toggle_summary, + action_id_builder=self.build_toggle_action_id, + label_builder=self.build_toggle_label, + ) + + def create_sync_template(self) -> TuiActionTemplate: + """ + 创建任务同步动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='job-sync', + label=TUI_COPY.build_action_label('job_sync'), + command_builder=lambda record, env: ('job', 'sync'), + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('job_sync'), + TUI_COPY.build_action_purpose_label('job_sync'), + ), + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/factories/static.py b/shierfeng-fastapi-backend/cli/tui/actions/factories/static.py new file mode 100644 index 0000000..ba51ace --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/factories/static.py @@ -0,0 +1,385 @@ +from dataclasses import dataclass + +from cli.tui.actions.builders import TuiActionTemplate, TuiActionTemplateSupport +from cli.tui.adapters.models import BrowserRecordSnapshot +from cli.tui.copy import TUI_COPY + + +@dataclass(frozen=True) +class StaticActionTemplateFactory: + """ + 静态页面动作模板工厂。 + + 该对象负责生成不依赖当前记录内容的页面动作模板,统一详情页和 + 部分浏览页的固定动作定义。 + + :param support: 动作模板共享构建支持 + """ + + support: TuiActionTemplateSupport + + @staticmethod + def build_job_sync_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建任务同步命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('job', 'sync') + + @staticmethod + def build_config_sync_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建配置同步命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('config', 'sync-cache') + + @staticmethod + def build_cache_warmup_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建缓存预热命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('cache', 'warmup') + + @staticmethod + def build_db_upgrade_wizard_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建数据库升级向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record + return ( + 'wizard', + 'db-upgrade', + '--output=text', + f'--default-env={env}', + '--default-revision=head', + '--default-dry-run', + ) + + @staticmethod + def build_db_init_dry_run_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建数据库初始化预演命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('db', 'init', '--dry-run') + + @staticmethod + def build_app_run_wizard_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建应用启动向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('wizard', 'app-run') + + @staticmethod + def build_completion_install_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建补全安装命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('completion', 'install', '--activate') + + @staticmethod + def build_prod_check_wizard_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建生产巡检向导命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record + return ( + 'wizard', + 'prod-check', + '--output=text', + f'--default-env={env}', + '--default-include-config', + ) + + @staticmethod + def build_crypto_rotate_dry_run_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建加密轮换预演命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('crypto', 'rotate', '--dry-run') + + @staticmethod + def build_app_run_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建应用直接启动命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record + return ('app', 'run', f'--env={env}') + + @staticmethod + def build_crypto_keygen_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建加密密钥生成命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record + return ('crypto', 'keygen', f'--env={env}', '--output=text') + + @staticmethod + def build_ops_ping_db_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建数据库探活命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('ops', 'ping-db') + + @staticmethod + def build_ops_ping_redis_command(record: BrowserRecordSnapshot | None, env: str) -> tuple[str, ...]: + """ + 构建 Redis 探活命令参数。 + + :param record: 当前记录 + :param env: 当前运行环境 + :return: 命令参数 + """ + del record, env + return ('ops', 'ping-redis') + + def create_config_sync_template(self) -> TuiActionTemplate: + """ + 创建配置同步动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='config-sync-cache', + label=TUI_COPY.build_action_label('config_sync'), + command_builder=self.build_config_sync_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('config_sync'), + TUI_COPY.build_action_purpose_label('config_sync'), + ), + ) + + def create_db_upgrade_wizard_template(self) -> TuiActionTemplate: + """ + 创建数据库升级向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-db-upgrade', + label=TUI_COPY.build_action_label('db_upgrade_wizard'), + command_builder=self.build_db_upgrade_wizard_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境数据库升级流程', + '进入向导后确认目标 revision、环境和 dry-run 预演', + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + ) + + def create_db_init_dry_run_template(self) -> TuiActionTemplate: + """ + 创建数据库初始化预演动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='db-init-dry-run', + label=TUI_COPY.build_action_label('db_init_dry_run'), + command_builder=self.build_db_init_dry_run_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('db_init_dry_run'), + TUI_COPY.build_action_purpose_label('db_init_dry_run'), + ), + append_yes=False, + ) + + def create_app_run_wizard_template(self) -> TuiActionTemplate: + """ + 创建应用启动向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-app-run', + label=TUI_COPY.build_action_label('app_run_wizard'), + command_builder=self.build_app_run_wizard_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境应用启动流程', + '进入向导后确认环境,并决定是否先执行启动前检查', + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + refresh_view=False, + ) + + def create_completion_install_template(self) -> TuiActionTemplate: + """ + 创建补全安装动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='completion-install', + label=TUI_COPY.build_action_label('completion_install'), + command_builder=self.build_completion_install_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('completion_install'), + TUI_COPY.build_action_purpose_label('completion_install'), + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('external'), + refresh_view=False, + preview_env_override='-', + ) + + def create_prod_check_wizard_template(self) -> TuiActionTemplate: + """ + 创建生产巡检向导动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='wizard-prod-check', + label=TUI_COPY.build_action_label('prod_check_wizard'), + command_builder=self.build_prod_check_wizard_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境生产巡检流程', + '进入向导后统一检查数据库、缓存和运行配置', + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + ) + + def create_crypto_rotate_dry_run_template(self) -> TuiActionTemplate: + """ + 创建加密轮换预演动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='crypto-rotate-dry-run', + label=TUI_COPY.build_action_label('crypto_rotate_dry_run'), + command_builder=self.build_crypto_rotate_dry_run_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境传输加密轮换预演', + '仅生成轮换辅助结果,不直接写入新密钥配置', + ), + append_yes=False, + ) + + def create_app_run_template(self) -> TuiActionTemplate: + """ + 创建应用直接启动动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='app-run', + label=TUI_COPY.build_action_label('app_run'), + command_builder=self.build_app_run_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境应用直接启动流程', + '确认后会在当前终端直接启动当前 FastAPI 应用,并持续占用终端会话', + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + refresh_view=False, + ) + + def create_crypto_keygen_template(self) -> TuiActionTemplate: + """ + 创建密钥生成动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='crypto-keygen', + label=TUI_COPY.build_action_label('crypto_keygen'), + command_builder=self.build_crypto_keygen_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + '当前环境新密钥生成流程', + '在终端中直接输出新密钥材料和环境变量补丁建议', + ), + execution_mode='external', + consequence_text=TUI_COPY.build_action_consequence_text('wizard'), + refresh_view=False, + ) + + def create_ops_ping_db_template(self) -> TuiActionTemplate: + """ + 创建数据库探活动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='ops-ping-db', + label=TUI_COPY.build_action_label('ops_ping_db'), + command_builder=self.build_ops_ping_db_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('ops_ping_db'), + TUI_COPY.build_action_purpose_label('ops_ping_db'), + ), + append_yes=False, + ) + + def create_ops_ping_redis_template(self) -> TuiActionTemplate: + """ + 创建 Redis 探活动作模板。 + + :return: 动作模板 + """ + return TuiActionTemplate( + action_id='ops-ping-redis', + label=TUI_COPY.build_action_label('ops_ping_redis'), + command_builder=self.build_ops_ping_redis_command, + summary_builder=lambda record, env: self.support.build_scope_purpose_summary( + TUI_COPY.build_action_scope_label('ops_ping_redis'), + TUI_COPY.build_action_purpose_label('ops_ping_redis'), + ), + append_yes=False, + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/models.py b/shierfeng-fastapi-backend/cli/tui/actions/models.py new file mode 100644 index 0000000..621bd5e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/models.py @@ -0,0 +1,72 @@ +from collections.abc import Callable +from dataclasses import dataclass +from typing import Literal + +from cli.tui.adapters.models import TUI_ADAPTER_MODEL_RENDERER, BrowserRecordSnapshot + +ActionSlot = Literal['primary', 'secondary', 'global', 'utility'] +ActionExecutionMode = Literal['nested_json', 'external'] +ActionCommandBuilder = Callable[[BrowserRecordSnapshot | None, str], tuple[str, ...] | None] +ActionSummaryBuilder = Callable[[BrowserRecordSnapshot | None, str], list[str]] +ActionTextBuilder = Callable[[BrowserRecordSnapshot | None, str], str] + + +@dataclass(frozen=True) +class TuiActionSpec: + """ + TUI 低风险动作定义。 + + :param action_id: 动作唯一标识 + :param label: 动作显示名称 + :param command_args: 对应 CLI 命令参数 + :param preview_title: 预览弹窗标题 + :param preview_lines: 预览摘要文本 + :param append_yes: 执行 nested JSON 动作时是否自动追加 `--yes` + :param refresh_view: 执行完成后是否刷新当前页面 + """ + + action_id: str + label: str + command_args: tuple[str, ...] + preview_title: str + preview_lines: list[str] + execution_mode: ActionExecutionMode = 'nested_json' + append_yes: bool = True + refresh_view: bool = True + + +@dataclass(frozen=True) +class TuiActionResult: + """ + TUI 动作执行结果。 + + :param spec: 动作定义 + :param payload: CLI JSON 负载 + """ + + spec: TuiActionSpec + payload: dict[str, object] | None = None + external_exit_code: int | None = None + external_message: str | None = None + + @property + def ok(self) -> bool: + """ + 判断动作是否执行成功。 + + :return: 是否成功 + """ + if self.external_exit_code is not None: + return self.external_exit_code == 0 + return bool(isinstance(self.payload, dict) and self.payload.get('ok', False)) + + @property + def message(self) -> str: + """ + 获取动作结果摘要。 + + :return: 结果摘要 + """ + if self.external_message is not None: + return self.external_message + return TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(self.payload) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/presentation.py b/shierfeng-fastapi-backend/cli/tui/actions/presentation.py new file mode 100644 index 0000000..e4cd232 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/presentation.py @@ -0,0 +1,110 @@ +from dataclasses import dataclass + +from cli.tui.actions.models import TuiActionResult +from cli.tui.actions.registry import TuiActionRegistry +from cli.tui.adapters.models import BrowserRecordSnapshot +from cli.tui.capabilities import TuiCapabilityRegistry +from cli.tui.copy import TUI_COPY +from cli.tui.keymaps import TUI_KEYMAP_REGISTRY +from cli.utils import SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class TuiActionPresentationService: + """ + TUI 动作展示服务。 + + 该对象负责动作提示、动作列表和动作结果通知等展示层文本构建, + 避免继续保留模块级桥接函数。 + """ + + capability_registry: TuiCapabilityRegistry + action_registry: TuiActionRegistry + + def build_browser_action_hint(self, view_key: str) -> str: + """ + 构建浏览页动作提示文本。 + + :param view_key: 当前页面视图标识 + :return: 动作提示文本 + """ + capability_labels = [ + f'[{capability.key}] {capability.hint_label}' + for capability in self.capability_registry.get_browser_capabilities(view_key) + ] + interaction_text = TUI_COPY.build_browser_action_hint_text( + view_key, TUI_KEYMAP_REGISTRY.browser_interaction_hint + ) + return TUI_COPY.build_capability_hint_text( + capability_labels, + interaction_text, + fallback='{interaction_hint}', + ) + + def build_detail_action_hint(self, view_key: str) -> str: + """ + 构建详情页动作提示文本。 + + :param view_key: 当前页面视图标识 + :return: 动作提示文本 + """ + capability_labels = [ + f'[{capability.key}] {capability.hint_label}' + for capability in self.capability_registry.get_detail_capabilities(view_key) + ] + interaction_text = TUI_COPY.build_detail_action_hint_text( + view_key, TUI_KEYMAP_REGISTRY.browser_interaction_hint + ) + return TUI_COPY.build_capability_hint_text( + capability_labels, + interaction_text, + fallback='{interaction_hint}', + ) + + def build_browser_action_lines( + self, + *, + view_key: str, + record: BrowserRecordSnapshot | None, + env: str, + ) -> list[str]: + """ + 构建当前页面可执行动作列表。 + + :param view_key: 当前页面视图标识 + :param record: 当前选中记录 + :param env: 当前运行环境 + :return: 动作文本行 + """ + lines: list[str] = [] + for capability in self.capability_registry.get_browser_capabilities(view_key): + slot = capability.slot # type: ignore[assignment] + action = self.action_registry.resolve_browser_action( + view_key=view_key, + slot=slot, + record=record, + env=env, + ) + if action is None: + continue + lines.append(TUI_COPY.build_action_line(capability.key, action.label)) + return lines or [TUI_COPY.build_action_empty_line()] + + @staticmethod + def build_action_result_message(result: TuiActionResult) -> str: + """ + 构建动作执行结果通知文本。 + + :param result: 动作执行结果 + :return: 通知文本 + """ + outcome = ( + TUI_COPY.build_action_result_field_label('success') + if result.ok + else TUI_COPY.build_action_result_field_label('fail') + ) + return TUI_COPY.build_action_result_toast( + result.spec.label, + outcome, + SHELL_TEXT_FORMATTER.truncate_text(result.message, 72), + ) diff --git a/shierfeng-fastapi-backend/cli/tui/actions/registry.py b/shierfeng-fastapi-backend/cli/tui/actions/registry.py new file mode 100644 index 0000000..90534e2 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/actions/registry.py @@ -0,0 +1,103 @@ +from __future__ import annotations + +from dataclasses import dataclass +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from cli.tui.actions.builders import TuiActionSpecFactory, TuiActionTemplate + from cli.tui.actions.models import ActionSlot, TuiActionSpec + from cli.tui.adapters.models import BrowserRecordSnapshot + + +@dataclass(frozen=True) +class TuiActionRegistry: + """ + TUI 动作注册表。 + + 该注册表负责集中维护浏览页和详情页的动作解析器,从而将 + 原本散落的条件分发收敛为可声明的映射关系。 + + :param browser_resolvers: 浏览页动作槽位解析器映射 + :param detail_resolvers: 详情页动作槽位解析器映射 + """ + + browser_resolvers: dict[str, TuiActionSlotResolver] + detail_resolvers: dict[str, TuiActionSlotResolver] + + def resolve_browser_action( + self, + *, + view_key: str, + slot: ActionSlot, + record: BrowserRecordSnapshot | None, + env: str, + ) -> TuiActionSpec | None: + """ + 解析浏览页动作。 + + :param view_key: 当前页面视图标识 + :param slot: 动作槽位 + :param record: 当前选中记录 + :param env: 当前运行环境 + :return: 动作定义 + """ + resolver = self.browser_resolvers.get(view_key) + if resolver is None: + return None + return resolver.resolve(slot=slot, record=record, env=env) + + def resolve_detail_action( + self, + *, + view_key: str, + slot: ActionSlot, + env: str, + ) -> TuiActionSpec | None: + """ + 解析详情页动作。 + + :param view_key: 当前页面视图标识 + :param slot: 动作槽位 + :param env: 当前运行环境 + :return: 动作定义 + """ + resolver = self.detail_resolvers.get(view_key) + if resolver is None: + return None + return resolver.resolve(slot=slot, record=None, env=env) + + +@dataclass(frozen=True) +class TuiActionSlotResolver: + """ + TUI 动作槽位解析器。 + + 该对象将一个页面支持的槽位动作集中定义为映射关系,避免继续在 + `resolve_*_action` 中堆叠条件分支。 + + :param slot_templates: 槽位到动作模板的映射 + :param spec_factory: 动作规格构建器 + """ + + slot_templates: dict[ActionSlot, TuiActionTemplate] + spec_factory: TuiActionSpecFactory + + def resolve( + self, + *, + slot: ActionSlot, + record: BrowserRecordSnapshot | None, + env: str, + ) -> TuiActionSpec | None: + """ + 解析指定槽位的动作定义。 + + :param slot: 动作槽位 + :param record: 当前选中记录 + :param env: 当前运行环境 + :return: 动作定义 + """ + template = self.slot_templates.get(slot) + if template is None: + return None + return template.build(record=record, env=env, spec_factory=self.spec_factory) diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/__init__.py b/shierfeng-fastapi-backend/cli/tui/adapters/__init__.py new file mode 100644 index 0000000..55d1882 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/__init__.py @@ -0,0 +1,98 @@ +from collections.abc import Callable +from dataclasses import dataclass + +from cli.tui.adapters.app import APP_DETAIL_ADAPTER as _APP_DETAIL_ADAPTER +from cli.tui.adapters.cache import CACHE_BROWSER_ADAPTER as _CACHE_BROWSER_ADAPTER +from cli.tui.adapters.configs import CONFIGS_BROWSER_ADAPTER as _CONFIGS_BROWSER_ADAPTER +from cli.tui.adapters.crypto import CRYPTO_DETAIL_ADAPTER as _CRYPTO_DETAIL_ADAPTER +from cli.tui.adapters.database import DATABASE_DETAIL_ADAPTER as _DATABASE_DETAIL_ADAPTER +from cli.tui.adapters.gen import GEN_BROWSER_ADAPTER as _GEN_BROWSER_ADAPTER +from cli.tui.adapters.health import ( + DASHBOARD_ADAPTER as _DASHBOARD_ADAPTER, +) +from cli.tui.adapters.health import DashboardPanelSnapshot, DashboardSnapshot +from cli.tui.adapters.jobs import JOBS_BROWSER_ADAPTER as _JOBS_BROWSER_ADAPTER +from cli.tui.adapters.models import ( + BrowserPageSnapshot, + BrowserRecordSnapshot, + DetailPageSnapshot, + DetailSectionSnapshot, +) +from cli.tui.adapters.ops import OPS_DETAIL_ADAPTER as _OPS_DETAIL_ADAPTER + +PageSnapshot = BrowserPageSnapshot | DashboardSnapshot | DetailPageSnapshot +SnapshotCollector = Callable[..., PageSnapshot] + + +@dataclass(frozen=True) +class TuiSnapshotCollectorRegistry: + """ + TUI 页面快照采集注册表。 + + 该对象集中维护页面视图标识与其采集函数之间的映射, + 使应用层和测试层可以通过统一入口发现当前可用的采集器。 + + :param collectors: 视图到采集函数的映射 + """ + + collectors: dict[str, SnapshotCollector] + + @staticmethod + def normalize_view_key(view_key: str) -> str: + """ + 规范化页面视图标识。 + + :param view_key: 原始页面视图标识 + :return: 规范化后的视图标识 + """ + return str(view_key).strip().lower() + + def get_collector(self, view_key: str) -> SnapshotCollector | None: + """ + 读取指定视图的快照采集器。 + + :param view_key: 页面视图标识 + :return: 采集函数 + """ + return self.collectors.get(self.normalize_view_key(view_key)) + + def collect(self, view_key: str, *args, **kwargs) -> PageSnapshot: + """ + 调用指定视图的快照采集器。 + + :param view_key: 页面视图标识 + :param args: 位置参数 + :param kwargs: 关键字参数 + :return: 页面快照 + :raises KeyError: 当视图未注册时抛出 + """ + collector = self.get_collector(view_key) + if collector is None: + raise KeyError(self.normalize_view_key(view_key)) + return collector(*args, **kwargs) + + +TUI_SNAPSHOT_COLLECTOR_REGISTRY = TuiSnapshotCollectorRegistry( + collectors={ + 'dashboard': _DASHBOARD_ADAPTER.collect_snapshot, + 'app': _APP_DETAIL_ADAPTER.collect_snapshot, + 'ops': _OPS_DETAIL_ADAPTER.collect_snapshot, + 'database': _DATABASE_DETAIL_ADAPTER.collect_snapshot, + 'cache': _CACHE_BROWSER_ADAPTER.collect_snapshot, + 'jobs': _JOBS_BROWSER_ADAPTER.collect_snapshot, + 'gen': _GEN_BROWSER_ADAPTER.collect_snapshot, + 'configs': _CONFIGS_BROWSER_ADAPTER.collect_snapshot, + 'crypto': _CRYPTO_DETAIL_ADAPTER.collect_snapshot, + } +) + +__all__ = [ + 'TUI_SNAPSHOT_COLLECTOR_REGISTRY', + 'BrowserPageSnapshot', + 'BrowserRecordSnapshot', + 'DashboardPanelSnapshot', + 'DashboardSnapshot', + 'DetailPageSnapshot', + 'DetailSectionSnapshot', + 'TuiSnapshotCollectorRegistry', +] diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/app.py b/shierfeng-fastapi-backend/cli/tui/adapters/app.py new file mode 100644 index 0000000..217ca23 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/app.py @@ -0,0 +1,680 @@ +from dataclasses import dataclass +from typing import Any + +from cli.tui.adapters.base import BaseDetailAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + DetailPageSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + +COMPLETION_PREVIEW_LINE_LIMIT = 12 + + +@dataclass(frozen=True) +class AppDetailSourcePayloads: + """ + 应用详情页原始数据源快照。 + + :param env_payload: `app env` 结果 + :param config_payload: `app config` 结果 + :param doctor_payload: `app doctor` 结果 + :param routes_payload: `app routes` 结果 + :param completion_payload: `completion doctor` 结果 + :param completion_preview_result: `completion show` 命令结果 + :param preview_shell: 当前补全脚本预览 shell + """ + + env_payload: dict[str, Any] | None + config_payload: dict[str, Any] | None + doctor_payload: dict[str, Any] | None + routes_payload: dict[str, Any] | None + completion_payload: dict[str, Any] | None + completion_preview_result: Any + preview_shell: str + + +class AppDetailSnapshotCollector: + """ + 应用详情页数据采集器。 + + 该对象负责拉取应用详情页所需的多路 CLI 原始结果, + 让 `AppDetailAdapter` 保持详情页编排职责。 + + :param section_builder: 应用详情分区构建器 + """ + + def __init__(self, section_builder: 'AppSectionBuilder') -> None: + """ + 初始化应用详情页数据采集器。 + + :param section_builder: 应用详情分区构建器 + :return: None + """ + self.section_builder = section_builder + + def collect(self, env: str) -> AppDetailSourcePayloads: + """ + 采集应用详情页所需原始结果。 + + :param env: 当前运行环境 + :return: 应用详情页原始数据源快照 + """ + env_payload = NESTED_CLI_SUPPORT.run( + 'app', + 'env', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + config_payload = NESTED_CLI_SUPPORT.run( + 'app', + 'config', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + doctor_payload = NESTED_CLI_SUPPORT.run( + 'app', + 'doctor', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + routes_payload = NESTED_CLI_SUPPORT.run( + 'app', + 'routes', + f'--env={env}', + '--group-by=tag', + '--output=json', + parse_json=True, + ).payload + completion_payload = NESTED_CLI_SUPPORT.run( + 'completion', + 'doctor', + '--output=json', + parse_json=True, + ).payload + preview_shell = self.section_builder.resolve_completion_preview_shell(completion_payload) + completion_preview_result = NESTED_CLI_SUPPORT.run('completion', 'show', preview_shell) + return AppDetailSourcePayloads( + env_payload=env_payload, + config_payload=config_payload, + doctor_payload=doctor_payload, + routes_payload=routes_payload, + completion_payload=completion_payload, + completion_preview_result=completion_preview_result, + preview_shell=preview_shell, + ) + + +class AppSectionBuilder: + """ + 应用详情分区构建器。 + + 该构建器负责将应用、补全和路由相关 CLI 结果转换为 TUI 详情页分区, + 使详情页适配器本体只保留采集与编排职责。 + """ + + @staticmethod + def resolve_completion_preview_shell(payload: dict[str, Any] | None) -> str: + """ + 解析补全脚本预览应使用的 shell。 + + :param payload: `completion doctor` JSON 负载 + :return: shell 名称 + """ + if not isinstance(payload, dict): + return 'bash' + active_shell = str(payload.get('activeShell') or '').strip().lower() + shells = payload.get('shells') if isinstance(payload.get('shells'), dict) else {} + if active_shell and isinstance(shells.get(active_shell), dict) and shells[active_shell].get('supported', False): + return active_shell + for shell_name in ('bash', 'zsh', 'fish', 'powershell'): + shell_payload = shells.get(shell_name) + if isinstance(shell_payload, dict) and shell_payload.get('supported', False): + return shell_name + return 'bash' + + @staticmethod + def build_env_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建应用环境解析分区。 + + :param payload: `app env` JSON 负载 + :return: 分区快照 + """ + runtime = payload.get('runtime') if isinstance(payload, dict) else None + if not isinstance(runtime, dict): + return DetailSectionSnapshot( + title='环境解析', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='环境信息', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='环境解析', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 环境映射', + f'CLI 目标环境: {runtime.get("cliEnv", "-")}', + f'配置模块环境: {runtime.get("configEnv", "-")}', + f'进程环境变量: {runtime.get("appEnv", "-") or "-"}', + '', + '## 文件与进程', + f'环境文件: {runtime.get("envFile", "-")}', + f'环境文件存在: {"是" if runtime.get("envFileExists", False) else "否"}', + f'后端目录: {SHELL_TEXT_FORMATTER.truncate_text(runtime.get("backendDir", "-"), 64)}', + f'Python 可执行文件: {SHELL_TEXT_FORMATTER.truncate_text(runtime.get("pythonExecutable", "-"), 64)}', + ], + ) + + @staticmethod + def build_config_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建应用基础配置分区。 + + :param payload: `app config` JSON 负载 + :return: 分区快照 + """ + config = payload.get('config') if isinstance(payload, dict) else None + if not isinstance(config, dict): + return DetailSectionSnapshot( + title='应用配置', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='应用配置', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='应用配置', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 应用入口', + f'应用名称: {SHELL_TEXT_FORMATTER.truncate_text(config.get("name", "-"), 40)}', + f'监听地址: {config.get("host", "-")}:{config.get("port", "-")}', + f'根路径: {config.get("rootPath", "-") or "/"}', + f'工作进程: {config.get("workers", "-")}', + f'热重载: {"开启" if config.get("reload", False) else "关闭"}', + '', + '## 文档与日志', + f'Swagger: {"关闭" if config.get("disableSwagger", False) else "开启"}', + f'ReDoc: {"关闭" if config.get("disableRedoc", False) else "开启"}', + f'日志级别: {config.get("logLevel", "-")}', + ], + ) + + @staticmethod + def build_dependency_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建应用依赖配置分区。 + + :param payload: `app config` JSON 负载 + :return: 分区快照 + """ + config = payload.get('config') if isinstance(payload, dict) else None + if not isinstance(config, dict): + return DetailSectionSnapshot( + title='依赖配置', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='依赖配置', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='依赖配置', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 数据库', + f'类型: {config.get("dbType", "-")}', + f'地址: {config.get("dbHost", "-")}:{config.get("dbPort", "-")}', + f'数据库名: {config.get("dbDatabase", "-")}', + '', + '## Redis 与加密', + f'Redis 地址: {config.get("redisHost", "-")}:{config.get("redisPort", "-")}', + f'传输加密: {"开启" if config.get("transportCryptoEnabled", False) else "关闭"}', + f'加密模式: {config.get("transportCryptoMode", "-")}', + ], + ) + + def build_routes_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建应用路由摘要分区。 + + :param payload: `app routes` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='路由摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='路由', empty_value='不可用'), + ) + + count = payload.get('count', 0) + routes = payload.get('routes') if isinstance(payload.get('routes'), list) else [] + grouped_routes = payload.get('groupedRoutes') if isinstance(payload.get('groupedRoutes'), dict) else {} + group_items = sorted( + ((str(tag), len(items) if isinstance(items, list) else 0) for tag, items in grouped_routes.items()), + key=lambda item: (-item[1], item[0]), + ) + + lines = [ + '## 路由规模', + f'总路由数: {count}', + f'标签分组数: {len(group_items)}', + '', + '## 主要标签', + ] + if group_items: + lines.extend(f'> {tag} · {size} 条' for tag, size in group_items[:6]) + else: + lines.append('> 暂无标签分组数据') + + if routes: + lines.extend(['', '## 路由样本']) + for route in routes[:6]: + if not isinstance(route, dict): + continue + methods = '/'.join(route.get('methods', [])) if isinstance(route.get('methods'), list) else '-' + lines.extend( + [ + f'> [{methods or "-"}] {SHELL_TEXT_FORMATTER.truncate_text(route.get("path", "-"), 48)}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(route.get("summary", "-") or "-", 48)}', + ] + ) + else: + lines.extend( + [ + '', + *TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='路由样本', + empty_value='0 条', + detail='当前环境未返回可展示的路由样本', + suggestion=TUI_COPY.build_refresh_page_suggestion('应用', '确认当前环境是否已完成路由注册'), + ), + ] + ) + + return DetailSectionSnapshot( + title='路由摘要', + status='ok', + lines=lines, + ) + + @staticmethod + def build_completion_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建 shell completion 诊断分区。 + + :param payload: `completion doctor` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='补全诊断', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='补全诊断', empty_value='不可用' + ), + ) + + shells = payload.get('shells') if isinstance(payload.get('shells'), dict) else {} + active_shell = str(payload.get('activeShell') or '-') + env_choices = payload.get('envChoices') if isinstance(payload.get('envChoices'), list) else [] + active_shell_payload = shells.get(active_shell) if isinstance(shells.get(active_shell), dict) else None + target_file = active_shell_payload.get('targetFile', '-') if isinstance(active_shell_payload, dict) else '-' + source_command = ( + active_shell_payload.get('sourceCommand', '-') if isinstance(active_shell_payload, dict) else '-' + ) + install_command = ( + active_shell_payload.get('recommendedInstallCommand', '-') + if isinstance(active_shell_payload, dict) + else payload.get('recommendedInstallCommand', '-') + ) + + lines = [ + '## 当前环境', + f'活动 Shell: {active_shell}', + f'项目目录: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("projectDir", "-"), 64)}', + f'补全环境变量: {payload.get("completeEnvVar", "-")}', + f'环境候选数: {len(env_choices)}', + '', + '## 激活建议', + f'目标脚本: {SHELL_TEXT_FORMATTER.truncate_text(target_file, 64)}', + f'加载命令: {SHELL_TEXT_FORMATTER.truncate_text(source_command, 72)}', + f'推荐安装命令: {SHELL_TEXT_FORMATTER.truncate_text(install_command, 72)}', + ] + + shell_lines = [] + for shell_name in ('bash', 'zsh', 'fish', 'powershell'): + shell_payload = shells.get(shell_name) + if not isinstance(shell_payload, dict): + continue + supported = '支持' if shell_payload.get('supported', False) else '不支持' + detected = '当前 Shell' if shell_payload.get('detected', False) else '候选 Shell' + shell_lines.append(f'> {shell_name} · {supported} · {detected}') + if shell_lines: + lines.extend(['', '## Shell 支持']) + lines.extend(shell_lines) + + return DetailSectionSnapshot( + title='补全诊断', + status='ok', + lines=lines, + ) + + def build_completion_preview_section( + self, + shell: str, + preview_result: Any, + ) -> DetailSectionSnapshot: + """ + 构建补全脚本预览分区。 + + :param shell: 当前预览 shell + :param preview_result: `completion show` 调用结果 + :return: 分区快照 + """ + stdout = str(getattr(preview_result, 'stdout', '') or '').strip() + stderr = str(getattr(preview_result, 'stderr', '') or '').strip() + returncode = int(getattr(preview_result, 'returncode', 1) or 0) + if returncode != 0: + return DetailSectionSnapshot( + title='补全脚本预览', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + {'ok': False, 'message': stderr or stdout or '补全脚本生成失败'}, + empty_label='补全脚本', + empty_value='不可用', + ), + ) + preview_lines = [ + SHELL_TEXT_FORMATTER.truncate_text(line, 88) for line in stdout.splitlines()[:COMPLETION_PREVIEW_LINE_LIMIT] + ] + if not preview_lines: + return DetailSectionSnapshot( + title='补全脚本预览', + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='补全脚本', + empty_value='0 行', + detail='当前 shell 的补全脚本未返回可预览内容', + suggestion=TUI_COPY.build_refresh_page_suggestion('应用', '重新生成补全脚本预览'), + ), + ) + return DetailSectionSnapshot( + title='补全脚本预览', + status='ok', + lines=[ + '## 预览目标', + f'Shell: {shell}', + f'预览行数: {len(preview_lines)}', + '', + '## 脚本片段', + *preview_lines, + ], + ) + + @staticmethod + def build_doctor_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建应用启动前检查分区。 + + :param payload: `app doctor` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='启动前检查', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='启动前检查', empty_value='不可用' + ), + ) + + database = payload.get('database') if isinstance(payload.get('database'), dict) else {} + redis = payload.get('redis') if isinstance(payload.get('redis'), dict) else {} + crypto = payload.get('crypto') if isinstance(payload.get('crypto'), dict) else {} + return DetailSectionSnapshot( + title='启动前检查', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 检查结果', + f'环境: {payload.get("env", "-")}', + f'数据库: {"正常" if database.get("ok", False) else "异常"}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(database.get("message", "-"), 64)}', + f'Redis: {"正常" if redis.get("ok", False) else "异常"}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(redis.get("message", "-"), 64)}', + f'加密组件: {"正常" if crypto.get("ok", False) else "异常"}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(crypto.get("message", "-"), 64)}', + ], + ) + + @staticmethod + def build_run_entry_section() -> DetailSectionSnapshot: + """ + 构建应用启动向导入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='启动入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备启动当前环境应用时,可直接启动应用,或先通过向导确认目标环境与启动前检查选项。', + command=TUI_COPY.build_cli_command_hint('app', 'run', '--env=dev'), + guide='若需要先做启动前检查或切换环境,建议改用 `wizard app-run` 进入交互式启动流程。', + ), + ) + + @staticmethod + def build_completion_install_entry_section() -> DetailSectionSnapshot: + """ + 构建 shell 补全安装入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='补全安装入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备为当前 Shell 安装或修复补全脚本时,可直接执行补全安装命令,并按需把激活命令写入 rc 文件。', + command=TUI_COPY.build_cli_command_hint('completion', 'install', '--activate', '--output=text'), + guide='当前页面提供补全诊断与安装入口;执行安装后可返回补全诊断分区确认 target file 和 source command 是否更新。', + ), + ) + + @staticmethod + def build_overview_section( + env_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + routes_payload: dict[str, Any] | None, + completion_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建应用页总览判断分区。 + + :param env_payload: `app env` JSON 负载 + :param config_payload: `app config` JSON 负载 + :param doctor_payload: `app doctor` JSON 负载 + :param routes_payload: `app routes` JSON 负载 + :param completion_payload: `completion doctor` JSON 负载 + :return: 分区快照 + """ + env_ok = bool(isinstance(env_payload, dict) and env_payload.get('ok', False)) + config_ok = bool(isinstance(config_payload, dict) and config_payload.get('ok', False)) + doctor_ok = bool(isinstance(doctor_payload, dict) and doctor_payload.get('ok', False)) + routes_ok = bool(isinstance(routes_payload, dict) and routes_payload.get('ok', False)) + completion_ok = bool(isinstance(completion_payload, dict) and completion_payload.get('ok', False)) + route_count = routes_payload.get('count', 0) if isinstance(routes_payload, dict) else 0 + runtime = ( + env_payload.get('runtime') + if isinstance(env_payload, dict) and isinstance(env_payload.get('runtime'), dict) + else {} + ) + config = ( + config_payload.get('config') + if isinstance(config_payload, dict) and isinstance(config_payload.get('config'), dict) + else {} + ) + + status = 'ok' + conclusion = '应用基线正常,可继续查看环境映射、配置摘要与路由状态' + if not env_ok or not config_ok: + status = 'fail' + conclusion = '应用基础信息读取异常,优先确认环境映射与应用配置是否可用' + elif not doctor_ok: + status = 'fail' + conclusion = '启动前检查异常,优先确认数据库、Redis 和加密组件状态' + elif not completion_ok: + status = 'warn' + conclusion = '补全诊断读取异常,建议优先确认项目目录、Shell 类型和补全脚本状态' + elif not routes_ok: + status = 'warn' + conclusion = '路由摘要读取异常,建议先确认当前环境是否完成应用初始化' + elif int(route_count or 0) <= 0: + status = 'info' + conclusion = '当前未返回注册路由,建议检查路由注册流程与运行上下文' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'CLI 环境: {runtime.get("cliEnv", "-")}', + f'配置环境: {runtime.get("configEnv", "-")}', + f'监听地址: {config.get("host", "-")}:{config.get("port", "-")}', + f'注册路由: {route_count} 条', + f'启动前检查: {"正常" if doctor_ok else "异常"}', + f'传输加密: {"开启" if config.get("transportCryptoEnabled", False) else "关闭"}', + f'补全诊断: {"正常" if completion_ok else "异常"}', + '', + '## 建议入口', + '优先关注:环境解析 / 应用配置 / 启动前检查 / 补全诊断 / 路由摘要 / 启动入口', + ], + ) + + def build_sections( + self, + *, + env_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + routes_payload: dict[str, Any] | None, + completion_payload: dict[str, Any] | None, + completion_preview_result: Any, + preview_shell: str, + ) -> list[DetailSectionSnapshot]: + """ + 构建应用页全部详情分区。 + + :param env_payload: `app env` 结果负载 + :param config_payload: `app config` 结果负载 + :param doctor_payload: `app doctor` 结果负载 + :param routes_payload: `app routes` 结果负载 + :param completion_payload: `completion doctor` 结果负载 + :param completion_preview_result: `completion show` 命令结果 + :param preview_shell: 当前预览 shell + :return: 详情分区列表 + """ + return [ + self.build_overview_section( + env_payload, + config_payload, + doctor_payload, + routes_payload, + completion_payload, + ), + self.build_env_section(env_payload), + self.build_config_section(config_payload), + self.build_dependency_section(config_payload), + self.build_doctor_section(doctor_payload), + self.build_completion_section(completion_payload), + self.build_completion_preview_section(preview_shell, completion_preview_result), + self.build_completion_install_entry_section(), + self.build_routes_section(routes_payload), + self.build_run_entry_section(), + ] + + +class AppDetailAdapter(BaseDetailAdapter): + """ + 应用详情页适配器。 + + 该适配器负责采集应用相关 CLI 结果,并委托分区构建器组装为 + TUI 详情页快照。 + """ + + def __init__( + self, + section_builder: AppSectionBuilder | None = None, + snapshot_collector: AppDetailSnapshotCollector | None = None, + ) -> None: + """ + 初始化应用详情页适配器。 + + :param section_builder: 应用详情分区构建器 + :param snapshot_collector: 应用详情页数据采集器 + :return: None + """ + super().__init__( + page_title='应用', + search_view_key='app', + default_suggestions=[ + '总览判断', + '环境解析', + '应用配置', + '依赖配置', + '启动前检查', + '补全诊断', + '补全脚本预览', + '补全安装入口', + '路由摘要', + '启动入口', + ], + ) + self.section_builder = section_builder or AppSectionBuilder() + self.snapshot_collector = snapshot_collector or AppDetailSnapshotCollector(self.section_builder) + + def collect_snapshot(self, env: str, query: str = '') -> DetailPageSnapshot: + """ + 采集应用状态页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 页面快照 + """ + source_payloads = self.snapshot_collector.collect(env) + sections = self.section_builder.build_sections( + env_payload=source_payloads.env_payload, + config_payload=source_payloads.config_payload, + doctor_payload=source_payloads.doctor_payload, + routes_payload=source_payloads.routes_payload, + completion_payload=source_payloads.completion_payload, + completion_preview_result=source_payloads.completion_preview_result, + preview_shell=source_payloads.preview_shell, + ) + return DetailPageSnapshot( + title='应用', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_app_diagnostic_subtitle( + source_payloads.env_payload, + source_payloads.config_payload, + source_payloads.doctor_payload, + source_payloads.routes_payload, + source_payloads.completion_payload, + ), + sections=self.filter_sections(sections, query), + search=self.resolve_search_context(query), + ) + + +APP_DETAIL_ADAPTER = AppDetailAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/base.py b/shierfeng-fastapi-backend/cli/tui/adapters/base.py new file mode 100644 index 0000000..5e3308d --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/base.py @@ -0,0 +1,219 @@ +from collections.abc import Sequence +from typing import Any + +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + BrowserRecordSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.search import TUI_SEARCH_SERVICE, PageFilterOption, PageSearchContext +from cli.utils import SHELL_TEXT_FORMATTER + + +class BaseBrowserAdapter: + """ + TUI 浏览页适配基类。 + + :param page_title: 浏览页标题 + :param search_view_key: 搜索上下文对应的页面键 + :param filter_options: 页面支持的筛选项 + """ + + def __init__( + self, + *, + page_title: str, + search_view_key: str, + filter_options: Sequence[PageFilterOption], + ) -> None: + """ + 初始化浏览页适配基类。 + + :param page_title: 浏览页标题 + :param search_view_key: 搜索上下文对应的页面键 + :param filter_options: 页面支持的筛选项 + :return: None + """ + self.page_title = page_title + self.search_view_key = search_view_key + self.filter_options = tuple(filter_options) + + @staticmethod + def extract_page_rows(payload: dict[str, Any] | None) -> list[dict[str, Any]]: + """ + 从标准分页 JSON 负载中提取行数据。 + + :param payload: 标准分页结果负载 + :return: 行数据列表 + """ + page_payload = payload.get('page') if isinstance(payload, dict) else None + rows = page_payload.get('rows') if isinstance(page_payload, dict) else None + if not isinstance(rows, list): + return [] + return [row for row in rows if isinstance(row, dict)] + + def resolve_active_filter(self, filter_key: str) -> PageFilterOption: + """ + 解析当前激活筛选项。 + + :param filter_key: 筛选键 + :return: 已解析的筛选项 + """ + return TUI_SEARCH_SERVICE.resolve_filter_option(self.filter_options, filter_key) or self.filter_options[0] + + def resolve_search_context(self, query: str) -> PageSearchContext: + """ + 解析当前页面搜索上下文。 + + :param query: 搜索词 + :return: 搜索上下文 + """ + return TUI_SEARCH_SERVICE.resolve_search_context(self.search_view_key, query) + + def build_failure_record( + self, + *, + key: str, + subject: str, + section_subject: str, + payload: dict[str, Any] | None, + ) -> BrowserRecordSnapshot: + """ + 构建底层命令失败时的兜底记录。 + + :param key: 记录键 + :param subject: 页面主体名称 + :param section_subject: 失败分区名称 + :param payload: 失败结果负载 + :return: 浏览记录快照 + """ + return BrowserRecordSnapshot( + key=key, + title=TUI_COPY.build_unavailable_record_title(subject), + status='fail', + summary=SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(payload), 64), + metadata_lines=[], + detail_sections=[ + DetailSectionSnapshot( + title=TUI_COPY.build_load_failure_section_title(section_subject), + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label=section_subject, empty_value='不可用' + ), + ) + ], + ) + + def build_empty_record( + self, + *, + key: str, + subject: str, + empty_label: str, + has_source_rows: bool, + filtered_summary: str, + empty_summary: str, + filtered_empty_value: str, + empty_empty_value: str, + filtered_detail: str, + empty_detail: str, + ) -> BrowserRecordSnapshot: + """ + 构建当前页面没有可浏览记录时的空态记录。 + + :param key: 记录键 + :param subject: 记录主体名称 + :param empty_label: 空态主字段名称 + :param has_source_rows: 是否存在未筛选前的源数据 + :param filtered_summary: 有源数据但当前筛选无结果时的摘要 + :param empty_summary: 源数据本身为空时的摘要 + :param filtered_empty_value: 有源数据但当前筛选无结果时的空态值 + :param empty_empty_value: 源数据本身为空时的空态值 + :param filtered_detail: 有源数据但当前筛选无结果时的说明 + :param empty_detail: 源数据本身为空时的说明 + :return: 浏览记录快照 + """ + summary = filtered_summary if has_source_rows else empty_summary + empty_value = filtered_empty_value if has_source_rows else empty_empty_value + detail = filtered_detail if has_source_rows else empty_detail + return BrowserRecordSnapshot( + key=key, + title=TUI_COPY.build_empty_record_title(subject), + status='info', + summary=TUI_COPY.build_empty_record_summary(summary), + metadata_lines=[], + detail_sections=[ + DetailSectionSnapshot( + title=TUI_COPY.build_empty_record_title(subject), + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label=empty_label, + empty_value=empty_value, + detail=detail, + ), + ) + ], + ) + + @staticmethod + def extract_payload_message(payload: dict[str, object] | None) -> str: + """ + 提取结果负载中的可读消息。 + + :param payload: 标准结果负载 + :return: 摘要消息文本 + """ + return TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(payload) + + +class BaseDetailAdapter: + """ + TUI 详情页适配基类。 + + :param page_title: 详情页标题 + :param search_view_key: 搜索上下文对应的页面键 + :param default_suggestions: 默认搜索建议 + """ + + def __init__( + self, + *, + page_title: str, + search_view_key: str, + default_suggestions: Sequence[str], + ) -> None: + """ + 初始化详情页适配基类。 + + :param page_title: 详情页标题 + :param search_view_key: 搜索上下文对应的页面键 + :param default_suggestions: 默认搜索建议 + :return: None + """ + self.page_title = page_title + self.search_view_key = search_view_key + self.default_suggestions = tuple(default_suggestions) + + def filter_sections(self, sections: Sequence[DetailSectionSnapshot], query: str) -> list[DetailSectionSnapshot]: + """ + 按搜索词过滤详情分区列表。 + + :param sections: 原始详情分区列表 + :param query: 搜索词 + :return: 过滤后的分区列表 + """ + return TUI_SEARCH_SERVICE.filter_detail_sections(list(sections), query) # type: ignore[arg-type] + + def resolve_search_context(self, query: str) -> PageSearchContext: + """ + 解析当前详情页搜索上下文。 + + :param query: 搜索词 + :return: 搜索上下文 + """ + return TUI_SEARCH_SERVICE.resolve_search_context( + self.search_view_key, + query, + default_suggestions=list(self.default_suggestions), + ) diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/cache.py b/shierfeng-fastapi-backend/cli/tui/adapters/cache.py new file mode 100644 index 0000000..a3596be --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/cache.py @@ -0,0 +1,579 @@ +from typing import Any + +from cli.tui.adapters.base import BaseBrowserAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + BrowserPageSnapshot, + BrowserRecordSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +class CacheRowExtractor: + """ + 缓存浏览行提取器。 + + 该对象负责从缓存统计结果中提取缓存名称列表,供共享分区和记录构建 + 逻辑复用。 + """ + + @staticmethod + def extract_cache_name_rows(payload: dict[str, Any] | None) -> list[dict[str, Any]]: + """ + 从缓存统计结果中提取缓存名称列表。 + + :param payload: `cache stats` JSON 负载 + :return: 缓存名称行列表 + """ + if not isinstance(payload, dict): + return [] + cache_names = payload.get('cacheNames') + if not isinstance(cache_names, list): + return [] + rows: list[dict[str, Any]] = [] + for item in cache_names: + if isinstance(item, dict): + rows.append(item) + continue + if isinstance(item, str): + rows.append({'cacheName': item, 'remark': ''}) + return rows + + +class CacheSectionBuilder: + """ + 缓存浏览页分区构建器。 + + 该构建器负责构建缓存浏览页共享分区,以及单个缓存名前缀下的键摘要、 + 键列表和键详情分区。 + + :param page_adapter: 缓存浏览页适配器 + :param row_extractor: 缓存浏览行提取器 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + row_extractor: CacheRowExtractor | None = None, + ) -> None: + """ + 初始化缓存浏览页分区构建器。 + + :param page_adapter: 缓存浏览页适配器 + :param row_extractor: 缓存浏览行提取器 + :return: None + """ + self.page_adapter = page_adapter + self.row_extractor = row_extractor or CacheRowExtractor() + + def build_overview_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建缓存总览共享分区。 + + :param payload: `cache stats` JSON 负载 + :return: 分区快照 + """ + info = payload.get('info') if isinstance(payload, dict) and isinstance(payload.get('info'), dict) else {} + cache_rows = self.row_extractor.extract_cache_name_rows(payload) + return DetailSectionSnapshot( + title='Redis 摘要', + status='ok' if isinstance(payload, dict) and payload.get('ok', False) else 'fail', + lines=[ + '## 容量状态', + f'当前键数: {payload.get("dbSize", "-") if isinstance(payload, dict) else "-"}', + f'已登记缓存名: {len(cache_rows)} 个', + '', + '## 运行指标', + f'Redis 版本: {info.get("redis_version", "-")}', + f'客户端连接数: {info.get("connected_clients", "-")}', + f'内存占用: {info.get("used_memory_human", info.get("used_memory", "-"))}', + ], + ) + + def build_overview_judgement_section( + self, + payload: dict[str, Any] | None, + filtered_rows: list[dict[str, Any]], + ) -> DetailSectionSnapshot: + """ + 构建缓存页总览判断共享分区。 + + :param payload: `cache stats` JSON 负载 + :param filtered_rows: 当前筛选后的缓存名列表 + :return: 分区快照 + """ + info = payload.get('info') if isinstance(payload, dict) and isinstance(payload.get('info'), dict) else {} + cache_rows = self.row_extractor.extract_cache_name_rows(payload) + db_size = payload.get('dbSize', '-') if isinstance(payload, dict) else '-' + client_count = info.get('connected_clients', '-') + command_stats = payload.get('commandStats') if isinstance(payload, dict) else None + command_count = len(command_stats) if isinstance(command_stats, list) else 0 + + status = 'ok' + conclusion = '缓存基线正常,可继续查看键列表、键值样本与 TTL' + if not isinstance(payload, dict) or not payload.get('ok', False): + status = 'fail' + conclusion = '缓存状态读取失败,优先确认 Redis 连通性与运行环境' + elif not cache_rows: + status = 'info' + conclusion = '当前没有登记的缓存名前缀,可先核对缓存配置与实际键空间' + elif not filtered_rows: + status = 'info' + conclusion = '当前搜索条件没有命中缓存名前缀,可调整关键字后继续排查' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'已登记缓存名: {len(cache_rows)} 个', + f'当前匹配: {len(filtered_rows)} 个', + f'Redis 键数: {db_size}', + f'客户端连接数: {client_count}', + f'命令统计样本: {command_count} 组', + '', + '## 建议入口', + '优先关注:Redis 摘要 / 命令统计 / 键值样本 / TTL', + ], + ) + + def build_top_commands_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建缓存命令统计共享分区。 + + :param payload: `cache stats` JSON 负载 + :return: 分区快照 + """ + command_stats = payload.get('commandStats') if isinstance(payload, dict) else None + lines = TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='命令统计', + empty_value='暂无数据', + detail='当前 Redis 运行快照中未返回命令统计样本', + ) + section_status = 'info' + if isinstance(command_stats, list) and command_stats: + section_status = 'ok' + lines = [ + f'{item.get("name", "-")} · {item.get("value", 0)} 次' + for item in command_stats[:8] + if isinstance(item, dict) + ] + return DetailSectionSnapshot( + title='命令统计', + status=section_status if isinstance(payload, dict) and payload.get('ok', False) else 'fail', + lines=lines, + ) + + @staticmethod + def build_cache_clear_entry_section() -> DetailSectionSnapshot: + """ + 构建缓存清理向导入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='缓存清理入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='当缓存命中异常、键数量失控,或需要按缓存名和前缀清理时,应先通过向导确认影响范围。', + command=TUI_COPY.build_cli_command_hint('wizard', 'cache-clear', '--output=text'), + guide='向导会继续询问环境、缓存名、键前缀和 dry-run 选项,确认后再执行实际清理。', + ), + ) + + def build_keys_summary_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建缓存键摘要分区。 + + :param payload: `cache keys` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='键摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='键摘要', empty_value='不可用' + ), + ) + keys = payload.get('keys') if isinstance(payload.get('keys'), list) else [] + rendered_keys = [str(item).strip() for item in keys if str(item).strip()] + lines = [ + '## 统计', + f'缓存名: {payload.get("cacheName", "-")}', + f'键数量: {payload.get("count", len(rendered_keys))}', + ] + if rendered_keys: + lines.extend( + ['', '## 键样本', *[f'> {SHELL_TEXT_FORMATTER.truncate_text(item, 64)}' for item in rendered_keys[:5]]] + ) + else: + lines.extend(['', '## 键样本', '> 当前缓存名前缀下没有键']) + return DetailSectionSnapshot( + title='键摘要', + status='ok', + lines=lines, + ) + + def build_keys_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建缓存键列表分区。 + + :param payload: `cache keys` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='键列表', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='键列表', empty_value='不可用' + ), + ) + keys = payload.get('keys') if isinstance(payload.get('keys'), list) else [] + lines = [ + SHELL_TEXT_FORMATTER.truncate_text(item, 88) for item in keys[:12] if str(item).strip() + ] or TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='缓存键', + empty_value='0 个', + detail='当前缓存名前缀下没有可展示的缓存键', + ) + return DetailSectionSnapshot( + title='键列表', + status='ok', + lines=lines, + ) + + def render_ttl_text(self, payload: dict[str, Any] | None) -> str: + """ + 渲染缓存 TTL 文本。 + + :param payload: `cache ttl` JSON 负载 + :return: TTL 文本 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return SHELL_TEXT_FORMATTER.truncate_text(self.page_adapter.extract_payload_message(payload), 56) + ttl_seconds = payload.get('ttlSeconds', '-') + if payload.get('persistent', False): + return '永久' + if payload.get('expires', False): + return f'{ttl_seconds} 秒' + return str(ttl_seconds) + + def build_key_detail_sections( + self, + cache_name: str, + key_items: list[str], + env: str, + ) -> list[DetailSectionSnapshot]: + """ + 构建按缓存键展开的详情分区。 + + :param cache_name: 缓存名称 + :param key_items: 缓存键列表 + :param env: 当前运行环境 + :return: 分区快照列表 + """ + if not key_items: + return [] + + sections: list[DetailSectionSnapshot] = [] + for cache_key in key_items[:5]: + value_payload = NESTED_CLI_SUPPORT.run( + 'cache', + 'get', + cache_name, + cache_key, + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + ttl_payload = NESTED_CLI_SUPPORT.run( + 'cache', + 'ttl', + cache_name, + cache_key, + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + + value_ok = isinstance(value_payload, dict) and value_payload.get('ok', False) + ttl_ok = isinstance(ttl_payload, dict) and ttl_payload.get('ok', False) + if value_ok and ttl_ok: + section_status = 'ok' + elif value_ok or ttl_ok: + section_status = 'warn' + else: + section_status = 'fail' + + cache_value = ( + '' if not value_ok or value_payload.get('cacheValue') is None else str(value_payload.get('cacheValue')) + ) + preview_lines = cache_value.splitlines()[:6] + ttl_text = self.render_ttl_text(ttl_payload) + lines = [ + '## 键信息', + f'缓存名: {cache_name}', + f'缓存键: {SHELL_TEXT_FORMATTER.truncate_text(cache_key, 72)}', + f'TTL: {ttl_text}', + '', + '## 值预览', + ] + if value_ok: + lines.extend( + [f'> {SHELL_TEXT_FORMATTER.truncate_text(line, 72)}' for line in preview_lines] + if preview_lines + else ['> -'] + ) + else: + lines.append( + f'> {SHELL_TEXT_FORMATTER.truncate_text(self.page_adapter.extract_payload_message(value_payload), 72)}' + ) + if not ttl_ok: + lines.extend( + [ + '', + '## TTL 结果', + f'> {SHELL_TEXT_FORMATTER.truncate_text(self.page_adapter.extract_payload_message(ttl_payload), 72)}', + ] + ) + sections.append( + DetailSectionSnapshot( + title=f'键详情 · {SHELL_TEXT_FORMATTER.truncate_text(cache_key, 28)}', + status=section_status, + lines=lines, + ) + ) + return sections + + def load_cache_detail_sections( + self, + cache_row: dict[str, Any], + env: str, + ) -> list[DetailSectionSnapshot]: + """ + 按需加载单个缓存名称的详情分区。 + + :param cache_row: 缓存名称行数据 + :param env: 当前运行环境 + :return: 详情分区列表 + """ + cache_name = str(cache_row.get('cacheName', '-') or '-') + keys_payload = NESTED_CLI_SUPPORT.run( + 'cache', + 'keys', + cache_name, + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + key_items: list[str] = [] + if isinstance(keys_payload, dict) and keys_payload.get('ok', False): + raw_keys = keys_payload.get('keys') if isinstance(keys_payload.get('keys'), list) else [] + key_items = [str(item).strip() for item in raw_keys if str(item).strip()] + return [ + self.build_keys_summary_section(keys_payload), + self.build_keys_section(keys_payload), + *self.build_key_detail_sections(cache_name, key_items, env), + ] + + def build_shared_sections( + self, + payload: dict[str, Any] | None, + filtered_rows: list[dict[str, Any]], + ) -> list[DetailSectionSnapshot]: + """ + 构建缓存浏览页共享分区。 + + :param payload: `cache stats` 结果负载 + :param filtered_rows: 当前筛选后的缓存名列表 + :return: 共享分区列表 + """ + return [ + self.build_overview_judgement_section(payload, filtered_rows), + self.build_overview_section(payload), + self.build_top_commands_section(payload), + self.build_cache_clear_entry_section(), + ] + + +class CacheRecordBuilder: + """ + 缓存浏览记录构建器。 + + 该对象负责构建缓存页单条浏览记录与失败兜底记录。 + + :param page_adapter: 缓存浏览页适配器 + :param section_builder: 缓存浏览页分区构建器 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + section_builder: CacheSectionBuilder, + ) -> None: + """ + 初始化缓存浏览记录构建器。 + + :param page_adapter: 缓存浏览页适配器 + :param section_builder: 缓存浏览页分区构建器 + :return: None + """ + self.page_adapter = page_adapter + self.section_builder = section_builder + + def build_record(self, cache_row: dict[str, Any], env: str) -> BrowserRecordSnapshot: + """ + 构建单条缓存浏览记录。 + + :param cache_row: 缓存名称行数据 + :param env: 当前运行环境 + :return: 浏览记录快照 + """ + cache_name = str(cache_row.get('cacheName', '-') or '-') + remark = str(cache_row.get('remark', '') or '').strip() + return BrowserRecordSnapshot( + key=f'cache:{cache_name}', + title=SHELL_TEXT_FORMATTER.truncate_text(cache_name, 40), + status='ok', + summary=SHELL_TEXT_FORMATTER.truncate_text(remark or '查看当前缓存名前缀下的键、值样本和过期时间', 64), + metadata_lines=[ + '## 缓存身份', + f'缓存名称: {cache_name}', + f'用途说明: {SHELL_TEXT_FORMATTER.truncate_text(remark or "-", 64)}', + ], + detail_sections=[], + detail_loader=lambda cache_row=cache_row, env=env: self.section_builder.load_cache_detail_sections( + cache_row, env + ), + ) + + def build_failure_record(self, payload: dict[str, Any] | None) -> BrowserRecordSnapshot: + """ + 构建缓存页失败兜底记录。 + + :param payload: 失败结果负载 + :return: 浏览记录快照 + """ + return self.page_adapter.build_failure_record( + key='cache:unavailable', + subject='缓存', + section_subject='缓存状态', + payload=payload, + ) + + +class CacheBrowserAdapter(BaseBrowserAdapter): + """ + 缓存浏览页适配器。 + + 该适配器负责采集 Redis 统计和缓存名前缀列表,并委托协作对象构建 + 共享分区、单条记录与键详情分区。 + """ + + def __init__( + self, + row_extractor: CacheRowExtractor | None = None, + section_builder: CacheSectionBuilder | None = None, + record_builder: CacheRecordBuilder | None = None, + ) -> None: + """ + 初始化缓存浏览页适配器。 + + :param row_extractor: 缓存浏览行提取器 + :param section_builder: 缓存浏览页分区构建器 + :param record_builder: 缓存浏览记录构建器 + :return: None + """ + super().__init__( + page_title='缓存', + search_view_key='cache', + filter_options=(), + ) + self.row_extractor = row_extractor or CacheRowExtractor() + self.section_builder = section_builder or CacheSectionBuilder(self, self.row_extractor) + self.record_builder = record_builder or CacheRecordBuilder(self, self.section_builder) + + @staticmethod + def apply_cache_query(rows: list[dict[str, Any]], query: str) -> list[dict[str, Any]]: + """ + 按缓存名或备注查询词过滤缓存行数据。 + + :param rows: 原始缓存行列表 + :param query: 当前搜索词 + :return: 过滤后的缓存行列表 + """ + normalized_query = str(query).strip().lower() + if not normalized_query: + return rows + return [ + row + for row in rows + if normalized_query in str(row.get('cacheName', '') or '').strip().lower() + or normalized_query in str(row.get('remark', '') or '').strip().lower() + ] + + def collect_snapshot(self, env: str, query: str = '') -> BrowserPageSnapshot: + """ + 采集缓存浏览页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 浏览页快照 + """ + search_context = self.resolve_search_context(query) + payload = NESTED_CLI_SUPPORT.run( + 'cache', + 'stats', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + cache_rows = self.row_extractor.extract_cache_name_rows(payload) + filtered_rows = self.apply_cache_query(cache_rows, query) + shared_sections = self.section_builder.build_shared_sections(payload, filtered_rows) + if not isinstance(payload, dict) or not payload.get('ok', False): + return BrowserPageSnapshot( + title='缓存', + subtitle=TUI_COPY.build_unavailable_subtitle( + '缓存状态', + SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(payload), 72), + ), + records=[self.record_builder.build_failure_record(payload)], + shared_sections=shared_sections, + search=search_context, + ) + + records = [self.record_builder.build_record(cache_row, env) for cache_row in filtered_rows[:12]] + if not records: + records = [ + self.build_empty_record( + key='cache:none', + subject='缓存名', + empty_label='缓存名前缀', + has_source_rows=bool(cache_rows), + filtered_summary='当前搜索条件下没有匹配缓存名前缀', + empty_summary='当前运行环境没有登记可浏览的缓存名前缀', + filtered_empty_value='暂无匹配', + empty_empty_value='暂无登记', + filtered_detail='当前搜索条件下没有匹配缓存名前缀', + empty_detail='当前运行环境没有登记可浏览的缓存名前缀', + ) + ] + return BrowserPageSnapshot( + title='缓存', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_cache_diagnostic_subtitle(payload, len(filtered_rows)), + records=records, + shared_sections=shared_sections, + search=search_context, + ) + + +CACHE_BROWSER_ADAPTER = CacheBrowserAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/configs.py b/shierfeng-fastapi-backend/cli/tui/adapters/configs.py new file mode 100644 index 0000000..63710da --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/configs.py @@ -0,0 +1,760 @@ +from typing import Any + +from cli.tui.adapters.base import BaseBrowserAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + BrowserPageSnapshot, + BrowserRecordSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.tui.search import CONFIG_FILTER_OPTIONS +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + +CONFIG_RISK_PRIORITY = { + 'mismatch': 0, + 'missing-cache': 1, + 'orphan-cache': 2, + 'normal': 3, +} + +CONFIG_RISK_LABELS = { + 'mismatch': '值不一致', + 'missing-cache': '缓存缺失', + 'orphan-cache': '缓存孤立', + 'normal': '正常', +} + +CONFIG_RISK_STATUSES = { + 'mismatch': 'fail', + 'missing-cache': 'warn', + 'orphan-cache': 'warn', + 'normal': 'ok', +} + + +class ConfigRiskSupport: + """ + 参数配置风险分类支持对象。 + + 该对象负责从巡检结果提取风险集合、解析单项风险分类,以及执行 + 风险排序和筛选逻辑,供浏览页分区和记录构建复用。 + """ + + @staticmethod + def extract_config_issue_keys(payload: dict[str, Any] | None, field_name: str) -> set[str]: + """ + 从配置巡检结果中提取指定风险字段对应的配置键集合。 + + :param payload: `config doctor` JSON 负载 + :param field_name: 风险字段名 + :return: 配置键集合 + """ + items = payload.get(field_name) if isinstance(payload, dict) else None + if not isinstance(items, list): + return set() + return {item.strip() for item in items if isinstance(item, str) and item.strip()} + + def build_config_risk_sets(self, payload: dict[str, Any] | None) -> dict[str, set[str]]: + """ + 构建配置风险分类集合。 + + :param payload: `config doctor` JSON 负载 + :return: 按风险分类聚合的配置键集合 + """ + return { + 'mismatch': self.extract_config_issue_keys(payload, 'mismatchKeys'), + 'missing-cache': self.extract_config_issue_keys(payload, 'missingInCache'), + 'orphan-cache': self.extract_config_issue_keys(payload, 'orphanInCache'), + } + + @staticmethod + def resolve_config_risk_key(config_key: str, risk_sets: dict[str, set[str]]) -> str: + """ + 解析单个配置项的风险分类。 + + :param config_key: 配置键 + :param risk_sets: 风险集合 + :return: 风险分类键 + """ + normalized_key = str(config_key).strip() + if normalized_key in risk_sets.get('mismatch', set()): + return 'mismatch' + if normalized_key in risk_sets.get('missing-cache', set()): + return 'missing-cache' + if normalized_key in risk_sets.get('orphan-cache', set()): + return 'orphan-cache' + return 'normal' + + def build_config_sort_key( + self, + config_row: dict[str, Any], + risk_sets: dict[str, set[str]], + ) -> tuple[int, str]: + """ + 构建配置列表排序键。 + + :param config_row: 配置项行数据 + :param risk_sets: 风险集合 + :return: 排序键 + """ + config_key = str(config_row.get('configKey', '') or '').strip() + risk_key = self.resolve_config_risk_key(config_key, risk_sets) + return (CONFIG_RISK_PRIORITY.get(risk_key, 99), config_key) + + def apply_config_filter( + self, + rows: list[dict[str, Any]], + risk_sets: dict[str, set[str]], + filter_key: str, + ) -> list[dict[str, Any]]: + """ + 按筛选键过滤配置行数据。 + + :param rows: 原始配置行列表 + :param risk_sets: 风险集合 + :param filter_key: 当前筛选键 + :return: 过滤后的配置行列表 + """ + normalized_filter = str(filter_key).strip().lower() + if normalized_filter == 'risky': + return [ + row + for row in rows + if self.resolve_config_risk_key(str(row.get('configKey', '') or ''), risk_sets) != 'normal' + ] + if normalized_filter == 'mismatch': + return [ + row + for row in rows + if self.resolve_config_risk_key(str(row.get('configKey', '') or ''), risk_sets) == 'mismatch' + ] + if normalized_filter == 'cache-drift': + return [ + row + for row in rows + if self.resolve_config_risk_key(str(row.get('configKey', '') or ''), risk_sets) + in {'missing-cache', 'orphan-cache'} + ] + return rows + + @staticmethod + def apply_config_query(rows: list[dict[str, Any]], query: str) -> list[dict[str, Any]]: + """ + 按配置键或配置名称查询词过滤配置行数据。 + + :param rows: 原始配置行列表 + :param query: 当前搜索词 + :return: 过滤后的配置行列表 + """ + normalized_query = str(query).strip().lower() + if not normalized_query: + return rows + return [ + row + for row in rows + if normalized_query in str(row.get('configKey', '') or '').strip().lower() + or normalized_query in str(row.get('configName', '') or '').strip().lower() + ] + + @staticmethod + def append_orphan_cache_rows(rows: list[dict[str, Any]], orphan_keys: set[str]) -> list[dict[str, Any]]: + """ + 将仅存在于缓存侧的孤立配置补充为可浏览记录。 + + :param rows: 原始数据库配置行 + :param orphan_keys: 缓存孤立配置键集合 + :return: 补齐后的配置行列表 + """ + merged_rows = list(rows) + existing_keys = {str(row.get('configKey', '') or '').strip() for row in rows} + merged_rows.extend( + { + 'configId': '-', + 'configKey': orphan_key, + 'configName': '缓存孤立配置', + 'configType': '-', + 'configValue': '缓存侧残留,建议排查来源', + } + for orphan_key in sorted(orphan_keys - existing_keys) + ) + return merged_rows + + +class ConfigSectionBuilder: + """ + 参数配置浏览页分区构建器。 + + 该构建器负责构建参数配置页共享分区,以及单个配置项详情分区。 + + :param page_adapter: 参数配置浏览页适配器 + :param risk_support: 参数配置风险分类支持对象 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + risk_support: ConfigRiskSupport, + ) -> None: + """ + 初始化参数配置浏览页分区构建器。 + + :param page_adapter: 参数配置浏览页适配器 + :param risk_support: 参数配置风险分类支持对象 + :return: None + """ + self.page_adapter = page_adapter + self.risk_support = risk_support + + def build_config_doctor_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建参数配置巡检共享分区。 + + :param payload: `config doctor` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='配置巡检', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='巡检结果', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='配置巡检', + status='ok', + lines=[ + '## 一致性状态', + f'数据库配置: {payload.get("databaseCount", "-")} 项', + f'缓存同步配置: {payload.get("cacheCount", "-")} 项', + f'缓存缺失: {payload.get("missingInCacheCount", "-")} 项', + f'缓存孤立: {payload.get("orphanInCacheCount", "-")} 项', + f'值不一致: {payload.get("mismatchCount", "-")} 项', + ], + ) + + def build_config_issue_samples_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建参数配置不一致样本共享分区。 + + :param payload: `config doctor` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='异常样本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='样本', empty_value='不可用'), + ) + + lines: list[str] = [] + missing_in_cache = payload.get('missingInCache') + orphan_in_cache = payload.get('orphanInCache') + mismatch_keys = payload.get('mismatchKeys') + + if isinstance(missing_in_cache, list) and missing_in_cache: + lines.extend( + f'缓存缺失示例:{SHELL_TEXT_FORMATTER.truncate_text(item, 64)}' + for item in missing_in_cache[:5] + if isinstance(item, str) + ) + if isinstance(orphan_in_cache, list) and orphan_in_cache: + lines.extend( + f'缓存孤立示例:{SHELL_TEXT_FORMATTER.truncate_text(item, 64)}' + for item in orphan_in_cache[:5] + if isinstance(item, str) + ) + if isinstance(mismatch_keys, list) and mismatch_keys: + lines.extend( + f'值不一致示例:{SHELL_TEXT_FORMATTER.truncate_text(item, 64)}' + for item in mismatch_keys[:5] + if isinstance(item, str) + ) + + issue_count = ( + int(payload.get('missingInCacheCount', 0)) + + int(payload.get('orphanInCacheCount', 0)) + + int(payload.get('mismatchCount', 0)) + ) + return DetailSectionSnapshot( + title='异常样本', + status='fail' if issue_count > 0 else 'ok', + lines=lines + if lines + else TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='异常样本', + empty_value='0 条', + detail='当前未发现配置异常样本', + ), + ) + + def build_config_set_entry_section(self, rows: list[dict[str, Any]]) -> DetailSectionSnapshot: + """ + 构建配置变更入口共享分区。 + + :param rows: 当前配置行列表 + :return: 分区快照 + """ + sample_key = '' + sample_value = '' + for row in rows: + config_key = str(row.get('configKey', '') or '').strip() + config_value = str(row.get('configValue', '') or '').strip() + if config_key: + sample_key = config_key + sample_value = config_value or 'new-value' + break + if not sample_key: + sample_key = 'demo.config.key' + sample_value = 'new-value' + return DetailSectionSnapshot( + title='配置变更入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备修复高风险配置、回填缓存缺失项或校正数据库与缓存值不一致时,应先在终端中明确目标键和值,再执行配置变更命令。', + command=TUI_COPY.build_cli_command_hint('config', 'set', sample_key, sample_value, '--output=text'), + guide='建议先在当前页面核对配置键、来源和现值;变更完成后再回到工作台执行参数缓存刷新,确认巡检结果恢复正常。', + ), + ) + + def build_high_risk_config_section( + self, + rows: list[dict[str, Any]], + risk_sets: dict[str, set[str]], + ) -> DetailSectionSnapshot: + """ + 构建高风险配置共享分区。 + + :param rows: 配置行列表 + :param risk_sets: 风险集合 + :return: 分区快照 + """ + risky_rows = [ + row + for row in sorted( + rows, key=lambda config_row: self.risk_support.build_config_sort_key(config_row, risk_sets) + ) + if self.risk_support.resolve_config_risk_key(str(row.get('configKey', '') or ''), risk_sets) != 'normal' + ] + if not risky_rows: + return DetailSectionSnapshot( + title='高风险配置', + status='ok', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='高风险配置', + empty_value='0 项', + detail='当前巡检结果中没有需要优先处理的高风险配置', + ), + ) + lines: list[str] = [] + for row in risky_rows[:8]: + config_key = str(row.get('configKey', '-') or '-') + config_name = str(row.get('configName', '-') or '-') + risk_key = self.risk_support.resolve_config_risk_key(config_key, risk_sets) + lines.append( + f'[{CONFIG_RISK_LABELS.get(risk_key, "风险")}] ' + f'{SHELL_TEXT_FORMATTER.truncate_text(config_key, 40)} · {SHELL_TEXT_FORMATTER.truncate_text(config_name, 20)}' + ) + return DetailSectionSnapshot( + title='高风险配置', + status='warn' if risky_rows else 'ok', + lines=lines, + ) + + def build_configs_overview_section( + self, + rows: list[dict[str, Any]], + filtered_rows: list[dict[str, Any]], + risk_sets: dict[str, set[str]], + filter_label: str, + ) -> DetailSectionSnapshot: + """ + 构建参数配置页总览判断共享分区。 + + :param rows: 原始配置行列表 + :param filtered_rows: 当前筛选后的配置行列表 + :param risk_sets: 风险集合 + :param filter_label: 当前筛选标签 + :return: 分区快照 + """ + mismatch_count = len(risk_sets.get('mismatch', set())) + drift_count = len(risk_sets.get('missing-cache', set())) + len(risk_sets.get('orphan-cache', set())) + risky_count = mismatch_count + drift_count + status = 'ok' + conclusion = '当前配置一致性正常,可继续抽查单项详情与同步状态' + if mismatch_count > 0: + status = 'warn' + conclusion = '存在值不一致配置,优先核对数据库与缓存是否同步' + elif drift_count > 0: + status = 'warn' + conclusion = '存在缓存漂移配置,建议优先确认缺失项与孤立项来源' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'当前筛选: {filter_label}', + f'已加载配置: {len(rows)} 项', + f'当前匹配: {len(filtered_rows)} 项', + f'高风险配置: {risky_count} 项', + f'值不一致: {mismatch_count} 项', + f'缓存漂移: {drift_count} 项', + '', + '## 建议入口', + '优先关注:高风险配置 / 值不一致 / 缓存漂移', + ], + ) + + def build_config_consistency_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建单个配置的一致性分区。 + + :param payload: `config get` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='同步状态', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='同步状态', empty_value='不可用' + ), + ) + lines = [ + '## 当前配置', + f'键名: {payload.get("key", "-")}', + f'读取来源: {payload.get("source", "-")}', + ] + source = str(payload.get('source', '-') or '-').strip().lower() + section_status = 'ok' + if source == 'both': + lines.append(f'数据库与缓存一致: {"是" if payload.get("inSync", False) else "否"}') + if not payload.get('inSync', False): + section_status = 'fail' + elif source == 'database': + lines.append('缓存状态: 缺失') + section_status = 'warn' + elif source == 'cache': + lines.append('数据库状态: 缺失') + section_status = 'warn' + return DetailSectionSnapshot( + title='同步状态', + status=section_status, + lines=lines, + ) + + def build_config_source_section( + self, + title: str, + config_item: dict[str, Any] | None, + *, + missing_text: str, + ) -> DetailSectionSnapshot: + """ + 构建配置来源详情分区。 + + :param title: 分区标题 + :param config_item: 配置来源详情 + :param missing_text: 缺失时提示 + :return: 分区快照 + """ + if not isinstance(config_item, dict): + return DetailSectionSnapshot( + title=title, + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label=title, + empty_value='未找到', + detail=missing_text, + ), + ) + return DetailSectionSnapshot( + title=title, + status='ok', + lines=[ + '## 基础信息', + f'配置 ID: {config_item.get("configId", "-")}', + f'键名: {SHELL_TEXT_FORMATTER.truncate_text(config_item.get("configKey", "-"), 48)}', + f'名称: {SHELL_TEXT_FORMATTER.truncate_text(config_item.get("configName", "-"), 32)}', + f'键值: {SHELL_TEXT_FORMATTER.truncate_text(config_item.get("configValue", "-"), 72)}', + f'内置标记: {config_item.get("configType", "-")}', + '', + '## 备注', + SHELL_TEXT_FORMATTER.truncate_text(config_item.get('remark', '-') or '-', 88), + ], + ) + + def load_config_detail_sections( + self, + config_row: dict[str, Any], + env: str, + ) -> list[DetailSectionSnapshot]: + """ + 按需加载单个配置项详情分区。 + + :param config_row: 配置项行数据 + :param env: 当前运行环境 + :return: 详情分区列表 + """ + config_key = str(config_row.get('configKey', '-') or '-') + detail_payload = NESTED_CLI_SUPPORT.run( + 'config', + 'get', + config_key, + f'--env={env}', + '--source=both', + '--output=json', + parse_json=True, + ).payload + database_payload = detail_payload.get('database') if isinstance(detail_payload, dict) else None + cache_payload = detail_payload.get('cache') if isinstance(detail_payload, dict) else None + return [ + self.build_config_consistency_section(detail_payload), + self.build_config_source_section('数据库配置', database_payload, missing_text='数据库中未找到该配置项'), + self.build_config_source_section('缓存配置', cache_payload, missing_text='缓存中未找到该配置项'), + ] + + +class ConfigRecordBuilder: + """ + 参数配置浏览记录构建器。 + + 该构建器负责构建配置浏览记录与失败兜底记录。 + + :param page_adapter: 参数配置浏览页适配器 + :param section_builder: 参数配置浏览页分区构建器 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + section_builder: ConfigSectionBuilder, + ) -> None: + """ + 初始化参数配置浏览记录构建器。 + + :param page_adapter: 参数配置浏览页适配器 + :param section_builder: 参数配置浏览页分区构建器 + :return: None + """ + self.page_adapter = page_adapter + self.section_builder = section_builder + + def build_record( + self, + config_row: dict[str, Any], + env: str, + *, + risk_key: str, + ) -> BrowserRecordSnapshot: + """ + 构建单条参数配置浏览记录。 + + :param config_row: 配置项行数据 + :param env: 当前运行环境 + :param risk_key: 当前配置项风险键 + :return: 浏览记录快照 + """ + config_id = config_row.get('configId', '-') + config_key = str(config_row.get('configKey', '-') or '-') + config_name = str(config_row.get('configName', '-') or '-') + config_type = str(config_row.get('configType', '-') or '-') + config_value = str(config_row.get('configValue', '-') or '-') + risk_label = CONFIG_RISK_LABELS.get(risk_key, '正常') + return BrowserRecordSnapshot( + key=f'config:{config_key}', + title=SHELL_TEXT_FORMATTER.truncate_text(config_key, 44), + status=CONFIG_RISK_STATUSES.get(risk_key, 'ok'), + summary=f'{risk_label} · {SHELL_TEXT_FORMATTER.truncate_text(config_name, 18)} · 值 {SHELL_TEXT_FORMATTER.truncate_text(config_value, 24)}', + metadata_lines=[ + '## 配置身份', + f'配置 ID: {config_id}', + f'配置名称: {SHELL_TEXT_FORMATTER.truncate_text(config_name, 40)}', + f'系统内置: {config_type}', + f'风险分类: {risk_label}', + '', + '## 当前值', + SHELL_TEXT_FORMATTER.truncate_text(config_value, 88), + ], + detail_sections=[], + detail_loader=lambda config_row=config_row, env=env: self.section_builder.load_config_detail_sections( + config_row, + env, + ), + ) + + def build_failure_record(self, payload: dict[str, Any] | None) -> BrowserRecordSnapshot: + """ + 构建配置页失败兜底记录。 + + :param payload: 失败结果负载 + :return: 浏览记录快照 + """ + return self.page_adapter.build_failure_record( + key='config:unavailable', + subject='参数配置', + section_subject='配置列表', + payload=payload, + ) + + +class ConfigsBrowserAdapter(BaseBrowserAdapter): + """ + 参数配置浏览页适配器。 + + 该适配器负责采集配置巡检、配置列表和单项配置详情,并统一完成 + 风险分类、筛选排序、共享分区构建与浏览记录装配。 + + :param risk_support: 参数配置风险分类支持对象 + :param section_builder: 参数配置浏览页分区构建器 + :param record_builder: 参数配置浏览记录构建器 + """ + + def __init__( + self, + risk_support: ConfigRiskSupport | None = None, + section_builder: ConfigSectionBuilder | None = None, + record_builder: ConfigRecordBuilder | None = None, + ) -> None: + """ + 初始化参数配置浏览页适配器。 + + :param risk_support: 参数配置风险分类支持对象 + :param section_builder: 参数配置浏览页分区构建器 + :param record_builder: 参数配置浏览记录构建器 + :return: None + """ + super().__init__( + page_title='参数配置', + search_view_key='configs', + filter_options=CONFIG_FILTER_OPTIONS, + ) + self.risk_support = risk_support or ConfigRiskSupport() + self.section_builder = section_builder or ConfigSectionBuilder(self, self.risk_support) + self.record_builder = record_builder or ConfigRecordBuilder(self, self.section_builder) + + def collect_snapshot(self, env: str, filter_key: str = 'all', query: str = '') -> BrowserPageSnapshot: + """ + 采集参数配置浏览页只读快照。 + + :param env: 当前运行环境 + :param filter_key: 当前筛选键 + :param query: 当前搜索词 + :return: 浏览页快照 + """ + active_filter_option = self.resolve_active_filter(filter_key) + active_filter = active_filter_option.key + active_filter_label = active_filter_option.label + search_context = self.resolve_search_context(query) + doctor_payload = NESTED_CLI_SUPPORT.run( + 'config', + 'doctor', + f'--env={env}', + '--sample-limit=5', + '--output=json', + parse_json=True, + ).payload + list_payload = NESTED_CLI_SUPPORT.run( + 'config', + 'list', + f'--env={env}', + '--paged', + '--page-size=8', + '--output=json', + parse_json=True, + ).payload + risk_sets = self.risk_support.build_config_risk_sets(doctor_payload) + + if not isinstance(list_payload, dict) or not list_payload.get('ok', False): + return BrowserPageSnapshot( + title='参数配置', + subtitle=TUI_COPY.build_unavailable_subtitle( + '配置', + SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(list_payload), 72), + ), + records=[self.record_builder.build_failure_record(list_payload)], + shared_sections=[ + self.section_builder.build_configs_overview_section([], [], risk_sets, active_filter_label), + self.section_builder.build_config_doctor_section(doctor_payload), + self.section_builder.build_high_risk_config_section([], risk_sets), + self.section_builder.build_config_issue_samples_section(doctor_payload), + self.section_builder.build_config_set_entry_section([]), + ], + filters=list(self.filter_options), + active_filter_key=active_filter, + search=search_context, + ) + + rows = self.risk_support.append_orphan_cache_rows( + self.extract_page_rows(list_payload), + risk_sets.get('orphan-cache', set()), + ) + sorted_rows = sorted( + rows, key=lambda config_row: self.risk_support.build_config_sort_key(config_row, risk_sets) + ) + filtered_rows = self.risk_support.apply_config_query( + self.risk_support.apply_config_filter(sorted_rows, risk_sets, active_filter), + query, + ) + records = [ + self.record_builder.build_record( + config_row, + env, + risk_key=self.risk_support.resolve_config_risk_key( + str(config_row.get('configKey', '') or ''), + risk_sets, + ), + ) + for config_row in filtered_rows[:12] + ] + if not records: + records = [ + self.build_empty_record( + key='config:none', + subject='配置项', + empty_label='配置项', + has_source_rows=bool(sorted_rows), + filtered_summary='当前筛选条件下没有匹配配置项', + empty_summary='当前环境没有可浏览的参数配置项', + filtered_empty_value='暂无数据', + empty_empty_value='暂无配置', + filtered_detail='当前筛选条件下没有匹配配置项', + empty_detail='当前环境没有可浏览的参数配置项', + ) + ] + + subtitle = TUI_DIAGNOSTIC_SERVICE.build_configs_diagnostic_subtitle( + active_filter_label, + len(filtered_rows), + len(risk_sets.get('mismatch', set())), + len(risk_sets.get('missing-cache', set())) + len(risk_sets.get('orphan-cache', set())), + ) + if isinstance(doctor_payload, dict) and not doctor_payload.get('ok', False): + subtitle = ( + f'{subtitle} | {SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(doctor_payload), 72)}' + ) + shared_sections = [ + self.section_builder.build_configs_overview_section(rows, filtered_rows, risk_sets, active_filter_label), + self.section_builder.build_config_doctor_section(doctor_payload), + self.section_builder.build_high_risk_config_section(rows, risk_sets), + self.section_builder.build_config_issue_samples_section(doctor_payload), + self.section_builder.build_config_set_entry_section(rows), + ] + return BrowserPageSnapshot( + title='参数配置', + subtitle=subtitle, + records=records, + shared_sections=shared_sections, + filters=list(self.filter_options), + active_filter_key=active_filter, + search=search_context, + ) + + +CONFIGS_BROWSER_ADAPTER = ConfigsBrowserAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/crypto.py b/shierfeng-fastapi-backend/cli/tui/adapters/crypto.py new file mode 100644 index 0000000..47c6f7a --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/crypto.py @@ -0,0 +1,372 @@ +from dataclasses import dataclass +from typing import Any + +from cli.tui.adapters.base import BaseDetailAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + DetailPageSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class CryptoDetailSourcePayloads: + """ + 传输加密详情页原始数据源快照。 + + :param validate_payload: `crypto validate` 结果 + :param public_payload: `crypto export-public` 结果 + """ + + validate_payload: dict[str, Any] | None + public_payload: dict[str, Any] | None + + +class CryptoDetailSnapshotCollector: + """ + 传输加密详情页数据采集器。 + + 该对象负责拉取传输加密详情页所需的 CLI 原始结果, + 让 `CryptoDetailAdapter` 保持详情页编排职责。 + """ + + def collect(self, env: str) -> CryptoDetailSourcePayloads: + """ + 采集传输加密详情页所需原始结果。 + + :param env: 当前运行环境 + :return: 传输加密详情页原始数据源快照 + """ + return CryptoDetailSourcePayloads( + validate_payload=NESTED_CLI_SUPPORT.run( + 'crypto', + 'validate', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + public_payload=NESTED_CLI_SUPPORT.run( + 'crypto', + 'export-public', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ) + + +class CryptoSectionBuilder: + """ + 传输加密详情分区构建器。 + + 该构建器负责将传输加密相关 CLI 结果负载转换为 TUI 详情页分区, + 使详情页适配器本体只保留采集与编排职责。 + """ + + @staticmethod + def build_validate_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建传输加密运行校验分区。 + + :param payload: `crypto validate` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='运行校验', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='运行校验', empty_value='不可用' + ), + ) + lines = [ + '## 校验结果', + f'状态: {"通过" if payload.get("ok", False) else "失败"}', + f'说明: {SHELL_TEXT_FORMATTER.truncate_text(TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(payload), 72)}', + ] + if payload.get('error'): + lines.append(f'错误: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("error", "-"), 72)}') + return DetailSectionSnapshot( + title='运行校验', + status='ok' if payload.get('ok', False) else 'fail', + lines=lines, + ) + + @staticmethod + def build_public_identity_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建公钥身份分区。 + + :param payload: `crypto export-public` JSON 负载 + :return: 分区快照 + """ + public_key_payload = payload.get('publicKey') if isinstance(payload, dict) else None + if not isinstance(public_key_payload, dict): + return DetailSectionSnapshot( + title='公钥身份', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='公钥', empty_value='不可用'), + ) + return DetailSectionSnapshot( + title='公钥身份', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 当前版本', + f'KID: {public_key_payload.get("kid", "-")}', + f'算法: {public_key_payload.get("alg", "-")}', + f'信封版本: {public_key_payload.get("envelopeVersion", "-")}', + f'过期时间: {public_key_payload.get("expireAt", "-")}', + ], + ) + + @staticmethod + def build_supported_kids_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建兼容版本分区。 + + :param payload: `crypto export-public` JSON 负载 + :return: 分区快照 + """ + public_key_payload = payload.get('publicKey') if isinstance(payload, dict) else None + if not isinstance(public_key_payload, dict): + return DetailSectionSnapshot( + title='兼容版本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='兼容版本', empty_value='不可用' + ), + ) + supported_kids = public_key_payload.get('supportedKids') + lines = TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='兼容版本', + empty_value='0 个', + detail='当前公钥未声明兼容版本 KID', + suggestion='如需兼容旧版本客户端,可检查 supportedKids 配置', + ) + if isinstance(supported_kids, list) and supported_kids: + lines = ['## 兼容 KID', *[f'支持版本: {kid}' for kid in supported_kids[:10]]] + return DetailSectionSnapshot( + title='兼容版本', + status='ok', + lines=lines, + ) + + def build_public_preview_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建公钥预览分区。 + + :param payload: `crypto export-public` JSON 负载 + :return: 分区快照 + """ + public_key_payload = payload.get('publicKey') if isinstance(payload, dict) else None + if not isinstance(public_key_payload, dict): + return DetailSectionSnapshot( + title='公钥预览', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='公钥预览', empty_value='不可用' + ), + ) + public_key = str(public_key_payload.get('publicKey', '') or '').splitlines() + if not public_key: + return DetailSectionSnapshot( + title='公钥预览', + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='公钥预览', + empty_value='无内容', + detail='当前公钥内容为空,无法生成预览', + suggestion='可检查公钥导出结果,或重新生成公钥后再刷新', + ), + ) + return DetailSectionSnapshot( + title='公钥预览', + status='info', + lines=['## 预览内容', *[SHELL_TEXT_FORMATTER.truncate_text(line, 88) for line in public_key[:6]]], + ) + + @staticmethod + def build_overview_section( + validate_payload: dict[str, Any] | None, + public_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建加密页总览判断分区。 + + :param validate_payload: `crypto validate` JSON 负载 + :param public_payload: `crypto export-public` JSON 负载 + :return: 分区快照 + """ + validate_ok = bool(isinstance(validate_payload, dict) and validate_payload.get('ok', False)) + public_ok = bool(isinstance(public_payload, dict) and public_payload.get('ok', False)) + public_key_payload = public_payload.get('publicKey') if isinstance(public_payload, dict) else None + supported_kids = public_key_payload.get('supportedKids') if isinstance(public_key_payload, dict) else None + supported_count = len(supported_kids) if isinstance(supported_kids, list) else 0 + + status = 'ok' + conclusion = '传输加密基线正常,可继续查看公钥身份、兼容版本与预演入口' + if not validate_ok: + status = 'fail' + conclusion = '运行校验失败,优先确认传输加密配置与环境变量' + elif not public_ok or not isinstance(public_key_payload, dict): + status = 'warn' + conclusion = '公钥导出结果异常,建议先确认当前 KID 与公钥内容是否可用' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'运行校验: {"通过" if validate_ok else "失败"}', + f'当前 KID: {public_key_payload.get("kid", "-") if isinstance(public_key_payload, dict) else "-"}', + f'算法: {public_key_payload.get("alg", "-") if isinstance(public_key_payload, dict) else "-"}', + f'兼容版本数: {supported_count}', + '', + '## 建议入口', + '优先关注:运行校验 / 公钥身份 / 兼容版本 / 轮换预演入口', + ], + ) + + @staticmethod + def build_rotation_entry_section(env: str) -> DetailSectionSnapshot: + """ + 构建加密密钥轮换预演入口分区。 + + :param env: 当前运行环境 + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='轮换预演入口', + status='warn', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备轮换传输加密密钥时,应先做 dry-run,确认新 KID、密钥长度和 guard 提示后再执行正式轮换。', + command=TUI_COPY.build_cli_command_hint( + 'crypto', + 'rotate', + f'--env={env}', + '--dry-run', + '--output=json', + ), + guide='当前页面先提供预演入口;正式轮换仍应遵循危险命令确认流程,避免直接在未知环境落地变更。', + ), + ) + + @staticmethod + def build_keygen_entry_section(env: str) -> DetailSectionSnapshot: + """ + 构建加密密钥生成入口分区。 + + :param env: 当前运行环境 + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='密钥生成入口', + status='warn', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备生成新的传输加密密钥对时,应在当前终端直接查看生成结果,并立即核对 KID、密钥长度和环境变量补丁。', + command=TUI_COPY.build_cli_command_hint( + 'crypto', + 'keygen', + f'--env={env}', + '--output=text', + ), + guide='当前入口会在终端中直接输出新公钥、私钥和 env patch keys,后续再决定是否进入轮换流程。', + ), + ) + + def build_sections( + self, + *, + validate_payload: dict[str, Any] | None, + public_payload: dict[str, Any] | None, + env: str, + ) -> list[DetailSectionSnapshot]: + """ + 构建传输加密页全部详情分区。 + + :param validate_payload: `crypto validate` 结果负载 + :param public_payload: `crypto export-public` 结果负载 + :param env: 当前运行环境 + :return: 详情分区列表 + """ + return [ + self.build_overview_section(validate_payload, public_payload), + self.build_validate_section(validate_payload), + self.build_public_identity_section(public_payload), + self.build_supported_kids_section(public_payload), + self.build_public_preview_section(public_payload), + self.build_keygen_entry_section(env), + self.build_rotation_entry_section(env), + ] + + +class CryptoDetailAdapter(BaseDetailAdapter): + """ + 传输加密详情页适配器。 + + 该适配器负责采集传输加密相关 CLI 结果,并组装为 TUI 详情页快照。 + 页面私有的解析逻辑、分区构建逻辑和快照采集流程统一收口在该类中。 + + :param section_builder: 传输加密详情分区构建器 + """ + + def __init__( + self, + section_builder: CryptoSectionBuilder | None = None, + snapshot_collector: CryptoDetailSnapshotCollector | None = None, + ) -> None: + """ + 初始化传输加密详情页适配器。 + + :param section_builder: 传输加密详情分区构建器 + :param snapshot_collector: 传输加密详情页数据采集器 + :return: None + """ + super().__init__( + page_title='传输加密', + search_view_key='crypto', + default_suggestions=[ + '总览判断', + '运行校验', + '公钥身份', + '兼容版本', + '公钥预览', + '密钥生成入口', + '轮换预演入口', + ], + ) + self.section_builder = section_builder or CryptoSectionBuilder() + self.snapshot_collector = snapshot_collector or CryptoDetailSnapshotCollector() + + def collect_snapshot(self, env: str, query: str = '') -> DetailPageSnapshot: + """ + 采集传输加密状态页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 页面快照 + """ + source_payloads = self.snapshot_collector.collect(env) + sections = self.section_builder.build_sections( + validate_payload=source_payloads.validate_payload, + public_payload=source_payloads.public_payload, + env=env, + ) + return DetailPageSnapshot( + title='传输加密', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_crypto_diagnostic_subtitle( + source_payloads.validate_payload, + source_payloads.public_payload, + ), + sections=self.filter_sections(sections, query), + search=self.resolve_search_context(query), + ) + + +CRYPTO_DETAIL_ADAPTER = CryptoDetailAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/database.py b/shierfeng-fastapi-backend/cli/tui/adapters/database.py new file mode 100644 index 0000000..3e27912 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/database.py @@ -0,0 +1,474 @@ +from dataclasses import dataclass +from typing import Any + +from cli.tui.adapters.base import BaseDetailAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + DetailPageSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class DatabaseDetailSourcePayloads: + """ + 数据库详情页原始数据源快照。 + + :param revision_payload: `db current` 结果 + :param check_payload: `db check` 结果 + :param heads_payload: `db heads` 结果 + :param history_payload: `db history` 结果 + :param config_payload: `app config` 结果 + """ + + revision_payload: dict[str, Any] | None + check_payload: dict[str, Any] | None + heads_payload: dict[str, Any] | None + history_payload: dict[str, Any] | None + config_payload: dict[str, Any] | None + + +class DatabaseDetailSnapshotCollector: + """ + 数据库详情页数据采集器。 + + 该对象负责拉取数据库详情页所需的多路 CLI 原始结果, + 让 `DatabaseDetailAdapter` 保持详情页编排职责。 + """ + + def collect(self, env: str) -> DatabaseDetailSourcePayloads: + """ + 采集数据库详情页所需原始结果。 + + :param env: 当前运行环境 + :return: 数据库详情页原始数据源快照 + """ + return DatabaseDetailSourcePayloads( + revision_payload=NESTED_CLI_SUPPORT.run( + 'db', + 'current', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + check_payload=NESTED_CLI_SUPPORT.run( + 'db', + 'check', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + heads_payload=NESTED_CLI_SUPPORT.run( + 'db', + 'heads', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + history_payload=NESTED_CLI_SUPPORT.run( + 'db', + 'history', + f'--env={env}', + '--limit=8', + '--output=json', + parse_json=True, + ).payload, + config_payload=NESTED_CLI_SUPPORT.run( + 'app', + 'config', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ) + + +class DatabaseSectionBuilder: + """ + 数据库详情分区构建器。 + + 该构建器负责将数据库相关 CLI 结果负载转换为 TUI 详情页分区, + 使详情页适配器本体只保留采集与编排职责。 + """ + + @staticmethod + def extract_revision_items(payload: dict[str, Any] | None) -> list[dict[str, Any]]: + """ + 从 Alembic 结果中提取修订版本列表。 + + :param payload: `db heads` 或 `db history` JSON 负载 + :return: 修订版本列表 + """ + items = payload.get('items') if isinstance(payload, dict) else None + if not isinstance(items, list): + return [] + return [item for item in items if isinstance(item, dict)] + + @staticmethod + def build_revision_item_lines(item: dict[str, Any], *, index: int, item_label: str) -> list[str]: + """ + 构建单条 Alembic 修订版本详情文本。 + + :param item: 修订版本字典 + :param index: 当前索引 + :param item_label: 条目标识名称 + :return: 文本行列表 + """ + down_revisions = item.get('downRevisions') + branch_labels = item.get('branchLabels') + depends_on = item.get('dependsOn') + return [ + f'## {item_label} {index:02d} · {item.get("revision", "-")}', + f'> 下游版本: {",".join(down_revisions) if isinstance(down_revisions, list) and down_revisions else "-"}', + f'> 分支标签: {",".join(branch_labels) if isinstance(branch_labels, list) and branch_labels else "-"}', + f'> 依赖版本: {",".join(depends_on) if isinstance(depends_on, list) and depends_on else "-"}', + f'> 说明: {SHELL_TEXT_FORMATTER.truncate_text(item.get("doc", "-"), 72)}', + f'> 文件: {SHELL_TEXT_FORMATTER.truncate_text(item.get("path", "-"), 72)}', + ] + + @staticmethod + def build_revision_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建数据库迁移状态分区。 + + :param payload: `db current` JSON 负载 + :return: 分区快照 + """ + current_revision = payload.get('currentRevision', '-') if isinstance(payload, dict) else '-' + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='迁移版本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='迁移版本', empty_value=str(current_revision or '-') + ), + ) + return DetailSectionSnapshot( + title='迁移版本', + status='ok', + lines=[ + '## 当前版本', + f'迁移版本: {current_revision}', + '', + '## 状态说明', + f'结果消息: {TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(payload)}', + ], + ) + + def build_overview_section( + self, + revision_payload: dict[str, Any] | None, + check_payload: dict[str, Any] | None, + heads_payload: dict[str, Any] | None, + history_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建数据库页总览判断分区。 + + :param revision_payload: `db current` JSON 负载 + :param check_payload: `db check` JSON 负载 + :param heads_payload: `db heads` JSON 负载 + :param history_payload: `db history` JSON 负载 + :return: 分区快照 + """ + revision_ok = bool(isinstance(revision_payload, dict) and revision_payload.get('ok', False)) + check_ok = bool(isinstance(check_payload, dict) and check_payload.get('ok', False)) + heads_ok = bool(isinstance(heads_payload, dict) and heads_payload.get('ok', False)) + current_revision = revision_payload.get('currentRevision', '-') if isinstance(revision_payload, dict) else '-' + head_items = self.extract_revision_items(heads_payload) + history_items = self.extract_revision_items(history_payload) + + status = 'ok' + conclusion = '数据库基线正常,可继续查看连接状态、Heads 与版本链路' + if not revision_ok or not check_ok: + status = 'fail' + conclusion = '数据库存在基础异常,优先确认迁移版本与连通性检查结果' + elif not heads_ok or len(head_items) != 1: + status = 'warn' + conclusion = '数据库存在迁移分叉风险,优先确认 Heads 与版本链路是否一致' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'当前 revision: {current_revision}', + f'连通性检查: {"正常" if check_ok else "异常"}', + f'Heads 数量: {len(head_items)}', + f'版本数量: {history_payload.get("totalCount", len(history_items)) if isinstance(history_payload, dict) else len(history_items)}', + '', + '## 建议入口', + '优先关注:迁移版本 / 连通性检查 / Heads 状态 / 升级入口', + ], + ) + + @staticmethod + def build_profile_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建数据库连接配置分区。 + + :param payload: `app config` JSON 负载 + :return: 分区快照 + """ + config = payload.get('config') if isinstance(payload, dict) else None + if not isinstance(config, dict): + return DetailSectionSnapshot( + title='连接信息', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='连接信息', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='连接信息', + status='ok', + lines=[ + '## 数据库连接', + f'数据库类型: {config.get("dbType", "-")}', + f'连接地址: {config.get("dbHost", "-")}:{config.get("dbPort", "-")}', + f'数据库名: {config.get("dbDatabase", "-")}', + ], + ) + + @staticmethod + def build_check_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建数据库连通性检查分区。 + + :param payload: `db check` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='连通性检查', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='数据库连接', empty_value='异常' + ), + ) + return DetailSectionSnapshot( + title='连通性检查', + status='ok', + lines=[ + '## 当前状态', + '数据库连接: 正常', + '', + '## 结果摘要', + f'结果消息: {TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(payload)}', + ], + ) + + def build_heads_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建 Alembic heads 分区。 + + :param payload: `db heads` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='Heads 状态', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='Heads', empty_value='不可用' + ), + ) + items = self.extract_revision_items(payload) + status = 'ok' if len(items) == 1 else 'warn' + lines = [ + '## Heads 概况', + f'Heads 数量: {len(items)}', + f'结果消息: {TUI_ADAPTER_MODEL_RENDERER.extract_payload_message(payload)}', + ] + if not items: + lines.extend(['', '## Heads 列表', '> 当前仓库未返回可用 heads']) + else: + lines.extend(['', '## Heads 列表']) + for index, item in enumerate(items[:4], start=1): + lines.extend(self.build_revision_item_lines(item, index=index, item_label='Head')) + lines.append('') + if len(lines) > 1 and lines[-1] == '': + lines.pop() + return DetailSectionSnapshot( + title='Heads 状态', + status=status, + lines=lines, + ) + + def build_history_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建 Alembic 历史版本分区。 + + :param payload: `db history` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='历史版本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='历史版本', empty_value='不可用' + ), + ) + items = self.extract_revision_items(payload) + lines = [ + '## 历史概况', + f'返回数量: {payload.get("count", len(items))}', + f'总版本数: {payload.get("totalCount", len(items))}', + f'查询上限: {payload.get("limit", len(items))}', + '', + '## 历史列表', + ] + if not items: + lines.append('> 当前仓库未返回可展示的历史版本') + else: + for index, item in enumerate(items[:6], start=1): + lines.extend(self.build_revision_item_lines(item, index=index, item_label='版本')) + lines.append('') + if lines[-1] == '': + lines.pop() + return DetailSectionSnapshot( + title='历史版本', + status='ok', + lines=lines, + ) + + @staticmethod + def build_upgrade_entry_section() -> DetailSectionSnapshot: + """ + 构建数据库升级向导入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='升级入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备执行数据库升级、校验迁移路径或在生产前做升级预演时,应先通过向导确认目标版本与 dry-run 结果。', + command=TUI_COPY.build_cli_command_hint('wizard', 'db-upgrade', '--output=text'), + guide='向导会继续询问目标环境和目标 revision,并在真正升级前先展示预览信息。', + ), + ) + + @staticmethod + def build_init_entry_section() -> DetailSectionSnapshot: + """ + 构建数据库初始化预演入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='初始化预演入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备初始化新库、重建本地环境,或先确认初始化命令会执行到哪些迁移版本时,应先执行 dry-run 预演。', + command=TUI_COPY.build_cli_command_hint('db', 'init', '--dry-run', '--output=text'), + guide='预演只返回命令摘要与执行目录;确认无误后,再通过外部终端或向导执行真实初始化流程。', + ), + ) + + def build_sections( + self, + *, + revision_payload: dict[str, Any] | None, + check_payload: dict[str, Any] | None, + heads_payload: dict[str, Any] | None, + history_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + ) -> list[DetailSectionSnapshot]: + """ + 构建数据库页全部详情分区。 + + :param revision_payload: `db current` 结果负载 + :param check_payload: `db check` 结果负载 + :param heads_payload: `db heads` 结果负载 + :param history_payload: `db history` 结果负载 + :param config_payload: `app config` 结果负载 + :return: 详情分区列表 + """ + return [ + self.build_overview_section(revision_payload, check_payload, heads_payload, history_payload), + self.build_revision_section(revision_payload), + self.build_profile_section(config_payload), + self.build_check_section(check_payload), + self.build_heads_section(heads_payload), + self.build_history_section(history_payload), + self.build_init_entry_section(), + self.build_upgrade_entry_section(), + ] + + +class DatabaseDetailAdapter(BaseDetailAdapter): + """ + 数据库详情页适配器。 + + 该适配器负责采集数据库相关 CLI 结果,并组装为 TUI 详情页快照。 + 页面私有的解析逻辑、分区构建逻辑和快照采集流程统一收口在该类中。 + + :param section_builder: 数据库详情分区构建器 + """ + + def __init__( + self, + section_builder: DatabaseSectionBuilder | None = None, + snapshot_collector: DatabaseDetailSnapshotCollector | None = None, + ) -> None: + """ + 初始化数据库详情页适配器。 + + :param section_builder: 数据库详情分区构建器 + :param snapshot_collector: 数据库详情页数据采集器 + :return: None + """ + super().__init__( + page_title='数据库', + search_view_key='database', + default_suggestions=[ + '总览判断', + '迁移版本', + '连接信息', + '连通性检查', + 'Heads 状态', + '历史版本', + '初始化预演入口', + '升级入口', + ], + ) + self.section_builder = section_builder or DatabaseSectionBuilder() + self.snapshot_collector = snapshot_collector or DatabaseDetailSnapshotCollector() + + def collect_snapshot(self, env: str, query: str = '') -> DetailPageSnapshot: + """ + 采集数据库状态页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 页面快照 + """ + source_payloads = self.snapshot_collector.collect(env) + sections = self.section_builder.build_sections( + revision_payload=source_payloads.revision_payload, + check_payload=source_payloads.check_payload, + heads_payload=source_payloads.heads_payload, + history_payload=source_payloads.history_payload, + config_payload=source_payloads.config_payload, + ) + return DetailPageSnapshot( + title='数据库', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_database_diagnostic_subtitle( + source_payloads.revision_payload, + source_payloads.check_payload, + source_payloads.heads_payload, + ), + sections=self.filter_sections(sections, query), + search=self.resolve_search_context(query), + ) + + +DATABASE_DETAIL_ADAPTER = DatabaseDetailAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/gen.py b/shierfeng-fastapi-backend/cli/tui/adapters/gen.py new file mode 100644 index 0000000..37b7e44 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/gen.py @@ -0,0 +1,807 @@ +from typing import Any + +from cli.tui.adapters.base import BaseBrowserAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + BrowserPageSnapshot, + BrowserRecordSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +class GenRenderingSupport: + """ + 代码生成浏览页渲染支持对象。 + + 该对象负责布尔语义渲染与常见文本辅助逻辑,供分区和记录构建复用。 + """ + + @staticmethod + def render_yes_no(value: object) -> str: + """ + 将常见布尔语义值转换为“是/否”。 + + :param value: 原始值 + :return: 中文布尔文本 + """ + normalized = str(value).strip().lower() + return '是' if normalized in {'1', 'y', 'yes', 'true'} else '否' + + +class GenSectionBuilder: + """ + 代码生成浏览页分区构建器。 + + 该构建器负责构建代码生成页共享分区,以及单条业务表详情分区。 + + :param page_adapter: 代码生成浏览页适配器 + :param rendering: 代码生成浏览页渲染支持对象 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + rendering: GenRenderingSupport, + ) -> None: + """ + 初始化代码生成浏览页分区构建器。 + + :param page_adapter: 代码生成浏览页适配器 + :param rendering: 代码生成浏览页渲染支持对象 + :return: None + """ + self.page_adapter = page_adapter + self.rendering = rendering + + def build_gen_focus_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建业务表概览分区。 + + :param payload: `gen detail` JSON 负载 + :return: 分区快照 + """ + detail = payload.get('detail') if isinstance(payload, dict) else None + info = detail.get('info') if isinstance(detail, dict) else None + if not isinstance(info, dict): + return DetailSectionSnapshot( + title='业务表摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='详情', empty_value='无'), + ) + return DetailSectionSnapshot( + title='业务表摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 表身份', + f'表 ID: {payload.get("tableId", "-")}', + f'表名: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("tableName", "-"), 40)}', + ], + ) + + def build_gen_generation_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建代码生成配置分区。 + + :param payload: `gen detail` JSON 负载 + :return: 分区快照 + """ + detail = payload.get('detail') if isinstance(payload, dict) else None + info = detail.get('info') if isinstance(detail, dict) else None + if not isinstance(info, dict): + return DetailSectionSnapshot( + title='生成配置', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='生成配置', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='生成配置', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 生成类信息', + f'生成类名: {SHELL_TEXT_FORMATTER.truncate_text(info.get("className", "-"), 32)}', + f'所属模块: {SHELL_TEXT_FORMATTER.truncate_text(info.get("moduleName", "-"), 24)}', + '', + '## 业务信息', + f'业务标识: {SHELL_TEXT_FORMATTER.truncate_text(info.get("businessName", "-"), 24)}', + f'功能名称: {SHELL_TEXT_FORMATTER.truncate_text(info.get("functionName", "-"), 24)}', + ], + ) + + def build_gen_column_summary_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建字段概览分区。 + + :param payload: `gen detail` JSON 负载 + :return: 分区快照 + """ + detail = payload.get('detail') if isinstance(payload, dict) else None + rows = detail.get('rows') if isinstance(detail, dict) else None + if not isinstance(rows, list): + return DetailSectionSnapshot( + title='字段摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='字段摘要', empty_value='不可用' + ), + ) + row_dicts = [row for row in rows if isinstance(row, dict)] + primary_key_count = sum(1 for row in row_dicts if self.rendering.render_yes_no(row.get('isPk', '-')) == '是') + required_count = sum(1 for row in row_dicts if self.rendering.render_yes_no(row.get('isRequired', '-')) == '是') + return DetailSectionSnapshot( + title='字段摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 字段规模', + f'字段总数: {payload.get("columnCount", "-")}', + f'主键字段: {primary_key_count}', + f'必填字段: {required_count}', + ], + ) + + def build_gen_columns_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建业务表字段分区。 + + :param payload: `gen detail` JSON 负载 + :return: 分区快照 + """ + detail = payload.get('detail') if isinstance(payload, dict) else None + rows = detail.get('rows') if isinstance(detail, dict) else None + if not isinstance(rows, list) or not rows: + return DetailSectionSnapshot( + title='字段列表', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='字段', empty_value='无'), + ) + lines: list[str] = [] + for row in rows[:12]: + if not isinstance(row, dict): + continue + lines.extend( + [ + f'## {SHELL_TEXT_FORMATTER.truncate_text(row.get("columnName", "-"), 24)} · {SHELL_TEXT_FORMATTER.truncate_text(row.get("columnType", "-"), 20)}', + ( + f'> 主键: {self.rendering.render_yes_no(row.get("isPk", "-"))} | ' + f'必填: {self.rendering.render_yes_no(row.get("isRequired", "-"))} | ' + f'查询: {row.get("queryType", "-")}' + ), + f'> 说明: {SHELL_TEXT_FORMATTER.truncate_text(row.get("columnComment", "-"), 40)}', + '', + ] + ) + return DetailSectionSnapshot( + title='字段列表', + status='ok' if payload.get('ok', False) else 'fail', + lines=(lines[:-1] if lines and lines[-1] == '' else lines) + or TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='字段信息', + empty_value='0 列', + detail='当前业务表没有可展示的字段信息', + ), + ) + + def build_gen_precheck_section( + self, + detail_payload: dict[str, Any] | None, + preview_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建代码生成前校验分区。 + + :param detail_payload: `gen detail` JSON 负载 + :param preview_payload: `gen preview` JSON 负载 + :return: 分区快照 + """ + detail = detail_payload.get('detail') if isinstance(detail_payload, dict) else None + info = detail.get('info') if isinstance(detail, dict) else None + rows = detail.get('rows') if isinstance(detail, dict) and isinstance(detail.get('rows'), list) else [] + preview = preview_payload.get('preview') if isinstance(preview_payload, dict) else None + preview_templates = preview if isinstance(preview, dict) else {} + row_dicts = [row for row in rows if isinstance(row, dict)] + + has_class_name = bool(isinstance(info, dict) and str(info.get('className', '') or '').strip()) + has_module_name = bool(isinstance(info, dict) and str(info.get('moduleName', '') or '').strip()) + has_business_name = bool(isinstance(info, dict) and str(info.get('businessName', '') or '').strip()) + has_primary_key = any(self.rendering.render_yes_no(row.get('isPk', '-')) == '是' for row in row_dicts) + column_count = len(row_dicts) + template_count = len(preview_templates) + + risk_items: list[str] = [] + if not has_class_name: + risk_items.append('生成类名缺失') + if not has_module_name: + risk_items.append('所属模块缺失') + if not has_business_name: + risk_items.append('业务标识缺失') + if column_count <= 0: + risk_items.append('字段列表为空') + if not has_primary_key: + risk_items.append('未识别到主键字段') + if template_count <= 0: + risk_items.append('未生成可预览模板') + + status = 'ok' if not risk_items else 'warn' + return DetailSectionSnapshot( + title='生成前校验', + status=status, + lines=[ + '## 校验结果', + f'生成类名: {"通过" if has_class_name else "缺失"}', + f'所属模块: {"通过" if has_module_name else "缺失"}', + f'业务标识: {"通过" if has_business_name else "缺失"}', + f'字段数量: {column_count}', + f'主键字段: {"通过" if has_primary_key else "缺失"}', + f'模板预览: {template_count} 份', + '', + '## 风险提示', + *(risk_items if risk_items else ['当前未发现阻断生成的明显风险']), + ], + ) + + def build_gen_sync_precheck_section( + self, + table_name: str, + payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建数据库表结构同步前检查分区。 + + :param table_name: 业务表名称 + :param payload: `gen db-list --table-name=...` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='同步预检查', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='同步预检查', empty_value='不可用' + ), + ) + + rows = self.page_adapter.extract_page_rows(payload) + matched_row = next( + (row for row in rows if str(row.get('tableName', '') or '').strip().lower() == table_name.strip().lower()), + None, + ) + if matched_row is None: + return DetailSectionSnapshot( + title='同步预检查', + status='warn', + lines=[ + '## 当前状态', + f'目标业务表: {table_name}', + '数据库物理表: 未匹配', + '', + '## 建议操作', + '当前数据库中未找到同名物理表,执行同步前应先确认表结构来源', + ], + ) + + return DetailSectionSnapshot( + title='同步预检查', + status='ok', + lines=[ + '## 当前状态', + f'目标业务表: {table_name}', + f'数据库物理表: {matched_row.get("tableName", "-")}', + f'表注释: {SHELL_TEXT_FORMATTER.truncate_text(matched_row.get("tableComment", "-"), 56)}', + '', + '## 建议操作', + '已匹配到同名物理表,可继续使用同步数据库表结构动作', + ], + ) + + def build_gen_preview_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建代码预览分区。 + + :param payload: `gen preview` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='代码预览', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='代码预览', empty_value='不可用' + ), + ) + preview_payload = payload.get('preview') if isinstance(payload.get('preview'), dict) else {} + lines = [ + '## 模板规模', + f'模板数量: {payload.get("templateCount", len(preview_payload))}', + ] + if not preview_payload: + lines.extend( + [ + '', + *TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='模板样本', + empty_value='0 份', + detail='当前业务表没有可预览的模板输出', + ), + ] + ) + return DetailSectionSnapshot(title='代码预览', status='info', lines=lines) + + lines.extend(['', '## 模板样本']) + for template_name, template_content in list(preview_payload.items())[:4]: + preview_lines = str(template_content).splitlines()[:3] + lines.append(f'## {SHELL_TEXT_FORMATTER.truncate_text(template_name, 48)}') + lines.extend(f'> {SHELL_TEXT_FORMATTER.truncate_text(line, 72)}' for line in preview_lines) + lines.append('') + if lines[-1] == '': + lines.pop() + return DetailSectionSnapshot( + title='代码预览', + status='ok', + lines=lines, + ) + + def build_gen_export_preview_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建代码导出预演分区。 + + :param payload: `gen export --dry-run` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='导出预览', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='导出预览', empty_value='不可用' + ), + ) + + results = payload.get('results') if isinstance(payload.get('results'), list) else [] + lines = [ + '## 预演结果', + f'执行模式: {payload.get("mode", "-")}', + f'dry-run: {"是" if payload.get("dryRun", False) else "否"}', + f'表数量: {len(payload.get("tableNames", [])) if isinstance(payload.get("tableNames"), list) else 0}', + f'结果数量: {len(results)}', + '', + '## 摘要', + f'结果摘要: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("message", "-"), 72)}', + ] + if payload.get('outputFile'): + lines.append(f'输出文件: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("outputFile", "-"), 72)}') + if payload.get('genPath'): + lines.append(f'输出目录: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("genPath", "-"), 72)}') + if results: + lines.extend(['', '## 结果样本']) + for item in results[:4]: + if not isinstance(item, dict): + continue + lines.append( + f'> {item.get("tableName", "-")} · {"成功" if item.get("ok", False) else "失败"} · ' + f'{SHELL_TEXT_FORMATTER.truncate_text(item.get("message", "-"), 48)}' + ) + return DetailSectionSnapshot( + title='导出预览', + status='ok', + lines=lines, + ) + + def build_importable_tables_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建数据库可导入表共享分区。 + + :param payload: `gen db-list` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='可导入数据表', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='数据表', empty_value='不可用' + ), + ) + rows = self.page_adapter.extract_page_rows(payload) + lines = TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='可导入数据表', + empty_value='0 张', + detail='当前环境没有可导入的数据库表', + ) + if rows: + lines = [ + f'{SHELL_TEXT_FORMATTER.truncate_text(row.get("tableName", "-"), 40)} · {SHELL_TEXT_FORMATTER.truncate_text(row.get("tableComment", "-"), 48)}' + for row in rows[:8] + ] + return DetailSectionSnapshot( + title='可导入数据表', + status='ok', + lines=lines, + ) + + @staticmethod + def build_gen_export_entry_section(table_name: str) -> DetailSectionSnapshot: + """ + 构建代码导出向导入口分区。 + + :param table_name: 当前业务表名称 + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='导出入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario=f'准备导出当前业务表 {table_name} 的生成结果时,应先通过向导确认目标表、输出目录和覆盖范围。', + command=TUI_COPY.build_cli_command_hint('wizard', 'gen-export', '--output=text'), + guide='进入向导后优先选择当前业务表,并在最终确认前检查导出目录和文件覆盖预览。', + ), + ) + + @staticmethod + def build_gen_import_entry_section(importable_rows: list[dict[str, Any]]) -> DetailSectionSnapshot: + """ + 构建物理表导入入口分区。 + + :param importable_rows: 可导入物理表列表 + :return: 分区快照 + """ + suggested_table_names = [ + str(row.get('tableName', '') or '').strip() + for row in importable_rows[:3] + if str(row.get('tableName', '') or '').strip() + ] + suggested_tables = ' '.join(suggested_table_names) if suggested_table_names else '' + return DetailSectionSnapshot( + title='导入入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备把数据库物理表纳入代码生成管理时,应先核对物理表名、注释和目标环境,再通过导入命令执行 dry-run 预演。', + command=TUI_COPY.build_cli_command_hint( + 'gen', 'import-table', suggested_tables, '--dry-run', '--output=text' + ), + guide='建议先从“可导入数据表”中确认目标表名,必要时一次只导入 1 到 3 张表,确认 dry-run 输出后再执行真实导入。', + ), + ) + + @staticmethod + def build_gen_create_entry_section() -> DetailSectionSnapshot: + """ + 构建建表 SQL 导入入口分区。 + + :return: 分区快照 + """ + sql_template = 'CREATE TABLE demo_table (id bigint primary key);' + return DetailSectionSnapshot( + title='建表入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备根据建表 SQL 直接创建物理表并导入代码生成配置时,应先使用单条 SQL 执行 dry-run 预演,确认语句可解析且只包含目标表。', + command=TUI_COPY.build_cli_command_hint( + 'gen', 'create-table', '--dry-run', '--sql', sql_template, '--output=text' + ), + guide='建议优先使用单条 CREATE TABLE 语句做预演;若 SQL 较长或来自文件,可改用 --sql-file 方式,但不要同时传入 --sql 与 --sql-file。', + ), + ) + + def load_gen_detail_sections( + self, + table_row: dict[str, Any], + env: str, + ) -> list[DetailSectionSnapshot]: + """ + 按需加载单条业务表详情分区。 + + :param table_row: 业务表列表行数据 + :param env: 当前运行环境 + :return: 详情分区列表 + """ + table_id = table_row.get('tableId') + detail_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'detail', + str(table_id), + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + preview_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'preview', + str(table_id), + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + table_name = str(table_row.get('tableName', '-') or '-') + export_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'export', + table_name, + f'--env={env}', + '--dry-run', + '--mode=zip', + '--output=json', + '--yes', + parse_json=True, + ).payload + sync_check_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'db-list', + f'--env={env}', + f'--table-name={table_name}', + '--paged', + '--page-size=5', + '--output=json', + parse_json=True, + ).payload + return [ + self.build_gen_focus_section(detail_payload), + self.build_gen_generation_section(detail_payload), + self.build_gen_column_summary_section(detail_payload), + self.build_gen_precheck_section(detail_payload, preview_payload), + self.build_gen_sync_precheck_section(table_name, sync_check_payload), + self.build_gen_columns_section(detail_payload), + self.build_gen_preview_section(preview_payload), + self.build_gen_export_preview_section(export_payload), + self.build_gen_export_entry_section(table_name), + ] + + def build_gen_overview_section( + self, + gen_rows: list[dict[str, Any]], + filtered_rows: list[dict[str, Any]], + importable_rows: list[dict[str, Any]], + ) -> DetailSectionSnapshot: + """ + 构建代码生成页总览判断共享分区。 + + :param gen_rows: 全量业务表行列表 + :param filtered_rows: 当前筛选后的业务表行列表 + :param importable_rows: 可导入物理表行列表 + :return: 分区快照 + """ + incomplete_count = sum( + 1 + for row in gen_rows + if not str(row.get('className', '') or '').strip() + or not str(row.get('moduleName', '') or '').strip() + or not str(row.get('businessName', '') or '').strip() + ) + status = 'ok' + conclusion = '当前生成配置可继续下钻,优先查看预检查、代码预览和导出预演' + if incomplete_count > 0: + status = 'warn' + conclusion = '存在生成配置不完整的业务表,建议先处理生成前校验风险' + elif not gen_rows and importable_rows: + status = 'info' + conclusion = '当前还没有业务表配置,可先从可导入物理表中选择目标' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'已加载业务表: {len(gen_rows)} 张', + f'当前匹配: {len(filtered_rows)} 张', + f'可导入物理表: {len(importable_rows)} 张', + f'配置待补全: {incomplete_count} 张', + '', + '## 建议入口', + '优先关注:生成前校验 / 同步预检查 / 代码预览 / 导出预览 / 导入入口 / 建表入口', + ], + ) + + +class GenRecordBuilder: + """ + 代码生成浏览记录构建器。 + + 该对象负责构建代码生成页单条业务表浏览记录与失败兜底记录。 + + :param page_adapter: 代码生成浏览页适配器 + :param section_builder: 代码生成浏览页分区构建器 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + section_builder: GenSectionBuilder, + ) -> None: + """ + 初始化代码生成浏览记录构建器。 + + :param page_adapter: 代码生成浏览页适配器 + :param section_builder: 代码生成浏览页分区构建器 + :return: None + """ + self.page_adapter = page_adapter + self.section_builder = section_builder + + def build_gen_record(self, table_row: dict[str, Any], env: str) -> BrowserRecordSnapshot: + """ + 构建单条业务表浏览记录。 + + :param table_row: 业务表列表行数据 + :param env: 当前运行环境 + :return: 浏览记录快照 + """ + table_id = table_row.get('tableId', '-') + table_name = str(table_row.get('tableName', '-') or '-') + class_name = str(table_row.get('className', '-') or '-') + module_name = str(table_row.get('moduleName', '-') or '-') + + return BrowserRecordSnapshot( + key=f'gen:{table_id}', + title=SHELL_TEXT_FORMATTER.truncate_text(table_name, 40), + status='ok', + summary=f'生成类 {SHELL_TEXT_FORMATTER.truncate_text(class_name, 24)} · 模块 {SHELL_TEXT_FORMATTER.truncate_text(module_name, 20)}', + metadata_lines=[ + '## 表身份', + f'表 ID: {table_id}', + '', + '## 生成信息', + f'生成类名: {SHELL_TEXT_FORMATTER.truncate_text(class_name, 32)}', + f'所属模块: {SHELL_TEXT_FORMATTER.truncate_text(module_name, 24)}', + f'业务标识: {SHELL_TEXT_FORMATTER.truncate_text(table_row.get("businessName", "-"), 24)}', + ], + detail_sections=[], + detail_loader=lambda table_row=table_row, env=env: self.section_builder.load_gen_detail_sections( + table_row, env + ), + ) + + def build_failure_record(self, payload: dict[str, Any] | None) -> BrowserRecordSnapshot: + """ + 构建代码生成页失败兜底记录。 + + :param payload: 失败结果负载 + :return: 浏览记录快照 + """ + return self.page_adapter.build_failure_record( + key='gen:unavailable', + subject='代码生成', + section_subject='业务表列表', + payload=payload, + ) + + +class GenBrowserAdapter(BaseBrowserAdapter): + """ + 代码生成浏览页适配器。 + + 该适配器负责采集业务表列表、详情、预览与可导入表清单,并委托 + 协作对象完成共享分区、详情分区和记录构建。 + """ + + def __init__( + self, + rendering: GenRenderingSupport | None = None, + section_builder: GenSectionBuilder | None = None, + record_builder: GenRecordBuilder | None = None, + ) -> None: + """ + 初始化代码生成浏览页适配器。 + + :param rendering: 代码生成浏览页渲染支持对象 + :param section_builder: 代码生成浏览页分区构建器 + :param record_builder: 代码生成浏览记录构建器 + :return: None + """ + super().__init__( + page_title='代码生成', + search_view_key='gen', + filter_options=(), + ) + self.rendering = rendering or GenRenderingSupport() + self.section_builder = section_builder or GenSectionBuilder(self, self.rendering) + self.record_builder = record_builder or GenRecordBuilder(self, self.section_builder) + + @staticmethod + def apply_gen_query(rows: list[dict[str, Any]], query: str) -> list[dict[str, Any]]: + """ + 按业务表名、生成类名或模块名查询词过滤业务表行数据。 + + :param rows: 原始业务表行列表 + :param query: 当前搜索词 + :return: 过滤后的业务表行列表 + """ + normalized_query = str(query).strip().lower() + if not normalized_query: + return rows + return [ + row + for row in rows + if normalized_query in str(row.get('tableName', '') or '').strip().lower() + or normalized_query in str(row.get('className', '') or '').strip().lower() + or normalized_query in str(row.get('moduleName', '') or '').strip().lower() + ] + + def collect_snapshot(self, env: str, query: str = '') -> BrowserPageSnapshot: + """ + 采集代码生成浏览页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 浏览页快照 + """ + search_context = self.resolve_search_context(query) + gen_tables_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'list', + f'--env={env}', + '--paged', + '--page-size=8', + '--output=json', + parse_json=True, + ).payload + db_tables_payload = NESTED_CLI_SUPPORT.run( + 'gen', + 'db-list', + f'--env={env}', + '--paged', + '--page-size=8', + '--output=json', + parse_json=True, + ).payload + importable_rows = self.extract_page_rows(db_tables_payload) + + if not isinstance(gen_tables_payload, dict) or not gen_tables_payload.get('ok', False): + return BrowserPageSnapshot( + title='代码生成', + subtitle=TUI_COPY.build_unavailable_subtitle( + '业务表', + SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(gen_tables_payload), 72), + ), + records=[self.record_builder.build_failure_record(gen_tables_payload)], + shared_sections=[ + self.section_builder.build_gen_overview_section([], [], importable_rows), + self.section_builder.build_importable_tables_section(db_tables_payload), + self.section_builder.build_gen_import_entry_section(importable_rows), + self.section_builder.build_gen_create_entry_section(), + ], + search=search_context, + ) + + rows = self.extract_page_rows(gen_tables_payload) + filtered_rows = self.apply_gen_query(rows, query) + records = [self.record_builder.build_gen_record(table_row, env) for table_row in filtered_rows[:8]] + if not records: + records = [ + self.build_empty_record( + key='gen:none', + subject='业务表', + empty_label='业务表', + has_source_rows=bool(rows), + filtered_summary='当前搜索条件下没有匹配业务表', + empty_summary='当前环境中还没有纳入代码生成的业务表', + filtered_empty_value='暂无匹配', + empty_empty_value='暂无配置', + filtered_detail='当前搜索条件下没有匹配业务表', + empty_detail='当前环境中尚未配置代码生成业务表', + ) + ] + + return BrowserPageSnapshot( + title='代码生成', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_gen_diagnostic_subtitle( + len(filtered_rows), + len(importable_rows), + ), + records=records, + shared_sections=[ + self.section_builder.build_gen_overview_section(rows, filtered_rows, importable_rows), + self.section_builder.build_importable_tables_section(db_tables_payload), + self.section_builder.build_gen_import_entry_section(importable_rows), + self.section_builder.build_gen_create_entry_section(), + ], + search=search_context, + ) + + +GEN_BROWSER_ADAPTER = GenBrowserAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/health.py b/shierfeng-fastapi-backend/cli/tui/adapters/health.py new file mode 100644 index 0000000..8aefde4 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/health.py @@ -0,0 +1,988 @@ +from dataclasses import dataclass, field +from typing import Any + +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.tui.keymaps import TUI_KEYMAP_REGISTRY +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + +DEPENDENCY_CHECK_TOTAL = 3 +DASHBOARD_PANEL_MAX_LINES = 8 +DASHBOARD_PANEL_LINE_MAX_LENGTH = 38 +DASHBOARD_PANEL_MORE_HINT = TUI_COPY.build_more_detail_hint() + + +@dataclass(frozen=True) +class DashboardPanelSnapshot: + """ + TUI 首页单个面板快照。 + + :param title: 面板标题 + :param status: 面板状态 + :param lines: 面板正文文本行 + """ + + title: str + status: str + lines: list[str] + + +@dataclass(frozen=True) +class DashboardMetricSnapshot: + """ + TUI 首页单个指标卡快照。 + + :param title: 指标标题 + :param value: 指标主值 + :param status: 指标状态 + :param hint: 指标补充说明 + """ + + title: str + value: str + status: str + hint: str + + +@dataclass(frozen=True) +class DashboardSnapshot: + """ + TUI 首页聚合快照。 + + :param env: 当前运行环境 + :param panels: 面板列表 + """ + + env: str + panels: list[DashboardPanelSnapshot] + metrics: list[DashboardMetricSnapshot] = field(default_factory=list) + + +@dataclass(frozen=True) +class DashboardSourcePayloads: + """ + TUI 首页聚合数据源快照。 + + :param app_env_payload: 应用环境结果 + :param app_routes_payload: 应用路由结果 + :param doctor_payload: 应用检查结果 + :param database_payload: 数据库版本结果 + :param cache_payload: 缓存统计结果 + :param deps_payload: 依赖检查结果 + :param server_payload: 服务器摘要结果 + """ + + app_env_payload: dict[str, Any] | None + app_routes_payload: dict[str, Any] | None + doctor_payload: dict[str, Any] | None + database_payload: dict[str, Any] | None + cache_payload: dict[str, Any] | None + deps_payload: dict[str, Any] | None + server_payload: dict[str, Any] | None + + +class DashboardSnapshotCollector: + """ + TUI 首页聚合数据采集器。 + + 该对象负责从多路 CLI 命令收集 dashboard 所需原始结果, + 让 `DashboardAdapter` 保持首页装配职责,而不继续承载所有采集细节。 + """ + + def collect(self, env: str) -> DashboardSourcePayloads: + """ + 采集首页聚合所需的多路原始结果。 + + :param env: 当前运行环境 + :return: 首页聚合数据源快照 + """ + return DashboardSourcePayloads( + app_env_payload=NESTED_CLI_SUPPORT.run( + 'app', + 'env', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + app_routes_payload=NESTED_CLI_SUPPORT.run( + 'app', + 'routes', + f'--env={env}', + '--group-by=tag', + '--output=json', + parse_json=True, + ).payload, + doctor_payload=NESTED_CLI_SUPPORT.run( + 'app', + 'doctor', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + database_payload=NESTED_CLI_SUPPORT.run( + 'db', + 'current', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + cache_payload=NESTED_CLI_SUPPORT.run( + 'cache', + 'stats', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + deps_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'deps', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + server_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'server-info', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ) + + +class DashboardFormattingSupport: + """ + 首页仪表盘格式化支持对象。 + + 该对象负责统一处理摘要消息提取、状态优先级、布尔文本、信号条和 + 面板空态/失败态文案,供面板与指标构建对象共享。 + """ + + @staticmethod + def truncate_dashboard_line(line: str) -> str: + """ + 截断首页面板单行文本,并保留结构化前缀。 + + :param line: 原始文本行 + :return: 截断后的文本行 + """ + stripped = str(line).strip() + if not stripped: + return '' + if stripped.startswith('## '): + return f'## {SHELL_TEXT_FORMATTER.truncate_text(stripped[3:].strip(), DASHBOARD_PANEL_LINE_MAX_LENGTH - 3)}' + if stripped.startswith('> '): + return f'> {SHELL_TEXT_FORMATTER.truncate_text(stripped[2:].strip(), DASHBOARD_PANEL_LINE_MAX_LENGTH - 2)}' + return SHELL_TEXT_FORMATTER.truncate_text(stripped, DASHBOARD_PANEL_LINE_MAX_LENGTH) + + @staticmethod + def resolve_status_priority(status: str) -> int: + """ + 解析状态优先级,值越小越需要优先关注。 + + :param status: 状态文本 + :return: 优先级 + """ + return { + 'fail': 0, + 'warn': 1, + 'ok': 2, + 'info': 3, + }.get(str(status).strip().lower(), 9) + + @staticmethod + def render_bool_flag(value: object) -> str: + """ + 将布尔语义值标准化为文本。 + + :param value: 原始值 + :return: 规范化后的文本 + """ + return '是' if bool(value) else '否' + + @staticmethod + def render_signal_bar( + passed: int, + total: int, + *, + width: int = 8, + on: str = '#', + off: str = '-', + ) -> str: + """ + 将通过数量渲染为 ASCII 信号条。 + + :param passed: 已通过数量 + :param total: 总数量 + :param width: 信号条宽度 + :param on: 点亮字符 + :param off: 熄灭字符 + :return: ASCII 信号条 + """ + if total <= 0: + return f'[{off * width}]' + safe_passed = max(0, min(passed, total)) + filled = round((safe_passed / total) * width) + return f'[{on * filled}{off * max(0, width - filled)}]' + + @staticmethod + def extract_payload_message(payload: dict[str, Any] | None) -> str: + """ + 提取结果负载中的摘要消息。 + + :param payload: 标准结果负载 + :return: 摘要文本 + """ + if not isinstance(payload, dict): + return '-' + if payload.get('message'): + return str(payload.get('message')) + if payload.get('error'): + return SHELL_TEXT_FORMATTER.truncate_text(payload.get('error'), 120) + return '-' + + def build_failure_lines( + self, + payload: dict[str, Any] | None, + *, + summary_label: str, + summary_value: str, + suggestion: str = TUI_COPY.build_dashboard_failure_suggestion(), + ) -> list[str]: + """ + 构建首页面板统一失败态摘要。 + + :param payload: 标准结果负载 + :param summary_label: 主字段名称 + :param summary_value: 主字段值 + :param suggestion: 建议操作 + :return: 面板正文 + """ + return [ + '## 当前状态', + f'{summary_label}: {summary_value}', + '', + '## 错误摘要', + f'> {self.extract_payload_message(payload)}', + '', + '## 建议操作', + suggestion, + ] + + @staticmethod + def build_empty_lines( + *, + summary_label: str, + summary_value: str, + detail: str, + suggestion: str = TUI_COPY.build_dashboard_empty_suggestion(), + ) -> list[str]: + """ + 构建首页面板统一空态摘要。 + + :param summary_label: 主字段名称 + :param summary_value: 主字段值 + :param detail: 空态说明 + :param suggestion: 建议操作 + :return: 面板正文 + """ + return [ + '## 当前状态', + f'{summary_label}: {summary_value}', + '', + '## 说明', + detail, + '', + '## 建议操作', + suggestion, + ] + + +class DashboardPanelCompressor: + """ + 首页面板压缩器。 + + 该对象负责将原始多行面板压缩为适合首页展示的统一密度摘要卡。 + + :param formatting: 首页仪表盘格式化支持对象 + """ + + def __init__(self, formatting: DashboardFormattingSupport) -> None: + """ + 初始化首页面板压缩器。 + + :param formatting: 首页仪表盘格式化支持对象 + :return: None + """ + self.formatting = formatting + + def compact_panel_lines(self, lines: list[str]) -> list[str]: + """ + 将首页面板正文压缩为统一长度的摘要卡内容。 + + :param lines: 原始正文文本行 + :return: 压缩后的摘要行列表 + """ + compact_lines: list[str] = [] + for raw_line in lines: + compact_line = self.formatting.truncate_dashboard_line(raw_line) + if not compact_line: + if compact_lines and compact_lines[-1] != '': + compact_lines.append('') + continue + compact_lines.append(compact_line) + + while compact_lines and compact_lines[0] == '': + compact_lines.pop(0) + while compact_lines and compact_lines[-1] == '': + compact_lines.pop() + + if len(compact_lines) <= DASHBOARD_PANEL_MAX_LINES: + return compact_lines + + summarized_lines = compact_lines[: DASHBOARD_PANEL_MAX_LINES - 1] + while summarized_lines and summarized_lines[-1] == '': + summarized_lines.pop() + summarized_lines.append(DASHBOARD_PANEL_MORE_HINT) + return summarized_lines + + def compact_panels(self, panels: list[DashboardPanelSnapshot]) -> list[DashboardPanelSnapshot]: + """ + 将首页所有面板压缩为统一密度的摘要卡。 + + :param panels: 原始面板列表 + :return: 压缩后的面板列表 + """ + return [ + DashboardPanelSnapshot( + title=panel.title, + status=panel.status, + lines=self.compact_panel_lines(panel.lines), + ) + for panel in panels + ] + + +class DashboardPanelBuilder: + """ + 首页面板构建器。 + + 该对象负责根据各个 CLI 结果负载构建首页展示面板,并统一风险热区与 + 建议入口逻辑。 + + :param formatting: 首页仪表盘格式化支持对象 + """ + + def __init__(self, formatting: DashboardFormattingSupport) -> None: + """ + 初始化首页面板构建器。 + + :param formatting: 首页仪表盘格式化支持对象 + :return: None + """ + self.formatting = formatting + + def build_app_env_panel( + self, + env: str, + env_payload: dict[str, Any] | None, + routes_payload: dict[str, Any] | None, + ) -> DashboardPanelSnapshot: + """ + 构建应用环境总览面板。 + + :param env: 当前运行环境 + :param env_payload: `app env` JSON 负载 + :param routes_payload: `app routes` JSON 负载 + :return: 面板快照 + """ + runtime = env_payload.get('runtime') if isinstance(env_payload, dict) else None + route_count = routes_payload.get('count', 0) if isinstance(routes_payload, dict) else 0 + grouped_routes = routes_payload.get('groupedRoutes') if isinstance(routes_payload, dict) else None + group_count = len(grouped_routes) if isinstance(grouped_routes, dict) else 0 + if not isinstance(runtime, dict): + return DashboardPanelSnapshot( + title='应用摘要', + status='fail', + lines=self.formatting.build_failure_lines( + env_payload, + summary_label='环境', + summary_value=env, + suggestion=TUI_COPY.build_dashboard_page_suggestion('应用', '检查环境解析结果'), + ), + ) + return DashboardPanelSnapshot( + title='应用摘要', + status='ok' if env_payload.get('ok', False) else 'fail', + lines=[ + '## 环境映射', + f'当前环境: {env} | CLI 目标环境: {runtime.get("cliEnv", "-")}', + f'配置文件环境: {runtime.get("configEnv", "-")}', + '## 路由摘要', + f'注册路由: {route_count} 条 | 标签分组: {group_count} 个', + '## 环境文件', + f'已加载环境文件: {runtime.get("envFile", "-")}', + f'环境文件存在: {self.formatting.render_bool_flag(runtime.get("envFileExists", False))}', + ], + ) + + def build_health_panel(self, payload: dict[str, Any] | None) -> DashboardPanelSnapshot: + """ + 构建健康检查面板。 + + :param payload: `app doctor` JSON 负载 + :return: 面板快照 + """ + if not isinstance(payload, dict): + return DashboardPanelSnapshot( + title='系统摘要', + status='fail', + lines=self.formatting.build_failure_lines( + payload, + summary_label='巡检结果', + summary_value='不可用', + suggestion=TUI_COPY.build_dashboard_page_suggestion('运维/健康检查', '查看原因'), + ), + ) + + database = payload.get('database') if isinstance(payload.get('database'), dict) else {} + redis = payload.get('redis') if isinstance(payload.get('redis'), dict) else {} + crypto = payload.get('crypto') if isinstance(payload.get('crypto'), dict) else {} + return DashboardPanelSnapshot( + title='系统摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 总体态势', + f'整体结果: {"通过" if payload.get("ok", False) else "异常"}', + '', + '## 依赖检查', + f'数据库: {"正常" if database.get("ok", False) else "异常"}', + f'> {self.formatting.extract_payload_message(database)}', + f'Redis: {"正常" if redis.get("ok", False) else "异常"}', + f'> {self.formatting.extract_payload_message(redis)}', + f'加密组件: {"正常" if crypto.get("ok", False) else "异常"}', + f'> {self.formatting.extract_payload_message(crypto)}', + ], + ) + + def build_recommended_entry_panel( + self, + doctor_payload: dict[str, Any] | None, + database_payload: dict[str, Any] | None, + cache_payload: dict[str, Any] | None, + ) -> DashboardPanelSnapshot: + """ + 构建首页建议入口面板。 + + :param doctor_payload: 健康检查负载 + :param database_payload: 数据库状态负载 + :param cache_payload: 缓存状态负载 + :return: 面板快照 + """ + database_ok = ( + bool(doctor_payload.get('database', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + ) + redis_ok = bool(doctor_payload.get('redis', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + crypto_ok = ( + bool(doctor_payload.get('crypto', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + ) + db_revision = str(database_payload.get('currentRevision', '-') if isinstance(database_payload, dict) else '-') + cache_size = cache_payload.get('dbSize', '-') if isinstance(cache_payload, dict) else '-' + + if not database_ok: + status = 'fail' + lines = [ + '## 首选入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("database").upper()}] 数据库', + f'> {TUI_DIAGNOSTIC_SERVICE.build_database_focus_hint()}', + '', + '## 次级入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("ops").upper()}] 运维', + f'> {TUI_DIAGNOSTIC_SERVICE.build_ops_focus_hint()}', + '', + '## 当前判断', + f'迁移版本: {db_revision}', + '> 数据库异常会优先阻断后续业务巡检', + ] + elif not redis_ok: + status = 'fail' + lines = [ + '## 首选入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("cache").upper()}] 缓存', + f'> {TUI_DIAGNOSTIC_SERVICE.build_cache_focus_hint()}', + '', + '## 次级入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("ops").upper()}] 运维', + f'> {TUI_DIAGNOSTIC_SERVICE.build_ops_focus_hint()}', + '', + '## 当前判断', + f'Redis 键数: {cache_size}', + '> 缓存异常通常会影响配置读取和任务运行', + ] + elif not crypto_ok: + status = 'warn' + lines = [ + '## 首选入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("crypto").upper()}] 加密', + '> 先检查运行校验、公钥身份和兼容版本', + '', + '## 次级入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("ops").upper()}] 运维', + '> 对照依赖版本,确认是否缺少加密相关运行依赖', + '', + '## 当前判断', + '> 加密异常不会立即阻断全部能力,但会影响安全链路', + ] + else: + status = 'ok' + lines = [ + '## 首选入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("jobs").upper()}] 任务 · {TUI_DIAGNOSTIC_SERVICE.build_jobs_focus_hint()}', + '## 次级入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("configs").upper()}] 参数配置 · {TUI_DIAGNOSTIC_SERVICE.build_configs_focus_hint()}', + '## 扩展入口', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("gen").upper()}] 代码生成 · {TUI_DIAGNOSTIC_SERVICE.build_gen_focus_hint()}', + f'[{TUI_KEYMAP_REGISTRY.get_navigation_shortcut("app").upper()}] 应用 · 配置摘要 / 路由状态', + ] + + return DashboardPanelSnapshot( + title='建议摘要', + status=status, + lines=lines, + ) + + def build_inspection_conclusion_panel( + self, + doctor_payload: dict[str, Any] | None, + database_payload: dict[str, Any] | None, + cache_payload: dict[str, Any] | None, + ) -> DashboardPanelSnapshot: + """ + 构建首页巡检结论面板。 + + :param doctor_payload: 健康检查负载 + :param database_payload: 数据库状态负载 + :param cache_payload: 缓存状态负载 + :return: 面板快照 + """ + database_ok = ( + bool(doctor_payload.get('database', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + ) + redis_ok = bool(doctor_payload.get('redis', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + crypto_ok = ( + bool(doctor_payload.get('crypto', {}).get('ok', False)) if isinstance(doctor_payload, dict) else False + ) + db_revision = database_payload.get('currentRevision', '-') if isinstance(database_payload, dict) else '-' + cache_size = cache_payload.get('dbSize', '-') if isinstance(cache_payload, dict) else '-' + + if not database_ok: + status = 'fail' + conclusion = '数据库存在异常,建议优先处理连接或迁移问题' + next_step = '优先进入数据库页面,确认迁移版本和连接配置' + elif not redis_ok: + status = 'fail' + conclusion = '缓存服务存在异常,建议优先检查 Redis 可用性' + next_step = '优先进入缓存页面,确认连接数、键数量和状态说明' + elif not crypto_ok: + status = 'warn' + conclusion = '加密组件状态异常,建议尽快核对运行依赖' + next_step = '先查看系统摘要面板,再排查加密组件依赖' + else: + status = 'ok' + conclusion = '当前核心依赖状态正常,可继续查看业务分区' + next_step = '优先查看任务与参数配置页面,确认业务侧是否有风险' + + return DashboardPanelSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 建议操作', + next_step, + '', + '## 当前快照', + f'迁移版本: {db_revision}', + f'Redis 键数: {cache_size}', + ], + ) + + def build_database_panel(self, payload: dict[str, Any] | None) -> DashboardPanelSnapshot: + """ + 构建数据库状态面板。 + + :param payload: `db current` JSON 负载 + :return: 面板快照 + """ + current_revision = payload.get('currentRevision', '-') if isinstance(payload, dict) else '-' + if not isinstance(payload, dict) or not payload.get('ok', False): + return DashboardPanelSnapshot( + title='数据库摘要', + status='fail', + lines=self.formatting.build_failure_lines( + payload, + summary_label='迁移版本', + summary_value=str(current_revision or '-'), + suggestion=TUI_COPY.build_dashboard_page_suggestion('数据库', '确认迁移版本与连接状态'), + ), + ) + return DashboardPanelSnapshot( + title='数据库摘要', + status='ok', + lines=[ + '## 迁移信息', + f'迁移版本: {current_revision}', + '', + '## 状态说明', + f'> {self.formatting.extract_payload_message(payload)}', + ], + ) + + def build_cache_panel(self, payload: dict[str, Any] | None) -> DashboardPanelSnapshot: + """ + 构建缓存状态面板。 + + :param payload: `cache stats` JSON 负载 + :return: 面板快照 + """ + if not isinstance(payload, dict): + return DashboardPanelSnapshot( + title='缓存摘要', + status='fail', + lines=self.formatting.build_failure_lines( + payload, + summary_label='缓存状态', + summary_value='不可用', + suggestion=TUI_COPY.build_dashboard_page_suggestion('缓存', '查看 Redis 状态'), + ), + ) + info = payload.get('info') if isinstance(payload.get('info'), dict) else {} + cache_names = payload.get('cacheNames') if isinstance(payload.get('cacheNames'), list) else [] + return DashboardPanelSnapshot( + title='缓存摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## Redis 概况', + f'当前键数: {payload.get("dbSize", "-")}', + f'Redis 版本: {info.get("redis_version", "-")}', + f'客户端连接数: {info.get("connected_clients", "-")}', + '', + '## 缓存资源', + f'已登记缓存名: {len(cache_names)} 个', + ], + ) + + def build_dependency_panel(self, payload: dict[str, Any] | None) -> DashboardPanelSnapshot: + """ + 构建首页依赖版本摘要面板。 + + :param payload: `ops deps` JSON 负载 + :return: 面板快照 + """ + if not isinstance(payload, dict): + return DashboardPanelSnapshot( + title='依赖版本', + status='fail', + lines=self.formatting.build_failure_lines( + payload, + summary_label='依赖检查', + summary_value='不可用', + suggestion=TUI_COPY.build_dashboard_page_suggestion('运维', '检查依赖详情'), + ), + ) + packages = payload.get('packages') if isinstance(payload.get('packages'), dict) else {} + missing_required = payload.get('missingRequired') if isinstance(payload.get('missingRequired'), list) else [] + lines = [ + '## 依赖结论', + f'检查结果: {"通过" if payload.get("ok", False) else "异常"}', + f'缺失核心依赖: {len(missing_required)} 个', + '', + '## 关键版本', + ] + for package_name in ('python', 'fastapi', 'sqlalchemy', 'redis'): + package_payload = packages.get(package_name) + if not isinstance(package_payload, dict): + continue + installed = '已安装' if package_payload.get('installed', False) else '缺失' + lines.append(f'{package_name}: {installed} · {package_payload.get("version", "-") or "-"}') + return DashboardPanelSnapshot( + title='依赖版本', + status='ok' if payload.get('ok', False) else 'fail', + lines=lines, + ) + + def build_server_info_panel(self, payload: dict[str, Any] | None) -> DashboardPanelSnapshot: + """ + 构建首页服务器概况面板。 + + :param payload: `ops server-info` JSON 负载 + :return: 面板快照 + """ + server = payload.get('server') if isinstance(payload, dict) else None + if not isinstance(server, dict): + return DashboardPanelSnapshot( + title='服务器摘要', + status='fail', + lines=self.formatting.build_failure_lines( + payload, + summary_label='服务器摘要', + summary_value='不可用', + suggestion=TUI_COPY.build_dashboard_page_suggestion('运维', '重新采集服务器摘要'), + ), + ) + sys_info = server.get('sys') if isinstance(server.get('sys'), dict) else {} + cpu_info = server.get('cpu') if isinstance(server.get('cpu'), dict) else {} + mem_info = server.get('mem') if isinstance(server.get('mem'), dict) else {} + return DashboardPanelSnapshot( + title='服务器摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 主机状态', + f'主机名: {sys_info.get("computerName", "-")}', + f'主机 IP: {sys_info.get("computerIp", "-")}', + '', + '## 资源概况', + f'CPU 使用率: {cpu_info.get("used", "-")}%', + f'内存使用率: {mem_info.get("usage", "-")}%', + ], + ) + + def build_risk_heatmap_panel(self, panels: list[DashboardPanelSnapshot]) -> DashboardPanelSnapshot: + """ + 构建首页风险热区面板。 + + :param panels: 当前已构建的面板列表 + :return: 风险热区面板 + """ + sorted_panels = sorted( + panels, key=lambda item: (self.formatting.resolve_status_priority(item.status), item.title) + ) + fail_panels = [panel for panel in sorted_panels if panel.status == 'fail'] + warn_panels = [panel for panel in sorted_panels if panel.status == 'warn'] + primary_targets = fail_panels[:3] or warn_panels[:3] or sorted_panels[:3] + + lines = [ + '## 热区摘要', + f'失败面板: {len(fail_panels)} 个', + f'警告面板: {len(warn_panels)} 个', + '', + '## 优先关注', + ] + if not primary_targets: + lines.extend( + self.formatting.build_empty_lines( + summary_label='风险热区', + summary_value='0 个', + detail='当前没有需要优先处理的失败或警告面板', + suggestion='可继续浏览任务、缓存、参数配置等业务页面', + ) + ) + else: + for index, panel in enumerate(primary_targets, start=1): + lead_line = SHELL_TEXT_FORMATTER.truncate_text( + panel.lines[1] if len(panel.lines) > 1 else panel.lines[0], 56 + ) + lines.extend( + [ + f'> HOT-{index:02d} [{panel.status.upper()}] {panel.title}', + f'> {lead_line}', + ] + ) + + status = 'fail' if fail_panels else 'warn' if warn_panels else 'ok' + return DashboardPanelSnapshot( + title='风险摘要', + status=status, + lines=lines, + ) + + def build_panels( + self, + *, + env: str, + app_env_payload: dict[str, Any] | None, + app_routes_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + database_payload: dict[str, Any] | None, + cache_payload: dict[str, Any] | None, + deps_payload: dict[str, Any] | None, + server_payload: dict[str, Any] | None, + ) -> list[DashboardPanelSnapshot]: + """ + 构建首页全部原始面板。 + + :param env: 当前运行环境 + :param app_env_payload: 应用环境负载 + :param app_routes_payload: 应用路由负载 + :param doctor_payload: 健康检查负载 + :param database_payload: 数据库状态负载 + :param cache_payload: 缓存状态负载 + :param deps_payload: 运维依赖负载 + :param server_payload: 服务器摘要负载 + :return: 原始面板列表 + """ + panels = [ + self.build_app_env_panel(env, app_env_payload, app_routes_payload), + self.build_health_panel(doctor_payload), + self.build_inspection_conclusion_panel(doctor_payload, database_payload, cache_payload), + self.build_recommended_entry_panel(doctor_payload, database_payload, cache_payload), + self.build_database_panel(database_payload), + self.build_cache_panel(cache_payload), + self.build_dependency_panel(deps_payload), + self.build_server_info_panel(server_payload), + ] + panels.append(self.build_risk_heatmap_panel(panels)) + return panels + + +class DashboardMetricBuilder: + """ + 首页指标卡构建器。 + + 该对象负责根据健康检查、数据库和缓存状态构建首页驾驶舱指标卡。 + + :param formatting: 首页仪表盘格式化支持对象 + """ + + def __init__(self, formatting: DashboardFormattingSupport) -> None: + """ + 初始化首页指标卡构建器。 + + :param formatting: 首页仪表盘格式化支持对象 + :return: None + """ + self.formatting = formatting + + def build_metrics( + self, + doctor_payload: dict[str, Any] | None, + database_payload: dict[str, Any] | None, + cache_payload: dict[str, Any] | None, + ) -> list[DashboardMetricSnapshot]: + """ + 构建首页驾驶舱指标卡。 + + :param doctor_payload: 健康检查负载 + :param database_payload: 数据库状态负载 + :param cache_payload: 缓存状态负载 + :return: 指标卡列表 + """ + database = doctor_payload.get('database') if isinstance(doctor_payload, dict) else None + redis = doctor_payload.get('redis') if isinstance(doctor_payload, dict) else None + crypto = doctor_payload.get('crypto') if isinstance(doctor_payload, dict) else None + + dependency_results = [ + bool(database.get('ok', False)) if isinstance(database, dict) else False, + bool(redis.get('ok', False)) if isinstance(redis, dict) else False, + bool(crypto.get('ok', False)) if isinstance(crypto, dict) else False, + ] + passed_dependencies = sum(1 for item in dependency_results if item) + posture = '风险' if isinstance(doctor_payload, dict) and not doctor_payload.get('ok', False) else '稳定' + posture_status = 'fail' if posture == '风险' else 'ok' + current_revision = database_payload.get('currentRevision', '-') if isinstance(database_payload, dict) else '-' + cache_size = cache_payload.get('dbSize', '-') if isinstance(cache_payload, dict) else '-' + + metrics = [ + DashboardMetricSnapshot( + title='当前态势', + value=f'{self.formatting.render_signal_bar(passed_dependencies, DEPENDENCY_CHECK_TOTAL)} {posture}', + status=posture_status, + hint=f'依赖通过 {passed_dependencies}/{DEPENDENCY_CHECK_TOTAL},健康检查自动判定', + ), + DashboardMetricSnapshot( + title='依赖通过率', + value=( + f'{self.formatting.render_signal_bar(passed_dependencies, DEPENDENCY_CHECK_TOTAL)} ' + f'{passed_dependencies}/{DEPENDENCY_CHECK_TOTAL}' + ), + status=( + 'ok' + if passed_dependencies == DEPENDENCY_CHECK_TOTAL + else 'warn' + if passed_dependencies > 0 + else 'fail' + ), + hint='数据库、Redis、加密组件', + ), + DashboardMetricSnapshot( + title='迁移版本', + value=f'[{SHELL_TEXT_FORMATTER.truncate_text(current_revision, 16)}]', + status='ok' if current_revision != '-' else 'warn', + hint='当前数据库 revision 基线', + ), + DashboardMetricSnapshot( + title='Redis 键数', + value=f'[KEYS] {cache_size}', + status='info', + hint='当前缓存库 key 数量观测值', + ), + ] + return sorted( + metrics, + key=lambda item: self.formatting.resolve_status_priority(item.status), + ) + + +class DashboardAdapter: + """ + TUI 首页巡检聚合适配器。 + + 该适配器负责采集应用、健康检查、数据库、缓存与运维只读快照, + 并委托面板构建器、指标构建器和压缩器组装首页结果。 + """ + + def __init__( + self, + formatting: DashboardFormattingSupport | None = None, + panel_builder: DashboardPanelBuilder | None = None, + metric_builder: DashboardMetricBuilder | None = None, + panel_compressor: DashboardPanelCompressor | None = None, + snapshot_collector: DashboardSnapshotCollector | None = None, + ) -> None: + """ + 初始化首页巡检聚合适配器。 + + :param formatting: 首页仪表盘格式化支持对象 + :param panel_builder: 首页面板构建器 + :param metric_builder: 首页指标卡构建器 + :param panel_compressor: 首页面板压缩器 + :param snapshot_collector: 首页聚合数据采集器 + :return: None + """ + self.formatting = formatting or DashboardFormattingSupport() + self.panel_builder = panel_builder or DashboardPanelBuilder(self.formatting) + self.metric_builder = metric_builder or DashboardMetricBuilder(self.formatting) + self.panel_compressor = panel_compressor or DashboardPanelCompressor(self.formatting) + self.snapshot_collector = snapshot_collector or DashboardSnapshotCollector() + + def collect_snapshot(self, env: str) -> DashboardSnapshot: + """ + 采集 TUI 首页只读巡检快照。 + + :param env: 当前运行环境 + :return: 首页聚合快照 + """ + source_payloads = self.snapshot_collector.collect(env) + panels = self.panel_builder.build_panels( + env=env, + app_env_payload=source_payloads.app_env_payload, + app_routes_payload=source_payloads.app_routes_payload, + doctor_payload=source_payloads.doctor_payload, + database_payload=source_payloads.database_payload, + cache_payload=source_payloads.cache_payload, + deps_payload=source_payloads.deps_payload, + server_payload=source_payloads.server_payload, + ) + return DashboardSnapshot( + env=env, + metrics=self.metric_builder.build_metrics( + source_payloads.doctor_payload, + source_payloads.database_payload, + source_payloads.cache_payload, + ), + panels=self.panel_compressor.compact_panels(panels), + ) + + +DASHBOARD_ADAPTER = DashboardAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/jobs.py b/shierfeng-fastapi-backend/cli/tui/adapters/jobs.py new file mode 100644 index 0000000..d5b3e5b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/jobs.py @@ -0,0 +1,747 @@ +from typing import Any + +from cli.tui.adapters.base import BaseBrowserAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + BrowserPageSnapshot, + BrowserRecordSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.tui.search import JOB_FILTER_OPTIONS +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +class JobRenderingSupport: + """ + 任务浏览页渲染支持对象。 + + 该对象负责状态文本、时间线标记、成功率信号条和失败任务提取等基础 + 逻辑,供筛选、分区和记录构建复用。 + + :param page_adapter: 任务浏览页适配器 + """ + + def __init__(self, page_adapter: BaseBrowserAdapter) -> None: + """ + 初始化任务浏览页渲染支持对象。 + + :param page_adapter: 任务浏览页适配器 + :return: None + """ + self.page_adapter = page_adapter + + def extract_failed_job_names(self, payload: dict[str, Any] | None) -> set[str]: + """ + 从失败日志结果中提取任务名称集合。 + + :param payload: 失败日志负载 + :return: 失败任务名称集合 + """ + rows = self.page_adapter.extract_page_rows(payload) + failed_job_names: set[str] = set() + for row in rows: + job_name = str(row.get('jobName', '') or '').strip() + if job_name: + failed_job_names.add(job_name) + return failed_job_names + + @staticmethod + def render_job_status(value: object) -> str: + """ + 将任务状态码转换为可读文本。 + + :param value: 原始状态值 + :return: 中文状态文本 + """ + normalized = str(value).strip() + if normalized == '0': + return '正常' + if normalized == '1': + return '暂停' + return normalized or '-' + + @staticmethod + def render_job_log_status(value: object) -> str: + """ + 将任务日志状态码转换为可读文本。 + + :param value: 原始状态值 + :return: 中文状态文本 + """ + normalized = str(value).strip() + if normalized == '0': + return '成功' + if normalized == '1': + return '失败' + return normalized or '-' + + def render_job_log_timeline_title(self, row: dict[str, Any]) -> str: + """ + 渲染单条任务日志时间线标题。 + + :param row: 日志行数据 + :return: 时间线标题文本 + """ + created_at = SHELL_TEXT_FORMATTER.truncate_text(row.get('createTime', '-'), 24) + if created_at and created_at != '-': + return f'{created_at} · {self.render_job_log_status(row.get("status", "-"))}' + return f'日志 {row.get("jobLogId", "-")} · {self.render_job_log_status(row.get("status", "-"))}' + + @staticmethod + def render_timeline_marker(status: object) -> str: + """ + 根据日志状态渲染时间线节点标记。 + + :param status: 原始日志状态 + :return: 节点标记 + """ + return 'x' if str(status).strip() == '1' else 'o' + + @staticmethod + def render_signal_bar(passed: int, total: int, *, width: int = 8) -> str: + """ + 渲染 ASCII 成功率条。 + + :param passed: 成功数量 + :param total: 总数量 + :param width: 条形宽度 + :return: ASCII 条形 + """ + if total <= 0: + return f'[{"-" * width}]' + safe_passed = max(0, min(passed, total)) + filled = round((safe_passed / total) * width) + return f'[{"#" * filled}{"-" * max(0, width - filled)}]' + + @staticmethod + def extract_latest_log_time(rows: list[dict[str, Any]]) -> str: + """ + 提取日志列表中的最近时间。 + + :param rows: 日志行数据 + :return: 最近时间文本 + """ + if not rows: + return '-' + latest_time = str(rows[0].get('createTime', '-') or '-').strip() + return latest_time or '-' + + +class JobRowFilter: + """ + 任务浏览行过滤器。 + + 该对象负责按筛选键和搜索词过滤任务行数据。 + """ + + @staticmethod + def apply_job_filter( + rows: list[dict[str, Any]], + failed_job_names: set[str], + filter_key: str, + ) -> list[dict[str, Any]]: + """ + 按筛选键过滤任务行数据。 + + :param rows: 原始任务行列表 + :param failed_job_names: 最近失败任务名称集合 + :param filter_key: 当前筛选键 + :return: 过滤后的任务行列表 + """ + normalized_filter = str(filter_key).strip().lower() + if normalized_filter == 'failed': + return [row for row in rows if str(row.get('jobName', '') or '').strip() in failed_job_names] + if normalized_filter == 'paused': + return [row for row in rows if str(row.get('status', '')).strip() == '1'] + if normalized_filter == 'ok': + return [ + row + for row in rows + if str(row.get('jobName', '') or '').strip() not in failed_job_names + and str(row.get('status', '')).strip() != '1' + ] + return rows + + @staticmethod + def apply_job_query(rows: list[dict[str, Any]], query: str) -> list[dict[str, Any]]: + """ + 按任务名称查询词过滤任务行数据。 + + :param rows: 原始任务行列表 + :param query: 当前搜索词 + :return: 过滤后的任务行列表 + """ + normalized_query = str(query).strip().lower() + if not normalized_query: + return rows + return [ + row + for row in rows + if normalized_query in str(row.get('jobName', '') or '').strip().lower() + or normalized_query in str(row.get('jobGroup', '') or '').strip().lower() + ] + + +class JobSectionBuilder: + """ + 任务浏览页分区构建器。 + + 该构建器负责构建任务页共享分区以及单条任务详情分区。 + + :param page_adapter: 任务浏览页适配器 + :param rendering: 任务浏览页渲染支持对象 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + rendering: JobRenderingSupport, + ) -> None: + """ + 初始化任务浏览页分区构建器。 + + :param page_adapter: 任务浏览页适配器 + :param rendering: 任务浏览页渲染支持对象 + :return: None + """ + self.page_adapter = page_adapter + self.rendering = rendering + + def build_job_failure_aggregate_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建任务失败聚合共享分区。 + + :param payload: 失败日志 JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title='失败聚合', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='失败聚合', empty_value='不可用' + ), + ) + + rows = self.page_adapter.extract_page_rows(payload) + if not rows: + return DetailSectionSnapshot( + title='失败聚合', + status='ok', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='失败日志', + empty_value='0 条', + detail='当前失败日志池为空,最近没有采集到失败执行记录', + ), + ) + + grouped_rows: dict[str, list[dict[str, Any]]] = {} + for row in rows: + job_name = str(row.get('jobName', '-') or '-').strip() or '-' + grouped_rows.setdefault(job_name, []).append(row) + + sorted_groups = sorted( + grouped_rows.items(), + key=lambda item: (-len(item[1]), self.rendering.extract_latest_log_time(item[1]), item[0]), + reverse=False, + ) + lines = [ + '## 失败池', + f'失败日志: {len(rows)} 条', + f'涉及任务: {len(grouped_rows)} 个', + f'最近失败: {self.rendering.extract_latest_log_time(rows)}', + '', + '## 高频失败任务', + ] + for index, (job_name, job_rows) in enumerate(sorted_groups[:6], start=1): + latest_row = job_rows[0] + latest_time = self.rendering.extract_latest_log_time(job_rows) + latest_message = SHELL_TEXT_FORMATTER.truncate_text(latest_row.get('jobMessage', '-'), 48) + lines.extend( + [ + f'[{index}] {SHELL_TEXT_FORMATTER.truncate_text(job_name, 28)} · {len(job_rows)} 次', + f'> 最近失败: {latest_time}', + f'> 最近结果: {latest_message}', + ] + ) + exception_info = SHELL_TEXT_FORMATTER.truncate_text(latest_row.get('exceptionInfo', ''), 48) + if exception_info: + lines.append(f'> 异常摘要: {exception_info}') + lines.append('') + + if lines[-1] == '': + lines.pop() + return DetailSectionSnapshot( + title='失败聚合', + status='warn', + lines=lines, + ) + + def build_jobs_overview_section( + self, + rows: list[dict[str, Any]], + filtered_rows: list[dict[str, Any]], + failed_job_names: set[str], + paused_count: int, + failed_logs_payload: dict[str, Any] | None, + filter_label: str, + ) -> DetailSectionSnapshot: + """ + 构建任务页总览判断共享分区。 + + :param rows: 原始任务行列表 + :param filtered_rows: 当前筛选后的任务行列表 + :param failed_job_names: 最近失败任务名称集合 + :param paused_count: 暂停任务数量 + :param failed_logs_payload: 失败日志负载 + :param filter_label: 当前筛选标签 + :return: 分区快照 + """ + failed_rows = self.page_adapter.extract_page_rows(failed_logs_payload) + latest_failure = self.rendering.extract_latest_log_time(failed_rows) + status = 'ok' + conclusion = '当前任务基线正常,可继续查看执行轨迹与最近执行记录' + if failed_job_names: + status = 'warn' + conclusion = '存在失败任务,优先查看失败聚合与失败执行记录' + elif paused_count > 0: + status = 'warn' + conclusion = '存在暂停任务,建议确认停用原因与恢复窗口' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'当前筛选: {filter_label}', + f'已加载任务: {len(rows)} 条', + f'当前匹配: {len(filtered_rows)} 条', + f'失败任务: {len(failed_job_names)} 个', + f'暂停任务: {paused_count} 个', + f'最近失败: {latest_failure}', + '', + '## 建议入口', + '优先关注:失败聚合 / 暂停任务 / 执行轨迹', + ], + ) + + def build_job_focus_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建任务概览分区。 + + :param payload: `job detail` JSON 负载 + :return: 分区快照 + """ + job = payload.get('job') if isinstance(payload, dict) else None + if not isinstance(job, dict): + return DetailSectionSnapshot( + title='任务摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='任务', empty_value='无'), + ) + return DetailSectionSnapshot( + title='任务摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 任务身份', + f'任务 ID: {job.get("jobId", "-")}', + f'任务名称: {SHELL_TEXT_FORMATTER.truncate_text(job.get("jobName", "-"), 40)}', + f'任务分组: {SHELL_TEXT_FORMATTER.truncate_text(job.get("jobGroup", "-"), 24)}', + f'运行状态: {self.rendering.render_job_status(job.get("status", "-"))}', + ], + ) + + @staticmethod + def build_job_schedule_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建任务调度配置分区。 + + :param payload: `job detail` JSON 负载 + :return: 分区快照 + """ + job = payload.get('job') if isinstance(payload, dict) else None + if not isinstance(job, dict): + return DetailSectionSnapshot( + title='调度配置', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='调度配置', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='调度配置', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 调度表达式', + f'Cron 表达式: {SHELL_TEXT_FORMATTER.truncate_text(job.get("cronExpression", "-"), 48)}', + '', + '## 执行入口', + f'调用目标: {SHELL_TEXT_FORMATTER.truncate_text(job.get("invokeTarget", "-"), 72)}', + ], + ) + + def build_job_logs_section(self, payload: dict[str, Any] | None, *, title: str) -> DetailSectionSnapshot: + """ + 构建任务日志分区。 + + :param payload: `job logs` JSON 负载 + :param title: 分区标题 + :return: 分区快照 + """ + if not isinstance(payload, dict) or not payload.get('ok', False): + return DetailSectionSnapshot( + title=title, + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='日志', empty_value='不可用'), + ) + rows = self.page_adapter.extract_page_rows(payload) + lines = TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='日志记录', + empty_value='0 条', + detail='当前筛选条件下没有相关日志', + ) + section_status = 'ok' + if rows: + lines = [] + if any(str(row.get('status', '')).strip() == '1' for row in rows): + section_status = 'warn' + for row in rows[:8]: + exception_info = SHELL_TEXT_FORMATTER.truncate_text(row.get('exceptionInfo', '-'), 56) + timeline_marker = self.rendering.render_timeline_marker(row.get('status', '-')) + rendered_status = self.rendering.render_job_log_status(row.get('status', '-')) + lines.extend( + [ + f'## 节点 {row.get("jobLogId", "-")} · {self.rendering.render_job_log_timeline_title(row)}', + f'> {timeline_marker} 状态: {rendered_status}', + f'> 时间: {SHELL_TEXT_FORMATTER.truncate_text(row.get("createTime", "-"), 24)}', + f'> 任务: {SHELL_TEXT_FORMATTER.truncate_text(row.get("jobName", "-"), 24)}', + f'> 结果: {SHELL_TEXT_FORMATTER.truncate_text(row.get("jobMessage", "-"), 56)}', + *([f'> 异常: {exception_info}'] if exception_info and exception_info != '-' else []), + '> 轨道: ├─采集 ├─执行 └─落盘', + f'> 轨迹: {"●" if timeline_marker == "o" else "▲"}─{"●" if timeline_marker == "o" else "▲"}─◎', + '', + ] + ) + return DetailSectionSnapshot( + title=title, + status=section_status, + lines=lines[:-1] if len(lines) > 1 and lines[-1] == '' else lines, + ) + + def build_job_log_summary_section( + self, + recent_logs_payload: dict[str, Any] | None, + failed_logs_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建任务日志摘要分区。 + + :param recent_logs_payload: 最近日志 JSON 负载 + :param failed_logs_payload: 失败日志 JSON 负载 + :return: 分区快照 + """ + if not isinstance(recent_logs_payload, dict) or not recent_logs_payload.get('ok', False): + return DetailSectionSnapshot( + title='执行摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + recent_logs_payload, empty_label='日志摘要', empty_value='不可用' + ), + ) + recent_rows = self.page_adapter.extract_page_rows(recent_logs_payload) + failed_rows = self.page_adapter.extract_page_rows(failed_logs_payload) + success_count = sum(1 for row in recent_rows if str(row.get('status', '')).strip() == '0') + failed_count = sum(1 for row in recent_rows if str(row.get('status', '')).strip() not in {'', '0'}) + status = 'warn' if failed_count > 0 or failed_rows else 'ok' + total_count = len(recent_rows) + latest_run = self.rendering.extract_latest_log_time(recent_rows) + latest_failure = self.rendering.extract_latest_log_time(failed_rows) + return DetailSectionSnapshot( + title='执行摘要', + status=status, + lines=[ + '## 执行统计', + f'最近采样日志: {total_count} 条', + f'执行成功: {success_count} 条', + f'执行失败: {failed_count} 条', + f'成功率信号: {self.rendering.render_signal_bar(success_count, total_count)} {success_count}/{total_count or 0}', + '', + '## 时间线锚点', + f'最近一次执行: {latest_run}', + f'最近一次失败: {latest_failure}', + '', + '## 轨道视图', + f'执行轨道: {"─".join("●" if str(row.get("status", "")).strip() == "0" else "▲" for row in recent_rows[:6]) or "-"}', + f'失败轨道: {"─".join("▲" for _ in failed_rows[:6]) or "-"}', + f'轨道窗口: {"[执行流]" if recent_rows else "-"} {"[失败流]" if failed_rows else ""}'.strip(), + '', + '## 风险信号', + f'失败记录池: {len(failed_rows)} 条', + ], + ) + + def load_job_detail_sections(self, job_row: dict[str, Any], env: str) -> list[DetailSectionSnapshot]: + """ + 按需加载单条任务详情与日志分区。 + + :param job_row: 任务列表行数据 + :param env: 当前运行环境 + :return: 详情分区列表 + """ + job_id = job_row.get('jobId', '-') + job_name = str(job_row.get('jobName', '-') or '-') + + detail_payload = NESTED_CLI_SUPPORT.run( + 'job', + 'detail', + str(job_id), + f'--env={env}', + '--output=json', + parse_json=True, + ).payload + + log_arguments = ['job', 'logs', f'--env={env}', '--paged', '--page-size=8', '--output=json'] + if job_name.strip() and job_name != '-': + log_arguments.append(f'--job-name={job_name}') + recent_logs_payload = NESTED_CLI_SUPPORT.run(*log_arguments, parse_json=True).payload + failed_logs_payload = NESTED_CLI_SUPPORT.run(*[*log_arguments, '--status=1'], parse_json=True).payload + + return [ + self.build_job_focus_section(detail_payload), + self.build_job_schedule_section(detail_payload), + self.build_job_log_summary_section(recent_logs_payload, failed_logs_payload), + self.build_job_logs_section(recent_logs_payload, title='最近执行记录'), + self.build_job_logs_section(failed_logs_payload, title='失败执行记录'), + ] + + +class JobRecordBuilder: + """ + 任务浏览记录构建器。 + + 该对象负责构建任务页单条浏览记录与失败兜底记录。 + + :param page_adapter: 任务浏览页适配器 + :param rendering: 任务浏览页渲染支持对象 + :param section_builder: 任务浏览页分区构建器 + """ + + def __init__( + self, + page_adapter: BaseBrowserAdapter, + rendering: JobRenderingSupport, + section_builder: JobSectionBuilder, + ) -> None: + """ + 初始化任务浏览记录构建器。 + + :param page_adapter: 任务浏览页适配器 + :param rendering: 任务浏览页渲染支持对象 + :param section_builder: 任务浏览页分区构建器 + :return: None + """ + self.page_adapter = page_adapter + self.rendering = rendering + self.section_builder = section_builder + + def build_job_record(self, job_row: dict[str, Any], env: str) -> BrowserRecordSnapshot: + """ + 构建单条任务浏览记录。 + + :param job_row: 任务列表行数据 + :param env: 当前运行环境 + :return: 浏览记录快照 + """ + job_id = job_row.get('jobId', '-') + job_name = str(job_row.get('jobName', '-') or '-') + job_status = str(job_row.get('status', '-') or '-') + job_group = str(job_row.get('jobGroup', '-') or '-') + cron_expression = str(job_row.get('cronExpression', '-') or '-') + rendered_status = self.rendering.render_job_status(job_status) + + return BrowserRecordSnapshot( + key=f'job:{job_id}', + title=SHELL_TEXT_FORMATTER.truncate_text(job_name, 40), + status='warn' if str(job_status).strip() == '1' else 'ok', + summary=f'{rendered_status} · Cron {SHELL_TEXT_FORMATTER.truncate_text(cron_expression, 32)}', + metadata_lines=[ + '## 任务标识', + f'任务 ID: {job_id}', + f'任务分组: {SHELL_TEXT_FORMATTER.truncate_text(job_group, 24)}', + f'运行状态: {rendered_status}', + '', + '## 调度信息', + f'Cron 表达式: {SHELL_TEXT_FORMATTER.truncate_text(cron_expression, 48)}', + ], + detail_sections=[], + detail_loader=lambda job_row=job_row, env=env: self.section_builder.load_job_detail_sections(job_row, env), + ) + + def build_failure_record(self, payload: dict[str, Any] | None) -> BrowserRecordSnapshot: + """ + 构建任务页失败兜底记录。 + + :param payload: 失败结果负载 + :return: 浏览记录快照 + """ + return self.page_adapter.build_failure_record( + key='job:unavailable', + subject='任务', + section_subject='任务列表', + payload=payload, + ) + + +class JobsBrowserAdapter(BaseBrowserAdapter): + """ + 任务浏览页适配器。 + + 该适配器负责采集任务列表、失败日志和单条任务详情,并委托协作对象 + 完成过滤、共享分区、详情分区和记录构建。 + """ + + def __init__( + self, + rendering: JobRenderingSupport | None = None, + row_filter: JobRowFilter | None = None, + section_builder: JobSectionBuilder | None = None, + record_builder: JobRecordBuilder | None = None, + ) -> None: + """ + 初始化任务浏览页适配器。 + + :param rendering: 任务浏览页渲染支持对象 + :param row_filter: 任务浏览行过滤器 + :param section_builder: 任务浏览页分区构建器 + :param record_builder: 任务浏览记录构建器 + :return: None + """ + super().__init__( + page_title='任务', + search_view_key='jobs', + filter_options=JOB_FILTER_OPTIONS, + ) + self.rendering = rendering or JobRenderingSupport(self) + self.row_filter = row_filter or JobRowFilter() + self.section_builder = section_builder or JobSectionBuilder(self, self.rendering) + self.record_builder = record_builder or JobRecordBuilder(self, self.rendering, self.section_builder) + + def collect_snapshot(self, env: str, filter_key: str = 'all', query: str = '') -> BrowserPageSnapshot: + """ + 采集定时任务浏览页只读快照。 + + :param env: 当前运行环境 + :param filter_key: 当前筛选键 + :param query: 当前搜索词 + :return: 浏览页快照 + """ + active_filter_option = self.resolve_active_filter(filter_key) + active_filter = active_filter_option.key + active_filter_label = active_filter_option.label + search_context = self.resolve_search_context(query) + jobs_payload = NESTED_CLI_SUPPORT.run( + 'job', + 'list', + f'--env={env}', + '--paged', + '--page-size=8', + '--output=json', + parse_json=True, + ).payload + failed_logs_payload = NESTED_CLI_SUPPORT.run( + 'job', + 'logs', + f'--env={env}', + '--paged', + '--page-size=20', + '--status=1', + '--output=json', + parse_json=True, + ).payload + failed_job_names = self.rendering.extract_failed_job_names(failed_logs_payload) + + if not isinstance(jobs_payload, dict) or not jobs_payload.get('ok', False): + return BrowserPageSnapshot( + title='任务', + subtitle=TUI_COPY.build_unavailable_subtitle( + '任务', + SHELL_TEXT_FORMATTER.truncate_text(self.extract_payload_message(jobs_payload), 72), + ), + records=[self.record_builder.build_failure_record(jobs_payload)], + shared_sections=[ + self.section_builder.build_jobs_overview_section( + [], [], failed_job_names, 0, failed_logs_payload, active_filter_label + ), + self.section_builder.build_job_failure_aggregate_section(failed_logs_payload), + ], + filters=list(self.filter_options), + active_filter_key=active_filter, + search=search_context, + ) + + rows = self.extract_page_rows(jobs_payload) + sorted_rows = sorted( + rows, + key=lambda row: ( + 0 + if str(row.get('jobName', '') or '').strip() in failed_job_names + else 1 + if str(row.get('status', '')).strip() == '1' + else 2, + str(row.get('jobName', '') or ''), + ), + ) + filtered_rows = self.row_filter.apply_job_query( + self.row_filter.apply_job_filter(sorted_rows, failed_job_names, active_filter), + query, + ) + records = [self.record_builder.build_job_record(job_row, env) for job_row in filtered_rows[:8]] + if not records: + records = [ + self.build_empty_record( + key='job:none', + subject='任务', + empty_label='任务列表', + has_source_rows=bool(sorted_rows), + filtered_summary='当前筛选条件下没有匹配任务', + empty_summary='当前环境中还没有定时任务', + filtered_empty_value='暂无任务', + empty_empty_value='暂无任务配置', + filtered_detail='当前筛选条件下没有匹配任务', + empty_detail='当前环境中尚未配置定时任务', + ) + ] + paused_count = sum(1 for row in rows if str(row.get('status', '')).strip() == '1') + shared_sections = [ + self.section_builder.build_jobs_overview_section( + rows, + filtered_rows, + failed_job_names, + paused_count, + failed_logs_payload, + active_filter_label, + ), + self.section_builder.build_job_failure_aggregate_section(failed_logs_payload), + ] + return BrowserPageSnapshot( + title='任务', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_jobs_diagnostic_subtitle( + active_filter_label, + len(filtered_rows), + failed_job_names, + paused_count, + ), + records=records, + shared_sections=shared_sections, + filters=list(self.filter_options), + active_filter_key=active_filter, + search=search_context, + ) + + +JOBS_BROWSER_ADAPTER = JobsBrowserAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/models.py b/shierfeng-fastapi-backend/cli/tui/adapters/models.py new file mode 100644 index 0000000..b0bca76 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/models.py @@ -0,0 +1,227 @@ +from collections.abc import Callable +from dataclasses import dataclass, field + +from cli.tui.copy import TUI_COPY +from cli.tui.search import PageFilterOption, PageSearchContext +from cli.utils import SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class DetailSectionSnapshot: + """ + TUI 详情页单个分区快照。 + + :param title: 分区标题 + :param status: 分区状态 + :param lines: 分区正文文本行 + """ + + title: str + status: str + lines: list[str] + + +@dataclass(frozen=True) +class DetailPageSnapshot: + """ + TUI 详情页聚合快照。 + + :param title: 页面标题 + :param subtitle: 页面副标题 + :param sections: 页面分区列表 + :param search: 当前页面搜索上下文 + """ + + title: str + subtitle: str + sections: list[DetailSectionSnapshot] + search: PageSearchContext | None = None + + +@dataclass(frozen=True) +class BrowserRecordSnapshot: + """ + TUI 浏览页单条记录快照。 + + :param key: 记录唯一标识 + :param title: 记录标题 + :param status: 记录状态 + :param summary: 记录摘要 + :param metadata_lines: 记录元信息文本行 + :param detail_sections: 记录联动详情分区列表 + """ + + key: str + title: str + status: str + summary: str + metadata_lines: list[str] + detail_sections: list[DetailSectionSnapshot] + detail_loader: Callable[[], list[DetailSectionSnapshot]] | None = None + _cached_detail_sections: tuple[DetailSectionSnapshot, ...] | None = field( + default=None, + init=False, + repr=False, + compare=False, + ) + + def resolve_detail_sections(self) -> list[DetailSectionSnapshot]: + """ + 获取当前记录详情分区,必要时按需加载并缓存。 + + :return: 详情分区列表 + """ + if self.detail_loader is None: + return self.detail_sections + if self._cached_detail_sections is None: + object.__setattr__(self, '_cached_detail_sections', tuple(self.detail_loader())) + return list(self._cached_detail_sections) + + +@dataclass(frozen=True) +class BrowserPageSnapshot: + """ + TUI 浏览页聚合快照。 + + :param title: 页面标题 + :param subtitle: 页面副标题 + :param records: 可浏览记录列表 + :param shared_sections: 全局共享分区列表 + :param filters: 页面可用筛选项 + :param active_filter_key: 当前激活筛选键 + :param search: 当前页面搜索上下文 + """ + + title: str + subtitle: str + records: list[BrowserRecordSnapshot] + shared_sections: list[DetailSectionSnapshot] + filters: list[PageFilterOption] = field(default_factory=list) + active_filter_key: str | None = None + search: PageSearchContext | None = None + + +class TuiAdapterModelRenderService: + """ + TUI 适配层模型渲染服务。 + + 该对象集中封装结果负载摘要提取,以及空态、加载态、失败态文本行 + 的统一构建逻辑,避免这些模块级辅助函数继续散落扩张。 + """ + + @staticmethod + def extract_payload_message(payload: dict[str, object] | None) -> str: + """ + 提取结果负载中的可读消息。 + + :param payload: 标准结果负载 + :return: 摘要消息文本 + """ + if not isinstance(payload, dict): + return '-' + if payload.get('message'): + return SHELL_TEXT_FORMATTER.truncate_text(payload.get('message', '-'), 120) + if payload.get('error'): + return SHELL_TEXT_FORMATTER.truncate_text(payload.get('error', '-'), 120) + return '-' + + @staticmethod + def build_empty_lines( + *, + empty_label: str, + empty_value: str, + detail: str, + suggestion: str = TUI_COPY.build_empty_state_suggestion(), + ) -> list[str]: + """ + 构建统一的空态文本行。 + + :param empty_label: 空态主字段名称 + :param empty_value: 空态主字段值 + :param detail: 空态说明 + :param suggestion: 建议操作 + :return: 空态文本行列表 + """ + return [ + TUI_COPY.build_state_section_title('status'), + f'{empty_label}: {empty_value}', + '', + TUI_COPY.build_state_section_title('detail'), + detail, + '', + TUI_COPY.build_state_section_title('suggestion'), + suggestion, + ] + + @staticmethod + def build_loading_lines( + *, + loading_label: str, + loading_value: str, + detail: str, + suggestion: str = TUI_COPY.build_loading_state_suggestion(), + ) -> list[str]: + """ + 构建统一的加载中文本行。 + + :param loading_label: 加载态主字段名称 + :param loading_value: 加载态主字段值 + :param detail: 加载说明 + :param suggestion: 建议操作 + :return: 加载态文本行列表 + """ + return [ + TUI_COPY.build_state_section_title('status'), + f'{loading_label}: {loading_value}', + '', + TUI_COPY.build_state_section_title('detail'), + detail, + '', + TUI_COPY.build_state_section_title('suggestion'), + suggestion, + ] + + def build_failure_lines( + self, + payload: dict[str, object] | None, + *, + empty_label: str, + empty_value: str, + ) -> list[str]: + """ + 为失败状态构建统一的可读文本行。 + + :param payload: 标准结果负载 + :param empty_label: 主字段标签 + :param empty_value: 主字段兜底值 + :return: 失败状态文本行列表 + """ + lines = [ + TUI_COPY.build_state_section_title('status'), + f'{empty_label}: {empty_value}', + '', + TUI_COPY.build_state_section_title('error'), + ] + if not isinstance(payload, dict): + lines.append('结果消息: -') + lines.extend( + ['', TUI_COPY.build_state_section_title('suggestion'), TUI_COPY.build_failure_state_suggestion()] + ) + return lines + lines.append(f'结果消息: {self.extract_payload_message(payload)}') + detail_lines: list[str] = [] + if payload.get('hint'): + detail_lines.append(f'建议提示: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("hint", "-"), 120)}') + if payload.get('error'): + detail_lines.append(f'错误信息: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("error", "-"), 120)}') + if payload.get('stderr'): + detail_lines.append(f'标准错误: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("stderr", "-"), 120)}') + if payload.get('stdout'): + detail_lines.append(f'标准输出: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("stdout", "-"), 120)}') + if detail_lines: + lines.extend(['', TUI_COPY.build_state_section_title('diagnostic'), *detail_lines]) + lines.extend(['', TUI_COPY.build_state_section_title('suggestion'), TUI_COPY.build_failure_state_suggestion()]) + return lines + + +TUI_ADAPTER_MODEL_RENDERER = TuiAdapterModelRenderService() diff --git a/shierfeng-fastapi-backend/cli/tui/adapters/ops.py b/shierfeng-fastapi-backend/cli/tui/adapters/ops.py new file mode 100644 index 0000000..b5222fc --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/adapters/ops.py @@ -0,0 +1,482 @@ +from dataclasses import dataclass +from typing import Any + +from cli.tui.adapters.base import BaseDetailAdapter +from cli.tui.adapters.models import ( + TUI_ADAPTER_MODEL_RENDERER, + DetailPageSnapshot, + DetailSectionSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.diagnostics import TUI_DIAGNOSTIC_SERVICE +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class OpsDetailSourcePayloads: + """ + 运维详情页原始数据源快照。 + + :param health_payload: `ops health` 结果 + :param ping_db_payload: `ops ping-db` 结果 + :param ping_redis_payload: `ops ping-redis` 结果 + :param deps_payload: `ops deps` 结果 + :param server_payload: `ops server-info` 结果 + """ + + health_payload: dict[str, Any] | None + ping_db_payload: dict[str, Any] | None + ping_redis_payload: dict[str, Any] | None + deps_payload: dict[str, Any] | None + server_payload: dict[str, Any] | None + + +class OpsDetailSnapshotCollector: + """ + 运维详情页数据采集器。 + + 该对象负责拉取运维详情页所需的多路 CLI 原始结果, + 让 `OpsDetailAdapter` 保持详情页编排职责。 + """ + + def collect(self, env: str) -> OpsDetailSourcePayloads: + """ + 采集运维详情页所需原始结果。 + + :param env: 当前运行环境 + :return: 运维详情页原始数据源快照 + """ + return OpsDetailSourcePayloads( + health_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'health', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ping_db_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'ping-db', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ping_redis_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'ping-redis', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + deps_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'deps', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + server_payload=NESTED_CLI_SUPPORT.run( + 'ops', + 'server-info', + f'--env={env}', + '--output=json', + parse_json=True, + ).payload, + ) + + +class OpsSectionBuilder: + """ + 运维详情分区构建器。 + + 该构建器负责将运维相关 CLI 结果负载转换为 TUI 详情页分区, + 使详情页适配器本体只保留采集与编排职责。 + """ + + @staticmethod + def build_health_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建运维健康检查分区。 + + :param payload: `ops health` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='健康检查', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='健康检查', empty_value='不可用' + ), + ) + database = payload.get('database') if isinstance(payload.get('database'), dict) else {} + redis = payload.get('redis') if isinstance(payload.get('redis'), dict) else {} + return DetailSectionSnapshot( + title='健康检查', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 基础连通性', + f'环境: {payload.get("env", "-")}', + f'数据库: {"正常" if database.get("ok", False) else "异常"}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(database.get("message", "-"), 64)}', + f'Redis: {"正常" if redis.get("ok", False) else "异常"}', + f'> {SHELL_TEXT_FORMATTER.truncate_text(redis.get("message", "-"), 64)}', + ], + ) + + @staticmethod + def build_ping_db_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建数据库探活结果分区。 + + :param payload: `ops ping-db` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='数据库探活', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='数据库探活', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='数据库探活', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 探活结果', + f'数据库连接: {"正常" if payload.get("ok", False) else "异常"}', + f'结果摘要: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("message", "-"), 72)}', + ], + ) + + @staticmethod + def build_ping_redis_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建 Redis 探活结果分区。 + + :param payload: `ops ping-redis` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='Redis 探活', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='Redis 探活', empty_value='不可用' + ), + ) + return DetailSectionSnapshot( + title='Redis 探活', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 探活结果', + f'Redis 连接: {"正常" if payload.get("ok", False) else "异常"}', + f'结果摘要: {SHELL_TEXT_FORMATTER.truncate_text(payload.get("message", "-"), 72)}', + ], + ) + + @staticmethod + def build_dependency_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建运维依赖版本分区。 + + :param payload: `ops deps` JSON 负载 + :return: 分区快照 + """ + if not isinstance(payload, dict): + return DetailSectionSnapshot( + title='依赖版本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines(payload, empty_label='依赖', empty_value='不可用'), + ) + packages = payload.get('packages') if isinstance(payload.get('packages'), dict) else {} + missing_required = payload.get('missingRequired') if isinstance(payload.get('missingRequired'), list) else [] + lines = [ + '## 总体结论', + f'检查结果: {"通过" if payload.get("ok", False) else "异常"}', + f'缺失核心依赖: {len(missing_required)} 个', + f'> {SHELL_TEXT_FORMATTER.truncate_text(payload.get("message", "-"), 72)}', + '', + '## 关键版本', + ] + for package_name in ('python', 'fastapi', 'sqlalchemy', 'redis', 'typer', 'alembic'): + package_payload = packages.get(package_name) + if not isinstance(package_payload, dict): + continue + installed = '已安装' if package_payload.get('installed', False) else '缺失' + lines.append(f'> {package_name} · {installed} · {package_payload.get("version", "-") or "-"}') + if missing_required: + lines.extend(['', '## 缺失项']) + lines.extend(f'> {item}' for item in missing_required[:8]) + return DetailSectionSnapshot( + title='依赖版本', + status='ok' if payload.get('ok', False) else 'fail', + lines=lines, + ) + + @staticmethod + def build_server_section(payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建服务器运行概况分区。 + + :param payload: `ops server-info` JSON 负载 + :return: 分区快照 + """ + server = payload.get('server') if isinstance(payload, dict) else None + if not isinstance(server, dict): + return DetailSectionSnapshot( + title='服务器摘要', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='服务器信息', empty_value='不可用' + ), + ) + + sys_info = server.get('sys') if isinstance(server.get('sys'), dict) else {} + cpu_info = server.get('cpu') if isinstance(server.get('cpu'), dict) else {} + mem_info = server.get('mem') if isinstance(server.get('mem'), dict) else {} + py_info = server.get('py') if isinstance(server.get('py'), dict) else {} + return DetailSectionSnapshot( + title='服务器摘要', + status='ok' if payload.get('ok', False) else 'fail', + lines=[ + '## 主机信息', + f'主机名: {sys_info.get("computerName", "-")}', + f'主机 IP: {sys_info.get("computerIp", "-")}', + f'操作系统: {SHELL_TEXT_FORMATTER.truncate_text(sys_info.get("osName", "-"), 56)}', + f'系统架构: {sys_info.get("osArch", "-")}', + '', + '## 资源负载', + f'CPU 核心: {cpu_info.get("cpuNum", "-")}', + f'CPU 使用率: {cpu_info.get("used", "-")}%', + f'内存总量: {mem_info.get("total", "-")}', + f'内存使用率: {mem_info.get("usage", "-")}%', + '', + '## Python 进程', + f'版本: {py_info.get("version", "-")}', + f'运行时长: {py_info.get("runTime", "-")}', + f'进程内存: {py_info.get("used", "-")} / {py_info.get("total", "-")}', + ], + ) + + def build_disk_section(self, payload: dict[str, Any] | None) -> DetailSectionSnapshot: + """ + 构建服务器磁盘样本分区。 + + :param payload: `ops server-info` JSON 负载 + :return: 分区快照 + """ + server = payload.get('server') if isinstance(payload, dict) else None + if not isinstance(server, dict): + return DetailSectionSnapshot( + title='磁盘样本', + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + payload, empty_label='磁盘样本', empty_value='不可用' + ), + ) + sys_files = server.get('sysFiles') if isinstance(server.get('sysFiles'), list) else [] + lines = TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label='磁盘样本', + empty_value='0 个', + detail='当前服务器信息中没有返回磁盘分区样本', + suggestion=TUI_COPY.build_refresh_page_suggestion('运维', '重新采集服务器信息'), + ) + section_status = 'info' + if sys_files: + section_status = 'ok' + lines = [] + for item in sys_files[:8]: + if not isinstance(item, dict): + continue + lines.extend( + [ + f'## {SHELL_TEXT_FORMATTER.truncate_text(item.get("dirName", "-"), 36)}', + ( + f'> 已用 {item.get("used", "-")} / 总量 {item.get("total", "-")} ' + f'| 使用率 {item.get("usage", "-")}' + ), + f'> 可用 {item.get("free", "-")}', + '', + ] + ) + if lines and lines[-1] == '': + lines.pop() + return DetailSectionSnapshot( + title='磁盘样本', + status=section_status, + lines=lines, + ) + + @staticmethod + def build_prod_check_entry_section() -> DetailSectionSnapshot: + """ + 构建生产巡检向导入口分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title='生产巡检入口', + status='info', + lines=TUI_COPY.build_command_hint_lines( + scenario='准备做生产环境巡检或上线前复核时,应先通过向导统一检查数据库、缓存和运行配置。', + command=TUI_COPY.build_cli_command_hint('wizard', 'prod-check', '--output=text'), + guide='向导会继续询问目标环境并输出预览结果,确认后再执行完整巡检。', + ), + ) + + @staticmethod + def build_overview_section( + health_payload: dict[str, Any] | None, + deps_payload: dict[str, Any] | None, + server_payload: dict[str, Any] | None, + ) -> DetailSectionSnapshot: + """ + 构建运维页总览判断分区。 + + :param health_payload: `ops health` JSON 负载 + :param deps_payload: `ops deps` JSON 负载 + :param server_payload: `ops server-info` JSON 负载 + :return: 分区快照 + """ + health_ok = bool(isinstance(health_payload, dict) and health_payload.get('ok', False)) + deps_ok = bool(isinstance(deps_payload, dict) and deps_payload.get('ok', False)) + server_ok = bool(isinstance(server_payload, dict) and server_payload.get('ok', False)) + missing_required = deps_payload.get('missingRequired') if isinstance(deps_payload, dict) else None + missing_count = len(missing_required) if isinstance(missing_required, list) else 0 + server = ( + server_payload.get('server') + if isinstance(server_payload, dict) and isinstance(server_payload.get('server'), dict) + else {} + ) + cpu_info = server.get('cpu') if isinstance(server.get('cpu'), dict) else {} + mem_info = server.get('mem') if isinstance(server.get('mem'), dict) else {} + + status = 'ok' + conclusion = '基础探活与运行依赖正常,可继续查看服务器资源与磁盘样本' + if not health_ok: + status = 'fail' + conclusion = '运维探活存在异常,优先处理数据库或 Redis 连通性问题' + elif not deps_ok or missing_count > 0: + status = 'warn' + conclusion = '运行依赖存在缺口,建议优先补齐核心依赖并确认版本兼容性' + elif not server_ok: + status = 'warn' + conclusion = '服务器信息采集异常,建议重新采集资源与磁盘状态' + + return DetailSectionSnapshot( + title='总览判断', + status=status, + lines=[ + '## 当前结论', + conclusion, + '', + '## 核心指标', + f'探活状态: {"正常" if health_ok else "异常"}', + f'缺失核心依赖: {missing_count} 个', + f'CPU 使用率: {cpu_info.get("used", "-")}%', + f'内存使用率: {mem_info.get("usage", "-")}%', + '', + '## 建议入口', + '优先关注:健康检查 / 依赖版本 / 服务器摘要 / 生产巡检入口', + ], + ) + + def build_sections( + self, + *, + health_payload: dict[str, Any] | None, + ping_db_payload: dict[str, Any] | None, + ping_redis_payload: dict[str, Any] | None, + deps_payload: dict[str, Any] | None, + server_payload: dict[str, Any] | None, + ) -> list[DetailSectionSnapshot]: + """ + 构建运维页全部详情分区。 + + :param health_payload: `ops health` 结果负载 + :param ping_db_payload: `ops ping-db` 结果负载 + :param ping_redis_payload: `ops ping-redis` 结果负载 + :param deps_payload: `ops deps` 结果负载 + :param server_payload: `ops server-info` 结果负载 + :return: 详情分区列表 + """ + return [ + self.build_overview_section(health_payload, deps_payload, server_payload), + self.build_health_section(health_payload), + self.build_ping_db_section(ping_db_payload), + self.build_ping_redis_section(ping_redis_payload), + self.build_dependency_section(deps_payload), + self.build_server_section(server_payload), + self.build_disk_section(server_payload), + self.build_prod_check_entry_section(), + ] + + +class OpsDetailAdapter(BaseDetailAdapter): + """ + 运维详情页适配器。 + + 该适配器负责采集运维相关 CLI 结果,并委托分区构建器组装为 + TUI 详情页快照。 + """ + + def __init__( + self, + section_builder: OpsSectionBuilder | None = None, + snapshot_collector: OpsDetailSnapshotCollector | None = None, + ) -> None: + """ + 初始化运维详情页适配器。 + + :param section_builder: 运维详情分区构建器 + :param snapshot_collector: 运维详情页数据采集器 + :return: None + """ + super().__init__( + page_title='运维', + search_view_key='ops', + default_suggestions=[ + '总览判断', + '健康检查', + '数据库探活', + 'Redis 探活', + '依赖版本', + '服务器摘要', + '磁盘样本', + '生产巡检入口', + ], + ) + self.section_builder = section_builder or OpsSectionBuilder() + self.snapshot_collector = snapshot_collector or OpsDetailSnapshotCollector() + + def collect_snapshot(self, env: str, query: str = '') -> DetailPageSnapshot: + """ + 采集运维状态页只读快照。 + + :param env: 当前运行环境 + :param query: 当前搜索词 + :return: 页面快照 + """ + source_payloads = self.snapshot_collector.collect(env) + sections = self.section_builder.build_sections( + health_payload=source_payloads.health_payload, + ping_db_payload=source_payloads.ping_db_payload, + ping_redis_payload=source_payloads.ping_redis_payload, + deps_payload=source_payloads.deps_payload, + server_payload=source_payloads.server_payload, + ) + return DetailPageSnapshot( + title='运维', + subtitle=TUI_DIAGNOSTIC_SERVICE.build_ops_diagnostic_subtitle( + source_payloads.health_payload, + source_payloads.deps_payload, + source_payloads.server_payload, + ), + sections=self.filter_sections(sections, query), + search=self.resolve_search_context(query), + ) + + +OPS_DETAIL_ADAPTER = OpsDetailAdapter() diff --git a/shierfeng-fastapi-backend/cli/tui/app.py b/shierfeng-fastapi-backend/cli/tui/app.py new file mode 100644 index 0000000..d95da40 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/app.py @@ -0,0 +1,898 @@ +from collections.abc import Callable +from dataclasses import dataclass +from datetime import datetime + +from textual.app import App +from textual.css.query import NoMatches + +from cli.tui.adapters import ( + TUI_SNAPSHOT_COLLECTOR_REGISTRY, + BrowserPageSnapshot, + DashboardSnapshot, + DetailPageSnapshot, +) +from cli.tui.copy import TUI_COPY +from cli.tui.keymaps import TUI_KEYMAP_REGISTRY +from cli.tui.screens import BrowserScreen, DashboardScreen, DetailScreen +from cli.tui.widgets import NavigationItem, WorkspaceSidebar + +SnapshotCollector = Callable[['ShierfengTuiApp'], BrowserPageSnapshot | DashboardSnapshot | DetailPageSnapshot] + + +@dataclass(frozen=True) +class TuiViewSpec: + """ + TUI 视图规格定义。 + + :param view_key: 视图标识 + :param include_query: 是否注入搜索词 + :param include_filter: 是否注入筛选键 + """ + + view_key: str + include_query: bool = False + include_filter: bool = False + + +@dataclass(frozen=True) +class TuiViewDefinition: + """ + TUI 视图定义。 + + :param view_key: 视图标识 + :param collector: 页面快照采集器 + """ + + view_key: str + collector: SnapshotCollector + + +@dataclass(frozen=True) +class TuiViewRegistry: + """ + TUI 视图注册表。 + + 该对象集中维护视图打开、刷新与顺序导航所需的元数据, + 避免 `ShierfengTuiApp` 内继续手工维护多份视图映射。 + + :param definitions: 视图定义映射 + :param navigation_items: 导航项列表 + """ + + definitions: dict[str, TuiViewDefinition] + navigation_items: list[NavigationItem] + + @staticmethod + def normalize_view_key(view_key: str) -> str: + """ + 规范化视图标识。 + + :param view_key: 原始视图标识 + :return: 规范化后的视图标识 + """ + return str(view_key).strip().lower() + + def resolve_view_key(self, view_key: str) -> str: + """ + 解析可用视图标识,不存在时回退到 dashboard。 + + :param view_key: 原始视图标识 + :return: 可用视图标识 + """ + normalized_view_key = self.normalize_view_key(view_key) + if normalized_view_key in self.definitions: + return normalized_view_key + return 'dashboard' + + def collect_snapshot( + self, app: 'ShierfengTuiApp', view_key: str + ) -> BrowserPageSnapshot | DashboardSnapshot | DetailPageSnapshot: + """ + 采集指定视图的页面快照。 + + :param app: 当前 TUI 应用实例 + :param view_key: 目标视图标识 + :return: 页面快照 + """ + resolved_view_key = self.resolve_view_key(view_key) + return self.definitions[resolved_view_key].collector(app) + + def get_navigation_index(self, view_key: str) -> int: + """ + 获取视图在导航列表中的索引。 + + :param view_key: 目标视图标识 + :return: 导航索引 + """ + resolved_view_key = self.resolve_view_key(view_key) + return next( + (index for index, item in enumerate(self.navigation_items) if item.view_key == resolved_view_key), + 0, + ) + + def get_relative_view_key(self, view_key: str, offset: int) -> str: + """ + 获取相对当前视图偏移后的目标视图标识。 + + :param view_key: 当前视图标识 + :param offset: 偏移量 + :return: 目标视图标识 + """ + current_index = self.get_navigation_index(view_key) + target_index = (current_index + offset) % len(self.navigation_items) + return self.navigation_items[target_index].view_key + + +_TUI_VIEW_SPECS: tuple[TuiViewSpec, ...] = ( + TuiViewSpec('dashboard'), + TuiViewSpec('app', include_query=True), + TuiViewSpec('ops', include_query=True), + TuiViewSpec('database', include_query=True), + TuiViewSpec('cache', include_query=True), + TuiViewSpec('jobs', include_query=True, include_filter=True), + TuiViewSpec('gen', include_query=True), + TuiViewSpec('configs', include_query=True, include_filter=True), + TuiViewSpec('crypto', include_query=True), +) + +_TUI_APP_CSS = """ +Screen { + layout: vertical; + background: #04080f; + color: #d8f7ff; + scrollbar-size-horizontal: 1; + scrollbar-size-vertical: 1; + scrollbar-background: #06111b; + scrollbar-background-hover: #0a1723; + scrollbar-background-active: #0d1f2d; + scrollbar-color: #1f6f8d; + scrollbar-color-hover: #38d8ff; + scrollbar-color-active: #6df7ff; +} + +Widget { + scrollbar-size-horizontal: 1; + scrollbar-size-vertical: 1; + scrollbar-background: #06111b; + scrollbar-background-hover: #0a1723; + scrollbar-background-active: #0d1f2d; + scrollbar-color: #1f6f8d; + scrollbar-color-hover: #38d8ff; + scrollbar-color-active: #6df7ff; +} + +#workspace-shell { + height: 1fr; + background: #050c15; +} + +#workspace-main { + padding: 1 2 1 1; + background: #050c15; + border: round #18425d; + margin: 1 1 1 0; + overflow-x: auto; + overflow-y: auto; + scrollbar-size-horizontal: 1; + scrollbar-size-vertical: 1; + scrollbar-background: #06111b; + scrollbar-background-hover: #0a1723; + scrollbar-background-active: #0d1f2d; + scrollbar-color: #1f6f8d; + scrollbar-color-hover: #38d8ff; + scrollbar-color-active: #6df7ff; +} + +#workspace-main:focus { + border: heavy #6df7ff; + background: #071320; +} + +#detail-body { + height: auto; + margin-top: 1; + border: double #18425d; + background: #06111b; + padding: 1; + overflow-x: auto; + overflow-y: auto; +} + +#browser-body { + height: auto; + margin-top: 1; + border: double #18425d; + background: #06111b; + padding: 1; + overflow-x: auto; + overflow-y: auto; +} + +#browser-filter-bar { + border: round #163c57; + padding: 1 2; + margin-bottom: 1; + background: #07131f; + color: #d9fbff; +} + +#browser-detail-pane { + width: 1fr; + min-width: 48; + border: round #163c57; + padding: 1; + background: #07131f; + overflow-x: auto; + overflow-y: auto; +} + +#browser-detail-pane.is-ok { + border: round #22c983; +} + +#browser-detail-pane.is-fail { + border: round #ff6b7a; + background: #190d12; +} + +#browser-detail-pane.is-warn { + border: round #f2b84b; + background: #171108; +} + +#browser-detail-pane.is-info { + border: round #38d8ff; +} + +#browser-section-body { + height: auto; + border-top: solid #163c57; + padding-top: 1; + background: #06111b; + overflow-x: auto; + overflow-y: auto; +} + +#dashboard-metrics { + grid-size: 4; + grid-gutter: 1 2; + grid-columns: 1fr 1fr 1fr 1fr; + height: auto; + margin-top: 1; + margin-bottom: 1; + padding: 1 0; +} + +#dashboard-grid, #detail-grid { + grid-size: 2; + grid-gutter: 1 2; + grid-columns: 1fr 1fr; + height: auto; + margin-top: 1; +} + +#detail-grid { + margin-bottom: 1; +} + +Footer { + background: #060d16; + color: #b6efff; + border-top: heavy #163c57; +} + +FooterKey { + background: #0b2130; + color: #ecfcff; +} +""" + + +@dataclass(frozen=True) +class TuiBindingSpec: + """ + TUI 快捷键绑定定义。 + + :param key: 快捷键 + :param action: 动作名称 + :param label: 展示标签 + """ + + key: str + action: str + label: str + + +class TuiBindingBuilder: + """ + TUI 快捷键绑定构建器。 + + 该对象负责统一装配应用级固定绑定和视图跳转绑定,避免 `ShierfengTuiApp` + 继续手工维护重复的绑定元组列表。 + """ + + def build_base_bindings(self) -> list[TuiBindingSpec]: + """ + 构建应用级固定绑定。 + + :return: 绑定定义列表 + """ + return [ + TuiBindingSpec('q', 'quit', TUI_COPY.build_app_binding_label('quit')), + TuiBindingSpec('s', 'focus_sidebar', TUI_COPY.build_app_binding_label('sidebar')), + TuiBindingSpec('[', 'show_previous_view', TUI_COPY.build_app_binding_label('previous')), + TuiBindingSpec(']', 'show_next_view', TUI_COPY.build_app_binding_label('next')), + TuiBindingSpec('r', 'refresh_current_view', TUI_COPY.build_app_binding_label('refresh')), + ] + + def build_navigation_bindings(self) -> list[TuiBindingSpec]: + """ + 构建页面导航绑定。 + + :return: 绑定定义列表 + """ + return [ + TuiBindingSpec( + TUI_KEYMAP_REGISTRY.get_navigation_shortcut(spec.view_key), + f'show_{spec.view_key}', + TUI_COPY.render_view_label(spec.view_key), + ) + for spec in _TUI_VIEW_SPECS + ] + + def build(self) -> list[tuple[str, str, str]]: + """ + 构建 Textual 所需的绑定元组列表。 + + :return: 绑定元组列表 + """ + return [ + (binding.key, binding.action, binding.label) + for binding in [*self.build_base_bindings(), *self.build_navigation_bindings()] + ] + + +TUI_APP_BINDINGS = TuiBindingBuilder().build() + + +@dataclass(frozen=True) +class TuiViewRegistryBuilder: + """ + TUI 视图注册表构建器。 + + 该对象负责根据统一规格构建导航项和快照采集定义,避免模块内 + 继续维护重复的 `lambda collect(...)` 配置块。 + """ + + def build_navigation_items(self) -> list[NavigationItem]: + """ + 构建工作台导航项列表。 + + :return: 导航项列表 + """ + return [ + NavigationItem( + view_key, + TUI_COPY.render_view_label(view_key), + shortcut, + TUI_COPY.render_navigation_description(view_key), + ) + for view_key, shortcut in TUI_KEYMAP_REGISTRY.navigation_shortcuts.items() + ] + + def build_collector(self, spec: TuiViewSpec) -> SnapshotCollector: + """ + 根据视图规格构建页面快照采集器。 + + :param spec: 视图规格 + :return: 页面快照采集器 + """ + + def collect(app: 'ShierfengTuiApp') -> BrowserPageSnapshot | DashboardSnapshot | DetailPageSnapshot: + collect_kwargs: dict[str, str] = {} + if spec.include_filter: + collect_kwargs['filter_key'] = app.get_browser_filter(spec.view_key) + if spec.include_query: + collect_kwargs['query'] = app.get_browser_query(spec.view_key) + return TUI_SNAPSHOT_COLLECTOR_REGISTRY.collect(spec.view_key, app.env, **collect_kwargs) + + return collect + + def build_definitions(self) -> dict[str, TuiViewDefinition]: + """ + 构建视图定义映射。 + + :return: 视图定义映射 + """ + return {spec.view_key: TuiViewDefinition(spec.view_key, self.build_collector(spec)) for spec in _TUI_VIEW_SPECS} + + def build(self) -> TuiViewRegistry: + """ + 构建 TUI 视图注册表。 + + :return: 视图注册表 + """ + return TuiViewRegistry( + definitions=self.build_definitions(), + navigation_items=self.build_navigation_items(), + ) + + +@dataclass +class TuiViewStateStore: + """ + TUI 视图状态存储。 + + 该对象集中维护页面级动作反馈、浏览页筛选键和搜索词,避免 + `ShierfengTuiApp` 本体继续直接操作多份同类字典状态。 + + :param action_feedback_by_view: 动作反馈映射 + :param browser_filter_by_view: 浏览页筛选映射 + :param browser_query_by_view: 浏览页搜索词映射 + """ + + action_feedback_by_view: dict[str, list[str]] + browser_filter_by_view: dict[str, str] + browser_query_by_view: dict[str, str] + + @classmethod + def create_default(cls) -> 'TuiViewStateStore': + """ + 创建默认视图状态存储。 + + :return: 视图状态存储 + """ + return cls( + action_feedback_by_view={}, + browser_filter_by_view={'jobs': 'all', 'configs': 'all'}, + browser_query_by_view={}, + ) + + def remember_action_feedback(self, view_key: str, lines: list[str]) -> None: + """ + 记录指定页面最近一次动作反馈。 + + :param view_key: 页面视图标识 + :param lines: 反馈文本行 + :return: None + """ + self.action_feedback_by_view[view_key] = list(lines) + + def get_action_feedback_lines(self, view_key: str) -> list[str]: + """ + 读取指定页面最近一次动作反馈。 + + :param view_key: 页面视图标识 + :return: 反馈文本行 + """ + return list(self.action_feedback_by_view.get(view_key, [])) + + def remember_browser_filter(self, view_key: str, filter_key: str) -> None: + """ + 记录指定浏览页当前筛选键。 + + :param view_key: 页面视图标识 + :param filter_key: 当前筛选键 + :return: None + """ + self.browser_filter_by_view[view_key] = filter_key + + def get_browser_filter(self, view_key: str, default: str = 'all') -> str: + """ + 读取指定浏览页当前筛选键。 + + :param view_key: 页面视图标识 + :param default: 默认筛选键 + :return: 当前筛选键 + """ + return str(self.browser_filter_by_view.get(view_key, default) or default) + + def remember_browser_query(self, view_key: str, query: str) -> None: + """ + 记录指定浏览页当前搜索词。 + + :param view_key: 页面视图标识 + :param query: 当前搜索词 + :return: None + """ + normalized_query = str(query or '').strip() + if normalized_query: + self.browser_query_by_view[view_key] = normalized_query + return + self.browser_query_by_view.pop(view_key, None) + + def get_browser_query(self, view_key: str, default: str = '') -> str: + """ + 读取指定浏览页当前搜索词。 + + :param view_key: 页面视图标识 + :param default: 默认搜索词 + :return: 当前搜索词 + """ + return str(self.browser_query_by_view.get(view_key, default) or default) + + +TUI_VIEW_REGISTRY = TuiViewRegistryBuilder().build() +NAVIGATION_ITEMS = TUI_VIEW_REGISTRY.navigation_items + + +@dataclass(frozen=True) +class TuiScreenFactory: + """ + TUI 工作台页面工厂。 + + 该对象负责把页面快照转换为具体 screen 实例,避免 `ShierfengTuiApp` + 同时承担状态协调和 screen 构建职责。 + """ + + @staticmethod + def build_refresh_timestamp() -> str: + """ + 构建当前页面刷新时间文本。 + + :return: 格式化后的刷新时间 + """ + return datetime.now().strftime('%Y-%m-%d %H:%M:%S') + + def build( + self, + *, + snapshot: BrowserPageSnapshot | DashboardSnapshot | DetailPageSnapshot, + env: str, + active_view: str, + navigation_items: list[NavigationItem], + action_feedback_lines: list[str], + ) -> BrowserScreen | DashboardScreen | DetailScreen: + """ + 根据快照类型构建对应的工作台页面。 + + :param snapshot: 页面快照 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param navigation_items: 导航项列表 + :param action_feedback_lines: 当前视图动作反馈 + :return: 对应的页面对象 + """ + refreshed_at = self.build_refresh_timestamp() + if isinstance(snapshot, DashboardSnapshot): + return DashboardScreen( + snapshot, + env=env, + active_view=active_view, + navigation_items=navigation_items, + refreshed_at=refreshed_at, + ) + if isinstance(snapshot, BrowserPageSnapshot): + return BrowserScreen( + snapshot, + env=env, + active_view=active_view, + navigation_items=navigation_items, + refreshed_at=refreshed_at, + action_feedback_lines=action_feedback_lines, + ) + return DetailScreen( + snapshot, + env=env, + active_view=active_view, + navigation_items=navigation_items, + refreshed_at=refreshed_at, + ) + + +@dataclass +class TuiScreenNavigator: + """ + TUI 工作台页面导航器。 + + 该对象负责处理首屏展示与后续切屏差异,让应用壳更专注于状态切换。 + + :param app: 当前 TUI 应用实例 + :param initialized: 工作台屏幕是否已初始化 + """ + + app: 'ShierfengTuiApp' + initialized: bool = False + + def show(self, screen: BrowserScreen | DashboardScreen | DetailScreen) -> None: + """ + 显示工作台页面,并兼容首屏初始化与后续切屏。 + + Textual 在默认根屏阶段直接调用 `switch_screen()` 会触发内部回调栈异常, + 因此首次展示页面需要使用 `push_screen()` 建立活动屏,后续再改用 + `switch_screen()` 做同层页面替换。 + + :param screen: 待显示的页面对象 + :return: None + """ + if not self.initialized: + self.app.push_screen(screen) + self.initialized = True + return + self.app.switch_screen(screen) + + +@dataclass(frozen=True) +class TuiViewOpeningCoordinator: + """ + TUI 视图打开协调器。 + + 该对象负责串联视图解析、快照采集、screen 构建与切屏展示, + 让 `ShierfengTuiApp` 更专注于状态暴露与 Textual action 桥接。 + + :param view_registry: 视图注册表 + :param screen_factory: 工作台页面工厂 + :param navigation_items: 导航项列表 + """ + + view_registry: TuiViewRegistry + screen_factory: TuiScreenFactory + navigation_items: list[NavigationItem] + + def show(self, app: 'ShierfengTuiApp', view_key: str) -> None: + """ + 切换并展示指定视图。 + + :param app: 当前 TUI 应用实例 + :param view_key: 目标视图标识 + :return: None + """ + resolved_view_key = self.view_registry.resolve_view_key(view_key) + app.current_view = resolved_view_key + snapshot = self.view_registry.collect_snapshot(app, resolved_view_key) + screen = self.screen_factory.build( + snapshot=snapshot, + env=app.env, + active_view=app.current_view, + navigation_items=self.navigation_items, + action_feedback_lines=app.get_action_feedback_lines(app.current_view), + ) + app.screen_navigator.show(screen) + + +class ShierfengTuiApp(App[None]): + """ + ShiErFeng CLI Textual 应用。 + + :param env: 当前运行环境 + """ + + CSS = _TUI_APP_CSS + BINDINGS = TUI_APP_BINDINGS + + def __init__(self, env: str) -> None: + """ + 初始化 TUI 应用实例。 + + :param env: 当前运行环境 + :return: None + """ + self.env = env + self.current_view = 'dashboard' + self.view_state_store = TuiViewStateStore.create_default() + self.screen_factory = TuiScreenFactory() + self.screen_navigator = TuiScreenNavigator(self) + self.view_opening_coordinator = TuiViewOpeningCoordinator( + view_registry=TUI_VIEW_REGISTRY, + screen_factory=self.screen_factory, + navigation_items=NAVIGATION_ITEMS, + ) + super().__init__() + + def show_view(self, view_key: str) -> None: + """ + 切换并展示指定视图。 + + :param view_key: 目标视图标识 + :return: None + """ + self.view_opening_coordinator.show(self, view_key) + + def remember_action_feedback(self, view_key: str, lines: list[str]) -> None: + """ + 记录指定页面最近一次动作反馈。 + + :param view_key: 页面视图标识 + :param lines: 反馈文本行 + :return: None + """ + self.view_state_store.remember_action_feedback(view_key, lines) + + def get_action_feedback_lines(self, view_key: str) -> list[str]: + """ + 读取指定页面最近一次动作反馈。 + + :param view_key: 页面视图标识 + :return: 反馈文本行 + """ + return self.view_state_store.get_action_feedback_lines(view_key) + + def remember_browser_filter(self, view_key: str, filter_key: str) -> None: + """ + 记录指定浏览页当前筛选键。 + + :param view_key: 页面视图标识 + :param filter_key: 当前筛选键 + :return: None + """ + self.view_state_store.remember_browser_filter(view_key, filter_key) + + def get_browser_filter(self, view_key: str, default: str = 'all') -> str: + """ + 读取指定浏览页当前筛选键。 + + :param view_key: 页面视图标识 + :param default: 默认筛选键 + :return: 当前筛选键 + """ + return self.view_state_store.get_browser_filter(view_key, default) + + def remember_browser_query(self, view_key: str, query: str) -> None: + """ + 记录指定浏览页当前搜索词。 + + :param view_key: 页面视图标识 + :param query: 当前搜索词 + :return: None + """ + self.view_state_store.remember_browser_query(view_key, query) + + def get_browser_query(self, view_key: str, default: str = '') -> str: + """ + 读取指定浏览页当前搜索词。 + + :param view_key: 页面视图标识 + :param default: 默认搜索词 + :return: 当前搜索词 + """ + return self.view_state_store.get_browser_query(view_key, default) + + def on_mount(self) -> None: + """ + 在应用启动时载入首页。 + + :return: None + """ + self.show_view('dashboard') + + def open_view(self, view_key: str) -> None: + """ + 按视图标识打开对应页面。 + + :param view_key: 视图标识 + :return: None + """ + self.show_view(view_key) + + def action_focus_sidebar(self) -> None: + """ + 将焦点切换到左侧导航栏。 + + :return: None + """ + try: + self.screen.query_one(WorkspaceSidebar).focus() + except NoMatches: + return + + def action_show_previous_view(self) -> None: + """ + 切换到前一个工作台视图。 + + :return: None + """ + self.open_view(TUI_VIEW_REGISTRY.get_relative_view_key(self.current_view, -1)) + + def action_show_next_view(self) -> None: + """ + 切换到后一个工作台视图。 + + :return: None + """ + self.open_view(TUI_VIEW_REGISTRY.get_relative_view_key(self.current_view, 1)) + + def action_refresh_current_view(self) -> None: + """ + 刷新当前视图数据。 + + :return: None + """ + self.show_view(self.current_view) + + def action_show_dashboard(self) -> None: + """ + 切换到首页视图。 + + :return: None + """ + self.open_view('dashboard') + + def action_show_app(self) -> None: + """ + 切换到应用详情视图。 + + :return: None + """ + self.open_view('app') + + def action_show_ops(self) -> None: + """ + 切换到运维详情视图。 + + :return: None + """ + self.open_view('ops') + + def action_show_database(self) -> None: + """ + 切换到数据库详情视图。 + + :return: None + """ + self.open_view('database') + + def action_show_cache(self) -> None: + """ + 切换到缓存浏览视图。 + + :return: None + """ + self.open_view('cache') + + def action_show_jobs(self) -> None: + """ + 切换到任务浏览视图。 + + :return: None + """ + self.open_view('jobs') + + def action_show_gen(self) -> None: + """ + 切换到代码生成浏览视图。 + + :return: None + """ + self.open_view('gen') + + def action_show_configs(self) -> None: + """ + 切换到配置浏览视图。 + + :return: None + """ + self.open_view('configs') + + def action_show_crypto(self) -> None: + """ + 切换到传输加密详情视图。 + + :return: None + """ + self.open_view('crypto') + + +@dataclass(frozen=True) +class TuiAppRunner: + """ + TUI 应用启动器。 + + 该对象负责按环境创建并运行 Textual 应用实例,使命令入口不再依赖 + 模块级启动函数。 + + :param app_factory: TUI 应用工厂 + """ + + app_factory: Callable[[str], ShierfengTuiApp] + + def run(self, env: str) -> None: + """ + 启动 TUI 应用。 + + :param env: 当前运行环境 + :return: None + """ + self.app_factory(env).run() + + +TUI_APP_RUNNER = TuiAppRunner(ShierfengTuiApp) diff --git a/shierfeng-fastapi-backend/cli/tui/capabilities.py b/shierfeng-fastapi-backend/cli/tui/capabilities.py new file mode 100644 index 0000000..95f7b12 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/capabilities.py @@ -0,0 +1,209 @@ +from dataclasses import dataclass +from typing import Literal + +from cli.tui.copy import TUI_COPY + +CapabilityKind = Literal['read_only', 'preview', 'low_risk_action', 'wizard_entry', 'command_hint'] +CapabilityScope = Literal['browser', 'detail'] + + +@dataclass(frozen=True) +class TuiCapability: + """ + TUI 页面能力定义。 + + :param kind: 能力类型 + :param slot: 绑定的动作槽位 + :param key: 绑定的快捷键 + :param label: 展示标签 + :param hint_label: 用于顶部提示的简洁标签 + :param scope: 能力所在页面范围 + """ + + kind: CapabilityKind + slot: str + key: str + label: str + hint_label: str + scope: CapabilityScope + + +@dataclass(frozen=True) +class TuiCapabilitySpec: + """ + TUI 页面能力规格定义。 + + :param capability_key: 能力标识 + :param kind: 能力类型 + :param slot: 绑定动作槽位 + :param key: 绑定快捷键 + """ + + capability_key: str + kind: CapabilityKind + slot: str + key: str + + +_BROWSER_CAPABILITY_SPECS: dict[str, tuple[TuiCapabilitySpec, ...]] = { + 'jobs': ( + TuiCapabilitySpec('job_run_once', 'low_risk_action', 'primary', 'X'), + TuiCapabilitySpec('job_toggle', 'low_risk_action', 'secondary', 'Z'), + TuiCapabilitySpec('job_sync', 'preview', 'global', 'Y'), + ), + 'configs': (TuiCapabilitySpec('config_sync', 'low_risk_action', 'global', 'Y'),), + 'cache': ( + TuiCapabilitySpec('cache_clear_wizard', 'wizard_entry', 'global', 'Y'), + TuiCapabilitySpec('cache_warmup', 'low_risk_action', 'utility', 'W'), + ), + 'gen': ( + TuiCapabilitySpec('gen_export_wizard', 'wizard_entry', 'primary', 'X'), + TuiCapabilitySpec('gen_import_wizard', 'wizard_entry', 'secondary', 'Z'), + TuiCapabilitySpec('gen_export_dry_run', 'preview', 'global', 'Y'), + TuiCapabilitySpec('gen_sync_db', 'low_risk_action', 'utility', 'W'), + ), +} + +_DETAIL_CAPABILITY_SPECS: dict[str, tuple[TuiCapabilitySpec, ...]] = { + 'app': ( + TuiCapabilitySpec('app_run', 'wizard_entry', 'primary', 'X'), + TuiCapabilitySpec('app_run_wizard', 'wizard_entry', 'global', 'Y'), + TuiCapabilitySpec('completion_install', 'command_hint', 'utility', 'W'), + ), + 'database': ( + TuiCapabilitySpec('db_upgrade_wizard', 'wizard_entry', 'global', 'Y'), + TuiCapabilitySpec('db_init_dry_run', 'preview', 'utility', 'W'), + ), + 'ops': ( + TuiCapabilitySpec('ops_ping_db', 'low_risk_action', 'primary', 'X'), + TuiCapabilitySpec('ops_ping_redis', 'low_risk_action', 'secondary', 'Z'), + TuiCapabilitySpec('prod_check_wizard', 'wizard_entry', 'global', 'Y'), + ), + 'crypto': ( + TuiCapabilitySpec('crypto_keygen', 'wizard_entry', 'primary', 'X'), + TuiCapabilitySpec('crypto_rotate_dry_run', 'preview', 'global', 'Y'), + ), +} + + +@dataclass(frozen=True) +class TuiCapabilityRegistry: + """ + TUI 页面能力注册表。 + + 该对象集中维护浏览页与详情页的能力描述,避免模块级散落 + 的字典常量在后续扩展时继续增长。 + + :param browser_capabilities: 浏览页能力映射 + :param detail_capabilities: 详情页能力映射 + """ + + browser_capabilities: dict[str, tuple[TuiCapability, ...]] + detail_capabilities: dict[str, tuple[TuiCapability, ...]] + + @staticmethod + def normalize_view_key(view_key: str) -> str: + """ + 规范化页面标识。 + + :param view_key: 原始页面标识 + :return: 规范化后的页面标识 + """ + return str(view_key).strip().lower() + + def get_browser_capabilities(self, view_key: str) -> tuple[TuiCapability, ...]: + """ + 获取浏览页支持的能力列表。 + + :param view_key: 页面视图标识 + :return: 能力列表 + """ + return self.browser_capabilities.get(self.normalize_view_key(view_key), ()) + + def get_detail_capabilities(self, view_key: str) -> tuple[TuiCapability, ...]: + """ + 获取详情页支持的能力列表。 + + :param view_key: 页面视图标识 + :return: 能力列表 + """ + return self.detail_capabilities.get(self.normalize_view_key(view_key), ()) + + +@dataclass(frozen=True) +class TuiCapabilityRegistryBuilder: + """ + TUI 页面能力注册表构建器。 + + 该对象负责通过统一文案服务构建页面能力定义,避免模块内继续 + 直接堆叠硬编码的标题和提示标签。 + """ + + def build_capability( + self, + *, + capability_key: str, + kind: CapabilityKind, + slot: str, + key: str, + scope: CapabilityScope, + ) -> TuiCapability: + """ + 构建单条能力定义。 + + :param capability_key: 能力标识 + :param kind: 能力类型 + :param slot: 绑定动作槽位 + :param key: 绑定快捷键 + :param scope: 页面范围 + :return: 能力定义 + """ + return TuiCapability( + kind=kind, + slot=slot, + key=key, + label=TUI_COPY.build_capability_label(capability_key), + hint_label=TUI_COPY.build_capability_hint_label(capability_key), + scope=scope, + ) + + def build_scope_capabilities( + self, + specs_by_view: dict[str, tuple[TuiCapabilitySpec, ...]], + *, + scope: CapabilityScope, + ) -> dict[str, tuple[TuiCapability, ...]]: + """ + 根据规格映射构建指定页面范围的能力注册表。 + + :param specs_by_view: 页面能力规格映射 + :param scope: 页面范围 + :return: 构建后的能力映射 + """ + return { + view_key: tuple( + self.build_capability( + capability_key=spec.capability_key, + kind=spec.kind, + slot=spec.slot, + key=spec.key, + scope=scope, + ) + for spec in specs + ) + for view_key, specs in specs_by_view.items() + } + + def build(self) -> TuiCapabilityRegistry: + """ + 构建页面能力注册表。 + + :return: 能力注册表 + """ + return TuiCapabilityRegistry( + browser_capabilities=self.build_scope_capabilities(_BROWSER_CAPABILITY_SPECS, scope='browser'), + detail_capabilities=self.build_scope_capabilities(_DETAIL_CAPABILITY_SPECS, scope='detail'), + ) + + +TUI_CAPABILITY_REGISTRY = TuiCapabilityRegistryBuilder().build() diff --git a/shierfeng-fastapi-backend/cli/tui/commands.py b/shierfeng-fastapi-backend/cli/tui/commands.py new file mode 100644 index 0000000..e6e62e6 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/commands.py @@ -0,0 +1,145 @@ +from dataclasses import dataclass +from importlib import import_module +from types import ModuleType + +import typer + +from cli.context import EnvOption +from cli.core import DEFAULT_CORE_SERVICES, CliContextFactory, CliExecutionService +from cli.exit_codes import DEPENDENCY_ERROR +from cli.output import CommandResult +from cli.tui.copy import TUI_COPY + + +@dataclass(frozen=True) +class TuiDependencyResultFactory: + """ + TUI 依赖结果构建器。 + + 该对象负责统一构建 Textual/Rich 缺失时的降级结果, + 避免命令注册层继续直接拼接错误负载。 + """ + + def build_missing_dependency_result(self) -> CommandResult: + """ + 构建 TUI 可选依赖缺失时的提示结果。 + + :return: 命令结果对象 + """ + return CommandResult( + data={ + 'ok': False, + 'message': TUI_COPY.build_missing_dependency_message(), + 'hint': TUI_COPY.build_missing_dependency_hint(), + }, + exit_code=DEPENDENCY_ERROR, + ) + + +@dataclass(frozen=True) +class TuiAppModuleLoader: + """ + TUI 应用模块加载器。 + + 该对象负责识别缺失的可选依赖,并在命令执行阶段按需导入 + `cli.tui.app` 模块。 + """ + + def is_missing_dependency_error(self, exc: ModuleNotFoundError) -> bool: + """ + 判断模块导入异常是否由 TUI 可选依赖缺失触发。 + + :param exc: 模块导入异常 + :return: 是否为 TUI 依赖缺失 + """ + missing_module_name = (exc.name or '').split('.', 1)[0] + return missing_module_name in {'textual', 'rich'} + + def load(self) -> ModuleType: + """ + 惰性导入 TUI 应用模块。 + + :return: `cli.tui.app` 模块对象 + """ + return import_module('cli.tui.app') + + +@dataclass(frozen=True) +class TuiCommandRegistration: + """ + TUI 命令注册器。 + + :param context_factory: CLI 上下文工厂 + :param execution_service: CLI 执行服务 + :param dependency_result_factory: TUI 缺失依赖结果构建器 + :param module_loader: TUI 应用模块加载器 + """ + + context_factory: CliContextFactory + execution_service: CliExecutionService + dependency_result_factory: TuiDependencyResultFactory + module_loader: TuiAppModuleLoader + + def handle_tui_command(self, env: str) -> None: + """ + 执行 `shierfeng tui` 命令。 + + :param env: 当前命令运行环境 + :return: None + """ + ctx = self.context_factory.build_readonly(env, 'text') + try: + tui_app_module = self.module_loader.load() + except ModuleNotFoundError as exc: + if self.module_loader.is_missing_dependency_error(exc): + self.execution_service.complete_result( + ctx, + self.dependency_result_factory.build_missing_dependency_result(), + ) + return + raise + tui_app_module.TUI_APP_RUNNER.run(env) + + def build(self) -> typer.Typer: + """ + 构建 `tui` 子应用。 + + :return: `tui` 子应用 + """ + app = typer.Typer( + help=TUI_COPY.build_tui_command_help(), + no_args_is_help=False, + invoke_without_command=True, + context_settings={'help_option_names': ['-h', '--help']}, + ) + + @app.callback() + def tui( + env: EnvOption = 'dev', + ) -> None: + """ + 进入只读巡检工作台。 + + :param env: 当前命令运行环境 + :return: None + """ + self.handle_tui_command(env) + + return app + + def register(self, root_cli: typer.Typer) -> None: + """ + 向根 Typer 应用注册 `tui` 命令。 + + :param root_cli: 根 Typer 应用 + :return: None + """ + root_cli.add_typer(self.build(), name='tui') + + +TUI_COMMAND_REGISTRATION = TuiCommandRegistration( + context_factory=DEFAULT_CORE_SERVICES.context_factory, + execution_service=DEFAULT_CORE_SERVICES.execution_service, + dependency_result_factory=TuiDependencyResultFactory(), + module_loader=TuiAppModuleLoader(), +) diff --git a/shierfeng-fastapi-backend/cli/tui/copy/__init__.py b/shierfeng-fastapi-backend/cli/tui/copy/__init__.py new file mode 100644 index 0000000..4c4e3de --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/copy/__init__.py @@ -0,0 +1,23 @@ +from cli.tui.copy.actions import TuiActionCopyMixin +from cli.tui.copy.navigation import TuiNavigationCopyMixin +from cli.tui.copy.workspace import TuiWorkspaceCopyMixin + + +class TuiCopyService(TuiNavigationCopyMixin, TuiActionCopyMixin, TuiWorkspaceCopyMixin): + """ + TUI 文案构造服务。 + + 该服务通过组合导航、动作和工作区文案混入对象,统一对外提供 + TUI 所需的文案构造能力,避免入口模块继续堆积实现细节。 + """ + + +TUI_COPY = TuiCopyService() + +__all__ = [ + 'TUI_COPY', + 'TuiActionCopyMixin', + 'TuiCopyService', + 'TuiNavigationCopyMixin', + 'TuiWorkspaceCopyMixin', +] diff --git a/shierfeng-fastapi-backend/cli/tui/copy/actions.py b/shierfeng-fastapi-backend/cli/tui/copy/actions.py new file mode 100644 index 0000000..6a45126 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/copy/actions.py @@ -0,0 +1,298 @@ +from cli.tui.copy.fragments import ( + ACTION_CONSEQUENCE_TEXTS, + ACTION_FEEDBACK_COPY, + ACTION_HINT_COPY, + ACTION_LABELS, + ACTION_NOTIFICATION_COPY, + ACTION_PREVIEW_FIELD_LABELS, + ACTION_PREVIEW_TITLES, + ACTION_PURPOSE_LABELS, + ACTION_RESULT_FIELD_LABELS, + ACTION_SCOPE_LABELS, + CAPABILITY_HINT_LABELS, + CAPABILITY_LABELS, + COMMAND_HINT_TITLES, + GENERAL_COPY, +) +from cli.utils import NESTED_CLI_SUPPORT, SHELL_TEXT_FORMATTER + + +class TuiActionCopyMixin: + """ + TUI 动作与能力文案混入。 + """ + + @staticmethod + def build_action_confirm_hint() -> str: + """ + 构建动作确认弹窗底部提示文案。 + + :return: 确认提示文案 + """ + return GENERAL_COPY['action_confirm_hint'] + + @staticmethod + def build_action_confirm_cancel_label() -> str: + """ + 构建动作确认弹窗取消按钮文案。 + + :return: 取消按钮文案 + """ + return GENERAL_COPY['action_confirm_cancel_label'] + + @staticmethod + def build_action_label(action_key: str) -> str: + """ + 根据动作标识构建动作标题文案。 + + :param action_key: 动作标识 + :return: 动作标题文案 + """ + normalized_key = str(action_key).strip().lower() + return ACTION_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_scope_label(action_key: str) -> str: + """ + 根据动作标识构建作用范围文案。 + + :param action_key: 动作标识 + :return: 作用范围文案 + """ + normalized_key = str(action_key).strip().lower() + return ACTION_SCOPE_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_purpose_label(action_key: str) -> str: + """ + 根据动作标识构建用途文案。 + + :param action_key: 动作标识 + :return: 用途文案 + """ + normalized_key = str(action_key).strip().lower() + return ACTION_PURPOSE_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_preview_title(title_key: str) -> str: + """ + 根据预览区块标识构建标题文案。 + + :param title_key: 预览区块标识 + :return: 标题文案 + """ + normalized_key = str(title_key).strip().lower() + return ACTION_PREVIEW_TITLES.get(normalized_key, normalized_key) + + @staticmethod + def build_action_preview_field_label(field_key: str) -> str: + """ + 根据预览字段标识构建字段文案。 + + :param field_key: 预览字段标识 + :return: 字段文案 + """ + normalized_key = str(field_key).strip().lower() + return ACTION_PREVIEW_FIELD_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_result_field_label(field_key: str) -> str: + """ + 根据结果字段标识构建字段文案。 + + :param field_key: 结果字段标识 + :return: 字段文案 + """ + normalized_key = str(field_key).strip().lower() + return ACTION_RESULT_FIELD_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_notification_title() -> str: + """ + 构建动作通知标题文案。 + + :return: 通知标题文案 + """ + return ACTION_NOTIFICATION_COPY['title'] + + @staticmethod + def build_action_unavailable_message() -> str: + """ + 构建无可执行动作时的提示文案。 + + :return: 提示文案 + """ + return ACTION_NOTIFICATION_COPY['unavailable_message'] + + @staticmethod + def build_action_empty_line() -> str: + """ + 构建无可执行动作时的空态占位文案。 + + :return: 空态占位文案 + """ + return ACTION_NOTIFICATION_COPY['empty_line'] + + @staticmethod + def build_action_consequence_text(consequence_key: str) -> str: + """ + 根据后果说明标识构建说明文案。 + + :param consequence_key: 后果说明标识 + :return: 后果说明文案 + """ + normalized_key = str(consequence_key).strip().lower() + return ACTION_CONSEQUENCE_TEXTS.get(normalized_key, normalized_key) + + @staticmethod + def build_capability_label(capability_key: str) -> str: + """ + 根据能力标识构建展示标签文案。 + + :param capability_key: 能力标识 + :return: 展示标签文案 + """ + normalized_key = str(capability_key).strip().lower() + return CAPABILITY_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_capability_hint_label(capability_key: str) -> str: + """ + 根据能力标识构建顶部提示短标签文案。 + + :param capability_key: 能力标识 + :return: 短标签文案 + """ + normalized_key = str(capability_key).strip().lower() + return CAPABILITY_HINT_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_action_running_message(label: str) -> str: + """ + 构建动作执行中的提示文案。 + + :param label: 动作标题 + :return: 提示文案 + """ + return f'正在执行:{label}' + + @staticmethod + def build_browser_action_hint_text(view_key: str, interaction_hint: str) -> str: + """ + 构建浏览页动作提示文本。 + + :param view_key: 当前页面视图标识 + :param interaction_hint: 通用浏览提示 + :return: 动作提示文本 + """ + normalized_view = str(view_key).strip().lower() + template = ACTION_HINT_COPY['browser_templates'].get(normalized_view, ACTION_HINT_COPY['browser_default']) + return template.format(interaction_hint=interaction_hint) + + @staticmethod + def build_detail_action_hint_text(view_key: str, interaction_hint: str) -> str: + """ + 构建详情页动作提示文本。 + + :param view_key: 当前页面视图标识 + :param interaction_hint: 通用浏览提示 + :return: 动作提示文本 + """ + normalized_view = str(view_key).strip().lower() + template = ACTION_HINT_COPY['detail_templates'].get(normalized_view, ACTION_HINT_COPY['detail_default']) + return template.format(interaction_hint=interaction_hint) + + @staticmethod + def build_action_line(key: str, label: str) -> str: + """ + 构建单条动作快捷键信息。 + + :param key: 快捷键 + :param label: 动作标题 + :return: 文本文案 + """ + return f'动作键 [{key}] · {label}' + + @staticmethod + def build_capability_hint_text(capability_labels: list[str], interaction_hint: str, *, fallback: str) -> str: + """ + 根据能力标签列表构建统一动作提示文本。 + + :param capability_labels: 动作标签列表 + :param interaction_hint: 通用浏览提示 + :param fallback: 缺省提示模板 + :return: 动作提示文本 + """ + if not capability_labels: + return fallback.format(interaction_hint=interaction_hint) + return f'动作键:{" ".join(capability_labels)} | {interaction_hint}' + + @staticmethod + def build_action_result_message_line(label: str, value: str) -> str: + """ + 构建动作结果详情的单行文案。 + + :param label: 字段标题 + :param value: 字段值 + :return: 文本文案 + """ + return f'{label}: {value}' + + @staticmethod + def build_cli_command_hint(*command_args: str) -> str: + """ + 构建 TUI 中展示的 CLI 命令提示文本。 + + :param command_args: CLI 命令参数 + :return: 可直接复制执行的命令文本 + """ + return SHELL_TEXT_FORMATTER.format_shell_command(NESTED_CLI_SUPPORT.build_nested_cli_command(*command_args)) + + @staticmethod + def build_command_hint_lines( + *, + scenario: str, + command: str, + guide: str, + ) -> list[str]: + """ + 构建统一的命令入口提示文本。 + + :param scenario: 适用场景说明 + :param command: 推荐命令 + :param guide: 使用说明 + :return: 文本行列表 + """ + return [ + COMMAND_HINT_TITLES['scenario'], + scenario, + '', + COMMAND_HINT_TITLES['command'], + command, + '', + COMMAND_HINT_TITLES['guide'], + guide, + ] + + @staticmethod + def build_labeled_value_line(label: str, value: str) -> str: + """ + 构建通用的“标签: 值”文案。 + + :param label: 字段标题 + :param value: 字段值 + :return: 文本文案 + """ + return f'{label}: {value}' + + @staticmethod + def build_action_result_toast(label: str, outcome: str, message: str) -> str: + """ + 构建动作完成后的通知文案。 + + :param label: 动作标题 + :param outcome: 执行结果 + :param message: 结果摘要 + :return: 通知文案 + """ + return f'{ACTION_FEEDBACK_COPY["toast_prefix"]} · {label} · {outcome} · {message}' diff --git a/shierfeng-fastapi-backend/cli/tui/copy/fragments.py b/shierfeng-fastapi-backend/cli/tui/copy/fragments.py new file mode 100644 index 0000000..d1f32b5 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/copy/fragments.py @@ -0,0 +1,339 @@ +VIEW_LABELS = { + 'dashboard': '总览', + 'app': '应用', + 'ops': '运维', + 'database': '数据库', + 'cache': '缓存', + 'jobs': '任务', + 'gen': '代码生成', + 'configs': '参数配置', + 'crypto': '加密', +} + +STATUS_LABELS = { + 'ok': '正常', + 'success': '正常', + 'healthy': '正常', + 'fail': '失败', + 'error': '失败', + 'down': '失败', + 'warn': '警告', + 'warning': '警告', + 'degraded': '警告', + 'info': '信息', +} + +GENERAL_COPY = { + 'action_confirm_cancel_label': '取消', + 'action_confirm_hint': '按键提示 · [Enter] 确认执行 [Esc] 取消返回', + 'more_detail_hint': '> 进入对应页面查看更多', + 'tui_command_help': '进入只读巡检工作台', + 'tui_missing_dependency_hint': '请重新执行 `pip install -r requirements.txt` 或 `pip install -r requirements-pg.txt`', + 'tui_missing_dependency_message': '当前环境未安装 TUI 可选依赖,无法启动 `shierfeng tui`', +} + +STATE_SUGGESTIONS = { + 'dashboard_empty': '按 [R] 刷新,或进入对应页面查看更多上下文', + 'dashboard_failure': '按 [R] 刷新,或进入对应页面查看完整诊断信息', + 'empty': '可按 [R] 刷新,或切换到其他页面继续查看', + 'failure': '可按 [R] 刷新,或切换页面后重新进入', + 'loading': '可继续切换其他区域,当前内容加载完成后会自动刷新', +} + +PAGE_SUBTITLES = { + 'crypto': '查看运行校验、公钥身份和兼容版本信息', + 'ops': '查看基础连通性、依赖版本与服务器资源', +} + +NAVIGATION_DESCRIPTIONS = { + 'dashboard': '全链路态势与关键健康信号', + 'app': '环境解析、配置快照、补全诊断与路由摘要', + 'ops': '健康检查、依赖版本与服务器资源', + 'database': '连接、迁移版本与存储状态', + 'cache': 'Redis 容量、热点与命中信号', + 'jobs': '定时任务、执行轨迹与失败样本', + 'gen': '业务表、字段与生成配置', + 'configs': '配置巡检、漂移与异常值', + 'crypto': '传输加密校验、公钥身份与兼容版本', +} + +DASHBOARD_HERO_COPY = { + 'subtitle': '先看整体风险和巡检结论,再进入数据库、缓存、任务等分区继续定位', + 'title': '运行驾驶舱', +} + +STATUS_PANEL_COPY = { + 'empty': '暂无数据', +} + +ACTION_LABELS = { + 'app_run': '直接启动应用', + 'app_run_wizard': '打开启动向导', + 'cache_clear_wizard': '打开缓存清理向导', + 'cache_warmup': '执行缓存预热', + 'completion_install': '安装当前 Shell 补全', + 'config_sync': '刷新参数缓存', + 'crypto_keygen': '打开密钥生成入口', + 'crypto_rotate_dry_run': '执行轮换预演', + 'db_init_dry_run': '执行初始化预演', + 'db_upgrade_wizard': '打开升级向导', + 'gen_export_dry_run': '执行导出预演', + 'gen_export_wizard': '打开导出向导', + 'gen_import_wizard': '打开导入向导', + 'gen_sync_db': '同步数据库表结构', + 'job_pause': '暂停任务', + 'job_resume': '恢复任务', + 'job_run_once': '执行一次任务', + 'job_sync': '同步调度配置', + 'ops_ping_db': '执行数据库探活', + 'ops_ping_redis': '执行 Redis 探活', + 'prod_check_wizard': '打开生产巡检向导', +} + +ACTION_SCOPE_LABELS = { + 'cache_warmup': '系统字典与系统参数基础缓存', + 'completion_install': '当前终端活动 Shell 的补全安装流程', + 'config_sync': '当前环境全部系统参数', + 'db_init_dry_run': '当前环境数据库初始化流程', + 'gen_export_dry_run': '当前业务表的代码导出结果预演', + 'gen_sync_db': '当前业务表对应的生成配置和物理表结构', + 'job_sync': '当前环境调度器配置', + 'ops_ping_db': '当前环境数据库连接与基础读写探活', + 'ops_ping_redis': '当前环境 Redis 连接与基础命令探活', +} + +ACTION_PURPOSE_LABELS = { + 'cache_warmup': '重建运行所需的基础缓存内容', + 'completion_install': '自动识别当前 Shell,写入补全脚本并按需更新 rc 文件激活命令', + 'config_sync': '将数据库中的参数值重新写入 Redis 缓存', + 'db_init_dry_run': '仅预演初始化到最新迁移版本,不直接执行真实升级', + 'gen_export_dry_run': '先演练导出流程并确认输出模式、模板数量和结果摘要', + 'gen_sync_db': '将数据库中的最新字段结构同步回当前业务表配置', + 'job_sync': '将最新任务配置同步到调度执行器', + 'ops_ping_db': '快速确认当前环境数据库是否可连接并返回基础探活结果', + 'ops_ping_redis': '快速确认当前环境 Redis 是否可连接并返回基础命令探活结果', +} + +ACTION_PREVIEW_TITLES = { + 'command': '## 执行命令', + 'consequence': '## 确认后果', + 'env': '## 执行环境', + 'summary': '## 动作信息', +} + +ACTION_PREVIEW_FIELD_LABELS = { + 'current_status': '当前状态', + 'job': '任务', + 'job_id': '任务 ID', + 'purpose': '用途', + 'scope': '作用范围', + 'target_action': '目标动作', + 'target_env': '目标环境', +} + +ACTION_RESULT_FIELD_LABELS = { + 'count': '影响数量', + 'exit_code': '退出码', + 'fail': '失败', + 'hint': '建议', + 'job_id': '任务 ID', + 'name': '动作名称', + 'operation': '操作标签', + 'outcome': '结果', + 'service': '服务反馈', + 'success': '成功', + 'summary': '摘要', +} + +ACTION_CONSEQUENCE_TEXTS = { + 'external': '确认后会暂时挂起 TUI,并在当前终端中执行对应命令;命令结束后自动返回工作台。', + 'preview': '确认后会立即执行对应 CLI 低风险命令,并按结果刷新当前页面。', + 'wizard': '确认后会暂时挂起 TUI,并在当前终端中打开对应向导;向导结束后自动返回工作台。', +} + +APP_BINDING_LABELS = { + 'next': '下一页', + 'previous': '上一页', + 'quit': '退出', + 'refresh': '刷新', + 'sidebar': '侧边栏', +} + +INTERNAL_BINDING_LABELS = { + 'action_global': '同步动作', + 'action_primary': '执行动作', + 'action_secondary': '切换状态', + 'action_utility': '工具动作', + 'clear_search': '清空搜索', + 'confirm_cancel': '取消', + 'confirm_submit': '确认', + 'end': '跳到末尾', + 'filter_1': '筛选项 1', + 'filter_2': '筛选项 2', + 'filter_3': '筛选项 3', + 'filter_4': '筛选项 4', + 'focus_left': '向左聚焦', + 'focus_right': '向右聚焦', + 'home': '回到顶部', + 'page_down': '下翻页', + 'page_up': '上翻页', + 'scroll_down': '向下滚动', + 'scroll_up': '向上滚动', + 'search': '页内搜索', +} + +BROWSER_EMPTY_RECORD_COPY = { + 'detail': '当前页面没有可浏览记录', + 'label': '记录列表', + 'summary': '当前页面没有可浏览记录', + 'title': '暂无记录数据', + 'value': '暂无数据', +} + +BROWSER_LOADING_COPY = { + 'detail': '正在后台加载当前记录详情,请稍候', + 'label': '详情状态', + 'title': '详情加载中', + 'value': '加载中', +} + +DETAIL_EMPTY_SECTION_COPY = { + 'detail_page': '当前页面没有可展示的分区详情', + 'detail_record': '当前记录没有可展示的分区详情', + 'label': '分区详情', + 'title': '暂无分区数据', + 'value': '暂无内容', +} + +CAPABILITY_LABELS = { + 'app_run': ACTION_LABELS['app_run'], + 'app_run_wizard': ACTION_LABELS['app_run_wizard'], + 'cache_clear_wizard': ACTION_LABELS['cache_clear_wizard'], + 'cache_warmup': ACTION_LABELS['cache_warmup'], + 'completion_install': ACTION_LABELS['completion_install'], + 'config_sync': ACTION_LABELS['config_sync'], + 'crypto_keygen': ACTION_LABELS['crypto_keygen'], + 'crypto_rotate_dry_run': ACTION_LABELS['crypto_rotate_dry_run'], + 'db_init_dry_run': ACTION_LABELS['db_init_dry_run'], + 'db_upgrade_wizard': ACTION_LABELS['db_upgrade_wizard'], + 'gen_export_dry_run': ACTION_LABELS['gen_export_dry_run'], + 'gen_export_wizard': ACTION_LABELS['gen_export_wizard'], + 'gen_import_wizard': ACTION_LABELS['gen_import_wizard'], + 'gen_sync_db': ACTION_LABELS['gen_sync_db'], + 'job_run_once': ACTION_LABELS['job_run_once'], + 'job_toggle': '暂停/恢复任务', + 'job_sync': ACTION_LABELS['job_sync'], + 'ops_ping_db': ACTION_LABELS['ops_ping_db'], + 'ops_ping_redis': ACTION_LABELS['ops_ping_redis'], + 'prod_check_wizard': ACTION_LABELS['prod_check_wizard'], +} + +CAPABILITY_HINT_LABELS = { + 'app_run': '直接启动', + 'app_run_wizard': '打开启动向导', + 'cache_clear_wizard': '清理向导', + 'cache_warmup': '执行缓存预热', + 'completion_install': '安装补全', + 'config_sync': '刷新参数缓存', + 'crypto_keygen': '密钥生成', + 'crypto_rotate_dry_run': '执行轮换预演', + 'db_init_dry_run': '初始化预演', + 'db_upgrade_wizard': '打开升级向导', + 'gen_export_dry_run': '导出预演', + 'gen_export_wizard': '导出向导', + 'gen_import_wizard': '导入向导', + 'gen_sync_db': '同步表结构', + 'job_run_once': '执行一次', + 'job_toggle': '暂停/恢复', + 'job_sync': '同步调度', + 'ops_ping_db': '数据库探活', + 'ops_ping_redis': 'Redis 探活', + 'prod_check_wizard': '打开生产巡检向导', +} + +WORKSPACE_LABELS = { + 'current_section': '当前分区', + 'menu': '菜单', + 'overview': '概览', + 'record': '记录', + 'section': '分区', + 'shortcut': '快捷键', + 'status': '状态', +} + +WORKSPACE_TITLES = { + 'action_feedback': '【执行反馈】', + 'detail_content': '详情内容', + 'key_fields': '【关键字段】', + 'key_info': '【关键信息】', +} + +WORKSPACE_EMPTY_TEXTS = { + 'actions': '暂无可执行动作', + 'detail': '暂无详情', + 'key_info': '暂无关键信息', +} + +STATE_SECTION_TITLES = { + 'detail': '## 补充说明', + 'diagnostic': '## 诊断线索', + 'error': '## 错误摘要', + 'status': '## 当前状态', + 'suggestion': '## 下一步', +} + +ACTION_NOTIFICATION_COPY = { + 'empty_line': '当前记录没有可执行的低风险动作', + 'title': 'TUI 动作', + 'unavailable_message': '当前页面没有可执行的对应快捷动作', +} + +BROWSER_ACTION_PANEL_COPY = { + 'action_section_title': '## 可执行动作', + 'operation_section_title': '## 浏览操作', + 'recent_action_section_title': '## 最近动作反馈', +} + +COMMAND_HINT_TITLES = { + 'command': '## 推荐命令', + 'guide': '## 使用说明', + 'scenario': '## 适用场景', +} + +SIGNAL_RAIL_COPY = { + 'empty': '暂无实时信号', + 'title': '系统信号带', +} + +METRIC_COPY = { + 'hint_label': '说明', + 'label': '指标', + 'value_label': '数值', +} + +ACTION_HINT_COPY = { + 'browser_default': '当前页面以浏览为主。{interaction_hint}', + 'browser_templates': { + 'cache': '建议先核对 Redis 概览与键值样本,再决定预热或进入清理向导。{interaction_hint}', + 'configs': '建议先看高风险配置,再决定是否刷新参数缓存。{interaction_hint}', + 'gen': '建议先看生成前校验、同步预检查与代码预览,再决定是否进入导入向导、同步表结构或进入导出向导。{interaction_hint}', + 'jobs': '建议先看失败聚合,再决定执行一次、暂停恢复或同步调度。{interaction_hint}', + }, + 'detail_default': '当前页面以查看分区为主。{interaction_hint}', + 'detail_templates': { + 'app': '建议先确认环境映射、应用配置、启动前检查、补全诊断和路由状态,再决定是安装补全、直接启动应用还是进入启动向导。{interaction_hint}', + 'crypto': '建议先确认运行校验、公钥身份和兼容版本,再决定是否生成新密钥或执行轮换预演。{interaction_hint}', + 'database': '建议先确认 revision、Heads 和历史链路,再决定是否执行初始化预演或进入升级向导。{interaction_hint}', + 'ops': '建议先确认数据库探活、Redis 探活、依赖版本和服务器资源,再决定是否进入生产巡检。{interaction_hint}', + }, + 'operation_hint_lines': [ + '> [←/→] 切换焦点', + '> [J/K] 向上/向下滚动', + '> [PgUp/PgDn] 整页滚动', + '> [Home/End] 跳到首尾', + ], +} + +ACTION_FEEDBACK_COPY = { + 'toast_prefix': '动作结果', +} diff --git a/shierfeng-fastapi-backend/cli/tui/copy/navigation.py b/shierfeng-fastapi-backend/cli/tui/copy/navigation.py new file mode 100644 index 0000000..f335066 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/copy/navigation.py @@ -0,0 +1,133 @@ +from cli.tui.copy.fragments import ( + APP_BINDING_LABELS, + GENERAL_COPY, + INTERNAL_BINDING_LABELS, + NAVIGATION_DESCRIPTIONS, + STATUS_LABELS, + VIEW_LABELS, +) + + +class TuiNavigationCopyMixin: + """ + TUI 导航与基础标签文案混入。 + """ + + @staticmethod + def render_view_label(view_key: str) -> str: + """ + 将内部视图标识转换为中文显示名称。 + + :param view_key: 视图标识 + :return: 中文视图名称 + """ + normalized_view = str(view_key).strip().lower() + return VIEW_LABELS.get(normalized_view, view_key) + + @staticmethod + def render_status_label(status: str, fallback: str = '信息') -> str: + """ + 将状态值转换为中文显示文本。 + + :param status: 原始状态值 + :param fallback: 缺失时兜底文本 + :return: 中文状态文本 + """ + normalized_status = str(status).strip().lower() + if not normalized_status: + return fallback + return STATUS_LABELS.get(normalized_status, str(status).strip().upper()) + + @staticmethod + def render_status_code(status: str) -> str: + """ + 将状态值转换为控制台风格状态码。 + + :param status: 原始状态值 + :return: 状态码文本 + """ + normalized_status = str(status).strip().lower() + status_code_mapping = { + 'ok': 'SYS.OK', + 'success': 'SYS.OK', + 'healthy': 'SYS.OK', + 'fail': 'SYS.FAIL', + 'error': 'SYS.FAIL', + 'down': 'SYS.FAIL', + 'warn': 'SYS.WARN', + 'warning': 'SYS.WARN', + 'degraded': 'SYS.WARN', + 'info': 'SYS.INFO', + } + return status_code_mapping.get(normalized_status, f'SYS.{normalized_status.upper() or "INFO"}') + + @staticmethod + def render_navigation_description(view_key: str) -> str: + """ + 获取指定视图的导航说明。 + + :param view_key: 视图标识 + :return: 导航说明 + """ + normalized_view = str(view_key).strip().lower() + return NAVIGATION_DESCRIPTIONS.get(normalized_view, '') + + @staticmethod + def build_tui_command_help() -> str: + """ + 构建 `shierfeng tui` 命令帮助文案。 + + :return: 命令帮助文案 + """ + return GENERAL_COPY['tui_command_help'] + + @staticmethod + def build_missing_dependency_message() -> str: + """ + 构建 TUI 可选依赖缺失时的提示消息。 + + :return: 缺依赖提示消息 + """ + return GENERAL_COPY['tui_missing_dependency_message'] + + @staticmethod + def build_missing_dependency_hint() -> str: + """ + 构建 TUI 可选依赖缺失时的恢复建议。 + + :return: 恢复建议文案 + """ + return GENERAL_COPY['tui_missing_dependency_hint'] + + @staticmethod + def build_app_binding_label(binding_key: str) -> str: + """ + 根据绑定标识构建应用级快捷键标签文案。 + + :param binding_key: 绑定标识 + :return: 快捷键标签文案 + """ + normalized_key = str(binding_key).strip().lower() + return APP_BINDING_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_confirm_binding_label(binding_key: str) -> str: + """ + 根据确认弹窗绑定标识构建快捷键标签文案。 + + :param binding_key: 绑定标识 + :return: 快捷键标签文案 + """ + normalized_key = str(binding_key).strip().lower() + return INTERNAL_BINDING_LABELS.get(f'confirm_{normalized_key}', normalized_key) + + @staticmethod + def build_internal_binding_label(binding_key: str) -> str: + """ + 根据内部交互绑定标识构建快捷键标签文案。 + + :param binding_key: 绑定标识 + :return: 快捷键标签文案 + """ + normalized_key = str(binding_key).strip().lower() + return INTERNAL_BINDING_LABELS.get(normalized_key, normalized_key) diff --git a/shierfeng-fastapi-backend/cli/tui/copy/workspace.py b/shierfeng-fastapi-backend/cli/tui/copy/workspace.py new file mode 100644 index 0000000..e4f0ff1 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/copy/workspace.py @@ -0,0 +1,593 @@ +from cli.tui.copy.fragments import ( + ACTION_HINT_COPY, + BROWSER_ACTION_PANEL_COPY, + BROWSER_EMPTY_RECORD_COPY, + BROWSER_LOADING_COPY, + DASHBOARD_HERO_COPY, + DETAIL_EMPTY_SECTION_COPY, + GENERAL_COPY, + METRIC_COPY, + SIGNAL_RAIL_COPY, + STATE_SECTION_TITLES, + STATE_SUGGESTIONS, + STATUS_PANEL_COPY, + WORKSPACE_EMPTY_TEXTS, + WORKSPACE_LABELS, + WORKSPACE_TITLES, +) + + +class TuiWorkspaceCopyMixin: + """ + TUI 工作区与状态文案混入。 + """ + + @staticmethod + def build_workspace_label(label_key: str) -> str: + """ + 根据工作台标签标识构建文案。 + + :param label_key: 标签标识 + :return: 标签文案 + """ + normalized_key = str(label_key).strip().lower() + return WORKSPACE_LABELS.get(normalized_key, normalized_key) + + @staticmethod + def build_workspace_title(title_key: str) -> str: + """ + 根据工作台标题标识构建文案。 + + :param title_key: 标题标识 + :return: 标题文案 + """ + normalized_key = str(title_key).strip().lower() + return WORKSPACE_TITLES.get(normalized_key, normalized_key) + + @staticmethod + def build_workspace_empty_text(text_key: str) -> str: + """ + 根据工作台空态标识构建文案。 + + :param text_key: 空态标识 + :return: 空态文案 + """ + normalized_key = str(text_key).strip().lower() + return WORKSPACE_EMPTY_TEXTS.get(normalized_key, normalized_key) + + @staticmethod + def build_status_panel_empty_text() -> str: + """ + 构建状态面板空态提示文案。 + + :return: 空态提示文案 + """ + return STATUS_PANEL_COPY['empty'] + + @staticmethod + def build_signal_rail_empty_text() -> str: + """ + 构建信号带空态提示文案。 + + :return: 空态提示文案 + """ + return SIGNAL_RAIL_COPY['empty'] + + @staticmethod + def build_more_detail_hint() -> str: + """ + 构建查看更多提示文案。 + + :return: 提示文案 + """ + return GENERAL_COPY['more_detail_hint'] + + @staticmethod + def build_empty_state_suggestion() -> str: + """ + 构建通用空态建议文案。 + + :return: 建议文案 + """ + return STATE_SUGGESTIONS['empty'] + + @staticmethod + def build_loading_state_suggestion() -> str: + """ + 构建通用加载态建议文案。 + + :return: 建议文案 + """ + return STATE_SUGGESTIONS['loading'] + + @staticmethod + def build_failure_state_suggestion() -> str: + """ + 构建通用失败态建议文案。 + + :return: 建议文案 + """ + return STATE_SUGGESTIONS['failure'] + + @staticmethod + def build_dashboard_failure_suggestion() -> str: + """ + 构建首页失败态建议文案。 + + :return: 建议文案 + """ + return STATE_SUGGESTIONS['dashboard_failure'] + + @staticmethod + def build_dashboard_empty_suggestion() -> str: + """ + 构建首页空态建议文案。 + + :return: 建议文案 + """ + return STATE_SUGGESTIONS['dashboard_empty'] + + @staticmethod + def build_state_section_title(title_key: str) -> str: + """ + 根据状态区块标识构建标题文案。 + + :param title_key: 区块标识 + :return: 标题文案 + """ + normalized_key = str(title_key).strip().lower() + return STATE_SECTION_TITLES.get(normalized_key, normalized_key) + + @staticmethod + def build_dashboard_hero_title() -> str: + """ + 构建首页 Hero 标题文案。 + + :return: 标题文案 + """ + return DASHBOARD_HERO_COPY['title'] + + @staticmethod + def build_dashboard_hero_subtitle() -> str: + """ + 构建首页 Hero 副标题文案。 + + :return: 副标题文案 + """ + return DASHBOARD_HERO_COPY['subtitle'] + + @staticmethod + def build_browser_empty_record_copy(field_key: str) -> str: + """ + 根据字段标识构建浏览页空记录文案。 + + :param field_key: 字段标识 + :return: 文案 + """ + normalized_key = str(field_key).strip().lower() + return BROWSER_EMPTY_RECORD_COPY.get(normalized_key, normalized_key) + + @staticmethod + def build_browser_loading_copy(field_key: str) -> str: + """ + 根据字段标识构建浏览页加载占位文案。 + + :param field_key: 字段标识 + :return: 文案 + """ + normalized_key = str(field_key).strip().lower() + return BROWSER_LOADING_COPY.get(normalized_key, normalized_key) + + @staticmethod + def build_detail_empty_section_copy(field_key: str) -> str: + """ + 根据字段标识构建详情页空态文案。 + + :param field_key: 字段标识 + :return: 文案 + """ + normalized_key = str(field_key).strip().lower() + return DETAIL_EMPTY_SECTION_COPY.get(normalized_key, normalized_key) + + @staticmethod + def build_refresh_page_suggestion(page_name: str, detail: str) -> str: + """ + 构建详情页场景下的统一建议操作文案。 + + :param page_name: 页面名称 + :param detail: 后续动作描述 + :return: 建议文案 + """ + return f'可按 [R] 刷新,或进入{page_name}页面{detail}' + + @staticmethod + def build_dashboard_page_suggestion(page_name: str, detail: str) -> str: + """ + 构建首页总览面板场景下的统一建议操作文案。 + + :param page_name: 页面名称 + :param detail: 后续动作描述 + :return: 建议文案 + """ + return f'按 [R] 刷新,或进入{page_name}页面{detail}' + + @staticmethod + def build_unavailable_record_title(resource_name: str) -> str: + """ + 构建浏览页失败兜底记录标题。 + + :param resource_name: 资源名称 + :return: 标题文本 + """ + return f'{resource_name}数据暂不可用' + + @staticmethod + def build_load_failure_section_title(resource_name: str) -> str: + """ + 构建浏览页失败兜底分区标题。 + + :param resource_name: 资源名称 + :return: 分区标题 + """ + return f'{resource_name}加载失败' + + @staticmethod + def build_empty_record_title(resource_name: str) -> str: + """ + 构建浏览页空记录标题。 + + :param resource_name: 资源名称 + :return: 标题文本 + """ + return f'暂无{resource_name}' + + @staticmethod + def build_unavailable_subtitle(resource_name: str, message: str) -> str: + """ + 构建浏览页数据不可用副标题。 + + :param resource_name: 资源名称 + :param message: 错误摘要 + :return: 副标题文本 + """ + return f'{resource_name}数据不可用:{message}' + + @staticmethod + def build_empty_record_summary(detail: str) -> str: + """ + 构建浏览页空记录摘要。 + + :param detail: 摘要说明 + :return: 摘要文本 + """ + return detail + + @staticmethod + def build_loaded_collection_subtitle(count: int, unit: str, detail: str) -> str: + """ + 构建浏览页“已加载”副标题。 + + :param count: 数量 + :param unit: 单位 + :param detail: 补充说明 + :return: 副标题文本 + """ + return f'已加载 {count} {unit},{detail}' + + @staticmethod + def build_summary_with_message(summary: str, message: str) -> str: + """ + 构建带结果摘要补充的副标题。 + + :param summary: 主摘要 + :param message: 结果消息 + :return: 副标题文本 + """ + return f'{summary} | {message}' + + @staticmethod + def build_count_detail_subtitle(prefix: str, count: int, unit: str, suffix: str) -> str: + """ + 构建带数量的详情页副标题。 + + :param prefix: 前缀文本 + :param count: 数量 + :param unit: 数量单位 + :param suffix: 后缀文本 + :return: 副标题文本 + """ + return f'{prefix} {count} {unit}{suffix}' + + @staticmethod + def build_value_detail_subtitle(prefix: str, value: str, suffix: str) -> str: + """ + 构建带单值信息的详情页副标题。 + + :param prefix: 前缀文本 + :param value: 值文本 + :param suffix: 后缀文本 + :return: 副标题文本 + """ + return f'{prefix} {value}{suffix}' + + @staticmethod + def build_workspace_hero_lines( + *, + view_label: str, + title: str, + subtitle: str, + env: str, + summary: str, + refreshed_at: str, + shortcut_hint: str, + ) -> list[str]: + """ + 构建工作区顶部摘要文本行。 + + :param view_label: 当前页面显示名称 + :param title: 页面标题 + :param subtitle: 页面副标题 + :param env: 当前环境 + :param summary: 页面摘要 + :param refreshed_at: 刷新时间 + :param shortcut_hint: 快捷键提示 + :return: 文本行列表 + """ + return [ + f'[{view_label} 控制台]', + title, + subtitle, + '', + f'运行环境 · {env}', + f'当前页面 · {view_label}', + f'运行摘要 · {summary}', + f'操作提示 · {shortcut_hint}', + f'最近刷新 · {refreshed_at}', + ] + + @staticmethod + def build_navigation_item_lines(index: int, label: str, shortcut: str, description: str) -> list[str]: + """ + 构建左侧导航项文案。 + + :param index: 导航索引 + :param label: 导航标题 + :param shortcut: 快捷键 + :param description: 导航说明 + :return: 文本行列表 + """ + return [ + f'▌ {WORKSPACE_LABELS["menu"]} {index + 1:02d} · {label}', + f'│ {WORKSPACE_LABELS["shortcut"]} [{shortcut.upper()}] · {description}', + ] + + @staticmethod + def build_section_item_lines(index: int, title: str, status_badge: str, preview: str) -> list[str]: + """ + 构建详情页分区导航项文案。 + + :param index: 分区索引 + :param title: 分区标题 + :param status_badge: 状态徽标 + :param preview: 预览文本 + :return: 文本行列表 + """ + return [ + f'▌ {WORKSPACE_LABELS["section"]} {index + 1:02d} · {title}', + f'│ {status_badge} {preview}', + ] + + @staticmethod + def build_record_item_lines(index: int, title: str, status_badge: str, summary: str) -> list[str]: + """ + 构建浏览页记录导航项文案。 + + :param index: 记录索引 + :param title: 记录标题 + :param status_badge: 状态徽标 + :param summary: 记录摘要 + :return: 文本行列表 + """ + return [ + f'▌ {WORKSPACE_LABELS["record"]} {index + 1:02d} · {title}', + f'│ {status_badge} {summary}', + ] + + @staticmethod + def build_section_detail_lines(title: str, status_label: str, status_badge: str, body: str) -> list[str]: + """ + 构建详情页右侧分区内容文案。 + + :param title: 分区标题 + :param status_label: 分区状态 + :param status_badge: 状态徽标 + :param body: 主体文本 + :return: 文本行列表 + """ + return [ + f'{status_badge} {title}', + f'{WORKSPACE_LABELS["status"]} · {status_label}', + '', + body, + ] + + @staticmethod + def build_browser_action_panel_lines(action_lines: list[str], feedback_lines: list[str]) -> list[str]: + """ + 构建浏览页动作面板文案。 + + :param action_lines: 可执行动作文本 + :param feedback_lines: 最近动作反馈文本 + :return: 文本行列表 + """ + lines = [ + BROWSER_ACTION_PANEL_COPY['action_section_title'], + *[f'> {line}' for line in action_lines], + '', + BROWSER_ACTION_PANEL_COPY['operation_section_title'], + ] + lines.extend(ACTION_HINT_COPY['operation_hint_lines']) + if feedback_lines: + lines.extend( + [ + '', + BROWSER_ACTION_PANEL_COPY['recent_action_section_title'], + *[f'> {line}' for line in feedback_lines], + ] + ) + return lines + + @staticmethod + def build_status_panel_text(title: str, status_code: str, status_label: str, body: str) -> str: + """ + 构建状态面板渲染文本。 + + :param title: 面板标题 + :param status_code: 状态码 + :param status_label: 状态标签 + :param body: 面板正文 + :return: 渲染文本 + """ + return f'{status_code} {title}\n{WORKSPACE_LABELS["status"]} · {status_label}\n\n{body}' + + @staticmethod + def build_metric_panel_text(title: str, value: str, status_code: str, status_label: str, hint: str) -> str: + """ + 构建指标卡渲染文本。 + + :param title: 指标标题 + :param value: 指标值 + :param status_code: 状态码 + :param status_label: 状态标签 + :param hint: 提示文本 + :return: 渲染文本 + """ + return ( + f'{METRIC_COPY["label"]} · {title}\n' + f'────────────────────────\n' + f'{METRIC_COPY["value_label"]} · {value}\n' + f'{WORKSPACE_LABELS["status"]} · {status_code} / {status_label}\n' + f'{METRIC_COPY["hint_label"]} · {hint}' + ) + + @staticmethod + def build_signal_rail_text(pulse: str, body: str) -> str: + """ + 构建首页信号带渲染文本。 + + :param pulse: 当前脉冲字符 + :param body: 主体文本 + :return: 渲染文本 + """ + return '\n'.join( + [ + f'{SIGNAL_RAIL_COPY["title"]} {pulse}', + '────────────────────────', + body or SIGNAL_RAIL_COPY['empty'], + ] + ) + + @staticmethod + def build_workspace_header_lines( + *, + env: str, + view_label: str, + timestamp: str, + shortcut_hint: str, + ) -> list[str]: + """ + 构建工作区顶部状态栏文本行。 + + :param env: 当前环境 + :param view_label: 当前页面显示名称 + :param timestamp: 当前时间 + :param shortcut_hint: 快捷键提示 + :return: 文本行列表 + """ + return [ + f'ShiErFeng 控制台 · 环境 {env.upper()} · 页面 {view_label}', + f'快捷键 · {shortcut_hint} 时间 {timestamp}', + ] + + @staticmethod + def build_dashboard_signal_lines( + *, + status_track: str, + fail_count: int, + warn_count: int, + ok_count: int, + total_count: int, + navigation_shortcut_hint: str, + ) -> list[str]: + """ + 构建首页信号带文案。 + + :param status_track: 面板状态轨迹 + :param fail_count: 失败数量 + :param warn_count: 警告数量 + :param ok_count: 正常数量 + :param total_count: 总数量 + :param navigation_shortcut_hint: 页面快捷键提示 + :return: 文本行列表 + """ + return [ + f'面板轨迹 · {status_track or "-"}', + f'风险分布 · 失败 {fail_count:02d} 警告 {warn_count:02d} 正常 {ok_count:02d} 合计 {total_count:02d}', + f'快捷入口 · 页面 {navigation_shortcut_hint}', + ] + + @staticmethod + def build_dashboard_summary_text(total_count: int, ok_count: int, warn_count: int, fail_count: int) -> str: + """ + 构建首页摘要文本。 + + :param total_count: 面板总数 + :param ok_count: 正常数量 + :param warn_count: 警告数量 + :param fail_count: 失败数量 + :return: 摘要文本 + """ + posture = '存在风险' if fail_count else '需要关注' if warn_count else '运行稳定' + return ( + f'当前态势:{posture}。共 {total_count} 个面板,正常 {ok_count} 个,' + f'警告 {warn_count} 个,失败 {fail_count} 个。' + ) + + @staticmethod + def build_detail_summary_text(total_count: int, ok_count: int, warn_count: int, fail_count: int) -> str: + """ + 构建详情页摘要文本。 + + :param total_count: 分区总数 + :param ok_count: 正常数量 + :param warn_count: 警告数量 + :param fail_count: 失败数量 + :return: 摘要文本 + """ + return ( + f'当前页共 {total_count} 个分区,正常 {ok_count} 个,警告 {warn_count} 个,失败 {fail_count} 个。' + '左侧上下切页,左右切换当前焦点区域。' + ) + + @staticmethod + def build_browser_summary_text( + total_count: int, + ok_count: int, + warn_count: int, + fail_count: int, + action_hint: str, + ) -> str: + """ + 构建浏览页摘要文本。 + + :param total_count: 记录总数 + :param ok_count: 正常数量 + :param warn_count: 警告数量 + :param fail_count: 失败数量 + :param action_hint: 动作提示文案 + :return: 摘要文本 + """ + return ( + f'当前页共 {total_count} 条记录,正常 {ok_count} 条,警告 {warn_count} 条,失败 {fail_count} 条。' + f'切换记录后,右侧会联动展示概览与分区详情。{action_hint}' + ) diff --git a/shierfeng-fastapi-backend/cli/tui/diagnostics.py b/shierfeng-fastapi-backend/cli/tui/diagnostics.py new file mode 100644 index 0000000..05f8b3d --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/diagnostics.py @@ -0,0 +1,581 @@ +from collections.abc import Callable +from dataclasses import dataclass +from typing import Any + +from cli.utils import SHELL_TEXT_FORMATTER + + +@dataclass(frozen=True) +class DiagnosticPagePolicy: + """ + TUI 页面诊断策略定义。 + + :param focus_terms: 页面聚焦词 + :param subtitle_builder: 页面摘要构建函数 + """ + + focus_terms: tuple[str, ...] + subtitle_builder: Callable[..., str] + + +@dataclass(frozen=True) +class DiagnosticPagePolicyRegistry: + """ + TUI 页面诊断策略注册表。 + + :param policies: 页面诊断策略映射 + """ + + policies: dict[str, DiagnosticPagePolicy] + + def get(self, page_key: str) -> DiagnosticPagePolicy: + """ + 读取指定页面诊断策略。 + + :param page_key: 页面标识 + :return: 页面诊断策略 + :raises KeyError: 页面未注册时抛出异常 + """ + return self.policies[page_key] + + +class TuiDiagnosticService: + """ + 统一封装 TUI 页面诊断提示与摘要拼装逻辑。 + + 该服务通过页面级诊断策略注册表管理各页面的聚焦词和 subtitle 规则, + 供 adapter、dashboard 等对象复用。 + + :param page_policy_registry: 页面诊断策略注册表 + """ + + def __init__(self, page_policy_registry: DiagnosticPagePolicyRegistry) -> None: + """ + 初始化诊断服务。 + + :param page_policy_registry: 页面诊断策略注册表 + :return: None + """ + self.page_policy_registry = page_policy_registry + + @staticmethod + def build_focus_hint(terms: tuple[str, ...]) -> str: + """ + 将诊断聚焦词渲染为统一提示文本。 + + :param terms: 聚焦词元组 + :return: 提示文本 + """ + return f'聚焦:{" / ".join(terms)}' + + def build_page_focus_hint(self, page_key: str) -> str: + """ + 构建指定页面统一聚焦词。 + + :param page_key: 页面标识 + :return: 聚焦提示 + """ + return self.build_focus_hint(self.page_policy_registry.get(page_key).focus_terms) + + def build_database_focus_hint(self) -> str: + """ + 构建数据库页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('database') + + def build_ops_focus_hint(self) -> str: + """ + 构建运维页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('ops') + + def build_cache_focus_hint(self) -> str: + """ + 构建缓存页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('cache') + + def build_app_focus_hint(self) -> str: + """ + 构建应用页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('app') + + def build_jobs_focus_hint(self) -> str: + """ + 构建任务页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('jobs') + + def build_configs_focus_hint(self) -> str: + """ + 构建参数配置页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('configs') + + def build_gen_focus_hint(self) -> str: + """ + 构建代码生成页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('gen') + + def build_crypto_focus_hint(self) -> str: + """ + 构建加密页统一聚焦词。 + + :return: 聚焦提示 + """ + return self.build_page_focus_hint('crypto') + + @staticmethod + def _build_app_subtitle( + env_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + routes_payload: dict[str, Any] | None, + completion_payload: dict[str, Any] | None, + *, + focus_hint: str, + ) -> str: + """ + 构建应用页诊断摘要。 + + :param env_payload: `app env` 结果 + :param config_payload: `app config` 结果 + :param doctor_payload: `app doctor` 结果 + :param routes_payload: `app routes` 结果 + :param completion_payload: `completion doctor` 结果 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + env_ok = bool(isinstance(env_payload, dict) and env_payload.get('ok', False)) + config_ok = bool(isinstance(config_payload, dict) and config_payload.get('ok', False)) + doctor_ok = bool(isinstance(doctor_payload, dict) and doctor_payload.get('ok', False)) + routes_ok = bool(isinstance(routes_payload, dict) and routes_payload.get('ok', False)) + completion_ok = bool(isinstance(completion_payload, dict) and completion_payload.get('ok', False)) + route_count = routes_payload.get('count', 0) if isinstance(routes_payload, dict) else 0 + + if not env_ok or not config_ok: + return f'{focus_hint} | 应用基础信息读取异常,优先确认环境映射与配置摘要' + if not doctor_ok: + return f'{focus_hint} | 启动前检查异常,优先确认数据库、Redis 与加密组件状态' + if not completion_ok: + return f'{focus_hint} | 补全诊断读取异常,优先确认项目目录与 shell 补全配置' + if not routes_ok: + return f'{focus_hint} | 路由摘要读取异常,优先确认应用初始化与路由注册状态' + return ( + f'{focus_hint} | 当前已加载 {route_count} 条注册路由,' + '可继续查看环境映射、配置摘要、启动前检查、补全诊断与路由状态' + ) + + @staticmethod + def _build_database_subtitle( + revision_payload: dict[str, Any] | None, + check_payload: dict[str, Any] | None, + heads_payload: dict[str, Any] | None, + *, + focus_hint: str, + ) -> str: + """ + 构建数据库页诊断摘要。 + + :param revision_payload: `db current` 结果 + :param check_payload: `db check` 结果 + :param heads_payload: `db heads` 结果 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + revision = revision_payload.get('currentRevision', '-') if isinstance(revision_payload, dict) else '-' + revision_text = SHELL_TEXT_FORMATTER.truncate_text(str(revision or '-'), 48) + revision_ok = bool(isinstance(revision_payload, dict) and revision_payload.get('ok', False)) + check_ok = bool(isinstance(check_payload, dict) and check_payload.get('ok', False)) + heads_ok = bool(isinstance(heads_payload, dict) and heads_payload.get('ok', False)) + heads_items = heads_payload.get('items') if isinstance(heads_payload, dict) else None + heads_count = len(heads_items) if isinstance(heads_items, list) else 0 + + if not revision_ok or not check_ok: + return f'{focus_hint} | 数据库异常,优先确认迁移版本、连接状态与 heads 信息' + if not heads_ok or heads_count != 1: + return f'{focus_hint} | 数据库存在迁移分叉风险,优先确认 heads 和历史版本' + return f'{focus_hint} | 数据库基线正常,当前 revision {revision_text},可继续查看连接、heads 和历史版本' + + @staticmethod + def _build_ops_subtitle( + health_payload: dict[str, Any] | None, + deps_payload: dict[str, Any] | None, + server_payload: dict[str, Any] | None, + *, + focus_hint: str, + ) -> str: + """ + 构建运维页诊断摘要。 + + :param health_payload: `ops health` 结果 + :param deps_payload: `ops deps` 结果 + :param server_payload: `ops server-info` 结果 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + health_ok = bool(isinstance(health_payload, dict) and health_payload.get('ok', False)) + deps_ok = bool(isinstance(deps_payload, dict) and deps_payload.get('ok', False)) + server_ok = bool(isinstance(server_payload, dict) and server_payload.get('ok', False)) + + if not health_ok: + return f'{focus_hint} | 运维探活存在异常,优先核对数据库/Redis 连通性与依赖版本' + if not deps_ok: + return f'{focus_hint} | 运维依赖存在异常,优先核对缺失依赖与版本兼容性' + if not server_ok: + return f'{focus_hint} | 服务器信息采集异常,优先重新检查主机资源与运行环境' + return f'{focus_hint} | 基础探活和依赖状态正常,可继续查看服务器资源与磁盘样本' + + @staticmethod + def _build_cache_subtitle( + stats_payload: dict[str, Any] | None, + matched_count: int, + *, + focus_hint: str, + ) -> str: + """ + 构建缓存页诊断摘要。 + + :param stats_payload: `cache stats` 结果 + :param matched_count: 当前筛选后缓存名数量 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + db_size = stats_payload.get('dbSize', '-') if isinstance(stats_payload, dict) else '-' + client_count = '-' + if isinstance(stats_payload, dict) and isinstance(stats_payload.get('info'), dict): + client_count = stats_payload['info'].get('connected_clients', '-') # type: ignore[index] + return ( + f'{focus_hint} | 缓存基线正常,当前已加载 {matched_count} 个缓存名,' + f'Redis 键数 {db_size},连接数 {client_count},可继续查看键列表、键值样本和 TTL' + ) + + @staticmethod + def _build_jobs_subtitle( + filter_label: str, + matched_count: int, + failed_job_names: set[str], + paused_count: int, + *, + focus_hint: str, + ) -> str: + """ + 构建任务页诊断摘要。 + + :param filter_label: 当前筛选标签 + :param matched_count: 当前匹配任务数 + :param failed_job_names: 最近失败任务集合 + :param paused_count: 暂停任务数量 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + if failed_job_names: + return ( + f'{focus_hint} | 当前筛选:{filter_label},已匹配 {matched_count} 条任务,' + f'失败任务 {len(failed_job_names)} 个,暂停任务 {paused_count} 个' + ) + return ( + f'{focus_hint} | 当前筛选:{filter_label},已匹配 {matched_count} 条任务,' + f'当前没有失败任务,暂停任务 {paused_count} 个' + ) + + @staticmethod + def _build_configs_subtitle( + filter_label: str, + matched_count: int, + mismatch_count: int, + drift_count: int, + *, + focus_hint: str, + ) -> str: + """ + 构建参数配置页诊断摘要。 + + :param filter_label: 当前筛选标签 + :param matched_count: 当前匹配配置数 + :param mismatch_count: 值不一致数量 + :param drift_count: 缓存漂移数量 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + return ( + f'{focus_hint} | 当前筛选:{filter_label},已匹配 {matched_count} 项配置,' + f'值不一致 {mismatch_count} 项,缓存漂移 {drift_count} 项' + ) + + @staticmethod + def _build_gen_subtitle( + matched_count: int, + importable_count: int, + *, + focus_hint: str, + ) -> str: + """ + 构建代码生成页诊断摘要。 + + :param matched_count: 当前匹配业务表数 + :param importable_count: 可导入物理表数 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + return ( + f'{focus_hint} | 当前已匹配 {matched_count} 张业务表,' + f'可导入物理表 {importable_count} 张,可继续查看表定义、预检查和代码预览' + ) + + @staticmethod + def _build_crypto_subtitle( + validate_payload: dict[str, Any] | None, + public_payload: dict[str, Any] | None, + *, + focus_hint: str, + ) -> str: + """ + 构建加密页诊断摘要。 + + :param validate_payload: `crypto validate` 结果 + :param public_payload: `crypto export-public` 结果 + :param focus_hint: 聚焦提示 + :return: 页面摘要 + """ + validate_ok = bool(isinstance(validate_payload, dict) and validate_payload.get('ok', False)) + public_ok = bool(isinstance(public_payload, dict) and public_payload.get('ok', False)) + public_key_payload = public_payload.get('publicKey') if isinstance(public_payload, dict) else None + current_kid = public_key_payload.get('kid', '-') if isinstance(public_key_payload, dict) else '-' + supported_kids = public_key_payload.get('supportedKids') if isinstance(public_key_payload, dict) else None + supported_count = len(supported_kids) if isinstance(supported_kids, list) else 0 + + if not validate_ok: + return f'{focus_hint} | 运行校验失败,优先确认传输加密配置与环境变量' + if not public_ok or not isinstance(public_key_payload, dict): + return f'{focus_hint} | 公钥导出结果异常,优先确认当前 KID 与公钥内容' + return ( + f'{focus_hint} | 当前 KID {current_kid},兼容版本 {supported_count} 个,' + '可继续查看公钥身份、兼容版本与轮换预演入口' + ) + + def build_app_diagnostic_subtitle( + self, + env_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + routes_payload: dict[str, Any] | None, + completion_payload: dict[str, Any] | None, + ) -> str: + """ + 构建应用页统一诊断摘要。 + + :param env_payload: `app env` 结果 + :param config_payload: `app config` 结果 + :param doctor_payload: `app doctor` 结果 + :param routes_payload: `app routes` 结果 + :param completion_payload: `completion doctor` 结果 + :return: 页面摘要 + """ + return self.page_policy_registry.get('app').subtitle_builder( + env_payload, + config_payload, + doctor_payload, + routes_payload, + completion_payload, + focus_hint=self.build_app_focus_hint(), + ) + + def build_database_diagnostic_subtitle( + self, + revision_payload: dict[str, Any] | None, + check_payload: dict[str, Any] | None, + heads_payload: dict[str, Any] | None, + ) -> str: + """ + 构建数据库页统一诊断摘要。 + + :param revision_payload: `db current` 结果 + :param check_payload: `db check` 结果 + :param heads_payload: `db heads` 结果 + :return: 页面摘要 + """ + return self.page_policy_registry.get('database').subtitle_builder( + revision_payload, + check_payload, + heads_payload, + focus_hint=self.build_database_focus_hint(), + ) + + def build_ops_diagnostic_subtitle( + self, + health_payload: dict[str, Any] | None, + deps_payload: dict[str, Any] | None, + server_payload: dict[str, Any] | None, + ) -> str: + """ + 构建运维页统一诊断摘要。 + + :param health_payload: `ops health` 结果 + :param deps_payload: `ops deps` 结果 + :param server_payload: `ops server-info` 结果 + :return: 页面摘要 + """ + return self.page_policy_registry.get('ops').subtitle_builder( + health_payload, + deps_payload, + server_payload, + focus_hint=self.build_ops_focus_hint(), + ) + + def build_cache_diagnostic_subtitle( + self, + stats_payload: dict[str, Any] | None, + matched_count: int, + ) -> str: + """ + 构建缓存页统一诊断摘要。 + + :param stats_payload: `cache stats` 结果 + :param matched_count: 当前筛选后缓存名数量 + :return: 页面摘要 + """ + return self.page_policy_registry.get('cache').subtitle_builder( + stats_payload, + matched_count, + focus_hint=self.build_cache_focus_hint(), + ) + + def build_jobs_diagnostic_subtitle( + self, + filter_label: str, + matched_count: int, + failed_job_names: set[str], + paused_count: int, + ) -> str: + """ + 构建任务页统一诊断摘要。 + + :param filter_label: 当前筛选标签 + :param matched_count: 当前匹配任务数 + :param failed_job_names: 最近失败任务集合 + :param paused_count: 暂停任务数量 + :return: 页面摘要 + """ + return self.page_policy_registry.get('jobs').subtitle_builder( + filter_label, + matched_count, + failed_job_names, + paused_count, + focus_hint=self.build_jobs_focus_hint(), + ) + + def build_configs_diagnostic_subtitle( + self, + filter_label: str, + matched_count: int, + mismatch_count: int, + drift_count: int, + ) -> str: + """ + 构建参数配置页统一诊断摘要。 + + :param filter_label: 当前筛选标签 + :param matched_count: 当前匹配配置数 + :param mismatch_count: 值不一致数量 + :param drift_count: 缓存漂移数量 + :return: 页面摘要 + """ + return self.page_policy_registry.get('configs').subtitle_builder( + filter_label, + matched_count, + mismatch_count, + drift_count, + focus_hint=self.build_configs_focus_hint(), + ) + + def build_gen_diagnostic_subtitle( + self, + matched_count: int, + importable_count: int, + ) -> str: + """ + 构建代码生成页统一诊断摘要。 + + :param matched_count: 当前匹配业务表数 + :param importable_count: 可导入物理表数 + :return: 页面摘要 + """ + return self.page_policy_registry.get('gen').subtitle_builder( + matched_count, + importable_count, + focus_hint=self.build_gen_focus_hint(), + ) + + def build_crypto_diagnostic_subtitle( + self, + validate_payload: dict[str, Any] | None, + public_payload: dict[str, Any] | None, + ) -> str: + """ + 构建加密页统一诊断摘要。 + + :param validate_payload: `crypto validate` 结果 + :param public_payload: `crypto export-public` 结果 + :return: 页面摘要 + """ + return self.page_policy_registry.get('crypto').subtitle_builder( + validate_payload, + public_payload, + focus_hint=self.build_crypto_focus_hint(), + ) + + +TUI_DIAGNOSTIC_PAGE_POLICY_REGISTRY = DiagnosticPagePolicyRegistry( + policies={ + 'database': DiagnosticPagePolicy( + focus_terms=('迁移版本', '连接状态', 'Heads'), + subtitle_builder=TuiDiagnosticService._build_database_subtitle, + ), + 'ops': DiagnosticPagePolicy( + focus_terms=('数据库连通性', 'Redis 连通性', '依赖版本'), + subtitle_builder=TuiDiagnosticService._build_ops_subtitle, + ), + 'cache': DiagnosticPagePolicy( + focus_terms=('Redis 键数', '连接数', '缓存名前缀'), + subtitle_builder=TuiDiagnosticService._build_cache_subtitle, + ), + 'app': DiagnosticPagePolicy( + focus_terms=('环境映射', '配置摘要', '启动前检查'), + subtitle_builder=TuiDiagnosticService._build_app_subtitle, + ), + 'jobs': DiagnosticPagePolicy( + focus_terms=('失败聚合', '暂停任务', '执行轨迹'), + subtitle_builder=TuiDiagnosticService._build_jobs_subtitle, + ), + 'configs': DiagnosticPagePolicy( + focus_terms=('高风险配置', '值不一致', '缓存漂移'), + subtitle_builder=TuiDiagnosticService._build_configs_subtitle, + ), + 'gen': DiagnosticPagePolicy( + focus_terms=('生成前校验', '同步预检查', '代码预览'), + subtitle_builder=TuiDiagnosticService._build_gen_subtitle, + ), + 'crypto': DiagnosticPagePolicy( + focus_terms=('运行校验', '公钥身份', '兼容版本'), + subtitle_builder=TuiDiagnosticService._build_crypto_subtitle, + ), + } +) +TUI_DIAGNOSTIC_SERVICE = TuiDiagnosticService(TUI_DIAGNOSTIC_PAGE_POLICY_REGISTRY) diff --git a/shierfeng-fastapi-backend/cli/tui/keymaps.py b/shierfeng-fastapi-backend/cli/tui/keymaps.py new file mode 100644 index 0000000..e8392c1 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/keymaps.py @@ -0,0 +1,177 @@ +from dataclasses import dataclass, field + + +@dataclass(frozen=True) +class TuiKeymapRegistry: + """ + TUI 键位注册表。 + + 该对象集中维护页面切换快捷键和派生提示文案,避免模块级 + 常量散落并在后续扩展时继续增长。 + + :param navigation_shortcuts: 页面导航快捷键映射 + """ + + navigation_shortcuts: dict[str, str] = field(default_factory=dict) + + @staticmethod + def normalize_view_key(view_key: str) -> str: + """ + 规范化页面标识。 + + :param view_key: 原始页面标识 + :return: 规范化后的页面标识 + """ + return str(view_key).strip().lower() + + def get_navigation_shortcut(self, view_key: str) -> str: + """ + 获取指定页面的导航快捷键。 + + :param view_key: 页面标识 + :return: 快捷键文本 + """ + normalized_view_key = self.normalize_view_key(view_key) + return self.navigation_shortcuts.get(normalized_view_key, '') + + @property + def navigation_shortcut_hint(self) -> str: + """ + 构建页面导航快捷键总提示。 + + :return: 快捷键提示 + """ + ordered_keys = ['dashboard', 'app', 'ops', 'database', 'cache', 'jobs', 'gen', 'configs', 'crypto'] + shortcuts = [ + self.get_navigation_shortcut(view_key).upper() + for view_key in ordered_keys + if self.get_navigation_shortcut(view_key) + ] + return f'[{" / ".join(shortcuts).replace(" / ", "/")}]' + + @property + def sidebar_shortcut_hint(self) -> str: + """ + 获取侧栏快捷键提示。 + + :return: 提示文本 + """ + return '[S] 侧栏' + + @property + def refresh_shortcut_hint(self) -> str: + """ + 获取刷新快捷键提示。 + + :return: 提示文本 + """ + return '[R] 刷新' + + @property + def quit_shortcut_hint(self) -> str: + """ + 获取退出快捷键提示。 + + :return: 提示文本 + """ + return '[Q] 退出' + + @property + def focus_shortcut_hint(self) -> str: + """ + 获取焦点切换快捷键提示。 + + :return: 提示文本 + """ + return '[←/→] 切换焦点' + + @property + def region_switch_shortcut_hint(self) -> str: + """ + 获取区域切换快捷键提示。 + + :return: 提示文本 + """ + return '[←/→] 切换区域' + + @property + def scroll_shortcut_hint(self) -> str: + """ + 获取滚动快捷键提示。 + + :return: 提示文本 + """ + return '[J/K] 滚动' + + @property + def page_scroll_shortcut_hint(self) -> str: + """ + 获取翻页快捷键提示。 + + :return: 提示文本 + """ + return '[PgUp/PgDn] 翻页' + + @property + def home_end_shortcut_hint(self) -> str: + """ + 获取首尾跳转快捷键提示。 + + :return: 提示文本 + """ + return '[Home/End] 首尾' + + @property + def browser_interaction_hint(self) -> str: + """ + 构建浏览页交互提示。 + + :return: 提示文本 + """ + return ( + f'浏览键:{self.focus_shortcut_hint} {self.scroll_shortcut_hint} ' + f'{self.page_scroll_shortcut_hint} {self.home_end_shortcut_hint}' + ) + + @property + def global_shortcut_hint(self) -> str: + """ + 构建全局快捷键提示。 + + :return: 提示文本 + """ + return ( + f'页面 {self.navigation_shortcut_hint} {self.sidebar_shortcut_hint} ' + f'{self.focus_shortcut_hint} {self.scroll_shortcut_hint} ' + f'{self.page_scroll_shortcut_hint} {self.home_end_shortcut_hint} ' + f'{self.refresh_shortcut_hint} {self.quit_shortcut_hint}' + ) + + @property + def hero_shortcut_hint(self) -> str: + """ + 构建首页英雄区快捷键提示。 + + :return: 提示文本 + """ + return ( + f'页面 {self.navigation_shortcut_hint} {self.sidebar_shortcut_hint} ' + f'{self.region_switch_shortcut_hint} {self.scroll_shortcut_hint} ' + f'{self.page_scroll_shortcut_hint} {self.home_end_shortcut_hint} ' + f'{self.refresh_shortcut_hint} {self.quit_shortcut_hint}' + ) + + +TUI_KEYMAP_REGISTRY = TuiKeymapRegistry( + navigation_shortcuts={ + 'dashboard': 'd', + 'app': 'a', + 'ops': 'o', + 'database': 'b', + 'cache': 'c', + 'jobs': 't', + 'gen': 'g', + 'configs': 'p', + 'crypto': 'e', + } +) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/__init__.py b/shierfeng-fastapi-backend/cli/tui/screens/__init__.py new file mode 100644 index 0000000..e26b185 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/__init__.py @@ -0,0 +1,5 @@ +from cli.tui.screens.browser import BrowserScreen +from cli.tui.screens.dashboard import DashboardScreen +from cli.tui.screens.detail import DetailScreen + +__all__ = ['BrowserScreen', 'DashboardScreen', 'DetailScreen'] diff --git a/shierfeng-fastapi-backend/cli/tui/screens/browser.py b/shierfeng-fastapi-backend/cli/tui/screens/browser.py new file mode 100644 index 0000000..a6f1443 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/browser.py @@ -0,0 +1,840 @@ +import asyncio + +from textual import on +from textual.app import ComposeResult +from textual.binding import Binding +from textual.containers import Horizontal, ScrollableContainer, Vertical +from textual.screen import Screen +from textual.widgets import Footer, Static + +from cli.tui.actions import ( + TUI_ACTION_PRESENTATION_SERVICE, + TUI_ACTION_REGISTRY, + TuiActionResult, + TuiActionSpec, +) +from cli.tui.adapters import BrowserPageSnapshot, BrowserRecordSnapshot, DetailSectionSnapshot +from cli.tui.adapters.models import TUI_ADAPTER_MODEL_RENDERER +from cli.tui.copy import TUI_COPY +from cli.tui.screens.focus import BaseScreenFocusService, ScreenFocusActionsMixin +from cli.tui.screens.interactions import TUI_SCREEN_INTERACTION_SERVICE, ScreenInteractionActionsMixin +from cli.tui.screens.summary import STATUS_SUMMARY_BUILDER +from cli.tui.search import TUI_SEARCH_SERVICE +from cli.tui.widgets import ( + NavigationItem, + RecordNavigator, + RecordSummaryView, + SectionDetailView, + SectionNavigator, + WorkspaceHeader, + WorkspaceHero, + WorkspaceSidebar, +) + + +class BrowserScreenSupport: + """ + 浏览页屏幕支持对象。 + + 该对象负责浏览页摘要、搜索词、动作解析、空态/加载态分区构建和 + 焦点顺序编排,使 `BrowserScreen` 本体主要保留 Textual 事件桥接。 + """ + + @staticmethod + def build_summary_text(snapshot: BrowserPageSnapshot, active_view: str) -> str: + """ + 构建浏览页摘要文本。 + + :param snapshot: 浏览页快照 + :param active_view: 当前激活视图 + :return: 摘要文本 + """ + summary = STATUS_SUMMARY_BUILDER.build(snapshot.records) + return TUI_COPY.build_browser_summary_text( + total_count=summary.total_count, + ok_count=summary.ok_count, + warn_count=summary.warn_count, + fail_count=summary.fail_count, + action_hint=TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint(active_view), + ) + + @staticmethod + def build_filter_bar_text(snapshot: BrowserPageSnapshot) -> str: + """ + 构建当前浏览页筛选条文本。 + + :param snapshot: 浏览页快照 + :return: 筛选条文本 + """ + search_context = snapshot.search + return TUI_SEARCH_SERVICE.build_filter_bar_text( + snapshot.filters, + snapshot.active_filter_key, + search_query=search_context.query if search_context is not None else '', + search_placeholder=search_context.placeholder if search_context is not None else '', + search_suggestions=search_context.suggestions if search_context is not None else [], + ) + + @staticmethod + def current_search_query(snapshot: BrowserPageSnapshot) -> str: + """ + 读取当前浏览页搜索词。 + + :param snapshot: 浏览页快照 + :return: 搜索词 + """ + search_context = snapshot.search + return search_context.query if search_context is not None else '' + + @staticmethod + def resolve_action( + *, + active_view: str, + slot: str, + record: BrowserRecordSnapshot, + env: str, + ) -> TuiActionSpec | None: + """ + 解析当前页面指定槽位对应的动作。 + + :param active_view: 当前激活视图 + :param slot: 动作槽位 + :param record: 当前选中记录 + :param env: 当前运行环境 + :return: 动作定义 + """ + return TUI_ACTION_REGISTRY.resolve_browser_action( + view_key=active_view, + slot=slot, # type: ignore[arg-type] + record=record, + env=env, + ) + + @staticmethod + def build_record_action_lines( + *, + active_view: str, + record: BrowserRecordSnapshot, + env: str, + feedback_lines: list[str], + ) -> list[str]: + """ + 构建当前记录动作面板文本。 + + :param active_view: 当前激活视图 + :param record: 当前记录 + :param env: 当前运行环境 + :param feedback_lines: 最近动作反馈文本 + :return: 动作面板文本 + """ + action_lines = TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_lines( + view_key=active_view, + record=record, + env=env, + ) + return TUI_COPY.build_browser_action_panel_lines(action_lines, feedback_lines) + + @staticmethod + def build_empty_record() -> BrowserRecordSnapshot: + """ + 构建浏览页空态兜底记录。 + + :return: 记录快照 + """ + return BrowserRecordSnapshot( + key='empty', + title=TUI_COPY.build_browser_empty_record_copy('title'), + status='info', + summary=TUI_COPY.build_browser_empty_record_copy('summary'), + metadata_lines=[], + detail_sections=[ + DetailSectionSnapshot( + title=TUI_COPY.build_browser_empty_record_copy('title'), + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label=TUI_COPY.build_browser_empty_record_copy('label'), + empty_value=TUI_COPY.build_browser_empty_record_copy('value'), + detail=TUI_COPY.build_browser_empty_record_copy('detail'), + ), + ) + ], + ) + + @staticmethod + def build_loading_section() -> DetailSectionSnapshot: + """ + 构建详情加载中的占位分区。 + + :return: 占位分区 + """ + return DetailSectionSnapshot( + title=TUI_COPY.build_browser_loading_copy('title'), + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_loading_lines( + loading_label=TUI_COPY.build_browser_loading_copy('label'), + loading_value=TUI_COPY.build_browser_loading_copy('value'), + detail=TUI_COPY.build_browser_loading_copy('detail'), + ), + ) + + @staticmethod + def build_detail_load_failure_sections(error: Exception, resource_name: str) -> list[DetailSectionSnapshot]: + """ + 构建详情加载失败时的兜底分区。 + + :param error: 后台加载异常 + :param resource_name: 资源名称 + :return: 失败分区列表 + """ + return [ + DetailSectionSnapshot( + title=TUI_COPY.build_load_failure_section_title(resource_name), + status='fail', + lines=TUI_ADAPTER_MODEL_RENDERER.build_failure_lines( + { + 'message': '后台详情加载失败', + 'error': str(error) or error.__class__.__name__, + 'hint': '可按 [R] 刷新当前页面,或切换记录后重试', + }, + empty_label='详情状态', + empty_value='不可用', + ), + ) + ] + + @staticmethod + def build_empty_section() -> DetailSectionSnapshot: + """ + 构建浏览页详情空态兜底分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title=TUI_COPY.build_detail_empty_section_copy('title'), + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label=TUI_COPY.build_detail_empty_section_copy('label'), + empty_value=TUI_COPY.build_detail_empty_section_copy('value'), + detail=TUI_COPY.build_detail_empty_section_copy('detail_record'), + ), + ) + + +class BrowserScreenFocusService(BaseScreenFocusService): + """ + 浏览页焦点服务。 + + 该对象负责定义浏览页可聚焦组件顺序,以及按左右键和滚动键解析 + 当前目标区域。 + """ + + def get_focus_order( + self, + screen: 'BrowserScreen', + ) -> list[WorkspaceSidebar | RecordNavigator | SectionNavigator | RecordSummaryView | SectionDetailView]: + """ + 定义浏览页可通过左右键切换的焦点顺序。 + + :param screen: 当前浏览页屏幕 + :return: 焦点顺序列表 + """ + return [ + screen.query_one(WorkspaceSidebar), + screen.query_one(RecordNavigator), + screen.query_one(SectionNavigator), + screen.query_one(RecordSummaryView), + screen.query_one(SectionDetailView), + ] + + def get_default_scroll_target( + self, + screen: 'BrowserScreen', + ) -> ScrollableContainer: + """ + 返回浏览页默认滚动容器。 + + :param screen: 当前浏览页屏幕 + :return: 主工作区滚动容器 + """ + return screen.query_one('#workspace-main', ScrollableContainer) + + +class BrowserScreen(ScreenInteractionActionsMixin, ScreenFocusActionsMixin, Screen[None]): + """ + TUI 浏览型页面。 + + :param snapshot: 浏览页快照 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param navigation_items: 导航项列表 + :param refreshed_at: 本次刷新时间 + """ + + BINDINGS = [ + Binding('left', 'focus_left', TUI_COPY.build_internal_binding_label('focus_left'), show=False), + Binding('right', 'focus_right', TUI_COPY.build_internal_binding_label('focus_right'), show=False), + Binding('j', 'scroll_focus_down', TUI_COPY.build_internal_binding_label('scroll_down'), show=False), + Binding('k', 'scroll_focus_up', TUI_COPY.build_internal_binding_label('scroll_up'), show=False), + Binding('pagedown', 'scroll_focus_page_down', TUI_COPY.build_internal_binding_label('page_down'), show=False), + Binding('pageup', 'scroll_focus_page_up', TUI_COPY.build_internal_binding_label('page_up'), show=False), + Binding('home', 'scroll_focus_home', TUI_COPY.build_internal_binding_label('home'), show=False), + Binding('end', 'scroll_focus_end', TUI_COPY.build_internal_binding_label('end'), show=False), + Binding('x', 'trigger_primary_action', TUI_COPY.build_internal_binding_label('action_primary'), show=False), + Binding('z', 'trigger_secondary_action', TUI_COPY.build_internal_binding_label('action_secondary'), show=False), + Binding('y', 'trigger_global_action', TUI_COPY.build_internal_binding_label('action_global'), show=False), + Binding('w', 'trigger_utility_action', TUI_COPY.build_internal_binding_label('action_utility'), show=False), + Binding('1', 'apply_filter_1', TUI_COPY.build_internal_binding_label('filter_1'), show=False), + Binding('2', 'apply_filter_2', TUI_COPY.build_internal_binding_label('filter_2'), show=False), + Binding('3', 'apply_filter_3', TUI_COPY.build_internal_binding_label('filter_3'), show=False), + Binding('4', 'apply_filter_4', TUI_COPY.build_internal_binding_label('filter_4'), show=False), + Binding('/', 'open_search', TUI_COPY.build_internal_binding_label('search'), show=False), + Binding('backspace', 'clear_search', TUI_COPY.build_internal_binding_label('clear_search'), show=False), + ] + + def __init__( + self, + snapshot: BrowserPageSnapshot, + env: str, + active_view: str, + navigation_items: list[NavigationItem], + refreshed_at: str, + action_feedback_lines: list[str] | None = None, + support: BrowserScreenSupport | None = None, + focus_service: BrowserScreenFocusService | None = None, + ) -> None: + """ + 初始化浏览型页面。 + + :param snapshot: 浏览页快照 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param navigation_items: 导航项列表 + :param refreshed_at: 本次刷新时间 + :param action_feedback_lines: 最近动作反馈文本 + :param support: 浏览页屏幕支持对象 + :param focus_service: 浏览页焦点服务 + :return: None + """ + self.snapshot = snapshot + self.env = env + self.active_view = active_view + self.navigation_items = navigation_items + self.refreshed_at = refreshed_at + self.selected_record_index = 0 + self.selected_section_index = 0 + self._is_syncing_sections = False + self._record_detail_request_id = 0 + self._record_detail_task: asyncio.Task[None] | None = None + self._action_task: asyncio.Task[None] | None = None + self._last_action_result: TuiActionResult | None = None + self._action_feedback_lines = list(action_feedback_lines or []) + self.support = support or BrowserScreenSupport() + self.focus_service = focus_service or BrowserScreenFocusService() + super().__init__() + + def _build_summary_text(self) -> str: + """ + 构建浏览页摘要文本。 + + :return: 摘要文本 + """ + return self.support.build_summary_text(self.snapshot, self.active_view) + + def _build_filter_bar_text(self) -> str: + """ + 构建当前浏览页筛选条文本。 + + :return: 筛选条文本 + """ + return self.support.build_filter_bar_text(self.snapshot) + + def _current_search_query(self) -> str: + return self.support.current_search_query(self.snapshot) + + def _apply_filter_shortcut(self, shortcut: str) -> None: + """ + 按快捷键切换当前浏览页筛选条件。 + + :param shortcut: 筛选快捷键 + :return: None + """ + if not self.snapshot.filters: + return + target = next((option for option in self.snapshot.filters if option.shortcut == shortcut), None) + if target is None or target.key == self.snapshot.active_filter_key: + return + remember_filter = getattr(self.app, 'remember_browser_filter', None) + if callable(remember_filter): + remember_filter(self.active_view, target.key) + self.app.action_refresh_current_view() + + def _open_search(self) -> None: + """ + 打开当前浏览页搜索输入弹窗。 + + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.open_search_dialog( + self, + self.snapshot.search, + self._handle_search_submitted, + ) + + def _handle_search_submitted(self, query: str | None) -> None: + """ + 处理页内搜索输入结果。 + + :param query: 搜索词 + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.remember_query_and_refresh(self, self.active_view, query) + + def _clear_search(self) -> None: + """ + 清空当前浏览页搜索词。 + + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.clear_query_and_refresh( + self, + self.active_view, + self._current_search_query(), + ) + + def _resolve_action(self, slot: str) -> TuiActionSpec | None: + """ + 解析当前页面指定槽位对应的动作。 + + :param slot: 动作槽位 + :return: 动作定义 + """ + return self.support.resolve_action( + active_view=self.active_view, + slot=slot, + record=self._get_record_or_fallback(self.selected_record_index), + env=self.env, + ) + + def _build_record_action_lines(self, record: BrowserRecordSnapshot) -> list[str]: + """ + 构建当前记录动作面板文本。 + + :param record: 当前记录 + :return: 动作面板文本 + """ + return self.support.build_record_action_lines( + active_view=self.active_view, + record=record, + env=self.env, + feedback_lines=self._action_feedback_lines, + ) + + def _open_action_confirm(self, slot: str) -> None: + """ + 打开指定槽位动作的确认弹窗。 + + :param slot: 动作槽位 + :return: None + """ + self._action_task = TUI_SCREEN_INTERACTION_SERVICE.confirm_and_schedule_action( + self, + self._resolve_action(slot), + self._action_task, + self._execute_action, + ) + + async def _execute_action(self, action: TuiActionSpec) -> None: + """ + 执行低风险动作并在结束后通知与刷新页面。 + + :param action: 动作定义 + :return: None + """ + + async def _handle_result(result: TuiActionResult, feedback_lines: list[str]) -> None: + self._last_action_result = result + self._action_feedback_lines = feedback_lines + await self._render_record_detail(eager=False) + + await TUI_SCREEN_INTERACTION_SERVICE.execute_action_with_feedback( + self, + action, + self.env, + self.active_view, + _handle_result, + ) + + def _get_record_or_fallback(self, index: int) -> BrowserRecordSnapshot: + """ + 获取指定索引的记录快照,缺失时返回兜底记录。 + + :param index: 记录索引 + :return: 记录快照 + """ + if 0 <= index < len(self.snapshot.records): + return self.snapshot.records[index] + return self.support.build_empty_record() + + def _build_loading_section(self) -> DetailSectionSnapshot: + """ + 构建详情加载中的占位分区。 + + :return: 占位分区 + """ + return self.support.build_loading_section() + + def _build_detail_load_failure_sections(self, error: Exception) -> list[DetailSectionSnapshot]: + """ + 构建详情加载失败时的兜底分区。 + + :param error: 后台加载异常 + :return: 失败分区列表 + """ + resource_name = self.snapshot.title if '详情' in self.snapshot.title else f'{self.snapshot.title}详情' + return self.support.build_detail_load_failure_sections(error, resource_name) + + @staticmethod + def _cancel_task(task: asyncio.Task[None] | None) -> None: + """ + 取消指定后台任务。 + + :param task: 待取消任务 + :return: None + """ + if task is None or task.done(): + return + task.cancel() + + def _cancel_background_tasks(self) -> None: + """ + 取消当前屏幕持有的后台任务。 + + :return: None + """ + self._record_detail_request_id += 1 + self._cancel_task(self._record_detail_task) + self._cancel_task(self._action_task) + + def _get_sections_for_record(self, index: int, *, eager: bool = False) -> list[DetailSectionSnapshot]: + """ + 获取指定记录对应的详情分区列表。 + + :param index: 记录索引 + :param eager: 是否立即加载按需详情 + :return: 详情分区列表 + """ + record = self._get_record_or_fallback(index) + if eager: + try: + detail_sections = record.resolve_detail_sections() + except Exception as error: + detail_sections = self._build_detail_load_failure_sections(error) + elif record.detail_sections: + detail_sections = record.detail_sections + elif record._cached_detail_sections: + detail_sections = list(record._cached_detail_sections) + elif record.detail_loader is not None: + detail_sections = [self._build_loading_section()] + else: + detail_sections = [] + return [*detail_sections, *self.snapshot.shared_sections] + + def _get_section_or_fallback(self, record_index: int, section_index: int) -> DetailSectionSnapshot: + """ + 获取指定记录下的分区快照,缺失时返回兜底分区。 + + :param record_index: 记录索引 + :param section_index: 分区索引 + :return: 分区快照 + """ + sections = self._get_sections_for_record(record_index) + if 0 <= section_index < len(sections): + return sections[section_index] + return self.support.build_empty_section() + + async def _render_record_detail(self, *, eager: bool = False) -> None: + """ + 根据当前选中记录刷新右侧详情区域。 + + :param eager: 是否立即解析完整详情 + :return: None + """ + record = self._get_record_or_fallback(self.selected_record_index) + sections = self._get_sections_for_record(self.selected_record_index, eager=eager) + selected_section = self._get_section_or_fallback(self.selected_record_index, self.selected_section_index) + self.query_one(RecordSummaryView).show_record( + record, + selected_section, + self._build_record_action_lines(record), + self._current_search_query(), + ) + navigator = self.query_one(SectionNavigator) + detail_view = self.query_one(SectionDetailView) + self._is_syncing_sections = True + try: + await navigator.show_sections( + sections, + initial_index=self.selected_section_index, + query=self._current_search_query(), + ) + detail_view.show_section(selected_section, query=self._current_search_query()) + self._sync_detail_pane_state(selected_section) + finally: + self._is_syncing_sections = False + + def _sync_detail_pane_state(self, section: DetailSectionSnapshot) -> None: + """ + 依据当前分区状态同步右侧详情容器样式。 + + :param section: 当前分区快照 + :return: None + """ + detail_pane = self.query_one('#browser-detail-pane', Vertical) + detail_pane.remove_class('is-ok', 'is-fail', 'is-warn', 'is-info') + normalized = section.status if section.status in {'ok', 'fail', 'warn'} else 'info' + detail_pane.add_class(f'is-{normalized}') + + async def _load_record_detail_async(self, index: int, request_id: int) -> None: + """ + 在后台线程中加载指定记录的详情,并在仍为当前选中记录时回填界面。 + + :param index: 记录索引 + :param request_id: 当前加载请求编号 + :return: None + """ + record = self._get_record_or_fallback(index) + try: + await asyncio.to_thread(record.resolve_detail_sections) + except Exception as error: + failure_sections = self._build_detail_load_failure_sections(error) + object.__setattr__(record, '_cached_detail_sections', tuple(failure_sections)) + if request_id != self._record_detail_request_id: + return + if index != self.selected_record_index: + return + await self._render_record_detail(eager=False) + + def _schedule_record_detail_load(self, index: int) -> None: + """ + 为当前选中记录安排一次后台详情加载。 + + :param index: 记录索引 + :return: None + """ + record = self._get_record_or_fallback(index) + if record.detail_loader is None: + return + if record._cached_detail_sections: + return + self._cancel_task(self._record_detail_task) + self._record_detail_request_id += 1 + self._record_detail_task = asyncio.create_task( + self._load_record_detail_async(index, self._record_detail_request_id) + ) + + async def _update_selected_record(self, index: int) -> None: + """ + 更新当前选中记录,并同步右侧详情视图。 + + :param index: 待选中的记录索引 + :return: None + """ + if not self.snapshot.records: + self.selected_record_index = 0 + self.selected_section_index = 0 + await self._render_record_detail(eager=False) + return + if not 0 <= index < len(self.snapshot.records): + return + if index == self.selected_record_index: + return + self.selected_record_index = index + self.selected_section_index = 0 + await self._render_record_detail(eager=False) + self._schedule_record_detail_load(index) + + def _update_selected_section(self, index: int) -> None: + """ + 更新当前选中分区,并同步最右侧详情内容。 + + :param index: 分区索引 + :return: None + """ + if self._is_syncing_sections: + return + sections = self._get_sections_for_record(self.selected_record_index) + if not sections: + detail_view = self.query_one(SectionDetailView) + fallback = self._get_section_or_fallback(self.selected_record_index, index) + detail_view.show_section(fallback, query=self._current_search_query()) + record = self._get_record_or_fallback(self.selected_record_index) + self.query_one(RecordSummaryView).show_record( + record, + fallback, + self._build_record_action_lines(record), + self._current_search_query(), + ) + self._sync_detail_pane_state(fallback) + return + if not 0 <= index < len(sections): + return + if index == self.selected_section_index: + return + self.selected_section_index = index + current_section = sections[index] + detail_view = self.query_one(SectionDetailView) + detail_view.show_section(current_section, query=self._current_search_query()) + record = self._get_record_or_fallback(self.selected_record_index) + self.query_one(RecordSummaryView).show_record( + record, + current_section, + self._build_record_action_lines(record), + self._current_search_query(), + ) + self._sync_detail_pane_state(current_section) + + def on_mount(self) -> None: + """ + 浏览页挂载后默认将焦点停留在左侧导航。 + + :return: None + """ + self.call_after_refresh(self.query_one(WorkspaceSidebar).focus) + self._schedule_record_detail_load(self.selected_record_index) + + def on_unmount(self) -> None: + """ + 浏览页卸载时取消尚未完成的后台任务。 + + :return: None + """ + self._cancel_background_tasks() + + def action_apply_filter_1(self) -> None: + """ + 应用第一个浏览页筛选条件。 + + :return: None + """ + self._apply_filter_shortcut('1') + + def action_apply_filter_2(self) -> None: + """ + 应用第二个浏览页筛选条件。 + + :return: None + """ + self._apply_filter_shortcut('2') + + def action_apply_filter_3(self) -> None: + """ + 应用第三个浏览页筛选条件。 + + :return: None + """ + self._apply_filter_shortcut('3') + + def action_apply_filter_4(self) -> None: + """ + 应用第四个浏览页筛选条件。 + + :return: None + """ + self._apply_filter_shortcut('4') + + def _open_sidebar_item(self, event: WorkspaceSidebar.Highlighted | WorkspaceSidebar.Selected) -> None: + """ + 根据侧边栏事件打开对应视图,并避免重复打开当前页面。 + + :param event: 侧边栏高亮或选中事件 + :return: None + """ + item = getattr(event.item, 'item', None) + if not isinstance(item, NavigationItem): + return + if item.view_key == self.active_view: + return + self.app.open_view(item.view_key) + + @on(WorkspaceSidebar.Selected) + def on_sidebar_selected(self, event: WorkspaceSidebar.Selected) -> None: + """ + 响应左侧导航选中事件并切换视图。 + + :param event: 导航选中事件 + :return: None + """ + self._open_sidebar_item(event) + + @on(WorkspaceSidebar.Highlighted) + def on_sidebar_highlighted(self, event: WorkspaceSidebar.Highlighted) -> None: + """ + 响应左侧导航高亮变更并立即切换视图。 + + :param event: 导航高亮事件 + :return: None + """ + self._open_sidebar_item(event) + + def compose(self) -> ComposeResult: + """ + 构建浏览页界面结构。 + + :return: Textual 组件结果 + """ + yield WorkspaceHeader(self.env, self.active_view) + with Horizontal(id='workspace-shell'): + yield WorkspaceSidebar(self.env, self.navigation_items, self.active_view) + with ScrollableContainer(id='workspace-main'): + yield WorkspaceHero( + title=self.snapshot.title, + subtitle=self.snapshot.subtitle, + env=self.env, + active_view=self.active_view, + summary=self._build_summary_text(), + refreshed_at=self.refreshed_at, + ) + if self.snapshot.filters: + yield Static(self._build_filter_bar_text(), id='browser-filter-bar', markup=False) + with Horizontal(id='browser-body'): + yield RecordNavigator( + self.snapshot.records, + initial_index=self.selected_record_index, + query=self._current_search_query(), + ) + with Vertical(id='browser-detail-pane'): + yield RecordSummaryView(self._get_record_or_fallback(self.selected_record_index)) + with Horizontal(id='browser-section-body'): + yield SectionNavigator( + self._get_sections_for_record(self.selected_record_index, eager=False), + initial_index=self.selected_section_index, + query=self._current_search_query(), + ) + yield SectionDetailView( + self._get_section_or_fallback( + self.selected_record_index, + self.selected_section_index, + ), + query=self._current_search_query(), + ) + yield Footer() + + @on(RecordNavigator.Changed) + async def on_record_changed(self, event: RecordNavigator.Changed) -> None: + """ + 响应记录导航高亮变更并更新详情内容。 + + :param event: 记录导航高亮事件 + :return: None + """ + await self._update_selected_record(event.index) + + @on(SectionNavigator.Changed) + def on_section_changed(self, event: SectionNavigator.Changed) -> None: + """ + 响应记录详情分区高亮变更并更新最右侧详情内容。 + + :param event: 分区导航高亮事件 + :return: None + """ + self._update_selected_section(event.index) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/confirm.py b/shierfeng-fastapi-backend/cli/tui/screens/confirm.py new file mode 100644 index 0000000..abdc64c --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/confirm.py @@ -0,0 +1,128 @@ +from textual import on +from textual.app import ComposeResult +from textual.binding import Binding +from textual.containers import Horizontal, Vertical +from textual.screen import ModalScreen +from textual.widgets import Button, Static + +from cli.tui.copy import TUI_COPY + + +class ActionConfirmScreen(ModalScreen[bool]): + """ + 通用动作确认弹窗。 + + :param title: 弹窗标题 + :param lines: 预览文本行 + :param confirm_label: 确认按钮文本 + """ + + CSS = """ + ActionConfirmScreen { + align: center middle; + } + + #action-confirm-dialog { + width: 96; + max-width: 96; + border: heavy #38d8ff; + background: #06111b; + padding: 1 2; + } + + #action-confirm-title { + text-style: bold; + color: #e9fcff; + margin-bottom: 1; + } + + #action-confirm-body { + border: round #18425d; + background: #081827; + color: #d8f7ff; + padding: 1 2; + margin-bottom: 1; + } + + #action-confirm-actions { + height: auto; + align-horizontal: right; + } + + #action-confirm-hint { + color: #8fc6d6; + margin-bottom: 1; + } + + #action-confirm-cancel { + margin-right: 1; + } + """ + + BINDINGS = [ + Binding('escape', 'cancel', TUI_COPY.build_confirm_binding_label('cancel'), show=False), + Binding('enter', 'submit', TUI_COPY.build_confirm_binding_label('submit'), show=False), + ] + + def __init__(self, title: str, lines: list[str], confirm_label: str) -> None: + super().__init__() + self._dialog_title = title + self._dialog_lines = lines + self._confirm_label = confirm_label + + def compose(self) -> ComposeResult: + """ + 构建确认弹窗界面。 + + :return: Textual 组件结果 + """ + with Vertical(id='action-confirm-dialog'): + yield Static(self._dialog_title, id='action-confirm-title', markup=False) + yield Static('\n'.join(self._dialog_lines), id='action-confirm-body', markup=False) + yield Static(TUI_COPY.build_action_confirm_hint(), id='action-confirm-hint', markup=False) + with Horizontal(id='action-confirm-actions'): + yield Button(TUI_COPY.build_action_confirm_cancel_label(), id='action-confirm-cancel') + yield Button(self._confirm_label, id='action-confirm-submit', variant='primary') + + def on_mount(self) -> None: + """ + 弹窗挂载后默认聚焦确认按钮。 + + :return: None + """ + self.call_after_refresh(self.query_one('#action-confirm-submit', Button).focus) + + def action_cancel(self) -> None: + """ + 取消并关闭弹窗。 + + :return: None + """ + self.dismiss(False) + + def action_submit(self) -> None: + """ + 通过键盘确认执行当前动作。 + + :return: None + """ + submit_button = self.query_one('#action-confirm-submit', Button) + submit_button.press() + + @on(Button.Pressed, '#action-confirm-cancel') + def on_cancel_pressed(self) -> None: + """ + 响应取消按钮。 + + :return: None + """ + self.dismiss(False) + + @on(Button.Pressed, '#action-confirm-submit') + def on_submit_pressed(self) -> None: + """ + 响应确认按钮。 + + :return: None + """ + self.dismiss(True) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/dashboard.py b/shierfeng-fastapi-backend/cli/tui/screens/dashboard.py new file mode 100644 index 0000000..ae8b460 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/dashboard.py @@ -0,0 +1,253 @@ +from textual import on +from textual.app import ComposeResult +from textual.binding import Binding +from textual.containers import Grid, Horizontal, ScrollableContainer +from textual.screen import Screen +from textual.widgets import Footer + +from cli.tui.adapters import DashboardSnapshot +from cli.tui.copy import TUI_COPY +from cli.tui.keymaps import TUI_KEYMAP_REGISTRY +from cli.tui.screens.focus import BaseScreenFocusService, ScreenFocusActionsMixin +from cli.tui.screens.summary import STATUS_SUMMARY_BUILDER +from cli.tui.widgets import ( + MetricPanel, + NavigationItem, + SignalRail, + StatusPanel, + WorkspaceHeader, + WorkspaceHero, + WorkspaceSidebar, +) + +PRIMARY_METRIC_COUNT = 2 + + +class DashboardScreenSupport: + """ + 首页屏幕支持对象。 + + 该对象负责首页摘要文本、信号带文本和状态轨迹构建, + 使 `DashboardScreen` 本体主要保留 Textual 生命周期与界面编排。 + """ + + @staticmethod + def build_summary_text(snapshot: DashboardSnapshot) -> str: + """ + 构建首页摘要文本。 + + :param snapshot: 首页聚合快照 + :return: 摘要文本 + """ + summary = STATUS_SUMMARY_BUILDER.build(snapshot.panels) + return TUI_COPY.build_dashboard_summary_text( + total_count=summary.total_count, + ok_count=summary.ok_count, + warn_count=summary.warn_count, + fail_count=summary.fail_count, + ) + + @staticmethod + def build_status_track(snapshot: DashboardSnapshot) -> str: + """ + 构建首页面板状态轨迹字符串。 + + :param snapshot: 首页聚合快照 + :return: 状态轨迹 + """ + return ''.join( + 'x' if panel.status == 'fail' else '!' if panel.status == 'warn' else 'o' if panel.status == 'ok' else '-' + for panel in snapshot.panels + ) + + def build_signal_lines(self, snapshot: DashboardSnapshot) -> list[str]: + """ + 构建首页顶部信号带文本。 + + :param snapshot: 首页聚合快照 + :return: 信号文本行 + """ + summary = STATUS_SUMMARY_BUILDER.build(snapshot.panels) + return TUI_COPY.build_dashboard_signal_lines( + status_track=self.build_status_track(snapshot), + fail_count=summary.fail_count, + warn_count=summary.warn_count, + ok_count=summary.ok_count, + total_count=summary.total_count, + navigation_shortcut_hint=TUI_KEYMAP_REGISTRY.navigation_shortcut_hint, + ) + + +class DashboardScreenFocusService(BaseScreenFocusService): + """ + 首页焦点服务。 + + 该对象负责定义首页可聚焦组件顺序,以及按左右键和滚动键解析 + 当前目标区域。 + """ + + def get_focus_order(self, screen: 'DashboardScreen') -> list[WorkspaceSidebar | ScrollableContainer]: + """ + 定义首页可通过左右键切换的焦点顺序。 + + :param screen: 当前首页屏幕 + :return: 焦点顺序列表 + """ + return [ + screen.query_one(WorkspaceSidebar), + screen.query_one('#workspace-main', ScrollableContainer), + ] + + def get_default_scroll_target(self, screen: 'DashboardScreen') -> ScrollableContainer: + """ + 返回首页默认滚动容器。 + + :param screen: 当前首页屏幕 + :return: 主工作区滚动容器 + """ + return screen.query_one('#workspace-main', ScrollableContainer) + + +class DashboardScreen(ScreenFocusActionsMixin, Screen[None]): + """ + TUI 首页巡检屏幕。 + + :param snapshot: 首页聚合快照 + """ + + BINDINGS = [ + Binding('left', 'focus_left', TUI_COPY.build_internal_binding_label('focus_left'), show=False), + Binding('right', 'focus_right', TUI_COPY.build_internal_binding_label('focus_right'), show=False), + Binding('j', 'scroll_focus_down', TUI_COPY.build_internal_binding_label('scroll_down'), show=False), + Binding('k', 'scroll_focus_up', TUI_COPY.build_internal_binding_label('scroll_up'), show=False), + Binding('pagedown', 'scroll_focus_page_down', TUI_COPY.build_internal_binding_label('page_down'), show=False), + Binding('pageup', 'scroll_focus_page_up', TUI_COPY.build_internal_binding_label('page_up'), show=False), + Binding('home', 'scroll_focus_home', TUI_COPY.build_internal_binding_label('home'), show=False), + Binding('end', 'scroll_focus_end', TUI_COPY.build_internal_binding_label('end'), show=False), + ] + + def __init__( + self, + snapshot: DashboardSnapshot, + env: str, + active_view: str, + navigation_items: list[NavigationItem], + refreshed_at: str, + support: DashboardScreenSupport | None = None, + focus_service: DashboardScreenFocusService | None = None, + ) -> None: + """ + 初始化首页巡检屏幕。 + + :param snapshot: 首页聚合快照 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param navigation_items: 导航项列表 + :param refreshed_at: 本次刷新时间 + :param support: 首页屏幕支持对象 + :param focus_service: 首页焦点服务 + :return: None + """ + self.snapshot = snapshot + self.env = env + self.active_view = active_view + self.navigation_items = navigation_items + self.refreshed_at = refreshed_at + self.support = support or DashboardScreenSupport() + self.focus_service = focus_service or DashboardScreenFocusService() + super().__init__() + + def _build_summary_text(self) -> str: + """ + 构建首页摘要文本。 + + :return: 摘要文本 + """ + return self.support.build_summary_text(self.snapshot) + + def _build_signal_lines(self) -> list[str]: + """ + 构建首页顶部信号带文本。 + + :return: 信号文本行 + """ + return self.support.build_signal_lines(self.snapshot) + + def compose(self) -> ComposeResult: + """ + 构建首页界面结构。 + + :return: Textual 组件结果 + """ + yield WorkspaceHeader(self.env, self.active_view) + with Horizontal(id='workspace-shell'): + yield WorkspaceSidebar(self.env, self.navigation_items, self.active_view) + with ScrollableContainer(id='workspace-main'): + yield WorkspaceHero( + title=TUI_COPY.build_dashboard_hero_title(), + subtitle=TUI_COPY.build_dashboard_hero_subtitle(), + env=self.env, + active_view=self.active_view, + summary=self._build_summary_text(), + refreshed_at=self.refreshed_at, + ) + yield SignalRail(self._build_signal_lines()) + with Grid(id='dashboard-metrics'): + for index, metric in enumerate(self.snapshot.metrics): + yield MetricPanel( + title=metric.title, + value=metric.value, + status=metric.status, + hint=metric.hint, + accent=index < PRIMARY_METRIC_COUNT, + ) + with Grid(id='dashboard-grid'): + for panel in self.snapshot.panels: + yield StatusPanel( + title=panel.title, + status=panel.status, + body='\n'.join(panel.lines), + ) + yield Footer() + + def on_mount(self) -> None: + """ + 首页挂载后默认将焦点停留在左侧导航。 + + :return: None + """ + self.call_after_refresh(self.query_one(WorkspaceSidebar).focus) + + def _open_sidebar_item(self, event: WorkspaceSidebar.Highlighted | WorkspaceSidebar.Selected) -> None: + """ + 根据侧边栏事件打开对应视图,并避免重复打开当前页面。 + + :param event: 侧边栏高亮或选中事件 + :return: None + """ + item = getattr(event.item, 'item', None) + if not isinstance(item, NavigationItem): + return + if item.view_key == self.active_view: + return + self.app.open_view(item.view_key) + + @on(WorkspaceSidebar.Selected) + def on_sidebar_selected(self, event: WorkspaceSidebar.Selected) -> None: + """ + 响应左侧导航选中事件并切换视图。 + + :param event: 导航选中事件 + :return: None + """ + self._open_sidebar_item(event) + + @on(WorkspaceSidebar.Highlighted) + def on_sidebar_highlighted(self, event: WorkspaceSidebar.Highlighted) -> None: + """ + 响应左侧导航高亮变更并立即切换视图。 + + :param event: 导航高亮事件 + :return: None + """ + self._open_sidebar_item(event) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/detail.py b/shierfeng-fastapi-backend/cli/tui/screens/detail.py new file mode 100644 index 0000000..97e2c69 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/detail.py @@ -0,0 +1,413 @@ +import asyncio + +from textual import on +from textual.app import ComposeResult +from textual.binding import Binding +from textual.containers import Horizontal, ScrollableContainer +from textual.screen import Screen +from textual.widgets import Footer + +from cli.tui.actions import ( + TUI_ACTION_PRESENTATION_SERVICE, + TUI_ACTION_REGISTRY, + TuiActionResult, + TuiActionSpec, +) +from cli.tui.adapters import DetailPageSnapshot, DetailSectionSnapshot +from cli.tui.adapters.models import TUI_ADAPTER_MODEL_RENDERER +from cli.tui.copy import TUI_COPY +from cli.tui.screens.focus import BaseScreenFocusService, ScreenFocusActionsMixin +from cli.tui.screens.interactions import TUI_SCREEN_INTERACTION_SERVICE, ScreenInteractionActionsMixin +from cli.tui.screens.summary import STATUS_SUMMARY_BUILDER +from cli.tui.widgets import ( + NavigationItem, + SectionDetailView, + SectionNavigator, + WorkspaceHeader, + WorkspaceHero, + WorkspaceSidebar, +) + + +class DetailScreenSupport: + """ + 详情页屏幕支持对象。 + + 该对象负责详情页摘要、搜索词、动作解析与空态分区构建, + 使 `DetailScreen` 本体主要保留 Textual 事件桥接。 + """ + + @staticmethod + def build_empty_section() -> DetailSectionSnapshot: + """ + 构建详情页空态兜底分区。 + + :return: 分区快照 + """ + return DetailSectionSnapshot( + title=TUI_COPY.build_detail_empty_section_copy('title'), + status='info', + lines=TUI_ADAPTER_MODEL_RENDERER.build_empty_lines( + empty_label=TUI_COPY.build_detail_empty_section_copy('label'), + empty_value=TUI_COPY.build_detail_empty_section_copy('value'), + detail=TUI_COPY.build_detail_empty_section_copy('detail_page'), + ), + ) + + @staticmethod + def build_summary_text(snapshot: DetailPageSnapshot, active_view: str) -> str: + """ + 构建详情页摘要文本。 + + :param snapshot: 页面快照 + :param active_view: 当前激活视图 + :return: 摘要文本 + """ + summary = STATUS_SUMMARY_BUILDER.build(snapshot.sections) + return ( + TUI_COPY.build_detail_summary_text( + total_count=summary.total_count, + ok_count=summary.ok_count, + warn_count=summary.warn_count, + fail_count=summary.fail_count, + ) + + f' {TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint(active_view)}' + ) + + @staticmethod + def current_search_query(snapshot: DetailPageSnapshot) -> str: + """ + 读取当前详情页搜索词。 + + :param snapshot: 页面快照 + :return: 搜索词 + """ + search_context = snapshot.search + return search_context.query if search_context is not None else '' + + @staticmethod + def resolve_action(*, active_view: str, slot: str, env: str) -> TuiActionSpec | None: + """ + 解析当前详情页指定槽位对应的动作。 + + :param active_view: 当前激活视图 + :param slot: 动作槽位 + :param env: 当前运行环境 + :return: 动作定义 + """ + return TUI_ACTION_REGISTRY.resolve_detail_action( + view_key=active_view, + slot=slot, # type: ignore[arg-type] + env=env, + ) + + +class DetailScreenFocusService(BaseScreenFocusService): + """ + 详情页焦点服务。 + + 该对象负责定义详情页可聚焦组件顺序,以及按左右键和滚动键解析 + 当前目标区域。 + """ + + def get_focus_order(self, screen: 'DetailScreen') -> list[WorkspaceSidebar | SectionNavigator | SectionDetailView]: + """ + 定义详情页可通过左右键切换的焦点顺序。 + + :param screen: 当前详情页屏幕 + :return: 焦点顺序列表 + """ + return [ + screen.query_one(WorkspaceSidebar), + screen.query_one(SectionNavigator), + screen.query_one(SectionDetailView), + ] + + def get_default_scroll_target( + self, + screen: 'DetailScreen', + ) -> ScrollableContainer: + """ + 返回详情页默认滚动容器。 + + :param screen: 当前详情页屏幕 + :return: 主工作区滚动容器 + """ + return screen.query_one('#workspace-main', ScrollableContainer) + + +class DetailScreen(ScreenInteractionActionsMixin, ScreenFocusActionsMixin, Screen[None]): + """ + TUI 通用详情屏幕。 + + :param snapshot: 页面快照 + """ + + BINDINGS = [ + Binding('left', 'focus_left', TUI_COPY.build_internal_binding_label('focus_left'), show=False), + Binding('right', 'focus_right', TUI_COPY.build_internal_binding_label('focus_right'), show=False), + Binding('j', 'scroll_focus_down', TUI_COPY.build_internal_binding_label('scroll_down'), show=False), + Binding('k', 'scroll_focus_up', TUI_COPY.build_internal_binding_label('scroll_up'), show=False), + Binding('pagedown', 'scroll_focus_page_down', TUI_COPY.build_internal_binding_label('page_down'), show=False), + Binding('pageup', 'scroll_focus_page_up', TUI_COPY.build_internal_binding_label('page_up'), show=False), + Binding('home', 'scroll_focus_home', TUI_COPY.build_internal_binding_label('home'), show=False), + Binding('end', 'scroll_focus_end', TUI_COPY.build_internal_binding_label('end'), show=False), + Binding('x', 'trigger_primary_action', TUI_COPY.build_internal_binding_label('action_primary'), show=False), + Binding('z', 'trigger_secondary_action', TUI_COPY.build_internal_binding_label('action_secondary'), show=False), + Binding('y', 'trigger_global_action', TUI_COPY.build_internal_binding_label('action_global'), show=False), + Binding('w', 'trigger_utility_action', TUI_COPY.build_internal_binding_label('action_utility'), show=False), + Binding('/', 'open_search', TUI_COPY.build_internal_binding_label('search'), show=False), + Binding('backspace', 'clear_search', TUI_COPY.build_internal_binding_label('clear_search'), show=False), + ] + + def __init__( + self, + snapshot: DetailPageSnapshot, + env: str, + active_view: str, + navigation_items: list[NavigationItem], + refreshed_at: str, + support: DetailScreenSupport | None = None, + focus_service: DetailScreenFocusService | None = None, + ) -> None: + """ + 初始化通用详情屏幕。 + + :param snapshot: 页面快照 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param navigation_items: 导航项列表 + :param refreshed_at: 本次刷新时间 + :param support: 详情页屏幕支持对象 + :param focus_service: 详情页焦点服务 + :return: None + """ + self.snapshot = snapshot + self.env = env + self.active_view = active_view + self.navigation_items = navigation_items + self.refreshed_at = refreshed_at + self.selected_section_index = 0 + self._last_action_result: TuiActionResult | None = None + self._action_feedback_lines: list[str] = [] + self._action_task: asyncio.Task[None] | None = None + self.support = support or DetailScreenSupport() + self.focus_service = focus_service or DetailScreenFocusService() + super().__init__() + + @staticmethod + def _cancel_task(task: asyncio.Task[None] | None) -> None: + """ + 取消指定后台任务。 + + :param task: 待取消任务 + :return: None + """ + if task is None or task.done(): + return + task.cancel() + + def _get_section_or_fallback(self, index: int) -> DetailSectionSnapshot: + """ + 获取指定索引的分区快照,缺失时返回兜底分区。 + + :param index: 分区索引 + :return: 分区快照 + """ + if 0 <= index < len(self.snapshot.sections): + return self.snapshot.sections[index] + return self.support.build_empty_section() + + def _build_summary_text(self) -> str: + """ + 构建详情页摘要文本。 + + :return: 摘要文本 + """ + return self.support.build_summary_text(self.snapshot, self.active_view) + + def _current_search_query(self) -> str: + return self.support.current_search_query(self.snapshot) + + def _open_search(self) -> None: + """ + 打开当前详情页搜索输入弹窗。 + + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.open_search_dialog( + self, + self.snapshot.search, + self._handle_search_submitted, + ) + + def _handle_search_submitted(self, query: str | None) -> None: + """ + 处理详情页搜索输入结果。 + + :param query: 搜索词 + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.remember_query_and_refresh(self, self.active_view, query) + + def _clear_search(self) -> None: + """ + 清空当前详情页搜索词。 + + :return: None + """ + TUI_SCREEN_INTERACTION_SERVICE.clear_query_and_refresh( + self, + self.active_view, + self._current_search_query(), + ) + + def _resolve_action(self, slot: str) -> TuiActionSpec | None: + """ + 解析当前详情页指定槽位对应的动作。 + + :param slot: 动作槽位 + :return: 动作定义 + """ + return self.support.resolve_action(active_view=self.active_view, slot=slot, env=self.env) + + def _open_action_confirm(self, slot: str) -> None: + """ + 打开指定槽位动作的确认弹窗。 + + :param slot: 动作槽位 + :return: None + """ + self._action_task = TUI_SCREEN_INTERACTION_SERVICE.confirm_and_schedule_action( + self, + self._resolve_action(slot), + self._action_task, + self._execute_action, + ) + + async def _execute_action(self, action: TuiActionSpec) -> None: + """ + 执行详情页动作。 + + :param action: 动作定义 + :return: None + """ + + def _handle_result(result: TuiActionResult, feedback_lines: list[str]) -> None: + self._last_action_result = result + self._action_feedback_lines = feedback_lines + + await TUI_SCREEN_INTERACTION_SERVICE.execute_action_with_feedback( + self, + action, + self.env, + self.active_view, + _handle_result, + ) + + def _update_selected_section(self, index: int) -> None: + """ + 更新当前选中分区,并同步右侧详情视图。 + + :param index: 待选中的分区索引 + :return: None + """ + if not self.snapshot.sections: + detail_view = self.query_one(SectionDetailView) + detail_view.show_section(self._get_section_or_fallback(index), query=self._current_search_query()) + return + if not 0 <= index < len(self.snapshot.sections): + return + self.selected_section_index = index + detail_view = self.query_one(SectionDetailView) + detail_view.show_section(self.snapshot.sections[index], query=self._current_search_query()) + + def compose(self) -> ComposeResult: + """ + 构建详情页界面结构。 + + :return: Textual 组件结果 + """ + yield WorkspaceHeader(self.env, self.active_view) + with Horizontal(id='workspace-shell'): + yield WorkspaceSidebar(self.env, self.navigation_items, self.active_view) + with ScrollableContainer(id='workspace-main'): + yield WorkspaceHero( + title=self.snapshot.title, + subtitle=self.snapshot.subtitle, + env=self.env, + active_view=self.active_view, + summary=self._build_summary_text(), + refreshed_at=self.refreshed_at, + ) + with Horizontal(id='detail-body'): + yield SectionNavigator( + self.snapshot.sections, + initial_index=self.selected_section_index, + query=self._current_search_query(), + ) + yield SectionDetailView( + self._get_section_or_fallback(self.selected_section_index), + query=self._current_search_query(), + ) + yield Footer() + + def on_mount(self) -> None: + """ + 详情页挂载后默认将焦点停留在左侧导航。 + + :return: None + """ + self.call_after_refresh(self.query_one(WorkspaceSidebar).focus) + + def on_unmount(self) -> None: + """ + 详情页卸载时取消尚未完成的后台任务。 + + :return: None + """ + self._cancel_task(self._action_task) + + def _open_sidebar_item(self, event: WorkspaceSidebar.Highlighted | WorkspaceSidebar.Selected) -> None: + """ + 根据侧边栏事件打开对应视图,并避免重复打开当前页面。 + + :param event: 侧边栏高亮或选中事件 + :return: None + """ + item = getattr(event.item, 'item', None) + if not isinstance(item, NavigationItem): + return + if item.view_key == self.active_view: + return + self.app.open_view(item.view_key) + + @on(WorkspaceSidebar.Selected) + def on_sidebar_selected(self, event: WorkspaceSidebar.Selected) -> None: + """ + 响应左侧导航选中事件并切换视图。 + + :param event: 导航选中事件 + :return: None + """ + self._open_sidebar_item(event) + + @on(WorkspaceSidebar.Highlighted) + def on_sidebar_highlighted(self, event: WorkspaceSidebar.Highlighted) -> None: + """ + 响应左侧导航高亮变更并立即切换视图。 + + :param event: 导航高亮事件 + :return: None + """ + self._open_sidebar_item(event) + + @on(SectionNavigator.Changed) + def on_section_changed(self, event: SectionNavigator.Changed) -> None: + """ + 响应分区导航高亮变更并更新详情内容。 + + :param event: 分区导航高亮事件 + :return: None + """ + self._update_selected_section(event.index) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/focus.py b/shierfeng-fastapi-backend/cli/tui/screens/focus.py new file mode 100644 index 0000000..fa3a00e --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/focus.py @@ -0,0 +1,152 @@ +from abc import ABC, abstractmethod +from typing import Any + +from textual.containers import ScrollableContainer + + +class BaseScreenFocusService(ABC): + """ + TUI 屏幕焦点服务基类。 + + 该基类统一处理焦点顺序中的左右移动和滚动目标回退逻辑,具体页面 + 只需声明自身的焦点顺序和默认滚动容器。 + """ + + @abstractmethod + def get_focus_order(self, screen: Any) -> list[Any]: + """ + 返回当前页面的焦点顺序。 + + :param screen: 当前屏幕对象 + :return: 焦点组件列表 + """ + + @abstractmethod + def get_default_scroll_target(self, screen: Any) -> ScrollableContainer: + """ + 返回当前页面的默认滚动容器。 + + :param screen: 当前屏幕对象 + :return: 默认滚动容器 + """ + + def move_focus(self, screen: Any, step: int) -> None: + """ + 按给定方向移动当前焦点。 + + :param screen: 当前屏幕对象 + :param step: 焦点移动步长 + :return: None + """ + order = self.get_focus_order(screen) + focused = screen.app.focused + if focused not in order: + order[0].focus() + return + target_index = max(0, min(order.index(focused) + step, len(order) - 1)) + order[target_index].focus() + + def get_scroll_target(self, screen: Any) -> Any: + """ + 获取当前应响应滚动动作的焦点区域。 + + :param screen: 当前屏幕对象 + :return: 当前焦点组件或默认滚动容器 + """ + focused = screen.app.focused + order = self.get_focus_order(screen) + if focused in order: + return focused + return self.get_default_scroll_target(screen) + + +class ScreenFocusActionsMixin: + """ + TUI 屏幕焦点动作混入。 + + 该混入负责将焦点服务暴露为屏幕上的左右移动与滚动 action,避免 + 各个 Screen 类重复编写同形转发方法。 + """ + + focus_service: BaseScreenFocusService + + def _move_focus(self, step: int) -> None: + """ + 按给定方向移动当前焦点。 + + :param step: 焦点移动步长 + :return: None + """ + self.focus_service.move_focus(self, step) + + def _get_scroll_target(self) -> Any: + """ + 获取当前应响应滚动动作的焦点区域。 + + :return: 当前焦点组件或主工作区 + """ + return self.focus_service.get_scroll_target(self) + + def action_scroll_focus_down(self) -> None: + """ + 向下滚动当前焦点区域。 + + :return: None + """ + self._get_scroll_target().scroll_down(animate=False) + + def action_scroll_focus_up(self) -> None: + """ + 向上滚动当前焦点区域。 + + :return: None + """ + self._get_scroll_target().scroll_up(animate=False) + + def action_scroll_focus_page_down(self) -> None: + """ + 向下翻动当前焦点区域。 + + :return: None + """ + self._get_scroll_target().scroll_page_down(animate=False) + + def action_scroll_focus_page_up(self) -> None: + """ + 向上翻动当前焦点区域。 + + :return: None + """ + self._get_scroll_target().scroll_page_up(animate=False) + + def action_scroll_focus_home(self) -> None: + """ + 将当前焦点区域滚动到起始位置。 + + :return: None + """ + self._get_scroll_target().scroll_home(animate=False) + + def action_scroll_focus_end(self) -> None: + """ + 将当前焦点区域滚动到末尾位置。 + + :return: None + """ + self._get_scroll_target().scroll_end(animate=False) + + def action_focus_left(self) -> None: + """ + 将焦点向左移动一列。 + + :return: None + """ + self._move_focus(-1) + + def action_focus_right(self) -> None: + """ + 将焦点向右移动一列。 + + :return: None + """ + self._move_focus(1) diff --git a/shierfeng-fastapi-backend/cli/tui/screens/interactions.py b/shierfeng-fastapi-backend/cli/tui/screens/interactions.py new file mode 100644 index 0000000..208469a --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/interactions.py @@ -0,0 +1,331 @@ +import asyncio +import inspect +from collections.abc import Awaitable, Callable +from typing import Any + +from textual.app import SuspendNotSupported + +from cli.tui.actions import ( + TUI_ACTION_EXECUTION_SERVICE, + TUI_ACTION_PRESENTATION_SERVICE, + TuiActionResult, + TuiActionSpec, +) +from cli.tui.copy import TUI_COPY +from cli.tui.screens.confirm import ActionConfirmScreen +from cli.tui.screens.search import SearchInputScreen +from cli.tui.search import PageSearchContext +from cli.tui.widgets import WorkspaceSidebar + + +class TuiScreenInteractionService: + """ + TUI 屏幕交互服务。 + + 该服务负责搜索弹窗、搜索状态写回、动作确认弹窗和动作执行通知等 + 屏幕级交互流程,减少浏览页与详情页之间的重复控制逻辑。 + """ + + @staticmethod + def open_search_dialog( + screen: Any, + search_context: PageSearchContext | None, + callback: Callable[[str | None], None], + ) -> None: + """ + 打开搜索输入弹窗。 + + :param screen: 当前屏幕对象 + :param search_context: 搜索上下文 + :param callback: 提交搜索词后的回调 + :return: None + """ + if search_context is None: + return + screen.app.push_screen( + SearchInputScreen( + '页内搜索', + search_context.placeholder, + search_context.query, + search_context.suggestions, + ), + callback=callback, + ) + + @staticmethod + def remember_query_and_refresh(screen: Any, active_view: str, query: str | None) -> None: + """ + 记录当前页面搜索词并刷新页面。 + + :param screen: 当前屏幕对象 + :param active_view: 当前页面视图标识 + :param query: 搜索词 + :return: None + """ + if query is None: + return + remember_query = getattr(screen.app, 'remember_browser_query', None) + if callable(remember_query): + remember_query(active_view, query) + screen.app.action_refresh_current_view() + + def clear_query_and_refresh(self, screen: Any, active_view: str, current_query: str) -> None: + """ + 清空当前页面搜索词并刷新页面。 + + :param screen: 当前屏幕对象 + :param active_view: 当前页面视图标识 + :param current_query: 当前搜索词 + :return: None + """ + if not current_query: + return + self.remember_query_and_refresh(screen, active_view, '') + + @staticmethod + def open_action_confirm( + screen: Any, + action: TuiActionSpec | None, + callback: Callable[[bool | None, TuiActionSpec], None], + ) -> None: + """ + 打开动作确认弹窗。 + + :param screen: 当前屏幕对象 + :param action: 待执行动作 + :param callback: 确认回调 + :return: None + """ + if action is None: + screen.notify( + TUI_COPY.build_action_unavailable_message(), + title=TUI_COPY.build_action_notification_title(), + severity='warning', + ) + return + screen.app.push_screen( + ActionConfirmScreen(action.preview_title, action.preview_lines, action.label), + callback=lambda confirmed, action=action: callback(confirmed, action), + ) + + @staticmethod + def schedule_action_task( + existing_task: asyncio.Task[None] | None, + action: TuiActionSpec, + execute_callback: Callable[[TuiActionSpec], Awaitable[None]], + ) -> asyncio.Task[None]: + """ + 安排动作执行任务,并在必要时取消旧任务。 + + :param existing_task: 现有动作任务 + :param action: 待执行动作 + :param execute_callback: 动作执行协程工厂 + :return: 新建任务 + """ + if existing_task is not None and not existing_task.done(): + existing_task.cancel() + return asyncio.create_task(execute_callback(action)) + + def confirm_and_schedule_action( + self, + screen: Any, + action: TuiActionSpec | None, + existing_task: asyncio.Task[None] | None, + execute_callback: Callable[[TuiActionSpec], Awaitable[None]], + ) -> asyncio.Task[None] | None: + """ + 统一处理动作确认结果,并在确认后调度后台执行任务。 + + :param screen: 当前屏幕对象 + :param action: 待执行动作 + :param existing_task: 当前已有动作任务 + :param execute_callback: 动作执行协程工厂 + :return: 新建任务或原任务 + """ + if action is None: + self.open_action_confirm(screen, action, lambda confirmed, action_spec: None) + return existing_task + + scheduled_task = existing_task + + def _handle_confirmed(confirmed: bool | None, action_spec: TuiActionSpec) -> None: + nonlocal scheduled_task + if not confirmed: + return + scheduled_task = self.schedule_action_task( + scheduled_task, + action_spec, + execute_callback, + ) + + self.open_action_confirm(screen, action, _handle_confirmed) + return scheduled_task + + async def execute_action( + self, + screen: Any, + action: TuiActionSpec, + env: str, + active_view: str, + *, + on_result: Callable[[TuiActionResult, list[str]], Any] | None = None, + ) -> TuiActionResult: + """ + 执行屏幕动作并统一处理通知、反馈持久化与刷新。 + + :param screen: 当前屏幕对象 + :param action: 动作定义 + :param env: 当前运行环境 + :param active_view: 当前页面视图标识 + :param on_result: 动作结果回调 + :return: 动作结果 + """ + screen.notify( + TUI_COPY.build_action_running_message(action.label), + title=TUI_COPY.build_action_notification_title(), + ) + if action.execution_mode == 'external': + try: + with screen.app.suspend(): + result = TUI_ACTION_EXECUTION_SERVICE.execute_external(action) + except SuspendNotSupported: + result = TuiActionResult( + spec=action, + external_exit_code=1, + external_message='当前终端不支持挂起 TUI,无法打开外部交互向导', + ) + else: + result = await asyncio.to_thread(TUI_ACTION_EXECUTION_SERVICE.execute, action, env) + + feedback_lines = TUI_ACTION_EXECUTION_SERVICE.build_result_lines(result) + remember_feedback = getattr(screen.app, 'remember_action_feedback', None) + if callable(remember_feedback): + remember_feedback(active_view, feedback_lines) + if on_result is not None: + maybe_result = on_result(result, feedback_lines) + if inspect.isawaitable(maybe_result): + await maybe_result + screen.notify( + TUI_ACTION_PRESENTATION_SERVICE.build_action_result_message(result), + title=TUI_COPY.build_action_notification_title(), + severity='information' if result.ok else 'error', + ) + if result.ok and action.refresh_view: + screen.app.action_refresh_current_view() + return result + + async def execute_action_with_feedback( + self, + screen: Any, + action: TuiActionSpec, + env: str, + active_view: str, + feedback_callback: Callable[[TuiActionResult, list[str]], Any], + ) -> TuiActionResult: + """ + 执行动作并将统一反馈回调注入结果收口流程。 + + :param screen: 当前屏幕对象 + :param action: 动作定义 + :param env: 当前运行环境 + :param active_view: 当前页面视图标识 + :param feedback_callback: 反馈写回回调 + :return: 动作结果 + """ + return await self.execute_action( + screen, + action, + env, + active_view, + on_result=feedback_callback, + ) + + +class ScreenInteractionActionsMixin: + """ + 屏幕交互动作混入。 + + 该混入负责把搜索、动作确认和侧栏切屏这类重复桥接 action 收口为 + 通用 Screen 方法,具体页面只需实现对应的私有协作方法。 + """ + + def _open_search(self) -> None: + """ + 打开当前页面搜索输入弹窗。 + + :return: None + """ + + def _clear_search(self) -> None: + """ + 清空当前页面搜索词。 + + :return: None + """ + + def _open_action_confirm(self, slot: str) -> None: + """ + 打开指定槽位动作的确认弹窗。 + + :param slot: 动作槽位 + :return: None + """ + + def _open_sidebar_item(self, event: WorkspaceSidebar.Highlighted | WorkspaceSidebar.Selected) -> None: + """ + 根据侧栏事件打开对应视图。 + + :param event: 侧栏事件 + :return: None + """ + + def action_open_search(self) -> None: + """ + 打开当前页面搜索输入。 + + :return: None + """ + self._open_search() + + def action_clear_search(self) -> None: + """ + 清空当前页面搜索词。 + + :return: None + """ + self._clear_search() + + def action_trigger_primary_action(self) -> None: + """ + 触发当前页面主动作。 + + :return: None + """ + self._open_action_confirm('primary') + + def action_trigger_secondary_action(self) -> None: + """ + 触发当前页面次动作。 + + :return: None + """ + self._open_action_confirm('secondary') + + def action_trigger_global_action(self) -> None: + """ + 触发当前页面全局动作。 + + :return: None + """ + self._open_action_confirm('global') + + def action_trigger_utility_action(self) -> None: + """ + 触发当前页面工具动作。 + + :return: None + """ + self._open_action_confirm('utility') + + +TUI_SCREEN_INTERACTION_SERVICE = TuiScreenInteractionService() diff --git a/shierfeng-fastapi-backend/cli/tui/screens/search.py b/shierfeng-fastapi-backend/cli/tui/screens/search.py new file mode 100644 index 0000000..fac67be --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/search.py @@ -0,0 +1,80 @@ +from textual import on +from textual.app import ComposeResult +from textual.binding import Binding +from textual.containers import Vertical +from textual.screen import ModalScreen +from textual.widgets import Input, Static + +from cli.tui.copy import TUI_COPY + + +class SearchInputScreen(ModalScreen[str | None]): + """ + 通用搜索输入弹窗。 + + :param title: 弹窗标题 + :param placeholder: 输入框提示 + :param value: 当前搜索词 + :param suggestions: 候选建议 + """ + + CSS = """ + SearchInputScreen { + align: center middle; + } + + #search-dialog { + width: 88; + max-width: 88; + border: heavy #38d8ff; + background: #06111b; + padding: 1 2; + } + + #search-title { + text-style: bold; + color: #e9fcff; + margin-bottom: 1; + } + + #search-input { + margin-bottom: 1; + } + + #search-suggestions { + color: #8fc6d6; + } + """ + + BINDINGS = [ + Binding('escape', 'cancel', TUI_COPY.build_confirm_binding_label('cancel'), show=False), + Binding('enter', 'submit', TUI_COPY.build_confirm_binding_label('submit'), show=False), + ] + + def __init__(self, title: str, placeholder: str, value: str, suggestions: list[str]) -> None: + super().__init__() + self._title = title + self._placeholder = placeholder + self._value = value + self._suggestions = suggestions + + def compose(self) -> ComposeResult: + with Vertical(id='search-dialog'): + yield Static(self._title, id='search-title', markup=False) + yield Input(value=self._value, placeholder=self._placeholder, id='search-input') + suggestion_text = '候选建议 · ' + (' '.join(self._suggestions[:6]) if self._suggestions else '暂无建议') + yield Static(suggestion_text, id='search-suggestions', markup=False) + + def on_mount(self) -> None: + self.call_after_refresh(self.query_one('#search-input', Input).focus) + + def action_cancel(self) -> None: + self.dismiss(None) + + def action_submit(self) -> None: + input_widget = self.query_one('#search-input', Input) + self.dismiss(str(input_widget.value or '').strip()) + + @on(Input.Submitted, '#search-input') + def on_input_submitted(self) -> None: + self.action_submit() diff --git a/shierfeng-fastapi-backend/cli/tui/screens/summary.py b/shierfeng-fastapi-backend/cli/tui/screens/summary.py new file mode 100644 index 0000000..f359cc8 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/screens/summary.py @@ -0,0 +1,59 @@ +from collections.abc import Iterable +from dataclasses import dataclass +from typing import Protocol + + +class StatusCarrier(Protocol): + """ + 状态载体协议。 + + 该协议用于描述首页面板、详情分区和浏览记录这类具备 `status` + 属性的摘要统计对象。 + """ + + status: str + + +@dataclass(frozen=True) +class StatusSummary: + """ + 状态摘要统计结果。 + + :param total_count: 总数量 + :param ok_count: 正常数量 + :param warn_count: 警告数量 + :param fail_count: 失败数量 + """ + + total_count: int + ok_count: int + warn_count: int + fail_count: int + + +class StatusSummaryBuilder: + """ + 状态摘要构建器。 + + 该对象负责对带 `status` 属性的集合做统一计数,供 dashboard、 + detail、browser 三类 screen support 复用。 + """ + + @staticmethod + def build(items: Iterable[StatusCarrier]) -> StatusSummary: + """ + 统计状态摘要。 + + :param items: 待统计对象集合 + :return: 状态摘要 + """ + materialized = list(items) + return StatusSummary( + total_count=len(materialized), + ok_count=sum(1 for item in materialized if item.status == 'ok'), + warn_count=sum(1 for item in materialized if item.status == 'warn'), + fail_count=sum(1 for item in materialized if item.status == 'fail'), + ) + + +STATUS_SUMMARY_BUILDER = StatusSummaryBuilder() diff --git a/shierfeng-fastapi-backend/cli/tui/search.py b/shierfeng-fastapi-backend/cli/tui/search.py new file mode 100644 index 0000000..9990549 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/search.py @@ -0,0 +1,375 @@ +from collections.abc import Callable +from dataclasses import dataclass, field + +from cli.completion.providers import COMPLETION_PROVIDER_GATEWAY, CompletionProviderGateway + +CompletionProviderCallable = Callable[[object, list[str] | None, str], list[str]] + + +@dataclass(frozen=True) +class PageFilterOption: + """ + 浏览页筛选项定义。 + + :param key: 筛选键 + :param label: 展示名称 + :param shortcut: 快捷键 + """ + + key: str + label: str + shortcut: str + + +@dataclass(frozen=True) +class PageSearchContext: + """ + 浏览页搜索上下文定义。 + + :param placeholder: 搜索输入提示 + :param query: 当前搜索词 + :param suggestions: 候选建议列表 + """ + + placeholder: str + query: str = '' + suggestions: list[str] = field(default_factory=list) + + +@dataclass(frozen=True) +class SearchSuggestionProviderSpec: + """ + 页面搜索建议提供者定义。 + + :param placeholder: 搜索输入提示 + :param suggestion_provider: 候选建议提供函数 + """ + + placeholder: str + suggestion_provider: Callable[[str], list[str]] | None = None + + +JOB_FILTER_OPTIONS: tuple[PageFilterOption, ...] = ( + PageFilterOption('all', '全部', '1'), + PageFilterOption('failed', '失败', '2'), + PageFilterOption('paused', '暂停', '3'), + PageFilterOption('ok', '正常', '4'), +) + +CONFIG_FILTER_OPTIONS: tuple[PageFilterOption, ...] = ( + PageFilterOption('all', '全部', '1'), + PageFilterOption('risky', '高风险', '2'), + PageFilterOption('mismatch', '值不一致', '3'), + PageFilterOption('cache-drift', '缓存异常', '4'), +) + + +class TuiSearchSuggestionProviderRegistry: + """ + TUI 搜索建议提供者注册表。 + + 该对象负责管理页面搜索提示文案及其候选建议提供函数,避免搜索服务 + 继续通过字符串反射隐式定位 completion provider。 + + :param providers: 页面搜索提供者映射 + """ + + def __init__(self, providers: dict[str, SearchSuggestionProviderSpec]) -> None: + """ + 初始化搜索建议提供者注册表。 + + :param providers: 页面搜索提供者映射 + :return: None + """ + self.providers = {self.normalize_view_key(key): value for key, value in providers.items()} + + @staticmethod + def normalize_view_key(view_key: str) -> str: + """ + 规范化页面视图标识。 + + :param view_key: 原始页面视图标识 + :return: 规范化后的页面视图标识 + """ + return str(view_key or '').strip().lower() + + def get_provider(self, view_key: str) -> SearchSuggestionProviderSpec | None: + """ + 获取指定页面的搜索建议提供者。 + + :param view_key: 页面视图标识 + :return: 搜索建议提供者定义 + """ + return self.providers.get(self.normalize_view_key(view_key)) + + +class CompletionSuggestionProviderFactory: + """ + 基于 completion 注册表构建 TUI 搜索建议提供函数。 + + :param completion_provider_gateway: completion 提供器对外网关 + """ + + def __init__(self, completion_provider_gateway: CompletionProviderGateway) -> None: + """ + 初始化 completion 搜索建议工厂。 + + :param completion_provider_gateway: completion 提供器对外网关 + :return: None + """ + self.completion_provider_gateway = completion_provider_gateway + + def build(self, provider: CompletionProviderCallable) -> Callable[[str], list[str]]: + """ + 根据显式 completion provider 构建建议提供函数。 + + :param provider: completion provider 可调用对象 + :return: 搜索建议提供函数 + """ + + def provide(query: str) -> list[str]: + """ + 调用 completion provider 生成候选建议。 + + :param query: 当前搜索词 + :return: 候选建议列表 + """ + candidates = provider(None, [], str(query or '').strip()) + return [str(candidate).strip() for candidate in candidates if str(candidate).strip()] + + return provide + + +def build_default_search_provider_registry( + completion_provider_gateway: CompletionProviderGateway, +) -> TuiSearchSuggestionProviderRegistry: + """ + 构建默认 TUI 搜索建议提供者注册表。 + + :param completion_provider_gateway: completion 提供器对外网关 + :return: 搜索建议提供者注册表 + """ + provider_factory = CompletionSuggestionProviderFactory(completion_provider_gateway) + return TuiSearchSuggestionProviderRegistry( + providers={ + 'jobs': SearchSuggestionProviderSpec( + '按任务名搜索', + provider_factory.build(completion_provider_gateway.complete_job_names), + ), + 'configs': SearchSuggestionProviderSpec( + '按配置键搜索', + provider_factory.build(completion_provider_gateway.complete_config_keys), + ), + 'cache': SearchSuggestionProviderSpec( + '按缓存名搜索', + provider_factory.build(completion_provider_gateway.complete_cache_names), + ), + 'gen': SearchSuggestionProviderSpec( + '按业务表名搜索', + provider_factory.build(completion_provider_gateway.complete_gen_table_names), + ), + 'database': SearchSuggestionProviderSpec( + '按 revision 搜索', + provider_factory.build(completion_provider_gateway.complete_alembic_revisions), + ), + 'app': SearchSuggestionProviderSpec('按分区或内容搜索'), + 'ops': SearchSuggestionProviderSpec('按分区或内容搜索'), + 'crypto': SearchSuggestionProviderSpec('按分区或内容搜索'), + } + ) + + +class TuiSearchHighlighter: + """ + TUI 搜索高亮器。 + + 该对象负责对终端文本做轻量关键字高亮。 + """ + + @staticmethod + def highlight(text: str, query: str, *, left_tag: str = '【', right_tag: str = '】') -> str: + """ + 对给定文本中的搜索词做轻量高亮。 + + :param text: 原始文本 + :param query: 搜索词 + :param left_tag: 左高亮标记 + :param right_tag: 右高亮标记 + :return: 高亮后的文本 + """ + raw_text = str(text or '') + normalized_query = str(query or '').strip() + if not raw_text or not normalized_query: + return raw_text + lower_text = raw_text.lower() + lower_query = normalized_query.lower() + result: list[str] = [] + cursor = 0 + query_length = len(normalized_query) + while True: + index = lower_text.find(lower_query, cursor) + if index < 0: + result.append(raw_text[cursor:]) + break + result.append(raw_text[cursor:index]) + result.append(f'{left_tag}{raw_text[index : index + query_length]}{right_tag}') + cursor = index + query_length + return ''.join(result) + + +class TuiSearchService: + """ + TUI 搜索服务。 + + 该对象负责筛选项解析、筛选条文案构建、搜索上下文装配和详情分区过滤。 + """ + + def __init__(self, provider_registry: TuiSearchSuggestionProviderRegistry) -> None: + """ + 初始化 TUI 搜索服务。 + + :param provider_registry: 页面搜索建议提供者注册表 + :return: None + """ + self.provider_registry = provider_registry + + @staticmethod + def resolve_filter_option( + options: list[PageFilterOption] | tuple[PageFilterOption, ...], + filter_key: str | None, + ) -> PageFilterOption | None: + """ + 从筛选项列表中解析指定键对应的筛选定义。 + + :param options: 筛选项列表 + :param filter_key: 筛选键 + :return: 匹配到的筛选项 + """ + normalized_key = str(filter_key or '').strip().lower() + if not normalized_key: + return None + for option in options: + if option.key == normalized_key: + return option + return None + + def build_filter_bar_text( + self, + options: list[PageFilterOption] | tuple[PageFilterOption, ...], + active_filter_key: str | None, + *, + search_query: str | None = None, + search_placeholder: str | None = None, + search_suggestions: list[str] | None = None, + ) -> str: + """ + 构建浏览页顶部筛选条文本。 + + :param options: 筛选项列表 + :param active_filter_key: 当前激活筛选键 + :param search_query: 当前搜索词 + :param search_placeholder: 搜索提示文本 + :param search_suggestions: 搜索候选建议 + :return: 筛选条文本 + """ + if not options and not search_placeholder: + return '' + lines: list[str] = [] + normalized_active = str(active_filter_key or '').strip().lower() + if options: + rendered_items = [ + f'[{option.shortcut}] {option.label}{" *" if option.key == normalized_active else ""}' + for option in options + ] + active_option = self.resolve_filter_option(options, normalized_active) + active_label = active_option.label if active_option is not None else '未指定' + lines.extend( + [ + f'筛选器 · {" ".join(rendered_items)}', + f'当前筛选 · {active_label}', + ] + ) + if search_placeholder: + normalized_query = str(search_query or '').strip() + lines.append(f'搜索器 · [/] {search_placeholder}') + lines.append(f'当前搜索 · {normalized_query or "未指定"} | [Backspace] 清空') + if search_suggestions: + lines.append(f'候选建议 · {" ".join(search_suggestions[:4])}') + return '\n'.join(lines) + + def resolve_search_context( + self, + view_key: str, + query: str = '', + *, + default_suggestions: list[str] | None = None, + ) -> PageSearchContext | None: + """ + 根据页面视图解析搜索上下文,并复用 completion provider 生成候选建议。 + + :param view_key: 当前页面视图标识 + :param query: 当前搜索词 + :param default_suggestions: 缺省候选建议 + :return: 搜索上下文 + """ + normalized_view = str(view_key).strip().lower() + provider_spec = self.provider_registry.get_provider(normalized_view) + if provider_spec is None: + return None + suggestions = self.resolve_search_suggestions(provider_spec, query) + if not suggestions and default_suggestions: + normalized_query = str(query or '').strip().lower() + suggestions = [ + suggestion + for suggestion in default_suggestions + if suggestion and (not normalized_query or normalized_query in suggestion.lower()) + ] + return PageSearchContext( + placeholder=provider_spec.placeholder, + query=str(query or '').strip(), + suggestions=suggestions[:6], + ) + + @staticmethod + def resolve_search_suggestions(provider_spec: SearchSuggestionProviderSpec, query: str) -> list[str]: + """ + 调用搜索建议提供函数生成当前搜索词的候选建议。 + + :param provider_spec: 搜索建议提供者定义 + :param query: 当前搜索词 + :return: 候选建议列表 + """ + normalized_query = str(query or '').strip() + if not normalized_query or not callable(provider_spec.suggestion_provider): + return [] + try: + candidates = provider_spec.suggestion_provider(normalized_query) + except Exception: + return [] + return [str(candidate).strip() for candidate in candidates if str(candidate).strip()] + + @staticmethod + def filter_detail_sections(sections: list[object], query: str) -> list[object]: + """ + 按搜索词过滤详情页分区列表。 + + :param sections: 原始分区列表 + :param query: 当前搜索词 + :return: 过滤后的分区列表 + """ + normalized_query = str(query or '').strip().lower() + if not normalized_query: + return sections + filtered_sections: list[object] = [] + for section in sections: + title = str(getattr(section, 'title', '') or '').strip().lower() + lines = getattr(section, 'lines', []) + joined_lines = ' '.join(str(line).strip().lower() for line in lines if str(line).strip()) + if normalized_query in title or normalized_query in joined_lines: + filtered_sections.append(section) + return filtered_sections + + +TUI_SEARCH_HIGHLIGHTER = TuiSearchHighlighter() +TUI_SEARCH_PROVIDER_REGISTRY = build_default_search_provider_registry(COMPLETION_PROVIDER_GATEWAY) +TUI_SEARCH_SERVICE = TuiSearchService(TUI_SEARCH_PROVIDER_REGISTRY) diff --git a/shierfeng-fastapi-backend/cli/tui/widgets/__init__.py b/shierfeng-fastapi-backend/cli/tui/widgets/__init__.py new file mode 100644 index 0000000..d51fc91 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/widgets/__init__.py @@ -0,0 +1,27 @@ +from cli.tui.widgets.status_panel import MetricPanel, SignalRail, StatusPanel +from cli.tui.widgets.workspace import ( + NavigationItem, + RecordDetailView, + RecordNavigator, + RecordSummaryView, + SectionDetailView, + SectionNavigator, + WorkspaceHeader, + WorkspaceHero, + WorkspaceSidebar, +) + +__all__ = [ + 'MetricPanel', + 'NavigationItem', + 'RecordDetailView', + 'RecordNavigator', + 'RecordSummaryView', + 'SectionDetailView', + 'SectionNavigator', + 'SignalRail', + 'StatusPanel', + 'WorkspaceHeader', + 'WorkspaceHero', + 'WorkspaceSidebar', +] diff --git a/shierfeng-fastapi-backend/cli/tui/widgets/status_panel.py b/shierfeng-fastapi-backend/cli/tui/widgets/status_panel.py new file mode 100644 index 0000000..6e31ea9 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/widgets/status_panel.py @@ -0,0 +1,323 @@ +from textual.widgets import Static + +from cli.tui.copy import TUI_COPY + + +class StatusPanelRenderingSupport: + """ + 状态面板渲染支持对象。 + + 该对象负责状态类名解析、结构化正文渲染和信号带脉冲文本构建, + 供状态面板、指标卡与信号带组件复用。 + """ + + PULSE_FRAMES = ['·', '•', '◉', '•'] + + @staticmethod + def resolve_status_class(status: str) -> str: + """ + 根据状态值解析样式类。 + + :param status: 面板状态 + :return: 状态样式类名 + """ + normalized_status = str(status).strip().lower() + if normalized_status in {'ok', 'success', 'healthy'}: + return 'is-ok' + if normalized_status in {'fail', 'error', 'down'}: + return 'is-fail' + if normalized_status in {'warn', 'warning', 'degraded'}: + return 'is-warn' + return 'is-info' + + def render_structured_body(self, body: str) -> str: + """ + 将结构化正文文本渲染为更有层次的终端块内容。 + + 支持以下约定: + - `## ` 开头:分组标题 + - `> ` 开头:说明或子项 + - 空字符串:保留空行 + + :param body: 原始正文文本 + :return: 渲染后的正文文本 + """ + rendered_lines: list[str] = [] + for raw_line in body.splitlines(): + stripped = raw_line.strip() + if not stripped: + if rendered_lines and rendered_lines[-1] != '': + rendered_lines.append('') + continue + if stripped.startswith('## '): + title = stripped[3:].strip() + if rendered_lines and rendered_lines[-1] != '': + rendered_lines.append('') + rendered_lines.append(f'【{title}】') + rendered_lines.append('─' * max(10, min(len(title) * 2, 28))) + continue + if stripped.startswith('> '): + rendered_lines.append(f'│ {stripped[2:].strip()}') + continue + rendered_lines.append(f'• {stripped}') + + while rendered_lines and rendered_lines[0] == '': + rendered_lines.pop(0) + while rendered_lines and rendered_lines[-1] == '': + rendered_lines.pop() + return '\n'.join(rendered_lines) if rendered_lines else f'- {TUI_COPY.build_status_panel_empty_text()}' + + def build_signal_rail_text(self, lines: list[str], pulse_index: int) -> str: + """ + 构建信号带渲染文本。 + + :param lines: 信号文本行 + :param pulse_index: 当前脉冲帧索引 + :return: 渲染文本 + """ + pulse = self.PULSE_FRAMES[pulse_index % len(self.PULSE_FRAMES)] + body = '\n'.join(line for line in lines if line.strip()) + return TUI_COPY.build_signal_rail_text(pulse, body or TUI_COPY.build_signal_rail_empty_text()) + + +STATUS_PANEL_RENDERING = StatusPanelRenderingSupport() + + +class StatusPanel(Static): + """ + TUI 状态面板组件。 + + :param title: 面板标题 + :param status: 面板状态 + :param body: 面板正文 + """ + + DEFAULT_CSS = """ + StatusPanel { + border: double #245874; + padding: 1 2; + margin: 0; + height: 17; + min-height: 17; + background: #08131f; + color: #def8ff; + } + + StatusPanel.is-ok { + border: double #22c983; + background: #081b17; + } + + StatusPanel.is-fail { + border: double #ff6b7a; + background: #241118; + } + + StatusPanel.is-warn { + border: double #f2b84b; + background: #261d0f; + } + + StatusPanel.is-info { + border: double #38d8ff; + background: #081825; + } + + StatusPanel:focus { + border: heavy #6df7ff; + background: #10364b; + } + """ + + def __init__( + self, + title: str, + status: str, + body: str, + rendering: StatusPanelRenderingSupport | None = None, + ) -> None: + """ + 初始化状态面板。 + + :param title: 面板标题 + :param status: 面板状态 + :param body: 面板正文 + :param rendering: 状态面板渲染支持对象 + :return: None + """ + self.title = title + self.status = status + self.body = body + self.rendering = rendering or STATUS_PANEL_RENDERING + super().__init__(self._build_render_text(), markup=False) + self.can_focus = True + self.add_class(self.rendering.resolve_status_class(self.status)) + + def _build_render_text(self) -> str: + """ + 构建面板渲染文本。 + + :return: 渲染文本 + """ + rendered_body = self.rendering.render_structured_body(self.body) + normalized_status = TUI_COPY.render_status_label(self.status) + return TUI_COPY.build_status_panel_text( + self.title, + TUI_COPY.render_status_code(self.status), + normalized_status, + rendered_body, + ) + + +class MetricPanel(Static): + """ + TUI 首页驾驶舱指标卡组件。 + + :param title: 指标标题 + :param value: 指标主值 + :param status: 指标状态 + :param hint: 指标补充说明 + """ + + DEFAULT_CSS = """ + MetricPanel { + border: double #245874; + padding: 1 2; + height: 12; + min-height: 12; + background: #08131f; + color: #effcff; + } + + MetricPanel.is-primary { + border: heavy #6df7ff; + height: 12; + min-height: 12; + background: #0a1725; + text-style: bold; + } + + MetricPanel.is-ok { + border: double #22c983; + background: #081b17; + } + + MetricPanel.is-fail { + border: double #ff6b7a; + background: #241118; + } + + MetricPanel.is-warn { + border: double #f2b84b; + background: #261d0f; + } + + MetricPanel.is-info { + border: double #38d8ff; + background: #081825; + } + """ + + def __init__( + self, + title: str, + value: str, + status: str, + hint: str, + *, + accent: bool = False, + rendering: StatusPanelRenderingSupport | None = None, + ) -> None: + """ + 初始化指标卡。 + + :param title: 指标标题 + :param value: 指标主值 + :param status: 指标状态 + :param hint: 指标补充说明 + :param accent: 是否作为主指标高亮展示 + :param rendering: 状态面板渲染支持对象 + :return: None + """ + self.title = title + self.value = value + self.status = status + self.hint = hint + self.rendering = rendering or STATUS_PANEL_RENDERING + super().__init__(self._build_render_text(), markup=False) + self.add_class(self.rendering.resolve_status_class(self.status)) + if accent: + self.add_class('is-primary') + + def _build_render_text(self) -> str: + """ + 构建指标卡渲染文本。 + + :return: 渲染文本 + """ + normalized_status = TUI_COPY.render_status_label(self.status) + return TUI_COPY.build_metric_panel_text( + self.title, + self.value, + TUI_COPY.render_status_code(self.status), + normalized_status, + self.hint, + ) + + +class SignalRail(Static): + """ + 首页信号带组件,用于展示简洁的系统态势条目。 + + :param lines: 信号文本行 + """ + + DEFAULT_CSS = """ + SignalRail { + border: double #1db9d1; + padding: 1 2; + margin-top: 1; + margin-bottom: 1; + min-height: 6; + background: #06111b; + color: #e9fdff; + } + """ + + def __init__(self, lines: list[str], rendering: StatusPanelRenderingSupport | None = None) -> None: + """ + 初始化首页信号带。 + + :param lines: 信号文本行 + :param rendering: 状态面板渲染支持对象 + :return: None + """ + self.lines = lines + self._pulse_index = 0 + self.rendering = rendering or STATUS_PANEL_RENDERING + super().__init__(self._build_render_text(), markup=False) + + def on_mount(self) -> None: + """ + 挂载后启动轻量脉冲刷新。 + + :return: None + """ + self.set_interval(0.8, self._advance_pulse, name='signal rail pulse') + + def _advance_pulse(self) -> None: + """ + 推进信号带脉冲状态。 + + :return: None + """ + self._pulse_index = (self._pulse_index + 1) % 4 + self.update(self._build_render_text()) + + def _build_render_text(self) -> str: + """ + 构建信号带渲染文本。 + + :return: 渲染文本 + """ + return self.rendering.build_signal_rail_text(self.lines, self._pulse_index) diff --git a/shierfeng-fastapi-backend/cli/tui/widgets/workspace.py b/shierfeng-fastapi-backend/cli/tui/widgets/workspace.py new file mode 100644 index 0000000..52ac4af --- /dev/null +++ b/shierfeng-fastapi-backend/cli/tui/widgets/workspace.py @@ -0,0 +1,1262 @@ +from dataclasses import dataclass +from datetime import datetime +from math import sin +from time import monotonic + +from rich.text import Text +from textual.message import Message +from textual.widgets import Label, ListItem, ListView, Static + +from cli.tui.adapters.models import BrowserRecordSnapshot, DetailSectionSnapshot +from cli.tui.copy import TUI_COPY +from cli.tui.keymaps import TUI_KEYMAP_REGISTRY +from cli.tui.search import TUI_SEARCH_HIGHLIGHTER + + +class WorkspaceRenderingSupport: + """ + 工作台组件渲染支持对象。 + + 该对象负责状态徽标、状态类名、结构化文本渲染和预览提取, + 供工作台中的导航项、详情视图和摘要视图复用。 + """ + + @staticmethod + def highlight_search_text(text: str, query: str) -> str: + """ + 对工作台文本执行搜索高亮。 + + :param text: 原始文本 + :param query: 搜索词 + :return: 高亮后的文本 + """ + return TUI_SEARCH_HIGHLIGHTER.highlight(text, query) + + @staticmethod + def render_status_badge(status: str) -> str: + """ + 将状态值转换为紧凑徽标文本。 + + :param status: 原始状态值 + :return: 徽标文本 + """ + return f'[{TUI_COPY.render_status_code(status)}]' + + @staticmethod + def resolve_status_class(status: str) -> str: + """ + 根据状态值解析统一样式类。 + + :param status: 原始状态值 + :return: 状态样式类名 + """ + normalized_status = str(status).strip().lower() + if normalized_status in {'ok', 'success', 'healthy'}: + return 'is-ok' + if normalized_status in {'fail', 'error'}: + return 'is-fail' + if normalized_status in {'warn', 'warning'}: + return 'is-warn' + return 'is-info' + + @staticmethod + def strip_line_markup(line: str) -> str: + """ + 去除内部展示标记,便于提取预览文本。 + + :param line: 原始文本行 + :return: 纯文本内容 + """ + stripped = line.strip() + if stripped.startswith('## '): + return stripped[3:].strip() + if stripped.startswith('> '): + return stripped[2:].strip() + return stripped + + def build_preview_line(self, lines: list[str], fallback: str) -> str: + """ + 从结构化文本中提取首条适合作为预览的内容。 + + :param lines: 原始文本行列表 + :param fallback: 兜底文本 + :return: 预览文本 + """ + for line in lines: + preview = self.strip_line_markup(line) + if preview: + return preview + return fallback + + def render_structured_lines(self, lines: list[str], empty_text: str) -> str: + """ + 将结构化文本行渲染为适合终端展示的块文本。 + + 支持以下轻量约定: + - `## ` 开头:区块标题 + - `> ` 开头:说明或子项 + - 空字符串:保留空行 + + :param lines: 原始文本行列表 + :param empty_text: 空态提示文本 + :return: 渲染后的文本块 + """ + rendered_lines: list[str] = [] + for raw_line in lines: + stripped = raw_line.strip() + if not stripped: + if rendered_lines and rendered_lines[-1] != '': + rendered_lines.append('') + continue + if stripped.startswith('## '): + title = stripped[3:].strip() + if rendered_lines and rendered_lines[-1] != '': + rendered_lines.append('') + rendered_lines.append(f'【{title}】') + rendered_lines.append('─' * max(10, min(len(title) * 2, 30))) + continue + if stripped.startswith('> '): + rendered_lines.append(f'│ {stripped[2:].strip()}') + continue + rendered_lines.append(f'• {stripped}') + + while rendered_lines and rendered_lines[0] == '': + rendered_lines.pop(0) + while rendered_lines and rendered_lines[-1] == '': + rendered_lines.pop() + + if not rendered_lines: + return f'- {empty_text}' + return '\n'.join(rendered_lines) + + +WORKSPACE_RENDERING = WorkspaceRenderingSupport() + + +@dataclass(frozen=True) +class NavigationItem: + """ + 工作台导航项定义。 + + :param view_key: 视图唯一标识 + :param label: 导航显示名称 + :param shortcut: 快捷键 + :param description: 导航说明 + """ + + view_key: str + label: str + shortcut: str + description: str + + +class NavigationListItem(ListItem): + """ + 工作台导航列表项。 + + :param item: 导航项定义 + """ + + DEFAULT_CSS = """ + NavigationListItem { + padding: 0 1; + margin-bottom: 1; + border: round #18425d; + background: #07131f; + color: #89b9c9; + height: auto; + } + + NavigationListItem Label { + width: 1fr; + } + + NavigationListItem.is-active { + border: round #38d8ff; + background: #0a1e2d; + color: #e4fbff; + } + + NavigationListItem.is-active Label { + text-style: bold; + } + + NavigationListItem.-highlight { + border: heavy #6df7ff; + background: #10364b; + color: #ffffff; + text-style: bold; + padding-left: 2; + } + """ + + def __init__(self, item: NavigationItem, index: int, *, active: bool = False) -> None: + """ + 初始化导航列表项。 + + :param item: 导航项定义 + :return: None + """ + self.item = item + super().__init__( + Label( + '\n'.join(TUI_COPY.build_navigation_item_lines(index, item.label, item.shortcut, item.description)), + markup=False, + ) + ) + if active: + self.add_class('is-active') + + +class WorkspaceSidebar(ListView): + """ + 工作台左侧导航组件。 + + :param env: 当前运行环境 + :param items: 导航项列表 + :param active_view: 当前激活视图 + """ + + DEFAULT_CSS = """ + WorkspaceSidebar { + width: 34; + min-width: 34; + padding: 1; + margin: 1 0 1 1; + border: double #18425d; + background: #06111b; + } + + WorkspaceSidebar:focus { + border: heavy #6df7ff; + } + """ + + def __init__(self, env: str, items: list[NavigationItem], active_view: str) -> None: + """ + 初始化工作台导航组件。 + + :param env: 当前运行环境 + :param items: 导航项列表 + :param active_view: 当前激活视图 + :return: None + """ + self.env = env + self.items = items + self.active_view = active_view + initial_index = self._resolve_initial_index() + children = [ + NavigationListItem(item, index, active=item.view_key == self.active_view) + for index, item in enumerate(self.items) + ] + super().__init__(*children, initial_index=initial_index, id='workspace-sidebar') + + def _resolve_initial_index(self) -> int: + """ + 解析当前激活视图对应的导航索引。 + + :return: 初始高亮索引 + """ + for index, item in enumerate(self.items): + if item.view_key == self.active_view: + return index + return 0 + + +class WorkspaceHero(Static): + """ + 工作台顶部摘要组件。 + + :param title: 页面标题 + :param subtitle: 页面副标题 + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :param summary: 状态摘要文本 + :param refreshed_at: 本次刷新时间 + """ + + DEFAULT_CSS = """ + WorkspaceHero { + border: double #38d8ff; + padding: 1 2; + margin-bottom: 1; + min-height: 11; + background: #081827; + color: #e9fcff; + } + """ + _BORDER_PHASES = ('#2fb8df', '#38d8ff', '#62ecff', '#38d8ff') + _TITLE_GLOW_PALETTE = ('#7be8ff', '#b4f6ff', '#e9fdff', '#b4f6ff') + + def __init__( + self, + title: str, + subtitle: str, + env: str, + active_view: str, + summary: str, + refreshed_at: str, + ) -> None: + """ + 初始化工作台顶部摘要组件。 + + :param title: 页面标题 + :param subtitle: 页面副标题 + :param active_view: 当前激活视图 + :param summary: 状态摘要文本 + :param refreshed_at: 本次刷新时间 + :return: None + """ + self.title = title + self.subtitle = subtitle + self.env = env + self.active_view = active_view + self.summary = summary + self.refreshed_at = refreshed_at + super().__init__(self._build_render_text(), id='workspace-hero', markup=False) + + def on_mount(self) -> None: + """ + 在组件挂载后启动低频边框呼吸动效。 + + :return: None + """ + self.set_interval(0.9, self._pulse_border, name='pulse workspace hero border') + + def _pulse_border(self) -> None: + """ + 以低频节奏切换 Hero 边框颜色。 + + :return: None + """ + phase_index = int(monotonic() * 1.1) % len(self._BORDER_PHASES) + self.styles.border = ('double', self._BORDER_PHASES[phase_index]) + + @classmethod + def _build_title_text(cls, title: str) -> Text: + """ + 构建 Hero 标题渐变文本。 + + :param title: 标题文本 + :return: 富文本标题 + """ + rendered = Text() + palette_size = len(cls._TITLE_GLOW_PALETTE) + for index, char in enumerate(title): + rendered.append(char, style=f'bold {cls._TITLE_GLOW_PALETTE[index % palette_size]}') + return rendered + + def _build_render_text(self) -> Text: + """ + 构建顶部摘要文本。 + + :return: 渲染富文本 + """ + lines = TUI_COPY.build_workspace_hero_lines( + view_label=TUI_COPY.render_view_label(self.active_view), + title=self.title, + subtitle=self.subtitle, + env=self.env, + summary=self.summary, + refreshed_at=self.refreshed_at, + shortcut_hint=TUI_KEYMAP_REGISTRY.hero_shortcut_hint, + ) + rendered = Text() + for index, line in enumerate(lines): + if index: + rendered.append('\n') + if line.startswith('标题 · '): + rendered.append('标题 · ', style='bold #8fd9e8') + rendered.append_text(self._build_title_text(line.removeprefix('标题 · '))) + continue + rendered.append(line, style='bold #e9fcff' if index == 0 else '#d7f7ff') + return rendered + + +class WorkspaceHeader(Static): + """ + 工作台顶部状态栏。 + + :param env: 当前运行环境 + :param active_view: 当前激活视图 + """ + + DEFAULT_CSS = """ + WorkspaceHeader { + height: 2; + padding: 0 2; + background: #060d16; + color: #c7f6ff; + border-bottom: heavy #163c57; + content-align: left middle; + text-style: bold; + } + """ + _HEADER_LINE_COUNT = 2 + _SCANLINE_WIDTH = 16 + _HEADER_HORIZONTAL_PADDING = 4 + _HEADER_FALLBACK_WIDTH = 108 + _SCANLINE_BASE_STYLE = '#1c5368' + _SCANLINE_GLOW_STYLES = { + '·': '#8ef7ff', + '░': '#62ecff', + '▒': '#4ee4ff', + '▓': '#2cc9ff', + '█': '#dffcff', + } + + @classmethod + def build_scanline_text(cls, phase: float, width: int) -> Text: + """ + 构建页眉扫描线文本。 + + 通过单个高亮扫描头和两侧衰减尾迹,营造简洁的霓虹扫线效果。 + + :param phase: 当前动画相位 + :param width: 扫描线宽度 + :return: 带颜色层次的扫描线文本 + """ + cells = ['─'] * width + head_position = int(((sin(phase * 0.82) + 1) / 2) * (width - 1)) + for offset, symbol in ((-2, '·'), (-1, '░'), (0, '█'), (1, '▓'), (2, '▒')): + position = head_position + offset + if 0 <= position < width: + cells[position] = symbol + rendered = Text() + for symbol in cells: + rendered.append(symbol, style=cls._SCANLINE_GLOW_STYLES.get(symbol, cls._SCANLINE_BASE_STYLE)) + return rendered + + def __init__(self, env: str, active_view: str) -> None: + """ + 初始化工作台顶部状态栏。 + + :param env: 当前运行环境 + :param active_view: 当前激活视图 + :return: None + """ + self.env = env + self.active_view = active_view + super().__init__(id='workspace-header', markup=False) + + def on_mount(self) -> None: + """ + 在组件挂载后启动时钟刷新。 + + :return: None + """ + self.set_interval(0.18, self.refresh, name='update workspace header') + + def build_scanline_text_label(self) -> Text: + """ + 构建扫描线文本。 + + :return: 扫描线文本 + """ + phase = monotonic() * 2.1 + return self.build_scanline_text(phase, self._SCANLINE_WIDTH) + + def build_symmetric_effects(self) -> tuple[Text, Text]: + """ + 构建标题两侧的对称动效文本。 + + 左右两侧都使用固定宽度,确保标题中心点稳定,不随动效变化漂移。 + + :return: 左右动效文本 + """ + left_effect = self.build_scanline_text_label() + right_effect = Text() + for span_symbol in reversed(left_effect.plain): + right_effect.append( + span_symbol, + style=self._SCANLINE_GLOW_STYLES.get(span_symbol, self._SCANLINE_BASE_STYLE), + ) + return left_effect, right_effect + + def build_centered_title_line(self, title_text: str) -> Text: + """ + 构建居中的标题装饰行。 + + 标题左右分别放置镜像扫描线动效,中间保留标题主体。 + + :param title_text: 标题主体文本 + :return: 居中后的富文本标题行 + """ + left_effect, right_effect = self.build_symmetric_effects() + decorated_title = Text() + decorated_title.append_text(left_effect) + decorated_title.append(' ') + decorated_title.append(title_text, style='bold #e8fdff') + decorated_title.append(' ') + decorated_title.append_text(right_effect) + available_width = self.size.width - self._HEADER_HORIZONTAL_PADDING + if available_width <= 0: + available_width = self._HEADER_FALLBACK_WIDTH + centered = Text( + ' ' * max((max(available_width, len(decorated_title.plain)) - len(decorated_title.plain)) // 2, 0) + ) + centered.append_text(decorated_title) + return centered + + def render(self) -> Text: + """ + 渲染顶部状态栏文本。 + + :return: 渲染富文本 + """ + timestamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S') + lines = TUI_COPY.build_workspace_header_lines( + env=self.env, + view_label=TUI_COPY.render_view_label(self.active_view), + timestamp=timestamp, + shortcut_hint=TUI_KEYMAP_REGISTRY.global_shortcut_hint, + ) + rendered = Text() + if len(lines) >= self._HEADER_LINE_COUNT: + rendered.append_text(self.build_centered_title_line(lines[0])) + rendered.append('\n') + rendered.append(lines[1], style='bold #c7f6ff') + return rendered + rendered.append('\n'.join(lines), style='bold #c7f6ff') + return rendered + + +class SectionListItem(ListItem): + """ + 详情页分区导航列表项。 + + :param section: 分区快照 + :param index: 分区索引 + """ + + DEFAULT_CSS = """ + SectionListItem { + padding: 0 1; + margin-bottom: 1; + border: round #123148; + background: #07131f; + color: #a3c8d2; + height: auto; + } + + SectionListItem Label { + width: 1fr; + } + + SectionListItem.is-ok { + border: round #22c983; + background: #081b17; + } + + SectionListItem.is-fail { + border: round #ff6b7a; + background: #241118; + } + + SectionListItem.is-warn { + border: round #f2b84b; + background: #261d0f; + } + + SectionListItem.is-info { + border: round #38d8ff; + background: #081825; + } + + SectionListItem.-highlight { + border: heavy #6df7ff; + background: #10364b; + color: #ffffff; + text-style: bold; + padding-left: 2; + } + """ + + def __init__( + self, + section: DetailSectionSnapshot, + index: int, + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化详情页分区导航项。 + + :param section: 分区快照 + :param index: 分区索引 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.section = section + self.index = index + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + preview_line = self.rendering.build_preview_line(section.lines, TUI_COPY.build_workspace_empty_text('detail')) + super().__init__( + Label( + '\n'.join( + TUI_COPY.build_section_item_lines( + index, + self.rendering.highlight_search_text(section.title, query), + self.rendering.render_status_badge(section.status), + self.rendering.highlight_search_text(preview_line, query), + ) + ), + markup=False, + ) + ) + self.add_class(self.rendering.resolve_status_class(section.status)) + + +class SectionNavigator(ListView): + """ + 详情页分区导航组件。 + + :param sections: 分区快照列表 + :param initial_index: 初始高亮索引 + """ + + DEFAULT_CSS = """ + SectionNavigator { + width: 30; + min-width: 30; + border: double #18425d; + padding: 1; + margin-right: 1; + background: #06111b; + } + + SectionNavigator:focus { + border: heavy #6df7ff; + } + """ + + class Changed(Message): + """ + 分区导航高亮变更消息。 + """ + + def __init__(self, navigator: 'SectionNavigator', index: int, item: SectionListItem) -> None: + super().__init__() + self.navigator = navigator + self.index = index + self.item = item + + @property + def control(self) -> 'SectionNavigator': + return self.navigator + + def __init__( + self, + sections: list[DetailSectionSnapshot], + initial_index: int = 0, + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化详情页分区导航。 + + :param sections: 分区快照列表 + :param initial_index: 初始高亮索引 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.sections = sections + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + children = [ + SectionListItem(section, index, query=query, rendering=self.rendering) + for index, section in enumerate(sections) + ] + super().__init__(*children, initial_index=initial_index) + + def watch_index(self, old_index: int | None, new_index: int | None) -> None: + """ + 在高亮变化后向父级发送明确的分区切换消息。 + + :param old_index: 旧索引 + :param new_index: 新索引 + :return: None + """ + super().watch_index(old_index, new_index) + if new_index is None or not 0 <= new_index < len(self._nodes): + return + item = self._nodes[new_index] + if isinstance(item, SectionListItem): + self.post_message(self.Changed(self, new_index, item)) + + async def show_sections( + self, sections: list[DetailSectionSnapshot], initial_index: int = 0, query: str = '' + ) -> None: + """ + 刷新分区导航内容并恢复高亮位置。 + + :param sections: 最新分区快照列表 + :param initial_index: 目标高亮索引 + :return: None + """ + self.sections = sections + self.search_query = query + await self.clear() + children = [ + SectionListItem(section, index, query=query, rendering=self.rendering) + for index, section in enumerate(sections) + ] + if not children: + self.index = None + return + await self.extend(children) + self.index = max(0, min(initial_index, len(children) - 1)) + + +class SectionDetailView(Static): + """ + 详情页分区内容展示组件。 + + :param section: 当前展示的分区快照 + """ + + DEFAULT_CSS = """ + SectionDetailView { + border: double #245874; + padding: 1 2; + background: #08131f; + color: #ddf8ff; + width: 1fr; + min-height: 18; + overflow-x: auto; + overflow-y: auto; + } + + SectionDetailView.is-ok { + border: double #22c983; + background: #081b17; + } + + SectionDetailView.is-fail { + border: double #ff6b7a; + background: #241118; + } + + SectionDetailView.is-warn { + border: double #f2b84b; + background: #261d0f; + } + + SectionDetailView.is-info { + border: double #38d8ff; + background: #081825; + } + + SectionDetailView:focus { + border: heavy #6df7ff; + background: #10364b; + } + """ + + def __init__( + self, + section: DetailSectionSnapshot, + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化详情页分区内容展示组件。 + + :param section: 当前展示的分区快照 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.section = section + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + super().__init__(markup=False) + self.can_focus = True + self._render_section() + + def show_section(self, section: DetailSectionSnapshot, query: str = '') -> None: + """ + 切换并渲染当前展示的分区内容。 + + :param section: 待展示的分区快照 + :return: None + """ + self.section = section + self.search_query = query + self._render_section() + + def _render_section(self) -> None: + """ + 渲染当前分区内容。 + + :return: None + """ + self.remove_class('is-ok', 'is-fail', 'is-warn', 'is-info') + self.add_class(self.rendering.resolve_status_class(self.section.status)) + highlighted_lines = [ + self.rendering.highlight_search_text(line, self.search_query) for line in self.section.lines + ] + body = self.rendering.render_structured_lines( + highlighted_lines, + TUI_COPY.build_workspace_empty_text('detail'), + ) + self.update( + '\n'.join( + TUI_COPY.build_section_detail_lines( + self.rendering.highlight_search_text(self.section.title, self.search_query), + TUI_COPY.render_status_label(self.section.status), + self.rendering.render_status_badge(self.section.status), + body, + ) + ) + ) + + +class RecordListItem(ListItem): + """ + 浏览页记录导航列表项。 + + :param record: 记录快照 + :param index: 记录索引 + """ + + DEFAULT_CSS = """ + RecordListItem { + padding: 0 1; + margin-bottom: 1; + border: round #123148; + background: #07131f; + color: #a3c8d2; + height: auto; + } + + RecordListItem Label { + width: 1fr; + } + + RecordListItem.is-ok { + border: round #22c983; + background: #081b17; + } + + RecordListItem.is-fail { + border: round #ff6b7a; + background: #241118; + } + + RecordListItem.is-warn { + border: round #f2b84b; + background: #261d0f; + } + + RecordListItem.is-info { + border: round #38d8ff; + background: #081825; + } + + RecordListItem.-highlight { + border: heavy #6df7ff; + background: #10364b; + color: #ffffff; + text-style: bold; + padding-left: 2; + } + """ + + def __init__( + self, + record: BrowserRecordSnapshot, + index: int, + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化浏览页记录导航项。 + + :param record: 记录快照 + :param index: 记录索引 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.record = record + self.index = index + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + super().__init__( + Label( + '\n'.join( + TUI_COPY.build_record_item_lines( + index, + self.rendering.highlight_search_text(record.title, query), + self.rendering.render_status_badge(record.status), + self.rendering.highlight_search_text(record.summary, query), + ) + ), + markup=False, + ) + ) + self.add_class(self.rendering.resolve_status_class(record.status)) + + +class RecordNavigator(ListView): + """ + 浏览页记录导航组件。 + + :param records: 记录快照列表 + :param initial_index: 初始高亮索引 + """ + + DEFAULT_CSS = """ + RecordNavigator { + width: 34; + min-width: 34; + border: double #18425d; + padding: 1; + margin-right: 1; + background: #06111b; + } + + RecordNavigator:focus { + border: heavy #6df7ff; + } + """ + + class Changed(Message): + """ + 记录导航高亮变更消息。 + """ + + def __init__(self, navigator: 'RecordNavigator', index: int, item: RecordListItem) -> None: + super().__init__() + self.navigator = navigator + self.index = index + self.item = item + + @property + def control(self) -> 'RecordNavigator': + return self.navigator + + def __init__( + self, + records: list[BrowserRecordSnapshot], + initial_index: int = 0, + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化浏览页记录导航。 + + :param records: 记录快照列表 + :param initial_index: 初始高亮索引 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.records = records + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + children = [ + RecordListItem(record, index, query=query, rendering=self.rendering) for index, record in enumerate(records) + ] + super().__init__(*children, initial_index=initial_index, id='record-navigator') + + def watch_index(self, old_index: int | None, new_index: int | None) -> None: + """ + 在高亮变化后向父级发送明确的记录切换消息。 + + :param old_index: 旧索引 + :param new_index: 新索引 + :return: None + """ + super().watch_index(old_index, new_index) + if new_index is None or not 0 <= new_index < len(self._nodes): + return + item = self._nodes[new_index] + if isinstance(item, RecordListItem): + self.post_message(self.Changed(self, new_index, item)) + + +class RecordDetailView(Static): + """ + 浏览页记录详情展示组件。 + + :param record: 当前展示的记录快照 + :param shared_sections: 页面共享分区列表 + """ + + DEFAULT_CSS = """ + RecordDetailView { + border: double #245874; + padding: 1 2; + background: #08131f; + color: #ddf8ff; + width: 1fr; + min-height: 18; + overflow-x: auto; + overflow-y: auto; + } + + RecordDetailView.is-ok { + border: double #22c983; + } + + RecordDetailView.is-fail { + border: double #ff6b7a; + } + + RecordDetailView.is-warn { + border: double #f2b84b; + } + + RecordDetailView.is-info { + border: double #38d8ff; + } + + RecordDetailView:focus { + border: heavy #6df7ff; + background: #10364b; + } + """ + + def __init__( + self, + record: BrowserRecordSnapshot, + shared_sections: list[DetailSectionSnapshot], + query: str = '', + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化浏览页记录详情展示组件。 + + :param record: 当前展示的记录快照 + :param shared_sections: 页面共享分区列表 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.record = record + self.shared_sections = shared_sections + self.search_query = query + self.rendering = rendering or WORKSPACE_RENDERING + super().__init__(id='record-detail-view', markup=False) + self.can_focus = True + self._render_record() + + def show_record( + self, + record: BrowserRecordSnapshot, + shared_sections: list[DetailSectionSnapshot], + query: str = '', + ) -> None: + """ + 切换并渲染当前展示的记录内容。 + + :param record: 待展示的记录快照 + :param shared_sections: 页面共享分区列表 + :return: None + """ + self.record = record + self.shared_sections = shared_sections + self.search_query = query + self._render_record() + + def _render_record(self) -> None: + """ + 渲染当前记录内容。 + + :return: None + """ + self.remove_class('is-ok', 'is-fail', 'is-warn', 'is-info') + self.add_class(self.rendering.resolve_status_class(self.record.status)) + lines = [ + ( + f'{self.rendering.render_status_badge(self.record.status)} ' + f'{self.rendering.highlight_search_text(self.record.title, self.search_query)}' + ), + f'{TUI_COPY.build_workspace_label("overview")} · {self.rendering.highlight_search_text(self.record.summary, self.search_query)}', + '', + ] + if self.record.metadata_lines: + lines.append(TUI_COPY.build_workspace_title('key_info')) + lines.append('────────────────') + lines.append( + self.rendering.render_structured_lines( + [ + self.rendering.highlight_search_text(line, self.search_query) + for line in self.record.metadata_lines + ], + TUI_COPY.build_workspace_empty_text('key_info'), + ) + ) + lines.append('') + + combined_sections = [*self.record.detail_sections, *self.shared_sections] + if not combined_sections: + lines.append(TUI_COPY.build_workspace_title('detail_content')) + lines.append('========') + lines.append(f'- {TUI_COPY.build_workspace_empty_text("detail")}') + else: + for section in combined_sections: + lines.append('-' * 44) + lines.append( + f'{self.rendering.render_status_badge(section.status)} ' + f'{self.rendering.highlight_search_text(section.title, self.search_query)}' + ) + lines.append( + self.rendering.render_structured_lines( + [self.rendering.highlight_search_text(line, self.search_query) for line in section.lines], + TUI_COPY.build_workspace_empty_text('detail'), + ) + ) + lines.append('') + self.update('\n'.join(lines).strip()) + + +class RecordSummaryView(Static): + """ + 浏览页记录摘要展示组件。 + + :param record: 当前展示的记录快照 + """ + + DEFAULT_CSS = """ + RecordSummaryView { + border: double #38d8ff; + padding: 1 2; + margin-bottom: 1; + background: #081827; + color: #e9fcff; + overflow-x: auto; + overflow-y: auto; + } + + RecordSummaryView.is-ok { + border: double #22c983; + background: #081b17; + } + + RecordSummaryView.is-fail { + border: double #ff6b7a; + background: #241118; + } + + RecordSummaryView.is-warn { + border: double #f2b84b; + background: #261d0f; + } + + RecordSummaryView.is-info { + border: double #38d8ff; + background: #081825; + } + + RecordSummaryView.section-ok { + border-left: heavy #22c983; + } + + RecordSummaryView.section-fail { + border-left: heavy #ff6b7a; + } + + RecordSummaryView.section-warn { + border-left: heavy #f2b84b; + } + + RecordSummaryView.section-info { + border-left: heavy #38d8ff; + } + + RecordSummaryView:focus { + border: heavy #6df7ff; + background: #10364b; + } + """ + + def __init__( + self, + record: BrowserRecordSnapshot, + rendering: WorkspaceRenderingSupport | None = None, + ) -> None: + """ + 初始化浏览页记录摘要展示组件。 + + :param record: 当前展示的记录快照 + :param rendering: 工作台组件渲染支持对象 + :return: None + """ + self.record = record + self.section: DetailSectionSnapshot | None = None + self.action_lines: list[str] = [] + self.search_query = '' + self.rendering = rendering or WORKSPACE_RENDERING + super().__init__(id='record-summary-view', markup=False) + self.can_focus = True + self._render_record() + + def show_record( + self, + record: BrowserRecordSnapshot, + selected_section: DetailSectionSnapshot | None = None, + action_lines: list[str] | None = None, + query: str = '', + ) -> None: + """ + 更新当前展示的记录摘要。 + + :param record: 待展示的记录快照 + :param selected_section: 当前联动分区 + :param action_lines: 动作摘要文本 + :return: None + """ + self.record = record + self.section = selected_section + self.action_lines = list(action_lines or []) + self.search_query = query + self._render_record() + + def _render_record(self) -> None: + """ + 渲染当前记录摘要。 + + :return: None + """ + self.remove_class('is-ok', 'is-fail', 'is-warn', 'is-info') + self.remove_class('section-ok', 'section-fail', 'section-warn', 'section-info') + self.add_class(self.rendering.resolve_status_class(self.record.status)) + if self.section is not None: + self.add_class( + f'section-{self.section.status if self.section.status in {"ok", "fail", "warn"} else "info"}' + ) + lines = [ + ( + f'{self.rendering.render_status_badge(self.record.status)} ' + f'{self.rendering.highlight_search_text(self.record.title, self.search_query)}' + ), + f'{TUI_COPY.build_workspace_label("overview")} · {self.rendering.highlight_search_text(self.record.summary, self.search_query)}', + ] + if self.section is not None: + lines.append( + f'{TUI_COPY.build_workspace_label("current_section")} · {self.rendering.highlight_search_text(self.section.title, self.search_query)} / {TUI_COPY.render_status_label(self.section.status)}' + ) + if self.record.metadata_lines: + lines.append('') + lines.append(TUI_COPY.build_workspace_title('key_fields')) + lines.append('────────────────') + lines.append( + self.rendering.render_structured_lines( + [ + self.rendering.highlight_search_text(line, self.search_query) + for line in self.record.metadata_lines + ], + TUI_COPY.build_workspace_empty_text('key_info'), + ) + ) + if self.action_lines: + lines.append('') + lines.append(TUI_COPY.build_workspace_title('action_feedback')) + lines.append('────────────────') + lines.append( + self.rendering.render_structured_lines( + [self.rendering.highlight_search_text(line, self.search_query) for line in self.action_lines], + TUI_COPY.build_workspace_empty_text('actions'), + ) + ) + self.update('\n'.join(lines)) diff --git a/shierfeng-fastapi-backend/cli/utils.py b/shierfeng-fastapi-backend/cli/utils.py new file mode 100644 index 0000000..28e4221 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/utils.py @@ -0,0 +1,366 @@ +import json +import os +import re +import shlex +import subprocess +import sys +from dataclasses import dataclass, field +from pathlib import Path +from typing import Any + +from cli.exit_codes import RUNTIME_ERROR +from cli.runtime.base import RUNTIME_ENVIRONMENT + +_SNAKE_CASE_BOUNDARY_PATTERN = re.compile(r'(? str: + """ + 将命令参数列表格式化为 shell 可读文本。 + + :param arguments: 命令参数列表 + :return: shell 命令文本 + """ + return shlex.join(arguments) + + @staticmethod + def truncate_text(value: object, max_length: int) -> str: + """ + 将文本截断到指定长度。 + + :param value: 原始文本值 + :param max_length: 最大长度 + :return: 截断后的文本 + """ + text = '' if value is None else str(value).strip() + if len(text) <= max_length: + return text + return f'{text[: max_length - 3]}...' + + @staticmethod + def to_snake_case(value: object) -> str: + """ + 将字段名标准化为 `snake_case` 形式。 + + :param value: 原始字段名 + :return: `snake_case` 字段名 + """ + text = '' if value is None else str(value).strip() + if not text: + return '' + normalized_text = text.replace('-', '_').replace(' ', '_') + return _SNAKE_CASE_BOUNDARY_PATTERN.sub('_', normalized_text).lower() + + +@dataclass(frozen=True) +class NestedCliProjectLocator: + """ + 内部 CLI 项目目录定位器。 + + 该对象负责识别后端根目录,并为内部 CLI 调用返回稳定的项目目录。 + """ + + @staticmethod + def is_backend_project_dir(project_dir: Path) -> bool: + """ + 判断给定目录是否为后端项目根目录。 + + :param project_dir: 待检查目录 + :return: 是否为后端项目根目录 + """ + return RUNTIME_ENVIRONMENT.is_backend_project_dir(project_dir) + + def resolve_project_dir(self) -> Path: + """ + 解析内部 CLI 子进程应使用的后端项目目录。 + + 优先使用当前工作目录;若当前目录不是后端目录,则回退到当前 + `cli/utils.py` 所在代码树的上一层目录。 + + :return: 后端项目根目录 + """ + current_dir = Path.cwd().resolve() + if self.is_backend_project_dir(current_dir): + return current_dir + return Path(__file__).resolve().parents[1] + + +@dataclass(frozen=True) +class NestedCliEnvironmentBuilder: + """ + 内部 CLI 环境构建器。 + + 该对象负责构建子进程环境变量以及内部 CLI 调用命令。 + """ + + @staticmethod + def build_process_env(project_dir: Path) -> dict[str, str]: + """ + 构建内部 CLI 子进程环境变量。 + + :param project_dir: 后端项目根目录 + :return: 子进程环境变量字典 + """ + process_env = dict(os.environ) + project_dir_str = str(project_dir) + python_path = process_env.get('PYTHONPATH', '').strip() + if python_path: + process_env['PYTHONPATH'] = os.pathsep.join([project_dir_str, python_path]) + else: + process_env['PYTHONPATH'] = project_dir_str + return process_env + + @staticmethod + def build_nested_cli_command(*arguments: str) -> list[str]: + """ + 构建内部 CLI 调用命令。 + + :param arguments: CLI 参数列表 + :return: 完整子进程命令参数列表 + """ + return [sys.executable, '-m', 'cli.main', '--color=never', '--icon=none', *arguments] + + +@dataclass(frozen=True) +class NestedCliPayloadParser: + """ + 内部 CLI 负载解析器。 + + 该对象负责从标准输出/错误中提取 JSON,并为非 JSON 结果构建兜底负载。 + """ + + @staticmethod + def extract_json_payload(output_text: str) -> dict[str, Any] | list[Any] | None: + """ + 从原始输出文本中提取 JSON 负载。 + + 该逻辑优先尝试直接解析;若输出前后混入提示文本、ANSI 控制序列 + 或其他噪声,则尝试截取最外层 JSON 对象或数组再解析。 + + :param output_text: 原始输出文本 + :return: 解析成功的 JSON 负载,失败时返回 None + """ + normalized_output = _ANSI_ESCAPE_PATTERN.sub('', output_text).strip() + if not normalized_output: + return None + + decoder = json.JSONDecoder() + try: + return decoder.decode(normalized_output) + except Exception: + pass + + for index, char in enumerate(normalized_output): + if char not in '{[': + continue + try: + payload, _ = decoder.raw_decode(normalized_output[index:]) + return payload + except Exception: + continue + return None + + @staticmethod + def build_non_json_payload_fallback( + *, + stdout: str, + stderr: str, + returncode: int, + ) -> dict[str, Any]: + """ + 为未返回 JSON 的内部 CLI 输出构建兜底负载。 + + :param stdout: 标准输出文本 + :param stderr: 标准错误文本 + :param returncode: 进程退出码 + :return: 兜底结果负载 + """ + stdout_text = stdout.strip() + stderr_text = stderr.strip() + summary = stdout_text or stderr_text or '内部 CLI 未返回可解析的 JSON 输出' + return { + 'ok': returncode == 0, + 'message': summary, + 'stdout': stdout_text, + 'stderr': stderr_text, + 'exit_code': returncode or RUNTIME_ERROR, + 'fallback': 'non_json_output', + } + + +@dataclass +class NestedCliSupport: + """ + 内部 CLI 子进程支持服务。 + + 该对象统一负责编排项目目录解析、环境注入、标准输出解析以及 + 实时执行/进程替换执行路径。 + + :param project_locator: 项目目录定位器 + :param environment_builder: 子进程环境构建器 + :param payload_parser: 负载解析器 + """ + + project_locator: NestedCliProjectLocator = field(default_factory=NestedCliProjectLocator) + environment_builder: NestedCliEnvironmentBuilder = field(default_factory=NestedCliEnvironmentBuilder) + payload_parser: NestedCliPayloadParser = field(default_factory=NestedCliPayloadParser) + + def resolve_project_dir(self) -> Path: + """ + 解析内部 CLI 子进程应使用的后端项目目录。 + + :return: 后端项目根目录 + """ + return self.project_locator.resolve_project_dir() + + def build_process_env(self, project_dir: Path) -> dict[str, str]: + """ + 构建内部 CLI 子进程环境变量。 + + :param project_dir: 后端项目根目录 + :return: 子进程环境变量字典 + """ + return self.environment_builder.build_process_env(project_dir) + + def build_nested_cli_command(self, *arguments: str) -> list[str]: + """ + 构建内部 CLI 调用命令。 + + :param arguments: CLI 参数列表 + :return: 完整子进程命令参数列表 + """ + return self.environment_builder.build_nested_cli_command(*arguments) + + def extract_json_payload(self, output_text: str) -> dict[str, Any] | list[Any] | None: + """ + 从原始输出文本中提取 JSON 负载。 + + :param output_text: 原始输出文本 + :return: 解析成功的 JSON 负载,失败时返回 None + """ + return self.payload_parser.extract_json_payload(output_text) + + def build_non_json_payload_fallback( + self, + *, + stdout: str, + stderr: str, + returncode: int, + ) -> dict[str, Any]: + """ + 为未返回 JSON 的内部 CLI 输出构建兜底负载。 + + :param stdout: 标准输出文本 + :param stderr: 标准错误文本 + :param returncode: 进程退出码 + :return: 兜底结果负载 + """ + return self.payload_parser.build_non_json_payload_fallback( + stdout=stdout, + stderr=stderr, + returncode=returncode, + ) + + def run(self, *arguments: str, parse_json: bool = False) -> NestedCliResult: + """ + 在当前后端目录中执行内部 CLI 命令。 + + :param arguments: CLI 参数列表 + :param parse_json: 是否尝试解析标准输出中的 JSON 负载 + :return: 内部 CLI 调用结果 + """ + project_dir = self.resolve_project_dir() + command = self.build_nested_cli_command(*arguments) + completed = subprocess.run( + command, + capture_output=True, + text=True, + check=False, + cwd=str(project_dir), + env=self.build_process_env(project_dir), + ) + payload: dict[str, Any] | list[Any] | None = None + if parse_json: + payload = self.extract_json_payload(completed.stdout) + if payload is None: + payload = self.extract_json_payload(completed.stderr) + if payload is None: + payload = self.build_non_json_payload_fallback( + stdout=completed.stdout, + stderr=completed.stderr, + returncode=completed.returncode, + ) + return NestedCliResult( + command=command, + returncode=completed.returncode, + stdout=completed.stdout, + stderr=completed.stderr, + payload=payload, + ) + + def run_live(self, *arguments: str) -> subprocess.CompletedProcess[str]: + """ + 在当前终端中直接执行内部 CLI 命令。 + + 该模式不会捕获标准输出/错误,适用于需要占用当前终端交互的 wizard + 或其他外部命令入口;调用方应自行决定是否先挂起 TUI。 + + :param arguments: CLI 参数列表 + :return: 子进程执行结果 + """ + project_dir = self.resolve_project_dir() + command = self.build_nested_cli_command(*arguments) + return subprocess.run( + command, + text=True, + check=False, + cwd=str(project_dir), + env=self.build_process_env(project_dir), + ) + + def exec(self, *arguments: str) -> None: + """ + 以进程替换方式执行内部 CLI 命令。 + + :param arguments: CLI 参数列表 + :return: None + """ + project_dir = self.resolve_project_dir() + command = self.build_nested_cli_command(*arguments) + executable = command[0] + subprocess_arguments = [executable, *command[1:]] + os.chdir(project_dir) + os.execvp(executable, subprocess_arguments) + + +SHELL_TEXT_FORMATTER = ShellTextFormatter() +NESTED_CLI_SUPPORT = NestedCliSupport() diff --git a/shierfeng-fastapi-backend/cli/wizard/__init__.py b/shierfeng-fastapi-backend/cli/wizard/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/wizard/aggregators.py b/shierfeng-fastapi-backend/cli/wizard/aggregators.py new file mode 100644 index 0000000..ade4639 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/aggregators.py @@ -0,0 +1,122 @@ +from dataclasses import dataclass +from typing import Any + + +@dataclass(frozen=True) +class ProdCheckPayloadSupport: + """ + `wizard prod-check` 结果提取支持对象。 + + 该对象负责从多路只读结果中提取 runtime、doctor、config + 片段,避免聚合器本体继续堆叠细碎字段判定逻辑。 + """ + + @staticmethod + def extract_runtime_payload(runtime_payload: dict[str, Any] | None) -> dict[str, Any] | None: + """ + 提取运行环境结果中的 runtime 片段。 + + :param runtime_payload: 运行环境结果 + :return: runtime 片段 + """ + return runtime_payload.get('runtime') if isinstance(runtime_payload, dict) else None + + @staticmethod + def extract_doctor_payload(doctor_payload: dict[str, Any] | None) -> dict[str, Any] | None: + """ + 提取应用检查结果片段。 + + :param doctor_payload: 应用检查结果 + :return: doctor 片段 + """ + return doctor_payload if isinstance(doctor_payload, dict) else None + + @staticmethod + def extract_config_payload(config_payload: dict[str, Any] | None) -> dict[str, Any] | None: + """ + 提取配置快照结果中的 config 片段。 + + :param config_payload: 配置快照结果 + :return: config 片段 + """ + return config_payload.get('config') if isinstance(config_payload, dict) else None + + +@dataclass(frozen=True) +class ProdCheckStatusEvaluator: + """ + `wizard prod-check` 状态评估器。 + + 该对象负责统一计算聚合结果的成功状态和标准消息。 + """ + + @staticmethod + def is_ok( + runtime_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + ) -> bool: + """ + 计算生产巡检聚合结果是否成功。 + + :param runtime_payload: 运行环境结果 + :param doctor_payload: 应用检查结果 + :param config_payload: 配置快照结果 + :return: 是否成功 + """ + return ( + bool(runtime_payload and runtime_payload.get('ok', False)) + and bool(doctor_payload and doctor_payload.get('ok', False)) + and (config_payload is None or bool(config_payload.get('ok', False))) + ) + + @staticmethod + def build_message() -> str: + """ + 构建生产巡检统一结果消息。 + + :return: 结果消息 + """ + return '生产巡检完成' + + +@dataclass(frozen=True) +class ProdCheckAggregator: + """ + `wizard prod-check` 聚合器。 + + 该对象负责聚合运行环境、应用检查和配置快照结果, + 让 flow 本体只保留交互编排职责。 + + :param payload_support: 结果提取支持对象 + :param status_evaluator: 状态评估器 + """ + + payload_support: ProdCheckPayloadSupport = ProdCheckPayloadSupport() + status_evaluator: ProdCheckStatusEvaluator = ProdCheckStatusEvaluator() + + def build_payload( + self, + *, + env: str, + runtime_payload: dict[str, Any] | None, + doctor_payload: dict[str, Any] | None, + config_payload: dict[str, Any] | None, + ) -> dict[str, Any]: + """ + 构建生产巡检聚合结果。 + + :param env: 当前运行环境 + :param runtime_payload: 运行环境结果 + :param doctor_payload: 应用检查结果 + :param config_payload: 配置快照结果 + :return: 聚合结果负载 + """ + return { + 'ok': self.status_evaluator.is_ok(runtime_payload, doctor_payload, config_payload), + 'env': env, + 'message': self.status_evaluator.build_message(), + 'runtime': self.payload_support.extract_runtime_payload(runtime_payload), + 'doctor': self.payload_support.extract_doctor_payload(doctor_payload), + 'config': self.payload_support.extract_config_payload(config_payload), + } diff --git a/shierfeng-fastapi-backend/cli/wizard/base.py b/shierfeng-fastapi-backend/cli/wizard/base.py new file mode 100644 index 0000000..b699087 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/base.py @@ -0,0 +1,909 @@ +import inspect +from abc import ABC, abstractmethod +from collections.abc import Callable +from typing import Any, ClassVar, Generic, TypeVar + +import typer + +from cli.context import CliContext, OutputOption +from cli.core import DEFAULT_CORE_SERVICES, CliContextFactory, CliExecutionService +from cli.output import CommandResult +from cli.utils import NESTED_CLI_SUPPORT +from cli.wizard.preview import WIZARD_PREVIEW_RENDERER, WizardPreviewRenderer +from cli.wizard.prompts import WIZARD_PROMPT_SERVICE, WizardPromptService + +SelectionT = TypeVar('SelectionT') + + +class WizardInteractionSupport: + """ + 向导交互与上下文构建支持对象。 + + :param context_factory: CLI 上下文工厂 + :param prompt_service: 向导提示服务 + """ + + def __init__( + self, + *, + context_factory: CliContextFactory, + prompt_service: WizardPromptService, + ) -> None: + """ + 初始化交互支持对象。 + + :param context_factory: CLI 上下文工厂 + :param prompt_service: 向导提示服务 + :return: None + """ + self.context_factory = context_factory + self.prompt_service = prompt_service + + def build_regular_context( + self, + env: str, + output: OutputOption, + *, + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> CliContext: + """ + 构建普通可写命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境执行 + :param yes: 是否跳过确认 + :param dry_run: 是否执行预演 + :return: CLI 上下文 + """ + return self.context_factory.build_regular(env, output, allow_prod, yes, dry_run) + + def build_readonly_context(self, env: str, output: OutputOption) -> CliContext: + """ + 构建只读命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.context_factory.build_readonly(env, output) + + def prompt_confirm(self, prompt_text: str, *, default_value: bool) -> bool: + """ + 执行标准确认交互。 + + :param prompt_text: 提示文本 + :param default_value: 默认值 + :return: 是否确认 + """ + return self.prompt_service.prompt_confirm(prompt_text, default_value=default_value) + + +class WizardResultSupport: + """ + 向导结果收口支持对象。 + + :param execution_service: CLI 执行服务 + :param preview_renderer: 向导预览渲染器 + """ + + def __init__( + self, + *, + execution_service: CliExecutionService, + preview_renderer: WizardPreviewRenderer, + ) -> None: + """ + 初始化结果收口支持对象。 + + :param execution_service: CLI 执行服务 + :param preview_renderer: 向导预览渲染器 + :return: None + """ + self.execution_service = execution_service + self.preview_renderer = preview_renderer + + def complete_result(self, ctx: CliContext, result: CommandResult) -> None: + """ + 输出命令结果对象。 + + :param ctx: CLI 上下文 + :param result: 命令结果对象 + :return: None + """ + self.execution_service.complete_result(ctx, result) + + def complete_payload( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + default_exit_code: int = 0, + ) -> None: + """ + 输出标准结果负载。 + + :param ctx: CLI 上下文 + :param payload: 标准结果负载 + :param default_exit_code: 默认退出码 + :return: None + """ + self.execution_service.complete_payload(ctx, payload, default_exit_code=default_exit_code) + + def complete_payload_result( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + text_builder: Callable[[dict[str, Any]], Any] | None = None, + default_exit_code: int = 0, + text_condition: Callable[[dict[str, Any]], bool] | None = None, + ) -> None: + """ + 统一按输出格式收口标准结果负载。 + + :param ctx: CLI 上下文 + :param payload: 标准结果负载 + :param text_builder: 文本结果构建函数 + :param default_exit_code: 默认退出码 + :param text_condition: 文本模式结果构建判定函数 + :return: None + """ + self.execution_service.complete_payload_result( + ctx, + payload, + text_builder=text_builder, + default_exit_code=default_exit_code, + text_condition=text_condition, + ) + + def build_cancel_result(self, wizard_name: str) -> CommandResult: + """ + 构建统一的向导取消结果。 + + :param wizard_name: 向导名称 + :return: 命令结果对象 + """ + return self.preview_renderer.build_cancel_result(wizard_name) + + def get_preview_renderer(self) -> WizardPreviewRenderer: + """ + 返回当前项目默认的向导预览渲染器。 + + :return: 预览渲染器 + """ + return self.preview_renderer + + +class WizardNestedCommandSupport: + """ + 向导内部 CLI 调用支持对象。 + + :param command_runner: 内部 CLI 子进程调用函数 + :param live_command_runner: 内部 CLI 实时执行函数 + """ + + def __init__( + self, + *, + command_runner: Callable[..., Any], + live_command_runner: Callable[..., Any], + ) -> None: + """ + 初始化内部 CLI 调用支持对象。 + + :param command_runner: 内部 CLI 子进程调用函数 + :param live_command_runner: 内部 CLI 实时执行函数 + :return: None + """ + self.command_runner = command_runner + self.live_command_runner = live_command_runner + + @staticmethod + def resolve_callable_override(owner: type['BaseCliWizardFlow[Any]'], attribute_name: str) -> Callable[..., Any]: + """ + 解析类级可调用注入点,避免普通函数在实例访问时被绑定为方法。 + + :param owner: 向导类 + :param attribute_name: 类属性名称 + :return: 可直接调用的函数对象 + """ + attribute = inspect.getattr_static(owner, attribute_name) + if isinstance(attribute, staticmethod): + return attribute.__func__ + return attribute + + def run_nested_command(self, *arguments: str, parse_json: bool = False) -> Any: + """ + 调用内部 CLI 并按需解析 JSON。 + + :param arguments: CLI 参数列表 + :param parse_json: 是否解析 JSON + :return: 内部 CLI 调用结果 + """ + return self.command_runner(*arguments, parse_json=parse_json) + + def exec_nested_command(self, *arguments: str) -> Any: + """ + 直接切换到内部 CLI 的实时执行路径。 + + :param arguments: CLI 参数列表 + :return: 内部 CLI 调用结果 + """ + return self.live_command_runner(*arguments) + + +class WizardExecutionResultSupport: + """ + 向导执行结果翻译支持对象。 + + 该对象负责提取内部 CLI 结果的 payload、退出码与错误文本,并构建 + 默认失败负载,让模板基类不再直接持有结果翻译细节。 + + :param failure_message: 默认失败提示 + """ + + def __init__(self, *, failure_message: str) -> None: + """ + 初始化执行结果翻译支持对象。 + + :param failure_message: 默认失败提示 + :return: None + """ + self.failure_message = failure_message + + @staticmethod + def extract_payload(nested_result: Any) -> dict[str, Any] | None: + """ + 提取内部 CLI JSON 负载。 + + :param nested_result: 内部 CLI 调用结果 + :return: JSON 负载 + """ + payload = getattr(nested_result, 'payload', None) + return payload if isinstance(payload, dict) else None + + @staticmethod + def extract_returncode(nested_result: Any) -> int: + """ + 提取内部 CLI 退出码。 + + :param nested_result: 内部 CLI 调用结果 + :return: 退出码 + """ + return int(getattr(nested_result, 'returncode', 0) or 0) + + @staticmethod + def extract_stdout(nested_result: Any) -> str: + """ + 提取内部 CLI 标准输出。 + + :param nested_result: 内部 CLI 调用结果 + :return: 标准输出文本 + """ + return str(getattr(nested_result, 'stdout', '') or '').strip() + + @staticmethod + def extract_stderr(nested_result: Any) -> str: + """ + 提取内部 CLI 标准错误。 + + :param nested_result: 内部 CLI 调用结果 + :return: 标准错误文本 + """ + return str(getattr(nested_result, 'stderr', '') or '').strip() + + def build_failure_payload(self, nested_result: Any) -> dict[str, Any]: + """ + 为内部 CLI 非 JSON 结果构建失败负载。 + + :param nested_result: 内部 CLI 调用结果 + :return: 失败负载 + """ + error_text = self.extract_stderr(nested_result) or self.extract_stdout(nested_result) + return { + 'ok': False, + 'message': self.failure_message, + 'error': error_text, + 'exit_code': self.extract_returncode(nested_result), + } + + +class WizardSupportCache: + """ + 向导协作者缓存。 + + 该对象负责延迟构建并复用当前 flow 需要的 interaction/result/nested + support collaborator,让 `BaseCliWizardFlow` 回到模板骨架与桥接层角色。 + + :param owner: 当前向导 flow + """ + + def __init__(self, owner: 'BaseCliWizardFlow[Any]') -> None: + """ + 初始化向导协作者缓存。 + + :param owner: 当前向导 flow + :return: None + """ + self.owner = owner + self._interaction_support: WizardInteractionSupport | None = None + self._result_support: WizardResultSupport | None = None + self._nested_command_support: WizardNestedCommandSupport | None = None + self._execution_result_support: WizardExecutionResultSupport | None = None + + def get_interaction_support(self) -> WizardInteractionSupport: + """ + 返回当前向导使用的交互支持对象。 + + :return: 交互支持对象 + """ + if self._interaction_support is None: + self._interaction_support = WizardInteractionSupport( + context_factory=self.owner.context_factory, + prompt_service=self.owner.prompt_service, + ) + return self._interaction_support + + def get_result_support(self) -> WizardResultSupport: + """ + 返回当前向导使用的结果收口支持对象。 + + :return: 结果收口支持对象 + """ + if self._result_support is None: + self._result_support = WizardResultSupport( + execution_service=self.owner.execution_service, + preview_renderer=self.owner.preview_renderer, + ) + return self._result_support + + def get_nested_command_support(self) -> WizardNestedCommandSupport: + """ + 返回当前向导使用的内部 CLI 调用支持对象。 + + :return: 内部 CLI 调用支持对象 + """ + if self._nested_command_support is None: + self._nested_command_support = WizardNestedCommandSupport( + command_runner=WizardNestedCommandSupport.resolve_callable_override( + type(self.owner), 'nested_command_runner' + ), + live_command_runner=WizardNestedCommandSupport.resolve_callable_override( + type(self.owner), + 'nested_live_command_runner', + ), + ) + return self._nested_command_support + + def get_execution_result_support(self) -> WizardExecutionResultSupport: + """ + 返回当前向导使用的执行结果翻译支持对象。 + + :return: 执行结果翻译支持对象 + """ + if self._execution_result_support is None: + self._execution_result_support = WizardExecutionResultSupport( + failure_message=self.owner.failure_message, + ) + return self._execution_result_support + + +class BaseNestedCommandWizardFlow(ABC, Generic[SelectionT]): + """ + 统一封装通过内部 CLI 执行的向导流程。 + + 子类需要提供参数采集、上下文构建、预览摘要、执行参数和 + 结果收口策略,从而复用向导的通用交互主链路。 + """ + + wizard_name: str + preview_title: str + failure_message: str + + def run(self, output: OutputOption = 'text') -> None: + """ + 执行向导主流程。 + + :param output: 输出格式 + :return: None + """ + selection = self.collect_selection() + self.prepare_execution_state(selection, output) + ctx = self.prepare_context(selection, output) + typer.echo(self.render_preview(selection)) + if not self.prompt_confirm(self.confirm_prompt(selection), default_value=self.confirm_default_value(selection)): + self.complete_result(ctx, self.build_cancel_result()) + return + + nested_result = self.execute(selection, output) + if self.handle_execution_result(ctx, nested_result, output): + return + payload = self.extract_payload(nested_result) + if payload is not None: + self.complete_payload(ctx, payload, default_exit_code=self.extract_returncode(nested_result)) + return + self.complete_payload(ctx, self.build_failure_payload(nested_result)) + + def render_preview(self, selection: SelectionT) -> str: + """ + 生成向导预览文本。 + + :param selection: 向导采集结果 + :return: 预览文本 + """ + return self.get_preview_renderer().render_preview( + self.preview_title, + summary=self.build_preview_summary(selection), + command=self.build_preview_command(selection), + notes=self.build_preview_notes(selection), + ) + + def confirm_default_value(self, selection: SelectionT) -> bool: + """ + 返回最终确认默认值。 + + :param selection: 向导采集结果 + :return: 默认确认值 + """ + del selection + return False + + def build_preview_notes(self, selection: SelectionT) -> list[str] | None: + """ + 构建预览附加说明。 + + :param selection: 向导采集结果 + :return: 预览附加说明 + """ + del selection + return None + + def prepare_execution_state(self, selection: SelectionT, output: OutputOption) -> None: + """ + 在渲染预览前准备 flow 级执行状态。 + + 该钩子用于少量需要在预览、确认默认值或执行前共享状态的 flow, + 例如预先探测只读诊断结果,但不允许子类因此重写整个模板主链路。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: None + """ + del selection, output + + def handle_execution_result(self, ctx: CliContext, nested_result: Any, output: OutputOption) -> bool: + """ + 允许子类在默认 payload 收口前接管执行结果。 + + 该钩子适用于需要切换到 live exec、实时终端占用或其他非标准 payload + 收口路径的少数 flow。返回 `True` 表示结果已处理完成。 + + :param ctx: CLI 上下文 + :param nested_result: 执行结果 + :param output: 输出格式 + :return: 是否已完成结果处理 + """ + del ctx, nested_result, output + return False + + def build_failure_payload(self, nested_result: Any) -> dict[str, Any]: + """ + 为内部 CLI 非 JSON 结果构建失败负载。 + + :param nested_result: 内部 CLI 调用结果 + :return: 失败负载 + """ + return self.get_execution_result_support().build_failure_payload(nested_result) + + @staticmethod + def extract_payload(nested_result: Any) -> dict[str, Any] | None: + """ + 提取内部 CLI JSON 负载。 + + :param nested_result: 内部 CLI 调用结果 + :return: JSON 负载 + """ + return WizardExecutionResultSupport.extract_payload(nested_result) + + @staticmethod + def extract_returncode(nested_result: Any) -> int: + """ + 提取内部 CLI 退出码。 + + :param nested_result: 内部 CLI 调用结果 + :return: 退出码 + """ + return WizardExecutionResultSupport.extract_returncode(nested_result) + + @staticmethod + def extract_stdout(nested_result: Any) -> str: + """ + 提取内部 CLI 标准输出。 + + :param nested_result: 内部 CLI 调用结果 + :return: 标准输出文本 + """ + return WizardExecutionResultSupport.extract_stdout(nested_result) + + @staticmethod + def extract_stderr(nested_result: Any) -> str: + """ + 提取内部 CLI 标准错误。 + + :param nested_result: 内部 CLI 调用结果 + :return: 标准错误文本 + """ + return WizardExecutionResultSupport.extract_stderr(nested_result) + + @abstractmethod + def collect_selection(self) -> SelectionT: + """ + 采集向导参数。 + + :return: 向导采集结果 + """ + + @abstractmethod + def prepare_context(self, selection: SelectionT, output: OutputOption) -> CliContext: + """ + 构建命令上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + + @abstractmethod + def build_preview_summary(self, selection: SelectionT) -> dict[str, Any]: + """ + 构建预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + + @abstractmethod + def build_preview_command(self, selection: SelectionT) -> list[str]: + """ + 构建用户视角命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + + @abstractmethod + def confirm_prompt(self, selection: SelectionT) -> str: + """ + 返回最终确认提示文本。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + + @abstractmethod + def build_execute_arguments(self, selection: SelectionT, output: OutputOption) -> list[str]: + """ + 构建内部 CLI 执行参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + + @abstractmethod + def prompt_confirm(self, prompt_text: str, *, default_value: bool) -> bool: + """ + 执行确认交互。 + + :param prompt_text: 提示文本 + :param default_value: 默认值 + :return: 是否确认 + """ + + @abstractmethod + def complete_result(self, ctx: CliContext, result: CommandResult) -> None: + """ + 输出命令结果对象。 + + :param ctx: CLI 上下文 + :param result: 命令结果 + :return: None + """ + + @abstractmethod + def build_cancel_result(self) -> CommandResult: + """ + 构建向导取消结果。 + + :return: 命令结果对象 + """ + + @abstractmethod + def get_preview_renderer(self) -> WizardPreviewRenderer: + """ + 获取当前向导使用的预览渲染器。 + + :return: 预览渲染器 + """ + + @abstractmethod + def complete_payload( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + default_exit_code: int = 0, + ) -> None: + """ + 输出标准负载。 + + :param ctx: CLI 上下文 + :param payload: 结果负载 + :param default_exit_code: 默认退出码 + :return: None + """ + + def execute(self, selection: SelectionT, output: OutputOption) -> Any: + """ + 执行内部 CLI 命令。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 调用结果 + """ + return self.run_nested_command(*self.build_execute_arguments(selection, output), parse_json=True) + + @abstractmethod + def run_nested_command(self, *arguments: str, parse_json: bool = False) -> Any: + """ + 调用内部 CLI。 + + :param arguments: 参数列表 + :param parse_json: 是否解析 JSON + :return: 内部 CLI 调用结果 + """ + + +class BaseCliWizardFlow(BaseNestedCommandWizardFlow[SelectionT], ABC): + """ + 当前项目使用的 CLI 向导基类。 + + 该基类在通用向导主链路之上继续下沉当前项目稳定复用的桥接逻辑, + 包括确认交互、上下文构建、命令结果收口与内部 CLI 调用封装。 + """ + + context_factory: ClassVar[CliContextFactory] = DEFAULT_CORE_SERVICES.context_factory + execution_service: ClassVar[CliExecutionService] = DEFAULT_CORE_SERVICES.execution_service + prompt_service: ClassVar[WizardPromptService] = WIZARD_PROMPT_SERVICE + preview_renderer: ClassVar[WizardPreviewRenderer] = WIZARD_PREVIEW_RENDERER + nested_command_runner: ClassVar[Callable[..., Any]] = staticmethod(NESTED_CLI_SUPPORT.run) + nested_live_command_runner: ClassVar[Callable[..., Any]] = staticmethod(NESTED_CLI_SUPPORT.exec) + + def __init__(self) -> None: + """ + 初始化当前项目向导基类。 + + 该基类通过协作者缓存稳定持有交互、结果收口和内部 CLI 调用 support, + 避免模板方法执行过程中重复构建同类对象。 + + :return: None + """ + self._support_cache: WizardSupportCache | None = None + + def get_support_cache(self) -> WizardSupportCache: + """ + 返回当前向导使用的协作者缓存。 + + 保持惰性创建,以兼容未显式调用基类 `__init__` 的现有 flow。 + + :return: 协作者缓存 + """ + support_cache = getattr(self, '_support_cache', None) + if support_cache is None: + self._support_cache = WizardSupportCache(self) + return self._support_cache + + def get_interaction_support(self) -> WizardInteractionSupport: + """ + 返回当前向导使用的交互支持对象。 + + :return: 交互支持对象 + """ + return self.get_support_cache().get_interaction_support() + + def get_result_support(self) -> WizardResultSupport: + """ + 返回当前向导使用的结果收口支持对象。 + + :return: 结果收口支持对象 + """ + return self.get_support_cache().get_result_support() + + def get_nested_command_support(self) -> WizardNestedCommandSupport: + """ + 返回当前向导使用的内部 CLI 调用支持对象。 + + :return: 内部 CLI 调用支持对象 + """ + return self.get_support_cache().get_nested_command_support() + + def get_execution_result_support(self) -> WizardExecutionResultSupport: + """ + 返回当前向导使用的执行结果翻译支持对象。 + + :return: 执行结果翻译支持对象 + """ + return self.get_support_cache().get_execution_result_support() + + def build_regular_context( + self, + env: str, + output: OutputOption, + *, + allow_prod: bool, + yes: bool, + dry_run: bool, + ) -> CliContext: + """ + 构建普通可写命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :param allow_prod: 是否允许生产环境执行 + :param yes: 是否跳过确认 + :param dry_run: 是否执行预演 + :return: CLI 上下文 + """ + return self.get_interaction_support().build_regular_context( + env, + output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ) + + def build_readonly_context(self, env: str, output: OutputOption) -> CliContext: + """ + 构建只读命令上下文。 + + :param env: 运行环境 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.get_interaction_support().build_readonly_context(env, output) + + def prompt_confirm(self, prompt_text: str, *, default_value: bool) -> bool: + """ + 执行标准确认交互。 + + :param prompt_text: 提示文本 + :param default_value: 默认值 + :return: 是否确认 + """ + return self.get_interaction_support().prompt_confirm(prompt_text, default_value=default_value) + + def complete_result(self, ctx: CliContext, result: CommandResult) -> None: + """ + 输出命令结果对象。 + + :param ctx: CLI 上下文 + :param result: 命令结果对象 + :return: None + """ + self.get_result_support().complete_result(ctx, result) + + def complete_payload( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + default_exit_code: int = 0, + ) -> None: + """ + 输出标准结果负载。 + + :param ctx: CLI 上下文 + :param payload: 标准结果负载 + :param default_exit_code: 默认退出码 + :return: None + """ + self.get_result_support().complete_payload(ctx, payload, default_exit_code=default_exit_code) + + def complete_payload_result( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + text_builder: Callable[[dict[str, Any]], Any] | None = None, + default_exit_code: int = 0, + text_condition: Callable[[dict[str, Any]], bool] | None = None, + ) -> None: + """ + 统一按输出格式收口标准结果负载。 + + :param ctx: CLI 上下文 + :param payload: 标准结果负载 + :param text_builder: 文本结果构建函数 + :param default_exit_code: 默认退出码 + :param text_condition: 文本模式结果构建判定函数 + :return: None + """ + self.get_result_support().complete_payload_result( + ctx, + payload, + text_builder=text_builder, + default_exit_code=default_exit_code, + text_condition=text_condition, + ) + + def build_cancel_result(self) -> CommandResult: + """ + 构建统一的向导取消结果。 + + :return: 命令结果对象 + """ + return self.get_result_support().build_cancel_result(self.wizard_name) + + def get_preview_renderer(self) -> WizardPreviewRenderer: + """ + 返回当前项目默认的向导预览渲染器。 + + :return: 预览渲染器 + """ + return self.get_result_support().get_preview_renderer() + + def run_nested_command(self, *arguments: str, parse_json: bool = False) -> Any: + """ + 调用内部 CLI 并按需解析 JSON。 + + :param arguments: CLI 参数列表 + :param parse_json: 是否解析 JSON + :return: 内部 CLI 调用结果 + """ + return self.get_nested_command_support().run_nested_command(*arguments, parse_json=parse_json) + + def exec_nested_command(self, *arguments: str) -> Any: + """ + 直接切换到内部 CLI 的实时执行路径。 + + :param arguments: CLI 参数列表 + :return: 内部 CLI 调用结果 + """ + return self.get_nested_command_support().exec_nested_command(*arguments) + + +class BaseLiveExecCliWizardFlow(BaseCliWizardFlow[SelectionT], ABC): + """ + 统一封装“确认后切换到实时终端执行路径”的 CLI 向导基类。 + + 该特化基类用于少量不走 JSON payload 收口,而是在确认后直接 + 切换到现有命令实时执行链路的向导场景,例如 `wizard app-run`。 + 它在保留预览与确认模板骨架的前提下,显式表达“执行阶段即完成收口”, + 避免子类再通过覆写 `complete_payload()` 或 `handle_execution_result()` + 实现规避式短路。 + """ + + def execute(self, selection: SelectionT, output: OutputOption) -> None: + """ + 切换到内部 CLI 的实时执行路径。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: None + """ + self.exec_nested_command(*self.build_execute_arguments(selection, output)) + + def handle_execution_result(self, ctx: CliContext, nested_result: Any, output: OutputOption) -> bool: + """ + 标记实时执行路径已完成结果收口。 + + :param ctx: CLI 上下文 + :param nested_result: 执行结果 + :param output: 输出格式 + :return: 是否已完成结果处理 + """ + del ctx, nested_result, output + return True diff --git a/shierfeng-fastapi-backend/cli/wizard/commands.py b/shierfeng-fastapi-backend/cli/wizard/commands.py new file mode 100644 index 0000000..18067ac --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/commands.py @@ -0,0 +1,316 @@ +from collections.abc import Callable +from dataclasses import dataclass, field +from importlib import import_module + +import typer + +from cli.context import OutputOption + +WizardCommandRegistrar = Callable[[typer.Typer, 'WizardCommandRegistration'], None] + + +@dataclass(frozen=True) +class WizardCommandRegistration: + """ + wizard 子命令注册元数据。 + + :param name: 子命令名称 + :param help_text: 子命令帮助文案 + :param registrar: 对应的注册器函数 + """ + + name: str + help_text: str + + +class WizardFlowLoader: + """ + wizard flow 惰性加载器。 + + 该对象负责在命令真正执行时导入对应 flow, + 避免 `wizard` 入口在模块导入阶段提前拉起全部向导依赖。 + """ + + def load_runner(self, module_name: str, function_name: str) -> Callable[..., None]: + """ + 按模块名和函数名加载向导执行入口。 + + :param module_name: flow 模块名 + :param function_name: flow 执行函数名 + :return: 可调用的向导执行函数 + """ + flow_module = import_module(module_name) + return getattr(flow_module, function_name) + + +@dataclass +class WizardCommandBuilder: + """ + wizard 子命令构建器。 + + :param flow_loader: wizard flow 惰性加载器 + """ + + flow_loader: WizardFlowLoader = field(default_factory=WizardFlowLoader) + + def build(self) -> typer.Typer: + """ + 构建 wizard 命令组。 + + :return: wizard 子应用 + """ + app = typer.Typer( + help='交互式向导命令', + no_args_is_help=True, + context_settings={'help_option_names': ['-h', '--help']}, + ) + self.register_commands(app) + return app + + def register_commands(self, app: typer.Typer) -> None: + """ + 向 Typer 子应用注册全部 wizard 子命令。 + + :param app: wizard 子应用 + :return: None + """ + for registration, registrar in self.iter_command_registrars(): + registrar(app, registration) + + def iter_command_registrars(self) -> tuple[tuple[WizardCommandRegistration, WizardCommandRegistrar], ...]: + """ + 返回向导命令注册元数据与显式注册器映射。 + + 该方法将命令声明与注册函数绑定关系显式化,避免继续依赖 + `registrar_name -> getattr(self, ...)` 的字符串分发。 + + :return: 注册元数据与注册器映射列表 + """ + return ( + ( + WizardCommandRegistration('app-run', '通过交互方式启动应用'), + self._register_app_run_command, + ), + ( + WizardCommandRegistration('db-upgrade', '通过交互方式执行数据库升级'), + self._register_db_upgrade_command, + ), + ( + WizardCommandRegistration('cache-clear', '通过交互方式执行缓存清理'), + self._register_cache_clear_command, + ), + ( + WizardCommandRegistration('gen-export', '通过交互方式执行代码导出'), + self._register_gen_export_command, + ), + ( + WizardCommandRegistration('gen-import', '通过交互方式执行物理表导入'), + self._register_gen_import_command, + ), + ( + WizardCommandRegistration('prod-check', '通过交互方式执行生产巡检'), + self._register_prod_check_command, + ), + ) + + def _register_app_run_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `app-run` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def app_run() -> None: + """ + 通过交互方式启动应用。 + + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.app_run', 'run_app_run_wizard')() + + def _register_db_upgrade_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `db-upgrade` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def db_upgrade( + output: OutputOption = 'text', + default_env: str = typer.Option('dev', '--default-env', help='向导默认环境'), + default_revision: str = typer.Option('head', '--default-revision', help='向导默认目标 revision'), + default_dry_run: bool = typer.Option( + True, '--default-dry-run/--no-default-dry-run', help='向导默认 dry-run 选项' + ), + ) -> None: + """ + 通过交互方式执行数据库升级。 + + :param output: 输出格式 + :param default_env: 向导默认环境 + :param default_revision: 向导默认目标 revision + :param default_dry_run: 向导默认 dry-run 选项 + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.db_upgrade', 'run_db_upgrade_wizard')( + output, + default_env=default_env, + default_revision=default_revision, + default_dry_run=default_dry_run, + ) + + def _register_cache_clear_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `cache-clear` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def cache_clear( + output: OutputOption = 'text', + default_env: str = typer.Option('dev', '--default-env', help='向导默认环境'), + default_mode: str = typer.Option('cache-name', '--default-mode', help='向导默认清理模式'), + default_cache_name: str = typer.Option('', '--default-cache-name', help='向导默认缓存名称前缀'), + default_cache_key: str = typer.Option('', '--default-cache-key', help='向导默认缓存键关键字'), + default_dry_run: bool = typer.Option( + True, '--default-dry-run/--no-default-dry-run', help='向导默认 dry-run 选项' + ), + ) -> None: + """ + 通过交互方式执行缓存清理。 + + :param output: 输出格式 + :param default_env: 向导默认环境 + :param default_mode: 向导默认清理模式 + :param default_cache_name: 向导默认缓存名称前缀 + :param default_cache_key: 向导默认缓存键关键字 + :param default_dry_run: 向导默认 dry-run 选项 + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.cache_clear', 'run_cache_clear_wizard')( + output, + default_env=default_env, + default_mode=default_mode, + default_cache_name=default_cache_name, + default_cache_key=default_cache_key, + default_dry_run=default_dry_run, + ) + + def _register_gen_export_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `gen-export` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def gen_export( + output: OutputOption = 'text', + default_env: str = typer.Option('dev', '--default-env', help='向导默认环境'), + default_table_names: str = typer.Option('', '--default-table-names', help='向导默认业务表名称列表'), + default_mode: str = typer.Option('zip', '--default-mode', help='向导默认导出模式'), + default_output_file: str = typer.Option('', '--default-output-file', help='向导默认导出目标文件路径'), + default_dry_run: bool = typer.Option( + True, '--default-dry-run/--no-default-dry-run', help='向导默认 dry-run 选项' + ), + ) -> None: + """ + 通过交互方式执行代码导出。 + + :param output: 输出格式 + :param default_env: 向导默认环境 + :param default_table_names: 向导默认业务表名称列表 + :param default_mode: 向导默认导出模式 + :param default_output_file: 向导默认导出目标文件路径 + :param default_dry_run: 向导默认 dry-run 选项 + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.gen_export', 'run_gen_export_wizard')( + output, + default_env=default_env, + default_table_names=default_table_names, + default_mode=default_mode, + default_output_file=default_output_file, + default_dry_run=default_dry_run, + ) + + def _register_gen_import_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `gen-import` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def gen_import( + output: OutputOption = 'text', + default_env: str = typer.Option('dev', '--default-env', help='向导默认环境'), + default_table_names: str = typer.Option('', '--default-table-names', help='向导默认物理表名称列表'), + default_dry_run: bool = typer.Option( + True, '--default-dry-run/--no-default-dry-run', help='向导默认 dry-run 选项' + ), + ) -> None: + """ + 通过交互方式执行物理表导入。 + + :param output: 输出格式 + :param default_env: 向导默认环境 + :param default_table_names: 向导默认物理表名称列表 + :param default_dry_run: 向导默认 dry-run 选项 + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.gen_import', 'run_gen_import_wizard')( + output, + default_env=default_env, + default_table_names=default_table_names, + default_dry_run=default_dry_run, + ) + + def _register_prod_check_command(self, app: typer.Typer, registration: WizardCommandRegistration) -> None: + """ + 注册 `prod-check` 子命令。 + + :param app: wizard 子应用 + :param registration: 子命令注册元数据 + :return: None + """ + + @app.command(registration.name, help=registration.help_text) + def prod_check( + output: OutputOption = 'text', + default_env: str = typer.Option('prod', '--default-env', help='向导默认环境'), + default_include_config: bool = typer.Option( + True, + '--default-include-config/--no-default-include-config', + help='向导默认是否附带配置快照', + ), + ) -> None: + """ + 通过交互方式执行生产巡检。 + + :param output: 输出格式 + :param default_env: 向导默认环境 + :param default_include_config: 向导默认是否附带配置快照 + :return: None + """ + self.flow_loader.load_runner('cli.wizard.flows.prod_check', 'run_prod_check_wizard')( + output, + default_env=default_env, + default_include_config=default_include_config, + ) + + +WIZARD_COMMAND_BUILDER = WizardCommandBuilder() diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/__init__.py b/shierfeng-fastapi-backend/cli/wizard/flows/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/app_run.py b/shierfeng-fastapi-backend/cli/wizard/flows/app_run.py new file mode 100644 index 0000000..f04c910 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/app_run.py @@ -0,0 +1,152 @@ +from dataclasses import dataclass +from typing import Any + +from cli.context import CliContext +from cli.wizard.base import BaseLiveExecCliWizardFlow + + +@dataclass(frozen=True) +class AppRunWizardSelection: + """ + `wizard app-run` 向导采集结果。 + + :param env: 运行环境 + :param run_doctor: 启动前是否先执行应用检查 + """ + + env: str + run_doctor: bool + + +class AppRunWizardFlow(BaseLiveExecCliWizardFlow[AppRunWizardSelection]): + """ + `wizard app-run` 向导流程。 + + :param doctor_payload: 启动前检查结果缓存 + """ + + wizard_name = 'wizard app-run' + preview_title = 'wizard app-run preview' + failure_message = '应用启动向导执行失败' + + def collect_selection(self) -> AppRunWizardSelection: + """ + 采集应用启动向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env('dev') + run_doctor = self.prompt_service.prompt_confirm('启动前是否先执行应用检查', default_value=True) + return AppRunWizardSelection(env=env, run_doctor=run_doctor) + + def prepare_context(self, selection: AppRunWizardSelection, output: str) -> CliContext: + """ + 构建应用启动向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + del output + return self.build_readonly_context(selection.env, 'text') + + def build_preview_summary(self, selection: AppRunWizardSelection) -> dict[str, Any]: + """ + 构建应用启动预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'run_doctor': str(selection.run_doctor).lower(), + 'doctor_ok': '-' if self.doctor_payload is None else str(self.doctor_payload.get('ok', False)).lower(), + } + + def build_preview_command(self, selection: AppRunWizardSelection) -> list[str]: + """ + 构建应用启动预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + return ['shierfeng', 'app', 'run', f'--env={selection.env}'] + + def build_preview_notes(self, selection: AppRunWizardSelection) -> list[str] | None: + """ + 构建应用启动预览附加说明。 + + :param selection: 向导采集结果 + :return: 预览附加说明 + """ + del selection + notes: list[str] = [] + if isinstance(self.doctor_payload, dict) and not self.doctor_payload.get('ok', False): + notes.append(self.doctor_payload.get('message', '启动前检查未通过')) + return notes or None + + def confirm_prompt(self, selection: AppRunWizardSelection) -> str: + """ + 返回应用启动最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认启动应用吗' + + def confirm_default_value(self, selection: AppRunWizardSelection) -> bool: + """ + 返回应用启动确认默认值。 + + :param selection: 向导采集结果 + :return: 默认确认值 + """ + del selection + return bool(self.doctor_payload is None or self.doctor_payload.get('ok', False)) + + def build_execute_arguments(self, selection: AppRunWizardSelection, output: str) -> list[str]: + """ + 构建应用启动内部 CLI 参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + del output + return ['app', 'run', f'--env={selection.env}'] + + def __init__(self) -> None: + """ + 初始化应用启动向导流程。 + + :return: None + """ + super().__init__() + self.doctor_payload: dict[str, Any] | None = None + + def prepare_execution_state(self, selection: AppRunWizardSelection, output: str) -> None: + """ + 在预览与确认前准备启动前检查结果。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: None + """ + del output + self.doctor_payload = None + if selection.run_doctor: + doctor_result = self.run_nested_command( + 'app', 'doctor', f'--env={selection.env}', '--output=json', parse_json=True + ) + payload = getattr(doctor_result, 'payload', None) + self.doctor_payload = payload if isinstance(payload, dict) else None + + +def run_app_run_wizard() -> None: + """ + 执行 `wizard app-run` 向导。 + + :return: None + """ + AppRunWizardFlow().run('text') diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/cache_clear.py b/shierfeng-fastapi-backend/cli/wizard/flows/cache_clear.py new file mode 100644 index 0000000..3d5e806 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/cache_clear.py @@ -0,0 +1,213 @@ +from dataclasses import dataclass + +from cli.context import CliContext, OutputOption +from cli.wizard.base import BaseCliWizardFlow + + +@dataclass(frozen=True) +class CacheClearWizardSelection: + """ + `wizard cache-clear` 向导采集结果。 + + :param env: 运行环境 + :param mode: 清理模式 + :param cache_name: 缓存名称前缀 + :param cache_key: 缓存键名关键字 + :param dry_run: 是否演练执行 + :param allow_prod: 是否允许生产环境执行 + """ + + env: str + mode: str + cache_name: str + cache_key: str + dry_run: bool + allow_prod: bool + + +class CacheClearWizardFlow(BaseCliWizardFlow[CacheClearWizardSelection]): + """ + `wizard cache-clear` 向导流程。 + + :param default_env: 默认环境 + :param default_mode: 默认清理模式 + :param default_cache_name: 默认缓存名称前缀 + :param default_cache_key: 默认缓存键名关键字 + :param default_dry_run: 默认是否先执行 dry-run + """ + + wizard_name = 'wizard cache-clear' + preview_title = 'wizard cache-clear preview' + failure_message = '缓存清理向导执行失败' + + def __init__( + self, + *, + default_env: str = 'dev', + default_mode: str = 'cache-name', + default_cache_name: str = '', + default_cache_key: str = '', + default_dry_run: bool = True, + ) -> None: + """ + 初始化缓存清理向导流程。 + + :param default_env: 默认环境 + :param default_mode: 默认清理模式 + :param default_cache_name: 默认缓存名称前缀 + :param default_cache_key: 默认缓存键名关键字 + :param default_dry_run: 默认是否先执行 dry-run + :return: None + """ + self.default_env = default_env + self.default_mode = default_mode + self.default_cache_name = default_cache_name + self.default_cache_key = default_cache_key + self.default_dry_run = default_dry_run + + def collect_selection(self) -> CacheClearWizardSelection: + """ + 采集缓存清理向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env(self.default_env) + mode = self.prompt_service.prompt_choice( + '清理模式', + ['cache-name', 'cache-key', 'all'], + self.default_mode, + ) + cache_name = '' + cache_key = '' + if mode == 'cache-name': + cache_name = self.prompt_service.prompt_required_text('缓存名称前缀', self.default_cache_name) + elif mode == 'cache-key': + cache_key = self.prompt_service.prompt_required_text('缓存键名关键字', self.default_cache_key) + else: + self.prompt_service.prompt_optional_text('当前将清理全部缓存,按回车继续', '') + dry_run = self.prompt_service.prompt_confirm('是否先执行 dry-run 预演', default_value=self.default_dry_run) + allow_prod = ( + self.prompt_service.prompt_confirm('当前为 prod 环境,是否允许继续执行', default_value=False) + if env == 'prod' + else False + ) + return CacheClearWizardSelection( + env=env, + mode=mode, + cache_name=cache_name, + cache_key=cache_key, + dry_run=dry_run, + allow_prod=allow_prod, + ) + + def prepare_context(self, selection: CacheClearWizardSelection, output: OutputOption) -> CliContext: + """ + 构建缓存清理向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_regular_context( + selection.env, + output, + allow_prod=selection.allow_prod, + yes=True, + dry_run=selection.dry_run, + ) + + def build_preview_summary(self, selection: CacheClearWizardSelection) -> dict[str, str]: + """ + 构建缓存清理预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'mode': selection.mode, + 'cache_name': selection.cache_name or '-', + 'cache_key': selection.cache_key or '-', + 'dry_run': str(selection.dry_run).lower(), + 'allow_prod': str(selection.allow_prod).lower(), + } + + def build_preview_command(self, selection: CacheClearWizardSelection) -> list[str]: + """ + 构建缓存清理预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + command = ['shierfeng', 'cache', 'clear', f'--env={selection.env}'] + if selection.mode == 'cache-name': + command.append(f'--cache-name={selection.cache_name}') + elif selection.mode == 'cache-key': + command.append(f'--cache-key={selection.cache_key}') + else: + command.append('--all') + if selection.dry_run: + command.append('--dry-run') + if selection.allow_prod: + command.append('--allow-prod') + return command + + def confirm_prompt(self, selection: CacheClearWizardSelection) -> str: + """ + 返回缓存清理最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认执行缓存清理向导吗' + + def build_execute_arguments(self, selection: CacheClearWizardSelection, output: OutputOption) -> list[str]: + """ + 构建缓存清理内部 CLI 参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + arguments = ['cache', 'clear', f'--env={selection.env}', f'--output={output}', '--yes'] + if selection.mode == 'cache-name': + arguments.append(f'--cache-name={selection.cache_name}') + elif selection.mode == 'cache-key': + arguments.append(f'--cache-key={selection.cache_key}') + else: + arguments.append('--all') + if selection.dry_run: + arguments.append('--dry-run') + if selection.allow_prod: + arguments.append('--allow-prod') + return arguments + + +def run_cache_clear_wizard( + output: OutputOption = 'text', + *, + default_env: str = 'dev', + default_mode: str = 'cache-name', + default_cache_name: str = '', + default_cache_key: str = '', + default_dry_run: bool = True, +) -> None: + """ + 执行 `wizard cache-clear` 向导。 + + :param output: 输出格式 + :param default_env: 默认环境 + :param default_mode: 默认清理模式 + :param default_cache_name: 默认缓存名称前缀 + :param default_cache_key: 默认缓存键关键字 + :param default_dry_run: 默认是否执行 dry-run + :return: None + """ + CacheClearWizardFlow( + default_env=default_env, + default_mode=default_mode, + default_cache_name=default_cache_name, + default_cache_key=default_cache_key, + default_dry_run=default_dry_run, + ).run(output) diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/db_upgrade.py b/shierfeng-fastapi-backend/cli/wizard/flows/db_upgrade.py new file mode 100644 index 0000000..1f9c3b2 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/db_upgrade.py @@ -0,0 +1,169 @@ +from dataclasses import dataclass + +from cli.context import CliContext, OutputOption +from cli.wizard.base import BaseCliWizardFlow + + +@dataclass(frozen=True) +class DbUpgradeWizardSelection: + """ + `wizard db-upgrade` 向导采集结果。 + + :param env: 运行环境 + :param revision: 目标迁移版本 + :param dry_run: 是否演练执行 + :param allow_prod: 是否允许生产环境执行 + """ + + env: str + revision: str + dry_run: bool + allow_prod: bool + + +class DbUpgradeWizardFlow(BaseCliWizardFlow[DbUpgradeWizardSelection]): + """ + `wizard db-upgrade` 向导流程。 + + :param default_env: 默认环境 + :param default_revision: 默认目标 revision + :param default_dry_run: 默认是否先执行 dry-run + """ + + wizard_name = 'wizard db-upgrade' + preview_title = 'wizard db-upgrade preview' + failure_message = '数据库升级向导执行失败' + + def __init__( + self, + *, + default_env: str = 'dev', + default_revision: str = 'head', + default_dry_run: bool = True, + ) -> None: + """ + 初始化数据库升级向导流程。 + + :param default_env: 默认环境 + :param default_revision: 默认目标 revision + :param default_dry_run: 默认是否先执行 dry-run + :return: None + """ + self.default_env = default_env + self.default_revision = default_revision + self.default_dry_run = default_dry_run + + def collect_selection(self) -> DbUpgradeWizardSelection: + """ + 采集数据库升级向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env(self.default_env) + revision = self.prompt_service.prompt_required_text('目标迁移版本', self.default_revision) + dry_run = self.prompt_service.prompt_confirm('是否先执行 dry-run 预演', default_value=self.default_dry_run) + allow_prod = ( + self.prompt_service.prompt_confirm('当前为 prod 环境,是否允许继续执行', default_value=False) + if env == 'prod' + else False + ) + return DbUpgradeWizardSelection(env=env, revision=revision, dry_run=dry_run, allow_prod=allow_prod) + + def prepare_context(self, selection: DbUpgradeWizardSelection, output: OutputOption) -> CliContext: + """ + 构建数据库升级向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_regular_context( + selection.env, + output, + allow_prod=selection.allow_prod, + yes=True, + dry_run=selection.dry_run, + ) + + def build_preview_summary(self, selection: DbUpgradeWizardSelection) -> dict[str, str]: + """ + 构建数据库升级预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'revision': selection.revision, + 'dry_run': str(selection.dry_run).lower(), + 'allow_prod': str(selection.allow_prod).lower(), + } + + def build_preview_command(self, selection: DbUpgradeWizardSelection) -> list[str]: + """ + 构建数据库升级预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + command = ['shierfeng', 'db', 'upgrade', f'--env={selection.env}', f'--revision={selection.revision}'] + if selection.dry_run: + command.append('--dry-run') + if selection.allow_prod: + command.append('--allow-prod') + return command + + def confirm_prompt(self, selection: DbUpgradeWizardSelection) -> str: + """ + 返回数据库升级最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认执行数据库升级向导吗' + + def build_execute_arguments(self, selection: DbUpgradeWizardSelection, output: OutputOption) -> list[str]: + """ + 构建数据库升级内部 CLI 参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + arguments = [ + 'db', + 'upgrade', + f'--env={selection.env}', + f'--output={output}', + f'--revision={selection.revision}', + '--yes', + ] + if selection.dry_run: + arguments.append('--dry-run') + if selection.allow_prod: + arguments.append('--allow-prod') + return arguments + + +def run_db_upgrade_wizard( + output: OutputOption = 'text', + *, + default_env: str = 'dev', + default_revision: str = 'head', + default_dry_run: bool = True, +) -> None: + """ + 执行 `wizard db-upgrade` 向导。 + + :param output: 输出格式 + :param default_env: 默认环境 + :param default_revision: 默认目标 revision + :param default_dry_run: 默认是否先 dry-run + :return: None + """ + DbUpgradeWizardFlow( + default_env=default_env, + default_revision=default_revision, + default_dry_run=default_dry_run, + ).run(output) diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/gen_export.py b/shierfeng-fastapi-backend/cli/wizard/flows/gen_export.py new file mode 100644 index 0000000..1a2bf0b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/gen_export.py @@ -0,0 +1,239 @@ +from dataclasses import dataclass + +import typer + +from cli.context import CliContext, OutputOption +from cli.wizard.base import BaseCliWizardFlow + + +@dataclass(frozen=True) +class GenExportWizardSelection: + """ + `wizard gen-export` 向导采集结果。 + + :param env: 运行环境 + :param table_names: 业务表名称列表 + :param mode: 导出模式 + :param output_file: zip 导出目标文件路径 + :param dry_run: 是否演练执行 + :param allow_prod: 是否允许生产环境执行 + """ + + env: str + table_names: list[str] + mode: str + output_file: str + dry_run: bool + allow_prod: bool + + +class GenExportWizardFlow(BaseCliWizardFlow[GenExportWizardSelection]): + """ + `wizard gen-export` 向导流程。 + + :param default_env: 默认环境 + :param default_table_names: 默认业务表名称列表文本 + :param default_mode: 默认导出模式 + :param default_output_file: 默认 zip 导出目标文件路径 + :param default_dry_run: 默认是否先执行 dry-run + """ + + wizard_name = 'wizard gen-export' + preview_title = 'wizard gen-export preview' + failure_message = '代码导出向导执行失败' + + def __init__( + self, + *, + default_env: str = 'dev', + default_table_names: str = '', + default_mode: str = 'zip', + default_output_file: str = '', + default_dry_run: bool = True, + ) -> None: + """ + 初始化代码导出向导流程。 + + :param default_env: 默认环境 + :param default_table_names: 默认业务表名称列表文本 + :param default_mode: 默认导出模式 + :param default_output_file: 默认 zip 导出目标文件路径 + :param default_dry_run: 默认是否先执行 dry-run + :return: None + """ + self.default_env = default_env + self.default_table_names = default_table_names + self.default_mode = default_mode + self.default_output_file = default_output_file + self.default_dry_run = default_dry_run + + def collect_selection(self) -> GenExportWizardSelection: + """ + 采集代码导出向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env(self.default_env) + raw_table_names = self.prompt_service.prompt_required_text( + '业务表名称列表(多个表请使用逗号分隔)', + self.default_table_names, + ) + table_names = self.parse_table_names(raw_table_names) + while not table_names: + typer.echo('至少需要输入一个业务表名称,请重新输入。') + raw_table_names = self.prompt_service.prompt_required_text( + '业务表名称列表(多个表请使用逗号分隔)', + self.default_table_names, + ) + table_names = self.parse_table_names(raw_table_names) + + mode = self.prompt_service.prompt_choice('导出模式', ['zip', 'local'], self.default_mode) + output_file = '' + if mode == 'zip': + output_file = self.prompt_service.prompt_optional_text( + 'zip 导出目标文件路径(留空则使用默认文件名)', + self.default_output_file, + ) + dry_run = self.prompt_service.prompt_confirm('是否先执行 dry-run 预演', default_value=self.default_dry_run) + allow_prod = ( + self.prompt_service.prompt_confirm('当前为 prod 环境,是否允许继续执行', default_value=False) + if env == 'prod' + else False + ) + return GenExportWizardSelection( + env=env, + table_names=table_names, + mode=mode, + output_file=output_file, + dry_run=dry_run, + allow_prod=allow_prod, + ) + + def prepare_context(self, selection: GenExportWizardSelection, output: OutputOption) -> CliContext: + """ + 构建代码导出向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_regular_context( + selection.env, + output, + allow_prod=selection.allow_prod, + yes=True, + dry_run=selection.dry_run, + ) + + def build_preview_summary(self, selection: GenExportWizardSelection) -> dict[str, str]: + """ + 构建代码导出预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'table_names': ','.join(selection.table_names), + 'mode': selection.mode, + 'output_file': selection.output_file or '-', + 'dry_run': str(selection.dry_run).lower(), + 'allow_prod': str(selection.allow_prod).lower(), + } + + def build_preview_command(self, selection: GenExportWizardSelection) -> list[str]: + """ + 构建代码导出预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + command = [ + 'shierfeng', + 'gen', + 'export', + *selection.table_names, + f'--env={selection.env}', + f'--mode={selection.mode}', + ] + if selection.output_file: + command.append(f'--output-file={selection.output_file}') + if selection.dry_run: + command.append('--dry-run') + if selection.allow_prod: + command.append('--allow-prod') + return command + + def confirm_prompt(self, selection: GenExportWizardSelection) -> str: + """ + 返回代码导出最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认执行代码导出向导吗' + + def build_execute_arguments(self, selection: GenExportWizardSelection, output: OutputOption) -> list[str]: + """ + 构建代码导出内部 CLI 参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + arguments = [ + 'gen', + 'export', + *selection.table_names, + f'--env={selection.env}', + f'--output={output}', + f'--mode={selection.mode}', + '--yes', + ] + if selection.output_file: + arguments.append(f'--output-file={selection.output_file}') + if selection.dry_run: + arguments.append('--dry-run') + if selection.allow_prod: + arguments.append('--allow-prod') + return arguments + + @staticmethod + def parse_table_names(raw_value: str) -> list[str]: + """ + 将逗号分隔的业务表名称文本解析为列表。 + + :param raw_value: 原始输入文本 + :return: 去空白后的业务表名称列表 + """ + return [table_name.strip() for table_name in raw_value.split(',') if table_name.strip()] + + +def run_gen_export_wizard( + output: OutputOption = 'text', + *, + default_env: str = 'dev', + default_table_names: str = '', + default_mode: str = 'zip', + default_output_file: str = '', + default_dry_run: bool = True, +) -> None: + """ + 执行 `wizard gen-export` 向导。 + + :param output: 输出格式 + :param default_env: 默认环境 + :param default_table_names: 默认业务表名称列表文本 + :param default_mode: 默认导出模式 + :param default_output_file: 默认 zip 导出目标文件路径 + :param default_dry_run: 默认是否先 dry-run + :return: None + """ + GenExportWizardFlow( + default_env=default_env, + default_table_names=default_table_names, + default_mode=default_mode, + default_output_file=default_output_file, + default_dry_run=default_dry_run, + ).run(output) diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/gen_import.py b/shierfeng-fastapi-backend/cli/wizard/flows/gen_import.py new file mode 100644 index 0000000..d57db10 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/gen_import.py @@ -0,0 +1,208 @@ +from dataclasses import dataclass + +import typer + +from cli.context import CliContext, OutputOption +from cli.wizard.base import BaseCliWizardFlow + + +@dataclass(frozen=True) +class GenImportWizardSelection: + """ + `wizard gen-import` 向导采集结果。 + + :param env: 运行环境 + :param table_names: 待导入物理表名称列表 + :param dry_run: 是否演练执行 + :param allow_prod: 是否允许生产环境执行 + """ + + env: str + table_names: list[str] + dry_run: bool + allow_prod: bool + + +class GenImportWizardFlow(BaseCliWizardFlow[GenImportWizardSelection]): + """ + `wizard gen-import` 向导流程。 + + :param default_env: 默认环境 + :param default_table_names: 默认物理表名称列表文本 + :param default_dry_run: 默认是否先执行 dry-run + """ + + wizard_name = 'wizard gen-import' + preview_title = 'wizard gen-import preview' + failure_message = '代码生成导入向导执行失败' + + def __init__( + self, + *, + default_env: str = 'dev', + default_table_names: str = '', + default_dry_run: bool = True, + ) -> None: + """ + 初始化代码生成导入向导流程。 + + :param default_env: 默认环境 + :param default_table_names: 默认物理表名称列表文本 + :param default_dry_run: 默认是否先执行 dry-run + :return: None + """ + self.default_env = default_env + self.default_table_names = default_table_names + self.default_dry_run = default_dry_run + + def collect_selection(self) -> GenImportWizardSelection: + """ + 采集代码生成导入向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env(self.default_env) + raw_table_names = self.prompt_service.prompt_required_text( + '物理表名称列表(多个表请使用逗号分隔)', + self.default_table_names, + ) + table_names = self.parse_table_names(raw_table_names) + while not table_names: + typer.echo('至少需要输入一个物理表名称,请重新输入。') + raw_table_names = self.prompt_service.prompt_required_text( + '物理表名称列表(多个表请使用逗号分隔)', + self.default_table_names, + ) + table_names = self.parse_table_names(raw_table_names) + + dry_run = self.prompt_service.prompt_confirm('是否先执行 dry-run 预演', default_value=self.default_dry_run) + allow_prod = ( + self.prompt_service.prompt_confirm('当前为 prod 环境,是否允许继续执行', default_value=False) + if env == 'prod' + else False + ) + return GenImportWizardSelection( + env=env, + table_names=table_names, + dry_run=dry_run, + allow_prod=allow_prod, + ) + + def prepare_context(self, selection: GenImportWizardSelection, output: OutputOption) -> CliContext: + """ + 构建代码生成导入向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_regular_context( + selection.env, + output, + allow_prod=selection.allow_prod, + yes=True, + dry_run=selection.dry_run, + ) + + def build_preview_summary(self, selection: GenImportWizardSelection) -> dict[str, str]: + """ + 构建代码生成导入预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'table_names': ','.join(selection.table_names), + 'dry_run': str(selection.dry_run).lower(), + 'allow_prod': str(selection.allow_prod).lower(), + } + + def build_preview_command(self, selection: GenImportWizardSelection) -> list[str]: + """ + 构建代码生成导入预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + command = ['shierfeng', 'gen', 'import-table', *selection.table_names, f'--env={selection.env}'] + if selection.dry_run: + command.append('--dry-run') + if selection.allow_prod: + command.append('--allow-prod') + return command + + def build_preview_notes(self, selection: GenImportWizardSelection) -> list[str] | None: + """ + 构建代码生成导入预览附加说明。 + + :param selection: 向导采集结果 + :return: 预览附加说明 + """ + del selection + return ['建议先确认物理表注释和字段规模,再决定是否执行真实导入。'] + + def confirm_prompt(self, selection: GenImportWizardSelection) -> str: + """ + 返回代码生成导入最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认执行代码生成导入向导吗' + + def build_execute_arguments(self, selection: GenImportWizardSelection, output: OutputOption) -> list[str]: + """ + 构建代码生成导入内部 CLI 参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + arguments = [ + 'gen', + 'import-table', + *selection.table_names, + f'--env={selection.env}', + f'--output={output}', + '--yes', + ] + if selection.dry_run: + arguments.append('--dry-run') + if selection.allow_prod: + arguments.append('--allow-prod') + return arguments + + @staticmethod + def parse_table_names(raw_value: str) -> list[str]: + """ + 将逗号分隔的物理表名称文本解析为列表。 + + :param raw_value: 原始输入文本 + :return: 去空白后的物理表名称列表 + """ + return [table_name.strip() for table_name in raw_value.split(',') if table_name.strip()] + + +def run_gen_import_wizard( + output: OutputOption = 'text', + *, + default_env: str = 'dev', + default_table_names: str = '', + default_dry_run: bool = True, +) -> None: + """ + 执行 `wizard gen-import` 向导。 + + :param output: 输出格式 + :param default_env: 默认环境 + :param default_table_names: 默认物理表名称列表文本 + :param default_dry_run: 默认是否先 dry-run + :return: None + """ + GenImportWizardFlow( + default_env=default_env, + default_table_names=default_table_names, + default_dry_run=default_dry_run, + ).run(output) diff --git a/shierfeng-fastapi-backend/cli/wizard/flows/prod_check.py b/shierfeng-fastapi-backend/cli/wizard/flows/prod_check.py new file mode 100644 index 0000000..8071296 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/flows/prod_check.py @@ -0,0 +1,224 @@ +from dataclasses import dataclass +from typing import Any + +from cli.context import CliContext, OutputOption +from cli.wizard.aggregators import ProdCheckAggregator +from cli.wizard.base import BaseCliWizardFlow +from cli.wizard.presenters import ProdCheckPresenter + + +@dataclass(frozen=True) +class ProdCheckWizardSelection: + """ + `wizard prod-check` 向导采集结果。 + + :param env: 运行环境 + :param include_config: 是否附带配置快照 + """ + + env: str + include_config: bool + + +class ProdCheckWizardFlow(BaseCliWizardFlow[ProdCheckWizardSelection]): + """ + `wizard prod-check` 向导流程。 + + :param default_env: 默认环境 + :param default_include_config: 默认是否附带配置快照 + """ + + wizard_name = 'wizard prod-check' + preview_title = 'wizard prod-check preview' + failure_message = '生产巡检向导执行失败' + + def __init__( + self, + *, + default_env: str = 'prod', + default_include_config: bool = True, + ) -> None: + """ + 初始化生产巡检向导流程。 + + :param default_env: 默认环境 + :param default_include_config: 默认是否附带配置快照 + :return: None + """ + super().__init__() + self.default_env = default_env + self.default_include_config = default_include_config + self.aggregator = ProdCheckAggregator() + self.presenter = ProdCheckPresenter() + + def collect_selection(self) -> ProdCheckWizardSelection: + """ + 采集生产巡检向导参数。 + + :return: 向导采集结果 + """ + env = self.prompt_service.prompt_env(self.default_env) + include_config = self.prompt_service.prompt_confirm( + '是否附带应用配置快照', + default_value=self.default_include_config, + ) + return ProdCheckWizardSelection(env=env, include_config=include_config) + + def prepare_context(self, selection: ProdCheckWizardSelection, output: OutputOption) -> CliContext: + """ + 构建生产巡检向导上下文。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: CLI 上下文 + """ + return self.build_readonly_context(selection.env, output) + + def build_preview_summary(self, selection: ProdCheckWizardSelection) -> dict[str, str]: + """ + 构建生产巡检预览摘要。 + + :param selection: 向导采集结果 + :return: 预览摘要 + """ + return { + 'env': selection.env, + 'include_config': str(selection.include_config).lower(), + } + + def build_preview_command(self, selection: ProdCheckWizardSelection) -> list[str]: + """ + 构建生产巡检预览命令。 + + :param selection: 向导采集结果 + :return: 用户视角命令参数 + """ + return ['shierfeng', 'app', 'doctor', f'--env={selection.env}'] + + def confirm_prompt(self, selection: ProdCheckWizardSelection) -> str: + """ + 返回生产巡检最终确认提示。 + + :param selection: 向导采集结果 + :return: 确认提示 + """ + del selection + return '确认执行生产巡检向导吗' + + def confirm_default_value(self, selection: ProdCheckWizardSelection) -> bool: + """ + 返回生产巡检确认默认值。 + + :param selection: 向导采集结果 + :return: 默认确认值 + """ + del selection + return True + + def build_execute_arguments(self, selection: ProdCheckWizardSelection, output: OutputOption) -> list[str]: + """ + 返回生产巡检占位执行参数。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 内部 CLI 参数 + """ + del selection, output + return [] + + def execute(self, selection: ProdCheckWizardSelection, output: OutputOption) -> dict[str, Any]: + """ + 执行生产巡检聚合逻辑。 + + :param selection: 向导采集结果 + :param output: 输出格式 + :return: 聚合后的巡检结果 + """ + del output + runtime_result = self.run_nested_command( + 'app', 'env', f'--env={selection.env}', '--output=json', parse_json=True + ) + doctor_result = self.run_nested_command( + 'app', + 'doctor', + f'--env={selection.env}', + '--output=json', + parse_json=True, + ) + config_payload = None + if selection.include_config: + config_result = self.run_nested_command( + 'app', + 'config', + f'--env={selection.env}', + '--output=json', + parse_json=True, + ) + config_payload = config_result.payload + return self.aggregator.build_payload( + env=selection.env, + runtime_payload=runtime_result.payload if isinstance(runtime_result.payload, dict) else None, + doctor_payload=doctor_result.payload if isinstance(doctor_result.payload, dict) else None, + config_payload=config_payload, + ) + + def complete_payload( + self, + ctx: CliContext, + payload: dict[str, Any], + *, + default_exit_code: int = 0, + ) -> None: + """ + 以聚合结果展示器收口生产巡检结果。 + + :param ctx: CLI 上下文 + :param payload: 聚合结果负载 + :param default_exit_code: 默认退出码 + :return: None + """ + self.complete_payload_result( + ctx, + payload, + text_builder=self.presenter.build_text, + default_exit_code=default_exit_code, + ) + + def extract_payload(self, nested_result: Any) -> dict[str, Any] | None: + """ + 提取生产巡检聚合结果负载。 + + :param nested_result: 聚合执行结果 + :return: 结构化结果负载 + """ + return nested_result if isinstance(nested_result, dict) else None + + def extract_returncode(self, nested_result: Any) -> int: + """ + 提取生产巡检聚合结果退出码。 + + :param nested_result: 聚合执行结果 + :return: 退出码 + """ + del nested_result + return 0 + + +def run_prod_check_wizard( + output: OutputOption = 'text', + *, + default_env: str = 'prod', + default_include_config: bool = True, +) -> None: + """ + 执行 `wizard prod-check` 向导。 + + :param output: 输出格式 + :param default_env: 默认环境 + :param default_include_config: 默认是否附带配置快照 + :return: None + """ + ProdCheckWizardFlow( + default_env=default_env, + default_include_config=default_include_config, + ).run(output) diff --git a/shierfeng-fastapi-backend/cli/wizard/presenters.py b/shierfeng-fastapi-backend/cli/wizard/presenters.py new file mode 100644 index 0000000..a0eea0b --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/presenters.py @@ -0,0 +1,95 @@ +from dataclasses import dataclass +from typing import Any + + +@dataclass(frozen=True) +class ProdCheckRenderingSupport: + """ + `wizard prod-check` 文本渲染支持对象。 + + 该对象负责构建 runtime、doctor、config 分区文本行, + 避免 presenter 本体继续维护全部分区细节。 + """ + + @staticmethod + def build_runtime_lines(runtime: dict[str, Any]) -> list[str]: + """ + 构建 runtime 分区文本行。 + + :param runtime: runtime 结果片段 + :return: 文本行列表 + """ + return [ + 'runtime:', + f' cli_env: {runtime.get("cliEnv", "-")}', + f' config_env: {runtime.get("configEnv", "-")}', + f' env_file: {runtime.get("envFile", "-")}', + f' env_file_exists: {str(runtime.get("envFileExists", False)).lower()}', + ] + + @staticmethod + def build_doctor_lines(doctor: dict[str, Any]) -> list[str]: + """ + 构建 doctor 分区文本行。 + + :param doctor: doctor 结果片段 + :return: 文本行列表 + """ + return [ + 'doctor:', + f' ok: {str(doctor.get("ok", False)).lower()}', + f' message: {doctor.get("message", "-")}', + ] + + @staticmethod + def build_config_lines(config: dict[str, Any]) -> list[str]: + """ + 构建 config 分区文本行。 + + :param config: config 结果片段 + :return: 文本行列表 + """ + return [ + 'config:', + f' name: {config.get("name", "-")}', + f' host: {config.get("host", "-")}:{config.get("port", "-")}', + f' db_type: {config.get("dbType", "-")}', + f' redis_host: {config.get("redisHost", "-")}:{config.get("redisPort", "-")}', + ] + + +@dataclass(frozen=True) +class ProdCheckPresenter: + """ + `wizard prod-check` 结果展示器。 + + 该对象负责将聚合结果转换为文本摘要, + 避免在 flow 内继续维护文本渲染细节。 + + :param rendering_support: 文本渲染支持对象 + """ + + rendering_support: ProdCheckRenderingSupport = ProdCheckRenderingSupport() + + def build_text(self, payload: dict[str, Any]) -> str: + """ + 将生产巡检聚合结果渲染为文本摘要。 + + :param payload: 聚合结果字典 + :return: 文本摘要 + """ + lines = [ + f'ok: {str(payload.get("ok", False)).lower()}', + f'env: {payload.get("env", "-")}', + f'message: {payload.get("message", "-")}', + ] + runtime = payload.get('runtime') + if isinstance(runtime, dict): + lines.extend(self.rendering_support.build_runtime_lines(runtime)) + doctor = payload.get('doctor') + if isinstance(doctor, dict): + lines.extend(self.rendering_support.build_doctor_lines(doctor)) + config = payload.get('config') + if isinstance(config, dict): + lines.extend(self.rendering_support.build_config_lines(config)) + return '\n'.join(lines) diff --git a/shierfeng-fastapi-backend/cli/wizard/preview.py b/shierfeng-fastapi-backend/cli/wizard/preview.py new file mode 100644 index 0000000..96b31f7 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/preview.py @@ -0,0 +1,65 @@ +from typing import Any + +from cli.exit_codes import GUARD_REJECTED +from cli.output import CommandResult +from cli.utils import SHELL_TEXT_FORMATTER + + +class WizardPreviewRenderer: + """ + 向导预览渲染器。 + + 该对象负责统一构建向导预览文本和取消结果, + 为各个 flow 提供稳定的类式渲染入口。 + """ + + @staticmethod + def render_preview( + title: str, + *, + summary: dict[str, Any], + command: list[str], + notes: list[str] | None = None, + ) -> str: + """ + 渲染向导执行预览文本。 + + :param title: 预览标题 + :param summary: 关键参数摘要 + :param command: 用户视角命令参数列表 + :param notes: 额外提示列表 + :return: 可直接输出的预览文本 + """ + lines = [title, 'summary:'] + for key, value in summary.items(): + lines.append(f' {key}: {value}') + lines.extend( + [ + 'command:', + f' {SHELL_TEXT_FORMATTER.format_shell_command(command)}', + ] + ) + if notes: + lines.append('notes:') + lines.extend(f' - {note}' for note in notes if note) + return '\n'.join(lines) + + @staticmethod + def build_cancel_result(wizard_name: str) -> CommandResult: + """ + 构建向导取消结果。 + + :param wizard_name: 向导名称 + :return: 命令结果对象 + """ + return CommandResult( + data={ + 'ok': False, + 'message': f'已取消向导执行:{wizard_name}', + 'hint': '可重新运行向导并调整参数后再次执行', + }, + exit_code=GUARD_REJECTED, + ) + + +WIZARD_PREVIEW_RENDERER = WizardPreviewRenderer() diff --git a/shierfeng-fastapi-backend/cli/wizard/prompts.py b/shierfeng-fastapi-backend/cli/wizard/prompts.py new file mode 100644 index 0000000..004ae76 --- /dev/null +++ b/shierfeng-fastapi-backend/cli/wizard/prompts.py @@ -0,0 +1,86 @@ +import typer + +from cli.metadata import ENVIRONMENT_OPTION_SERVICE + + +class WizardPromptService: + """ + 向导交互输入服务。 + + 该对象集中封装向导中稳定复用的环境选择、枚举选择、 + 文本采集和确认交互逻辑,避免继续扩散模块级散函数入口。 + """ + + def prompt_env(self, default_env: str = 'dev') -> str: + """ + 交互采集运行环境名称。 + + :param default_env: 默认环境名称 + :return: 用户选择的环境名称 + """ + env_names = ENVIRONMENT_OPTION_SERVICE.discover_env_names() + prompt_message = f'运行环境(可选值: {", ".join(env_names)})' + while True: + env_value = typer.prompt(prompt_message, default=default_env).strip() + if env_value in env_names: + return env_value + typer.echo(f'不支持的环境名称:{env_value},请重新输入。') + + @staticmethod + def prompt_choice(prompt_text: str, choices: list[str], default_value: str) -> str: + """ + 交互采集枚举型文本输入。 + + :param prompt_text: 提示文案 + :param choices: 可选值列表 + :param default_value: 默认值 + :return: 用户选择的枚举值 + """ + while True: + value = typer.prompt( + f'{prompt_text}(可选值: {", ".join(choices)})', + default=default_value, + ).strip() + if value in choices: + return value + typer.echo(f'不支持的选项:{value},请重新输入。') + + @staticmethod + def prompt_required_text(prompt_text: str, default_value: str = '') -> str: + """ + 交互采集必填文本输入。 + + :param prompt_text: 提示文案 + :param default_value: 默认值 + :return: 用户输入文本 + """ + while True: + value = typer.prompt(prompt_text, default=default_value).strip() + if value: + return value + typer.echo('该字段不能为空,请重新输入。') + + @staticmethod + def prompt_optional_text(prompt_text: str, default_value: str = '') -> str: + """ + 交互采集可选文本输入。 + + :param prompt_text: 提示文案 + :param default_value: 默认值 + :return: 用户输入文本 + """ + return typer.prompt(prompt_text, default=default_value).strip() + + @staticmethod + def prompt_confirm(prompt_text: str, default_value: bool = False) -> bool: + """ + 交互采集确认型输入。 + + :param prompt_text: 提示文案 + :param default_value: 默认值 + :return: 用户确认结果 + """ + return typer.confirm(prompt_text, default=default_value) + + +WIZARD_PROMPT_SERVICE = WizardPromptService() diff --git a/shierfeng-fastapi-backend/common/annotation/cache_annotation.py b/shierfeng-fastapi-backend/common/annotation/cache_annotation.py new file mode 100644 index 0000000..aabeefa --- /dev/null +++ b/shierfeng-fastapi-backend/common/annotation/cache_annotation.py @@ -0,0 +1,502 @@ +import hashlib +import json +from collections.abc import Awaitable, Callable, Sequence +from datetime import datetime +from functools import wraps +from typing import Any, TypeVar + +from fastapi import Request +from fastapi.encoders import jsonable_encoder +from fastapi.responses import JSONResponse, ORJSONResponse, Response, StreamingResponse, UJSONResponse +from redis import asyncio as aioredis +from typing_extensions import ParamSpec + +from common.constant import HttpStatusConstant +from common.context import RequestContext +from common.enums import HttpMethod, RedisInitKeyConfig +from exceptions.exception import LoginException +from utils.api_annotation_util import ApiAnnotationUtil +from utils.api_response_header_util import ApiResponseHeaderUtil +from utils.log_util import logger + +P = ParamSpec('P') +R = TypeVar('R') + + +class ApiCacheManager: + """ + 接口缓存键与命名空间管理工具类 + """ + + @classmethod + async def clear_namespace(cls, redis: aioredis.Redis, namespace: str) -> int: + """ + 清理指定命名空间下的接口缓存 + + :param redis: Redis连接对象 + :param namespace: 缓存命名空间 + :return: 删除的缓存数量 + """ + return await cls._clear_by_pattern(redis, cls.build_namespace_pattern(namespace)) + + @classmethod + async def clear_all(cls, redis: aioredis.Redis) -> int: + """ + 清理所有接口缓存 + + :param redis: Redis连接对象 + :return: 删除的缓存数量 + """ + return await cls._clear_by_pattern(redis, cls.build_namespace_pattern('*')) + + @classmethod + async def clear_namespaces(cls, redis: aioredis.Redis, namespaces: list[str] | tuple[str, ...] | set[str]) -> int: + """ + 批量清理多个命名空间下的接口缓存 + + :param redis: Redis连接对象 + :param namespaces: 需要清理的缓存命名空间列表 + :return: 删除的缓存数量 + """ + deleted_count = 0 + for namespace in set(namespaces): + deleted_count += await cls.clear_namespace(redis, namespace) + + return deleted_count + + @classmethod + async def clear_namespace_prefix(cls, redis: aioredis.Redis, namespace_prefix: str) -> int: + """ + 按命名空间前缀清理接口缓存 + + :param redis: Redis连接对象 + :param namespace_prefix: 缓存命名空间前缀 + :return: 删除的缓存数量 + """ + return await cls._clear_by_pattern(redis, cls.build_namespace_prefix_pattern(namespace_prefix)) + + @classmethod + async def clear_namespace_prefixes( + cls, + redis: aioredis.Redis, + namespace_prefixes: list[str] | tuple[str, ...] | set[str], + ) -> int: + """ + 批量按命名空间前缀清理接口缓存 + + :param redis: Redis连接对象 + :param namespace_prefixes: 需要清理的缓存命名空间前缀列表 + :return: 删除的缓存数量 + """ + deleted_count = 0 + for namespace_prefix in set(namespace_prefixes): + deleted_count += await cls.clear_namespace_prefix(redis, namespace_prefix) + + return deleted_count + + @classmethod + def build_namespace_pattern(cls, namespace: str) -> str: + """ + 生成命名空间扫描表达式 + + :param namespace: 缓存命名空间 + :return: 缓存键扫描匹配模式 + """ + return f'{RedisInitKeyConfig.API_CACHE.key}:{namespace}:*' + + @classmethod + def build_namespace_prefix_pattern(cls, namespace_prefix: str) -> str: + """ + 生成命名空间前缀扫描表达式 + + :param namespace_prefix: 缓存命名空间前缀 + :return: 缓存键扫描匹配模式 + """ + return f'{RedisInitKeyConfig.API_CACHE.key}:{namespace_prefix}*' + + @classmethod + async def _clear_by_pattern(cls, redis: aioredis.Redis, pattern: str) -> int: + """ + 根据扫描表达式清理匹配的接口缓存 + + :param redis: Redis连接对象 + :param pattern: 缓存键扫描匹配模式 + :return: 删除的缓存数量 + """ + cache_keys = [key async for key in redis.scan_iter(match=pattern)] + if not cache_keys: + return 0 + + return await redis.delete(*cache_keys) + + +class _ApiCacheSupport: + """ + 接口缓存装饰器共用工具基类 + """ + + def _load_json_content(self, response_body: str) -> Any | None: + """ + 解析JSON响应体内容 + + :param response_body: JSON字符串响应体 + :return: 解析后的Python对象,解析失败时返回None + """ + try: + return json.loads(response_body) + except json.JSONDecodeError: + return None + + def _extract_json_response_content(self, result: Any) -> Any | None: + """ + 提取响应中的JSON内容 + + :param result: 原始接口返回结果 + :return: 解析后的JSON内容,无法提取时返回None + """ + if result is None or isinstance(result, StreamingResponse): + return None + + if isinstance(result, (JSONResponse, ORJSONResponse, UJSONResponse)): + return self._load_json_content(result.body.decode('utf-8')) + + if isinstance(result, Response): + return None + + return jsonable_encoder(result) + + def _match_response_codes(self, response_content: Any, response_codes: set[int]) -> bool: + """ + 判断响应内容中的业务响应码是否匹配 + + :param response_content: JSON响应内容 + :param response_codes: 允许的业务响应码集合 + :return: 是否匹配 + """ + if not isinstance(response_content, dict): + return True + + response_code = response_content.get('code') + if response_code is None: + return True + + return response_code in response_codes + + def _get_matched_response_content(self, result: Any, response_codes: set[int]) -> Any | None: + """ + 提取并校验满足业务响应码要求的JSON响应内容 + + :param result: 原始接口返回结果 + :param response_codes: 允许的业务响应码集合 + :return: 匹配成功的JSON响应内容,不匹配时返回None + """ + response_content = self._extract_json_response_content(result) + if response_content is None or not self._match_response_codes(response_content, response_codes): + return None + + return response_content + + +class ApiCache(_ApiCacheSupport): + """ + 接口缓存装饰器,仅用于幂等且返回JSON的接口 + """ + + def __init__( + self, + namespace: str, + expire_seconds: int = 10, + vary_by_user: bool = True, + methods: Sequence[HttpMethod] | None = None, + cache_response_codes: set[int] | None = None, + ) -> None: + """ + 初始化接口缓存装饰器 + + :param namespace: 缓存命名空间,用于区分不同接口类型 + :param expire_seconds: 缓存过期时间,单位秒 + :param vary_by_user: 是否按当前登录用户隔离缓存 + :param methods: 允许启用缓存的HttpMethod枚举列表,为None时默认仅缓存GET请求 + :param cache_response_codes: 允许缓存的业务响应码,为None时默认仅缓存成功响应 + """ + self.namespace = namespace + self.expire_seconds = expire_seconds + self.vary_by_user = vary_by_user + self.methods = ApiAnnotationUtil.normalize_http_methods(methods, default_methods=(HttpMethod.GET,)) + self.cache_response_codes = ( + cache_response_codes if cache_response_codes is not None else {HttpStatusConstant.SUCCESS} + ) + + def __call__(self, func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]: + """ + 为目标异步接口函数增加接口缓存能力 + + :param func: 需要被缓存的异步接口函数 + :return: 包装后的异步接口函数 + """ + + @wraps(func) + async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: + request, redis = ApiAnnotationUtil.resolve_request_redis( + func, '当前应用未初始化Redis连接,跳过接口缓存', *args, **kwargs + ) + if request is None or redis is None: + return await func(*args, **kwargs) + if not self._is_request_method_allowed(request): + return await func(*args, **kwargs) + + cache_key = await self._build_cache_key(request) + cached_response = await redis.get(cache_key) + if cached_response: + return self._build_cached_response(cached_response) # type: ignore[return-value] + + result = await func(*args, **kwargs) + await self._cache_response(redis, cache_key, result) + ApiResponseHeaderUtil.merge_headers(request, {'X-Api-Cache': 'MISS'}) + + return result + + return wrapper + + def _is_request_method_allowed(self, request: Request) -> bool: + """ + 判断当前请求方法是否允许启用接口缓存 + + :param request: 当前请求对象 + :return: 是否允许缓存 + """ + return request.method.upper() in self.methods + + async def _build_cache_key(self, request: Request) -> str: + """ + 根据当前请求生成稳定缓存键 + + :param request: 当前请求对象 + :return: 接口缓存键 + """ + request_body = await request.body() + user_scope = self._get_user_scope(request) if self.vary_by_user else '' + key_material = { + 'method': request.method, + 'path': request.url.path, + 'path_params': dict(sorted(request.path_params.items())), + 'query_params': sorted(request.query_params.multi_items()), + 'body_digest': hashlib.sha256(request_body).hexdigest() if request_body else '', + 'user_scope': user_scope, + } + key_digest = hashlib.sha256( + json.dumps( + key_material, + ensure_ascii=False, + sort_keys=True, + separators=(',', ':'), + default=str, + ).encode('utf-8') + ).hexdigest() + + return f'{RedisInitKeyConfig.API_CACHE.key}:{self.namespace}:{key_digest}' + + def _get_user_scope(self, request: Request) -> str: + """ + 获取用户隔离维度 + + 优先使用当前登录用户ID,未登录时回退到Authorization摘要。 + + :param request: 当前请求对象 + :return: 用户隔离字符串 + """ + try: + current_user = RequestContext.get_current_user() + return str(current_user.user.user_id) + except LoginException: + authorization = request.headers.get('Authorization', '') + return hashlib.sha256(authorization.encode('utf-8')).hexdigest() if authorization else '' + + def _serialize_response(self, result: Any) -> str | None: + """ + 将响应对象序列化为可存入缓存的字符串 + + :param result: 原始接口返回结果 + :return: 序列化后的缓存内容,不可缓存时返回None + """ + response_payload = self._extract_response_payload(result) + if response_payload is None: + return None + + return json.dumps(response_payload, ensure_ascii=False) + + def _extract_response_payload(self, result: Any) -> dict[str, Any] | None: + """ + 提取可缓存的响应载荷 + + :param result: 原始接口返回结果 + :return: 可缓存的响应载荷,不可缓存时返回None + """ + if isinstance(result, StreamingResponse): + return None + + if isinstance(result, (JSONResponse, ORJSONResponse, UJSONResponse)): + # 命中缓存时无法安全复放后台任务,因此带有后台任务的响应不参与缓存 + if getattr(result, 'background', None) is not None: + return None + + content = self._get_matched_response_content(result, self.cache_response_codes) + if content is None: + return None + + return { + 'content': content, + 'status_code': result.status_code, + 'media_type': result.media_type, + 'headers': self._filter_response_headers(result.headers), + } + + if isinstance(result, Response): + return None + + json_content = self._get_matched_response_content(result, self.cache_response_codes) + if json_content is None: + return None + + return { + 'content': json_content, + 'status_code': HttpStatusConstant.SUCCESS, + 'media_type': 'application/json', + 'headers': {}, + } + + def _build_cached_response(self, cached_response: str) -> JSONResponse: + """ + 根据缓存内容重建JSON响应对象 + + :param cached_response: 缓存中读取到的响应字符串 + :return: 重建后的JSON响应对象 + """ + cached_payload = json.loads(cached_response) + cached_content = self._refresh_response_time(cached_payload['content']) + response = JSONResponse( + status_code=cached_payload['status_code'], + content=jsonable_encoder(cached_content), + headers=cached_payload.get('headers'), + media_type=cached_payload.get('media_type'), + ) + response.headers['X-Api-Cache'] = 'HIT' + + return response + + async def _cache_response(self, redis: aioredis.Redis, cache_key: str, result: Any) -> None: + """ + 将接口响应写入接口缓存 + + :param redis: Redis连接对象 + :param cache_key: 接口缓存键 + :param result: 原始接口返回结果 + :return: None + """ + serialized_response = self._serialize_response(result) + if serialized_response is None: + return + + await redis.set(cache_key, serialized_response, ex=self.expire_seconds) + logger.debug(f'接口缓存写入成功: {cache_key}') + + def _filter_response_headers(self, headers: dict[str, str]) -> dict[str, str]: + """ + 过滤不适合直接回放的响应头 + + :param headers: 原始响应头 + :return: 过滤后的响应头 + """ + excluded_headers = {'content-length', 'content-type', 'set-cookie'} + return {key: value for key, value in headers.items() if key.lower() not in excluded_headers} + + def _refresh_response_time(self, response_content: Any) -> Any: + """ + 刷新项目统一响应体中的time字段 + + :param response_content: JSON响应内容 + :return: 刷新time后的响应内容 + """ + if not isinstance(response_content, dict): + return response_content + + if {'code', 'msg', 'success', 'time'}.issubset(response_content): + refreshed_content = response_content.copy() + refreshed_content['time'] = datetime.now() + return refreshed_content + + return response_content + + +class ApiCacheEvict(_ApiCacheSupport): + """ + 接口缓存失效装饰器,用于在写操作成功后统一清理相关缓存 + """ + + def __init__( + self, + namespaces: Sequence[str] | None = None, + namespace_prefixes: Sequence[str] | None = None, + evict_response_codes: set[int] | None = None, + ) -> None: + """ + 初始化接口缓存失效装饰器 + + :param namespaces: 需要失效的缓存命名空间列表 + :param namespace_prefixes: 需要失效的缓存命名空间前缀列表 + :param evict_response_codes: 允许触发失效的业务响应码,默认为仅成功响应触发 + """ + self.namespaces = tuple(dict.fromkeys(namespaces or ())) + self.namespace_prefixes = tuple(dict.fromkeys(namespace_prefixes or ())) + if not self.namespaces and not self.namespace_prefixes: + raise ValueError('ApiCacheEvict至少需要指定namespaces或namespace_prefixes') + + self.evict_response_codes = ( + evict_response_codes if evict_response_codes is not None else {HttpStatusConstant.SUCCESS} + ) + + def __call__(self, func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]: + """ + 为目标异步接口函数增加缓存失效能力 + + :param func: 需要在成功后触发缓存失效的异步接口函数 + :return: 包装后的异步接口函数 + """ + + @wraps(func) + async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: + result = await func(*args, **kwargs) + _, redis = ApiAnnotationUtil.resolve_request_redis( + func, '当前应用未初始化Redis连接,跳过接口缓存失效', *args, **kwargs + ) + if redis is None: + return result + + if self._should_evict(result): + await self._evict_cache(redis) + + return result + + return wrapper + + async def _evict_cache(self, redis: aioredis.Redis) -> None: + """ + 根据配置统一执行接口缓存失效 + + :param redis: Redis连接对象 + :return: None + """ + if self.namespaces: + await ApiCacheManager.clear_namespaces(redis, self.namespaces) + + if self.namespace_prefixes: + await ApiCacheManager.clear_namespace_prefixes(redis, self.namespace_prefixes) + + def _should_evict(self, result: Any) -> bool: + """ + 判断当前响应是否应触发缓存失效 + + :param result: 原始接口返回结果 + :return: 是否触发缓存失效 + """ + return self._get_matched_response_content(result, self.evict_response_codes) is not None diff --git a/shierfeng-fastapi-backend/common/annotation/log_annotation.py b/shierfeng-fastapi-backend/common/annotation/log_annotation.py new file mode 100644 index 0000000..4b11b59 --- /dev/null +++ b/shierfeng-fastapi-backend/common/annotation/log_annotation.py @@ -0,0 +1,1078 @@ +import inspect +import json +import time +from collections.abc import Awaitable, Callable +from copy import deepcopy +from datetime import datetime +from enum import Enum +from functools import wraps +from typing import Any, Literal, TypeVar + +import httpx +from async_lru import alru_cache +from fastapi import Request +from fastapi.responses import JSONResponse, ORJSONResponse, UJSONResponse +from starlette.status import HTTP_200_OK +from typing_extensions import ParamSpec +from user_agents import parse + +from common.context import RequestContext +from common.enums import BusinessType +from config.env import AppConfig +from exceptions.exception import LoginException, ServiceException, ServiceWarning +from module_admin.entity.vo.log_vo import LogininforModel, OperLogModel +from module_admin.service.log_service import LogQueueService +from utils.client_ip_util import ClientIPUtil +from utils.dependency_util import DependencyUtil +from utils.log_util import LogSanitizer, logger +from utils.response_util import ResponseUtil + +P = ParamSpec('P') +R = TypeVar('R') + + +class _LogFieldRoot(str, Enum): + """ + 日志字段路径根节点 + """ + + def field(self, *parts: str) -> str: + """ + 生成 include 字段路径 + + :param parts: 后续字段路径片段 + :return: 完整字段路径 + """ + return '.'.join((self.value, *parts)) if parts else self.value + + +class RequestLogFieldRoot(_LogFieldRoot): + """ + 请求日志字段路径支持的根节点 + """ + + PATH_PARAMS = 'path_params' + QUERY_PARAMS = 'query_params' + JSON_BODY = 'json_body' + FORM_DATA = 'form_data' + FILES = 'files' + RAW_BODY = 'raw_body' + + +class ResponseLogFieldRoot(_LogFieldRoot): + """ + 响应日志字段路径推荐的根节点 + """ + + CODE = 'code' + MSG = 'msg' + DATA = 'data' + ROWS = 'rows' + SUCCESS = 'success' + TIME = 'time' + + +class Log: + """ + 日志装饰器 + + 支持的日志模式: + - `full`: 记录脱敏后的完整载荷 + - `none`: 不记录对应方向的载荷 + - `summary`: 仅记录摘要信息,如顶层键、状态码、rows数量等 + - `include`: 仅记录白名单字段,适合高敏感接口 + - `exclude`: 记录完整载荷后排除少数字段,适合中敏感接口 + + 模式建议: + - 普通后台管理接口可使用`full` + - 包含大量字段但只关心结构时使用`summary` + - 包含密钥、密码、提示词、配置项等高敏感字段时优先使用`include` + - 字段较多但只需排除极少数字段时可使用`exclude` + - 完全无需保留请求体或响应体时使用`none` + + include / exclude 模式字段路径规则: + - 使用`.`分隔路径,如`json_body.modelCode`、`data.userId` + - 请求日志推荐根节点:`path_params`、`query_params`、`json_body`、`form_data`、`files`、`raw_body` + - 响应日志推荐根节点:`code`、`msg`、`data`、`rows`、`success`、`time` + - 字段名优先按原样精确匹配,若未命中会自动尝试 snake_case、camelCase、kebab-case 归一化匹配 + - 数组使用数字下标,如`rows.0.userName` + - 当前不支持通配符 + - 推荐优先使用`RequestLogFieldRoot.JSON_BODY.field(...)`和`ResponseLogFieldRoot.DATA.field(...)`构造字段路径 + + 示例: + - `request_include_fields=(RequestLogFieldRoot.JSON_BODY.field('model_code'),)` + - `response_include_fields=(ResponseLogFieldRoot.DATA.field('userName'),)` + - `request_exclude_fields=('json_body.api_key',)` + """ + + _REQUEST_INCLUDE_ROOTS = tuple(item.value for item in RequestLogFieldRoot) + _RESPONSE_INCLUDE_ROOTS = tuple(item.value for item in ResponseLogFieldRoot) + _MISSING = object() + _AMBIGUOUS = object() + + def __init__( + self, + title: str, + business_type: BusinessType, + log_type: Literal['login', 'operation'] | None = 'operation', + request_log_mode: Literal['full', 'none', 'summary', 'include', 'exclude'] = 'full', + response_log_mode: Literal['full', 'none', 'summary', 'include', 'exclude'] = 'full', + request_include_fields: tuple[str, ...] | None = None, + response_include_fields: tuple[str, ...] | None = None, + request_exclude_fields: tuple[str, ...] | None = None, + response_exclude_fields: tuple[str, ...] | None = None, + ) -> None: + """ + 日志装饰器 + + :param title: 当前日志装饰器装饰的模块标题 + :param business_type: 业务类型(OTHER其它 INSERT新增 UPDATE修改 DELETE删除 GRANT授权 EXPORT导出 IMPORT导入 FORCE强退 GENCODE生成代码 CLEAN清空数据) + :param log_type: 日志类型;`login`表示登录日志,仅落登录信息,`operation`表示操作日志,会落请求/响应摘要与操作人信息 + :param request_log_mode: 请求日志记录模式;`full`记录脱敏后的完整请求,`none`不记录请求体,`summary`记录请求摘要,`include`仅记录request_include_fields指定的字段,`exclude`记录完整请求后排除request_exclude_fields指定的字段 + :param response_log_mode: 响应日志记录模式;`full`记录脱敏后的完整响应,`none`不记录响应体,`summary`记录响应摘要,`include`仅记录response_include_fields指定的字段,`exclude`记录完整响应后排除response_exclude_fields指定的字段 + :param request_include_fields: 请求日志白名单字段路径,仅在request_log_mode='include'时生效;推荐从path_params/query_params/json_body/form_data/files/raw_body开始,字段名支持 snake_case 与 camelCase 自动兼容 + :param response_include_fields: 响应日志白名单字段路径,仅在response_log_mode='include'时生效;推荐从code/msg/data/rows/success/time开始,字段名支持 snake_case 与 camelCase 自动兼容 + :param request_exclude_fields: 请求日志排除字段路径,仅在request_log_mode='exclude'时生效;推荐从path_params/query_params/json_body/form_data/files/raw_body开始,字段名支持 snake_case 与 camelCase 自动兼容 + :param response_exclude_fields: 响应日志排除字段路径,仅在response_log_mode='exclude'时生效;推荐从code/msg/data/rows/success/time开始,字段名支持 snake_case 与 camelCase 自动兼容 + :return: + """ + self.title = title + self.business_type = business_type.value + self.log_type = log_type + self.request_log_mode = request_log_mode + self.response_log_mode = response_log_mode + self.request_include_fields = request_include_fields or () + self.response_include_fields = response_include_fields or () + self.request_exclude_fields = request_exclude_fields or () + self.response_exclude_fields = response_exclude_fields or () + self._oper_param_len = 2000 + self._json_result_len = 2000 + self._warned_field_path_warnings: set[str] = set() + self._validate_request_field_paths_strict() + self._warn_invalid_field_path_config() + + def __call__(self, func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]: + @wraps(func) + async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: + start_time = time.perf_counter() + # 获取当前被装饰函数所在路径 + func_path = self._get_decorator_func_path(func) + # 获取上下文信息 + request_name_list = get_function_parameters_name_by_type(func, Request) + request = get_function_parameters_value_by_name(func, request_name_list[0], *args, **kwargs) + DependencyUtil.check_exclude_routes(request, err_msg='当前路由不在认证规则内,不可使用Log装饰器') + request_method = request.method + user_agent = request.headers.get('User-Agent') or '' + # 获取操作类型 + operator_type = self._get_oper_type(user_agent) + # 获取请求的url + oper_url = request.url.path + # 获取请求ip + oper_ip = ClientIPUtil.get_client_ip(request) + # 获取请求ip归属区域 + oper_location = await self._get_oper_location(oper_ip) + # 获取请求参数 + oper_param_payload = LogSanitizer.sanitize_data(await self._get_request_params(request)) + oper_param = self._build_log_text( + oper_param_payload, + self.request_log_mode, + self.request_include_fields, + self.request_exclude_fields, + payload_kind='request', + ) + # 日志表请求参数字段长度最大为2000,因此在此处判断长度 + oper_param = self._limit_log_text(oper_param, self._oper_param_len, '请求参数过长') + + # 获取操作时间 + oper_time = datetime.now() + # 此处在登录之前向原始函数传递一些登录信息,用于监测在线用户的相关信息 + login_log = self._get_login_log(user_agent, oper_ip, oper_location, oper_time, kwargs) + try: + # 调用原始函数 + result = await func(*args, **kwargs) + except (LoginException, ServiceWarning) as e: + logger.warning(e.message) + result = ResponseUtil.failure(data=e.data, msg=e.message) + except ServiceException as e: + logger.error(e.message) + result = ResponseUtil.error(data=e.data, msg=e.message) + except Exception as e: + logger.exception(e) + result = ResponseUtil.error(msg=str(e)) + # 获取请求耗时 + cost_time = float(time.perf_counter() - start_time) * 1000 + # 判断请求是否来自api文档 + request_from_swagger, request_from_redoc = self._is_request_from_swagger_or_redoc(request) + # 根据响应结果的类型使用不同的方法获取响应结果参数 + sanitized_result_dict = LogSanitizer.sanitize_data( + self._get_result_dict(result, request_from_swagger, request_from_redoc) + ) + json_result = self._build_log_text( + sanitized_result_dict, + self.response_log_mode, + self.response_include_fields, + self.response_exclude_fields, + payload_kind='response', + ) + # 日志表返回参数字段长度最大为2000,因此在此处判断长度 + json_result = self._limit_log_text(json_result, self._json_result_len, '返回参数过长') + # 根据响应结果获取响应状态及异常信息 + status, error_msg = self._get_status_and_error_msg(sanitized_result_dict) + # 根据日志类型向对应的日志表插入数据 + if self.log_type == 'login': + # 登录请求来自于api文档时不记录登录日志,其余情况则记录 + if request_from_swagger or request_from_redoc: + pass + else: + user = kwargs.get('form_data') + login_log.update( + { + 'loginTime': oper_time, + 'userName': user.username, + 'status': str(status), + 'msg': sanitized_result_dict.get('msg') or '', + } + ) + + await LogQueueService.enqueue_login_log(request, LogininforModel(**login_log), func_path) + else: + current_user = RequestContext.get_current_user() + oper_name = current_user.user.user_name + dept_name = current_user.user.dept.dept_name if current_user.user.dept else None + operation_log = OperLogModel( + title=self.title, + businessType=self.business_type, + method=func_path, + requestMethod=request_method, + operatorType=operator_type, + operName=oper_name, + deptName=dept_name, + operUrl=oper_url, + operIp=oper_ip, + operLocation=oper_location, + operParam=oper_param, + jsonResult=json_result, + status=status, + errorMsg=error_msg, + operTime=oper_time, + costTime=int(cost_time), + ) + await LogQueueService.enqueue_operation_log(request, operation_log, func_path) + + return result + + return wrapper + + def _get_decorator_func_path(self, func: Callable) -> str: + """ + 获取被装饰函数所在路径 + + :param func: 被装饰函数 + :return: 被装饰函数所在路径 + """ + # 获取被装饰函数所在的模块 + module = inspect.getmodule(func) + # 获取完整模块路径 + module_path = module.__name__ if module else '' + # 获取当前被装饰函数所在路径 + func_path = f'{module_path}.{func.__name__}()' + + return func_path + + @staticmethod + def _limit_log_text(log_text: str, max_length: int, overflow_text: str) -> str: + """ + 限制日志文本长度,避免超过日志表字段长度 + + :param log_text: 原始日志文本 + :param max_length: 最大长度 + :param overflow_text: 超长时替代文本 + :return: 处理后的日志文本 + """ + return overflow_text if len(log_text) > max_length else log_text + + def _get_oper_type(self, user_agent: Any) -> int: + """ + 获取操作类型 + + :param user_agent: 用户代理字符串 + :return: 操作类型 + """ + user_agent_text = user_agent or '' + operator_type = 0 + if 'Windows' in user_agent_text or 'Macintosh' in user_agent_text or 'Linux' in user_agent_text: + operator_type = 1 + if 'Mobile' in user_agent_text or 'Android' in user_agent_text or 'iPhone' in user_agent_text: + operator_type = 2 + + return operator_type + + async def _get_oper_location(self, oper_ip: str) -> str: + """ + 获取请求IP归属区域 + + :param oper_ip: 请求IP + :return: 请求IP归属区域 + """ + oper_location = '内网IP' + if AppConfig.app_ip_location_query: + oper_location = await get_ip_location(oper_ip) + + return oper_location + + async def _get_request_params(self, request: Request) -> dict[str, Any]: + """ + 获取请求参数 + + :param request: Request对象 + :return: 结构化请求参数 + """ + params = {} + + # 路径和查询参数 + path_params = dict(request.path_params) + query_params = dict(request.query_params) + params.update({k: v for k, v in {'path_params': path_params, 'query_params': query_params}.items() if v}) + + # 请求体处理 + content_type = request.headers.get('Content-Type', '') + + # JSON请求 + if 'application/json' in content_type: + params.update(await self._get_json_request_params(request, content_type)) + + # 表单数据 + elif 'multipart/form-data' in content_type or 'application/x-www-form-urlencoded' in content_type: + params.update(await self._get_form_request_params(request, content_type)) + + # 其他文本请求 + elif 'application/octet-stream' not in content_type: + params.update(await self._get_raw_request_params(request)) + + return params + + async def _get_json_request_params(self, request: Request, content_type: str) -> dict[str, Any]: + """ + 获取 JSON 请求参数,解析失败时自动降级为原始文本 + + :param request: Request对象 + :param content_type: 请求头中的 content-type + :return: 结构化请求参数 + """ + params = {} + try: + json_body = await request.json() + except Exception as exc: + logger.warning( + 'Log装饰器请求体解析失败,已降级为raw_body记录,path={}, content_type={}, error_type={}', + request.url.path, + content_type, + type(exc).__name__, + ) + params.update(await self._get_raw_request_params(request)) + else: + if json_body: + params['json_body'] = json_body + return params + + async def _get_form_request_params(self, request: Request, content_type: str) -> dict[str, Any]: + """ + 获取表单请求参数 + + :param request: Request对象 + :param content_type: 请求头中的 content-type + :return: 结构化请求参数 + """ + params = {} + form_data = await request.form() + if not form_data: + return params + + # 过滤掉文件对象,只保留普通表单字段 + form_dict = {key: value for key, value in form_data.items() if not hasattr(value, 'filename')} + if form_dict: + params['form_data'] = form_dict + + # 仅在multipart时尝试处理文件 + if 'multipart/form-data' not in content_type: + return params + + file_info = {} + for key, value in form_data.items(): + if hasattr(value, 'filename'): + file_info[key] = { + 'filename': value.filename, + 'content_type': value.content_type, + 'size': value.size, + 'headers': dict(value.headers), + } + if file_info: + params['files'] = file_info + return params + + async def _get_raw_request_params(self, request: Request) -> dict[str, Any]: + """ + 获取原始文本请求参数 + + :param request: Request对象 + :return: 原始文本请求参数 + """ + body = await request.body() + if not body: + return {} + return {'raw_body': self._decode_request_body(body)} + + @staticmethod + def _decode_request_body(body: bytes) -> str: + """ + 安全解码请求体,避免日志采集影响主流程 + + :param body: 原始请求体字节 + :return: 解码后的请求体文本 + """ + return body.decode('utf-8', errors='replace') + + def _build_log_text( + self, + payload: Any, + mode: Literal['full', 'none', 'summary', 'include', 'exclude'], + include_fields: tuple[str, ...], + exclude_fields: tuple[str, ...], + payload_kind: Literal['request', 'response'], + ) -> str: + """ + 根据日志策略构建日志文本 + + :param payload: 已完成脱敏的日志载荷 + :param mode: 日志记录模式 + :param include_fields: 白名单字段路径 + :param exclude_fields: 排除字段路径 + :param payload_kind: 载荷类型 + :return: 日志文本 + """ + if mode == 'none' or not payload: + return '' + if mode == 'summary': + log_payload = self._build_summary_payload(payload, payload_kind) + elif mode == 'include': + log_payload = self._extract_include_fields(payload, include_fields, payload_kind) + elif mode == 'exclude': + log_payload = self._exclude_fields(payload, exclude_fields, payload_kind) + else: + log_payload = payload + return json.dumps(log_payload, ensure_ascii=False, indent=2) if log_payload else '' + + def _build_summary_payload(self, payload: Any, payload_kind: Literal['request', 'response']) -> dict[str, Any]: + """ + 构建摘要日志载荷 + + :param payload: 原始载荷 + :param payload_kind: 载荷类型 + :return: 摘要日志载荷 + """ + summary_payload: dict[str, Any] = { + 'mode': 'summary', + 'kind': payload_kind, + } + if not isinstance(payload, dict): + summary_payload['type'] = type(payload).__name__ + return summary_payload + summary_payload['keys'] = list(payload.keys()) + if payload_kind == 'request': + summary_payload.update( + { + 'path_param_keys': self._get_mapping_keys(payload.get('path_params')), + 'query_param_keys': self._get_mapping_keys(payload.get('query_params')), + 'json_body_keys': self._get_mapping_keys(payload.get('json_body')), + 'form_data_keys': self._get_mapping_keys(payload.get('form_data')), + 'file_fields': self._get_mapping_keys(payload.get('files')), + 'raw_body_length': len(payload.get('raw_body', '')) if payload.get('raw_body') else 0, + } + ) + else: + summary_payload.update( + { + 'code': payload.get('code'), + 'msg': self._get_result_message(payload), + 'data_keys': self._get_mapping_keys(payload.get('data')), + 'rows_count': len(payload.get('rows')) if isinstance(payload.get('rows'), list) else 0, + } + ) + return summary_payload + + def _extract_include_fields( + self, + payload: Any, + include_fields: tuple[str, ...], + payload_kind: Literal['request', 'response'], + ) -> dict[str, Any]: + """ + 提取白名单字段日志载荷 + + :param payload: 原始载荷 + :param include_fields: 白名单字段路径 + :param payload_kind: 载荷类型 + :return: 提取后的日志载荷 + """ + selected_fields = {} + for field_path in include_fields: + field_value = self._get_field_value_by_path(payload, field_path) + if field_value is not self._MISSING: + selected_fields[field_path] = field_value + else: + self._warn_missing_field_path(payload, field_path, payload_kind, strategy='include') + return { + 'mode': 'include', + 'selected': selected_fields, + } + + def _exclude_fields( + self, + payload: Any, + exclude_fields: tuple[str, ...], + payload_kind: Literal['request', 'response'], + ) -> Any: + """ + 排除指定字段后返回日志载荷 + + :param payload: 原始载荷 + :param exclude_fields: 排除字段路径 + :param payload_kind: 载荷类型 + :return: 排除后的日志载荷 + """ + if not exclude_fields or not isinstance(payload, (dict, list)): + return payload + filtered_payload = deepcopy(payload) + for field_path in self._sort_field_paths_for_exclude(exclude_fields): + if not self._remove_field_by_path(filtered_payload, field_path): + self._warn_missing_field_path(payload, field_path, payload_kind, strategy='exclude') + return filtered_payload + + def _warn_missing_field_path( + self, + payload: Any, + field_path: str, + payload_kind: Literal['request', 'response'], + strategy: Literal['include', 'exclude'], + ) -> None: + """ + 记录未命中的字段路径告警,同一路径仅提示一次 + + :param payload: 原始载荷 + :param field_path: 字段路径 + :param payload_kind: 载荷类型 + :param strategy: 当前字段路径策略 + :return: None + """ + warning_key = f'{strategy}:{payload_kind}:{field_path}' + if warning_key in self._warned_field_path_warnings: + return + self._warned_field_path_warnings.add(warning_key) + kind_text = '请求' if payload_kind == 'request' else '响应' + reason = self._describe_missing_field_path(payload, field_path) + if strategy == 'include': + logger.warning( + f'Log装饰器字段白名单未命中:{kind_text}日志字段路径`{field_path}`已忽略。' + f'{reason}若该字段为可选字段,可忽略此提示。' + ) + else: + logger.warning( + f'Log装饰器字段排除路径未命中:{kind_text}日志字段路径`{field_path}`未生效。' + f'{reason}若该字段为可选字段,可忽略此提示。' + ) + + def _describe_missing_field_path(self, payload: Any, field_path: str) -> str: + """ + 描述字段路径未命中的原因 + + :param payload: 原始载荷 + :param field_path: 字段路径 + :return: 原因描述 + """ + current_value = payload + traversed_parts: list[str] = [] + for part in field_path.split('.'): + traversed_path = '.'.join(traversed_parts) or '' + if isinstance(current_value, dict): + mapping_value = self._get_mapping_value_by_part(current_value, part) + if mapping_value is self._MISSING: + available_keys = ', '.join(map(str, current_value.keys())) if current_value else '无' + return f'在`{traversed_path}`下未找到字段`{part}`,可用字段:{available_keys}。' + if mapping_value is self._AMBIGUOUS: + ambiguous_keys = ', '.join( + str(key) + for key in current_value + if self._normalize_include_key(str(key)) == self._normalize_include_key(part) + ) + return ( + f'在`{traversed_path}`下字段`{part}`存在命名冲突,' + f'可匹配字段:{ambiguous_keys};请改用精确字段名。' + ) + current_value = mapping_value + elif isinstance(current_value, list): + if not part.isdigit(): + return f'在`{traversed_path}`处当前值为列表,字段片段`{part}`应为数字下标。' + current_index = int(part) + if current_index >= len(current_value): + return f'在`{traversed_path}`处列表长度为{len(current_value)},下标`{part}`越界。' + current_value = current_value[current_index] + else: + current_type = type(current_value).__name__ if current_value is not None else 'None' + return f'在`{traversed_path}`处当前值类型为`{current_type}`,无法继续匹配后续路径。' + traversed_parts.append(part) + return '' + + def _warn_invalid_field_path_config(self) -> None: + """ + 记录字段路径配置告警,帮助开发者发现路径误配 + + :return: None + """ + warnings = [ + *self._collect_field_path_warnings( + mode=self.request_log_mode, + include_fields=self.request_include_fields, + exclude_fields=self.request_exclude_fields, + payload_kind='request', + ), + *self._collect_field_path_warnings( + mode=self.response_log_mode, + include_fields=self.response_include_fields, + exclude_fields=self.response_exclude_fields, + payload_kind='response', + ), + ] + for warning in warnings: + logger.warning(f'Log装饰器字段路径配置提示:{warning}') + + def _validate_request_field_paths_strict(self) -> None: + """ + 严格校验请求日志字段路径根节点 + + :return: None + """ + field_paths = () + if self.request_log_mode == 'include': + field_paths = self.request_include_fields + elif self.request_log_mode == 'exclude': + field_paths = self.request_exclude_fields + for field_path in field_paths: + if not field_path: + continue + root_part = field_path.split('.', 1)[0] + if self._resolve_include_root(root_part, self._REQUEST_INCLUDE_ROOTS) is None: + raise ValueError( + f'请求日志字段路径`{field_path}`使用了不支持的根节点`{root_part}`;' + f'仅支持:{", ".join(self._REQUEST_INCLUDE_ROOTS)}' + ) + + def _collect_field_path_warnings( + self, + mode: Literal['full', 'none', 'summary', 'include', 'exclude'], + include_fields: tuple[str, ...], + exclude_fields: tuple[str, ...], + payload_kind: Literal['request', 'response'], + ) -> list[str]: + """ + 收集字段路径配置告警信息 + + :param mode: 日志记录模式 + :param include_fields: 白名单字段路径列表 + :param exclude_fields: 排除字段路径列表 + :param payload_kind: 载荷类型 + :return: 告警信息列表 + """ + warnings = [] + kind_text = '请求' if payload_kind == 'request' else '响应' + recommended_roots = self._REQUEST_INCLUDE_ROOTS if payload_kind == 'request' else self._RESPONSE_INCLUDE_ROOTS + if mode == 'include' and not include_fields: + warnings.append( + f'{kind_text}日志已启用include模式,但未配置白名单字段;推荐根节点:{", ".join(recommended_roots)}' + ) + if mode == 'exclude' and not exclude_fields: + warnings.append( + f'{kind_text}日志已启用exclude模式,但未配置排除字段;推荐根节点:{", ".join(recommended_roots)}' + ) + if mode != 'include' and include_fields: + warnings.append(f'{kind_text}日志配置了白名单字段,但当前模式为{mode},这些字段不会生效') + if mode != 'exclude' and exclude_fields: + warnings.append(f'{kind_text}日志配置了排除字段,但当前模式为{mode},这些字段不会生效') + for field_path in include_fields: + path_warning = self._validate_field_path(field_path, payload_kind, strategy='include') + if path_warning: + warnings.append(path_warning) + for field_path in exclude_fields: + path_warning = self._validate_field_path(field_path, payload_kind, strategy='exclude') + if path_warning: + warnings.append(path_warning) + + return warnings + + def _validate_field_path( + self, + field_path: str, + payload_kind: Literal['request', 'response'], + strategy: Literal['include', 'exclude'], + ) -> str | None: + """ + 校验单个字段路径 + + :param field_path: 字段路径 + :param payload_kind: 载荷类型 + :param strategy: 当前字段路径策略 + :return: 告警信息 + """ + kind_text = '请求' if payload_kind == 'request' else '响应' + recommended_roots = self._REQUEST_INCLUDE_ROOTS if payload_kind == 'request' else self._RESPONSE_INCLUDE_ROOTS + strategy_text = '白名单字段路径' if strategy == 'include' else '排除字段路径' + if not field_path: + return f'{kind_text}日志存在空{strategy_text};推荐根节点:{", ".join(recommended_roots)}' + parts = field_path.split('.') + if any(not part for part in parts): + return f'{kind_text}日志{strategy_text}`{field_path}`格式不合法,请使用`.`分隔的完整路径' + canonical_root = self._resolve_include_root(parts[0], recommended_roots) + if canonical_root is None: + return ( + f'{kind_text}日志{strategy_text}`{field_path}`未使用推荐根节点`{parts[0]}`;' + f'推荐根节点:{", ".join(recommended_roots)}' + ) + return None + + def _get_field_value_by_path(self, payload: Any, field_path: str) -> Any: + """ + 通过字段路径获取字段值 + + :param payload: 原始载荷 + :param field_path: 字段路径 + :return: 字段值 + """ + current_value = payload + for part in field_path.split('.'): + if isinstance(current_value, dict): + mapping_value = self._get_mapping_value_by_part(current_value, part) + if mapping_value is self._MISSING or mapping_value is self._AMBIGUOUS: + return self._MISSING + current_value = mapping_value + elif isinstance(current_value, list) and part.isdigit(): + current_index = int(part) + if current_index >= len(current_value): + return self._MISSING + current_value = current_value[current_index] + else: + return self._MISSING + return current_value + + def _get_mapping_value_by_part(self, payload: dict[str, Any], part: str) -> Any: + """ + 从字典中按字段片段获取值,支持 snake_case / camelCase / kebab-case 自动兼容 + + :param payload: 当前字典载荷 + :param part: 当前路径片段 + :return: 字段值 + """ + if part in payload: + return payload[part] + normalized_part = self._normalize_include_key(part) + matched_keys = [key for key in payload if self._normalize_include_key(str(key)) == normalized_part] + if len(matched_keys) == 1: + return payload[matched_keys[0]] + if len(matched_keys) > 1: + return self._AMBIGUOUS + return self._MISSING + + @staticmethod + def _sort_field_paths_for_exclude(field_paths: tuple[str, ...]) -> list[str]: + """ + 对 exclude 字段路径排序,优先处理更深层路径和更大的列表下标,避免列表删除时发生索引位移 + + :param field_paths: 原始字段路径 + :return: 排序后的字段路径列表 + """ + return sorted(field_paths, key=Log._build_exclude_sort_key, reverse=True) + + @staticmethod + def _build_exclude_sort_key(field_path: str) -> tuple[int, tuple[tuple[int, int | str], ...]]: + """ + 构建 exclude 字段路径排序键 + + :param field_path: 字段路径 + :return: 排序键 + """ + parts = field_path.split('.') + normalized_parts: tuple[tuple[int, int | str], ...] = tuple( + (1, int(part)) if part.isdigit() else (0, part) for part in parts + ) + return len(parts), normalized_parts + + def _remove_field_by_path(self, payload: Any, field_path: str) -> bool: + """ + 按路径移除字段 + + :param payload: 原始载荷 + :param field_path: 字段路径 + :return: 是否移除成功 + """ + if not field_path: + return False + current_value = payload + parts = field_path.split('.') + for part in parts[:-1]: + if isinstance(current_value, dict): + mapping_value = self._get_mapping_value_by_part(current_value, part) + if mapping_value is self._MISSING or mapping_value is self._AMBIGUOUS: + return False + current_value = mapping_value + elif isinstance(current_value, list) and part.isdigit(): + current_index = int(part) + if current_index >= len(current_value): + return False + current_value = current_value[current_index] + else: + return False + + target_part = parts[-1] + if isinstance(current_value, dict): + resolved_key = self._resolve_mapping_key_by_part(current_value, target_part) + if resolved_key is self._MISSING or resolved_key is self._AMBIGUOUS: + return False + del current_value[resolved_key] + return True + if isinstance(current_value, list) and target_part.isdigit(): + current_index = int(target_part) + if current_index >= len(current_value): + return False + current_value.pop(current_index) + return True + return False + + def _resolve_mapping_key_by_part(self, payload: dict[str, Any], part: str) -> str | object: + """ + 解析字段片段在字典中的真实键名 + + :param payload: 当前字典载荷 + :param part: 当前路径片段 + :return: 真实键名或哨兵值 + """ + if part in payload: + return part + normalized_part = self._normalize_include_key(part) + matched_keys = [key for key in payload if self._normalize_include_key(str(key)) == normalized_part] + if len(matched_keys) == 1: + return matched_keys[0] + if len(matched_keys) > 1: + return self._AMBIGUOUS + return self._MISSING + + @staticmethod + def _resolve_include_root( + root: RequestLogFieldRoot | ResponseLogFieldRoot | str, candidates: tuple[str, ...] + ) -> str | None: + """ + 解析 include 根节点到标准写法 + + :param root: 原始根节点 + :param candidates: 候选根节点 + :return: 标准根节点 + """ + normalized_root = Log._normalize_include_key(str(root)) + for candidate in candidates: + if Log._normalize_include_key(candidate) == normalized_root: + return candidate + return None + + @staticmethod + def _normalize_include_key(field_name: str) -> str: + """ + 标准化 include 字段名 + + :param field_name: 原始字段名 + :return: 标准化后的字段名 + """ + return ''.join(char.lower() for char in field_name if char.isalnum()) + + @staticmethod + def _get_mapping_keys(payload: Any) -> list[str]: + """ + 获取字典载荷的键列表 + + :param payload: 原始载荷 + :return: 键列表 + """ + if isinstance(payload, dict): + return list(payload.keys()) + return [] + + def _get_login_log( + self, user_agent: Any, oper_ip: str, oper_location: str, oper_time: datetime, origin_kwargs: dict + ) -> dict: + """ + 获取登录日志信息 + + :param user_agent: 用户代理字符串 + :param oper_ip: 操作ip + :param oper_location: 操作区域 + :param oper_time: 操作时间 + :param origin_kwargs: 原始函数参数 + :return: 登录日志信息 + """ + login_log = {} + if self.log_type == 'login': + user_agent_info = parse(user_agent or '') + browser = f'{user_agent_info.browser.family}' + system_os = f'{user_agent_info.os.family}' + if user_agent_info.browser.version != (): + browser += f' {user_agent_info.browser.version[0]}' + if user_agent_info.os.version != (): + system_os += f' {user_agent_info.os.version[0]}' + login_log = { + 'ipaddr': oper_ip, + 'loginLocation': oper_location, + 'browser': browser, + 'os': system_os, + 'loginTime': oper_time.strftime('%Y-%m-%d %H:%M:%S'), + } + self._set_login_data(login_log, origin_kwargs) + + return login_log + + def _set_login_data(self, login_log: dict, origin_kwargs: dict) -> None: + """ + 设置登录日志数据 + + :param login_log: 登录日志信息 + :param origin_kwargs: 原始函数参数 + :return: None + """ + if 'form_data' in origin_kwargs: + origin_kwargs['form_data'].login_info = login_log + + def _get_status_and_error_msg(self, result_dict: dict) -> tuple[int, str]: + """ + 获取操作状态和错误信息 + + :param result_dict: 操作结果字典 + :return: 操作状态和错误信息元组 + """ + status = 1 + error_msg = '' + if result_dict.get('code') == HTTP_200_OK: + status = 0 + else: + error_msg = self._get_result_message(result_dict) + + return status, error_msg + + @staticmethod + def _get_result_message(result_dict: dict[str, Any]) -> Any: + """ + 获取响应结果中的消息字段,兼容 msg / message 两种写法 + + :param result_dict: 操作结果字典 + :return: 消息内容 + """ + return result_dict.get('msg') if result_dict.get('msg') is not None else result_dict.get('message') + + def _is_request_from_swagger_or_redoc(self, request: Request) -> tuple[bool, bool]: + """ + 判断请求是否来自swagger或redoc + + :param request: Request对象 + :return: 是否来自swagger请求和是否来自redoc请求元组 + """ + request_from_swagger = ( + request.headers.get('referer').endswith('docs') if request.headers.get('referer') else False + ) + request_from_redoc = ( + request.headers.get('referer').endswith('redoc') if request.headers.get('referer') else False + ) + + return request_from_swagger, request_from_redoc + + def _get_result_dict(self, result: Any, request_from_swagger: bool, request_from_redoc: bool) -> dict: + """ + 获取操作结果字典 + + :param result: 操作结果 + :param request_from_swagger: 是否来自swagger请求 + :param request_from_redoc: 是否来自redoc请求 + :return: 操作结果字典 + """ + if isinstance(result, (JSONResponse, ORJSONResponse, UJSONResponse)): + result_dict = json.loads(str(result.body, 'utf-8')) + elif request_from_swagger or request_from_redoc: + result_dict = {} + elif result.status_code == HTTP_200_OK: + result_dict = {'code': result.status_code, 'message': '获取成功'} + else: + result_dict = {'code': result.status_code, 'message': '获取失败'} + + return result_dict + + +@alru_cache() +async def get_ip_location(oper_ip: str) -> str: + """ + 查询ip归属区域 + + :param oper_ip: 需要查询的ip + :return: ip归属区域 + """ + oper_location = '内网IP' + try: + if oper_ip not in ['127.0.0.1', 'localhost']: + oper_location = '未知' + async with httpx.AsyncClient() as client: + ip_result = await client.get(f'https://qifu-api.baidubce.com/ip/geo/v1/district?ip={oper_ip}') + if ip_result.status_code == HTTP_200_OK: + prov = ip_result.json().get('data', {}).get('prov') + city = ip_result.json().get('data', {}).get('city') + if prov or city: + oper_location = f'{prov}-{city}' + except Exception as e: + oper_location = '未知' + print(e) + return oper_location + + +def get_function_parameters_name_by_type(func: Callable, param_type: Any) -> list: + """ + 获取函数指定类型的参数名称 + + :param func: 函数 + :param arg_type: 参数类型 + :return: 函数指定类型的参数名称 + """ + # 获取函数的参数信息 + parameters = inspect.signature(func).parameters + # 找到指定类型的参数名称 + parameters_name_list = [] + # 遍历所有参数 + for name, param in parameters.items(): + # 处理参数注解 + annotation = param.annotation + # 检查参数类型是否匹配 + # 1. 直接匹配 + # 2. 检查是否为Annotated类型(通过类型名称判断) + if annotation == param_type or ( + hasattr(annotation, '__class__') + and annotation.__class__.__name__ == '_AnnotatedAlias' + and annotation.__origin__ == param_type + ): + parameters_name_list.append(name) + return parameters_name_list + + +def get_function_parameters_value_by_name(func: Callable, name: str, *args, **kwargs) -> Any: + """ + 获取函数指定参数的值 + + :param func: 函数 + :param name: 参数名 + :return: 参数值 + """ + # 获取参数值 + bound_parameters = inspect.signature(func).bind(*args, **kwargs) + bound_parameters.apply_defaults() + parameters_value = bound_parameters.arguments.get(name) + + return parameters_value diff --git a/shierfeng-fastapi-backend/common/annotation/pydantic_annotation.py b/shierfeng-fastapi-backend/common/annotation/pydantic_annotation.py new file mode 100644 index 0000000..9dde679 --- /dev/null +++ b/shierfeng-fastapi-backend/common/annotation/pydantic_annotation.py @@ -0,0 +1,86 @@ +import inspect +from typing import TYPE_CHECKING, TypeVar + +from fastapi import Form, Query +from pydantic import BaseModel + +if TYPE_CHECKING: + from pydantic.fields import FieldInfo + +BaseModelVar = TypeVar('BaseModelVar', bound=BaseModel) + + +def as_query(cls: type[BaseModelVar]) -> type[BaseModelVar]: + """ + pydantic模型查询参数装饰器,将pydantic模型用于接收查询参数 + """ + new_parameters = [] + + for model_field in cls.model_fields.values(): + model_field: FieldInfo + + if not model_field.is_required(): + new_parameters.append( + inspect.Parameter( + model_field.alias, + inspect.Parameter.POSITIONAL_ONLY, + default=Query(default=model_field.default, description=model_field.description), + annotation=model_field.annotation, + ) + ) + else: + new_parameters.append( + inspect.Parameter( + model_field.alias, + inspect.Parameter.POSITIONAL_ONLY, + default=Query(..., description=model_field.description), + annotation=model_field.annotation, + ) + ) + + async def as_query_func(**data) -> type[BaseModelVar]: + return cls(**data) + + sig = inspect.signature(as_query_func) + sig = sig.replace(parameters=new_parameters) + as_query_func.__signature__ = sig + cls.as_query = as_query_func + return cls + + +def as_form(cls: type[BaseModelVar]) -> type[BaseModelVar]: + """ + pydantic模型表单参数装饰器,将pydantic模型用于接收表单参数 + """ + new_parameters = [] + + for model_field in cls.model_fields.values(): + model_field: FieldInfo + + if not model_field.is_required(): + new_parameters.append( + inspect.Parameter( + model_field.alias, + inspect.Parameter.POSITIONAL_ONLY, + default=Form(default=model_field.default, description=model_field.description), + annotation=model_field.annotation, + ) + ) + else: + new_parameters.append( + inspect.Parameter( + model_field.alias, + inspect.Parameter.POSITIONAL_ONLY, + default=Form(..., description=model_field.description), + annotation=model_field.annotation, + ) + ) + + async def as_form_func(**data) -> type[BaseModelVar]: + return cls(**data) + + sig = inspect.signature(as_form_func) + sig = sig.replace(parameters=new_parameters) + as_form_func.__signature__ = sig + cls.as_form = as_form_func + return cls diff --git a/shierfeng-fastapi-backend/common/annotation/rate_limit_annotation.py b/shierfeng-fastapi-backend/common/annotation/rate_limit_annotation.py new file mode 100644 index 0000000..1d7e9b8 --- /dev/null +++ b/shierfeng-fastapi-backend/common/annotation/rate_limit_annotation.py @@ -0,0 +1,720 @@ +import hashlib +import json +import time +import uuid +from collections import deque +from collections.abc import Awaitable, Callable, Sequence +from dataclasses import dataclass +from functools import wraps +from typing import Literal, TypeVar + +from fastapi import Request +from redis import asyncio as aioredis +from typing_extensions import ParamSpec + +from common.context import RequestContext +from common.enums import HttpMethod, RedisInitKeyConfig +from exceptions.exception import LoginException +from module_admin.entity.vo.user_vo import CurrentUserModel +from utils.api_annotation_util import ApiAnnotationUtil +from utils.api_response_header_util import ApiResponseHeaderUtil +from utils.client_ip_util import ClientIPUtil +from utils.log_util import logger +from utils.response_util import ResponseUtil + +P = ParamSpec('P') +R = TypeVar('R') +RateLimitScope = Literal['ip', 'user', 'user_or_ip'] +RateLimitAlgorithm = Literal['fixed_window', 'sliding_window'] +RateLimitFailStrategy = Literal['open', 'closed', 'local_fallback'] + + +@dataclass(frozen=True) +class ApiRateLimitPresetConfig: + """ + 接口限流预设配置 + """ + + name: str + limit: int + window_seconds: int + scope: RateLimitScope = 'ip' + algorithm: RateLimitAlgorithm = 'fixed_window' + fail_strategy: RateLimitFailStrategy = 'open' + methods: tuple[HttpMethod, ...] | None = None + message: str = '请求过于频繁,请稍后再试' + + +@dataclass(frozen=True) +class ApiRateLimitBypassConfig: + """ + 接口限流角色豁免配置 + """ + + roles: tuple[str, ...] + + +class ApiRateLimitPreset: + """ + 接口限流预设 + + ANON_AUTH_LOGIN: 匿名登录类接口限流预设 + ANON_AUTH_REGISTER: 匿名注册类接口限流预设 + ANON_AUTH_CAPTCHA: 匿名验证码类接口限流预设 + ANON_PUBLIC_METADATA: 匿名公开元数据接口限流预设 + COMMON_UPLOAD: 通用上传接口限流预设 + USER_INTERACTIVE_HIGH_FREQ: 用户高频交互接口限流预设 + USER_RESOURCE_EXECUTION: 用户执行类接口限流预设 + USER_COMMON_MUTATION: 用户普通写操作接口限流预设 + USER_SECURITY_MUTATION: 用户安全敏感操作接口限流预设 + USER_DESTRUCTIVE_MUTATION: 用户破坏性操作接口限流预设 + USER_RESOURCE_EXPORT: 用户导出类接口限流预设 + USER_RESOURCE_IMPORT: 用户导入类接口限流预设 + USER_RESOURCE_UPLOAD: 用户上传类接口限流预设 + USER_RESOURCE_GENERATE: 用户生成类接口限流预设 + USER_RESOURCE_DOWNLOAD: 用户下载类接口限流预设 + USER_RESOURCE_SYNC: 用户同步类接口限流预设 + """ + + ANON_AUTH_LOGIN = ApiRateLimitPresetConfig( + name='ANON_AUTH_LOGIN', + limit=12, + window_seconds=60, + algorithm='sliding_window', + fail_strategy='local_fallback', + ) + ANON_AUTH_REGISTER = ApiRateLimitPresetConfig( + name='ANON_AUTH_REGISTER', + limit=6, + window_seconds=120, + algorithm='sliding_window', + fail_strategy='local_fallback', + ) + ANON_AUTH_CAPTCHA = ApiRateLimitPresetConfig( + name='ANON_AUTH_CAPTCHA', + limit=36, + window_seconds=60, + algorithm='sliding_window', + fail_strategy='local_fallback', + ) + ANON_PUBLIC_METADATA = ApiRateLimitPresetConfig( + name='ANON_PUBLIC_METADATA', + limit=30, + window_seconds=60, + algorithm='sliding_window', + fail_strategy='local_fallback', + ) + COMMON_UPLOAD = ApiRateLimitPresetConfig( + name='COMMON_UPLOAD', + limit=24, + window_seconds=60, + scope='user_or_ip', + ) + + USER_INTERACTIVE_HIGH_FREQ = ApiRateLimitPresetConfig( + name='USER_INTERACTIVE_HIGH_FREQ', + limit=40, + window_seconds=60, + scope='user', + ) + USER_RESOURCE_EXECUTION = ApiRateLimitPresetConfig( + name='USER_RESOURCE_EXECUTION', + limit=12, + window_seconds=60, + scope='user', + ) + USER_COMMON_MUTATION = ApiRateLimitPresetConfig( + name='USER_COMMON_MUTATION', + limit=24, + window_seconds=120, + scope='user', + ) + USER_SECURITY_MUTATION = ApiRateLimitPresetConfig( + name='USER_SECURITY_MUTATION', + limit=12, + window_seconds=120, + scope='user', + ) + USER_DESTRUCTIVE_MUTATION = ApiRateLimitPresetConfig( + name='USER_DESTRUCTIVE_MUTATION', + limit=6, + window_seconds=120, + scope='user', + ) + USER_RESOURCE_EXPORT = ApiRateLimitPresetConfig( + name='USER_RESOURCE_EXPORT', + limit=15, + window_seconds=120, + scope='user', + ) + USER_RESOURCE_IMPORT = ApiRateLimitPresetConfig( + name='USER_RESOURCE_IMPORT', + limit=8, + window_seconds=120, + scope='user', + ) + USER_RESOURCE_UPLOAD = ApiRateLimitPresetConfig( + name='USER_RESOURCE_UPLOAD', + limit=12, + window_seconds=120, + scope='user', + ) + USER_RESOURCE_GENERATE = ApiRateLimitPresetConfig( + name='USER_RESOURCE_GENERATE', + limit=8, + window_seconds=120, + scope='user', + ) + USER_RESOURCE_DOWNLOAD = ApiRateLimitPresetConfig( + name='USER_RESOURCE_DOWNLOAD', + limit=12, + window_seconds=60, + scope='user', + ) + USER_RESOURCE_SYNC = ApiRateLimitPresetConfig( + name='USER_RESOURCE_SYNC', + limit=15, + window_seconds=120, + scope='user', + ) + + +class ApiRateLimit: + """ + 接口限流装饰器,支持Redis固定窗口、滑动窗口及本地应急兜底。 + + `local_fallback` 仅作为Redis异常场景下的进程内应急保护,能提供单进程内的 + 基础限流能力,但不保证多 worker / 多实例部署下的全局一致性。 + + `ip` 维度限流通过 `ClientIPUtil` 提取客户端地址,仅当请求来源命中 + `APP_TRUSTED_PROXY_IPS` 且 `APP_TRUSTED_PROXY_HOPS` 大于0时,才会解析 + `X-Forwarded-For` / `X-Real-IP` 请求头;否则回退到直接连接来源地址。 + """ + + _SUPPORTED_SCOPES: tuple[RateLimitScope, ...] = ('ip', 'user', 'user_or_ip') + _SUPPORTED_ALGORITHMS: tuple[RateLimitAlgorithm, ...] = ('fixed_window', 'sliding_window') + _SUPPORTED_FAIL_STRATEGIES: tuple[RateLimitFailStrategy, ...] = ('open', 'closed', 'local_fallback') + _FIXED_WINDOW_LUA_SCRIPT = """ + local current = redis.call('INCR', KEYS[1]) + local ttl = redis.call('PTTL', KEYS[1]) + if current == 1 or ttl < 0 then + redis.call('PEXPIRE', KEYS[1], ARGV[1]) + ttl = redis.call('PTTL', KEYS[1]) + end + local limit = tonumber(ARGV[2]) + local remaining = limit - current + if remaining < 0 then + remaining = 0 + end + local allowed = 0 + if current <= limit then + allowed = 1 + end + return {allowed, current, remaining, ttl} + """ + _SLIDING_WINDOW_LUA_SCRIPT = """ + redis.call('ZREMRANGEBYSCORE', KEYS[1], 0, tonumber(ARGV[1]) - tonumber(ARGV[2])) + local current = redis.call('ZCARD', KEYS[1]) + local limit = tonumber(ARGV[4]) + local ttl = ARGV[2] + if current >= limit then + local earliest = redis.call('ZRANGE', KEYS[1], 0, 0, 'WITHSCORES') + if earliest[2] ~= nil then + ttl = tonumber(ARGV[2]) - (tonumber(ARGV[1]) - tonumber(earliest[2])) + end + if ttl < 1 then + ttl = 1 + end + return {0, current, 0, ttl} + end + redis.call('ZADD', KEYS[1], ARGV[1], ARGV[3]) + redis.call('PEXPIRE', KEYS[1], ARGV[2]) + current = current + 1 + local remaining = limit - current + if remaining < 0 then + remaining = 0 + end + local earliest = redis.call('ZRANGE', KEYS[1], 0, 0, 'WITHSCORES') + if earliest[2] ~= nil then + ttl = tonumber(ARGV[2]) - (tonumber(ARGV[1]) - tonumber(earliest[2])) + end + if ttl < 1 then + ttl = 1 + end + return {1, current, remaining, ttl} + """ + # 仅用于Redis异常时的单进程本地兜底,不承担分布式一致性职责。 + _LOCAL_FALLBACK_STORE: dict[str, deque[int]] = {} + + def __init__( + self, + namespace: str, + limit: int | None = None, + window_seconds: int | None = None, + scope: RateLimitScope | None = None, + algorithm: RateLimitAlgorithm | None = None, + fail_strategy: RateLimitFailStrategy | None = None, + bypass: ApiRateLimitBypassConfig | None = None, + methods: Sequence[HttpMethod] | None = None, + message: str | None = None, + preset: ApiRateLimitPresetConfig | None = None, + ) -> None: + """ + 初始化接口限流装饰器 + + :param namespace: 限流命名空间,用于区分不同接口 + :param limit: 窗口内允许的最大请求次数,可覆盖预设 + :param window_seconds: 限流窗口时长,单位秒,可覆盖预设 + :param scope: 限流作用域,ip: 按客户端IP限流,客户端IP由可信代理配置控制提取,user: 仅按当前登录用户限流,未登录请求跳过限流,user_or_ip: 已登录按用户限流,未登录按客户端IP限流,可覆盖预设 + :param algorithm: 限流算法,fixed_window: 固定窗口,sliding_window: 滑动窗口,可覆盖预设 + :param fail_strategy: 限流组件异常时的故障策略,open: 放行,closed: 直接拦截,local_fallback: 使用进程内内存做应急兜底限流,仅保证单进程内生效,可覆盖预设 + :param bypass: 角色豁免配置,仅在显式传入时生效 + :param methods: 需要限流的HttpMethod枚举列表,为None时默认限制所有方法,可覆盖预设 + :param message: 触发限流后的提示信息,可覆盖预设 + :param preset: 限流预设配置 + """ + resolved_limit = limit if limit is not None else preset.limit if preset else None + resolved_window_seconds = ( + window_seconds if window_seconds is not None else preset.window_seconds if preset else None + ) + resolved_scope = scope if scope is not None else preset.scope if preset else 'ip' + resolved_algorithm = algorithm if algorithm is not None else preset.algorithm if preset else 'fixed_window' + resolved_fail_strategy = ( + fail_strategy if fail_strategy is not None else preset.fail_strategy if preset else 'open' + ) + resolved_methods = methods if methods is not None else preset.methods if preset else None + resolved_message = message if message is not None else preset.message if preset else '请求过于频繁,请稍后再试' + resolved_preset_name = preset.name if preset else 'CUSTOM' + + if not namespace: + raise ValueError('ApiRateLimit的namespace不能为空') + if resolved_limit is None or resolved_limit <= 0: + raise ValueError('ApiRateLimit的limit必须大于0') + if resolved_window_seconds is None or resolved_window_seconds <= 0: + raise ValueError('ApiRateLimit的window_seconds必须大于0') + if resolved_scope not in self._SUPPORTED_SCOPES: + raise ValueError(f'ApiRateLimit的scope仅支持: {", ".join(self._SUPPORTED_SCOPES)}') + if resolved_algorithm not in self._SUPPORTED_ALGORITHMS: + raise ValueError(f'ApiRateLimit的algorithm仅支持: {", ".join(self._SUPPORTED_ALGORITHMS)}') + if resolved_fail_strategy not in self._SUPPORTED_FAIL_STRATEGIES: + raise ValueError(f'ApiRateLimit的fail_strategy仅支持: {", ".join(self._SUPPORTED_FAIL_STRATEGIES)}') + if bypass and resolved_scope == 'ip': + raise ValueError('ApiRateLimit在scope=ip时不支持角色豁免配置') + + self.namespace = namespace + self.preset_name = resolved_preset_name + self.limit = resolved_limit + self.window_seconds = resolved_window_seconds + self.scope = resolved_scope + self.algorithm = resolved_algorithm + self.fail_strategy = resolved_fail_strategy + self.bypass_roles = self._normalize_bypass_roles(bypass.roles if bypass else None) + self.methods = ApiAnnotationUtil.normalize_http_methods(resolved_methods) + self.message = resolved_message + + def __call__(self, func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]: + """ + 为目标异步接口函数增加接口限流能力 + + :param func: 需要限流的异步接口函数 + :return: 包装后的异步接口函数 + """ + + @wraps(func) + async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: + request = ApiAnnotationUtil.get_request(func, *args, **kwargs) + if request is None: + return await func(*args, **kwargs) + if not self._is_request_method_allowed(request): + return await func(*args, **kwargs) + bypass_role = self._match_bypass_role() + if bypass_role is not None: + self._log_rate_limit_bypass(request, bypass_role) + return await func(*args, **kwargs) + + rate_limit_result: dict[str, int | bool] | None = None + redis = getattr(request.app.state, 'redis', None) + if redis is None: + rate_limit_result = self._resolve_failed_rate_limit( + request, reason='redis_unavailable', error_message='redis client is not initialized' + ) + if rate_limit_result is None: + return await func(*args, **kwargs) + else: + try: + rate_limit_result = await self._acquire_rate_limit(redis, request) + except Exception as exc: + rate_limit_result = self._resolve_failed_rate_limit( + request, reason='redis_error', error_message=str(exc) + ) + if rate_limit_result is None: + return await func(*args, **kwargs) + if rate_limit_result is None: + return await func(*args, **kwargs) + + headers = self._build_rate_limit_headers(rate_limit_result) + if not rate_limit_result['allowed']: + self._log_rate_limit_hit(request, rate_limit_result) + return ResponseUtil.too_many_requests(msg=self.message, headers=headers) # type: ignore[return-value] + + ApiResponseHeaderUtil.merge_headers(request, headers) + result = await func(*args, **kwargs) + return result + + return wrapper + + def _is_request_method_allowed(self, request: Request) -> bool: + """ + 判断当前请求方法是否启用限流 + + :param request: 当前请求对象 + :return: 是否启用限流 + """ + return not self.methods or request.method.upper() in self.methods + + def _normalize_bypass_roles(self, bypass_roles: Sequence[str] | None) -> tuple[str, ...]: + """ + 标准化角色豁免配置 + + :param bypass_roles: 原始角色标识列表 + :return: 去重后的角色标识元组 + """ + if not bypass_roles: + return () + + normalized_roles: list[str] = [] + for role in bypass_roles: + normalized_role = role.strip() + if not normalized_role: + raise ValueError('ApiRateLimit的bypass_roles不能包含空角色标识') + if normalized_role not in normalized_roles: + normalized_roles.append(normalized_role) + + return tuple(normalized_roles) + + def _match_bypass_role(self) -> str | None: + """ + 判断当前登录用户是否命中角色豁免 + + :return: 命中的角色标识,未命中时返回None + """ + if not self.bypass_roles: + return None + + current_user = self._get_current_user() + if current_user is None: + return None + + user_roles = {str(role).strip() for role in current_user.roles if str(role).strip()} + for role in self.bypass_roles: + if role in user_roles: + return role + + return None + + async def _acquire_rate_limit(self, redis: aioredis.Redis, request: Request) -> dict[str, int | bool] | None: + """ + 获取当前请求的限流计数结果 + + :param redis: Redis连接对象 + :param request: 当前请求对象 + :return: 限流结果,当前请求不适用限流时返回None + """ + current_time_ms = int(time.time() * 1000) + rate_limit_key = self._build_rate_limit_key(request, current_time_ms) + if rate_limit_key is None: + return None + if self.algorithm == 'sliding_window': + allowed, current, remaining, reset_after_ms = await redis.eval( + self._SLIDING_WINDOW_LUA_SCRIPT, + 1, + rate_limit_key, + current_time_ms, + self.window_seconds * 1000, + f'{current_time_ms}-{time.time_ns()}-{uuid.uuid4().hex}', + self.limit, + ) + else: + window_ms = self.window_seconds * 1000 + window_bucket = current_time_ms // window_ms + window_end_ms = (window_bucket + 1) * window_ms + ttl_ms = max(window_end_ms - current_time_ms, 1) + allowed, current, remaining, reset_after_ms = await redis.eval( + self._FIXED_WINDOW_LUA_SCRIPT, 1, rate_limit_key, ttl_ms, self.limit + ) + reset_after_ms = max(int(reset_after_ms), 1) + + return { + 'allowed': bool(int(allowed)), + 'current': int(current), + 'remaining': int(remaining), + 'reset_after_seconds': max((reset_after_ms + 999) // 1000, 1), + 'reset_at': (current_time_ms + reset_after_ms + 999) // 1000, + } + + def _build_rate_limit_key( + self, request: Request, current_time_ms: int, include_window_bucket: bool = True + ) -> str | None: + """ + 构建当前请求的限流键 + + :param request: 当前请求对象 + :param current_time_ms: 当前时间戳,单位毫秒 + :return: 限流键,当前请求不适用限流时返回None + """ + scope_value = self._get_scope_value(request) + if scope_value is None: + return None + + key_material = { + 'method': request.method.upper(), + 'path': self._get_route_path(request), + 'scope': self.scope, + 'scope_value': scope_value, + } + key_digest = hashlib.sha256( + json.dumps( + key_material, + ensure_ascii=False, + sort_keys=True, + separators=(',', ':'), + ).encode('utf-8') + ).hexdigest() + + key_prefix = f'{RedisInitKeyConfig.API_RATE_LIMIT.key}:{self.namespace}:{self.algorithm}:{key_digest}' + if self.algorithm == 'fixed_window' and include_window_bucket: + window_bucket = current_time_ms // (self.window_seconds * 1000) + return f'{key_prefix}:{window_bucket}' + + return key_prefix + + def _resolve_failed_rate_limit( + self, request: Request, reason: str, error_message: str + ) -> dict[str, int | bool] | None: + """ + 处理Redis不可用或执行异常时的限流故障策略 + + :param request: 当前请求对象 + :param reason: 降级原因 + :param error_message: 错误详情 + :return: 限流结果,为None时表示按策略放行 + """ + self._log_rate_limit_degrade(request, reason, error_message) + if self.fail_strategy == 'open': + return None + if self.fail_strategy == 'closed': + return self._build_closed_rate_limit_result() + + return self._acquire_local_fallback_rate_limit(request) + + def _acquire_local_fallback_rate_limit(self, request: Request) -> dict[str, int | bool] | None: + """ + 使用进程内内存进行应急兜底限流,仅在Redis异常时启用 + + 该兜底能力仅在当前进程内生效,不保证多 worker / 多实例场景下的 + 全局一致限流,更适合作为短时故障期间的降级保护。 + + :param request: 当前请求对象 + :return: 限流结果,当前请求不适用限流时返回None + """ + current_time_ms = int(time.time() * 1000) + rate_limit_key = self._build_rate_limit_key(request, current_time_ms, include_window_bucket=False) + if rate_limit_key is None: + return None + + window_ms = self.window_seconds * 1000 + window_start_ms = current_time_ms - window_ms + local_window = self._LOCAL_FALLBACK_STORE.setdefault(rate_limit_key, deque()) + while local_window and local_window[0] <= window_start_ms: + local_window.popleft() + if not local_window: + self._LOCAL_FALLBACK_STORE.pop(rate_limit_key, None) + local_window = deque() + self._LOCAL_FALLBACK_STORE[rate_limit_key] = local_window + + current = len(local_window) + if current >= self.limit: + reset_after_ms = max(local_window[0] + window_ms - current_time_ms, 1) if local_window else window_ms + return { + 'allowed': False, + 'current': current, + 'remaining': 0, + 'reset_after_seconds': max((reset_after_ms + 999) // 1000, 1), + 'reset_at': (current_time_ms + reset_after_ms + 999) // 1000, + } + + local_window.append(current_time_ms) + current += 1 + reset_after_ms = max(local_window[0] + window_ms - current_time_ms, 1) + + return { + 'allowed': True, + 'current': current, + 'remaining': max(self.limit - current, 0), + 'reset_after_seconds': max((reset_after_ms + 999) // 1000, 1), + 'reset_at': (current_time_ms + reset_after_ms + 999) // 1000, + } + + def _build_closed_rate_limit_result(self) -> dict[str, int | bool]: + """ + 构建故障关闭策略下的拦截结果 + + :return: 限流结果 + """ + reset_after_seconds = max(self.window_seconds, 1) + current_time_ms = int(time.time() * 1000) + reset_after_ms = reset_after_seconds * 1000 + return { + 'allowed': False, + 'current': self.limit, + 'remaining': 0, + 'reset_after_seconds': reset_after_seconds, + 'reset_at': (current_time_ms + reset_after_ms + 999) // 1000, + } + + def _get_route_path(self, request: Request) -> str: + """ + 获取当前请求的路由模板路径 + + :param request: 当前请求对象 + :return: 路由模板路径 + """ + route = request.scope.get('route') + route_path = getattr(route, 'path', None) + return route_path or request.url.path + + def _get_scope_value(self, request: Request) -> str | None: + """ + 获取当前请求的限流作用域值 + + :param request: 当前请求对象 + :return: 作用域值,当前请求不适用限流时返回None + """ + if self.scope == 'ip': + return f'ip:{self._get_client_ip(request)}' + + current_user_id = self._get_current_user_id() + if current_user_id is not None: + return f'user:{current_user_id}' + + if self.scope == 'user': + return None + + return f'ip:{self._get_client_ip(request)}' + + def _get_current_user_id(self) -> int | None: + """ + 获取当前登录用户ID + + :return: 用户ID,未登录时返回None + """ + current_user = self._get_current_user() + return current_user.user.user_id if current_user and current_user.user else None + + def _get_current_user(self) -> CurrentUserModel | None: + """ + 获取当前登录用户 + + :return: 当前登录用户,未登录时返回None + """ + try: + return RequestContext.get_current_user() + except LoginException: + return None + + def _get_client_ip(self, request: Request) -> str: + """ + 获取客户端IP地址 + + :param request: 当前请求对象 + :return: 客户端IP地址 + """ + return ClientIPUtil.get_client_ip(request) + + def _build_rate_limit_headers(self, rate_limit_result: dict[str, int | bool]) -> dict[str, str]: + """ + 构建限流响应头 + + :param rate_limit_result: 限流结果 + :return: 限流响应头 + """ + headers = { + 'X-RateLimit-Limit': str(self.limit), + 'X-RateLimit-Remaining': str(rate_limit_result['remaining']), + 'X-RateLimit-Reset': str(rate_limit_result['reset_at']), + } + if not rate_limit_result['allowed']: + headers['Retry-After'] = str(rate_limit_result['reset_after_seconds']) + + return headers + + def _log_rate_limit_hit(self, request: Request, rate_limit_result: dict[str, int | bool]) -> None: + """ + 记录限流命中日志 + + :param request: 当前请求对象 + :param rate_limit_result: 限流结果 + :return: None + """ + logger.warning( + '接口限流命中: namespace={} preset={} algorithm={} fail_strategy={} method={} path={} scope={} scope_value={} current={} limit={} retry_after={}s', + self.namespace, + self.preset_name, + self.algorithm, + self.fail_strategy, + request.method.upper(), + self._get_route_path(request), + self.scope, + self._get_scope_value(request), + rate_limit_result['current'], + self.limit, + rate_limit_result['reset_after_seconds'], + ) + + def _log_rate_limit_degrade(self, request: Request, reason: str, error_message: str) -> None: + """ + 记录限流组件异常时的降级日志 + + :param request: 当前请求对象 + :param reason: 降级原因 + :param error_message: 错误详情 + :return: None + """ + log_message = ( + '接口限流降级: namespace={} preset={} algorithm={} fail_strategy={} ' + 'method={} path={} scope={} reason={} error={}' + ) + log_args: list[str] = [ + self.namespace, + self.preset_name, + self.algorithm, + self.fail_strategy, + request.method.upper(), + self._get_route_path(request), + self.scope, + reason, + error_message, + ] + if self.fail_strategy == 'local_fallback': + log_message += ' local_fallback_scope={}' + log_args.append('process_local_only') + + logger.warning(log_message, *log_args) + + def _log_rate_limit_bypass(self, request: Request, bypass_role: str) -> None: + """ + 记录角色豁免限流日志 + + :param request: 当前请求对象 + :param bypass_role: 命中的角色标识 + :return: None + """ + logger.info( + '接口限流绕过: namespace={} preset={} method={} path={} scope={} bypass_role={}', + self.namespace, + self.preset_name, + request.method.upper(), + self._get_route_path(request), + self.scope, + bypass_role, + ) diff --git a/shierfeng-fastapi-backend/common/aspect/data_scope.py b/shierfeng-fastapi-backend/common/aspect/data_scope.py new file mode 100644 index 0000000..4d3f93a --- /dev/null +++ b/shierfeng-fastapi-backend/common/aspect/data_scope.py @@ -0,0 +1,112 @@ +from fastapi import Depends, Request, params +from sqlalchemy import ColumnElement, func, or_, select + +from common.context import RequestContext +from config.database import Base +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.role_do import SysRoleDept +from utils.dependency_util import DependencyUtil + + +class GetDataScope: + """ + 获取当前用户数据权限对应的查询sql语句 + """ + + DATA_SCOPE_ALL = '1' + DATA_SCOPE_CUSTOM = '2' + DATA_SCOPE_DEPT = '3' + DATA_SCOPE_DEPT_AND_CHILD = '4' + DATA_SCOPE_SELF = '5' + + def __init__( + self, + query_alias: Base, + user_alias: str | None = 'user_id', + dept_alias: str | None = 'dept_id', + ) -> None: + """ + 获取当前用户数据权限对应的查询sql语句 + + :param query_alias: 所要查询表对应的sqlalchemy模型类,不可为空 + :param user_alias: 用户id字段别名,默认为'user_id' + :param dept_alias: 部门id字段别名,默认为'dept_id' + """ + self.query_alias = query_alias + self.user_alias = user_alias + self.dept_alias = dept_alias + + def __call__(self, request: Request) -> ColumnElement: + DependencyUtil.check_exclude_routes(request, err_msg='当前路由不在认证规则内,不可使用GetDataScope依赖项') + current_user = RequestContext.get_current_user() + user_id = current_user.user.user_id + dept_id = current_user.user.dept_id + custom_data_scope_role_id_list = [ + item.role_id for item in current_user.user.role if item.data_scope == self.DATA_SCOPE_CUSTOM + ] + param_sql_list = [] + for role in current_user.user.role: + if current_user.user.admin or role.data_scope == self.DATA_SCOPE_ALL: + param_sql_list = [True] + break + if role.data_scope == self.DATA_SCOPE_CUSTOM: + if len(custom_data_scope_role_id_list) > 1: + param_sql_list.append( + getattr(self.query_alias, self.dept_alias).in_( + select(SysRoleDept.dept_id).where(SysRoleDept.role_id.in_(custom_data_scope_role_id_list)) + ) + if hasattr(self.query_alias, self.dept_alias) + else False + ) + else: + param_sql_list.append( + getattr(self.query_alias, self.dept_alias).in_( + select(SysRoleDept.dept_id).where(SysRoleDept.role_id == role.role_id) + ) + if hasattr(self.query_alias, self.dept_alias) + else False + ) + elif role.data_scope == self.DATA_SCOPE_DEPT: + param_sql_list.append( + getattr(self.query_alias, self.dept_alias) == dept_id + if hasattr(self.query_alias, self.dept_alias) + else False + ) + elif role.data_scope == self.DATA_SCOPE_DEPT_AND_CHILD: + param_sql_list.append( + getattr(self.query_alias, self.dept_alias).in_( + select(SysDept.dept_id).where( + or_(SysDept.dept_id == dept_id, func.find_in_set(dept_id, SysDept.ancestors)) + ) + ) + if hasattr(self.query_alias, self.dept_alias) + else False + ) + elif role.data_scope == self.DATA_SCOPE_SELF: + param_sql_list.append( + getattr(self.query_alias, self.user_alias) == user_id + if hasattr(self.query_alias, self.user_alias) + else False + ) + else: + param_sql_list.append(False) + param_sql_list = list(dict.fromkeys(param_sql_list)) + param_sql = or_(*param_sql_list) + + return param_sql + + +def DataScopeDependency( # noqa: N802 + query_alias: Base, + user_alias: str | None = 'user_id', + dept_alias: str | None = 'dept_id', +) -> params.Depends: + """ + 当前用户数据权限依赖 + + :param query_alias: 所要查询表对应的sqlalchemy模型类,不可为空 + :param user_alias: 用户id字段别名,默认为'user_id' + :param dept_alias: 部门id字段别名,默认为'dept_id' + :return: 当前用户数据权限依赖 + """ + return Depends(GetDataScope(query_alias, user_alias, dept_alias)) diff --git a/shierfeng-fastapi-backend/common/aspect/db_seesion.py b/shierfeng-fastapi-backend/common/aspect/db_seesion.py new file mode 100644 index 0000000..3c88fb9 --- /dev/null +++ b/shierfeng-fastapi-backend/common/aspect/db_seesion.py @@ -0,0 +1,12 @@ +from fastapi import Depends, params + +from config.get_db import get_db + + +def DBSessionDependency() -> params.Depends: # noqa: N802 + """ + 数据库会话依赖 + + :return: 数据库会话依赖 + """ + return Depends(get_db) diff --git a/shierfeng-fastapi-backend/common/aspect/interface_auth.py b/shierfeng-fastapi-backend/common/aspect/interface_auth.py new file mode 100644 index 0000000..92f20e8 --- /dev/null +++ b/shierfeng-fastapi-backend/common/aspect/interface_auth.py @@ -0,0 +1,94 @@ +from fastapi import Depends, Request, params + +from common.context import RequestContext +from exceptions.exception import PermissionException +from utils.dependency_util import DependencyUtil + + +class CheckUserInterfaceAuth: + """ + 校验当前用户是否具有相应的接口权限 + """ + + def __init__(self, perm: str | list, is_strict: bool = False) -> None: + """ + 校验当前用户是否具有相应的接口权限 + + :param perm: 权限标识 + :param is_strict: 当传入的权限标识是list类型时,是否开启严格模式,开启表示会校验列表中的每一个权限标识,所有的校验结果都需要为True才会通过 + """ + self.perm = perm + self.is_strict = is_strict + + def __call__(self, request: Request) -> bool: + DependencyUtil.check_exclude_routes( + request, err_msg='当前路由不在认证规则内,不可使用CheckUserInterfaceAuth依赖项' + ) + current_user = RequestContext.get_current_user() + user_auth_list = current_user.permissions + if '*:*:*' in user_auth_list: + return True + if isinstance(self.perm, str) and self.perm in user_auth_list: + return True + if isinstance(self.perm, list): + if self.is_strict: + if all(perm_str in user_auth_list for perm_str in self.perm): + return True + elif any(perm_str in user_auth_list for perm_str in self.perm): + return True + raise PermissionException(data='', message='该用户无此接口权限') + + +class CheckRoleInterfaceAuth: + """ + 根据角色校验当前用户是否具有相应的接口权限 + """ + + def __init__(self, role_key: str | list, is_strict: bool = False) -> None: + """ + 根据角色校验当前用户是否具有相应的接口权限 + + :param role_key: 角色标识 + :param is_strict: 当传入的角色标识是list类型时,是否开启严格模式,开启表示会校验列表中的每一个角色标识,所有的校验结果都需要为True才会通过 + """ + self.role_key = role_key + self.is_strict = is_strict + + def __call__(self, request: Request) -> bool: + DependencyUtil.check_exclude_routes( + request, err_msg='当前路由不在认证规则内,不可使用CheckRoleInterfaceAuth依赖项' + ) + current_user = RequestContext.get_current_user() + user_role_list = current_user.user.role + user_role_key_list = [role.role_key for role in user_role_list] + if isinstance(self.role_key, str) and self.role_key in user_role_key_list: + return True + if isinstance(self.role_key, list): + if self.is_strict: + if all(role_key_str in user_role_key_list for role_key_str in self.role_key): + return True + elif any(role_key_str in user_role_key_list for role_key_str in self.role_key): + return True + raise PermissionException(data='', message='该用户无此接口权限') + + +def UserInterfaceAuthDependency(perm: str | list, is_strict: bool = False) -> params.Depends: # noqa: N802 + """ + 根据权限标识校验当前用户接口权限依赖 + + :param perm: 权限标识 + :param is_strict: 当传入的权限标识是list类型时,是否开启严格模式,开启表示会校验列表中的每一个权限标识,所有的校验结果都需要为True才会通过 + :return: 根据权限标识校验当前用户接口权限依赖 + """ + return Depends(CheckUserInterfaceAuth(perm, is_strict)) + + +def RoleInterfaceAuthDependency(role_key: str | list, is_strict: bool = False) -> params.Depends: # noqa: N802 + """ + 根据角色校验当前用户接口权限依赖 + + :param role_key: 角色标识 + :param is_strict: 当传入的角色标识是list类型时,是否开启严格模式,开启表示会校验列表中的每一个角色标识,所有的校验结果都需要为True才会通过 + :return: 根据角色校验当前用户接口权限依赖 + """ + return Depends(CheckRoleInterfaceAuth(role_key, is_strict)) diff --git a/shierfeng-fastapi-backend/common/aspect/pre_auth.py b/shierfeng-fastapi-backend/common/aspect/pre_auth.py new file mode 100644 index 0000000..cdcc579 --- /dev/null +++ b/shierfeng-fastapi-backend/common/aspect/pre_auth.py @@ -0,0 +1,146 @@ +import re +from typing import Literal, TypedDict + +from fastapi import Depends, Request, params +from fastapi.security import OAuth2PasswordBearer +from sqlalchemy.ext.asyncio import AsyncSession + +from common.context import RequestContext +from config.env import AppConfig +from config.get_db import get_db +from exceptions.exception import AuthException +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.login_service import LoginService + + +# 定义排除路由的字典结构 +class ExcludeRoute(TypedDict, total=False): + """ + 排除路由的字典结构 + + :param path: 路由路径(必填) + :param methods: HTTP方法列表,空列表表示所有方法(可选,默认为[]) + :param ignore_paths: 需要忽略的特定路径列表,即使匹配通配符也不排除(可选,默认为[]) + """ + + path: str + methods: list[Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']] + ignore_paths: list[str] + + +# 创建OAuth2PasswordBearer对象 +oauth2_scheme = OAuth2PasswordBearer(tokenUrl='/login') + + +class PreAuth: + """ + 登录认证前置校验依赖类 + """ + + def __init__(self, exclude_routes: list[ExcludeRoute] | None = None) -> None: + """ + 初始化登录认证前置校验依赖 + + :param exclude_routes: 需要排除的路由列表,格式为: + [{'path': '/path1', 'methods': ['GET', 'POST']}, {'path': '/path2/{param}', 'methods': ['GET']}] + methods 可以是字符串或列表,空列表表示所有方法 + """ + self.exclude_routes = exclude_routes or [] + # 编译排除路径为正则表达式模式,并存储方法信息 + self.exclude_patterns = [] + + for route in self.exclude_routes: + # 使用TypedDict,确保路由字典包含path字段 + path = route.get('path', '') + methods = route.get('methods', []) + ignore_paths = route.get('ignore_paths', []) + + # 编译路径为正则表达式 + pattern = self._compile_path_pattern(path) + # 存储编译后的模式和方法信息 + self.exclude_patterns.append( + { + 'pattern': pattern, + 'methods': [method.upper() for method in methods], + 'original_path': path, + 'ignore_paths': ignore_paths, + } + ) + + def _compile_path_pattern(self, path: str) -> re.Pattern: + """ + 将FastAPI路径转换为正则表达式模式 + + :param path: FastAPI路径(如 /configKey/{config_key}) + :return: 编译后的正则表达式模式 + """ + # 将FastAPI路径参数转换为正则表达式 + # 例如:/configKey/{config_key} -> /configKey/[^/]+ + pattern_str = re.sub(r'\{[^}]+\}', r'[^/]+', path) + # 添加开始和结束锚点,确保精确匹配 + return re.compile(f'^{pattern_str}$') + + async def __call__(self, request: Request, db: AsyncSession = Depends(get_db)) -> CurrentUserModel | None: + """ + 执行登录认证校验 + + :param request: 当前请求对象 + :param db: 数据库会话 + :return: 当前用户信息 + """ + # 获取当前请求路径和方法 + path = request.url.path + method = request.method.upper() + + # 从配置中获取APP_ROOT_PATH + app_root_path = AppConfig.app_root_path + + # 去掉APP_ROOT_PATH前缀 + if app_root_path and path.startswith(app_root_path): + path = path[len(app_root_path) :] + + # 设置上下文变量 + RequestContext.set_current_exclude_patterns(self.exclude_patterns) + + # 检查路径和方法是否匹配排除模式 + for item in self.exclude_patterns: + pattern = item['pattern'] + exclude_methods = item['methods'] + ignore_paths = item['ignore_paths'] + + # 检查当前路径是否在忽略列表中 + if path in ignore_paths: + continue + + # 检查路径是否匹配,并且methods为空列表(匹配所有方法)或者当前方法在允许列表中 + if pattern.match(path) and (not exclude_methods or method in exclude_methods): + # 跳过认证 + return None + + # 否则执行正常认证 + token = request.headers.get('Authorization') + if not token: + raise AuthException(data='', message='用户未登录,请先完成登录') + current_user = await LoginService.get_current_user(request, token, db) + return current_user + + +def PreAuthDependency(exclude_routes: list[ExcludeRoute] | None = None) -> params.Depends: # noqa: N802 + """ + 登录认证前置校验依赖 + + :param exclude_routes: 需要排除的路由列表,格式为: + [{'path': '/path1', 'methods': ['GET', 'POST']}, {'path': '/path2/{param}', 'methods': ['GET']}] + methods 可以是字符串或列表,空列表表示所有方法 + :return: 登录认证前置校验依赖 + """ + return Depends(PreAuth(exclude_routes)) + + +def CurrentUserDependency() -> params.Depends: # noqa: N802 + """ + 当前登录用户信息依赖 + + :return: 当前登录用户信息依赖 + """ + return Depends(LoginService.get_current_user) diff --git a/shierfeng-fastapi-backend/common/constant.py b/shierfeng-fastapi-backend/common/constant.py new file mode 100644 index 0000000..1d8cf23 --- /dev/null +++ b/shierfeng-fastapi-backend/common/constant.py @@ -0,0 +1,856 @@ +from config.env import DataBaseConfig + + +class CommonConstant: + """ + 常用常量 + + PASSWORD_ERROR_COUNT: 密码错误次数 + WWW: www主域 + HTTP: http请求 + HTTPS: https请求 + LOOKUP_RMI: RMI远程方法调用 + LOOKUP_LDAP: LDAP远程方法调用 + LOOKUP_LDAPS: LDAPS远程方法调用 + YES: 是否为系统默认(是) + NO: 是否为系统默认(否) + DEPT_NORMAL: 部门正常状态 + DEPT_DISABLE: 部门停用状态 + UNIQUE: 校验是否唯一的返回标识(是) + NOT_UNIQUE: 校验是否唯一的返回标识(否) + """ + + PASSWORD_ERROR_COUNT = 5 + WWW = 'www.' + HTTP = 'http://' + HTTPS = 'https://' + LOOKUP_RMI = 'rmi:' + LOOKUP_LDAP = 'ldap:' + LOOKUP_LDAPS = 'ldaps:' + YES = 'Y' + NO = 'N' + DEPT_NORMAL = '0' + DEPT_DISABLE = '1' + UNIQUE = True + NOT_UNIQUE = False + + +class HttpStatusConstant: + """ + 返回状态码 + + SUCCESS: 操作成功 + CREATED: 对象创建成功 + ACCEPTED: 请求已经被接受 + NO_CONTENT: 操作已经执行成功,但是没有返回数据 + MOVED_PERM: 资源已被移除 + SEE_OTHER: 重定向 + NOT_MODIFIED: 资源没有被修改 + BAD_REQUEST: 参数列表错误(缺少,格式不匹配) + UNAUTHORIZED: 未授权 + FORBIDDEN: 访问受限,授权过期 + NOT_FOUND: 资源,服务未找到 + BAD_METHOD: 不允许的http方法 + CONFLICT: 资源冲突,或者资源被锁 + UNSUPPORTED_TYPE: 不支持的数据,媒体类型 + TOO_MANY_REQUESTS: 请求过于频繁 + ERROR: 系统内部错误 + NOT_IMPLEMENTED: 接口未实现 + WARN: 系统警告消息 + """ + + SUCCESS = 200 + CREATED = 201 + ACCEPTED = 202 + NO_CONTENT = 204 + MOVED_PERM = 301 + SEE_OTHER = 303 + NOT_MODIFIED = 304 + BAD_REQUEST = 400 + UNAUTHORIZED = 401 + FORBIDDEN = 403 + NOT_FOUND = 404 + BAD_METHOD = 405 + CONFLICT = 409 + UNSUPPORTED_TYPE = 415 + TOO_MANY_REQUESTS = 429 + ERROR = 500 + NOT_IMPLEMENTED = 501 + WARN = 601 + + +class JobConstant: + """ + 定时任务常量 + + JOB_ERROR_LIST: 定时任务禁止调用模块及违规字符串列表 + JOB_WHITE_LIST: 定时任务允许调用模块列表 + """ + + JOB_ERROR_LIST = [ + 'app', + 'config', + 'exceptions', + 'import ', + 'middlewares', + 'module_admin', + 'open(', + 'os.', + 'server', + 'sub_applications', + 'subprocess.', + 'sys.', + 'utils', + 'while ', + '__import__', + '"', + "'", + ',', + '?', + ':', + ';', + '/', + '|', + '+', + '-', + '=', + '~', + '!', + '#', + '$', + '%', + '^', + '&', + '*', + '<', + '>', + '(', + ')', + '[', + ']', + '{', + '}', + ' ', + ] + JOB_WHITE_LIST = ['module_task'] + + +class LockConstant: + """ + 分布式锁常量 + """ + + APP_STARTUP_LOCK_KEY = 'app:startup:lock' + LOCK_EXPIRE_SECONDS = 60 + LOCK_RENEWAL_INTERVAL = 20 + + +class ApiNamespace: + """ + 接口注解通用命名空间常量 + + 这一组常量统一提供给 `ApiCache`、`ApiCacheEvict`、`ApiRateLimit` + 等接口注解使用,用同一套“模块:功能”命名规则收敛缓存和限流场景。 + + LOGIN: 登录接口命名空间 + REGISTER: 注册接口命名空间 + LOGIN_USER_INFO: 登录用户信息接口命名空间 + LOGIN_USER_ROUTERS: 登录用户路由接口命名空间 + CAPTCHA_IMAGE: 图片验证码接口命名空间 + COMMON_UPLOAD: 通用上传接口命名空间 + TRANSPORT_CRYPTO_PUBLIC_KEY: 传输层加密公钥接口命名空间 + TRANSPORT_CRYPTO_FRONTEND_CONFIG: 传输层加密前端配置接口命名空间 + + MONITOR_SERVER_INFO: 服务监控信息接口命名空间 + MONITOR_CACHE_CLEAR_NAME: 缓存名称清理接口命名空间 + MONITOR_CACHE_CLEAR_KEY: 缓存键清理接口命名空间 + MONITOR_CACHE_CLEAR_ALL: 缓存全量清理接口命名空间 + MONITOR_ONLINE_FORCE_LOGOUT: 在线用户强退接口命名空间 + MONITOR_OPERLOG_CLEAN: 操作日志清空接口命名空间 + MONITOR_OPERLOG_DELETE: 操作日志删除接口命名空间 + MONITOR_OPERLOG_EXPORT: 操作日志导出接口命名空间 + MONITOR_LOGININFO_CLEAN: 登录日志清空接口命名空间 + MONITOR_LOGININFO_DELETE: 登录日志删除接口命名空间 + MONITOR_LOGININFO_UNLOCK: 账户解锁接口命名空间 + MONITOR_LOGININFO_EXPORT: 登录日志导出接口命名空间 + MONITOR_JOB_LIST: 定时任务分页列表接口命名空间 + MONITOR_JOB_DETAIL: 定时任务详情接口命名空间 + MONITOR_JOB_RUN: 定时任务执行接口命名空间 + MONITOR_JOB_DELETE: 定时任务删除接口命名空间 + MONITOR_JOB_EXPORT: 定时任务导出接口命名空间 + MONITOR_JOB_LOG_CLEAN: 定时任务日志清空接口命名空间 + MONITOR_JOB_LOG_DELETE: 定时任务日志删除接口命名空间 + MONITOR_JOB_LOG_EXPORT: 定时任务日志导出接口命名空间 + + SYSTEM_DEPT_EDIT_TREE: 部门编辑树接口命名空间 + SYSTEM_DEPT_LIST: 部门列表接口命名空间 + SYSTEM_DEPT_DETAIL: 部门详情接口命名空间 + SYSTEM_CONFIG_LIST: 参数配置列表接口命名空间 + SYSTEM_CONFIG_DETAIL: 参数配置详情接口命名空间 + SYSTEM_CONFIG_REFRESH_CACHE: 参数缓存刷新接口命名空间 + SYSTEM_CONFIG_EXPORT: 参数导出接口命名空间 + SYSTEM_DICT_TYPE_LIST: 字典类型列表接口命名空间 + SYSTEM_DICT_TYPE_OPTIONS: 字典类型选项接口命名空间 + SYSTEM_DICT_TYPE_DETAIL: 字典类型详情接口命名空间 + SYSTEM_DICT_REFRESH_CACHE: 字典缓存刷新接口命名空间 + SYSTEM_DICT_TYPE_EXPORT: 字典类型导出接口命名空间 + SYSTEM_DICT_DATA_LIST: 字典数据列表接口命名空间 + SYSTEM_DICT_DATA_DETAIL: 字典数据详情接口命名空间 + SYSTEM_DICT_DATA_EXPORT: 字典数据导出接口命名空间 + SYSTEM_MENU_TREE: 菜单树接口命名空间 + SYSTEM_MENU_ROLE_TREE: 角色菜单树接口命名空间 + SYSTEM_MENU_LIST: 菜单分页列表接口命名空间 + SYSTEM_MENU_DETAIL: 菜单详情接口命名空间 + SYSTEM_NOTICE_LIST: 通知公告列表接口命名空间 + SYSTEM_NOTICE_DETAIL: 通知公告详情接口命名空间 + SYSTEM_POST_LIST: 岗位列表接口命名空间 + SYSTEM_POST_DETAIL: 岗位详情接口命名空间 + SYSTEM_POST_EXPORT: 岗位导出接口命名空间 + SYSTEM_ROLE_DEPT_TREE: 角色部门树接口命名空间 + SYSTEM_ROLE_LIST: 角色列表接口命名空间 + SYSTEM_ROLE_DETAIL: 角色详情接口命名空间 + SYSTEM_ROLE_ALLOCATED_USER_LIST: 已分配用户角色列表接口命名空间 + SYSTEM_ROLE_UNALLOCATED_USER_LIST: 未分配用户角色列表接口命名空间 + SYSTEM_ROLE_EXPORT: 角色导出接口命名空间 + SYSTEM_ROLE_AUTH_USER_SELECT_ALL: 角色批量分配用户接口命名空间 + SYSTEM_ROLE_AUTH_USER_CANCEL: 角色取消分配用户接口命名空间 + SYSTEM_ROLE_AUTH_USER_CANCEL_ALL: 角色批量取消分配用户接口命名空间 + SYSTEM_USER_DEPT_TREE: 用户部门树接口命名空间 + SYSTEM_USER_LIST: 用户列表接口命名空间 + SYSTEM_USER_PROFILE: 用户个人信息接口命名空间 + SYSTEM_USER_DETAIL: 用户详情接口命名空间 + SYSTEM_USER_PROFILE_AVATAR: 用户头像上传接口命名空间 + SYSTEM_USER_IMPORT: 用户导入接口命名空间 + SYSTEM_USER_EXPORT: 用户导出接口命名空间 + + AI_MODEL_LIST: AI模型列表接口命名空间 + AI_MODEL_ALL: AI模型全量列表接口命名空间 + AI_MODEL_DETAIL: AI模型详情接口命名空间 + AI_CHAT_CONFIG: AI对话配置接口命名空间 + AI_CHAT_SEND: AI对话发送接口命名空间 + AI_CHAT_CANCEL: AI对话取消接口命名空间 + + TOOL_GEN_LIST: 代码生成列表接口命名空间 + TOOL_GEN_DB_LIST: 代码生成数据源列表接口命名空间 + TOOL_GEN_DETAIL: 代码生成详情接口命名空间 + TOOL_GEN_PREVIEW: 代码生成预览接口命名空间 + TOOL_GEN_IMPORT_TABLE: 代码生成导入表接口命名空间 + TOOL_GEN_CREATE_TABLE: 代码生成建表接口命名空间 + TOOL_GEN_BATCH_GEN_CODE: 代码生成批量下载接口命名空间 + TOOL_GEN_GEN_CODE_LOCAL: 代码生成到本地接口命名空间 + TOOL_GEN_SYNC_DB: 代码生成同步库结构接口命名空间 + """ + + LOGIN = 'login' + REGISTER = 'register' + LOGIN_USER_INFO = 'login:user:info' + LOGIN_USER_ROUTERS = 'login:user:routers' + CAPTCHA_IMAGE = 'captcha:image' + COMMON_UPLOAD = 'common:upload' + TRANSPORT_CRYPTO_PUBLIC_KEY = 'transport-crypto:public-key' + TRANSPORT_CRYPTO_FRONTEND_CONFIG = 'transport-crypto:frontend-config' + + MONITOR_SERVER_INFO = 'monitor:server:info' + MONITOR_CACHE_CLEAR_NAME = 'monitor:cache:clear-name' + MONITOR_CACHE_CLEAR_KEY = 'monitor:cache:clear-key' + MONITOR_CACHE_CLEAR_ALL = 'monitor:cache:clear-all' + MONITOR_ONLINE_FORCE_LOGOUT = 'monitor:online:force-logout' + MONITOR_OPERLOG_CLEAN = 'monitor:operlog:clean' + MONITOR_OPERLOG_DELETE = 'monitor:operlog:delete' + MONITOR_OPERLOG_EXPORT = 'monitor:operlog:export' + MONITOR_LOGININFO_CLEAN = 'monitor:logininfor:clean' + MONITOR_LOGININFO_DELETE = 'monitor:logininfor:delete' + MONITOR_LOGININFO_UNLOCK = 'monitor:logininfor:unlock' + MONITOR_LOGININFO_EXPORT = 'monitor:logininfor:export' + MONITOR_JOB_LIST = 'monitor:job:list' + MONITOR_JOB_DETAIL = 'monitor:job:detail' + MONITOR_JOB_RUN = 'monitor:job:run' + MONITOR_JOB_DELETE = 'monitor:job:delete' + MONITOR_JOB_EXPORT = 'monitor:job:export' + MONITOR_JOB_LOG_CLEAN = 'monitor:job-log:clean' + MONITOR_JOB_LOG_DELETE = 'monitor:job-log:delete' + MONITOR_JOB_LOG_EXPORT = 'monitor:job-log:export' + + SYSTEM_DEPT_EDIT_TREE = 'system:dept:edit-tree' + SYSTEM_DEPT_LIST = 'system:dept:list' + SYSTEM_DEPT_DETAIL = 'system:dept:detail' + + SYSTEM_CONFIG_LIST = 'system:config:list' + SYSTEM_CONFIG_DETAIL = 'system:config:detail' + SYSTEM_CONFIG_REFRESH_CACHE = 'system:config:refresh-cache' + SYSTEM_CONFIG_EXPORT = 'system:config:export' + + SYSTEM_DICT_TYPE_LIST = 'system:dict:type-list' + SYSTEM_DICT_TYPE_OPTIONS = 'system:dict:type-options' + SYSTEM_DICT_TYPE_DETAIL = 'system:dict:type-detail' + SYSTEM_DICT_REFRESH_CACHE = 'system:dict:refresh-cache' + SYSTEM_DICT_TYPE_EXPORT = 'system:dict:type-export' + SYSTEM_DICT_DATA_LIST = 'system:dict:data-list' + SYSTEM_DICT_DATA_DETAIL = 'system:dict:data-detail' + SYSTEM_DICT_DATA_EXPORT = 'system:dict:data-export' + + SYSTEM_MENU_TREE = 'system:menu:tree' + SYSTEM_MENU_ROLE_TREE = 'system:menu:role-tree' + SYSTEM_MENU_LIST = 'system:menu:list' + SYSTEM_MENU_DETAIL = 'system:menu:detail' + + SYSTEM_NOTICE_LIST = 'system:notice:list' + SYSTEM_NOTICE_DETAIL = 'system:notice:detail' + + SYSTEM_POST_LIST = 'system:post:list' + SYSTEM_POST_DETAIL = 'system:post:detail' + SYSTEM_POST_EXPORT = 'system:post:export' + + SYSTEM_ROLE_DEPT_TREE = 'system:role:dept-tree' + SYSTEM_ROLE_LIST = 'system:role:list' + SYSTEM_ROLE_DETAIL = 'system:role:detail' + SYSTEM_ROLE_ALLOCATED_USER_LIST = 'system:role:allocated-user-list' + SYSTEM_ROLE_UNALLOCATED_USER_LIST = 'system:role:unallocated-user-list' + SYSTEM_ROLE_EXPORT = 'system:role:export' + SYSTEM_ROLE_AUTH_USER_SELECT_ALL = 'system:role:auth-user-select-all' + SYSTEM_ROLE_AUTH_USER_CANCEL = 'system:role:auth-user-cancel' + SYSTEM_ROLE_AUTH_USER_CANCEL_ALL = 'system:role:auth-user-cancel-all' + + SYSTEM_USER_DEPT_TREE = 'system:user:dept-tree' + SYSTEM_USER_LIST = 'system:user:list' + SYSTEM_USER_PROFILE = 'system:user:profile' + SYSTEM_USER_DETAIL = 'system:user:detail' + SYSTEM_USER_PROFILE_AVATAR = 'system:user:profile-avatar' + SYSTEM_USER_IMPORT = 'system:user:import' + SYSTEM_USER_EXPORT = 'system:user:export' + + AI_MODEL_LIST = 'ai:model:list' + AI_MODEL_ALL = 'ai:model:all' + AI_MODEL_DETAIL = 'ai:model:detail' + AI_CHAT_CONFIG = 'ai:chat:config' + AI_CHAT_SEND = 'ai:chat:send' + AI_CHAT_CANCEL = 'ai:chat:cancel' + + TOOL_GEN_LIST = 'tool:gen:list' + TOOL_GEN_DB_LIST = 'tool:gen:db-list' + TOOL_GEN_DETAIL = 'tool:gen:detail' + TOOL_GEN_PREVIEW = 'tool:gen:preview' + + TOOL_GEN_IMPORT_TABLE = 'tool:gen:import-table' + TOOL_GEN_CREATE_TABLE = 'tool:gen:create-table' + TOOL_GEN_BATCH_GEN_CODE = 'tool:gen:batch-gen-code' + TOOL_GEN_GEN_CODE_LOCAL = 'tool:gen:gen-code-local' + TOOL_GEN_SYNC_DB = 'tool:gen:sync-db' + + +class ApiGroup: + """ + 接口命名空间分组常量 + + 当前主要用于 `ApiCacheEvict` 批量清理关联命名空间,分组成员均来自 + `ApiNamespace`,按业务写操作影响范围收敛管理。 + + PERMISSION_MUTATION: 权限与菜单视图关联命名空间分组 + DATA_SCOPE_MUTATION: 数据范围相关视图关联命名空间分组 + MENU_MUTATION: 菜单写操作关联命名空间分组 + JOB_MUTATION: 定时任务写操作关联命名空间分组 + POST_MUTATION: 岗位写操作关联命名空间分组 + NOTICE_MUTATION: 通知公告写操作关联命名空间分组 + ROLE_ENTITY_MUTATION: 角色实体信息变更关联命名空间分组 + ROLE_PERMISSION_MUTATION: 角色权限变更关联命名空间分组 + ROLE_MUTATION: 角色通用写操作关联命名空间组合分组 + USER_ENTITY_MUTATION: 用户实体信息变更关联命名空间分组 + USER_PERMISSION_MUTATION: 用户权限变更关联命名空间分组 + USER_INFO_MUTATION: 用户资料与安全相关写操作关联命名空间分组 + LOGIN_SUCCESS_MUTATION: 登录成功后关联命名空间分组 + LOGOUT_MUTATION: 登出后关联命名空间分组 + CONFIG_MUTATION: 参数配置写操作关联命名空间分组 + DICT_TYPE_MUTATION: 字典类型写操作关联命名空间分组 + DICT_DATA_MUTATION: 字典数据写操作关联命名空间分组 + AI_MODEL_MUTATION: AI模型写操作关联命名空间分组 + AI_CHAT_CONFIG_MUTATION: AI对话配置写操作关联命名空间分组 + GEN_MUTATION: 代码生成写操作关联命名空间分组 + """ + + PERMISSION_MUTATION = ( + ApiNamespace.LOGIN_USER_INFO, + ApiNamespace.LOGIN_USER_ROUTERS, + ApiNamespace.SYSTEM_MENU_TREE, + ApiNamespace.SYSTEM_MENU_ROLE_TREE, + ApiNamespace.SYSTEM_MENU_LIST, + ) + + DATA_SCOPE_MUTATION = ( + ApiNamespace.LOGIN_USER_INFO, + ApiNamespace.SYSTEM_DEPT_EDIT_TREE, + ApiNamespace.SYSTEM_DEPT_LIST, + ApiNamespace.SYSTEM_DEPT_DETAIL, + ApiNamespace.SYSTEM_ROLE_DEPT_TREE, + ApiNamespace.SYSTEM_ROLE_LIST, + ApiNamespace.SYSTEM_ROLE_DETAIL, + ApiNamespace.SYSTEM_ROLE_ALLOCATED_USER_LIST, + ApiNamespace.SYSTEM_ROLE_UNALLOCATED_USER_LIST, + ApiNamespace.SYSTEM_USER_DEPT_TREE, + ApiNamespace.SYSTEM_USER_LIST, + ApiNamespace.SYSTEM_USER_DETAIL, + ApiNamespace.SYSTEM_USER_PROFILE, + ApiNamespace.AI_MODEL_LIST, + ApiNamespace.AI_MODEL_ALL, + ApiNamespace.AI_MODEL_DETAIL, + ) + + MENU_MUTATION = ( + *PERMISSION_MUTATION, + ApiNamespace.SYSTEM_MENU_DETAIL, + ) + + JOB_MUTATION = ( + ApiNamespace.MONITOR_JOB_LIST, + ApiNamespace.MONITOR_JOB_DETAIL, + ) + + POST_MUTATION = ( + ApiNamespace.SYSTEM_POST_LIST, + ApiNamespace.SYSTEM_POST_DETAIL, + ApiNamespace.SYSTEM_USER_DETAIL, + ApiNamespace.SYSTEM_USER_PROFILE, + ) + + NOTICE_MUTATION = ( + ApiNamespace.SYSTEM_NOTICE_LIST, + ApiNamespace.SYSTEM_NOTICE_DETAIL, + ) + + ROLE_ENTITY_MUTATION = ( + ApiNamespace.SYSTEM_ROLE_DEPT_TREE, + ApiNamespace.SYSTEM_ROLE_LIST, + ApiNamespace.SYSTEM_ROLE_DETAIL, + ApiNamespace.SYSTEM_ROLE_ALLOCATED_USER_LIST, + ApiNamespace.SYSTEM_ROLE_UNALLOCATED_USER_LIST, + ApiNamespace.SYSTEM_MENU_ROLE_TREE, + ApiNamespace.SYSTEM_USER_DETAIL, + ) + + ROLE_PERMISSION_MUTATION = ( + *ROLE_ENTITY_MUTATION, + ApiNamespace.SYSTEM_USER_PROFILE, + ApiNamespace.LOGIN_USER_INFO, + *PERMISSION_MUTATION, + ) + + ROLE_MUTATION = ( + *ROLE_PERMISSION_MUTATION, + *DATA_SCOPE_MUTATION, + ) + + USER_ENTITY_MUTATION = ( + ApiNamespace.SYSTEM_USER_LIST, + ApiNamespace.SYSTEM_USER_DETAIL, + ApiNamespace.SYSTEM_ROLE_ALLOCATED_USER_LIST, + ApiNamespace.SYSTEM_ROLE_UNALLOCATED_USER_LIST, + ) + + USER_PERMISSION_MUTATION = ( + *DATA_SCOPE_MUTATION, + *PERMISSION_MUTATION, + ) + + USER_INFO_MUTATION = ( + ApiNamespace.SYSTEM_USER_LIST, + ApiNamespace.SYSTEM_USER_DETAIL, + ApiNamespace.SYSTEM_USER_PROFILE, + ApiNamespace.LOGIN_USER_INFO, + ) + + LOGIN_SUCCESS_MUTATION = ( + ApiNamespace.SYSTEM_USER_LIST, + ApiNamespace.LOGIN_USER_INFO, + ApiNamespace.LOGIN_USER_ROUTERS, + ApiNamespace.SYSTEM_USER_PROFILE, + ApiNamespace.SYSTEM_USER_DETAIL, + ) + + LOGOUT_MUTATION = ( + ApiNamespace.LOGIN_USER_INFO, + ApiNamespace.LOGIN_USER_ROUTERS, + ) + + CONFIG_MUTATION = ( + ApiNamespace.SYSTEM_CONFIG_LIST, + ApiNamespace.SYSTEM_CONFIG_DETAIL, + ) + + DICT_TYPE_MUTATION = ( + ApiNamespace.SYSTEM_DICT_TYPE_LIST, + ApiNamespace.SYSTEM_DICT_TYPE_OPTIONS, + ApiNamespace.SYSTEM_DICT_TYPE_DETAIL, + ApiNamespace.SYSTEM_DICT_DATA_LIST, + ApiNamespace.SYSTEM_DICT_DATA_DETAIL, + ) + + DICT_DATA_MUTATION = ( + ApiNamespace.SYSTEM_DICT_DATA_LIST, + ApiNamespace.SYSTEM_DICT_DATA_DETAIL, + ) + + AI_MODEL_MUTATION = ( + ApiNamespace.AI_MODEL_LIST, + ApiNamespace.AI_MODEL_ALL, + ApiNamespace.AI_MODEL_DETAIL, + ) + + AI_CHAT_CONFIG_MUTATION = (ApiNamespace.AI_CHAT_CONFIG,) + + GEN_MUTATION = ( + ApiNamespace.TOOL_GEN_LIST, + ApiNamespace.TOOL_GEN_DB_LIST, + ApiNamespace.TOOL_GEN_DETAIL, + ApiNamespace.TOOL_GEN_PREVIEW, + ) + + +class MenuConstant: + """ + 菜单常量 + + TYPE_DIR: 菜单类型(目录) + TYPE_MENU: 菜单类型(菜单) + TYPE_BUTTON: 菜单类型(按钮) + YES_FRAME: 是否菜单外链(是) + NO_FRAME: 是否菜单外链(否) + LAYOUT: Layout组件标识 + PARENT_VIEW: ParentView组件标识 + INNER_LINK: InnerLink组件标识 + """ + + TYPE_DIR = 'M' + TYPE_MENU = 'C' + TYPE_BUTTON = 'F' + YES_FRAME = 0 + NO_FRAME = 1 + LAYOUT = 'Layout' + PARENT_VIEW = 'ParentView' + INNER_LINK = 'InnerLink' + + +class GenConstant: + """ + 代码生成常量 + + TPL_CRUD: 单表(增删改查 + TPL_TREE: 树表(增删改查) + TPL_SUB: 主子表(增删改查) + TREE_CODE: 树编码字段 + TREE_PARENT_CODE: 树父编码字段 + TREE_NAME: 树名称字段 + PARENT_MENU_ID: 上级菜单ID字段 + PARENT_MENU_NAME: 上级菜单名称字段 + COLUMNTYPE_STR: 数据库字符串类型 + COLUMNTYPE_TEXT: 数据库文本类型 + COLUMNTYPE_TIME: 数据库时间类型 + COLUMNTYPE_GEOMETRY: 数据库字空间类型 + COLUMNTYPE_NUMBER: 数据库数字类型 + COLUMNNAME_NOT_EDIT: 页面不需要编辑字段 + COLUMNNAME_NOT_LIST: 页面不需要显示的列表字段 + COLUMNNAME_NOT_QUERY: 页面不需要查询字段 + BASE_ENTITY: Entity基类字段 + TREE_ENTITY: Tree基类字段 + HTML_INPUT: 文本框 + HTML_TEXTAREA: 文本域 + HTML_SELECT: 下拉框 + HTML_RADIO: 单选框 + HTML_CHECKBOX: 复选框 + HTML_DATETIME: 日期控件 + HTML_IMAGE_UPLOAD: 图片上传控件 + HTML_FILE_UPLOAD: 文件上传控件 + HTML_EDITOR: 富文本控件 + TYPE_DECIMAL: 高精度计算类型 + TYPE_DATE: 时间类型 + QUERY_LIKE: 模糊查询 + QUERY_EQ: 相等查询 + REQUIRE: 需要 + DB_TO_SQLALCHEMY_TYPE_MAPPING: 数据库类型与sqlalchemy类型映射 + DB_TO_PYTHON_TYPE_MAPPING: 数据库类型与python类型映射 + """ + + TPL_CRUD = 'crud' + TPL_TREE = 'tree' + TPL_SUB = 'sub' + TREE_CODE = 'treeCode' + TREE_PARENT_CODE = 'treeParentCode' + TREE_NAME = 'treeName' + PARENT_MENU_ID = 'parentMenuId' + PARENT_MENU_NAME = 'parentMenuName' + COLUMNTYPE_STR = ( + ['character varying', 'varchar', 'character', 'char'] + if DataBaseConfig.db_type == 'postgresql' + else ['char', 'varchar', 'nvarchar', 'varchar2'] + ) + COLUMNTYPE_TEXT = ( + ['text', 'citext'] if DataBaseConfig.db_type == 'postgresql' else ['tinytext', 'text', 'mediumtext', 'longtext'] + ) + COLUMNTYPE_TIME = ( + [ + 'date', + 'time', + 'time with time zone', + 'time without time zone', + 'timestamp', + 'timestamp with time zone', + 'timestamp without time zone', + 'interval', + ] + if DataBaseConfig.db_type == 'postgresql' + else ['datetime', 'time', 'date', 'timestamp'] + ) + COLUMNTYPE_GEOMETRY = ( + ['point', 'line', 'lseg', 'box', 'path', 'polygon', 'circle'] + if DataBaseConfig.db_type == 'postgresql' + else [ + 'geometry', + 'point', + 'linestring', + 'polygon', + 'multipoint', + 'multilinestring', + 'multipolygon', + 'geometrycollection', + ] + ) + COLUMNTYPE_NUMBER = [ + 'tinyint', + 'smallint', + 'mediumint', + 'int', + 'number', + 'integer', + 'bit', + 'bigint', + 'float', + 'double', + 'decimal', + ] + COLUMNNAME_NOT_ADD_SHOW = ['create_by', 'create_time'] + COLUMNNAME_NOT_EDIT_SHOW = ['update_by', 'update_time'] + COLUMNNAME_NOT_EDIT = ['id', 'create_by', 'create_time', 'del_flag'] + COLUMNNAME_NOT_LIST = ['id', 'create_by', 'create_time', 'del_flag', 'update_by', 'update_time'] + COLUMNNAME_NOT_QUERY = ['id', 'create_by', 'create_time', 'del_flag', 'update_by', 'update_time', 'remark'] + BASE_ENTITY = ['createBy', 'createTime', 'updateBy', 'updateTime', 'remark'] + TREE_ENTITY = ['parentName', 'parentId', 'orderNum', 'ancestors', 'children'] + HTML_INPUT = 'input' + HTML_TEXTAREA = 'textarea' + HTML_SELECT = 'select' + HTML_RADIO = 'radio' + HTML_CHECKBOX = 'checkbox' + HTML_DATETIME = 'datetime' + HTML_IMAGE_UPLOAD = 'imageUpload' + HTML_FILE_UPLOAD = 'fileUpload' + HTML_EDITOR = 'editor' + TYPE_DECIMAL = 'Decimal' + TYPE_DATE = ['date', 'time', 'datetime'] + QUERY_LIKE = 'LIKE' + QUERY_EQ = 'EQ' + REQUIRE = '1' + DB_TO_SQLALCHEMY_TYPE_MAPPING = ( + { + 'boolean': 'Boolean', + 'smallint': 'SmallInteger', + 'integer': 'Integer', + 'bigint': 'BigInteger', + 'real': 'Float', + 'double precision': 'Float', + 'numeric': 'Numeric', + 'character varying': 'String', + 'character': 'String', + 'text': 'Text', + 'bytea': 'LargeBinary', + 'date': 'Date', + 'time': 'Time', + 'time with time zone': 'Time', + 'time without time zone': 'Time', + 'timestamp': 'DateTime', + 'timestamp with time zone': 'DateTime', + 'timestamp without time zone': 'DateTime', + 'interval': 'Interval', + 'json': 'JSON', + 'jsonb': 'JSONB', + 'uuid': 'Uuid', + 'inet': 'INET', + 'cidr': 'CIDR', + 'macaddr': 'MACADDR', + 'point': 'Geometry', + 'line': 'Geometry', + 'lseg': 'Geometry', + 'box': 'Geometry', + 'path': 'Geometry', + 'polygon': 'Geometry', + 'circle': 'Geometry', + 'bit': 'Bit', + 'bit varying': 'Bit', + 'tsvector': 'TSVECTOR', + 'tsquery': 'TSQUERY', + 'xml': 'String', + 'array': 'ARRAY', + 'composite': 'JSON', + 'enum': 'Enum', + 'range': 'Range', + 'money': 'Numeric', + 'pg_lsn': 'BigInteger', + 'txid_snapshot': 'String', + 'oid': 'BigInteger', + 'regproc': 'String', + 'regclass': 'String', + 'regtype': 'String', + 'regrole': 'String', + 'regnamespace': 'String', + 'int2vector': 'ARRAY', + 'oidvector': 'ARRAY', + 'pg_node_tree': 'Text', + } + if DataBaseConfig.db_type == 'postgresql' + else { + # 数值类型 + 'TINYINT': 'SmallInteger', + 'SMALLINT': 'SmallInteger', + 'MEDIUMINT': 'Integer', + 'INT': 'Integer', + 'INTEGER': 'Integer', + 'BIGINT': 'BigInteger', + 'FLOAT': 'Float', + 'DOUBLE': 'Float', + 'DECIMAL': 'DECIMAL', + 'BIT': 'Integer', + # 日期和时间类型 + 'DATE': 'Date', + 'TIME': 'Time', + 'DATETIME': 'DateTime', + 'TIMESTAMP': 'TIMESTAMP', + 'YEAR': 'Integer', + # 字符串类型 + 'CHAR': 'CHAR', + 'VARCHAR': 'String', + 'TINYTEXT': 'Text', + 'TEXT': 'Text', + 'MEDIUMTEXT': 'Text', + 'LONGTEXT': 'Text', + 'BINARY': 'BINARY', + 'VARBINARY': 'VARBINARY', + 'TINYBLOB': 'LargeBinary', + 'BLOB': 'LargeBinary', + 'MEDIUMBLOB': 'LargeBinary', + 'LONGBLOB': 'LargeBinary', + # 枚举和集合类型 + 'ENUM': 'Enum', + 'SET': 'String', + # JSON 类型 + 'JSON': 'JSON', + # 空间数据类型(需要扩展支持,如 GeoAlchemy2) + 'GEOMETRY': 'Geometry', # 需要安装 geoalchemy2 + 'POINT': 'Geometry', + 'LINESTRING': 'Geometry', + 'POLYGON': 'Geometry', + 'MULTIPOINT': 'Geometry', + 'MULTILINESTRING': 'Geometry', + 'MULTIPOLYGON': 'Geometry', + 'GEOMETRYCOLLECTION': 'Geometry', + } + ) + DB_TO_PYTHON_TYPE_MAPPING = ( + { + 'boolean': 'bool', + 'smallint': 'int', + 'integer': 'int', + 'bigint': 'int', + 'real': 'float', + 'double precision': 'float', + 'numeric': 'Decimal', + 'character varying': 'str', + 'character': 'str', + 'text': 'str', + 'bytea': 'bytes', + 'date': 'date', + 'time': 'time', + 'time with time zone': 'time', + 'time without time zone': 'time', + 'timestamp': 'datetime', + 'timestamp with time zone': 'datetime', + 'timestamp without time zone': 'datetime', + 'interval': 'timedelta', + 'json': 'dict', + 'jsonb': 'dict', + 'uuid': 'str', + 'inet': 'str', + 'cidr': 'str', + 'macaddr': 'str', + 'point': 'list', + 'line': 'list', + 'lseg': 'list', + 'box': 'list', + 'path': 'list', + 'polygon': 'list', + 'circle': 'list', + 'bit': 'int', + 'bit varying': 'int', + 'tsvector': 'str', + 'tsquery': 'str', + 'xml': 'str', + 'array': 'list', + 'composite': 'dict', + 'enum': 'str', + 'range': 'list', + 'money': 'Decimal', + 'pg_lsn': 'int', + 'txid_snapshot': 'str', + 'oid': 'int', + 'regproc': 'str', + 'regclass': 'str', + 'regtype': 'str', + 'regrole': 'str', + 'regnamespace': 'str', + 'int2vector': 'list', + 'oidvector': 'list', + 'pg_node_tree': 'str', + } + if DataBaseConfig.db_type == 'postgresql' + else { + # 数值类型 + 'TINYINT': 'int', + 'SMALLINT': 'int', + 'MEDIUMINT': 'int', + 'INT': 'int', + 'INTEGER': 'int', + 'BIGINT': 'int', + 'FLOAT': 'float', + 'DOUBLE': 'float', + 'DECIMAL': 'Decimal', + 'BIT': 'int', + # 日期和时间类型 + 'DATE': 'date', + 'TIME': 'time', + 'DATETIME': 'datetime', + 'TIMESTAMP': 'datetime', + 'YEAR': 'int', + # 字符串类型 + 'CHAR': 'str', + 'VARCHAR': 'str', + 'TINYTEXT': 'str', + 'TEXT': 'str', + 'MEDIUMTEXT': 'str', + 'LONGTEXT': 'str', + 'BINARY': 'bytes', + 'VARBINARY': 'bytes', + 'TINYBLOB': 'bytes', + 'BLOB': 'bytes', + 'MEDIUMBLOB': 'bytes', + 'LONGBLOB': 'bytes', + # 枚举和集合类型 + 'ENUM': 'str', + 'SET': 'str', + # JSON 类型 + 'JSON': 'dict', + # 空间数据类型(通常需要特殊处理) + 'GEOMETRY': 'bytes', + 'POINT': 'bytes', + 'LINESTRING': 'bytes', + 'POLYGON': 'bytes', + 'MULTIPOINT': 'bytes', + 'MULTILINESTRING': 'bytes', + 'MULTIPOLYGON': 'bytes', + 'GEOMETRYCOLLECTION': 'bytes', + } + ) diff --git a/shierfeng-fastapi-backend/common/context.py b/shierfeng-fastapi-backend/common/context.py new file mode 100644 index 0000000..67e933c --- /dev/null +++ b/shierfeng-fastapi-backend/common/context.py @@ -0,0 +1,96 @@ +import re +from contextvars import ContextVar, Token +from typing import Literal + +from exceptions.exception import LoginException +from module_admin.entity.vo.user_vo import CurrentUserModel + +# 定义上下文变量 +# 存储当前请求的编译后的排除路由模式列表 +current_exclude_patterns: ContextVar[ + list[dict[str, str | list[Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']] | re.Pattern]] | None +] = ContextVar('current_exclude_patterns', default=None) +# 存储当前用户信息 +current_user: ContextVar[CurrentUserModel | None] = ContextVar('current_user', default=None) + + +class RequestContext: + """ + 请求上下文管理类,用于设置和清理上下文变量 + """ + + @staticmethod + def set_current_exclude_patterns( + exclude_patterns: list[ + dict[str, str | list[Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']] | re.Pattern] + ], + ) -> Token: + """ + 设置当前请求的编译后的排除路由模式列表 + + :param exclude_patterns: 编译后的排除路由模式列表 + :return: 上下文变量令牌,用于重置 + """ + return current_exclude_patterns.set(exclude_patterns) + + @staticmethod + def get_current_exclude_patterns() -> list[ + dict[str, str | list[Literal['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']] | re.Pattern] + ]: + """ + 获取当前请求的编译后的排除路由模式列表 + + :return: 编译后的排除路由模式列表 + """ + _exclude_patterns = current_exclude_patterns.get() + if _exclude_patterns is None: + _exclude_patterns = [] + return _exclude_patterns + + @staticmethod + def set_current_user(user: CurrentUserModel) -> Token: + """ + 设置当前用户信息 + + :param user: 用户信息 + :return: 上下文变量令牌,用于重置 + """ + return current_user.set(user) + + @staticmethod + def get_current_user() -> CurrentUserModel: + """ + 获取当前用户信息 + + :return: 用户信息 + """ + _current_user = current_user.get() + if _current_user is None: + raise LoginException(data='', message='当前用户信息为空,请检查是否已登录') + return _current_user + + @staticmethod + def reset_current_exclude_patterns(token: Token) -> None: + """ + 重置当前请求的编译后的排除路由模式列表 + + :param token: 设置编译后的排除路由模式列表时返回的令牌 + """ + current_exclude_patterns.reset(token) + + @staticmethod + def reset_current_user(token: Token) -> None: + """ + 重置当前用户信息 + + :param token: 设置用户信息时返回的令牌 + """ + current_user.reset(token) + + @staticmethod + def clear_all() -> None: + """ + 清除所有上下文变量 + """ + current_exclude_patterns.set(None) + current_user.set(None) diff --git a/shierfeng-fastapi-backend/common/enums.py b/shierfeng-fastapi-backend/common/enums.py new file mode 100644 index 0000000..de86877 --- /dev/null +++ b/shierfeng-fastapi-backend/common/enums.py @@ -0,0 +1,79 @@ +from enum import Enum + + +class HttpMethod(str, Enum): + """ + HTTP请求方法枚举 + + GET: 获取资源 + POST: 创建资源 + PUT: 整体更新资源 + DELETE: 删除资源 + PATCH: 局部更新资源 + HEAD: 获取响应头 + OPTIONS: 获取允许的方法信息 + TRACE: 回显诊断请求 + CONNECT: 建立隧道连接 + """ + + GET = 'GET' + POST = 'POST' + PUT = 'PUT' + DELETE = 'DELETE' + PATCH = 'PATCH' + HEAD = 'HEAD' + OPTIONS = 'OPTIONS' + TRACE = 'TRACE' + CONNECT = 'CONNECT' + + +class BusinessType(Enum): + """ + 业务操作类型 + + OTHER: 其它 + INSERT: 新增 + UPDATE: 修改 + DELETE: 删除 + GRANT: 授权 + EXPORT: 导出 + IMPORT: 导入 + FORCE: 强退 + GENCODE: 生成代码 + CLEAN: 清空数据 + """ + + OTHER = 0 + INSERT = 1 + UPDATE = 2 + DELETE = 3 + GRANT = 4 + EXPORT = 5 + IMPORT = 6 + FORCE = 7 + GENCODE = 8 + CLEAN = 9 + + +class RedisInitKeyConfig(Enum): + """ + 系统内置Redis键名 + """ + + @property + def key(self) -> str | None: + return self.value.get('key') + + @property + def remark(self) -> str | None: + return self.value.get('remark') + + ACCESS_TOKEN = {'key': 'access_token', 'remark': '登录令牌信息'} + SYS_DICT = {'key': 'sys_dict', 'remark': '数据字典'} + SYS_CONFIG = {'key': 'sys_config', 'remark': '配置信息'} + API_CACHE = {'key': 'api_cache', 'remark': '接口响应缓存'} + API_RATE_LIMIT = {'key': 'api_rate_limit', 'remark': '接口限流'} + CAPTCHA_CODES = {'key': 'captcha_codes', 'remark': '图片验证码'} + ACCOUNT_LOCK = {'key': 'account_lock', 'remark': '用户锁定'} + PASSWORD_ERROR_COUNT = {'key': 'password_error_count', 'remark': '密码错误次数'} + SMS_CODE = {'key': 'sms_code', 'remark': '短信验证码'} diff --git a/shierfeng-fastapi-backend/common/router.py b/shierfeng-fastapi-backend/common/router.py new file mode 100644 index 0000000..f7106c5 --- /dev/null +++ b/shierfeng-fastapi-backend/common/router.py @@ -0,0 +1,393 @@ +import glob +import importlib +import os +import sys +from collections.abc import Callable, Sequence +from enum import Enum +from typing import Annotated, Any, Literal + +from annotated_doc import Doc +from fastapi import FastAPI, params +from fastapi.datastructures import Default +from fastapi.routing import APIRoute, APIRouter +from fastapi.utils import generate_unique_id +from starlette.responses import JSONResponse, Response +from starlette.routing import BaseRoute +from starlette.types import ASGIApp, Lifespan +from typing_extensions import deprecated + + +class APIRouterPro(APIRouter): + """ + `APIRouterPro` class, inherited from the `APIRouter` class, it has all the functions of `APIRouter` and provides some additional parameter settings. + `APIRouter` class, used to group *path operations*, for example to structure + an app in multiple files. It would then be included in the `FastAPI` app, or + in another `APIRouter` (ultimately included in the app). + + Read more about it in the + [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/). + + ## Example + + ```python + from common.router import APIRouterPro, FastAPI + + app = FastAPI() + router = APIRouterPro() + + + @router.get('/users/', tags=['users']) + async def read_users(): + return [{'username': 'Rick'}, {'username': 'Morty'}] + + + app.include_router(router) + ``` + """ + + def __init__( # noqa: PLR0913 + self, + *, + prefix: Annotated[str, Doc('An optional path prefix for the router.')] = '', + order_num: Annotated[int, Doc('An optional order number for the router.')] = 100, + auto_register: Annotated[bool, Doc('An optional auto register flag for the router.')] = True, + tags: Annotated[ + list[str | Enum] | None, + Doc( + """ + A list of tags to be applied to all the *path operations* in this + router. + + It will be added to the generated OpenAPI (e.g. visible at `/docs`). + + Read more about it in the + [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). + """ + ), + ] = None, + dependencies: Annotated[ + Sequence[params.Depends] | None, + Doc( + """ + A list of dependencies (using `Depends()`) to be applied to all the + *path operations* in this router. + + Read more about it in the + [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies). + """ + ), + ] = None, + default_response_class: Annotated[ + type[Response], + Doc( + """ + The default response class to be used. + + Read more in the + [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class). + """ + ), + ] = Default(JSONResponse), + responses: Annotated[ + dict[int | str, dict[str, Any]] | None, + Doc( + """ + Additional responses to be shown in OpenAPI. + + It will be added to the generated OpenAPI (e.g. visible at `/docs`). + + Read more about it in the + [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/). + + And in the + [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies). + """ + ), + ] = None, + callbacks: Annotated[ + list[BaseRoute] | None, + Doc( + """ + OpenAPI callbacks that should apply to all *path operations* in this + router. + + It will be added to the generated OpenAPI (e.g. visible at `/docs`). + + Read more about it in the + [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/). + """ + ), + ] = None, + routes: Annotated[ + list[BaseRoute] | None, + Doc( + """ + **Note**: you probably shouldn't use this parameter, it is inherited + from Starlette and supported for compatibility. + + --- + + A list of routes to serve incoming HTTP and WebSocket requests. + """ + ), + deprecated( + """ + You normally wouldn't use this parameter with FastAPI, it is inherited + from Starlette and supported for compatibility. + + In FastAPI, you normally would use the *path operation methods*, + like `router.get()`, `router.post()`, etc. + """ + ), + ] = None, + redirect_slashes: Annotated[ + bool, + Doc( + """ + Whether to detect and redirect slashes in URLs when the client doesn't + use the same format. + """ + ), + ] = True, + default: Annotated[ + ASGIApp | None, + Doc( + """ + Default function handler for this router. Used to handle + 404 Not Found errors. + """ + ), + ] = None, + dependency_overrides_provider: Annotated[ + Any | None, + Doc( + """ + Only used internally by FastAPI to handle dependency overrides. + + You shouldn't need to use it. It normally points to the `FastAPI` app + object. + """ + ), + ] = None, + route_class: Annotated[ + type[APIRoute], + Doc( + """ + Custom route (*path operation*) class to be used by this router. + + Read more about it in the + [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router). + """ + ), + ] = APIRoute, + on_startup: Annotated[ + Sequence[Callable[[], Any]] | None, + Doc( + """ + A list of startup event handler functions. + + You should instead use the `lifespan` handlers. + + Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/). + """ + ), + ] = None, + on_shutdown: Annotated[ + Sequence[Callable[[], Any]] | None, + Doc( + """ + A list of shutdown event handler functions. + + You should instead use the `lifespan` handlers. + + Read more in the + [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/). + """ + ), + ] = None, + # the generic to Lifespan[AppType] is the type of the top level application + # which the router cannot know statically, so we use typing.Any + lifespan: Annotated[ + Lifespan[Any] | None, + Doc( + """ + A `Lifespan` context manager handler. This replaces `startup` and + `shutdown` functions with a single context manager. + + Read more in the + [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/). + """ + ), + ] = None, + deprecated: Annotated[ + bool | None, + Doc( + """ + Mark all *path operations* in this router as deprecated. + + It will be added to the generated OpenAPI (e.g. visible at `/docs`). + + Read more about it in the + [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/). + """ + ), + ] = None, + include_in_schema: Annotated[ + bool, + Doc( + """ + To include (or not) all the *path operations* in this router in the + generated OpenAPI. + + This affects the generated OpenAPI (e.g. visible at `/docs`). + + Read more about it in the + [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi). + """ + ), + ] = True, + generate_unique_id_function: Annotated[ + Callable[[APIRoute], str], + Doc( + """ + Customize the function used to generate unique IDs for the *path + operations* shown in the generated OpenAPI. + + This is particularly useful when automatically generating clients or + SDKs for your API. + + Read more about it in the + [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function). + """ + ), + ] = Default(generate_unique_id), + ) -> None: + self.order_num = order_num + self.auto_register = auto_register + super().__init__( + prefix=prefix, + tags=tags, + dependencies=dependencies, + default_response_class=default_response_class, + responses=responses, + callbacks=callbacks, + routes=routes, + redirect_slashes=redirect_slashes, + default=default, + dependency_overrides_provider=dependency_overrides_provider, + route_class=route_class, + on_startup=on_startup, + on_shutdown=on_shutdown, + lifespan=lifespan, + deprecated=deprecated, + include_in_schema=include_in_schema, + generate_unique_id_function=generate_unique_id_function, + ) + + +class RouterRegister: + """ + 路由注册器,用于自动注册所有controller目录下的路由 + """ + + def __init__(self, app: FastAPI) -> None: + """ + 初始化路由注册器 + + :param app: FastAPI对象 + """ + self.app = app + # 获取项目根目录 + self.project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..')) + sys.path.insert(0, self.project_root) + + def _find_controller_files(self) -> list[str]: + """ + 查找所有controller目录下的py文件 + + :return: py文件路径列表 + """ + pattern = os.path.join(self.project_root, '*', 'controller', '[!_]*.py') + return sorted(glob.glob(pattern)) + + def _import_module_and_get_routers(self, controller_files: list[str]) -> list[tuple[str, APIRouter]]: + """ + 导入模块并获取路由实例 + + :param controller_files: controller目录下的py文件路径列表 + :return: 路由实例列表 + """ + routers = [] + for file_path in controller_files: + # 计算模块路径 + relative_path = os.path.relpath(file_path, self.project_root) + module_name = relative_path.replace(os.sep, '.')[:-3] + + # 动态导入模块 + module = importlib.import_module(module_name) + # 直接遍历模块__dict__,只检查模块自身定义的属性 + for attr_name, attr in module.__dict__.items(): + # 对于APIRouterPro实例,只有当auto_register=True时才添加 + if isinstance(attr, APIRouterPro): + if attr.auto_register: + routers.append((attr_name, attr)) + # 对于APIRouter实例,直接添加 + elif isinstance(attr, APIRouter): + routers.append((attr_name, attr)) + return routers + + def _sort_routers(self, routers: list[tuple[str, APIRouter]]) -> list[tuple[str, APIRouter]]: + """ + 按规则排序路由 + + :param routers: 路由实例列表 + :return: 排序后的路由实例列表 + """ + + # 按规则排序路由 + def sort_key(item: tuple[str, APIRouter]) -> tuple[Literal[0], int, str] | tuple[Literal[1], str]: + attr_name, router = item + # APIRouterPro实例按order_num排序,序号越小越靠前 + if isinstance(router, APIRouterPro): + return (0, router.order_num, attr_name) + # APIRouter实例按变量名首字母排序 + return (1, attr_name) + + return sorted(routers, key=sort_key) + + def _register_routers_to_app(self, routers: list[tuple[str, APIRouter]]) -> None: + """ + 将路由注册到FastAPI应用 + + :param routers: 排序后的路由实例列表 + :return: None + """ + for _attr_name, router in routers: + self.app.include_router(router=router) + + def register_routers(self) -> None: + """ + 自动注册所有controller目录下的路由 + + :return: None + """ + # 查找所有controller目录下的py文件 + controller_files = self._find_controller_files() + # 导入模块并获取路由实例 + routers = self._import_module_and_get_routers(controller_files) + # 按规则排序路由 + sorted_routers = self._sort_routers(routers) + # 注册路由到FastAPI应用 + self._register_routers_to_app(sorted_routers) + + +def auto_register_routers(app: FastAPI) -> None: + """ + 自动注册所有controller目录下的路由 + + :param app: FastAPI对象 + :return: None + """ + # 使用路由注册器进行注册 + router_register = RouterRegister(app) + router_register.register_routers() diff --git a/shierfeng-fastapi-backend/common/vo.py b/shierfeng-fastapi-backend/common/vo.py new file mode 100644 index 0000000..951facd --- /dev/null +++ b/shierfeng-fastapi-backend/common/vo.py @@ -0,0 +1,105 @@ +from datetime import datetime +from typing import Any, Generic, TypeVar + +from pydantic import BaseModel, ConfigDict, Field, create_model +from pydantic.alias_generators import to_camel +from typing_extensions import Self + +from common.constant import HttpStatusConstant + +T = TypeVar('T') + + +class CrudResponseModel(BaseModel): + """ + 操作响应模型 + """ + + is_success: bool = Field(description='操作是否成功') + message: str = Field(description='响应信息') + result: Any | None = Field(default=None, description='响应结果') + + +class ResponseBaseModel(BaseModel): + """ + 响应模型 + """ + + code: int = Field(default=HttpStatusConstant.SUCCESS, description='响应码') + msg: str = Field(default='操作成功', description='响应信息') + success: bool = Field(default=True, description='响应是否成功') + time: datetime = Field(default_factory=datetime.now, description='响应时间') + + +class DynamicResponseModel(ResponseBaseModel, Generic[T]): + """ + 动态响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + def __class_getitem__(cls, item: Any) -> Any | Self: + """ + 当使用 DynamicResponseModel[Item] 语法时,动态创建一个包含所有字段的新模型 + """ + # 检查是否已经为该类型创建了模型 + if not hasattr(cls, '_cached_models'): + cls._cached_models = {} + + if item in cls._cached_models: + return cls._cached_models[item] + + # 检查item是否为Pydantic模型 + if not hasattr(item, 'model_fields'): + raise TypeError(f'{item} 不是一个Pydantic模型,请使用Pydantic模型作为泛型参数') + + # 获取ResponseBaseModel的字段 + base_fields = {} + for field_name, field in cls.model_fields.items(): + base_fields[field_name] = (field.annotation, field) + + # 获取泛型类型的字段 + item_fields = {} + for field_name, field in item.model_fields.items(): + item_fields[field_name] = (field.annotation, field) + + # 合并所有字段 + all_fields = {**base_fields, **item_fields} + + # 动态创建新模型 + new_model = create_model( + f'DynamicResponseModel[{item.__name__}]', __base__=cls, __config__=cls.model_config, **all_fields + ) + + # 缓存模型 + cls._cached_models[item] = new_model + + return new_model + + +class PageModel(BaseModel, Generic[T]): + """ + 分页模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + rows: list[T] = Field(description='记录列表') + page_num: int = Field(description='当前页码') + page_size: int = Field(description='每页记录数') + total: int = Field(description='总记录数') + has_next: bool = Field(description='是否有下一页') + + +class PageResponseModel(PageModel, ResponseBaseModel, Generic[T]): + """ + 分页响应模型 + """ + + +class DataResponseModel(ResponseBaseModel, Generic[T]): + """ + 数据响应模型 + """ + + data: T = Field(description='响应数据') diff --git a/shierfeng-fastapi-backend/config/database.py b/shierfeng-fastapi-backend/config/database.py new file mode 100644 index 0000000..e526b42 --- /dev/null +++ b/shierfeng-fastapi-backend/config/database.py @@ -0,0 +1,109 @@ +from urllib.parse import quote_plus + +from sqlalchemy import Engine, create_engine +from sqlalchemy.ext.asyncio import AsyncAttrs, AsyncEngine, async_sessionmaker, create_async_engine +from sqlalchemy.orm import DeclarativeBase, sessionmaker + +from config.env import DataBaseConfig + + +def build_async_sqlalchemy_database_url() -> str: + """ + 构建异步 SQLAlchemy 数据库连接 URL + + :return: 异步 SQLAlchemy 数据库连接 URL + """ + if DataBaseConfig.db_type == 'postgresql': + return ( + f'postgresql+asyncpg://{DataBaseConfig.db_username}:{quote_plus(DataBaseConfig.db_password)}@' + f'{DataBaseConfig.db_host}:{DataBaseConfig.db_port}/{DataBaseConfig.db_database}' + ) + return ( + f'mysql+asyncmy://{DataBaseConfig.db_username}:{quote_plus(DataBaseConfig.db_password)}@' + f'{DataBaseConfig.db_host}:{DataBaseConfig.db_port}/{DataBaseConfig.db_database}' + ) + + +ASYNC_SQLALCHEMY_DATABASE_URL = build_async_sqlalchemy_database_url() + + +def build_sync_sqlalchemy_database_url() -> str: + """ + 构建同步 SQLAlchemy 数据库连接 URL + + :return: 同步 SQLAlchemy 数据库连接 URL + """ + if DataBaseConfig.db_type == 'postgresql': + return ( + f'postgresql+psycopg2://{DataBaseConfig.db_username}:{quote_plus(DataBaseConfig.db_password)}@' + f'{DataBaseConfig.db_host}:{DataBaseConfig.db_port}/{DataBaseConfig.db_database}' + ) + return ( + f'mysql+pymysql://{DataBaseConfig.db_username}:{quote_plus(DataBaseConfig.db_password)}@' + f'{DataBaseConfig.db_host}:{DataBaseConfig.db_port}/{DataBaseConfig.db_database}' + ) + + +SYNC_SQLALCHEMY_DATABASE_URL = build_sync_sqlalchemy_database_url() + + +def create_async_db_engine(echo: bool | None = None) -> AsyncEngine: + """ + 创建异步 SQLAlchemy Engine + + :param echo: 可选,是否输出 SQLAlchemy SQL 日志 + :return: 异步 SQLAlchemy Engine + """ + return create_async_engine( + ASYNC_SQLALCHEMY_DATABASE_URL, + echo=DataBaseConfig.db_echo if echo is None else echo, + max_overflow=DataBaseConfig.db_max_overflow, + pool_size=DataBaseConfig.db_pool_size, + pool_recycle=DataBaseConfig.db_pool_recycle, + pool_timeout=DataBaseConfig.db_pool_timeout, + ) + + +def create_sync_db_engine(echo: bool | None = None) -> Engine: + """ + 创建同步 SQLAlchemy Engine + + :param echo: 可选,是否输出 SQLAlchemy SQL 日志 + :return: 同步 SQLAlchemy Engine + """ + return create_engine( + SYNC_SQLALCHEMY_DATABASE_URL, + echo=DataBaseConfig.db_echo if echo is None else echo, + max_overflow=DataBaseConfig.db_max_overflow, + pool_size=DataBaseConfig.db_pool_size, + pool_recycle=DataBaseConfig.db_pool_recycle, + pool_timeout=DataBaseConfig.db_pool_timeout, + ) + + +def create_async_session_local(engine: AsyncEngine) -> async_sessionmaker: + """ + 创建异步 Session 工厂 + + :param engine: 异步 SQLAlchemy Engine + :return: 异步 Session 工厂 + """ + return async_sessionmaker(autocommit=False, autoflush=False, bind=engine) + + +def create_sync_session_local(engine: Engine) -> sessionmaker: + """ + 创建同步 Session 工厂 + + :param engine: 同步 SQLAlchemy Engine + :return: 同步 Session 工厂 + """ + return sessionmaker(autocommit=False, autoflush=False, bind=engine) + + +async_engine = create_async_db_engine() +AsyncSessionLocal = create_async_session_local(async_engine) + + +class Base(AsyncAttrs, DeclarativeBase): + pass diff --git a/shierfeng-fastapi-backend/config/env.py b/shierfeng-fastapi-backend/config/env.py new file mode 100644 index 0000000..317013e --- /dev/null +++ b/shierfeng-fastapi-backend/config/env.py @@ -0,0 +1,334 @@ +import argparse +import configparser +import os +import sys +from typing import Literal + +from dotenv import load_dotenv +from pydantic import computed_field +from pydantic_settings import BaseSettings + + +class AppSettings(BaseSettings): + """ + 应用配置 + """ + + app_env: str = 'dev' + app_name: str = 'ShiErFeng-FastAPI' + app_root_path: str = '/dev-api' + app_host: str = '0.0.0.0' + app_port: int = 9099 + app_version: str = '1.0.0' + app_reload: bool = True + app_workers: int = 1 + app_ip_location_query: bool = True + app_same_time_login: bool = True + app_demo_mode: bool = False + app_disable_swagger: bool = False + app_disable_redoc: bool = False + app_trusted_proxy_ips: str = '127.0.0.1,::1' + app_trusted_proxy_hops: int = 1 + + +class JwtSettings(BaseSettings): + """ + Jwt配置 + """ + + jwt_secret_key: str = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55' + jwt_algorithm: str = 'HS256' + jwt_expire_minutes: int = 1440 + jwt_redis_expire_minutes: int = 30 + + +class DataBaseSettings(BaseSettings): + """ + 数据库配置 + """ + + db_type: Literal['mysql', 'postgresql'] = 'mysql' + db_host: str = '127.0.0.1' + db_port: int = 3306 + db_username: str = 'root' + db_password: str = 'mysqlroot' + db_database: str = 'shierfeng-fastapi' + db_echo: bool = True + db_max_overflow: int = 10 + db_pool_size: int = 50 + db_pool_recycle: int = 3600 + db_pool_timeout: int = 30 + + @computed_field + @property + def sqlglot_parse_dialect(self) -> str: + if self.db_type == 'postgresql': + return 'postgres' + return self.db_type + + +class RedisSettings(BaseSettings): + """ + Redis配置 + """ + + redis_host: str = '127.0.0.1' + redis_port: int = 6379 + redis_username: str = '' + redis_password: str = '' + redis_database: int = 2 + + +class LogSettings(BaseSettings): + """ + 日志与队列配置 + """ + + log_mask_enabled: bool = True + log_mask_placeholder: str = '******' + log_mask_fields: str = ( + 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,' + 'authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,' + 'sms_code,captcha_code,system_prompt' + ) + log_partial_mask_fields: str = 'phonenumber,phone,mobile,email' + log_config_secret_patterns: str = 'password,token,secret,key,private,credential,access,jwt,captcha,sms' + log_stream_key: str = 'log:stream' + log_stream_group: str = 'log_aggregator' + log_stream_consumer_prefix: str = 'worker' + log_stream_batch_size: int = 100 + log_stream_block_ms: int = 2000 + log_stream_maxlen: int = 100000 + log_stream_claim_idle_ms: int = 60000 + log_stream_claim_interval_ms: int = 5000 + log_stream_claim_batch_size: int = 100 + log_stream_dedup_ttl: int = 3600 + log_stream_dedup_prefix: str = 'log:dedup' + + loguru_json: bool = False + loguru_level: str = 'INFO' + loguru_stdout: bool = True + log_file_enabled: bool = True + log_file_base_dir: str = 'logs' + loguru_rotation: str = '50MB' + loguru_retention: str = '30 days' + loguru_compression: str = 'zip' + log_instance_id: str = 'prod' + log_service_name: str = 'shierfeng-fastapi-backend' + log_worker_id: str = 'auto' + + +class TransportCryptoSettings(BaseSettings): + """ + 传输层加解密配置 + """ + + transport_crypto_enabled: bool = True + transport_crypto_mode: Literal['off', 'optional', 'required'] = 'optional' + transport_crypto_algorithm: str = 'RSA_OAEP_AES_256_GCM' + transport_crypto_kid: str = 'default' + transport_crypto_public_key: str = '' + transport_crypto_private_key: str = '' + transport_crypto_legacy_key_pairs: str = '[]' + transport_crypto_rsa_key_size: int = 2048 + transport_crypto_public_key_ttl_seconds: int = 3600 + transport_crypto_frontend_config_ttl_seconds: int = 300 + transport_crypto_max_get_url_length: int = 4096 + transport_crypto_clock_skew_seconds: int = 120 + transport_crypto_replay_ttl_seconds: int = 300 + transport_crypto_enabled_paths: str = '' + transport_crypto_required_paths: str = '' + transport_crypto_exclude_paths: str = ( + '/openapi.json,/docs,/docs/oauth2-redirect,/redoc,' + '/transport/crypto/frontend-config,/transport/crypto/public-key,/common/download,/common/download/resource' + ) + + +class GenSettings: + """ + 代码生成配置 + """ + + author = 'insistence' + package_name = 'module_admin.system' + auto_remove_pre = False + table_prefix = 'sys_' + allow_overwrite = False + + GEN_PATH = 'vf_admin/gen_path' + + def __init__(self) -> None: + if not os.path.exists(self.GEN_PATH): + os.makedirs(self.GEN_PATH) + + +class UploadSettings: + """ + 上传配置 + """ + + UPLOAD_PREFIX = '/profile' + UPLOAD_PATH = 'vf_admin/upload_path' + UPLOAD_MACHINE = 'A' + DEFAULT_ALLOWED_EXTENSION = [ + # 图片 + 'bmp', + 'gif', + 'jpg', + 'jpeg', + 'png', + # word excel powerpoint + 'doc', + 'docx', + 'xls', + 'xlsx', + 'ppt', + 'pptx', + 'html', + 'htm', + 'txt', + # 压缩文件 + 'rar', + 'zip', + 'gz', + 'bz2', + # 视频格式 + 'mp4', + 'avi', + 'rmvb', + # pdf + 'pdf', + ] + DOWNLOAD_PATH = 'vf_admin/download_path' + + def __init__(self) -> None: + if not os.path.exists(self.UPLOAD_PATH): + os.makedirs(self.UPLOAD_PATH) + if not os.path.exists(self.DOWNLOAD_PATH): + os.makedirs(self.DOWNLOAD_PATH) + + +class CachePathConfig: + """ + 缓存目录配置 + """ + + PATH = os.path.join(os.path.abspath(os.getcwd()), 'caches') + PATHSTR = 'caches' + + +class GetConfig: + """ + 获取配置 + """ + + def __init__(self) -> None: + self.parse_cli_args() + + def get_app_config(self) -> AppSettings: + """ + 获取应用配置 + """ + # 实例化应用配置模型 + return AppSettings() + + def get_jwt_config(self) -> JwtSettings: + """ + 获取Jwt配置 + """ + # 实例化Jwt配置模型 + return JwtSettings() + + def get_database_config(self) -> DataBaseSettings: + """ + 获取数据库配置 + """ + # 实例化数据库配置模型 + return DataBaseSettings() + + def get_redis_config(self) -> RedisSettings: + """ + 获取Redis配置 + """ + # 实例化Redis配置模型 + return RedisSettings() + + def get_log_config(self) -> LogSettings: + """ + 获取日志配置 + """ + return LogSettings() + + def get_transport_crypto_config(self) -> TransportCryptoSettings: + """ + 获取传输层加解密配置 + """ + return TransportCryptoSettings() + + def get_gen_config(self) -> GenSettings: + """ + 获取代码生成配置 + """ + # 实例化代码生成配置 + return GenSettings() + + def get_upload_config(self) -> UploadSettings: + """ + 获取上传配置 + """ + # 实例上传配置 + return UploadSettings() + + @staticmethod + def parse_cli_args() -> None: + """ + 解析命令行参数 + """ + # 检查是否在alembic环境中运行,如果是则跳过参数解析 + if 'alembic' in sys.argv[0] or any('alembic' in arg for arg in sys.argv): + ini_config = configparser.ConfigParser() + ini_config.read('alembic.ini', encoding='utf-8') + if 'settings' in ini_config: + # 获取env选项 + env_value = ini_config['settings'].get('env') + os.environ['APP_ENV'] = env_value if env_value else 'dev' + elif 'uvicorn' in sys.argv[0]: + # 使用uvicorn启动时,命令行参数需要按照uvicorn的文档进行配置,无法自定义参数 + pass + else: + # 使用argparse定义命令行参数 + parser = argparse.ArgumentParser(description='命令行参数') + parser.add_argument('--env', type=str, default='', help='运行环境') + # 解析命令行参数 + args, _ = parser.parse_known_args() + # 设置环境变量,如果未设置命令行参数,默认APP_ENV为dev + os.environ['APP_ENV'] = args.env if args.env else 'dev' + # 读取运行环境 + run_env = os.environ.get('APP_ENV', '') + # 运行环境未指定时默认加载.env.dev + env_file = '.env.dev' + # 运行环境不为空时按命令行参数加载对应.env文件 + if run_env != '': + env_file = f'.env.{run_env}' + # 加载配置 + load_dotenv(env_file) + + +# 实例化获取配置类 +get_config = GetConfig() +# 应用配置 +AppConfig = get_config.get_app_config() +# Jwt配置 +JwtConfig = get_config.get_jwt_config() +# 数据库配置 +DataBaseConfig = get_config.get_database_config() +# Redis配置 +RedisConfig = get_config.get_redis_config() +# 日志配置 +LogConfig = get_config.get_log_config() +# 传输层加解密配置 +TransportCryptoConfig = get_config.get_transport_crypto_config() +# 代码生成配置 +GenConfig = get_config.get_gen_config() +# 上传配置 +UploadConfig = get_config.get_upload_config() diff --git a/shierfeng-fastapi-backend/config/get_db.py b/shierfeng-fastapi-backend/config/get_db.py new file mode 100644 index 0000000..43f838a --- /dev/null +++ b/shierfeng-fastapi-backend/config/get_db.py @@ -0,0 +1,37 @@ +from collections.abc import AsyncGenerator + +from sqlalchemy.ext.asyncio import AsyncSession + +from config.database import AsyncSessionLocal, Base, async_engine +from utils.log_util import logger + + +async def get_db() -> AsyncGenerator[AsyncSession, None]: + """ + 每一个请求处理完毕后会关闭当前连接,不同的请求使用不同的连接 + + :return: + """ + async with AsyncSessionLocal() as current_db: + yield current_db + + +async def init_create_table() -> None: + """ + 应用启动时初始化数据库连接 + + :return: + """ + logger.info('🔎 初始化数据库连接...') + async with async_engine.begin() as conn: + await conn.run_sync(Base.metadata.create_all) + logger.info('✅️ 数据库连接成功') + + +async def close_async_engine() -> None: + """ + 应用关闭时释放数据库连接池 + + :return: + """ + await async_engine.dispose() diff --git a/shierfeng-fastapi-backend/config/get_redis.py b/shierfeng-fastapi-backend/config/get_redis.py new file mode 100644 index 0000000..559c677 --- /dev/null +++ b/shierfeng-fastapi-backend/config/get_redis.py @@ -0,0 +1,107 @@ +from fastapi import FastAPI +from redis import asyncio as aioredis +from redis.exceptions import AuthenticationError, RedisError +from redis.exceptions import TimeoutError as RedisTimeoutError + +from config.database import AsyncSessionLocal +from config.env import RedisConfig +from module_admin.service.config_service import ConfigService +from module_admin.service.dict_service import DictDataService +from utils.log_util import logger + + +class RedisUtil: + """ + Redis相关方法 + """ + + @classmethod + async def create_redis_pool(cls, log_enabled: bool = True, log_start_enabled: bool | None = None) -> aioredis.Redis: + """ + 应用启动时初始化redis连接 + + :param log_enabled: 是否输出日志 + :param log_start_enabled: 是否输出开始连接日志 + :return: Redis连接对象 + """ + redis = await aioredis.from_url( + url=f'redis://{RedisConfig.redis_host}', + port=RedisConfig.redis_port, + username=RedisConfig.redis_username, + password=RedisConfig.redis_password, + db=RedisConfig.redis_database, + encoding='utf-8', + decode_responses=True, + ) + if log_start_enabled is None: + log_start_enabled = log_enabled + if log_enabled or log_start_enabled: + await cls.check_redis_connection(redis, log_enabled=log_enabled, log_start_enabled=log_start_enabled) + return redis + + @classmethod + async def check_redis_connection( + cls, redis: aioredis.Redis, log_enabled: bool = True, log_start_enabled: bool | None = None + ) -> None: + """ + 检查redis连接状态 + + :param redis: redis对象 + :param log_enabled: 是否输出日志 + :param log_start_enabled: 是否输出开始连接日志 + :return: None + """ + if log_start_enabled is None: + log_start_enabled = log_enabled + if log_start_enabled: + logger.info('🔎 开始连接redis...') + try: + connection = await redis.ping() + if not log_enabled: + return + if connection: + logger.info('✅️ redis连接成功') + else: + logger.error('❌️ redis连接失败') + except AuthenticationError as e: + if log_enabled: + logger.error(f'❌️ redis用户名或密码错误,详细错误信息:{e}') + except RedisTimeoutError as e: + if log_enabled: + logger.error(f'❌️ redis连接超时,详细错误信息:{e}') + except RedisError as e: + if log_enabled: + logger.error(f'❌️ redis连接错误,详细错误信息:{e}') + + @classmethod + async def close_redis_pool(cls, app: FastAPI) -> None: + """ + 应用关闭时关闭redis连接 + + :param app: fastapi对象 + :return: + """ + await app.state.redis.close() + logger.info('✅️ 关闭redis连接成功') + + @classmethod + async def init_sys_dict(cls, redis: FastAPI) -> None: + """ + 应用启动时缓存字典表 + + :param redis: redis对象 + :return: + """ + async with AsyncSessionLocal() as session: + await DictDataService.init_cache_sys_dict_services(session, redis) + + @classmethod + async def init_sys_config(cls, redis: aioredis.Redis) -> None: + """ + 应用启动时缓存参数配置表 + + :param redis: redis对象 + :return: + """ + async with AsyncSessionLocal() as session: + await ConfigService.init_cache_sys_config_services(session, redis) diff --git a/shierfeng-fastapi-backend/config/get_scheduler.py b/shierfeng-fastapi-backend/config/get_scheduler.py new file mode 100644 index 0000000..a60f31c --- /dev/null +++ b/shierfeng-fastapi-backend/config/get_scheduler.py @@ -0,0 +1,940 @@ +import asyncio +import importlib +import json +from asyncio import iscoroutinefunction +from collections.abc import Callable +from datetime import datetime, timedelta +from typing import Any + +from apscheduler.events import EVENT_ALL, SchedulerEvent +from apscheduler.executors.asyncio import AsyncIOExecutor +from apscheduler.executors.pool import ProcessPoolExecutor +from apscheduler.job import Job +from apscheduler.jobstores.memory import MemoryJobStore +from apscheduler.jobstores.redis import RedisJobStore +from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore +from apscheduler.schedulers.asyncio import AsyncIOScheduler +from apscheduler.triggers.combining import OrTrigger +from apscheduler.triggers.cron import CronTrigger +from apscheduler.triggers.date import DateTrigger +from redis import asyncio as aioredis +from sqlalchemy.engine import Engine +from sqlalchemy.ext.asyncio import AsyncEngine + +import module_task # noqa: F401 +from common.constant import LockConstant +from config.database import ( + SYNC_SQLALCHEMY_DATABASE_URL, + create_async_db_engine, + create_async_session_local, + create_sync_db_engine, + create_sync_session_local, +) +from config.env import AppConfig, LogConfig, RedisConfig +from module_admin.dao.job_dao import JobDao +from module_admin.entity.vo.job_vo import JobLogModel, JobModel +from module_admin.service.job_log_service import JobLogService +from utils.log_util import logger +from utils.server_util import StartupUtil, WorkerIdUtil + + +# 重写Cron定时 +class MyCronTrigger(CronTrigger): + CRON_EXPRESSION_LENGTH_MIN = 6 + CRON_EXPRESSION_LENGTH_MAX = 7 + WEEKDAY_COUNT = 5 + + @classmethod + def from_crontab(cls, expr: str, timezone: str | None = None) -> 'MyCronTrigger': + values = expr.split() + if len(values) != cls.CRON_EXPRESSION_LENGTH_MIN and len(values) != cls.CRON_EXPRESSION_LENGTH_MAX: + raise ValueError(f'Wrong number of fields; got {len(values)}, expected 6 or 7') + + second = values[0] + minute = values[1] + hour = values[2] + if '?' in values[3]: + day = None + elif 'L' in values[5]: + day = f'last {values[5].replace("L", "")}' + elif 'W' in values[3]: + day = cls.__find_recent_workday(int(values[3].split('W')[0])) + else: + day = values[3].replace('L', 'last') + month = values[4] + if '?' in values[5] or 'L' in values[5]: + week = None + elif '#' in values[5]: + week = int(values[5].split('#')[1]) + else: + week = values[5] + day_of_week = int(values[5].split('#')[0]) - 1 if '#' in values[5] else None + year = values[6] if len(values) == cls.CRON_EXPRESSION_LENGTH_MAX else None + return cls( + second=second, + minute=minute, + hour=hour, + day=day, + month=month, + week=week, + day_of_week=day_of_week, + year=year, + timezone=timezone, + ) + + @classmethod + def __find_recent_workday(cls, day: int) -> int: + now = datetime.now() + date = datetime(now.year, now.month, day) + if date.weekday() < cls.WEEKDAY_COUNT: + return date.day + diff = 1 + while True: + previous_day = date - timedelta(days=diff) + if previous_day.weekday() < cls.WEEKDAY_COUNT: + return previous_day.day + diff += 1 + + +redis_config = { + 'host': RedisConfig.redis_host, + 'port': RedisConfig.redis_port, + 'username': RedisConfig.redis_username, + 'password': RedisConfig.redis_password, + 'db': RedisConfig.redis_database, +} +job_defaults = {'coalesce': False, 'max_instance': 1} +scheduler = AsyncIOScheduler() + + +class SchedulerUtil: + """ + 定时任务相关方法 + """ + + # 分布式锁相关类变量 + _is_leader: bool = False + _worker_id: str = WorkerIdUtil.get_worker_id(LogConfig.log_worker_id) + _redis: aioredis.Redis | None = None + _job_update_time_cache: dict[str, datetime] = {} + _sync_channel: str = 'scheduler:sync:request' + _sync_listener_task: asyncio.Task | None = None + _lock_lost_task: asyncio.Task | None = None + _sync_task: asyncio.Task | None = None + _sync_pending: bool = False + _sync_lock: asyncio.Lock = asyncio.Lock() + _last_sync_at: datetime | None = None + _sync_debounce_seconds: float = 0.5 + _sync_min_interval_seconds: float = 2.0 + _reacquire_task: asyncio.Task | None = None + _reacquire_interval_seconds: float = 5.0 + _sync_async_engine: AsyncEngine | None = None + _sync_async_sessionmaker: Any | None = None + _disposed_sync_engines: bool = False + + # 懒加载的同步 Engine 和 SessionLocal + _jobstore_engine: Engine | None = None + _listener_engine: Engine | None = None + _session_local: Any | None = None + _scheduler_configured: bool = False + + @classmethod + def _get_jobstore_engine(cls) -> Engine: + """ + 懒加载获取 jobstore 使用的同步 Engine + + :return: 同步 Engine + """ + if cls._jobstore_engine is None: + cls._jobstore_engine = create_sync_db_engine(echo=False) + return cls._jobstore_engine + + @classmethod + def _get_listener_engine(cls) -> Engine: + """ + 懒加载获取 listener 使用的同步 Engine + + :return: 同步 Engine + """ + if cls._listener_engine is None: + cls._listener_engine = create_sync_db_engine() + return cls._listener_engine + + @classmethod + def _get_session_local(cls) -> Any: + """ + 懒加载获取同步 SessionLocal + + :return: SessionLocal + """ + if cls._session_local is None: + cls._session_local = create_sync_session_local(cls._get_listener_engine()) + return cls._session_local + + @classmethod + def _configure_scheduler(cls) -> None: + """ + 配置 scheduler(懒加载 jobstore) + + :return: None + """ + if cls._scheduler_configured: + return + job_stores = { + 'default': MemoryJobStore(), + 'sqlalchemy': SQLAlchemyJobStore(url=SYNC_SQLALCHEMY_DATABASE_URL, engine=cls._get_jobstore_engine()), + 'redis': RedisJobStore(**redis_config), + } + executors = {'default': AsyncIOExecutor(), 'processpool': ProcessPoolExecutor(5)} + scheduler.configure(jobstores=job_stores, executors=executors, job_defaults=job_defaults) + cls._scheduler_configured = True + + @classmethod + def _should_enable_scheduler_sync(cls) -> bool: + """ + 判断是否需要启用多 worker 的任务状态同步机制 + + :return: 是否开启定时同步与监听 + """ + return not AppConfig.app_reload and AppConfig.app_workers > 1 + + @classmethod + async def init_system_scheduler(cls, redis: aioredis.Redis) -> None: + """ + 应用启动时初始化定时任务(使用分布式锁确保只有一个worker启动scheduler) + + :param redis: Redis连接对象 + :return: + """ + cls._redis = redis + logger.info(f'🔎 Worker {cls._worker_id} 尝试获取 Application 锁...') + + acquired = await StartupUtil.acquire_startup_log_gate( + redis=redis, + lock_key=LockConstant.APP_STARTUP_LOCK_KEY, + worker_id=cls._worker_id, + lock_expire_seconds=LockConstant.LOCK_EXPIRE_SECONDS, + ) + + if acquired: + await cls._start_scheduler_as_leader(redis) + else: + cls._is_leader = False + logger.info(f'⏸️ Worker {cls._worker_id} 未持有 Application 锁,跳过 Scheduler 启动') + + @classmethod + async def _start_scheduler_as_leader(cls, redis: aioredis.Redis) -> None: + """ + 以 Leader 身份启动 Scheduler(内部方法,调用前需确保已持有锁) + + :param redis: Redis连接对象 + :return: None + """ + cls._is_leader = True + cls._disposed_sync_engines = False + logger.info(f'🎯 Worker {cls._worker_id} 持有 Application 锁,开始启动定时任务...') + # 懒加载配置 scheduler + cls._configure_scheduler() + scheduler.start() + + # 加载数据库中的定时任务 + async with cls._get_sync_async_session() as session: + job_list = await JobDao.get_job_list_for_scheduler(session) + for item in job_list: + cls._add_job_to_scheduler(item) + + # 添加事件监听器 + scheduler.add_listener(cls.scheduler_event_listener, EVENT_ALL) + + if cls._should_enable_scheduler_sync(): + # 添加任务状态同步任务(每30秒从数据库同步一次任务状态) + scheduler.add_job( + func=cls.request_scheduler_sync, + trigger='interval', + seconds=30, + id='_scheduler_job_sync', + name='Scheduler任务同步', + replace_existing=True, + ) + cls._sync_listener_task = asyncio.create_task(cls._listen_sync_channel(redis)) + + logger.info('✅️ 系统初始定时任务加载成功') + + @classmethod + def on_lock_lost(cls) -> None: + """ + 锁丢失处理入口 + + :return: None + """ + if not cls._is_leader: + return + cls._is_leader = False + logger.warning(f'⚠️ Worker {cls._worker_id} 失去 Application 锁') + if cls._lock_lost_task: + cls._lock_lost_task.cancel() + cls._lock_lost_task = asyncio.create_task(cls._handle_lock_lost()) + + @classmethod + async def _handle_lock_lost(cls) -> None: + """ + 处理锁丢失后的资源释放 + + :return: None + """ + if cls._sync_listener_task: + cls._sync_listener_task.cancel() + try: + await cls._sync_listener_task + except asyncio.CancelledError: + pass + cls._sync_listener_task = None + if cls._sync_task: + cls._sync_task.cancel() + try: + await cls._sync_task + except asyncio.CancelledError: + pass + cls._sync_task = None + cls._sync_pending = False + if getattr(scheduler, 'running', False): + scheduler.shutdown() + await cls._dispose_sync_async_engine() + cls._dispose_sync_engines() + cls._ensure_reacquire_task() + + @classmethod + async def _sync_jobs_from_database(cls) -> None: + """ + 从数据库同步任务状态,确保多worker环境下任务状态一致 + """ + if not cls._is_leader: + return + + try: + async with cls._get_sync_async_session() as session: + db_jobs_all = await JobDao.get_all_job_list_for_scheduler(session) + db_jobs_enabled = [job for job in db_jobs_all if job.status == '0'] + db_enabled_ids = {str(job.job_id) for job in db_jobs_enabled} + db_job_map = {str(job.job_id): job for job in db_jobs_enabled} + db_job_update_time_map = { + str(job.job_id): job.update_time for job in db_jobs_enabled if job.update_time is not None + } + scheduler_jobs = scheduler.get_jobs() + scheduler_job_map = {job.id: job for job in scheduler_jobs if not job.id.startswith('_')} + scheduler_job_ids = set(scheduler_job_map.keys()) + + jobs_to_remove = scheduler_job_ids - db_enabled_ids + for job_id in jobs_to_remove: + scheduler.remove_job(job_id=job_id) + logger.info(f'🗑️ 同步移除任务: {job_id}') + cls._refresh_job_update_cache(job_id, None) + + jobs_to_add = db_enabled_ids - scheduler_job_ids + for job_id in jobs_to_add: + job_info = db_job_map.get(job_id) + if job_info: + cls._add_job_to_scheduler(job_info) + logger.info(f'➕ 同步添加任务: {job_info.job_name}') + cls._refresh_job_update_cache(job_id, job_info.update_time) + + jobs_to_update = db_enabled_ids & scheduler_job_ids + for job_id in jobs_to_update: + job_info = db_job_map.get(job_id) + scheduler_job = scheduler_job_map.get(job_id) + job_update_time = db_job_update_time_map.get(job_id) + cls._sync_update_job(job_id, job_info, scheduler_job, job_update_time) + + except Exception as e: + logger.error(f'❌ 任务同步异常: {e}') + + @classmethod + def _is_job_config_in_sync(cls, scheduler_job: Job, job_info: JobModel) -> bool: + """ + 判断任务配置是否一致 + + :param scheduler_job: 调度器任务对象 + :param job_info: 数据库任务对象 + :return: 是否一致 + """ + job_state = scheduler_job.__getstate__() + job_kwargs = json.loads(job_info.job_kwargs) if job_info.job_kwargs else None + job_args = job_info.job_args.split(',') if job_info.job_args else None + job_executor = job_info.job_executor + if iscoroutinefunction(cls._import_function(job_info.invoke_target)): + job_executor = 'default' + expected = { + 'name': job_info.job_name, + 'executor': job_executor, + 'jobstore': job_info.job_group, + 'misfire_grace_time': 1000000000000 if job_info.misfire_policy == '3' else None, + 'coalesce': job_info.misfire_policy == '2', + 'max_instances': 3 if job_info.concurrent == '0' else 1, + 'trigger': str(MyCronTrigger.from_crontab(job_info.cron_expression)), + 'args': tuple(job_args) if job_args else None, + 'kwargs': job_kwargs if job_kwargs else None, + 'func': str(cls._import_function(job_info.invoke_target)), + } + current = { + 'name': job_state.get('name'), + 'executor': job_state.get('executor'), + 'jobstore': scheduler_job._jobstore_alias, + 'misfire_grace_time': job_state.get('misfire_grace_time'), + 'coalesce': job_state.get('coalesce'), + 'max_instances': job_state.get('max_instances'), + 'trigger': str(job_state.get('trigger')), + 'args': job_state.get('args'), + 'kwargs': job_state.get('kwargs'), + 'func': str(job_state.get('func')), + } + return expected == current + + @classmethod + def _sync_update_job( + cls, job_id: str, job_info: JobModel | None, scheduler_job: Job | None, job_update_time: datetime | None + ) -> None: + """ + 同步更新任务配置 + + :param job_id: 任务ID + :param job_info: 数据库任务对象 + :param scheduler_job: 调度器任务对象 + :param job_update_time: 任务更新时间 + :return: None + """ + if not job_info or not scheduler_job: + return + if cls._should_skip_job_update(job_id, job_update_time): + return + if not cls._is_job_config_in_sync(scheduler_job, job_info): + scheduler.remove_job(job_id=job_id) + cls._add_job_to_scheduler(job_info) + logger.info(f'♻️ 同步更新任务: {job_info.job_name}') + cls._refresh_job_update_cache(job_id, job_update_time) + + @classmethod + def _should_skip_job_update(cls, job_id: str, job_update_time: datetime | None) -> bool: + """ + 判断是否跳过同步更新 + + :param job_id: 任务ID + :param job_update_time: 任务更新时间 + :return: 是否跳过 + """ + if job_update_time is None: + return False + return cls._job_update_time_cache.get(job_id) == job_update_time + + @classmethod + def _refresh_job_update_cache(cls, job_id: str, job_update_time: datetime | None) -> None: + """ + 刷新任务更新时间缓存 + + :param job_id: 任务ID + :param job_update_time: 任务更新时间 + :return: None + """ + if job_update_time is not None: + cls._job_update_time_cache[job_id] = job_update_time + else: + cls._job_update_time_cache.pop(job_id, None) + + @classmethod + async def request_scheduler_sync(cls) -> None: + """ + 请求调度器同步任务状态 + + :return: None + """ + if cls._is_leader: + cls._sync_pending = True + cls._ensure_sync_task() + return + if cls._redis: + await cls._redis.publish(cls._sync_channel, cls._worker_id) + + @classmethod + def _ensure_sync_task(cls) -> None: + """ + 启动同步调度任务 + + :return: None + """ + if cls._sync_task and not cls._sync_task.done(): + return + cls._sync_task = asyncio.create_task(cls._run_sync_loop()) + + @classmethod + def _get_sync_async_session(cls) -> Any: + """ + 获取同步任务使用的异步 Session + + :return: 异步 Session + """ + if not cls._sync_async_sessionmaker: + cls._sync_async_engine = create_async_db_engine(echo=False) + cls._sync_async_sessionmaker = create_async_session_local(cls._sync_async_engine) + return cls._sync_async_sessionmaker() + + @classmethod + async def _dispose_sync_async_engine(cls) -> None: + """ + 释放同步任务使用的异步 Engine + + :return: None + """ + if cls._sync_async_engine: + await cls._sync_async_engine.dispose() + cls._sync_async_engine = None + cls._sync_async_sessionmaker = None + + @classmethod + def _dispose_sync_engines(cls) -> None: + """ + 释放 Scheduler 使用的同步 Engine + + :return: None + """ + if cls._disposed_sync_engines: + return + if cls._jobstore_engine: + cls._jobstore_engine.dispose() + cls._jobstore_engine = None + if cls._listener_engine: + cls._listener_engine.dispose() + cls._listener_engine = None + cls._session_local = None + cls._disposed_sync_engines = True + + @classmethod + def _ensure_reacquire_task(cls) -> None: + """ + 启动锁重新竞争任务 + + :return: None + """ + if not cls._redis: + return + if cls._reacquire_task and not cls._reacquire_task.done(): + return + cls._reacquire_task = asyncio.create_task(cls._run_reacquire_loop()) + + @classmethod + async def _run_reacquire_loop(cls) -> None: + """ + 循环尝试重新获取锁并恢复调度器 + + :return: None + """ + try: + while not cls._is_leader: + if not cls._redis: + await asyncio.sleep(cls._reacquire_interval_seconds) + continue + acquired = await StartupUtil.acquire_startup_log_gate( + redis=cls._redis, + lock_key=LockConstant.APP_STARTUP_LOCK_KEY, + worker_id=cls._worker_id, + lock_expire_seconds=LockConstant.LOCK_EXPIRE_SECONDS, + ) + if acquired: + # 直接调用 _start_scheduler_as_leader,避免重复获取锁 + await cls._start_scheduler_as_leader(cls._redis) + return + await asyncio.sleep(cls._reacquire_interval_seconds) + except asyncio.CancelledError: + raise + finally: + cls._reacquire_task = None + + @classmethod + async def _run_sync_loop(cls) -> None: + """ + 执行同步调度循环 + + :return: None + """ + try: + while True: + if not cls._sync_pending: + break + cls._sync_pending = False + await asyncio.sleep(cls._sync_debounce_seconds) + await cls._sync_with_throttle() + except asyncio.CancelledError: + raise + finally: + cls._sync_task = None + + @classmethod + async def _sync_with_throttle(cls) -> None: + """ + 按节流规则执行同步 + + :return: None + """ + async with cls._sync_lock: + if not cls._is_leader: + return + if cls._last_sync_at: + elapsed = datetime.now() - cls._last_sync_at + min_interval = timedelta(seconds=cls._sync_min_interval_seconds) + if elapsed < min_interval: + await asyncio.sleep((min_interval - elapsed).total_seconds()) + await cls._sync_jobs_from_database() + cls._last_sync_at = datetime.now() + + @classmethod + async def _listen_sync_channel(cls, redis: aioredis.Redis) -> None: + """ + 监听同步请求通道 + + :param redis: Redis连接对象 + :return: None + """ + while True: + pubsub = redis.pubsub() + try: + await pubsub.subscribe(cls._sync_channel) + async for message in pubsub.listen(): + if not cls._is_leader: + continue + if message.get('type') != 'message': + continue + await cls.request_scheduler_sync() + except asyncio.CancelledError: + await pubsub.unsubscribe(cls._sync_channel) + await pubsub.close() + raise + except Exception as e: + logger.error(f'❌ Scheduler 同步监听异常: {e},5秒后重试...') + await pubsub.close() + await asyncio.sleep(5) + finally: + try: + await pubsub.close() + except Exception: + pass + + @classmethod + async def _execute_async_job_with_log( + cls, job_func: Callable[..., Any], job_info: JobModel, args: list, kwargs: dict + ) -> None: + """ + 执行异步任务并记录日志 + + :param job_func: 任务函数 + :param job_info: 任务对象信息 + :param args: 位置参数 + :param kwargs: 关键字参数 + :return: None + """ + status = '0' + exception_info = '' + job_executor = job_info.job_executor + if iscoroutinefunction(job_func): + job_executor = 'default' + try: + await job_func(*args, **kwargs) + except Exception as e: + status = '1' + exception_info = str(e) + logger.error(f'❌ 异步执行任务 {job_info.job_name} 失败: {e}') + finally: + cls._record_job_execution_log(job_info, job_executor, status, exception_info) + + @classmethod + def _record_job_execution_log(cls, job_info: JobModel, job_executor: str, status: str, exception_info: str) -> None: + """ + 记录任务执行日志(用于非 Leader Worker 直接执行任务时) + + :param job_info: 任务对象信息 + :param job_executor: 任务执行器 + :param status: 执行状态 0-成功 1-失败 + :param exception_info: 异常信息 + :return: None + """ + try: + job_args = job_info.job_args if job_info.job_args else '' + job_kwargs = job_info.job_kwargs if job_info.job_kwargs else '{}' + job_trigger = str(MyCronTrigger.from_crontab(job_info.cron_expression)) if job_info.cron_expression else '' + job_message = ( + f'事件类型: DirectExecution(非Leader), 任务ID: {job_info.job_id}, ' + f'任务名称: {job_info.job_name}, 执行于{datetime.now().strftime("%Y-%m-%d %H:%M:%S")}' + ) + job_log = JobLogModel( + jobName=job_info.job_name, + jobGroup=job_info.job_group, + jobExecutor=job_executor, + invokeTarget=job_info.invoke_target, + jobArgs=job_args, + jobKwargs=job_kwargs, + jobTrigger=job_trigger, + jobMessage=job_message, + status=status, + exceptionInfo=exception_info, + createTime=datetime.now(), + ) + session = cls._get_session_local()() + try: + JobLogService.add_job_log_services(session, job_log) + finally: + session.close() + except Exception as e: + logger.error(f'❌ 记录任务执行日志失败: {e}') + + @classmethod + def _prepare_scheduler_job_add(cls, job_info: JobModel) -> dict[str, Any]: + """ + 构建调度器任务参数 + + :param job_info: 任务对象信息 + :return: 调度器任务参数 + """ + job_func = cls._import_function(job_info.invoke_target) + job_executor = job_info.job_executor + if iscoroutinefunction(job_func): + job_executor = 'default' + return { + 'func': job_func, + 'trigger': MyCronTrigger.from_crontab(job_info.cron_expression), + 'args': job_info.job_args.split(',') if job_info.job_args else None, + 'kwargs': json.loads(job_info.job_kwargs) if job_info.job_kwargs else None, + 'id': str(job_info.job_id), + 'name': job_info.job_name, + 'misfire_grace_time': 1000000000000 if job_info.misfire_policy == '3' else None, + 'coalesce': job_info.misfire_policy == '2', + 'max_instances': 3 if job_info.concurrent == '0' else 1, + 'jobstore': job_info.job_group, + 'executor': job_executor, + } + + @classmethod + def _add_job_to_scheduler(cls, job_info: JobModel) -> None: + """ + 内部方法:将任务添加到调度器(不检查应用锁状态,仅供内部使用) + + :param job_info: 任务对象信息 + """ + try: + # 先移除已存在的同ID任务 + existing_job = scheduler.get_job(job_id=str(job_info.job_id)) + if existing_job: + scheduler.remove_job(job_id=str(job_info.job_id)) + scheduler.add_job(**cls._prepare_scheduler_job_add(job_info)) + except Exception as e: + logger.error(f'❌ 添加任务 {job_info.job_name} 失败: {e}') + + @classmethod + async def close_system_scheduler(cls) -> None: + """ + 应用关闭时关闭定时任务 + + :return: + """ + if cls._sync_listener_task: + cls._sync_listener_task.cancel() + try: + await cls._sync_listener_task + except asyncio.CancelledError: + pass + cls._sync_listener_task = None + if cls._sync_task: + cls._sync_task.cancel() + try: + await cls._sync_task + except asyncio.CancelledError: + pass + cls._sync_task = None + cls._sync_pending = False + if cls._reacquire_task: + cls._reacquire_task.cancel() + try: + await cls._reacquire_task + except asyncio.CancelledError: + pass + cls._reacquire_task = None + await cls._dispose_sync_async_engine() + cls._dispose_sync_engines() + if cls._lock_lost_task: + cls._lock_lost_task.cancel() + try: + await cls._lock_lost_task + except asyncio.CancelledError: + pass + cls._lock_lost_task = None + if getattr(scheduler, 'running', False): + scheduler.shutdown() + logger.info('✅️ 关闭定时任务成功') + # 释放锁 + if cls._redis: + current_holder = await cls._redis.get(LockConstant.APP_STARTUP_LOCK_KEY) + if current_holder == cls._worker_id: + await cls._redis.delete(LockConstant.APP_STARTUP_LOCK_KEY) + logger.info(f'🔓 Worker {cls._worker_id} 释放 Application 锁') + + @classmethod + def _import_function(cls, func_path: str) -> Callable[..., Any]: + """ + 动态导入函数 + + :param func_path: 函数字符串,如module_task.scheduler_test.job + :return: 导入的函数对象 + """ + module_path, func_name = func_path.rsplit('.', 1) + module = importlib.import_module(module_path) + return getattr(module, func_name) + + @classmethod + def get_scheduler_job(cls, job_id: str | int) -> Job: + """ + 根据任务id获取任务对象 + + :param job_id: 任务id + :return: 任务对象 + """ + query_job = scheduler.get_job(job_id=str(job_id)) + + return query_job + + @classmethod + def add_scheduler_job(cls, job_info: JobModel) -> None: + """ + 根据输入的任务对象信息添加任务 + + :param job_info: 任务对象信息 + :return: + """ + # 非应用锁 worker 跳过操作(数据库状态是持久化的,持有应用锁时会加载) + if not cls._is_leader: + return + scheduler.add_job(**cls._prepare_scheduler_job_add(job_info)) + + @classmethod + def execute_scheduler_job_once(cls, job_info: JobModel) -> None: + """ + 根据输入的任务对象执行一次任务 + + :param job_info: 任务对象信息 + :return: + """ + job_func = cls._import_function(job_info.invoke_target) + job_executor = job_info.job_executor + if iscoroutinefunction(job_func): + job_executor = 'default' + + # 非应用锁 worker:直接执行函数(不通过 scheduler) + if not cls._is_leader: + logger.info(f'📍 当前 Worker 未持有 Application 锁,直接执行任务 {job_info.job_name}') + args = job_info.job_args.split(',') if job_info.job_args else [] + kwargs = json.loads(job_info.job_kwargs) if job_info.job_kwargs else {} + status = '0' + exception_info = '' + try: + if iscoroutinefunction(job_func): + asyncio.create_task(cls._execute_async_job_with_log(job_func, job_info, args, kwargs)) # noqa: RUF006 + else: + job_func(*args, **kwargs) + except Exception as e: + status = '1' + exception_info = str(e) + logger.error(f'❌ 直接执行任务 {job_info.job_name} 失败: {e}') + finally: + # 同步任务记录日志(异步任务在 _execute_async_job_with_log 中记录) + if not iscoroutinefunction(job_func): + cls._record_job_execution_log(job_info, job_executor, status, exception_info) + return + + # 应用锁 worker:通过 scheduler 执行 + job_trigger = DateTrigger() + if job_info.status == '0': + job_trigger = OrTrigger(triggers=[DateTrigger(), MyCronTrigger.from_crontab(job_info.cron_expression)]) + scheduler.add_job( + func=job_func, + trigger=job_trigger, + args=job_info.job_args.split(',') if job_info.job_args else None, + kwargs=json.loads(job_info.job_kwargs) if job_info.job_kwargs else None, + id=str(job_info.job_id), + name=job_info.job_name, + misfire_grace_time=1000000000000 if job_info.misfire_policy == '3' else None, + coalesce=job_info.misfire_policy == '2', + max_instances=3 if job_info.concurrent == '0' else 1, + jobstore=job_info.job_group, + executor=job_executor, + ) + + @classmethod + def remove_scheduler_job(cls, job_id: str | int) -> None: + """ + 根据任务id移除任务 + + :param job_id: 任务id + :return: + """ + # 非应用锁 worker 跳过操作(数据库状态是持久化的,持有应用锁时会根据状态加载) + if not cls._is_leader: + return + query_job = cls.get_scheduler_job(job_id=job_id) + if query_job: + scheduler.remove_job(job_id=str(job_id)) + + @classmethod + def scheduler_event_listener(cls, event: SchedulerEvent) -> None: + """ + 调度器事件监听器,记录任务执行日志 + """ + try: + # 获取事件类型和任务ID + event_type = event.__class__.__name__ + # 获取任务执行异常信息 + status = '0' + exception_info = '' + if event_type == 'JobExecutionEvent' and event.exception: + exception_info = str(event.exception) + status = '1' + if hasattr(event, 'job_id'): + job_id = event.job_id + # 跳过内部系统任务(以 _ 开头的任务ID),不记录日志 + if str(job_id).startswith('_'): + return + query_job = cls.get_scheduler_job(job_id=job_id) + if query_job: + query_job_info = query_job.__getstate__() + # 获取任务名称 + job_name = query_job_info.get('name') + # 获取任务组名 + job_group = query_job._jobstore_alias + # 获取任务执行器 + job_executor = query_job_info.get('executor') + # 获取调用目标字符串 + invoke_target = query_job_info.get('func') + # 获取调用函数位置参数(安全处理) + args = query_job_info.get('args') + job_args = ','.join(str(arg) for arg in args) if args else '' + # 获取调用函数关键字参数 + kwargs = query_job_info.get('kwargs') + job_kwargs = json.dumps(kwargs) if kwargs else '{}' + # 获取任务触发器 + job_trigger = str(query_job_info.get('trigger')) + # 构造日志消息 + job_message = f'事件类型: {event_type}, 任务ID: {job_id}, 任务名称: {job_name}, 执行于{datetime.now().strftime("%Y-%m-%d %H:%M:%S")}' + job_log = JobLogModel( + jobName=job_name, + jobGroup=job_group, + jobExecutor=job_executor, + invokeTarget=invoke_target, + jobArgs=job_args, + jobKwargs=job_kwargs, + jobTrigger=job_trigger, + jobMessage=job_message, + status=status, + exceptionInfo=exception_info, + createTime=datetime.now(), + ) + session = cls._get_session_local()() + try: + JobLogService.add_job_log_services(session, job_log) + finally: + session.close() + except Exception as e: + logger.error(f'❌ 调度任务事件监听器异常: {e}') diff --git a/shierfeng-fastapi-backend/docs/cli_usage.md b/shierfeng-fastapi-backend/docs/cli_usage.md new file mode 100644 index 0000000..558319d --- /dev/null +++ b/shierfeng-fastapi-backend/docs/cli_usage.md @@ -0,0 +1,841 @@ +# ShiErFeng Backend CLI 使用文档 + +## 1. 文档说明 + +本文档用于说明 `shierfeng-fastapi-backend` 当前已经落地的 CLI 用法。 + +统一命令入口为: + +```bash +shierfeng [options] +``` + +当前已实现的命令组包括: + +- `app` +- `db` +- `ops` +- `cache` +- `job` +- `config` +- `crypto` +- `gen` +- `dev` +- `completion` +- `wizard` +- `tui` + +## 2. 快速开始 + +### 2.1 执行目录 + +`shierfeng` 命令必须在后端项目根目录执行,也就是 `shierfeng-fastapi-backend` 目录。 + +```bash +cd shierfeng-fastapi-backend +shierfeng --help +``` + +### 2.2 安装依赖 + +MySQL 版本: + +```bash +cd shierfeng-fastapi-backend +pip3 install -r requirements.txt +``` + +PostgreSQL 版本: + +```bash +cd shierfeng-fastapi-backend +pip3 install -r requirements-pg.txt +``` + +说明: + +- `requirements*.txt` 已包含当前项目自身安装项 `.`,因此不需要额外执行 `pip install -e .` +- 安装完成后,`shierfeng` 会随当前 Python 环境一起可用 + +如果本地使用 Conda,推荐先进入项目环境再执行命令: + +```bash +conda activate shierfeng-fastapi +cd shierfeng-fastapi-backend +shierfeng --help +``` + +`textual` 已包含在现有依赖文件中,因此安装 `requirements.txt` 或 `requirements-pg.txt` 后即可直接使用 TUI。 + +### 2.3 第一个命令 + +开发环境启动应用: + +```bash +shierfeng app run --env=dev +``` + +这个命令的目标是等价替代: + +```bash +python app.py --env=dev +``` + +## 3. 使用规则 + +### 3.1 根参数位置 + +根参数必须写在命令组前面。 + +正确示例: + +```bash +shierfeng --color=never --icon=none ops health --env=dev +``` + +推荐不要写成把根参数放到子命令后面的形式。 + +### 3.2 环境参数 + +CLI 不单独维护配置系统,仍然复用项目原有的 `config/env.py` 解析逻辑。 + +常用环境映射如下: + +- `--env=dev` -> `.env.dev` +- `--env=prod` -> `.env.prod` +- `--env=dockermy` -> `.env.dockermy` +- `--env=dockerpg` -> `.env.dockerpg` + +### 3.3 帮助命令 + +可以通过以下方式逐层查看帮助: + +```bash +shierfeng --help +shierfeng app --help +shierfeng app run --help +shierfeng db --help +shierfeng cache clear --help +``` + +### 3.4 输出模式 + +除 `app run` 这类进程接管型命令外,大多数命令支持: + +- `--output=text` +- `--output=json` + +推荐约定: + +- 人工排查优先使用 `text` +- 脚本集成优先使用 `json` +- `text` 输出中的字段名统一使用 `snake_case` +- `json` 输出中的字段名保持稳定结构化契约,不为显示效果重命名 +- `json` 输出不会混入颜色码、emoji 或装饰文本 +- `json` 输出不会混入 SQLAlchemy SQL 日志、普通业务日志或其他非 JSON 文本 +- `app run` 会直接接管应用前台进程,因此不提供 `--output` + +示例: + +```bash +shierfeng ops health --env=dev --output=text +shierfeng ops health --env=dev --output=json +``` + +### 3.5 视觉选项 + +根命令支持: + +- `--color=auto|always|never` +- `--icon=emoji|ascii|none` + +当前默认值为: + +- `--color=always` +- `--icon=emoji` + +说明: + +- 这两个参数只影响 `text` 输出 +- `json` 输出始终保持结构化结果,不受颜色和图标影响 + +示例: + +```bash +shierfeng --color=always ops server-info --env=dev +shierfeng --color=never ops server-info --env=dev +shierfeng --icon=none ops server-info --env=dev +``` + +### 3.6 危险命令 + +会产生真实副作用的命令会纳入危险命令保护。 + +危险命令分为两类: + +- `high`:必须支持 `--dry-run` 或等价预览能力 +- `normal`:默认要求确认,但不强制要求 `--dry-run` + +保护规则如下: + +- 非 `prod` 环境下默认会要求确认 +- 非交互终端中如果未传 `--yes`,命令会直接拒绝执行 +- `prod` 环境下默认禁止执行,必须显式传入 `--allow-prod --yes` +- 只有 `high` 风险命令或已实现预演能力的命令才会出现 `--dry-run` + +示例: + +```bash +shierfeng cache clear --env=dev --all --yes +shierfeng db upgrade --env=prod --revision=head --allow-prod --yes +shierfeng gen export sys_user --env=dev --mode=local --dry-run +``` + +## 4. 常用工作流 + +### 4.1 本地开发启动 + +```bash +cd shierfeng-fastapi-backend +shierfeng app doctor --env=dev +shierfeng app run --env=dev +``` + +### 4.2 发布前检查 + +```bash +shierfeng ops health --env=prod --output=json +shierfeng ops server-info --env=prod +shierfeng db current --env=prod --output=json +``` + +### 4.3 数据库迁移 + +```bash +shierfeng db check --env=dev +shierfeng db revision --env=dev --message="add user index" --yes +shierfeng db upgrade --env=dev --revision=head --yes +``` + +### 4.4 缓存与调度排查 + +```bash +shierfeng cache stats --env=dev +shierfeng cache keys sys_config --env=dev --output=json +shierfeng job list --env=dev --output=json +shierfeng job sync --env=dev --yes +``` + +### 4.5 开发态检查 + +```bash +shierfeng dev lint cli --check-only +shierfeng dev test tests --keyword sanitize --maxfail=1 -q +``` + +### 4.6 Shell Completion 初始化 + +```bash +shierfeng completion doctor --output=json +shierfeng completion show bash +shierfeng completion install --activate +shierfeng completion install --shell=bash --activate +``` + +### 4.7 交互式向导与 TUI + +```bash +shierfeng wizard app-run +shierfeng wizard db-upgrade +shierfeng wizard cache-clear +shierfeng wizard gen-export +shierfeng wizard gen-import +shierfeng wizard prod-check +shierfeng tui --env=dev +``` + +## 5. 命令速查 + +### 5.1 `app` + +用于启动当前 FastAPI 应用、启动前检查、配置快照和路由巡检。 + +```bash +shierfeng app run --env=dev +shierfeng app doctor --env=dev --output=json +shierfeng app env --env=dev +shierfeng app config --env=dev --output=json +shierfeng app routes --env=dev +shierfeng app routes --env=dev --method=GET --path-prefix=/system +shierfeng app routes --env=dev --group-by=tag +shierfeng app routes --env=dev --include-hidden --output=json +``` + +### 5.2 `db` + +用于数据库连接检查和 Alembic 迁移封装。 + +```bash +shierfeng db check --env=dev +shierfeng db current --env=dev --output=json +shierfeng db heads --env=dev --output=json +shierfeng db history --env=dev --limit=10 +shierfeng db upgrade --env=dev +shierfeng db upgrade --env=dev --revision=head --dry-run +shierfeng db init --env=dev +shierfeng db downgrade --env=dev --revision=-1 +shierfeng db downgrade --env=dev --revision=-1 --dry-run +shierfeng db revision --env=dev --message="add user index" --yes +shierfeng db revision --env=dev --message="sync table structure" --autogenerate --yes +``` + +### 5.3 `ops` + +用于基础运维检查。 + +```bash +shierfeng ops deps --env=dev +shierfeng ops ping-db --env=dev +shierfeng ops ping-redis --env=dev +shierfeng ops health --env=dev +shierfeng ops health --env=dev --output=json +shierfeng ops server-info --env=dev +shierfeng ops server-info --env=dev --output=json +``` + +说明: + +- `server-info --output=text` 适合人工巡检 +- `server-info --output=json` 更适合脚本消费 + +### 5.4 `cache` + +用于缓存统计、查询、清理和预热。 + +```bash +shierfeng cache stats --env=dev +shierfeng cache stats --env=dev --output=json +shierfeng cache keys login_tokens --env=dev --output=json +shierfeng cache get sys_config site.name --env=dev --output=json +shierfeng cache ttl sys_config site.name --env=dev --output=json +shierfeng cache clear --env=dev --cache-name=sys_config --yes +shierfeng cache clear --env=dev --cache-key=site.name --yes +shierfeng cache clear --env=dev --all --yes +shierfeng cache warmup --env=dev --yes +``` + +### 5.5 `job` + +用于定时任务查询、执行和同步。 + +```bash +shierfeng job list --env=dev --output=json +shierfeng job list --env=dev --job-name=同步任务 --status=0 --paged +shierfeng job detail 1 --env=dev --output=json +shierfeng job logs --env=dev --output=json +shierfeng job logs --env=dev --job-name=同步任务 --status=1 --paged +shierfeng job run-once 1 --env=dev --yes +shierfeng job pause 1 --env=dev --yes +shierfeng job resume 1 --env=dev --yes +shierfeng job sync --env=dev --yes +shierfeng job run-once 1 --env=prod --allow-prod --yes +``` + +### 5.6 `config` + +用于系统参数配置读取、写入和缓存同步。 + +```bash +shierfeng config list --env=dev --output=json +shierfeng config list --env=dev --paged +shierfeng config get --env=dev --output=json +shierfeng config get --env=dev --source=both --output=json +shierfeng config get --env=dev --source=db --output=json +shierfeng config get --env=dev --source=cache +shierfeng config doctor --env=dev --output=json +shierfeng config set sys.user.initPassword --env=dev --value=123456 --name="初始密码" --yes +shierfeng config set sys.user.initPassword --env=dev --value=123456 --remark="CLI update" --yes +shierfeng config sync-cache --env=dev --yes +``` + +说明: + +- `config get --source=both` 会同时读取数据库和 Redis,并在 JSON 中返回 `database`、`cache` 与 `inSync` +- `config get --source=db` 只读取参数配置表,适合确认数据库中的真实存量值 +- `config get --source=cache` 只读取 Redis 缓存,适合确认当前运行时命中的值 +- 如果某个键只在缓存里存在、不在数据库里存在,`--source=db` 会返回“参数配置不存在”,这代表数据库侧没有对应记录,不表示缓存读取异常 + +### 5.7 `crypto` + +用于传输加密配置校验、公钥导出和密钥辅助操作。 + +```bash +shierfeng crypto validate --env=dev --output=json +shierfeng crypto keygen --env=dev --kid=default --key-size=2048 +shierfeng crypto keygen --env=dev --output=json --kid=default --key-size=2048 +shierfeng crypto export-public --env=dev +shierfeng crypto export-public --env=dev --output=json +shierfeng crypto rotate --env=dev --output=json --next-kid=v2 --key-size=2048 --yes +``` + +说明: + +- `crypto keygen` 会输出新生成的公钥、私钥和建议写入的 `envPatch` +- `crypto rotate` 当前只生成轮换辅助结果,不会直接改写 `.env.*` 文件 +- 涉及私钥的输出只建议在安全终端中使用 + +### 5.8 `gen` + +用于代码生成业务表查询、导入、建表、预览和导出。 + +```bash +shierfeng gen list --env=dev --output=json +shierfeng gen db-list --env=dev --output=json +shierfeng gen detail 1 --env=dev --output=json +shierfeng gen import-table sys_user sys_role --env=dev --yes +shierfeng gen import-table sys_user sys_role --env=dev --dry-run +shierfeng gen create-table --env=dev --sql="create table demo_test (id bigint primary key)" --yes +shierfeng gen create-table --env=dev --sql-file=./sql/demo.sql --dry-run +shierfeng gen preview 1 --env=dev +shierfeng gen preview 1 --env=dev --output=json +shierfeng gen export sys_user --env=dev --yes +shierfeng gen export sys_user sys_role --env=dev --mode=zip --output-file=./build/gen.zip --yes +shierfeng gen export sys_user --env=dev --mode=local --dry-run +shierfeng gen sync-db sys_user --env=dev --yes +``` + +说明: + +- `import-table` 与 `create-table` 支持 `--dry-run` +- `create-table` 必须且只能传入 `--sql` 或 `--sql-file` 其中一种 +- `gen preview --output=text` 会按模板分块展示预览代码内容 +- `export --mode=local` 会复用现有生成逻辑,并遵守 `GenConfig.allow_overwrite` + +### 5.9 `dev` + +用于开发态代码检查与测试执行。 + +```bash +shierfeng dev lint +shierfeng dev lint cli tests --check-only +shierfeng dev lint cli --fix +shierfeng dev lint cli --output=json +shierfeng dev test +shierfeng dev test tests/test_log_sanitize_util.py +shierfeng dev test tests --keyword sanitize --maxfail=1 -q +shierfeng dev test tests --output=json +``` + +说明: + +- `dev lint` 默认顺序是先执行 `ruff format`,再执行 `ruff check` +- `--check-only` 会改成只检查,不写回 +- `--fix` 会执行 `ruff check --fix` +- `dev test` 通过当前环境的 `python -m pytest` 执行测试 + +### 5.10 `completion` + +用于生成、安装和诊断 shell completion。 + +```bash +shierfeng completion doctor --output=json +shierfeng completion show bash +shierfeng completion show zsh +shierfeng completion show fish +shierfeng completion show powershell +shierfeng completion install --activate +shierfeng completion install --shell=bash +shierfeng completion install --shell=zsh --activate +shierfeng completion install --shell=fish +shierfeng completion install --shell=powershell --activate +``` + +说明: + +- 当前版本已支持 `bash`、`zsh`、`fish`、`powershell` +- `install` 在未传 `--shell` 时会优先自动识别当前 shell +- `install` 默认写入 shell 对应的默认脚本位置 +- Bash 和 Zsh 如需自动加载,建议配合 `--activate` +- PowerShell 如需自动加载,建议配合 `--activate` +- Bash 脚本已对旧版本 Bash 做兼容处理,若之前已安装过脚本,请重新执行一次 `shierfeng completion install --activate` +- `completion doctor` 会给出推荐安装命令和 source 建议 +- 当前已补充的上下文补全包括 `--env`、`cache_name`、`cache_key`、`config_key`、`db --revision`、`gen` 业务表名、`gen` 数据库表名、`gen --sql-file`、`gen --output-file`、`job_name`、`job_id` + +### 5.11 `wizard` + +用于通过交互方式组装危险命令或复杂命令,并在真正执行前输出预览。 + +```bash +shierfeng wizard app-run +shierfeng wizard db-upgrade --default-env=dev --default-revision=head +shierfeng wizard cache-clear --default-env=dev --default-mode=cache-name +shierfeng wizard gen-export --default-env=dev --default-mode=zip +shierfeng wizard gen-import --default-env=dev --default-table-names=sys_notice +shierfeng wizard prod-check --default-env=prod +``` + +说明: + +- 所有向导都会先采集输入,再输出预览摘要与最终将执行的 CLI 命令 +- `db-upgrade`、`cache-clear`、`gen-export`、`gen-import` 默认都支持先走 `dry-run` +- 向导本质上仍然是对底层 CLI 的封装,最终返回值、退出码和危险命令保护规则与底层命令保持一致 + +### 5.12 `tui` + +用于进入只读巡检工作台,以页面方式浏览应用、运维、数据库、缓存、任务、代码生成、参数配置和加密状态。 + +```bash +shierfeng tui --env=dev +shierfeng tui --env=prod +``` + +说明: + +- 当前 TUI 是只读巡检工作台,页面内的写操作入口会通过确认弹窗或向导二次确认 +- 页面切换快捷键为 `D/A/O/B/C/T/G/P/E`,分别对应总览、应用、运维、数据库、缓存、任务、代码生成、参数配置、加密 +- 通用快捷键包括 `R` 刷新、`Q` 退出、`S` 聚焦侧栏、`←/→` 切换焦点或区域、`J/K` 滚动、`PgUp/PgDn` 翻页、`Home/End` 首尾跳转 +- 若当前 Python 环境缺少 TUI 依赖,`shierfeng tui` 会返回失败结果并提示重新执行 `pip install -r requirements.txt` 或 `pip install -r requirements-pg.txt` + +## 6. 危险命令清单 + +当前已接入保护的命令包括: + +- `cache clear` +- `cache warmup` +- `db upgrade` +- `db init` +- `db downgrade` +- `db revision` +- `config set` +- `config sync-cache` +- `crypto rotate` +- `job run-once` +- `job pause` +- `job resume` +- `job sync` +- `gen import-table` +- `gen create-table` +- `gen export` +- `gen sync-db` + +说明: + +- 在 `prod` 环境下,这些命令默认拒绝执行 +- 在非 `prod` 环境下,这些命令默认也会进入交互确认 +- 在非交互终端中,如果未传入 `--yes`,命令会直接拒绝执行 +- 如果命令支持 `--dry-run`,优先先跑一次预演 + +## 7. 输出与退出码 + +### 7.1 输出格式 + +CLI 支持两种输出格式: + +- `text` +- `json` + +字段命名约定: + +- `text` 输出优先面向人工阅读,字段名统一使用 `snake_case` +- `json` 输出优先面向脚本消费,字段名保持命令契约定义,不因视觉优化变化 + +示例: + +```bash +shierfeng ops health --env=dev --output=json +``` + +标准样例: + +文本输出样例: + +命令: + +```bash +shierfeng --color=never --icon=none app config --env=dev +``` + +输出: + +```text +OK SUCCESS +env: dev +application: + name: ShiErFeng-FastAPI + host: 0.0.0.0:9099 + root_path: /dev-api + reload: true + workers: 1 + disable_swagger: false + disable_redoc: false +database: + type: mysql + host: 127.0.0.1:3306 + name: shierfeng-fastapi +redis: + host: 127.0.0.1:6379 +logging: + level: INFO +transport_crypto: + enabled: false + mode: off +``` + +JSON 输出样例: + +命令: + +```bash +shierfeng app config --env=dev --output=json +``` + +输出: + +```json +{ + "ok": true, + "env": "dev", + "config": { + "env": "dev", + "name": "ShiErFeng-FastAPI", + "host": "0.0.0.0", + "port": 9099, + "rootPath": "/dev-api", + "reload": true, + "workers": 1, + "disableSwagger": false, + "disableRedoc": false, + "dbType": "mysql", + "dbHost": "127.0.0.1", + "dbPort": 3306, + "dbDatabase": "shierfeng-fastapi", + "redisHost": "127.0.0.1", + "redisPort": 6379, + "logLevel": "INFO", + "transportCryptoEnabled": false, + "transportCryptoMode": "off" + } +} +``` + +危险命令拒绝样例: + +命令: + +```bash +shierfeng db revision --env=prod --message="doc-sample" --output=json +``` + +输出: + +```json +{ + "ok": false, + "message": "生产环境默认禁止直接执行危险命令:db revision", + "hint": "如确认执行,请传入 --allow-prod;如需跳过确认,请同时传入 --yes" +} +``` + +`dry-run` 输出样例: + +命令: + +```bash +shierfeng db upgrade --env=dev --revision=head --dry-run --yes --output=json +``` + +输出: + +```json +{ + "ok": true, + "message": "数据库已升级到 head(dry-run)", + "dryRun": true, + "command": [ + "alembic", + "-c", + "/path/to/shierfeng-fastapi-backend/alembic.ini", + "upgrade", + "head" + ], + "cwd": "/path/to/shierfeng-fastapi-backend" +} +``` + +代码生成 `dry-run` 文本样例: + +命令: + +```bash +shierfeng --color=never --icon=none gen export demo_table --env=dev --dry-run --yes --output=text +``` + +输出: + +```text +OK SUCCESS +env: dev +mode: zip +dry_run: true +message: 代码导出演练完成,未执行实际导出 +table_names: + - demo_table +output_file: /path/to/shierfeng-fastapi-backend/gen_code_demo_table.zip +``` + +代码生成 `dry-run` JSON 样例: + +命令: + +```bash +shierfeng gen create-table --env=dev --dry-run --yes --sql='CREATE TABLE demo_cli_test (id bigint);' --output=json +``` + +输出: + +```json +{ + "ok": true, + "message": "建表语句演练完成,未执行实际建表", + "dryRun": true, + "statementCount": 1, + "tableNames": [ + "demo_cli_test" + ], + "sql": "CREATE TABLE demo_cli_test (id bigint);", + "env": "dev" +} +``` + +参数错误样例: + +命令: + +```bash +shierfeng --color=never --icon=none gen create-table --env=dev --dry-run --yes --sql='DROP TABLE demo_cli_test;' --output=text +``` + +输出: + +```text +FAIL FAILED +message: 创建表结构失败 +error: 建表语句不合法,仅允许 CREATE TABLE 语句 +env: dev +``` + +参数错误 JSON 样例: + +命令: + +```bash +shierfeng gen create-table --env=dev --dry-run --yes --sql='DROP TABLE demo_cli_test;' --output=json +``` + +输出: + +```json +{ + "ok": false, + "message": "创建表结构失败", + "error": "建表语句不合法,仅允许 CREATE TABLE 语句", + "env": "dev" +} +``` + +依赖检查失败样例: + +说明: + +- `app doctor` 和 `ops health` 的返回结果会受到当前数据库、Redis 连通性影响 +- 如果依赖不可用,命令会输出失败结果,并返回退出码 `10` + +命令: + +```bash +shierfeng --color=never --icon=none app doctor --env=dev --output=text +``` + +输出: + +```text +FAIL FAILED +env: dev +checks: + database: false | 数据库连接失败 | error: + redis: false | Redis连接失败 | error: + crypto: true | 传输加密配置校验通过 +``` + +命令: + +```bash +shierfeng ops health --env=dev --output=json +``` + +输出: + +```json +{ + "env": "dev", + "database": { + "ok": false, + "message": "数据库连接失败", + "error": "", + "exit_code": 20 + }, + "redis": { + "ok": false, + "message": "Redis连接失败", + "error": "", + "exit_code": 21 + }, + "ok": false +} +``` + +### 7.2 退出码 + +当前统一退出码如下: + +- `0`:成功 +- `2`:参数错误 +- `10`:依赖检查失败 +- `20`:数据库失败 +- `21`:Redis 失败 +- `22`:调度器失败 +- `30`:危险操作被拒绝 +- `50`:未分类运行错误 + +## 8. 常见问题 + +### 8.1 `shierfeng` 命令不可用 + +请依次确认: + +- 当前目录是否为 `shierfeng-fastapi-backend` +- 当前 Python 环境是否执行过 `pip install -r requirements.txt` 或 `pip install -r requirements-pg.txt` +- 当前终端是否真的使用了安装依赖的那个 Python/Conda 环境 + +### 8.2 命令报数据库或 Redis 连接失败 + +请检查: + +- `.env.*` 中数据库配置是否正确 +- `.env.*` 中 Redis 配置是否正确 +- 当前网络、容器或主机是否允许连接目标服务 +- `app doctor` 与 `ops health` 在依赖异常时返回退出码 `10` +- 单项依赖失败会在 JSON 中带出原始 `error` 和对应依赖退出码 + +### 8.3 文本输出太花或不适合脚本处理 + +可以直接切换输出与视觉参数: + +```bash +shierfeng --color=never --icon=none ops health --env=dev --output=text +shierfeng ops health --env=dev --output=json +``` + +### 8.4 使用文档与实现不一致 + +应以当前 CLI 实现和命令帮助输出为准,并同步更新本文档。 diff --git a/shierfeng-fastapi-backend/docs/transport_crypto_config.md b/shierfeng-fastapi-backend/docs/transport_crypto_config.md new file mode 100644 index 0000000..4dc8238 --- /dev/null +++ b/shierfeng-fastapi-backend/docs/transport_crypto_config.md @@ -0,0 +1,129 @@ +# 传输层加解密配置说明 + +## 模式说明 + +`TRANSPORT_CRYPTO_MODE` 共有三种模式: + +- `off` + 完全关闭传输层加解密。中间件不执行请求解密与响应加密,前端通过 `/transport/crypto/frontend-config` 获取到的策略也会同步关闭。 +- `optional` + 可选加密模式。命中的接口既接受明文请求,也接受加密请求;如果请求已加密,后端会解密后处理,并对命中的 JSON 响应自动加密。适合灰度接入和上线初期观察。 +- `required` + 强制加密模式。命中的接口必须携带合法加密信封,明文请求会被直接拒绝;同时防重放校验会按严格模式执行,Redis 不可用时也会拒绝请求。适合链路稳定后的正式强制启用阶段。 + +补充说明: + +- `TRANSPORT_CRYPTO_ENABLED=false` 时,整体效果等同于关闭,不再进入传输层加解密逻辑。 +- `TRANSPORT_CRYPTO_ENABLED_PATHS`、`TRANSPORT_CRYPTO_REQUIRED_PATHS` 和 `TRANSPORT_CRYPTO_EXCLUDE_PATHS` 会在上述模式基础上继续约束命中范围。 + +## 开发环境 + +开发环境直接使用 `.env.dev` 中默认提供的可用密钥对即可。 + +说明: + +- 传输层加解密启用后,后端启动时必须读到一对匹配的 `TRANSPORT_CRYPTO_PUBLIC_KEY` / `TRANSPORT_CRYPTO_PRIVATE_KEY`。 +- 前端会自动读取 `/transport/crypto/frontend-config`,并跟随后端配置完成请求加密、响应解密。 +- `/transport/crypto/frontend-config` 和 `/transport/crypto/public-key` 为公开接口,已配置匿名限流,前端会直接调用这两个接口完成初始化。 +- `TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS` 用于控制前端多久重新拉取一次运行策略。 +- `TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS` 用于控制前端多久重新拉取一次公钥,两者已经独立。 + +## 生产环境 + +生产环境使用后端 `.env.prod` 中的密钥配置;仓库默认提供一套可用示例值,正式部署前请替换为正式密钥。 + +推荐最小配置如下: + +```env +TRANSPORT_CRYPTO_ENABLED=true +TRANSPORT_CRYPTO_MODE='optional' +TRANSPORT_CRYPTO_KID='2026-prod-v1' +TRANSPORT_CRYPTO_PUBLIC_KEY='-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n' +TRANSPORT_CRYPTO_PRIVATE_KEY='-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n' +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS='[]' +TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS=300 +TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS=3600 +TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS=120 +TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH=4096 +``` + +说明: + +- `TRANSPORT_CRYPTO_PUBLIC_KEY` 和 `TRANSPORT_CRYPTO_PRIVATE_KEY` 必须是一对匹配密钥,缺一不可。 +- `TRANSPORT_CRYPTO_KID` 表示当前启用的密钥版本。 +- `TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS` 控制 `/transport/crypto/frontend-config` 的前端缓存时长,适合在策略经常调整时适当缩短。 +- `TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS` 控制 `/transport/crypto/public-key` 的前端缓存时长,主要服务于公钥缓存与密钥轮换。 +- `TRANSPORT_CRYPTO_CLOCK_SKEW_SECONDS` 建议控制在 `60-120` 秒,默认收紧为 `120` 秒。 +- `TRANSPORT_CRYPTO_REPLAY_TTL_SECONDS` 控制防重放随机数在 Redis 中的有效期;如果准备使用 `required` 模式,建议保证 Redis 稳定可用。 +- 初次上线建议先用 `TRANSPORT_CRYPTO_MODE='optional'`,确认链路稳定后再考虑切到 `required`。 +- `TRANSPORT_CRYPTO_MAX_GET_URL_LENGTH` 用于限制 GET/DELETE 请求加密后的 URL 长度,前端会通过 `/transport/crypto/frontend-config` 自动同步该值,超限时直接提示改用 POST 或精简查询条件。 +- 传输层加密主要面向查询参数、`application/json` 与 `application/x-www-form-urlencoded` 请求;`multipart/form-data` 上传和下载接口默认排除。 + +## Docker 环境 + +当前项目的 Docker 部署使用: + +- `shierfeng-fastapi-test/docker-compose.test.my.yml` + `shierfeng-fastapi-backend/Dockerfile.my` +- `shierfeng-fastapi-test/docker-compose.test.pg.yml` + `shierfeng-fastapi-backend/Dockerfile.pg` + +后端容器启动命令分别是: + +- `shierfeng app run --env=dockermy` +- `shierfeng app run --env=dockerpg` + +所以 Docker 环境需要直接在以下文件中配置传输层密钥: + +- `shierfeng-fastapi-backend/.env.dockermy` +- `shierfeng-fastapi-backend/.env.dockerpg` + +配置方式与生产环境相同;`.env.dockermy` / `.env.dockerpg` 里也已经默认提供一套可用示例值,正式部署前请替换为正式密钥。 + +使用时只需要: + +1. 修改对应的 `.env.dockermy` 或 `.env.dockerpg` +2. 重新构建并启动 Docker 服务 + +## 密钥生成 + +使用 `openssl` 生成一套 RSA 密钥: + +```bash +openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:4096 -out transport_private.pem +openssl rsa -pubout -in transport_private.pem -out transport_public.pem +``` + +如果需要写入 `.env`,先转成单行带 `\n` 的格式: + +```bash +awk 'NF {sub(/\r/, ""); printf "%s\\\\n",$0;}' transport_private.pem +awk 'NF {sub(/\r/, ""); printf "%s\\\\n",$0;}' transport_public.pem +``` + +## 使用流程 + +1. 后端启动时读取当前 `TRANSPORT_CRYPTO_*` 配置,并校验公私钥是否同时存在且彼此匹配。 +2. 前端通过 `/transport/crypto/frontend-config` 获取当前运行策略,再通过 `/transport/crypto/public-key` 获取当前 `kid`、协议版本和公钥。 +3. `TRANSPORT_CRYPTO_FRONTEND_CONFIG_TTL_SECONDS` 和 `TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS` 分别控制这两类缓存的刷新周期。 +4. 前端用公钥加密请求,后端用私钥解密请求。 +5. 后端会对命中的 JSON 响应自动加密,前端自动解密;下载、上传等排除场景保持明文。 + +## 密钥轮换 + +如果需要更换密钥: + +1. 生成新密钥对。 +2. 修改 `TRANSPORT_CRYPTO_KID` 为新版本,例如 `2026-prod-v2`。 +3. 配置新的 `TRANSPORT_CRYPTO_PUBLIC_KEY` 和 `TRANSPORT_CRYPTO_PRIVATE_KEY`。 +4. 把旧私钥放入 `TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS`。 + +补充说明: + +- `TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS` 主要用于兼容旧报文解密,最少提供 `kid` 和旧私钥即可;`publicKey` 可选,不填时后端会从私钥推导。 +- 轮换期间建议保留旧私钥直到旧公钥缓存全部过期,至少覆盖 `TRANSPORT_CRYPTO_PUBLIC_KEY_TTL_SECONDS` 对应的缓存窗口。 + +示例: + +```env +TRANSPORT_CRYPTO_KID='2026-prod-v2' +TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS='[{"kid":"2026-prod-v1","privateKey":"-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"}]' +``` diff --git a/shierfeng-fastapi-backend/exceptions/exception.py b/shierfeng-fastapi-backend/exceptions/exception.py new file mode 100644 index 0000000..02580ed --- /dev/null +++ b/shierfeng-fastapi-backend/exceptions/exception.py @@ -0,0 +1,58 @@ +class LoginException(Exception): + """ + 自定义登录异常LoginException + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message + + +class AuthException(Exception): + """ + 自定义令牌异常AuthException + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message + + +class PermissionException(Exception): + """ + 自定义权限异常PermissionException + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message + + +class ServiceException(Exception): + """ + 自定义服务异常ServiceException + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message + + +class ServiceWarning(Exception): + """ + 自定义服务警告ServiceWarning + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message + + +class ModelValidatorException(Exception): + """ + 自定义模型校验异常ModelValidatorException + """ + + def __init__(self, data: str | None = None, message: str | None = None) -> None: + self.data = data + self.message = message diff --git a/shierfeng-fastapi-backend/exceptions/handle.py b/shierfeng-fastapi-backend/exceptions/handle.py new file mode 100644 index 0000000..3e8e590 --- /dev/null +++ b/shierfeng-fastapi-backend/exceptions/handle.py @@ -0,0 +1,72 @@ +from fastapi import FastAPI, Request, Response +from fastapi.exceptions import HTTPException +from pydantic_validation_decorator import FieldValidationError + +from exceptions.exception import ( + AuthException, + LoginException, + ModelValidatorException, + PermissionException, + ServiceException, + ServiceWarning, +) +from utils.log_util import logger +from utils.response_util import JSONResponse, ResponseUtil, jsonable_encoder + + +def handle_exception(app: FastAPI) -> None: + """ + 全局异常处理 + """ + + # 自定义token检验异常 + @app.exception_handler(AuthException) + async def auth_exception_handler(request: Request, exc: AuthException) -> Response: + return ResponseUtil.unauthorized(data=exc.data, msg=exc.message) + + # 自定义登录检验异常 + @app.exception_handler(LoginException) + async def login_exception_handler(request: Request, exc: LoginException) -> Response: + return ResponseUtil.failure(data=exc.data, msg=exc.message) + + # 自定义模型检验异常 + @app.exception_handler(ModelValidatorException) + async def model_validator_exception_handler(request: Request, exc: ModelValidatorException) -> Response: + logger.warning(exc.message) + return ResponseUtil.failure(data=exc.data, msg=exc.message) + + # 自定义字段检验异常 + @app.exception_handler(FieldValidationError) + async def field_validation_error_handler(request: Request, exc: FieldValidationError) -> Response: + logger.warning(exc.message) + return ResponseUtil.failure(msg=exc.message) + + # 自定义权限检验异常 + @app.exception_handler(PermissionException) + async def permission_exception_handler(request: Request, exc: PermissionException) -> Response: + return ResponseUtil.forbidden(data=exc.data, msg=exc.message) + + # 自定义服务异常 + @app.exception_handler(ServiceException) + async def service_exception_handler(request: Request, exc: ServiceException) -> Response: + logger.error(exc.message) + return ResponseUtil.error(data=exc.data, msg=exc.message) + + # 自定义服务警告 + @app.exception_handler(ServiceWarning) + async def service_warning_handler(request: Request, exc: ServiceWarning) -> Response: + logger.warning(exc.message) + return ResponseUtil.failure(data=exc.data, msg=exc.message) + + # 处理其他http请求异常 + @app.exception_handler(HTTPException) + async def http_exception_handler(request: Request, exc: HTTPException) -> Response: + return JSONResponse( + content=jsonable_encoder({'code': exc.status_code, 'msg': exc.detail}), status_code=exc.status_code + ) + + # 处理其他异常 + @app.exception_handler(Exception) + async def exception_handler(request: Request, exc: Exception) -> Response: + logger.exception(exc) + return ResponseUtil.error(msg=str(exc)) diff --git a/shierfeng-fastapi-backend/middlewares/api_response_header_middleware.py b/shierfeng-fastapi-backend/middlewares/api_response_header_middleware.py new file mode 100644 index 0000000..5393eaf --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/api_response_header_middleware.py @@ -0,0 +1,28 @@ +from fastapi import FastAPI, Request +from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint +from starlette.responses import Response + + +class ApiResponseHeaderMiddleware(BaseHTTPMiddleware): + """ + 接口响应头追加中间件 + """ + + async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response: + """ + 在响应返回前统一追加接口响应头 + """ + response = await call_next(request) + api_response_headers = getattr(request.state, 'api_response_headers', None) + if api_response_headers: + response.headers.update(api_response_headers) + return response + + +def add_api_response_header_middleware(app: FastAPI) -> None: + """ + 添加接口响应头追加中间件 + + :param app: FastAPI对象 + """ + app.add_middleware(ApiResponseHeaderMiddleware) diff --git a/shierfeng-fastapi-backend/middlewares/context_middleware.py b/shierfeng-fastapi-backend/middlewares/context_middleware.py new file mode 100644 index 0000000..89c9054 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/context_middleware.py @@ -0,0 +1,29 @@ +from fastapi import FastAPI, Request +from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint +from starlette.responses import Response + +from common.context import RequestContext + + +class ContextCleanupMiddleware(BaseHTTPMiddleware): + """ + 上下文清理中间件 + """ + + async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response: + """ + 在每个请求处理完成后清理上下文信息 + """ + response = await call_next(request) + # 请求处理完成后清理所有上下文变量 + RequestContext.clear_all() + return response + + +def add_context_cleanup_middleware(app: FastAPI) -> None: + """ + 添加上下文清理中间件 + + :param app: FastAPI对象 + """ + app.add_middleware(ContextCleanupMiddleware) diff --git a/shierfeng-fastapi-backend/middlewares/cors_middleware.py b/shierfeng-fastapi-backend/middlewares/cors_middleware.py new file mode 100644 index 0000000..df6a0ce --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/cors_middleware.py @@ -0,0 +1,28 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware + + +def add_cors_middleware(app: FastAPI) -> None: + """ + 添加跨域中间件 + + :param app: FastAPI对象 + :return: + """ + # 前端页面url + origins = ['*'] + expose_headers = [ + 'x-body-encrypted', + 'x-key-id', + 'x-encrypt-alg', + ] + + # 后台api允许跨域 + app.add_middleware( + CORSMiddleware, + allow_origins=origins, + allow_credentials=True, + allow_methods=['*'], + allow_headers=['*'], + expose_headers=expose_headers, + ) diff --git a/shierfeng-fastapi-backend/middlewares/demo_mode_middleware.py b/shierfeng-fastapi-backend/middlewares/demo_mode_middleware.py new file mode 100644 index 0000000..f2eb03f --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/demo_mode_middleware.py @@ -0,0 +1,63 @@ +from fastapi import FastAPI, Request +from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint +from starlette.responses import Response + +from utils.client_ip_util import ClientIPUtil +from utils.log_util import logger +from utils.response_util import ResponseUtil + + +class DemoModeMiddleware(BaseHTTPMiddleware): + """ + 演示模式中间件 + """ + + async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response: + """ + 演示模式下拦截指定请求 + """ + url_path = str(request.url) + method = request.method.lower() + intercept_url_list = [ + 'system/user', + 'system/role', + 'system/menu', + 'system/dept', + 'system/post', + 'system/dict', + 'system/config', + 'system/notice', + 'monitor/operlog', + 'monitor/logininfor', + 'monitor/online', + 'monitor/job', + 'monitor/jobLog', + 'monitor/cache', + 'ai/model', + 'ai/chat', + ] + + for item in intercept_url_list: + if (url_path.startswith(f'{request.base_url!s}{item}') and method != 'get') or url_path.startswith( + ( + f'{request.base_url!s}common', + f'{request.base_url!s}register', + f'{request.base_url!s}tool/gen/createTable', + ) + ): + operate_ip = ClientIPUtil.get_client_ip(request) + logger.warning( + '请求IP:{}||请求API:{}||请求方法:{}||请求结果:演示模式,不允许操作!', operate_ip, url_path, method + ) + return ResponseUtil.failure(msg='演示模式,不允许操作!') + response = await call_next(request) + return response + + +def add_demo_mode_middleware(app: FastAPI) -> None: + """ + 添加演示模式中间件 + + :param app: FastAPI对象 + """ + app.add_middleware(DemoModeMiddleware) diff --git a/shierfeng-fastapi-backend/middlewares/gzip_middleware.py b/shierfeng-fastapi-backend/middlewares/gzip_middleware.py new file mode 100644 index 0000000..867b786 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/gzip_middleware.py @@ -0,0 +1,12 @@ +from fastapi import FastAPI +from starlette.middleware.gzip import GZipMiddleware + + +def add_gzip_middleware(app: FastAPI) -> None: + """ + 添加gzip压缩中间件 + + :param app: FastAPI对象 + :return: + """ + app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=9) diff --git a/shierfeng-fastapi-backend/middlewares/handle.py b/shierfeng-fastapi-backend/middlewares/handle.py new file mode 100644 index 0000000..b56c0c0 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/handle.py @@ -0,0 +1,31 @@ +from fastapi import FastAPI + +from config.env import AppConfig +from middlewares.api_response_header_middleware import add_api_response_header_middleware +from middlewares.context_middleware import add_context_cleanup_middleware +from middlewares.cors_middleware import add_cors_middleware +from middlewares.demo_mode_middleware import add_demo_mode_middleware +from middlewares.gzip_middleware import add_gzip_middleware +from middlewares.trace_middleware import add_trace_middleware +from middlewares.transport_crypto_middleware import add_transport_crypto_middleware + + +def handle_middleware(app: FastAPI) -> None: + """ + 全局中间件处理 + """ + # 加载上下文清理中间件 + add_context_cleanup_middleware(app) + # 加载跨域中间件 + add_cors_middleware(app) + # 加载gzip压缩中间件 + add_gzip_middleware(app) + # 加载接口响应头追加中间件 + add_api_response_header_middleware(app) + # 加载trace中间件 + add_trace_middleware(app) + if AppConfig.app_demo_mode: + # 加载演示模式中间件 + add_demo_mode_middleware(app) + # 加载传输层请求解密/响应加密中间件 + add_transport_crypto_middleware(app) diff --git a/shierfeng-fastapi-backend/middlewares/trace_middleware/__init__.py b/shierfeng-fastapi-backend/middlewares/trace_middleware/__init__.py new file mode 100644 index 0000000..c2ea302 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/trace_middleware/__init__.py @@ -0,0 +1,18 @@ +from fastapi import FastAPI + +from .ctx import TraceCtx +from .middle import TraceASGIMiddleware + +__all__ = ('TraceASGIMiddleware', 'TraceCtx') + +__version__ = '0.1.0' + + +def add_trace_middleware(app: FastAPI) -> None: + """ + 添加trace中间件 + + :param app: FastAPI对象 + :return: + """ + app.add_middleware(TraceASGIMiddleware) diff --git a/shierfeng-fastapi-backend/middlewares/trace_middleware/ctx.py b/shierfeng-fastapi-backend/middlewares/trace_middleware/ctx.py new file mode 100644 index 0000000..f5461d1 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/trace_middleware/ctx.py @@ -0,0 +1,64 @@ +import contextvars +from uuid import uuid4 + +CTX_TRACE_ID: contextvars.ContextVar[str] = contextvars.ContextVar('trace-id', default='') +CTX_REQUEST_ID: contextvars.ContextVar[str] = contextvars.ContextVar('request-id', default='') +CTX_SPAN_ID: contextvars.ContextVar[str] = contextvars.ContextVar('span-id', default='') +CTX_REQUEST_PATH: contextvars.ContextVar[str] = contextvars.ContextVar('request-path', default='') +CTX_REQUEST_METHOD: contextvars.ContextVar[str] = contextvars.ContextVar('request-method', default='') + + +class TraceCtx: + @staticmethod + def set_trace_id() -> str: + _id = uuid4().hex + CTX_TRACE_ID.set(_id) + return _id + + @staticmethod + def get_trace_id() -> str: + return CTX_TRACE_ID.get() + + @staticmethod + def set_request_id() -> str: + _id = uuid4().hex + CTX_REQUEST_ID.set(_id) + return _id + + @staticmethod + def get_request_id() -> str: + return CTX_REQUEST_ID.get() + + @staticmethod + def set_span_id() -> str: + _id = uuid4().hex + CTX_SPAN_ID.set(_id) + return _id + + @staticmethod + def get_span_id() -> str: + return CTX_SPAN_ID.get() + + @staticmethod + def set_request_path(path: str) -> None: + CTX_REQUEST_PATH.set(path) + + @staticmethod + def get_request_path() -> str: + return CTX_REQUEST_PATH.get() + + @staticmethod + def set_request_method(method: str) -> None: + CTX_REQUEST_METHOD.set(method) + + @staticmethod + def get_request_method() -> str: + return CTX_REQUEST_METHOD.get() + + @staticmethod + def clear() -> None: + CTX_TRACE_ID.set('') + CTX_REQUEST_ID.set('') + CTX_SPAN_ID.set('') + CTX_REQUEST_PATH.set('') + CTX_REQUEST_METHOD.set('') diff --git a/shierfeng-fastapi-backend/middlewares/trace_middleware/middle.py b/shierfeng-fastapi-backend/middlewares/trace_middleware/middle.py new file mode 100644 index 0000000..57a9a28 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/trace_middleware/middle.py @@ -0,0 +1,46 @@ +from functools import wraps + +from starlette.types import ASGIApp, Message, Receive, Scope, Send + +from .ctx import TraceCtx +from .span import Span, get_current_span + + +class TraceASGIMiddleware: + """ + fastapi-example: + app = FastAPI() + app.add_middleware(TraceASGIMiddleware) + """ + + def __init__(self, app: ASGIApp) -> None: + self.app = app + + @staticmethod + async def my_receive(receive: Receive, span: Span) -> Receive: + await span.request_before() + + @wraps(receive) + async def my_receive() -> Message: + message = await receive() + await span.request_after(message) + return message + + return my_receive + + async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: + if scope['type'] != 'http': + await self.app(scope, receive, send) + return + + async with get_current_span(scope) as span: + handle_outgoing_receive = await self.my_receive(receive, span) + + async def handle_outgoing_request(message: 'Message') -> None: + await span.response(message) + await send(message) + + try: + await self.app(scope, handle_outgoing_receive, handle_outgoing_request) + finally: + TraceCtx.clear() diff --git a/shierfeng-fastapi-backend/middlewares/trace_middleware/span.py b/shierfeng-fastapi-backend/middlewares/trace_middleware/span.py new file mode 100644 index 0000000..ba66000 --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/trace_middleware/span.py @@ -0,0 +1,54 @@ +from collections.abc import AsyncGenerator +from contextlib import asynccontextmanager + +from starlette.types import Message, Scope + +from .ctx import TraceCtx + + +class Span: + """ + 整个http生命周期: + request(before) --> request(after) --> response(before) --> response(after) + """ + + def __init__(self, scope: Scope) -> None: + self.scope = scope + + async def request_before(self) -> None: + """ + request_before: 处理header信息等, 如记录请求体信息 + """ + TraceCtx.set_trace_id() + TraceCtx.set_request_id() + TraceCtx.set_span_id() + TraceCtx.set_request_path(self.scope.get('path', '')) + TraceCtx.set_request_method(self.scope.get('method', '')) + + async def request_after(self, message: Message) -> Message: + """ + request_after: 处理请求bytes, 如记录请求参数 + + example: + message: {'type': 'http.request', 'body': b'{\r\n "name": "\xe8\x8b\x8f\xe8\x8b\x8f\xe8\x8b\x8f"\r\n}', 'more_body': False} + """ + return message + + async def response(self, message: Message) -> Message: + """ + if message['type'] == "http.response.start": -----> request-before + pass + if message['type'] == "http.response.body": -----> request-after + message.get('body', b'') + pass + """ + if message['type'] == 'http.response.start': + message['headers'].append((b'request-id', TraceCtx.get_request_id().encode())) + message['headers'].append((b'trace-id', TraceCtx.get_trace_id().encode())) + message['headers'].append((b'span-id', TraceCtx.get_span_id().encode())) + return message + + +@asynccontextmanager +async def get_current_span(scope: Scope) -> AsyncGenerator[Span, None]: + yield Span(scope) diff --git a/shierfeng-fastapi-backend/middlewares/transport_crypto_middleware.py b/shierfeng-fastapi-backend/middlewares/transport_crypto_middleware.py new file mode 100644 index 0000000..623ea1c --- /dev/null +++ b/shierfeng-fastapi-backend/middlewares/transport_crypto_middleware.py @@ -0,0 +1,757 @@ +import json +from collections.abc import Awaitable, Callable +from urllib.parse import parse_qs, urlencode + +from fastapi import FastAPI, Request +from fastapi.datastructures import Headers, QueryParams +from fastapi.responses import JSONResponse +from starlette.types import ASGIApp, Message, Receive, Scope, Send + +from common.constant import HttpStatusConstant +from config.env import AppConfig, TransportCryptoConfig +from utils.transport_crypto_util import ( + DecryptedTransportEnvelope, + TransportCryptoMonitorUtil, + TransportCryptoUtil, + TransportSecurityUtil, +) + + +class TransportCryptoMiddleware: + """ + 传输层请求解密与响应加密中间件 + """ + + _ENCRYPT_REQUEST_HEADER = 'x-transport-encrypt' + _ENCRYPT_RESPONSE_HEADER = 'x-body-encrypted' + _ENCRYPT_ALG_HEADER = 'x-encrypt-alg' + _ENCRYPT_KID_HEADER = 'x-key-id' + _MONITOR_REQUEST_MODE_HEADER = 'x-transport-request-mode' + _MONITOR_RESPONSE_MODE_HEADER = 'x-transport-response-mode' + _MONITOR_STATUS_HEADER = 'x-transport-crypto-status' + _MONITOR_KID_HEADER = 'x-transport-key-id' + + def __init__(self, app: ASGIApp) -> None: + """ + 初始化传输层加解密中间件 + + :param app: FastAPI/Starlette应用对象 + :return: None + """ + self.app = app + + async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: + """ + 拦截HTTP请求,按配置执行请求解密与响应加密 + + :param scope: 当前ASGI请求作用域 + :param receive: ASGI receive函数 + :param send: ASGI send函数 + :return: None + """ + if scope['type'] != 'http' or not TransportCryptoConfig.transport_crypto_enabled: + await self.app(scope, receive, send) + return + + current_app = scope.get('app') + path = self._normalize_path(str(scope.get('path', ''))) + if ( + self._is_excluded_path(path) + or TransportCryptoConfig.transport_crypto_mode == 'off' + or not self._is_enabled_path(path) + ): + await self.app(scope, receive, send) + return + + headers = Headers(scope=scope) + request_encrypted = headers.get(self._ENCRYPT_REQUEST_HEADER) == '1' + request_required = TransportCryptoConfig.transport_crypto_mode == 'required' or self._is_required_path(path) + + if request_required and not request_encrypted: + await TransportCryptoMonitorUtil.record_plain_request(current_app) + await TransportCryptoMonitorUtil.record_required_rejected( + current_app, str(scope.get('method', '')).upper(), path + ) + await TransportCryptoMonitorUtil.record_plain_response(current_app) + await self._send_error_response( + scope, + receive, + send, + '当前接口要求使用加密传输', + headers=self._build_monitor_headers( + request_mode='plain', + response_mode='plain', + crypto_status='required_missing', + ), + ) + return + + if not request_encrypted: + await TransportCryptoMonitorUtil.record_plain_request(current_app) + response_observer = self._build_passthrough_response_observer( + app=current_app, + send=send, + request_mode='plain', + crypto_status='pass_through', + ) + await self.app(scope, receive, response_observer) + return + + body = await self._read_body(receive) + request = Request(scope, receive=self._build_receive(body)) + try: + decrypted_scope, decrypted_body, crypto_context = await self._decrypt_request(scope, request, headers, body) + await TransportCryptoMonitorUtil.record_encrypted_request(current_app, str(crypto_context['kid'])) + await TransportCryptoMonitorUtil.record_decrypt_success(current_app, str(crypto_context['kid'])) + except Exception as exc: + error_crypto_context = self._build_error_crypto_context(scope, headers, body) + error_kid = ( + str(error_crypto_context['kid']) + if error_crypto_context + else self._extract_request_kid(scope, headers, body) + ) + await TransportCryptoMonitorUtil.record_encrypted_request(current_app, error_kid) + failure_reason = self._classify_failure_reason(str(exc)) + await TransportCryptoMonitorUtil.record_decrypt_failure( + current_app, + method=str(scope.get('method', '')).upper(), + path=path, + reason=failure_reason, + kid=error_kid, + ) + if error_crypto_context: + await TransportCryptoMonitorUtil.record_encrypted_response(current_app, error_kid, is_error=True) + else: + await TransportCryptoMonitorUtil.record_plain_response(current_app) + await self._send_error_response( + scope, + receive, + send, + str(exc) or '加密请求解析失败', + error_crypto_context, + headers=self._build_monitor_headers( + request_mode='encrypted', + response_mode='encrypted' if error_crypto_context else 'plain', + crypto_status=failure_reason, + kid=error_kid, + ), + ) + return + + async def send_wrapper(message: Message) -> None: + await response_encryptor(message) + + response_encryptor = self._build_response_encryptor( + app=current_app, + scope=decrypted_scope, + send=send, + crypto_context=crypto_context, + ) + await self.app(decrypted_scope, self._build_receive(decrypted_body), send_wrapper) + + async def _decrypt_request( + self, + scope: Scope, + request: Request, + headers: Headers, + body: bytes, + ) -> tuple[Scope, bytes, dict[str, str | bytes | bool]]: + """ + 解密请求并回写解密后的headers、query和body + + :param scope: 当前ASGI请求作用域 + :param request: FastAPI请求对象 + :param headers: 当前请求头对象 + :param body: 原始请求体字节串 + :return: 解密后的scope、请求体与加密上下文 + """ + new_scope = dict(scope) + new_scope['state'] = dict(scope.get('state', {})) + new_scope['headers'] = self._remove_header(new_scope.get('headers', []), b'accept-encoding') + content_type = headers.get('content-type', '') + + query_envelope = self._extract_query_envelope(new_scope) + body_envelope = self._extract_body_envelope(content_type, body) + + if query_envelope is None and body_envelope is None: + raise ValueError('未找到可解密的请求载荷') + + crypto_context: dict[str, str | bytes | bool] | None = None + if query_envelope is not None: + decrypted_query = await self._decrypt_envelope(request, scope, query_envelope) + query_payload = self._loads_json_mapping(decrypted_query.plaintext.decode('utf-8')) + new_scope['query_string'] = urlencode(query_payload, doseq=True).encode('utf-8') + crypto_context = self._build_crypto_context(decrypted_query) + + decrypted_body = body + if body_envelope is not None: + decrypted_body_payload = await self._decrypt_envelope(request, scope, body_envelope) + if crypto_context and crypto_context['kid'] != decrypted_body_payload.kid: + raise ValueError('请求中存在不一致的密钥版本') + if crypto_context and crypto_context['aes_key'] != decrypted_body_payload.aes_key: + raise ValueError('请求中存在不一致的会话密钥') + if crypto_context is None: + crypto_context = self._build_crypto_context(decrypted_body_payload) + + if 'application/x-www-form-urlencoded' in content_type: + form_payload = self._loads_json_mapping(decrypted_body_payload.plaintext.decode('utf-8')) + decrypted_body = urlencode(form_payload, doseq=True).encode('utf-8') + else: + decrypted_body = decrypted_body_payload.plaintext + new_scope['headers'] = self._replace_header( + new_scope.get('headers', []), b'content-length', str(len(decrypted_body)).encode('utf-8') + ) + + if crypto_context is None: + raise ValueError('加密请求缺少可用的密钥上下文') + + new_scope['state']['transport_crypto_context'] = crypto_context + return new_scope, decrypted_body, crypto_context + + async def _decrypt_envelope( + self, + request: Request, + scope: Scope, + envelope: dict[str, str], + ) -> DecryptedTransportEnvelope: + """ + 解密单个请求信封并执行时间窗、防重放校验 + + :param request: 当前请求对象 + :param scope: 当前ASGI请求作用域 + :param envelope: 请求信封字典 + :return: 解密后的请求信封对象 + """ + decrypted_payload = TransportCryptoUtil.decrypt_envelope( + envelope, + expected_method=str(scope.get('method', '')).upper(), + expected_path=self._normalize_path(str(scope.get('path', ''))), + ) + TransportSecurityUtil.validate_timestamp(decrypted_payload.timestamp) + await TransportSecurityUtil.validate_replay(request, decrypted_payload.kid, decrypted_payload.nonce) + return decrypted_payload + + def _extract_query_envelope(self, scope: Scope) -> dict[str, str] | None: + """ + 从查询参数中提取加密信封 + + :param scope: 当前ASGI请求作用域 + :return: 查询参数中的信封字典,不存在时返回None + """ + query_params = QueryParams(scope.get('query_string', b'').decode('utf-8')) + encrypted_query = query_params.get('__enc') + if not encrypted_query: + return None + return TransportCryptoUtil.decode_query_envelope(encrypted_query) + + def _extract_body_envelope(self, content_type: str, body: bytes) -> dict[str, str] | None: + """ + 根据内容类型从请求体中提取加密信封 + + :param content_type: 当前请求内容类型 + :param body: 原始请求体字节串 + :return: 请求体中的信封字典,不存在时返回None + """ + if not body or 'multipart/form-data' in content_type: + return None + + if 'application/json' in content_type: + body_payload = json.loads(body.decode('utf-8')) + if not isinstance(body_payload, dict): + raise ValueError('加密请求体格式不合法') + return body_payload + + if 'application/x-www-form-urlencoded' in content_type: + parsed_form = parse_qs(body.decode('utf-8'), keep_blank_values=True) + body_envelope = { + key: values[-1] if isinstance(values, list) else values for key, values in parsed_form.items() + } + aad = body_envelope.get('aad') + if isinstance(aad, str) and aad: + try: + parsed_aad = json.loads(aad) + if isinstance(parsed_aad, dict): + body_envelope['aad'] = parsed_aad + except json.JSONDecodeError: + pass + return body_envelope + + return None + + def _build_response_encryptor( + self, + app: FastAPI | None, + scope: Scope, + send: Send, + crypto_context: dict[str, str | bytes | bool], + ) -> Callable[[Message], Awaitable[None]]: + """ + 构建响应加密发送器,仅对JSON响应执行加密 + + :param scope: 当前ASGI请求作用域 + :param send: ASGI send函数 + :param crypto_context: 当前请求加密上下文 + :return: 包装后的ASGI send函数 + """ + response_start_message: Message | None = None + buffered_json_body: list[bytes] = [] + should_buffer_json = False + + async def _encrypt_response(message: Message) -> None: + nonlocal response_start_message, should_buffer_json + + if message['type'] == 'http.response.start': + response_start_message = message + headers = Headers(raw=message.get('headers', [])) + content_type = headers.get('content-type', '') + should_buffer_json = 'application/json' in content_type + if not should_buffer_json: + await TransportCryptoMonitorUtil.record_plain_response(app) + await send( + { + **message, + 'headers': self._merge_response_headers( + message.get('headers', []), + self._build_monitor_headers( + request_mode='encrypted', + response_mode='plain', + crypto_status='ok', + kid=str(crypto_context['kid']), + ), + ), + } + ) + return + + if message['type'] != 'http.response.body': + await send(message) + return + + if not should_buffer_json or response_start_message is None: + await send(message) + return + + buffered_json_body.append(message.get('body', b'')) + if message.get('more_body', False): + return + + encrypted_body = TransportCryptoUtil.encrypt_response_body( + aes_key=crypto_context['aes_key'], + payload=b''.join(buffered_json_body), + kid=str(crypto_context['kid']), + method=str(scope.get('method', '')), + path=self._normalize_path(str(scope.get('path', ''))), + ) + response_headers = self._replace_header( + response_start_message.get('headers', []), + b'content-length', + str(len(encrypted_body)).encode('utf-8'), + ) + response_headers = self._replace_header(response_headers, b'content-type', b'application/json') + response_headers = self._replace_header( + response_headers, self._ENCRYPT_RESPONSE_HEADER.encode('utf-8'), b'1' + ) + response_headers = self._replace_header( + response_headers, + self._ENCRYPT_ALG_HEADER.encode('utf-8'), + TransportCryptoUtil.get_response_envelope_algorithm().encode('utf-8'), + ) + response_headers = self._replace_header( + response_headers, + self._ENCRYPT_KID_HEADER.encode('utf-8'), + str(crypto_context['kid']).encode('utf-8'), + ) + response_headers = self._merge_response_headers( + response_headers, + self._build_monitor_headers( + request_mode='encrypted', + response_mode='encrypted', + crypto_status='ok', + kid=str(crypto_context['kid']), + ), + ) + await TransportCryptoMonitorUtil.record_encrypted_response(app, str(crypto_context['kid'])) + await send({**response_start_message, 'headers': response_headers}) + await send({'type': 'http.response.body', 'body': encrypted_body, 'more_body': False}) + + return _encrypt_response + + def _build_passthrough_response_observer( + self, + app: FastAPI | None, + send: Send, + request_mode: str, + crypto_status: str, + kid: str | None = None, + ) -> Callable[[Message], Awaitable[None]]: + """ + 构建明文响应观察器,为响应追加监控诊断头 + + :param send: ASGI send函数 + :param request_mode: 请求传输模式 + :param crypto_status: 当前传输层处理状态 + :param kid: 可选的密钥版本 + :return: 包装后的ASGI send函数 + """ + has_recorded_response = False + + async def _observe_response(message: Message) -> None: + nonlocal has_recorded_response + + if message['type'] == 'http.response.start': + if not has_recorded_response: + await TransportCryptoMonitorUtil.record_plain_response(app) + has_recorded_response = True + await send( + { + **message, + 'headers': self._merge_response_headers( + message.get('headers', []), + self._build_monitor_headers( + request_mode=request_mode, + response_mode='plain', + crypto_status=crypto_status, + kid=kid, + ), + ), + } + ) + return + + await send(message) + + return _observe_response + + def _build_crypto_context(self, decrypted_payload: DecryptedTransportEnvelope) -> dict[str, str | bytes | bool]: + """ + 从解密结果构建请求生命周期内的加密上下文 + + :param decrypted_payload: 解密后的请求信封对象 + :return: 请求加密上下文字典 + """ + return { + 'active': True, + 'kid': decrypted_payload.kid, + 'aes_key': decrypted_payload.aes_key, + } + + def _build_error_crypto_context( + self, + scope: Scope, + headers: Headers, + body: bytes, + ) -> dict[str, str | bytes | bool] | None: + """ + 尝试在解密失败场景下提取AES会话密钥,以便返回加密错误响应 + + :param scope: 当前ASGI请求作用域 + :param headers: 当前请求头对象 + :param body: 原始请求体字节串 + :return: 可用于构造加密错误响应的上下文字典,失败时返回None + """ + content_type = headers.get('content-type', '') + try: + query_envelope = self._extract_query_envelope(scope) + body_envelope = self._extract_body_envelope(content_type, body) + envelope = body_envelope or query_envelope + if envelope is None: + return None + TransportCryptoUtil._extract_and_validate_aad( + envelope, + expected_method=str(scope.get('method', '')).upper(), + expected_path=self._normalize_path(str(scope.get('path', ''))), + ) + return { + 'active': True, + 'kid': str(envelope['kid']), + 'aes_key': TransportCryptoUtil.decrypt_request_key(envelope), + } + except Exception: + return None + + def _extract_request_kid(self, scope: Scope, headers: Headers, body: bytes) -> str | None: + """ + 尝试从原始请求信封中提取密钥版本 + + :param scope: 当前ASGI请求作用域 + :param headers: 当前请求头对象 + :param body: 原始请求体字节串 + :return: 密钥版本,不存在时返回None + """ + content_type = headers.get('content-type', '') + try: + query_envelope = self._extract_query_envelope(scope) + body_envelope = self._extract_body_envelope(content_type, body) + envelope = body_envelope or query_envelope + except Exception: + return None + if envelope is None or not envelope.get('kid'): + return None + return str(envelope['kid']) + + @staticmethod + def _loads_json_mapping(payload: str) -> dict: + """ + 将JSON字符串解析为字典,并限制结果必须为JSON对象 + + :param payload: JSON字符串 + :return: 解析后的字典对象 + """ + json_payload = json.loads(payload) + if not isinstance(json_payload, dict): + raise ValueError('解密后的请求载荷必须为JSON对象') + return json_payload + + @staticmethod + async def _read_body(receive: Receive) -> bytes: + """ + 从ASGI receive中读取完整请求体 + + :param receive: ASGI receive函数 + :return: 完整请求体字节串 + """ + body_chunks: list[bytes] = [] + more_body = True + while more_body: + message = await receive() + if message['type'] != 'http.request': + continue + body_chunks.append(message.get('body', b'')) + more_body = message.get('more_body', False) + return b''.join(body_chunks) + + @staticmethod + def _build_receive(body: bytes) -> Receive: + """ + 根据指定请求体重建一次性可消费的ASGI receive函数 + + :param body: 需要回放的请求体字节串 + :return: 重建后的ASGI receive函数 + """ + has_been_called = False + + async def _receive() -> Message: + nonlocal has_been_called + if has_been_called: + return {'type': 'http.request', 'body': b'', 'more_body': False} + has_been_called = True + return {'type': 'http.request', 'body': body, 'more_body': False} + + return _receive + + @staticmethod + def _replace_header(headers: list[tuple[bytes, bytes]], key: bytes, value: bytes) -> list[tuple[bytes, bytes]]: + """ + 替换或新增指定响应头 + + :param headers: 原始请求/响应头列表 + :param key: 头名称 + :param value: 头值 + :return: 替换后的头列表 + """ + normalized_key = key.lower() + filtered_headers = [ + (header_key, header_value) for header_key, header_value in headers if header_key.lower() != normalized_key + ] + filtered_headers.append((key, value)) + return filtered_headers + + @staticmethod + def _remove_header(headers: list[tuple[bytes, bytes]], key: bytes) -> list[tuple[bytes, bytes]]: + """ + 删除指定请求头 + + :param headers: 原始请求头列表 + :param key: 头名称 + :return: 删除后的头列表 + """ + normalized_key = key.lower() + return [ + (header_key, header_value) for header_key, header_value in headers if header_key.lower() != normalized_key + ] + + @staticmethod + def _normalize_path(path: str) -> str: + """ + 标准化请求路径,剥离应用根路径前缀 + + :param path: 原始请求路径 + :return: 标准化后的业务路径 + """ + app_root_path = AppConfig.app_root_path + if app_root_path and path.startswith(app_root_path): + normalized_path = path[len(app_root_path) :] + return normalized_path or '/' + return path or '/' + + @classmethod + def _merge_response_headers( + cls, + headers: list[tuple[bytes, bytes]], + extra_headers: dict[str, str], + ) -> list[tuple[bytes, bytes]]: + """ + 将字符串响应头批量写回到原始headers列表 + + :param headers: 原始请求/响应头列表 + :param extra_headers: 需要追加的响应头 + :return: 合并后的响应头列表 + """ + merged_headers = headers + for header_key, header_value in extra_headers.items(): + merged_headers = cls._replace_header( + merged_headers, header_key.encode('utf-8'), header_value.encode('utf-8') + ) + return merged_headers + + @classmethod + def _build_monitor_headers( + cls, + request_mode: str, + response_mode: str, + crypto_status: str, + kid: str | None = None, + ) -> dict[str, str]: + """ + 构建传输层加解密监控响应头 + + :param request_mode: 请求传输模式 + :param response_mode: 响应传输模式 + :param crypto_status: 当前传输层处理状态 + :param kid: 可选的密钥版本 + :return: 监控响应头字典 + """ + headers = { + cls._MONITOR_REQUEST_MODE_HEADER: request_mode, + cls._MONITOR_RESPONSE_MODE_HEADER: response_mode, + cls._MONITOR_STATUS_HEADER: crypto_status, + } + if kid: + headers[cls._MONITOR_KID_HEADER] = kid + return headers + + @classmethod + async def _send_error_response( + cls, + scope: Scope, + receive: Receive, + send: Send, + message: str, + crypto_context: dict[str, str | bytes | bool] | None = None, + headers: dict[str, str] | None = None, + ) -> None: + """ + 发送错误响应,在存在AES会话密钥时优先返回加密错误响应 + + :param scope: 当前ASGI请求作用域 + :param receive: ASGI receive函数 + :param send: ASGI send函数 + :param message: 错误信息 + :param crypto_context: 可选的请求加密上下文 + :param headers: 需要追加的诊断响应头 + :return: None + """ + response_content = {'code': HttpStatusConstant.BAD_REQUEST, 'msg': message, 'success': False} + response = JSONResponse(status_code=HttpStatusConstant.BAD_REQUEST, content=response_content) + if crypto_context: + encrypted_body = TransportCryptoUtil.encrypt_response_body( + aes_key=crypto_context['aes_key'], + payload=json.dumps(response_content, ensure_ascii=False).encode('utf-8'), + kid=str(crypto_context['kid']), + method=str(scope.get('method', '')), + path=cls._normalize_path(str(scope.get('path', ''))), + ) + response.body = encrypted_body + response.init_headers() + response.headers[cls._ENCRYPT_RESPONSE_HEADER] = '1' + response.headers[cls._ENCRYPT_ALG_HEADER] = TransportCryptoUtil.get_response_envelope_algorithm() + response.headers[cls._ENCRYPT_KID_HEADER] = str(crypto_context['kid']) + if headers: + response.headers.update(headers) + await response(scope, receive, send) + + @staticmethod + def _classify_failure_reason(message: str) -> str: + """ + 根据异常信息归类传输层失败原因 + + :param message: 原始异常信息 + :return: 失败原因分类编码 + """ + if not message or message == '加密请求解析失败': + return 'decrypt_failed' + failure_reason_mapping = ( + ('method/path与当前接口不匹配', 'aad_mismatch'), + ('缺少合法的aad', 'aad_invalid'), + ('已过期', 'timestamp_expired'), + ('缺少必要字段', 'envelope_fields_missing'), + ('协议版本不受支持', 'protocol_version_invalid'), + ('算法不受支持', 'algorithm_invalid'), + ('未找到可解密的请求载荷', 'envelope_missing'), + ('密钥版本', 'kid_mismatch'), + ) + for reason_keyword, reason_code in failure_reason_mapping: + if reason_keyword in message: + return reason_code + if '重复请求' in message or '重放' in message: + return 'replay_detected' + return 'decrypt_failed' + + @classmethod + def _is_excluded_path(cls, path: str) -> bool: + """ + 判断当前路径是否在传输加密排除列表内 + + :param path: 当前请求路径 + :return: 是否命中排除列表 + """ + excluded_paths = [ + excluded_path.strip() + for excluded_path in TransportCryptoConfig.transport_crypto_exclude_paths.split(',') + if excluded_path.strip() + ] + return any(path == excluded_path or path.startswith(f'{excluded_path}/') for excluded_path in excluded_paths) + + @classmethod + def _is_required_path(cls, path: str) -> bool: + """ + 判断当前路径是否在强制加密列表内 + + :param path: 当前请求路径 + :return: 是否命中强制加密列表 + """ + required_paths = [ + required_path.strip() + for required_path in TransportCryptoConfig.transport_crypto_required_paths.split(',') + if required_path.strip() + ] + if not required_paths: + return False + return any(path == required_path or path.startswith(f'{required_path}/') for required_path in required_paths) + + @classmethod + def _is_enabled_path(cls, path: str) -> bool: + """ + 判断当前路径是否在启用传输加密的列表内 + + :param path: 当前请求路径 + :return: 当前路径是否启用传输加密 + """ + enabled_paths = [ + enabled_path.strip() + for enabled_path in TransportCryptoConfig.transport_crypto_enabled_paths.split(',') + if enabled_path.strip() + ] + if not enabled_paths: + return True + return any(path == enabled_path or path.startswith(f'{enabled_path}/') for enabled_path in enabled_paths) + + +def add_transport_crypto_middleware(app: ASGIApp) -> None: + """ + 添加传输层加解密中间件 + + :param app: FastAPI/Starlette应用对象 + :return: None + """ + app.add_middleware(TransportCryptoMiddleware) diff --git a/shierfeng-fastapi-backend/module_admin/controller/cache_controller.py b/shierfeng-fastapi-backend/module_admin/controller/cache_controller.py new file mode 100644 index 0000000..8cb11d7 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/cache_controller.py @@ -0,0 +1,129 @@ +from typing import Annotated + +from fastapi import Path, Request, Response + +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.router import APIRouterPro +from common.vo import DataResponseModel, ResponseBaseModel +from module_admin.entity.vo.cache_vo import CacheInfoModel, CacheMonitorModel +from module_admin.service.cache_service import CacheService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +cache_controller = APIRouterPro( + prefix='/monitor/cache', order_num=15, tags=['系统监控-缓存监控'], dependencies=[PreAuthDependency()] +) + + +@cache_controller.get( + '', + summary='获取缓存监控信息接口', + description='用于获取缓存监控信息', + response_model=DataResponseModel[CacheMonitorModel], + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +async def get_monitor_cache_info(request: Request) -> Response: + # 获取全量数据 + cache_info_query_result = await CacheService.get_cache_monitor_statistical_info_services(request) + logger.info('获取成功') + + return ResponseUtil.success(data=cache_info_query_result) + + +@cache_controller.get( + '/getNames', + summary='获取缓存名称列表接口', + description='用于获取缓存名称列表', + response_model=DataResponseModel[list[CacheInfoModel]], + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +async def get_monitor_cache_name(request: Request) -> Response: + # 获取全量数据 + cache_name_list_result = await CacheService.get_cache_monitor_cache_name_services() + logger.info('获取成功') + + return ResponseUtil.success(data=cache_name_list_result) + + +@cache_controller.get( + '/getKeys/{cache_name}', + summary='获取缓存键列表接口', + description='用于获取指定缓存名称下的所有缓存键列表', + response_model=DataResponseModel[list[str]], + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +async def get_monitor_cache_key(request: Request, cache_name: Annotated[str, Path(description='缓存名称')]) -> Response: + # 获取全量数据 + cache_key_list_result = await CacheService.get_cache_monitor_cache_key_services(request, cache_name) + logger.info('获取成功') + + return ResponseUtil.success(data=cache_key_list_result) + + +@cache_controller.get( + '/getValue/{cache_name}/{cache_key}', + summary='获取缓存值接口', + description='用于获取指定缓存名称下的指定缓存键对应的值', + response_model=DataResponseModel[CacheInfoModel], + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +async def get_monitor_cache_value( + request: Request, + cache_name: Annotated[str, Path(description='缓存名称')], + cache_key: Annotated[str, Path(description='缓存键')], +) -> Response: + # 获取全量数据 + cache_value_list_result = await CacheService.get_cache_monitor_cache_value_services(request, cache_name, cache_key) + logger.info('获取成功') + + return ResponseUtil.success(data=cache_value_list_result) + + +@cache_controller.delete( + '/clearCacheName/{cache_name}', + summary='清除缓存名称接口', + description='用于清除指定缓存名称下的所有缓存键值对', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_CACHE_CLEAR_NAME, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +async def clear_monitor_cache_name( + request: Request, cache_name: Annotated[str, Path(description='缓存名称')] +) -> Response: + clear_cache_name_result = await CacheService.clear_cache_monitor_cache_name_services(request, cache_name) + logger.info(clear_cache_name_result.message) + + return ResponseUtil.success(msg=clear_cache_name_result.message) + + +@cache_controller.delete( + '/clearCacheKey/{cache_key}', + summary='清除缓存键接口', + description='用于清除指定缓存键对应的值', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_CACHE_CLEAR_KEY, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +async def clear_monitor_cache_key(request: Request, cache_key: Annotated[str, Path(description='缓存键')]) -> Response: + clear_cache_key_result = await CacheService.clear_cache_monitor_cache_key_services(request, cache_key) + logger.info(clear_cache_key_result.message) + + return ResponseUtil.success(msg=clear_cache_key_result.message) + + +@cache_controller.delete( + '/clearCacheAll', + summary='清除所有缓存接口', + description='用于清除所有缓存键值对', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:cache:list')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_CACHE_CLEAR_ALL, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +async def clear_monitor_cache_all(request: Request) -> Response: + clear_cache_all_result = await CacheService.clear_cache_monitor_all_services(request) + logger.info(clear_cache_all_result.message) + + return ResponseUtil.success(msg=clear_cache_all_result.message) diff --git a/shierfeng-fastapi-backend/module_admin/controller/captcha_controller.py b/shierfeng-fastapi-backend/module_admin/controller/captcha_controller.py new file mode 100644 index 0000000..5e3f28a --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/captcha_controller.py @@ -0,0 +1,46 @@ +import uuid +from datetime import timedelta + +from fastapi import Request, Response + +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.constant import ApiNamespace +from common.enums import RedisInitKeyConfig +from common.router import APIRouterPro +from common.vo import DynamicResponseModel +from module_admin.entity.vo.login_vo import CaptchaCode +from module_admin.service.captcha_service import CaptchaService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +captcha_controller = APIRouterPro(order_num=2, tags=['验证码模块']) + + +@captcha_controller.get( + '/captchaImage', + summary='获取图片验证码接口', + description='用于获取图片验证码', + response_model=DynamicResponseModel[CaptchaCode], +) +@ApiRateLimit(namespace=ApiNamespace.CAPTCHA_IMAGE, preset=ApiRateLimitPreset.ANON_AUTH_CAPTCHA) +async def get_captcha_image(request: Request) -> Response: + captcha_enabled = ( + await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.captchaEnabled') == 'true' + ) + register_enabled = ( + await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.registerUser') == 'true' + ) + session_id = str(uuid.uuid4()) + captcha_result = await CaptchaService.create_captcha_image_service() + image = captcha_result[0] + computed_result = captcha_result[1] + await request.app.state.redis.set( + f'{RedisInitKeyConfig.CAPTCHA_CODES.key}:{session_id}', computed_result, ex=timedelta(minutes=2) + ) + logger.info(f'编号为{session_id}的会话获取图片验证码成功') + + return ResponseUtil.success( + model_content=CaptchaCode( + captchaEnabled=captcha_enabled, registerEnabled=register_enabled, img=image, uuid=session_id + ) + ) diff --git a/shierfeng-fastapi-backend/module_admin/controller/common_controller.py b/shierfeng-fastapi-backend/module_admin/controller/common_controller.py new file mode 100644 index 0000000..bfa4282 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/common_controller.py @@ -0,0 +1,77 @@ +from typing import Annotated + +from fastapi import BackgroundTasks, File, Query, Request, Response, UploadFile +from fastapi.responses import StreamingResponse + +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.router import APIRouterPro +from common.vo import DynamicResponseModel +from module_admin.entity.vo.common_vo import UploadResponseModel +from module_admin.service.common_service import CommonService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +common_controller = APIRouterPro(prefix='/common', order_num=16, tags=['通用模块'], dependencies=[PreAuthDependency()]) + + +@common_controller.post( + '/upload', + summary='通用文件上传接口', + description='用于上传文件', + response_model=DynamicResponseModel[UploadResponseModel], +) +@ApiRateLimit(namespace=ApiNamespace.COMMON_UPLOAD, preset=ApiRateLimitPreset.COMMON_UPLOAD) +async def common_upload(request: Request, file: Annotated[UploadFile, File(...)]) -> Response: + upload_result = await CommonService.upload_service(request, file) + logger.info('上传成功') + + return ResponseUtil.success(model_content=upload_result.result) + + +@common_controller.get( + '/download', + summary='通用文件下载接口', + description='用于下载下载目录中的文件', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, +) +async def common_download( + request: Request, + background_tasks: BackgroundTasks, + file_name: Annotated[str, Query(alias='fileName')], + delete: Annotated[bool, Query()], +) -> Response: + download_result = await CommonService.download_services(background_tasks, file_name, delete) + logger.info(download_result.message) + + return ResponseUtil.streaming(data=download_result.result) + + +@common_controller.get( + '/download/resource', + summary='通用资源文件下载接口', + description='用于下载上传目录中的资源文件', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, +) +async def common_download_resource(request: Request, resource: Annotated[str, Query()]) -> Response: + download_resource_result = await CommonService.download_resource_services(resource) + logger.info(download_resource_result.message) + + return ResponseUtil.streaming(data=download_resource_result.result) diff --git a/shierfeng-fastapi-backend/module_admin/controller/config_controller.py b/shierfeng-fastapi-backend/module_admin/controller/config_controller.py new file mode 100644 index 0000000..bbe6cf2 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/config_controller.py @@ -0,0 +1,201 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel, DeleteConfigModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.config_service import ConfigService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +config_controller = APIRouterPro( + prefix='/system/config', order_num=9, tags=['系统管理-参数管理'], dependencies=[PreAuthDependency()] +) + + +@config_controller.get( + '/list', + summary='获取参数分页列表接口', + description='用于获取参数分页列表', + response_model=PageResponseModel[ConfigModel], + dependencies=[UserInterfaceAuthDependency('system:config:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_CONFIG_LIST) +async def get_system_config_list( + request: Request, + config_page_query: Annotated[ConfigPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + config_page_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=config_page_query_result) + + +@config_controller.post( + '', + summary='新增参数接口', + description='用于新增参数', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:config:add')], +) +@ValidateFields(validate_model='add_config') +@ApiCacheEvict(namespaces=ApiGroup.CONFIG_MUTATION) +@Log(title='参数管理', business_type=BusinessType.INSERT) +async def add_system_config( + request: Request, + add_config: ConfigModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_config.create_by = current_user.user.user_name + add_config.create_time = datetime.now() + add_config.update_by = current_user.user.user_name + add_config.update_time = datetime.now() + add_config_result = await ConfigService.add_config_services(request, query_db, add_config) + logger.info(add_config_result.message) + + return ResponseUtil.success(msg=add_config_result.message) + + +@config_controller.put( + '', + summary='编辑参数接口', + description='用于编辑参数', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:config:edit')], +) +@ValidateFields(validate_model='edit_config') +@ApiCacheEvict(namespaces=ApiGroup.CONFIG_MUTATION) +@Log(title='参数管理', business_type=BusinessType.UPDATE) +async def edit_system_config( + request: Request, + edit_config: ConfigModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_config.update_by = current_user.user.user_name + edit_config.update_time = datetime.now() + edit_config_result = await ConfigService.edit_config_services(request, query_db, edit_config) + logger.info(edit_config_result.message) + + return ResponseUtil.success(msg=edit_config_result.message) + + +@config_controller.delete( + '/refreshCache', + summary='刷新参数缓存接口', + description='用于刷新参数缓存', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:config:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_CONFIG_REFRESH_CACHE, preset=ApiRateLimitPreset.USER_COMMON_MUTATION) +@Log(title='参数管理', business_type=BusinessType.UPDATE) +async def refresh_system_config( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + refresh_config_result = await ConfigService.refresh_sys_config_services(request, query_db) + logger.info(refresh_config_result.message) + + return ResponseUtil.success(msg=refresh_config_result.message) + + +@config_controller.delete( + '/{config_ids}', + summary='删除参数接口', + description='用于删除参数', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:config:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.CONFIG_MUTATION) +@Log(title='参数管理', business_type=BusinessType.DELETE) +async def delete_system_config( + request: Request, + config_ids: Annotated[str, Path(description='需要删除的参数主键')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_config = DeleteConfigModel(configIds=config_ids) + delete_config_result = await ConfigService.delete_config_services(request, query_db, delete_config) + logger.info(delete_config_result.message) + + return ResponseUtil.success(msg=delete_config_result.message) + + +@config_controller.get( + '/{config_id}', + summary='获取参数详情接口', + description='用于获取指定参数的详细信息', + response_model=DataResponseModel[ConfigModel], + dependencies=[UserInterfaceAuthDependency('system:config:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_CONFIG_DETAIL) +async def query_detail_system_config( + request: Request, + config_id: Annotated[int, Path(description='参数主键')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + config_detail_result = await ConfigService.config_detail_services(query_db, config_id) + logger.info(f'获取config_id为{config_id}的信息成功') + + return ResponseUtil.success(data=config_detail_result) + + +@config_controller.get( + '/configKey/{config_key}', + summary='根据参数键查询参数值接口', + description='用于根据参数键从缓存中查询参数值', + response_model=ResponseBaseModel, +) +async def query_system_config(request: Request, config_key: str) -> Response: + # 获取全量数据 + config_query_result = await ConfigService.query_config_list_from_cache_services(request.app.state.redis, config_key) + logger.info('获取成功') + + return ResponseUtil.success(msg=config_query_result) + + +@config_controller.post( + '/export', + summary='导出参数列表接口', + description='用于导出当前符合查询条件的参数列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回参数列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:config:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_CONFIG_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='参数管理', business_type=BusinessType.EXPORT) +async def export_system_config_list( + request: Request, + config_page_query: Annotated[ConfigPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + config_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=False) + config_export_result = await ConfigService.export_config_list_services(config_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(config_export_result)) diff --git a/shierfeng-fastapi-backend/module_admin/controller/dept_controller.py b/shierfeng-fastapi-backend/module_admin/controller/dept_controller.py new file mode 100644 index 0000000..d40d946 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/dept_controller.py @@ -0,0 +1,175 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from pydantic_validation_decorator import ValidateFields +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.aspect.data_scope import DataScopeDependency +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, ResponseBaseModel +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.vo.dept_vo import DeleteDeptModel, DeptModel, DeptQueryModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.dept_service import DeptService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +dept_controller = APIRouterPro( + prefix='/system/dept', order_num=6, tags=['系统管理-部门管理'], dependencies=[PreAuthDependency()] +) + + +@dept_controller.get( + '/list/exclude/{dept_id}', + summary='获取编辑部门的下拉树接口', + description='用于获取部门下拉树,不包含指定部门及其子部门', + response_model=DataResponseModel[list[DeptModel]], + dependencies=[UserInterfaceAuthDependency('system:dept:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DEPT_EDIT_TREE) +async def get_system_dept_tree_for_edit_option( + request: Request, + dept_id: Annotated[int, Path(description='部门id')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + dept_query = DeptModel(deptId=dept_id) + dept_query_result = await DeptService.get_dept_for_edit_option_services(query_db, dept_query, data_scope_sql) + logger.info('获取成功') + + return ResponseUtil.success(data=dept_query_result) + + +@dept_controller.get( + '/list', + summary='获取部门列表接口', + description='用于获取部门列表', + response_model=DataResponseModel[list[DeptModel]], + dependencies=[UserInterfaceAuthDependency('system:dept:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DEPT_LIST) +async def get_system_dept_list( + request: Request, + dept_query: Annotated[DeptQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + dept_query_result = await DeptService.get_dept_list_services(query_db, dept_query, data_scope_sql) + logger.info('获取成功') + + return ResponseUtil.success(data=dept_query_result) + + +@dept_controller.post( + '', + summary='新增部门接口', + description='用于新增部门', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dept:add')], +) +@ValidateFields(validate_model='add_dept') +@ApiCacheEvict(namespaces=ApiGroup.DATA_SCOPE_MUTATION) +@Log(title='部门管理', business_type=BusinessType.INSERT) +async def add_system_dept( + request: Request, + add_dept: DeptModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_dept.create_by = current_user.user.user_name + add_dept.create_time = datetime.now() + add_dept.update_by = current_user.user.user_name + add_dept.update_time = datetime.now() + add_dept_result = await DeptService.add_dept_services(query_db, add_dept) + logger.info(add_dept_result.message) + + return ResponseUtil.success(msg=add_dept_result.message) + + +@dept_controller.put( + '', + summary='编辑部门接口', + description='用于编辑部门', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dept:edit')], +) +@ValidateFields(validate_model='edit_dept') +@ApiCacheEvict(namespaces=ApiGroup.DATA_SCOPE_MUTATION) +@Log(title='部门管理', business_type=BusinessType.UPDATE) +async def edit_system_dept( + request: Request, + edit_dept: DeptModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await DeptService.check_dept_data_scope_services(query_db, edit_dept.dept_id, data_scope_sql) + edit_dept.update_by = current_user.user.user_name + edit_dept.update_time = datetime.now() + edit_dept_result = await DeptService.edit_dept_services(query_db, edit_dept) + logger.info(edit_dept_result.message) + + return ResponseUtil.success(msg=edit_dept_result.message) + + +@dept_controller.delete( + '/{dept_ids}', + summary='删除部门接口', + description='用于删除部门', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dept:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.DATA_SCOPE_MUTATION) +@Log(title='部门管理', business_type=BusinessType.DELETE) +async def delete_system_dept( + request: Request, + dept_ids: Annotated[str, Path(description='需要删除的部门id')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + dept_id_list = dept_ids.split(',') if dept_ids else [] + if dept_id_list: + for dept_id in dept_id_list: + if not current_user.user.admin: + await DeptService.check_dept_data_scope_services(query_db, int(dept_id), data_scope_sql) + delete_dept = DeleteDeptModel(deptIds=dept_ids) + delete_dept.update_by = current_user.user.user_name + delete_dept.update_time = datetime.now() + delete_dept_result = await DeptService.delete_dept_services(query_db, delete_dept) + logger.info(delete_dept_result.message) + + return ResponseUtil.success(msg=delete_dept_result.message) + + +@dept_controller.get( + '/{dept_id}', + summary='获取部门详情接口', + description='用于获取指定部门的详情信息', + response_model=DataResponseModel[DeptModel], + dependencies=[UserInterfaceAuthDependency('system:dept:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DEPT_DETAIL) +async def query_detail_system_dept( + request: Request, + dept_id: Annotated[int, Path(description='部门id')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await DeptService.check_dept_data_scope_services(query_db, dept_id, data_scope_sql) + detail_dept_result = await DeptService.dept_detail_services(query_db, dept_id) + logger.info(f'获取dept_id为{dept_id}的信息成功') + + return ResponseUtil.success(data=detail_dept_result) diff --git a/shierfeng-fastapi-backend/module_admin/controller/dict_controller.py b/shierfeng-fastapi-backend/module_admin/controller/dict_controller.py new file mode 100644 index 0000000..cd72983 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/dict_controller.py @@ -0,0 +1,377 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.dict_vo import ( + DeleteDictDataModel, + DeleteDictTypeModel, + DictDataModel, + DictDataPageQueryModel, + DictTypeModel, + DictTypePageQueryModel, +) +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.dict_service import DictDataService, DictTypeService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +dict_controller = APIRouterPro( + prefix='/system/dict', order_num=8, tags=['系统管理-字典管理'], dependencies=[PreAuthDependency()] +) + + +@dict_controller.get( + '/type/list', + summary='获取字典类型分页列表接口', + description='用于获取字典类型分页列表', + response_model=PageResponseModel[DictTypeModel], + dependencies=[UserInterfaceAuthDependency('system:dict:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DICT_TYPE_LIST) +async def get_system_dict_type_list( + request: Request, + dict_type_page_query: Annotated[DictTypePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + dict_type_page_query_result = await DictTypeService.get_dict_type_list_services( + query_db, dict_type_page_query, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=dict_type_page_query_result) + + +@dict_controller.post( + '/type', + summary='新增字典类型接口', + description='用于新增字典类型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:add')], +) +@ValidateFields(validate_model='add_dict_type') +@ApiCacheEvict(namespaces=ApiGroup.DICT_TYPE_MUTATION) +@Log(title='字典类型', business_type=BusinessType.INSERT) +async def add_system_dict_type( + request: Request, + add_dict_type: DictTypeModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_dict_type.create_by = current_user.user.user_name + add_dict_type.create_time = datetime.now() + add_dict_type.update_by = current_user.user.user_name + add_dict_type.update_time = datetime.now() + add_dict_type_result = await DictTypeService.add_dict_type_services(request, query_db, add_dict_type) + logger.info(add_dict_type_result.message) + + return ResponseUtil.success(msg=add_dict_type_result.message) + + +@dict_controller.put( + '/type', + summary='编辑字典类型接口', + description='用于编辑字典类型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:edit')], +) +@ValidateFields(validate_model='edit_dict_type') +@ApiCacheEvict(namespaces=ApiGroup.DICT_TYPE_MUTATION) +@Log(title='字典类型', business_type=BusinessType.UPDATE) +async def edit_system_dict_type( + request: Request, + edit_dict_type: DictTypeModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_dict_type.update_by = current_user.user.user_name + edit_dict_type.update_time = datetime.now() + edit_dict_type_result = await DictTypeService.edit_dict_type_services(request, query_db, edit_dict_type) + logger.info(edit_dict_type_result.message) + + return ResponseUtil.success(msg=edit_dict_type_result.message) + + +@dict_controller.delete( + '/type/refreshCache', + summary='刷新字典缓存接口', + description='用于刷新字典缓存', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_DICT_REFRESH_CACHE, preset=ApiRateLimitPreset.USER_COMMON_MUTATION) +@Log(title='字典类型', business_type=BusinessType.UPDATE) +async def refresh_system_dict(request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()]) -> Response: + refresh_dict_result = await DictTypeService.refresh_sys_dict_services(request, query_db) + logger.info(refresh_dict_result.message) + + return ResponseUtil.success(msg=refresh_dict_result.message) + + +@dict_controller.delete( + '/type/{dict_ids}', + summary='删除字典类型接口', + description='用于删除字典类型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.DICT_TYPE_MUTATION) +@Log(title='字典类型', business_type=BusinessType.DELETE) +async def delete_system_dict_type( + request: Request, + dict_ids: Annotated[str, Path(description='需要删除的字典主键')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_dict_type = DeleteDictTypeModel(dictIds=dict_ids) + delete_dict_type_result = await DictTypeService.delete_dict_type_services(request, query_db, delete_dict_type) + logger.info(delete_dict_type_result.message) + + return ResponseUtil.success(msg=delete_dict_type_result.message) + + +@dict_controller.get( + '/type/optionselect', + summary='获取字典类型下拉列表接口', + description='用于获取字典类型下拉列表', + response_model=DataResponseModel[list[DictTypeModel]], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DICT_TYPE_OPTIONS) +async def query_system_dict_type_options( + request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()] +) -> Response: + dict_type_query_result = await DictTypeService.get_dict_type_list_services( + query_db, DictTypePageQueryModel(), is_page=False + ) + logger.info('获取成功') + + return ResponseUtil.success(data=dict_type_query_result) + + +@dict_controller.get( + '/type/{dict_id}', + summary='获取字典类型详情接口', + description='用于获取指定字典类型的详细信息', + response_model=DataResponseModel[DictTypeModel], + dependencies=[UserInterfaceAuthDependency('system:dict:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DICT_TYPE_DETAIL) +async def query_detail_system_dict_type( + request: Request, + dict_id: Annotated[int, Path(description='字典主键')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + dict_type_detail_result = await DictTypeService.dict_type_detail_services(query_db, dict_id) + logger.info(f'获取dict_id为{dict_id}的信息成功') + + return ResponseUtil.success(data=dict_type_detail_result) + + +@dict_controller.post( + '/type/export', + summary='导出字典类型列表接口', + description='用于导出当前符合查询条件的字典类型列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回字典类型列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:dict:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_DICT_TYPE_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='字典类型', business_type=BusinessType.EXPORT) +async def export_system_dict_type_list( + request: Request, + dict_type_page_query: Annotated[DictTypePageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + dict_type_query_result = await DictTypeService.get_dict_type_list_services( + query_db, dict_type_page_query, is_page=False + ) + dict_type_export_result = await DictTypeService.export_dict_type_list_services(dict_type_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(dict_type_export_result)) + + +@dict_controller.get( + '/data/type/{dict_type}', + summary='获取指定字典类型的数据列表接口', + description='用于从缓存中获取指定字典类型的所有数据项', + response_model=DataResponseModel[list[DictDataModel]], +) +async def query_system_dict_type_data( + request: Request, + dict_type: Annotated[str, Path(description='字典类型')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + dict_data_query_result = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type + ) + logger.info('获取成功') + + return ResponseUtil.success(data=dict_data_query_result) + + +@dict_controller.get( + '/data/list', + summary='获取字典数据分页列表接口', + description='用于获取字典数据分页列表', + response_model=PageResponseModel[DictDataModel], + dependencies=[UserInterfaceAuthDependency('system:dict:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DICT_DATA_LIST) +async def get_system_dict_data_list( + request: Request, + dict_data_page_query: Annotated[DictDataPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + dict_data_page_query_result = await DictDataService.get_dict_data_list_services( + query_db, dict_data_page_query, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=dict_data_page_query_result) + + +@dict_controller.post( + '/data', + summary='新增字典数据接口', + description='用于新增字典数据', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:add')], +) +@ValidateFields(validate_model='add_dict_data') +@ApiCacheEvict(namespaces=ApiGroup.DICT_DATA_MUTATION) +@Log(title='字典数据', business_type=BusinessType.INSERT) +async def add_system_dict_data( + request: Request, + add_dict_data: DictDataModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_dict_data.create_by = current_user.user.user_name + add_dict_data.create_time = datetime.now() + add_dict_data.update_by = current_user.user.user_name + add_dict_data.update_time = datetime.now() + add_dict_data_result = await DictDataService.add_dict_data_services(request, query_db, add_dict_data) + logger.info(add_dict_data_result.message) + + return ResponseUtil.success(msg=add_dict_data_result.message) + + +@dict_controller.put( + '/data', + summary='编辑字典数据接口', + description='用于编辑字典数据', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:edit')], +) +@ValidateFields(validate_model='edit_dict_data') +@ApiCacheEvict(namespaces=ApiGroup.DICT_DATA_MUTATION) +@Log(title='字典数据', business_type=BusinessType.UPDATE) +async def edit_system_dict_data( + request: Request, + edit_dict_data: DictDataModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_dict_data.update_by = current_user.user.user_name + edit_dict_data.update_time = datetime.now() + edit_dict_data_result = await DictDataService.edit_dict_data_services(request, query_db, edit_dict_data) + logger.info(edit_dict_data_result.message) + + return ResponseUtil.success(msg=edit_dict_data_result.message) + + +@dict_controller.delete( + '/data/{dict_codes}', + summary='删除字典数据接口', + description='用于删除字典数据', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:dict:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.DICT_DATA_MUTATION) +@Log(title='字典数据', business_type=BusinessType.DELETE) +async def delete_system_dict_data( + request: Request, + dict_codes: Annotated[str, Path(description='需要删除的字典编码')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_dict_data = DeleteDictDataModel(dictCodes=dict_codes) + delete_dict_data_result = await DictDataService.delete_dict_data_services(request, query_db, delete_dict_data) + logger.info(delete_dict_data_result.message) + + return ResponseUtil.success(msg=delete_dict_data_result.message) + + +@dict_controller.get( + '/data/{dict_code}', + summary='获取字典数据详情接口', + description='用于获取指定字典数据的详细信息', + response_model=DataResponseModel[DictDataModel], + dependencies=[UserInterfaceAuthDependency('system:dict:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_DICT_DATA_DETAIL) +async def query_detail_system_dict_data( + request: Request, + dict_code: Annotated[int, Path(description='字典编码')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + detail_dict_data_result = await DictDataService.dict_data_detail_services(query_db, dict_code) + logger.info(f'获取dict_code为{dict_code}的信息成功') + + return ResponseUtil.success(data=detail_dict_data_result) + + +@dict_controller.post( + '/data/export', + summary='导出字典数据列表接口', + description='用于导出当前符合查询条件的字典数据列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回字典数据列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:dict:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_DICT_DATA_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='字典数据', business_type=BusinessType.EXPORT) +async def export_system_dict_data_list( + request: Request, + dict_data_page_query: Annotated[DictDataPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + dict_data_query_result = await DictDataService.get_dict_data_list_services( + query_db, dict_data_page_query, is_page=False + ) + dict_data_export_result = await DictDataService.export_dict_data_list_services(dict_data_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(dict_data_export_result)) diff --git a/shierfeng-fastapi-backend/module_admin/controller/job_controller.py b/shierfeng-fastapi-backend/module_admin/controller/job_controller.py new file mode 100644 index 0000000..38db601 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/job_controller.py @@ -0,0 +1,318 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.job_vo import ( + DeleteJobLogModel, + DeleteJobModel, + EditJobModel, + JobLogModel, + JobLogPageQueryModel, + JobModel, + JobPageQueryModel, +) +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.job_log_service import JobLogService +from module_admin.service.job_service import JobService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +job_controller = APIRouterPro( + prefix='/monitor', order_num=13, tags=['系统监控-定时任务'], dependencies=[PreAuthDependency()] +) + + +@job_controller.get( + '/job/list', + summary='获取定时任务分页列表接口', + description='用于获取定时任务分页列表', + response_model=PageResponseModel[JobModel], + dependencies=[UserInterfaceAuthDependency('monitor:job:list')], +) +@ApiCache(namespace=ApiNamespace.MONITOR_JOB_LIST) +async def get_system_job_list( + request: Request, + job_page_query: Annotated[JobPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + job_page_query_result = await JobService.get_job_list_services(query_db, job_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=job_page_query_result) + + +@job_controller.post( + '/job', + summary='新增定时任务接口', + description='用于新增定时任务', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:add')], +) +@ValidateFields(validate_model='add_job') +@ApiCacheEvict(namespaces=ApiGroup.JOB_MUTATION) +@Log(title='定时任务', business_type=BusinessType.INSERT) +async def add_system_job( + request: Request, + add_job: JobModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_job.create_by = current_user.user.user_name + add_job.create_time = datetime.now() + add_job.update_by = current_user.user.user_name + add_job.update_time = datetime.now() + add_job_result = await JobService.add_job_services(query_db, add_job) + logger.info(add_job_result.message) + + return ResponseUtil.success(msg=add_job_result.message) + + +@job_controller.put( + '/job', + summary='编辑定时任务接口', + description='用于编辑定时任务', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:edit')], +) +@ValidateFields(validate_model='edit_job') +@ApiCacheEvict(namespaces=ApiGroup.JOB_MUTATION) +@Log(title='定时任务', business_type=BusinessType.UPDATE) +async def edit_system_job( + request: Request, + edit_job: EditJobModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_job.update_by = current_user.user.user_name + edit_job.update_time = datetime.now() + edit_job_result = await JobService.edit_job_services(query_db, edit_job) + logger.info(edit_job_result.message) + + return ResponseUtil.success(msg=edit_job_result.message) + + +@job_controller.put( + '/job/changeStatus', + summary='修改定时任务状态接口', + description='用于修改定时任务状态', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')], +) +@ApiCacheEvict(namespaces=ApiGroup.JOB_MUTATION) +@Log(title='定时任务', business_type=BusinessType.UPDATE) +async def change_system_job_status( + request: Request, + change_job: EditJobModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_job = EditJobModel( + jobId=change_job.job_id, + status=change_job.status, + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + type='status', + ) + edit_job_result = await JobService.edit_job_services(query_db, edit_job) + logger.info(edit_job_result.message) + + return ResponseUtil.success(msg=edit_job_result.message) + + +@job_controller.put( + '/job/run', + summary='执行定时任务接口', + description='用于执行指定的定时任务', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_RUN, preset=ApiRateLimitPreset.USER_RESOURCE_EXECUTION) +@ApiCacheEvict(namespaces=ApiGroup.JOB_MUTATION) +@Log(title='定时任务', business_type=BusinessType.UPDATE) +async def execute_system_job( + request: Request, + execute_job: JobModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + execute_job_result = await JobService.execute_job_once_services(query_db, execute_job) + logger.info(execute_job_result.message) + + return ResponseUtil.success(msg=execute_job_result.message) + + +@job_controller.delete( + '/job/{job_ids}', + summary='删除定时任务接口', + description='用于删除定时任务', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_DELETE, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@ApiCacheEvict(namespaces=ApiGroup.JOB_MUTATION) +@Log(title='定时任务', business_type=BusinessType.DELETE) +async def delete_system_job( + request: Request, + job_ids: Annotated[str, Path(description='需要删除的定时任务ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_job = DeleteJobModel(jobIds=job_ids) + delete_job_result = await JobService.delete_job_services(query_db, delete_job) + logger.info(delete_job_result.message) + + return ResponseUtil.success(msg=delete_job_result.message) + + +@job_controller.get( + '/job/{job_id}', + summary='获取定时任务详情接口', + description='用于获取指定定时任务的详情信息', + response_model=DataResponseModel[JobModel], + dependencies=[UserInterfaceAuthDependency('monitor:job:query')], +) +@ApiCache(namespace=ApiNamespace.MONITOR_JOB_DETAIL) +async def query_detail_system_job( + request: Request, + job_id: Annotated[int, Path(description='任务ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + job_detail_result = await JobService.job_detail_services(query_db, job_id) + logger.info(f'获取job_id为{job_id}的信息成功') + + return ResponseUtil.success(data=job_detail_result) + + +@job_controller.post( + '/job/export', + summary='导出定时任务列表接口', + description='用于导出当前符合查询条件的定时任务列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回定时任务列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('monitor:job:export')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='定时任务', business_type=BusinessType.EXPORT) +async def export_system_job_list( + request: Request, + job_page_query: Annotated[JobPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + job_query_result = await JobService.get_job_list_services(query_db, job_page_query, is_page=False) + job_export_result = await JobService.export_job_list_services(request, job_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(job_export_result)) + + +@job_controller.get( + '/jobLog/list', + summary='获取定时任务调度日志分页列表接口', + description='用于获取定时任务调度日志分页列表', + response_model=PageResponseModel[JobLogModel], + dependencies=[UserInterfaceAuthDependency('monitor:job:list')], +) +async def get_system_job_log_list( + request: Request, + job_log_page_query: Annotated[JobLogPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + job_log_page_query_result = await JobLogService.get_job_log_list_services( + query_db, job_log_page_query, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=job_log_page_query_result) + + +@job_controller.delete( + '/jobLog/clean', + summary='清空定时任务调度日志接口', + description='用于清空所有定时任务调度日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_LOG_CLEAN, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='定时任务调度日志', business_type=BusinessType.CLEAN) +async def clear_system_job_log( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + clear_job_log_result = await JobLogService.clear_job_log_services(query_db) + logger.info(clear_job_log_result.message) + + return ResponseUtil.success(msg=clear_job_log_result.message) + + +@job_controller.delete( + '/jobLog/{job_log_ids}', + summary='删除定时任务调度日志接口', + description='用于删除定时任务调度日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_LOG_DELETE, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='定时任务调度日志', business_type=BusinessType.DELETE) +async def delete_system_job_log( + request: Request, + job_log_ids: Annotated[str, Path(description='需要删除的定时任务日志ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_job_log = DeleteJobLogModel(jobLogIds=job_log_ids) + delete_job_log_result = await JobLogService.delete_job_log_services(query_db, delete_job_log) + logger.info(delete_job_log_result.message) + + return ResponseUtil.success(msg=delete_job_log_result.message) + + +@job_controller.post( + '/jobLog/export', + summary='导出定时任务调度日志列表接口', + description='用于导出当前符合查询条件的定时任务调度日志列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回定时任务日志列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('monitor:job:export')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_JOB_LOG_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='定时任务调度日志', business_type=BusinessType.EXPORT) +async def export_system_job_log_list( + request: Request, + job_log_page_query: Annotated[JobLogPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + job_log_query_result = await JobLogService.get_job_log_list_services(query_db, job_log_page_query, is_page=False) + job_log_export_result = await JobLogService.export_job_log_list_services(request, job_log_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(job_log_export_result)) diff --git a/shierfeng-fastapi-backend/module_admin/controller/log_controller.py b/shierfeng-fastapi-backend/module_admin/controller/log_controller.py new file mode 100644 index 0000000..e84d0f8 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/log_controller.py @@ -0,0 +1,241 @@ +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.log_vo import ( + DeleteLoginLogModel, + DeleteOperLogModel, + LogininforModel, + LoginLogPageQueryModel, + OperLogModel, + OperLogPageQueryModel, + UnlockUser, +) +from module_admin.service.log_service import LoginLogService, OperationLogService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +log_controller = APIRouterPro( + prefix='/monitor', order_num=11, tags=['系统管理-日志管理'], dependencies=[PreAuthDependency()] +) + + +@log_controller.get( + '/operlog/list', + summary='获取操作日志分页列表接口', + description='用于获取操作日志分页列表', + response_model=PageResponseModel[OperLogModel], + dependencies=[UserInterfaceAuthDependency('monitor:operlog:list')], +) +async def get_system_operation_log_list( + request: Request, + operation_log_page_query: Annotated[OperLogPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + operation_log_page_query_result = await OperationLogService.get_operation_log_list_services( + query_db, operation_log_page_query, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=operation_log_page_query_result) + + +@log_controller.delete( + '/operlog/clean', + summary='清空操作日志接口', + description='用于清空所有操作日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_OPERLOG_CLEAN, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='操作日志', business_type=BusinessType.CLEAN) +async def clear_system_operation_log( + request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()] +) -> Response: + clear_operation_log_result = await OperationLogService.clear_operation_log_services(query_db) + logger.info(clear_operation_log_result.message) + + return ResponseUtil.success(msg=clear_operation_log_result.message) + + +@log_controller.delete( + '/operlog/{oper_ids}', + summary='删除操作日志接口', + description='用于删除操作日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_OPERLOG_DELETE, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='操作日志', business_type=BusinessType.DELETE) +async def delete_system_operation_log( + request: Request, + oper_ids: Annotated[str, Path(description='需要删除的日志主键')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_operation_log = DeleteOperLogModel(operIds=oper_ids) + delete_operation_log_result = await OperationLogService.delete_operation_log_services( + query_db, delete_operation_log + ) + logger.info(delete_operation_log_result.message) + + return ResponseUtil.success(msg=delete_operation_log_result.message) + + +@log_controller.post( + '/operlog/export', + summary='导出操作日志接口', + description='用于导出当前符合查询条件的操作日志数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回操作日志列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('monitor:operlog:export')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_OPERLOG_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='操作日志', business_type=BusinessType.EXPORT) +async def export_system_operation_log_list( + request: Request, + operation_log_page_query: Annotated[OperLogPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + operation_log_query_result = await OperationLogService.get_operation_log_list_services( + query_db, operation_log_page_query, is_page=False + ) + operation_log_export_result = await OperationLogService.export_operation_log_list_services( + request, operation_log_query_result + ) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(operation_log_export_result)) + + +@log_controller.get( + '/logininfor/list', + summary='获取登录日志分页列表接口', + description='用于获取登录日志分页列表', + response_model=PageResponseModel[LogininforModel], + dependencies=[UserInterfaceAuthDependency('monitor:logininfor:list')], +) +async def get_system_login_log_list( + request: Request, + login_log_page_query: Annotated[LoginLogPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + login_log_page_query_result = await LoginLogService.get_login_log_list_services( + query_db, login_log_page_query, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=login_log_page_query_result) + + +@log_controller.delete( + '/logininfor/clean', + summary='清空登录日志接口', + description='用于清空所有登录日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_LOGININFO_CLEAN, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='登录日志', business_type=BusinessType.CLEAN) +async def clear_system_login_log( + request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()] +) -> Response: + clear_login_log_result = await LoginLogService.clear_login_log_services(query_db) + logger.info(clear_login_log_result.message) + + return ResponseUtil.success(msg=clear_login_log_result.message) + + +@log_controller.delete( + '/logininfor/{info_ids}', + summary='删除登录日志接口', + description='用于删除登录日志', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_LOGININFO_DELETE, preset=ApiRateLimitPreset.USER_DESTRUCTIVE_MUTATION) +@Log(title='登录日志', business_type=BusinessType.DELETE) +async def delete_system_login_log( + request: Request, + info_ids: Annotated[str, Path(description='需要删除的访问ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_login_log = DeleteLoginLogModel(infoIds=info_ids) + delete_login_log_result = await LoginLogService.delete_login_log_services(query_db, delete_login_log) + logger.info(delete_login_log_result.message) + + return ResponseUtil.success(msg=delete_login_log_result.message) + + +@log_controller.get( + '/logininfor/unlock/{user_name}', + summary='解锁账户接口', + description='用于解锁指定用户账户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:logininfor:unlock')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_LOGININFO_UNLOCK, preset=ApiRateLimitPreset.USER_SECURITY_MUTATION) +@Log(title='账户解锁', business_type=BusinessType.OTHER) +async def unlock_system_user( + request: Request, + user_name: Annotated[str, Path(description='用户名称')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + unlock_user = UnlockUser(userName=user_name) + unlock_user_result = await LoginLogService.unlock_user_services(request, unlock_user) + logger.info(unlock_user_result.message) + + return ResponseUtil.success(msg=unlock_user_result.message) + + +@log_controller.post( + '/logininfor/export', + summary='导出登录日志接口', + description='用于导出当前符合查询条件的登录日志数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回登录日志列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('monitor:logininfor:export')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_LOGININFO_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='登录日志', business_type=BusinessType.EXPORT) +async def export_system_login_log_list( + request: Request, + login_log_page_query: Annotated[LoginLogPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + login_log_query_result = await LoginLogService.get_login_log_list_services( + query_db, login_log_page_query, is_page=False + ) + login_log_export_result = await LoginLogService.export_login_log_list_services(login_log_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(login_log_export_result)) diff --git a/shierfeng-fastapi-backend/module_admin/controller/login_controller.py b/shierfeng-fastapi-backend/module_admin/controller/login_controller.py new file mode 100644 index 0000000..4eadc4a --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/login_controller.py @@ -0,0 +1,192 @@ +import uuid +from datetime import datetime, timedelta +from typing import Annotated + +import jwt +from fastapi import Depends, Request, Response +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.pre_auth import CurrentUserDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType, RedisInitKeyConfig +from common.router import APIRouterPro +from common.vo import CrudResponseModel, DataResponseModel, DynamicResponseModel, ResponseBaseModel +from config.env import AppConfig, JwtConfig +from module_admin.entity.vo.login_vo import LoginToken, RouterModel, Token, UserLogin, UserRegister +from module_admin.entity.vo.user_vo import CurrentUserModel, EditUserModel +from module_admin.service.login_service import CustomOAuth2PasswordRequestForm, LoginService, oauth2_scheme +from module_admin.service.user_service import UserService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +login_controller = APIRouterPro(order_num=1, tags=['登录模块']) + + +@login_controller.post( + '/login', + summary='登录接口', + description='用于用户登录', + response_model=DynamicResponseModel[LoginToken] | Token, +) +@ApiRateLimit(namespace=ApiNamespace.LOGIN, preset=ApiRateLimitPreset.ANON_AUTH_LOGIN) +@ApiCacheEvict(namespaces=ApiGroup.LOGIN_SUCCESS_MUTATION) +@Log(title='用户登录', business_type=BusinessType.OTHER, log_type='login') +async def login( + request: Request, + form_data: Annotated[CustomOAuth2PasswordRequestForm, Depends()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + captcha_enabled = ( + await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.captchaEnabled') == 'true' + ) + user = UserLogin( + userName=form_data.username, + password=form_data.password, + code=form_data.code, + uuid=form_data.uuid, + loginInfo=form_data.login_info, + captchaEnabled=captcha_enabled, + ) + result = await LoginService.authenticate_user(request, query_db, user) + access_token_expires = timedelta(minutes=JwtConfig.jwt_expire_minutes) + session_id = str(uuid.uuid4()) + access_token = await LoginService.create_access_token( + data={ + 'user_id': str(result[0].user_id), + 'user_name': result[0].user_name, + 'dept_name': result[1].dept_name if result[1] else None, + 'session_id': session_id, + 'login_info': user.login_info, + }, + expires_delta=access_token_expires, + ) + if AppConfig.app_same_time_login: + await request.app.state.redis.set( + f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}', + access_token, + ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes), + ) + else: + # 此方法可实现同一账号同一时间只能登录一次 + await request.app.state.redis.set( + f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{result[0].user_id}', + access_token, + ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes), + ) + await UserService.edit_user_services( + query_db, EditUserModel(userId=result[0].user_id, loginDate=datetime.now(), type='status') + ) + logger.info('登录成功') + # 判断请求是否来自于api文档,如果是返回指定格式的结果,用于修复api文档认证成功后token显示undefined的bug + request_from_swagger = request.headers.get('referer').endswith('docs') if request.headers.get('referer') else False + request_from_redoc = request.headers.get('referer').endswith('redoc') if request.headers.get('referer') else False + if request_from_swagger or request_from_redoc: + return {'access_token': access_token, 'token_type': 'Bearer'} + return ResponseUtil.success(msg='登录成功', dict_content={'token': access_token}) + + +@login_controller.get( + '/getInfo', + summary='获取用户信息接口', + description='用于获取当前登录用户的信息', + response_model=DynamicResponseModel[CurrentUserModel], +) +@ApiCache(namespace=ApiNamespace.LOGIN_USER_INFO) +async def get_login_user_info( + request: Request, current_user: Annotated[CurrentUserModel, CurrentUserDependency()] +) -> Response: + logger.info('获取成功') + + return ResponseUtil.success(model_content=current_user) + + +@login_controller.get( + '/getRouters', + summary='获取用户路由接口', + description='用于获取当前登录用户的路由信息', + response_model=DataResponseModel[list[RouterModel]], +) +@ApiCache(namespace=ApiNamespace.LOGIN_USER_ROUTERS) +async def get_login_user_routers( + request: Request, + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + logger.info('获取成功') + user_routers = await LoginService.get_current_user_routers(current_user.user.user_id, query_db) + + return ResponseUtil.success(data=user_routers) + + +@login_controller.post( + '/register', + summary='注册接口', + description='用于用户注册', + response_model=DataResponseModel[CrudResponseModel], +) +@ApiRateLimit(namespace=ApiNamespace.REGISTER, preset=ApiRateLimitPreset.ANON_AUTH_REGISTER) +@ApiCacheEvict(namespaces=ApiGroup.USER_ENTITY_MUTATION) +async def register_user( + request: Request, + user_register: UserRegister, + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + user_register_result = await LoginService.register_user_services(request, query_db, user_register) + logger.info(user_register_result.message) + + return ResponseUtil.success(data=user_register_result, msg=user_register_result.message) + + +# @login_controller.post("/getSmsCode", response_model=SmsCode) +# async def get_sms_code(request: Request, user: ResetUserModel, query_db: AsyncSession = DBSessionDependency()): +# try: +# sms_result = await LoginService.get_sms_code_services(request, query_db, user) +# if sms_result.is_success: +# logger.info('获取成功') +# return ResponseUtil.success(data=sms_result) +# else: +# logger.warning(sms_result.message) +# return ResponseUtil.failure(msg=sms_result.message) +# except Exception as e: +# logger.exception(e) +# return ResponseUtil.error(msg=str(e)) +# +# +# @login_controller.post("/forgetPwd", response_model=CrudResponseModel) +# async def forget_user_pwd(request: Request, forget_user: ResetUserModel, query_db: AsyncSession = DBSessionDependency()): +# try: +# forget_user_result = await LoginService.forget_user_services(request, query_db, forget_user) +# if forget_user_result.is_success: +# logger.info(forget_user_result.message) +# return ResponseUtil.success(data=forget_user_result, msg=forget_user_result.message) +# else: +# logger.warning(forget_user_result.message) +# return ResponseUtil.failure(msg=forget_user_result.message) +# except Exception as e: +# logger.exception(e) +# return ResponseUtil.error(msg=str(e)) + + +@login_controller.post( + '/logout', + summary='退出登录接口', + description='用于用户退出登录', + response_model=ResponseBaseModel, +) +@ApiCacheEvict(namespaces=ApiGroup.LOGOUT_MUTATION) +async def logout(request: Request, token: Annotated[str | None, Depends(oauth2_scheme)]) -> Response: + payload = jwt.decode( + token, JwtConfig.jwt_secret_key, algorithms=[JwtConfig.jwt_algorithm], options={'verify_exp': False} + ) + if AppConfig.app_same_time_login: + token_id: str = payload.get('session_id') + else: + token_id: str = payload.get('user_id') + await LoginService.logout_services(request, token_id) + logger.info('退出成功') + + return ResponseUtil.success(msg='退出成功') diff --git a/shierfeng-fastapi-backend/module_admin/controller/menu_controller.py b/shierfeng-fastapi-backend/module_admin/controller/menu_controller.py new file mode 100644 index 0000000..5747ee8 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/menu_controller.py @@ -0,0 +1,173 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, DynamicResponseModel, ResponseBaseModel +from module_admin.entity.vo.menu_vo import DeleteMenuModel, MenuModel, MenuQueryModel, MenuTreeModel +from module_admin.entity.vo.role_vo import RoleMenuQueryModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.menu_service import MenuService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +menu_controller = APIRouterPro( + prefix='/system/menu', order_num=5, tags=['系统管理-菜单管理'], dependencies=[PreAuthDependency()] +) + + +@menu_controller.get( + '/treeselect', + summary='获取菜单树接口', + description='用于获取当前用户可见的菜单树', + response_model=DataResponseModel[list[MenuTreeModel]], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_MENU_TREE) +async def get_system_menu_tree( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + menu_query_result = await MenuService.get_menu_tree_services(query_db, current_user) + logger.info('获取成功') + + return ResponseUtil.success(data=menu_query_result) + + +@menu_controller.get( + '/roleMenuTreeselect/{role_id}', + summary='获取角色菜单树接口', + description='用于获取指定角色可见的菜单树', + response_model=DynamicResponseModel[RoleMenuQueryModel], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_MENU_ROLE_TREE) +async def get_system_role_menu_tree( + request: Request, + role_id: Annotated[int, Path(description='角色ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + role_menu_query_result = await MenuService.get_role_menu_tree_services(query_db, role_id, current_user) + logger.info('获取成功') + + return ResponseUtil.success(model_content=role_menu_query_result) + + +@menu_controller.get( + '/list', + summary='获取菜单列表接口', + description='用于获取当前用户可见的菜单列表', + response_model=DataResponseModel[list[MenuModel]], + dependencies=[UserInterfaceAuthDependency('system:menu:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_MENU_LIST) +async def get_system_menu_list( + request: Request, + menu_query: Annotated[MenuQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + menu_query_result = await MenuService.get_menu_list_services(query_db, menu_query, current_user) + logger.info('获取成功') + + return ResponseUtil.success(data=menu_query_result) + + +@menu_controller.post( + '', + summary='新增菜单接口', + description='用于新增菜单', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:menu:add')], +) +@ValidateFields(validate_model='add_menu') +@ApiCacheEvict(namespaces=ApiGroup.MENU_MUTATION) +@Log(title='菜单管理', business_type=BusinessType.INSERT) +async def add_system_menu( + request: Request, + add_menu: MenuModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_menu.create_by = current_user.user.user_name + add_menu.create_time = datetime.now() + add_menu.update_by = current_user.user.user_name + add_menu.update_time = datetime.now() + add_menu_result = await MenuService.add_menu_services(query_db, add_menu) + logger.info(add_menu_result.message) + + return ResponseUtil.success(msg=add_menu_result.message) + + +@menu_controller.put( + '', + summary='编辑菜单接口', + description='用于编辑菜单', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:menu:edit')], +) +@ValidateFields(validate_model='edit_menu') +@ApiCacheEvict(namespaces=ApiGroup.MENU_MUTATION) +@Log(title='菜单管理', business_type=BusinessType.UPDATE) +async def edit_system_menu( + request: Request, + edit_menu: MenuModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_menu.update_by = current_user.user.user_name + edit_menu.update_time = datetime.now() + edit_menu_result = await MenuService.edit_menu_services(query_db, edit_menu) + logger.info(edit_menu_result.message) + + return ResponseUtil.success(msg=edit_menu_result.message) + + +@menu_controller.delete( + '/{menu_ids}', + summary='删除菜单接口', + description='用于删除菜单', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:menu:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.MENU_MUTATION) +@Log(title='菜单管理', business_type=BusinessType.DELETE) +async def delete_system_menu( + request: Request, + menu_ids: Annotated[str, Path(description='需要删除的菜单ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_menu = DeleteMenuModel(menuIds=menu_ids) + delete_menu_result = await MenuService.delete_menu_services(query_db, delete_menu) + logger.info(delete_menu_result.message) + + return ResponseUtil.success(msg=delete_menu_result.message) + + +@menu_controller.get( + '/{menu_id}', + summary='获取菜单详情接口', + description='用于获取指定菜单的详情信息', + response_model=DataResponseModel[MenuModel], + dependencies=[UserInterfaceAuthDependency('system:menu:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_MENU_DETAIL) +async def query_detail_system_menu( + request: Request, + menu_id: Annotated[int, Path(description='菜单ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + menu_detail_result = await MenuService.menu_detail_services(query_db, menu_id) + logger.info(f'获取menu_id为{menu_id}的信息成功') + + return ResponseUtil.success(data=menu_detail_result) diff --git a/shierfeng-fastapi-backend/module_admin/controller/notice_controller.py b/shierfeng-fastapi-backend/module_admin/controller/notice_controller.py new file mode 100644 index 0000000..c78d787 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/notice_controller.py @@ -0,0 +1,135 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.notice_vo import DeleteNoticeModel, NoticeModel, NoticePageQueryModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.notice_service import NoticeService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +notice_controller = APIRouterPro( + prefix='/system/notice', order_num=10, tags=['系统管理-通知公告管理'], dependencies=[PreAuthDependency()] +) + + +@notice_controller.get( + '/list', + summary='获取通知公告分页列表接口', + description='用于获取通知公告分页列表', + response_model=PageResponseModel[NoticeModel], + dependencies=[UserInterfaceAuthDependency('system:notice:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_NOTICE_LIST) +async def get_system_notice_list( + request: Request, + notice_page_query: Annotated[NoticePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + notice_page_query_result = await NoticeService.get_notice_list_services(query_db, notice_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=notice_page_query_result) + + +@notice_controller.post( + '', + summary='新增通知公告接口', + description='用于新增通知公告', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:notice:add')], +) +@ValidateFields(validate_model='add_notice') +@ApiCacheEvict(namespaces=ApiGroup.NOTICE_MUTATION) +@Log(title='通知公告', business_type=BusinessType.INSERT) +async def add_system_notice( + request: Request, + add_notice: NoticeModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_notice.create_by = current_user.user.user_name + add_notice.create_time = datetime.now() + add_notice.update_by = current_user.user.user_name + add_notice.update_time = datetime.now() + add_notice_result = await NoticeService.add_notice_services(query_db, add_notice) + logger.info(add_notice_result.message) + + return ResponseUtil.success(msg=add_notice_result.message) + + +@notice_controller.put( + '', + summary='编辑通知公告接口', + description='用于编辑通知公告', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:notice:edit')], +) +@ValidateFields(validate_model='edit_notice') +@ApiCacheEvict(namespaces=ApiGroup.NOTICE_MUTATION) +@Log(title='通知公告', business_type=BusinessType.UPDATE) +async def edit_system_notice( + request: Request, + edit_notice: NoticeModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_notice.update_by = current_user.user.user_name + edit_notice.update_time = datetime.now() + edit_notice_result = await NoticeService.edit_notice_services(query_db, edit_notice) + logger.info(edit_notice_result.message) + + return ResponseUtil.success(msg=edit_notice_result.message) + + +@notice_controller.delete( + '/{notice_ids}', + summary='删除通知公告接口', + description='用于删除通知公告', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:notice:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.NOTICE_MUTATION) +@Log(title='通知公告', business_type=BusinessType.DELETE) +async def delete_system_notice( + request: Request, + notice_ids: Annotated[str, Path(description='需要删除的公告ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_notice = DeleteNoticeModel(noticeIds=notice_ids) + delete_notice_result = await NoticeService.delete_notice_services(query_db, delete_notice) + logger.info(delete_notice_result.message) + + return ResponseUtil.success(msg=delete_notice_result.message) + + +@notice_controller.get( + '/{notice_id}', + summary='获取通知公告详情接口', + description='用于获取指定通知公告的详细信息', + response_model=DataResponseModel[NoticeModel], + dependencies=[UserInterfaceAuthDependency('system:notice:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_NOTICE_DETAIL) +async def query_detail_system_post( + request: Request, + notice_id: Annotated[int, Path(description='公告ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + notice_detail_result = await NoticeService.notice_detail_services(query_db, notice_id) + logger.info(f'获取notice_id为{notice_id}的信息成功') + + return ResponseUtil.success(data=notice_detail_result) diff --git a/shierfeng-fastapi-backend/module_admin/controller/online_controller.py b/shierfeng-fastapi-backend/module_admin/controller/online_controller.py new file mode 100644 index 0000000..ff152bb --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/online_controller.py @@ -0,0 +1,63 @@ +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import ResponseBaseModel +from module_admin.entity.vo.online_vo import DeleteOnlineModel, OnlinePageResponseModel, OnlineQueryModel +from module_admin.service.online_service import OnlineService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +online_controller = APIRouterPro( + prefix='/monitor/online', order_num=12, tags=['系统监控-在线用户'], dependencies=[PreAuthDependency()] +) + + +@online_controller.get( + '/list', + summary='获取在线用户分页列表接口', + description='用于获取在线用户分页列表', + response_model=OnlinePageResponseModel, + dependencies=[UserInterfaceAuthDependency('monitor:online:list')], +) +async def get_monitor_online_list( + request: Request, + online_page_query: Annotated[OnlineQueryModel, Query()], +) -> Response: + # 获取全量数据 + online_query_result = await OnlineService.get_online_list_services(request, online_page_query) + logger.info('获取成功') + + return ResponseUtil.success( + model_content=OnlinePageResponseModel(rows=online_query_result, total=len(online_query_result)) + ) + + +@online_controller.delete( + '/{token_ids}', + summary='强退在线用户接口', + description='用于强退指定会话编号的在线用户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('monitor:online:forceLogout')], +) +@ApiRateLimit(namespace=ApiNamespace.MONITOR_ONLINE_FORCE_LOGOUT, preset=ApiRateLimitPreset.USER_SECURITY_MUTATION) +@Log(title='在线用户', business_type=BusinessType.FORCE) +async def delete_monitor_online( + request: Request, + token_ids: Annotated[str, Path(description='需要强退的会话编号')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_online = DeleteOnlineModel(tokenIds=token_ids) + delete_online_result = await OnlineService.delete_online_services(request, delete_online) + logger.info(delete_online_result.message) + + return ResponseUtil.success(msg=delete_online_result.message) diff --git a/shierfeng-fastapi-backend/module_admin/controller/post_controller.py b/shierfeng-fastapi-backend/module_admin/controller/post_controller.py new file mode 100644 index 0000000..ff84f96 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/post_controller.py @@ -0,0 +1,168 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.post_vo import DeletePostModel, PostModel, PostPageQueryModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_admin.service.post_service import PostService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +post_controller = APIRouterPro( + prefix='/system/post', order_num=7, tags=['系统管理-岗位管理'], dependencies=[PreAuthDependency()] +) + + +@post_controller.get( + '/list', + summary='获取岗位分页列表接口', + description='用于获取岗位分页列表', + response_model=PageResponseModel[PostModel], + dependencies=[UserInterfaceAuthDependency('system:post:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_POST_LIST) +async def get_system_post_list( + request: Request, + post_page_query: Annotated[PostPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + post_page_query_result = await PostService.get_post_list_services(query_db, post_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=post_page_query_result) + + +@post_controller.post( + '', + summary='新增岗位接口', + description='用于新增岗位', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:post:add')], +) +@ValidateFields(validate_model='add_post') +@ApiCacheEvict(namespaces=ApiGroup.POST_MUTATION) +@Log(title='岗位管理', business_type=BusinessType.INSERT) +async def add_system_post( + request: Request, + add_post: PostModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_post.create_by = current_user.user.user_name + add_post.create_time = datetime.now() + add_post.update_by = current_user.user.user_name + add_post.update_time = datetime.now() + add_post_result = await PostService.add_post_services(query_db, add_post) + logger.info(add_post_result.message) + + return ResponseUtil.success(msg=add_post_result.message) + + +@post_controller.put( + '', + summary='编辑岗位接口', + description='用于编辑岗位', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:post:edit')], +) +@ValidateFields(validate_model='edit_post') +@ApiCacheEvict(namespaces=ApiGroup.POST_MUTATION) +@Log(title='岗位管理', business_type=BusinessType.UPDATE) +async def edit_system_post( + request: Request, + edit_post: PostModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_post.update_by = current_user.user.user_name + edit_post.update_time = datetime.now() + edit_post_result = await PostService.edit_post_services(query_db, edit_post) + logger.info(edit_post_result.message) + + return ResponseUtil.success(msg=edit_post_result.message) + + +@post_controller.delete( + '/{post_ids}', + summary='删除岗位接口', + description='用于删除岗位', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:post:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.POST_MUTATION) +@Log(title='岗位管理', business_type=BusinessType.DELETE) +async def delete_system_post( + request: Request, + post_ids: Annotated[str, Path(description='需要删除的岗位ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_post = DeletePostModel(postIds=post_ids) + delete_post_result = await PostService.delete_post_services(query_db, delete_post) + logger.info(delete_post_result.message) + + return ResponseUtil.success(msg=delete_post_result.message) + + +@post_controller.get( + '/{post_id}', + summary='获取岗位详情接口', + description='用于获取指定岗位的详细信息', + response_model=DataResponseModel[PostModel], + dependencies=[UserInterfaceAuthDependency('system:post:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_POST_DETAIL) +async def query_detail_system_post( + request: Request, + post_id: Annotated[int, Path(description='岗位ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + post_detail_result = await PostService.post_detail_services(query_db, post_id) + logger.info(f'获取post_id为{post_id}的信息成功') + + return ResponseUtil.success(data=post_detail_result) + + +@post_controller.post( + '/export', + summary='导出岗位列表接口', + description='用于导出当前符合查询条件的岗位列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回岗位列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:post:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_POST_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='岗位管理', business_type=BusinessType.EXPORT) +async def export_system_post_list( + request: Request, + post_page_query: Annotated[PostPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + post_query_result = await PostService.get_post_list_services(query_db, post_page_query, is_page=False) + post_export_result = await PostService.export_post_list_services(post_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(post_export_result)) diff --git a/shierfeng-fastapi-backend/module_admin/controller/role_controller.py b/shierfeng-fastapi-backend/module_admin/controller/role_controller.py new file mode 100644 index 0000000..c86dc00 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/role_controller.py @@ -0,0 +1,400 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.data_scope import DataScopeDependency +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, DynamicResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.user_do import SysUser +from module_admin.entity.vo.dept_vo import DeptModel +from module_admin.entity.vo.role_vo import ( + AddRoleModel, + DeleteRoleModel, + RoleDeptQueryModel, + RoleModel, + RolePageQueryModel, +) +from module_admin.entity.vo.user_vo import CrudUserRoleModel, CurrentUserModel, UserInfoModel, UserRolePageQueryModel +from module_admin.service.dept_service import DeptService +from module_admin.service.role_service import RoleService +from module_admin.service.user_service import UserService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +role_controller = APIRouterPro( + prefix='/system/role', order_num=4, tags=['系统管理-角色管理'], dependencies=[PreAuthDependency()] +) + + +@role_controller.get( + '/deptTree/{role_id}', + summary='获取自定义数据权限时可见的部门树接口', + description='用于自定义数据权限时获取当前用户可见的部门树', + response_model=DynamicResponseModel[RoleDeptQueryModel], + dependencies=[UserInterfaceAuthDependency('system:role:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_ROLE_DEPT_TREE) +async def get_system_role_dept_tree( + request: Request, + role_id: Annotated[int, Path(description='角色ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + dept_query_result = await DeptService.get_dept_tree_services(query_db, DeptModel(), data_scope_sql) + role_dept_query_result = await RoleService.get_role_dept_tree_services(query_db, role_id) + role_dept_query_result.depts = dept_query_result + logger.info('获取成功') + + return ResponseUtil.success(model_content=role_dept_query_result) + + +@role_controller.get( + '/list', + summary='获取角色分页列表接口', + description='用于获取角色分页列表', + response_model=PageResponseModel[RoleModel], + dependencies=[UserInterfaceAuthDependency('system:role:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_ROLE_LIST) +async def get_system_role_list( + request: Request, + role_page_query: Annotated[RolePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + role_page_query_result = await RoleService.get_role_list_services( + query_db, role_page_query, data_scope_sql, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=role_page_query_result) + + +@role_controller.post( + '', + summary='新增角色接口', + description='用于新增角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:add')], +) +@ValidateFields(validate_model='add_role') +@ApiCacheEvict(namespaces=ApiGroup.ROLE_ENTITY_MUTATION) +@Log(title='角色管理', business_type=BusinessType.INSERT) +async def add_system_role( + request: Request, + add_role: AddRoleModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_role.create_by = current_user.user.user_name + add_role.create_time = datetime.now() + add_role.update_by = current_user.user.user_name + add_role.update_time = datetime.now() + add_role_result = await RoleService.add_role_services(query_db, add_role) + logger.info(add_role_result.message) + + return ResponseUtil.success(msg=add_role_result.message) + + +@role_controller.put( + '', + summary='编辑角色接口', + description='用于编辑角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ValidateFields(validate_model='edit_role') +@ApiCacheEvict(namespaces=ApiGroup.ROLE_PERMISSION_MUTATION) +@Log(title='角色管理', business_type=BusinessType.UPDATE) +async def edit_system_role( + request: Request, + edit_role: AddRoleModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + await RoleService.check_role_allowed_services(edit_role) + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, str(edit_role.role_id), data_scope_sql) + edit_role.update_by = current_user.user.user_name + edit_role.update_time = datetime.now() + edit_role_result = await RoleService.edit_role_services(query_db, edit_role) + logger.info(edit_role_result.message) + + return ResponseUtil.success(msg=edit_role_result.message) + + +@role_controller.put( + '/dataScope', + summary='编辑角色数据权限接口', + description='用于编辑角色数据权限', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ApiCacheEvict(namespaces=ApiGroup.DATA_SCOPE_MUTATION) +@Log(title='角色管理', business_type=BusinessType.GRANT) +async def edit_system_role_datascope( + request: Request, + role_data_scope: AddRoleModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + await RoleService.check_role_allowed_services(role_data_scope) + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, str(role_data_scope.role_id), data_scope_sql) + edit_role = AddRoleModel( + roleId=role_data_scope.role_id, + dataScope=role_data_scope.data_scope, + deptIds=role_data_scope.dept_ids, + deptCheckStrictly=role_data_scope.dept_check_strictly, + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + ) + role_data_scope_result = await RoleService.role_datascope_services(query_db, edit_role) + logger.info(role_data_scope_result.message) + + return ResponseUtil.success(msg=role_data_scope_result.message) + + +@role_controller.delete( + '/{role_ids}', + summary='删除角色接口', + description='用于删除角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.ROLE_ENTITY_MUTATION) +@Log(title='角色管理', business_type=BusinessType.DELETE) +async def delete_system_role( + request: Request, + role_ids: Annotated[str, Path(description='需要删除的角色ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + role_id_list = role_ids.split(',') if role_ids else [] + if role_id_list: + for role_id in role_id_list: + await RoleService.check_role_allowed_services(RoleModel(roleId=int(role_id))) + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, role_id, data_scope_sql) + delete_role = DeleteRoleModel(roleIds=role_ids, updateBy=current_user.user.user_name, updateTime=datetime.now()) + delete_role_result = await RoleService.delete_role_services(query_db, delete_role) + logger.info(delete_role_result.message) + + return ResponseUtil.success(msg=delete_role_result.message) + + +@role_controller.get( + '/{role_id}', + summary='获取角色详情接口', + description='用于获取指定角色的详细信息', + response_model=DataResponseModel[RoleModel], + dependencies=[UserInterfaceAuthDependency('system:role:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_ROLE_DETAIL) +async def query_detail_system_role( + request: Request, + role_id: Annotated[int, Path(description='角色ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, str(role_id), data_scope_sql) + role_detail_result = await RoleService.role_detail_services(query_db, role_id) + logger.info(f'获取role_id为{role_id}的信息成功') + + return ResponseUtil.success(data=role_detail_result.model_dump(by_alias=True)) + + +@role_controller.post( + '/export', + summary='导出角色列表接口', + description='用于导出当前符合查询条件的角色列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回角色列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:role:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_ROLE_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='角色管理', business_type=BusinessType.EXPORT) +async def export_system_role_list( + request: Request, + role_page_query: Annotated[RolePageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + # 获取全量数据 + role_query_result = await RoleService.get_role_list_services( + query_db, role_page_query, data_scope_sql, is_page=False + ) + role_export_result = await RoleService.export_role_list_services(role_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(role_export_result)) + + +@role_controller.put( + '/changeStatus', + summary='修改角色状态接口', + description='用于修改角色状态', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ApiCacheEvict(namespaces=ApiGroup.ROLE_MUTATION) +@Log(title='角色管理', business_type=BusinessType.UPDATE) +async def reset_system_role_status( + request: Request, + change_role: AddRoleModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + await RoleService.check_role_allowed_services(change_role) + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, str(change_role.role_id), data_scope_sql) + edit_role = AddRoleModel( + roleId=change_role.role_id, + status=change_role.status, + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + type='status', + ) + edit_role_result = await RoleService.edit_role_services(query_db, edit_role) + logger.info(edit_role_result.message) + + return ResponseUtil.success(msg=edit_role_result.message) + + +@role_controller.get( + '/authUser/allocatedList', + summary='获取已分配用户分页列表接口', + description='用于获取指定角色已分配的用户分页列表', + response_model=PageResponseModel[UserInfoModel], + dependencies=[UserInterfaceAuthDependency('system:role:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_ROLE_ALLOCATED_USER_LIST) +async def get_system_allocated_user_list( + request: Request, + user_role: Annotated[UserRolePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + role_user_allocated_page_query_result = await RoleService.get_role_user_allocated_list_services( + query_db, user_role, data_scope_sql, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=role_user_allocated_page_query_result) + + +@role_controller.get( + '/authUser/unallocatedList', + summary='获取未分配用户分页列表接口', + description='用于获取指定角色未分配的用户分页列表', + response_model=PageResponseModel[UserInfoModel], + dependencies=[UserInterfaceAuthDependency('system:role:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_ROLE_UNALLOCATED_USER_LIST) +async def get_system_unallocated_user_list( + request: Request, + user_role: Annotated[UserRolePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + role_user_unallocated_page_query_result = await RoleService.get_role_user_unallocated_list_services( + query_db, user_role, data_scope_sql, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=role_user_unallocated_page_query_result) + + +@role_controller.put( + '/authUser/selectAll', + summary='分配用户给角色接口', + description='用于给指定角色分配用户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_ROLE_AUTH_USER_SELECT_ALL, preset=ApiRateLimitPreset.USER_SECURITY_MUTATION) +@ApiCacheEvict(namespaces=ApiGroup.ROLE_MUTATION) +@Log(title='角色管理', business_type=BusinessType.GRANT) +async def add_system_role_user( + request: Request, + add_role_user: Annotated[CrudUserRoleModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await RoleService.check_role_data_scope_services(query_db, str(add_role_user.role_id), data_scope_sql) + add_role_user_result = await UserService.add_user_role_services(query_db, add_role_user) + logger.info(add_role_user_result.message) + + return ResponseUtil.success(msg=add_role_user_result.message) + + +@role_controller.put( + '/authUser/cancel', + summary='取消分配用户给角色接口', + description='用于取消指定用户分配给角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_ROLE_AUTH_USER_CANCEL, preset=ApiRateLimitPreset.USER_SECURITY_MUTATION) +@ApiCacheEvict(namespaces=ApiGroup.ROLE_MUTATION) +@Log(title='角色管理', business_type=BusinessType.GRANT) +async def cancel_system_role_user( + request: Request, + cancel_user_role: CrudUserRoleModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + cancel_user_role_result = await UserService.delete_user_role_services(query_db, cancel_user_role) + logger.info(cancel_user_role_result.message) + + return ResponseUtil.success(msg=cancel_user_role_result.message) + + +@role_controller.put( + '/authUser/cancelAll', + summary='批量取消分配用户给角色接口', + description='用于批量取消用户分配给角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:role:edit')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_ROLE_AUTH_USER_CANCEL_ALL, preset=ApiRateLimitPreset.USER_SECURITY_MUTATION) +@ApiCacheEvict(namespaces=ApiGroup.ROLE_MUTATION) +@Log(title='角色管理', business_type=BusinessType.GRANT) +async def batch_cancel_system_role_user( + request: Request, + batch_cancel_user_role: Annotated[CrudUserRoleModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + batch_cancel_user_role_result = await UserService.delete_user_role_services(query_db, batch_cancel_user_role) + logger.info(batch_cancel_user_role_result.message) + + return ResponseUtil.success(msg=batch_cancel_user_role_result.message) diff --git a/shierfeng-fastapi-backend/module_admin/controller/server_controller.py b/shierfeng-fastapi-backend/module_admin/controller/server_controller.py new file mode 100644 index 0000000..a68f218 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/server_controller.py @@ -0,0 +1,32 @@ +from fastapi import Request, Response + +from common.annotation.cache_annotation import ApiCache +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.router import APIRouterPro +from common.vo import DataResponseModel +from module_admin.entity.vo.server_vo import ServerMonitorModel +from module_admin.service.server_service import ServerService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +server_controller = APIRouterPro( + prefix='/monitor/server', order_num=14, tags=['系统监控-服务监控'], dependencies=[PreAuthDependency()] +) + + +@server_controller.get( + '', + summary='获取服务器监控信息接口', + description='用于获取当前服务器的监控信息', + response_model=DataResponseModel[ServerMonitorModel], + dependencies=[UserInterfaceAuthDependency('monitor:server:list')], +) +@ApiCache(namespace=ApiNamespace.MONITOR_SERVER_INFO) +async def get_monitor_server_info(request: Request) -> Response: + # 获取全量数据 + server_info_query_result = await ServerService.get_server_monitor_info() + logger.info('获取成功') + + return ResponseUtil.success(data=server_info_query_result) diff --git a/shierfeng-fastapi-backend/module_admin/controller/transport_crypto_controller.py b/shierfeng-fastapi-backend/module_admin/controller/transport_crypto_controller.py new file mode 100644 index 0000000..781d21c --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/transport_crypto_controller.py @@ -0,0 +1,78 @@ +from fastapi import Request, Response + +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import PreAuthDependency +from common.constant import ApiNamespace +from common.router import APIRouterPro +from common.vo import DataResponseModel +from module_admin.entity.vo.transport_crypto_vo import ( + TransportCryptoFrontendConfigModel, + TransportCryptoMonitorModel, + TransportCryptoPublicKeyModel, +) +from module_admin.service.transport_crypto_service import TransportCryptoService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +transport_crypto_controller = APIRouterPro(prefix='/transport/crypto', order_num=15, tags=['传输加密模块']) + + +@transport_crypto_controller.get( + '/frontend-config', + summary='获取前端传输加密配置接口', + description='公开接口,用于向前端下发当前传输层加解密启用状态与运行模式,供前端统一跟随后端策略', + response_model=DataResponseModel[TransportCryptoFrontendConfigModel], +) +@ApiRateLimit(namespace=ApiNamespace.TRANSPORT_CRYPTO_FRONTEND_CONFIG, preset=ApiRateLimitPreset.ANON_PUBLIC_METADATA) +async def get_transport_frontend_config(request: Request) -> Response: + """ + 获取当前前端传输层加解密运行配置 + + :param request: 当前请求对象 + :return: 前端传输层加解密运行配置响应 + """ + transport_frontend_config = await TransportCryptoService.get_transport_frontend_config_services() + logger.info('获取成功') + + return ResponseUtil.success(data=transport_frontend_config) + + +@transport_crypto_controller.get( + '/public-key', + summary='获取传输加密公钥接口', + description='公开接口,用于向前端下发当前可用的传输层加密公钥,已配置匿名限流保护', + response_model=DataResponseModel[TransportCryptoPublicKeyModel], +) +@ApiRateLimit(namespace=ApiNamespace.TRANSPORT_CRYPTO_PUBLIC_KEY, preset=ApiRateLimitPreset.ANON_PUBLIC_METADATA) +async def get_transport_public_key(request: Request) -> Response: + """ + 获取当前传输层加密公钥 + + :param request: 当前请求对象 + :return: 公钥下发响应 + """ + transport_public_key = await TransportCryptoService.get_transport_public_key_services() + logger.info('获取成功') + + return ResponseUtil.success(data=transport_public_key) + + +@transport_crypto_controller.get( + '/monitor', + summary='获取传输层加解密监控信息接口', + description='用于获取基于Redis聚合的传输层加解密运行状态与统计信息', + response_model=DataResponseModel[TransportCryptoMonitorModel], + dependencies=[PreAuthDependency(), UserInterfaceAuthDependency('monitor:transportCrypto:list')], +) +async def get_transport_crypto_monitor_info(request: Request) -> Response: + """ + 获取基于Redis聚合的传输层加解密监控信息 + + :param request: 当前请求对象 + :return: 传输层加解密监控信息响应 + """ + transport_crypto_monitor_info = await TransportCryptoService.get_transport_crypto_monitor_info_services(request) + logger.info('获取成功') + + return ResponseUtil.success(data=transport_crypto_monitor_info) diff --git a/shierfeng-fastapi-backend/module_admin/controller/user_controller.py b/shierfeng-fastapi-backend/module_admin/controller/user_controller.py new file mode 100644 index 0000000..7ea969c --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/controller/user_controller.py @@ -0,0 +1,550 @@ +import os +from datetime import datetime +from typing import Annotated, Literal + +import aiofiles +from fastapi import File, Form, Path, Query, Request, Response, UploadFile +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitBypassConfig, ApiRateLimitPreset +from common.aspect.data_scope import DataScopeDependency +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, DynamicResponseModel, PageResponseModel, ResponseBaseModel +from config.env import UploadConfig +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.user_do import SysUser +from module_admin.entity.vo.dept_vo import DeptModel, DeptTreeModel +from module_admin.entity.vo.user_vo import ( + AddUserModel, + AvatarModel, + CrudUserRoleModel, + CurrentUserModel, + DeleteUserModel, + EditUserModel, + ResetPasswordModel, + ResetUserModel, + UserDetailModel, + UserInfoModel, + UserModel, + UserPageQueryModel, + UserProfileModel, + UserRoleQueryModel, + UserRoleResponseModel, + UserRowModel, +) +from module_admin.service.dept_service import DeptService +from module_admin.service.role_service import RoleService +from module_admin.service.user_service import UserService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.pwd_util import PwdUtil +from utils.response_util import ResponseUtil +from utils.upload_util import UploadUtil + +user_controller = APIRouterPro( + prefix='/system/user', order_num=3, tags=['系统管理-用户管理'], dependencies=[PreAuthDependency()] +) + + +@user_controller.get( + '/deptTree', + summary='获取部门树接口', + description='用于获取当前登录用户可见的部门树', + response_model=DataResponseModel[list[DeptTreeModel]], + dependencies=[UserInterfaceAuthDependency('system:user:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_USER_DEPT_TREE) +async def get_system_dept_tree( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + dept_query_result = await DeptService.get_dept_tree_services(query_db, DeptModel(), data_scope_sql) + logger.info('获取成功') + + return ResponseUtil.success(data=dept_query_result) + + +@user_controller.get( + '/list', + summary='获取用户分页列表接口', + description='用于获取用户分页列表', + response_model=PageResponseModel[UserRowModel], + dependencies=[UserInterfaceAuthDependency('system:user:list')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_USER_LIST) +async def get_system_user_list( + request: Request, + user_page_query: Annotated[UserPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + # 获取分页数据 + user_page_query_result = await UserService.get_user_list_services( + query_db, user_page_query, data_scope_sql, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=user_page_query_result) + + +@user_controller.post( + '', + summary='新增用户接口', + description='用于新增用户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:add')], +) +@ValidateFields(validate_model='add_user') +@ApiCacheEvict(namespaces=ApiGroup.USER_ENTITY_MUTATION) +@Log(title='用户管理', business_type=BusinessType.INSERT) +async def add_system_user( + request: Request, + add_user: AddUserModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + dept_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], + role_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await DeptService.check_dept_data_scope_services(query_db, add_user.dept_id, dept_data_scope_sql) + await RoleService.check_role_data_scope_services( + query_db, ','.join([str(item) for item in add_user.role_ids]), role_data_scope_sql + ) + add_user.password = PwdUtil.get_password_hash(add_user.password) + add_user.create_by = current_user.user.user_name + add_user.create_time = datetime.now() + add_user.update_by = current_user.user.user_name + add_user.update_time = datetime.now() + add_user_result = await UserService.add_user_services(query_db, add_user) + logger.info(add_user_result.message) + + return ResponseUtil.success(msg=add_user_result.message) + + +@user_controller.put( + '', + summary='编辑用户接口', + description='用于编辑用户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:edit')], +) +@ValidateFields(validate_model='edit_user') +@ApiCacheEvict(namespaces=ApiGroup.USER_PERMISSION_MUTATION) +@Log(title='用户管理', business_type=BusinessType.UPDATE) +async def edit_system_user( + request: Request, + edit_user: EditUserModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + user_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], + dept_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], + role_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + await UserService.check_user_allowed_services(edit_user) + if not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, edit_user.user_id, user_data_scope_sql) + await DeptService.check_dept_data_scope_services(query_db, edit_user.dept_id, dept_data_scope_sql) + await RoleService.check_role_data_scope_services( + query_db, ','.join([str(item) for item in edit_user.role_ids]), role_data_scope_sql + ) + edit_user.update_by = current_user.user.user_name + edit_user.update_time = datetime.now() + edit_user_result = await UserService.edit_user_services(query_db, edit_user) + logger.info(edit_user_result.message) + + return ResponseUtil.success(msg=edit_user_result.message) + + +@user_controller.delete( + '/{user_ids}', + summary='删除用户接口', + description='用于删除用户', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.USER_ENTITY_MUTATION) +@Log(title='用户管理', business_type=BusinessType.DELETE) +async def delete_system_user( + request: Request, + user_ids: Annotated[str, Path(description='需要删除的用户ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + user_id_list = user_ids.split(',') if user_ids else [] + if user_id_list: + if current_user.user.user_id in list(map(int, user_id_list)): + logger.warning('当前登录用户不能删除') + + return ResponseUtil.failure(msg='当前登录用户不能删除') + for user_id in user_id_list: + await UserService.check_user_allowed_services(UserModel(userId=int(user_id))) + if not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, int(user_id), data_scope_sql) + delete_user = DeleteUserModel(userIds=user_ids, updateBy=current_user.user.user_name, updateTime=datetime.now()) + delete_user_result = await UserService.delete_user_services(query_db, delete_user) + logger.info(delete_user_result.message) + + return ResponseUtil.success(msg=delete_user_result.message) + + +@user_controller.put( + '/resetPwd', + summary='重置用户密码接口', + description='用于重置用户密码', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:resetPwd')], +) +@ApiCacheEvict(namespaces=ApiGroup.USER_INFO_MUTATION) +@Log(title='用户管理', business_type=BusinessType.UPDATE) +async def reset_system_user_pwd( + request: Request, + reset_user: EditUserModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + await UserService.check_user_allowed_services(reset_user) + if not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, reset_user.user_id, data_scope_sql) + edit_user = EditUserModel( + userId=reset_user.user_id, + password=PwdUtil.get_password_hash(reset_user.password), + pwdUpdateDate=datetime.now(), + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + type='pwd', + ) + edit_user_result = await UserService.edit_user_services(query_db, edit_user) + logger.info(edit_user_result.message) + + return ResponseUtil.success(msg=edit_user_result.message) + + +@user_controller.put( + '/changeStatus', + summary='修改用户状态接口', + description='用于修改用户状态', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:edit')], +) +@ApiCacheEvict(namespaces=ApiGroup.USER_INFO_MUTATION) +@Log(title='用户管理', business_type=BusinessType.UPDATE) +async def change_system_user_status( + request: Request, + change_user: EditUserModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + await UserService.check_user_allowed_services(change_user) + if not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, change_user.user_id, data_scope_sql) + edit_user = EditUserModel( + userId=change_user.user_id, + status=change_user.status, + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + type='status', + ) + edit_user_result = await UserService.edit_user_services(query_db, edit_user) + logger.info(edit_user_result.message) + + return ResponseUtil.success(msg=edit_user_result.message) + + +@user_controller.get( + '/profile', + summary='获取用户个人信息接口', + description='用于获取当前登录用户的个人信息', + response_model=DynamicResponseModel[UserProfileModel], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_USER_PROFILE) +async def query_detail_system_user_profile( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + profile_user_result = await UserService.user_profile_services(query_db, current_user.user.user_id) + logger.info(f'获取user_id为{current_user.user.user_id}的信息成功') + + return ResponseUtil.success(model_content=profile_user_result) + + +@user_controller.get( + '/{user_id}', + summary='获取用户详情接口', + description='用于获取指定用户的详情信息', + response_model=DynamicResponseModel[UserDetailModel], + dependencies=[UserInterfaceAuthDependency('system:user:query')], +) +@user_controller.get( + '/', + summary='获取用户岗位和角色列表接口', + description='用于获取当前登录用户可见的岗位和角色列表', + response_model=DynamicResponseModel[UserDetailModel], + dependencies=[UserInterfaceAuthDependency('system:user:query')], +) +@ApiCache(namespace=ApiNamespace.SYSTEM_USER_DETAIL) +async def query_detail_system_user( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], + user_id: int | Literal[''] | None = '', +) -> Response: + if user_id and not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, user_id, data_scope_sql) + detail_user_result = await UserService.user_detail_services(query_db, user_id) + logger.info(f'获取user_id为{user_id}的信息成功') + + return ResponseUtil.success(model_content=detail_user_result) + + +@user_controller.post( + '/profile/avatar', + summary='修改用户头像接口', + description='用于修改当前登录用户的头像', + response_model=DynamicResponseModel[AvatarModel], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_USER_PROFILE_AVATAR, preset=ApiRateLimitPreset.USER_RESOURCE_UPLOAD) +@ApiCacheEvict(namespaces=ApiGroup.USER_INFO_MUTATION) +@Log(title='个人信息', business_type=BusinessType.UPDATE) +async def change_system_user_profile_avatar( + request: Request, + avatarfile: Annotated[bytes, File()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + if avatarfile: + relative_path = ( + f'avatar/{datetime.now().strftime("%Y")}/{datetime.now().strftime("%m")}/{datetime.now().strftime("%d")}' + ) + dir_path = os.path.join(UploadConfig.UPLOAD_PATH, relative_path) + try: + os.makedirs(dir_path) + except FileExistsError: + pass + avatar_name = f'avatar_{datetime.now().strftime("%Y%m%d%H%M%S")}{UploadConfig.UPLOAD_MACHINE}{UploadUtil.generate_random_number()}.png' + avatar_path = os.path.join(dir_path, avatar_name) + async with aiofiles.open(avatar_path, 'wb') as f: + await f.write(avatarfile) + edit_user = EditUserModel( + userId=current_user.user.user_id, + avatar=f'{UploadConfig.UPLOAD_PREFIX}/{relative_path}/{avatar_name}', + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + type='avatar', + ) + edit_user_result = await UserService.edit_user_services(query_db, edit_user) + logger.info(edit_user_result.message) + + return ResponseUtil.success(model_content=AvatarModel(imgUrl=edit_user.avatar), msg=edit_user_result.message) + return ResponseUtil.failure(msg='上传图片异常,请联系管理员') + + +@user_controller.put( + '/profile', + summary='修改用户个人信息接口', + description='用于修改当前登录用户的个人信息', + response_model=ResponseBaseModel, +) +@ApiCacheEvict(namespaces=ApiGroup.USER_INFO_MUTATION) +@Log(title='个人信息', business_type=BusinessType.UPDATE) +async def change_system_user_profile_info( + request: Request, + user_info: UserInfoModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_user = EditUserModel( + **user_info.model_dump(exclude_unset=True, by_alias=True, exclude={'role_ids', 'post_ids'}), + userId=current_user.user.user_id, + userName=current_user.user.user_name, + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + roleIds=current_user.user.role_ids.split(',') if current_user.user.role_ids else [], + postIds=current_user.user.post_ids.split(',') if current_user.user.post_ids else [], + role=current_user.user.role, + ) + edit_user_result = await UserService.edit_user_services(query_db, edit_user) + logger.info(edit_user_result.message) + + return ResponseUtil.success(msg=edit_user_result.message) + + +@user_controller.put( + '/profile/updatePwd', + summary='修改用户密码接口', + description='用于修改当前登录用户的密码', + response_model=ResponseBaseModel, +) +@ApiCacheEvict(namespaces=ApiGroup.USER_INFO_MUTATION) +@Log(title='个人信息', business_type=BusinessType.UPDATE) +async def reset_system_user_password( + request: Request, + reset_password: ResetPasswordModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + reset_user = ResetUserModel( + userId=current_user.user.user_id, + oldPassword=reset_password.old_password, + password=reset_password.new_password, + pwdUpdateDate=datetime.now(), + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + ) + reset_user_result = await UserService.reset_user_services(query_db, reset_user) + logger.info(reset_user_result.message) + + return ResponseUtil.success(msg=reset_user_result.message) + + +@user_controller.post( + '/importData', + summary='批量导入用户接口', + description='用于批量导入用户数据', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:import')], +) +@ApiRateLimit( + namespace=ApiNamespace.SYSTEM_USER_IMPORT, + preset=ApiRateLimitPreset.USER_RESOURCE_IMPORT, + bypass=ApiRateLimitBypassConfig(roles=('admin',)), +) +@ApiCacheEvict(namespaces=ApiGroup.DATA_SCOPE_MUTATION) +@Log(title='用户管理', business_type=BusinessType.IMPORT) +async def batch_import_system_user( + request: Request, + file: Annotated[UploadFile, File(...)], + update_support: Annotated[bool, Query(alias='updateSupport')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + user_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], + dept_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + batch_import_result = await UserService.batch_import_user_services( + request, query_db, file, update_support, current_user, user_data_scope_sql, dept_data_scope_sql + ) + logger.info(batch_import_result.message) + + return ResponseUtil.success(msg=batch_import_result.message) + + +@user_controller.post( + '/importTemplate', + summary='获取用户导入模板接口', + description='用于获取用户导入模板excel文件', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回导入用户模板excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:user:import')], +) +async def export_system_user_template( + request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()] +) -> Response: + user_import_template_result = await UserService.get_user_import_template_services() + logger.info('获取成功') + + return ResponseUtil.streaming(data=bytes2file_response(user_import_template_result)) + + +@user_controller.post( + '/export', + summary='导出用户列表接口', + description='用于导出当前符合查询条件的用户列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回用户列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('system:user:export')], +) +@ApiRateLimit(namespace=ApiNamespace.SYSTEM_USER_EXPORT, preset=ApiRateLimitPreset.USER_RESOURCE_EXPORT) +@Log(title='用户管理', business_type=BusinessType.EXPORT) +async def export_system_user_list( + request: Request, + user_page_query: Annotated[UserPageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], +) -> Response: + # 获取全量数据 + user_query_result = await UserService.get_user_list_services( + query_db, user_page_query, data_scope_sql, is_page=False + ) + user_export_result = await UserService.export_user_list_services(user_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response(user_export_result)) + + +@user_controller.get( + '/authRole/{user_id}', + summary='获取用户已分配角色列表接口', + description='用于获取指定用户已分配的角色列表', + response_model=DynamicResponseModel[UserRoleResponseModel], + dependencies=[UserInterfaceAuthDependency('system:user:query')], +) +async def get_system_allocated_role_list( + request: Request, + user_id: Annotated[int, Path(description='用户ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + user_role_query = UserRoleQueryModel(userId=user_id) + user_role_allocated_query_result = await UserService.get_user_role_allocated_list_services( + query_db, user_role_query + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=user_role_allocated_query_result) + + +@user_controller.put( + '/authRole', + summary='给用户分配角色接口', + description='用于给指定用户分配角色', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('system:user:edit')], +) +@ApiCacheEvict(namespaces=ApiGroup.USER_PERMISSION_MUTATION) +@Log(title='用户管理', business_type=BusinessType.GRANT) +async def update_system_role_user( + request: Request, + user_id: Annotated[int, Query(alias='userId')], + role_ids: Annotated[str, Query(alias='roleIds')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + user_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysUser)], + role_data_scope_sql: Annotated[ColumnElement, DataScopeDependency(SysDept)], +) -> Response: + if not current_user.user.admin: + await UserService.check_user_data_scope_services(query_db, user_id, user_data_scope_sql) + await RoleService.check_role_data_scope_services(query_db, role_ids, role_data_scope_sql) + add_user_role_result = await UserService.add_user_role_services( + query_db, CrudUserRoleModel(userId=user_id, roleIds=role_ids) + ) + logger.info(add_user_role_result.message) + + return ResponseUtil.success(msg=add_user_role_result.message) diff --git a/shierfeng-fastapi-backend/module_admin/dao/config_dao.py b/shierfeng-fastapi-backend/module_admin/dao/config_dao.py new file mode 100644 index 0000000..d130d58 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/config_dao.py @@ -0,0 +1,124 @@ +from datetime import datetime, time +from typing import Any + +from sqlalchemy import delete, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.config_do import SysConfig +from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel +from utils.page_util import PageUtil + + +class ConfigDao: + """ + 参数配置管理模块数据库操作层 + """ + + @classmethod + async def get_config_detail_by_id(cls, db: AsyncSession, config_id: int) -> SysConfig | None: + """ + 根据参数配置id获取参数配置详细信息 + + :param db: orm对象 + :param config_id: 参数配置id + :return: 参数配置信息对象 + """ + config_info = (await db.execute(select(SysConfig).where(SysConfig.config_id == config_id))).scalars().first() + + return config_info + + @classmethod + async def get_config_detail_by_info(cls, db: AsyncSession, config: ConfigModel) -> SysConfig | None: + """ + 根据参数配置参数获取参数配置信息 + + :param db: orm对象 + :param config: 参数配置参数对象 + :return: 参数配置信息对象 + """ + config_info = ( + ( + await db.execute( + select(SysConfig).where( + SysConfig.config_key == config.config_key if config.config_key else True, + SysConfig.config_value == config.config_value if config.config_value else True, + ) + ) + ) + .scalars() + .first() + ) + + return config_info + + @classmethod + async def get_config_list( + cls, db: AsyncSession, query_object: ConfigPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取参数配置列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 参数配置列表信息对象 + """ + query = ( + select(SysConfig) + .where( + SysConfig.config_name.like(f'%{query_object.config_name}%') if query_object.config_name else True, + SysConfig.config_key.like(f'%{query_object.config_key}%') if query_object.config_key else True, + SysConfig.config_type == query_object.config_type if query_object.config_type else True, + SysConfig.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .order_by(SysConfig.config_id) + .distinct() + ) + config_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return config_list + + @classmethod + async def add_config_dao(cls, db: AsyncSession, config: ConfigModel) -> SysConfig: + """ + 新增参数配置数据库操作 + + :param db: orm对象 + :param config: 参数配置对象 + :return: + """ + db_config = SysConfig(**config.model_dump()) + db.add(db_config) + await db.flush() + + return db_config + + @classmethod + async def edit_config_dao(cls, db: AsyncSession, config: dict) -> None: + """ + 编辑参数配置数据库操作 + + :param db: orm对象 + :param config: 需要更新的参数配置字典 + :return: + """ + await db.execute(update(SysConfig), [config]) + + @classmethod + async def delete_config_dao(cls, db: AsyncSession, config: ConfigModel) -> None: + """ + 删除参数配置数据库操作 + + :param db: orm对象 + :param config: 参数配置对象 + :return: + """ + await db.execute(delete(SysConfig).where(SysConfig.config_id.in_([config.config_id]))) diff --git a/shierfeng-fastapi-backend/module_admin/dao/dept_dao.py b/shierfeng-fastapi-backend/module_admin/dao/dept_dao.py new file mode 100644 index 0000000..2325c39 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/dept_dao.py @@ -0,0 +1,315 @@ +from collections.abc import Sequence + +from sqlalchemy import ColumnElement, bindparam, func, select, update +from sqlalchemy.ext.asyncio import AsyncSession +from sqlalchemy.util import immutabledict + +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.user_do import SysUser +from module_admin.entity.vo.dept_vo import DeptModel + + +class DeptDao: + """ + 部门管理模块数据库操作层 + """ + + @classmethod + async def get_dept_by_id(cls, db: AsyncSession, dept_id: int) -> SysDept | None: + """ + 根据部门id获取在用部门信息 + + :param db: orm对象 + :param dept_id: 部门id + :return: 在用部门信息对象 + """ + dept_info = (await db.execute(select(SysDept).where(SysDept.dept_id == dept_id))).scalars().first() + + return dept_info + + @classmethod + async def get_dept_detail_by_id(cls, db: AsyncSession, dept_id: int) -> SysDept | None: + """ + 根据部门id获取部门详细信息 + + :param db: orm对象 + :param dept_id: 部门id + :return: 部门信息对象 + """ + dept_info = ( + (await db.execute(select(SysDept).where(SysDept.dept_id == dept_id, SysDept.del_flag == '0'))) + .scalars() + .first() + ) + + return dept_info + + @classmethod + async def get_dept_detail_by_info(cls, db: AsyncSession, dept: DeptModel) -> SysDept | None: + """ + 根据部门参数获取部门信息 + + :param db: orm对象 + :param dept: 部门参数对象 + :return: 部门信息对象 + """ + dept_info = ( + ( + await db.execute( + select(SysDept).where( + SysDept.parent_id == dept.parent_id if dept.parent_id else True, + SysDept.dept_name == dept.dept_name if dept.dept_name else True, + SysDept.del_flag == '0', + ) + ) + ) + .scalars() + .first() + ) + + return dept_info + + @classmethod + async def get_dept_info_for_edit_option( + cls, db: AsyncSession, dept_info: DeptModel, data_scope_sql: ColumnElement + ) -> Sequence[SysDept]: + """ + 获取部门编辑对应的在用部门列表信息 + + :param db: orm对象 + :param dept_info: 部门对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 部门列表信息 + """ + dept_result = ( + ( + await db.execute( + select(SysDept) + .where( + SysDept.dept_id != dept_info.dept_id, + ~SysDept.dept_id.in_( + select(SysDept.dept_id).where(func.find_in_set(dept_info.dept_id, SysDept.ancestors)) + ), + SysDept.del_flag == '0', + SysDept.status == '0', + data_scope_sql, + ) + .order_by(SysDept.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + return dept_result + + @classmethod + async def get_children_dept_dao(cls, db: AsyncSession, dept_id: int) -> Sequence[SysDept]: + """ + 根据部门id查询当前部门的子部门列表信息 + + :param db: orm对象 + :param dept_id: 部门id + :return: 子部门信息列表 + """ + dept_result = ( + (await db.execute(select(SysDept).where(func.find_in_set(dept_id, SysDept.ancestors)))).scalars().all() + ) + + return dept_result + + @classmethod + async def get_dept_list_for_tree( + cls, db: AsyncSession, dept_info: DeptModel, data_scope_sql: ColumnElement + ) -> Sequence[SysDept]: + """ + 获取所有在用部门列表信息 + + :param db: orm对象 + :param dept_info: 部门对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 在用部门列表信息 + """ + dept_result = ( + ( + await db.execute( + select(SysDept) + .where( + SysDept.status == '0', + SysDept.del_flag == '0', + SysDept.dept_name.like(f'%{dept_info.dept_name}%') if dept_info.dept_name else True, + data_scope_sql, + ) + .order_by(SysDept.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + return dept_result + + @classmethod + async def get_dept_list( + cls, db: AsyncSession, page_object: DeptModel, data_scope_sql: ColumnElement + ) -> Sequence[SysDept]: + """ + 根据查询参数获取部门列表信息 + + :param db: orm对象 + :param page_object: 不分页查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 部门列表信息对象 + """ + dept_result = ( + ( + await db.execute( + select(SysDept) + .where( + SysDept.del_flag == '0', + SysDept.dept_id == page_object.dept_id if page_object.dept_id is not None else True, + SysDept.status == page_object.status if page_object.status else True, + SysDept.dept_name.like(f'%{page_object.dept_name}%') if page_object.dept_name else True, + data_scope_sql, + ) + .order_by(SysDept.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + return dept_result + + @classmethod + async def add_dept_dao(cls, db: AsyncSession, dept: DeptModel) -> SysDept: + """ + 新增部门数据库操作 + + :param db: orm对象 + :param dept: 部门对象 + :return: 新增校验结果 + """ + db_dept = SysDept(**dept.model_dump()) + db.add(db_dept) + await db.flush() + + return db_dept + + @classmethod + async def edit_dept_dao(cls, db: AsyncSession, dept: dict) -> None: + """ + 编辑部门数据库操作 + + :param db: orm对象 + :param dept: 需要更新的部门字典 + :return: 编辑校验结果 + """ + await db.execute(update(SysDept), [dept]) + + @classmethod + async def update_dept_children_dao(cls, db: AsyncSession, update_dept: list) -> None: + """ + 更新子部门信息 + + :param db: orm对象 + :param update_dept: 需要更新的部门列表 + :return: + """ + await db.execute( + update(SysDept) + .where(SysDept.dept_id == bindparam('dept_id')) + .values( + { + 'dept_id': bindparam('dept_id'), + 'ancestors': bindparam('ancestors'), + } + ), + update_dept, + execution_options=immutabledict({'synchronize_session': None}), + ) + + @classmethod + async def update_dept_status_normal_dao(cls, db: AsyncSession, dept_id_list: list) -> None: + """ + 批量更新部门状态为正常 + + :param db: orm对象 + :param dept_id_list: 部门id列表 + :return: + """ + await db.execute(update(SysDept).where(SysDept.dept_id.in_(dept_id_list)).values(status='0')) + + @classmethod + async def delete_dept_dao(cls, db: AsyncSession, dept: DeptModel) -> None: + """ + 删除部门数据库操作 + + :param db: orm对象 + :param dept: 部门对象 + :return: + """ + await db.execute( + update(SysDept) + .where(SysDept.dept_id == dept.dept_id) + .values(del_flag='2', update_by=dept.update_by, update_time=dept.update_time) + ) + + @classmethod + async def count_normal_children_dept_dao(cls, db: AsyncSession, dept_id: int) -> int | None: + """ + 根据部门id查询查询所有子部门(正常状态)的数量 + + :param db: orm对象 + :param dept_id: 部门id + :return: 所有子部门(正常状态)的数量 + """ + normal_children_dept_count = ( + await db.execute( + select(func.count('*')) + .select_from(SysDept) + .where(SysDept.status == '0', SysDept.del_flag == '0', func.find_in_set(dept_id, SysDept.ancestors)) + ) + ).scalar() + + return normal_children_dept_count + + @classmethod + async def count_children_dept_dao(cls, db: AsyncSession, dept_id: int) -> int | None: + """ + 根据部门id查询查询所有子部门(所有状态)的数量 + + :param db: orm对象 + :param dept_id: 部门id + :return: 所有子部门(所有状态)的数量 + """ + children_dept_count = ( + await db.execute( + select(func.count('*')) + .select_from(SysDept) + .where(SysDept.del_flag == '0', SysDept.parent_id == dept_id) + .limit(1) + ) + ).scalar() + + return children_dept_count + + @classmethod + async def count_dept_user_dao(cls, db: AsyncSession, dept_id: int) -> int | None: + """ + 根据部门id查询查询部门下的用户数量 + + :param db: orm对象 + :param dept_id: 部门id + :return: 部门下的用户数量 + """ + dept_user_count = ( + await db.execute( + select(func.count('*')).select_from(SysUser).where(SysUser.dept_id == dept_id, SysUser.del_flag == '0') + ) + ).scalar() + + return dept_user_count diff --git a/shierfeng-fastapi-backend/module_admin/dao/dict_dao.py b/shierfeng-fastapi-backend/module_admin/dao/dict_dao.py new file mode 100644 index 0000000..e7b5530 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/dict_dao.py @@ -0,0 +1,294 @@ +from collections.abc import Sequence +from datetime import datetime, time +from typing import Any + +from sqlalchemy import and_, delete, func, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.dict_do import SysDictData, SysDictType +from module_admin.entity.vo.dict_vo import DictDataModel, DictDataPageQueryModel, DictTypeModel, DictTypePageQueryModel +from utils.page_util import PageUtil +from utils.time_format_util import list_format_datetime + + +class DictTypeDao: + """ + 字典类型管理模块数据库操作层 + """ + + @classmethod + async def get_dict_type_detail_by_id(cls, db: AsyncSession, dict_id: int) -> SysDictType | None: + """ + 根据字典类型id获取字典类型详细信息 + + :param db: orm对象 + :param dict_id: 字典类型id + :return: 字典类型信息对象 + """ + dict_type_info = (await db.execute(select(SysDictType).where(SysDictType.dict_id == dict_id))).scalars().first() + + return dict_type_info + + @classmethod + async def get_dict_type_detail_by_info(cls, db: AsyncSession, dict_type: DictTypeModel) -> SysDictType | None: + """ + 根据字典类型参数获取字典类型信息 + + :param db: orm对象 + :param dict_type: 字典类型参数对象 + :return: 字典类型信息对象 + """ + dict_type_info = ( + ( + await db.execute( + select(SysDictType).where( + SysDictType.dict_type == dict_type.dict_type if dict_type.dict_type else True, + SysDictType.dict_name == dict_type.dict_name if dict_type.dict_name else True, + ) + ) + ) + .scalars() + .first() + ) + + return dict_type_info + + @classmethod + async def get_all_dict_type(cls, db: AsyncSession) -> list[Any]: + """ + 获取所有的字典类型信息 + + :param db: orm对象 + :return: 字典类型信息列表对象 + """ + dict_type_info = (await db.execute(select(SysDictType))).scalars().all() + + return list_format_datetime(dict_type_info) + + @classmethod + async def get_dict_type_list( + cls, db: AsyncSession, query_object: DictTypePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取字典类型列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 字典类型列表信息对象 + """ + query = ( + select(SysDictType) + .where( + SysDictType.dict_name.like(f'%{query_object.dict_name}%') if query_object.dict_name else True, + SysDictType.dict_type.like(f'%{query_object.dict_type}%') if query_object.dict_type else True, + SysDictType.status == query_object.status if query_object.status else True, + SysDictType.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .order_by(SysDictType.dict_id) + .distinct() + ) + dict_type_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return dict_type_list + + @classmethod + async def add_dict_type_dao(cls, db: AsyncSession, dict_type: DictTypeModel) -> SysDictType: + """ + 新增字典类型数据库操作 + + :param db: orm对象 + :param dict_type: 字典类型对象 + :return: + """ + db_dict_type = SysDictType(**dict_type.model_dump()) + db.add(db_dict_type) + await db.flush() + + return db_dict_type + + @classmethod + async def edit_dict_type_dao(cls, db: AsyncSession, dict_type: dict) -> None: + """ + 编辑字典类型数据库操作 + + :param db: orm对象 + :param dict_type: 需要更新的字典类型字典 + :return: + """ + await db.execute(update(SysDictType), [dict_type]) + + @classmethod + async def delete_dict_type_dao(cls, db: AsyncSession, dict_type: DictTypeModel) -> None: + """ + 删除字典类型数据库操作 + + :param db: orm对象 + :param dict_type: 字典类型对象 + :return: + """ + await db.execute(delete(SysDictType).where(SysDictType.dict_id.in_([dict_type.dict_id]))) + + +class DictDataDao: + """ + 字典数据管理模块数据库操作层 + """ + + @classmethod + async def get_dict_data_detail_by_id(cls, db: AsyncSession, dict_code: int) -> SysDictData | None: + """ + 根据字典数据id获取字典数据详细信息 + + :param db: orm对象 + :param dict_code: 字典数据id + :return: 字典数据信息对象 + """ + dict_data_info = ( + (await db.execute(select(SysDictData).where(SysDictData.dict_code == dict_code))).scalars().first() + ) + + return dict_data_info + + @classmethod + async def get_dict_data_detail_by_info(cls, db: AsyncSession, dict_data: DictDataModel) -> SysDictData | None: + """ + 根据字典数据参数获取字典数据信息 + + :param db: orm对象 + :param dict_data: 字典数据参数对象 + :return: 字典数据信息对象 + """ + dict_data_info = ( + ( + await db.execute( + select(SysDictData).where( + SysDictData.dict_type == dict_data.dict_type, + SysDictData.dict_label == dict_data.dict_label, + SysDictData.dict_value == dict_data.dict_value, + ) + ) + ) + .scalars() + .first() + ) + + return dict_data_info + + @classmethod + async def get_dict_data_list( + cls, db: AsyncSession, query_object: DictDataPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取字典数据列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 字典数据列表信息对象 + """ + query = ( + select(SysDictData) + .where( + SysDictData.dict_type == query_object.dict_type if query_object.dict_type else True, + SysDictData.dict_label.like(f'%{query_object.dict_label}%') if query_object.dict_label else True, + SysDictData.status == query_object.status if query_object.status else True, + ) + .order_by(SysDictData.dict_sort) + .distinct() + ) + dict_data_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return dict_data_list + + @classmethod + async def query_dict_data_list(cls, db: AsyncSession, dict_type: str) -> Sequence[SysDictData]: + """ + 根据查询参数获取字典数据列表信息 + + :param db: orm对象 + :param dict_type: 字典类型 + :return: 字典数据列表信息对象 + """ + dict_data_list = ( + ( + await db.execute( + select(SysDictData) + .select_from(SysDictType) + .where(SysDictType.dict_type == dict_type if dict_type else True, SysDictType.status == '0') + .join( + SysDictData, + and_(SysDictType.dict_type == SysDictData.dict_type, SysDictData.status == '0'), + isouter=True, + ) + .order_by(SysDictData.dict_sort) + .distinct() + ) + ) + .scalars() + .all() + ) + + return dict_data_list + + @classmethod + async def add_dict_data_dao(cls, db: AsyncSession, dict_data: DictDataModel) -> SysDictData: + """ + 新增字典数据数据库操作 + + :param db: orm对象 + :param dict_data: 字典数据对象 + :return: + """ + db_data_type = SysDictData(**dict_data.model_dump()) + db.add(db_data_type) + await db.flush() + + return db_data_type + + @classmethod + async def edit_dict_data_dao(cls, db: AsyncSession, dict_data: dict) -> None: + """ + 编辑字典数据数据库操作 + + :param db: orm对象 + :param dict_data: 需要更新的字典数据字典 + :return: + """ + await db.execute(update(SysDictData), [dict_data]) + + @classmethod + async def delete_dict_data_dao(cls, db: AsyncSession, dict_data: DictDataModel) -> None: + """ + 删除字典数据数据库操作 + + :param db: orm对象 + :param dict_data: 字典数据对象 + :return: + """ + await db.execute(delete(SysDictData).where(SysDictData.dict_code.in_([dict_data.dict_code]))) + + @classmethod + async def count_dict_data_dao(cls, db: AsyncSession, dict_type: str) -> int | None: + """ + 根据字典类型查询字典类型关联的字典数据数量 + + :param db: orm对象 + :param dict_type: 字典类型 + :return: 字典类型关联的字典数据数量 + """ + dict_data_count = ( + await db.execute(select(func.count('*')).select_from(SysDictData).where(SysDictData.dict_type == dict_type)) + ).scalar() + + return dict_data_count diff --git a/shierfeng-fastapi-backend/module_admin/dao/job_dao.py b/shierfeng-fastapi-backend/module_admin/dao/job_dao.py new file mode 100644 index 0000000..52df8e3 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/job_dao.py @@ -0,0 +1,156 @@ +from collections.abc import Sequence +from typing import Any + +from sqlalchemy import delete, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.job_do import SysJob +from module_admin.entity.vo.job_vo import JobModel, JobPageQueryModel +from utils.page_util import PageUtil + + +class JobDao: + """ + 定时任务管理模块数据库操作层 + """ + + @classmethod + async def get_job_detail_by_id(cls, db: AsyncSession, job_id: int) -> SysJob | None: + """ + 根据定时任务id获取定时任务详细信息 + + :param db: orm对象 + :param job_id: 定时任务id + :return: 定时任务信息对象 + """ + job_info = (await db.execute(select(SysJob).where(SysJob.job_id == job_id))).scalars().first() + + return job_info + + @classmethod + async def get_job_detail_by_info(cls, db: AsyncSession, job: JobModel) -> SysJob | None: + """ + 根据定时任务参数获取定时任务信息 + + :param db: orm对象 + :param job: 定时任务参数对象 + :return: 定时任务信息对象 + """ + job_info = ( + ( + await db.execute( + select(SysJob).where( + SysJob.job_name == job.job_name, + SysJob.job_group == job.job_group, + SysJob.job_executor == job.job_executor, + SysJob.invoke_target == job.invoke_target, + SysJob.job_args == job.job_args, + SysJob.job_kwargs == job.job_kwargs, + SysJob.cron_expression == job.cron_expression, + ) + ) + ) + .scalars() + .first() + ) + + return job_info + + @classmethod + async def get_job_list( + cls, db: AsyncSession, query_object: JobPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取定时任务列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 定时任务列表信息对象 + """ + query = ( + select(SysJob) + .where( + SysJob.job_name.like(f'%{query_object.job_name}%') if query_object.job_name else True, + SysJob.job_group == query_object.job_group if query_object.job_group else True, + SysJob.status == query_object.status if query_object.status else True, + ) + .order_by(SysJob.job_id) + .distinct() + ) + job_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return job_list + + @classmethod + async def get_job_list_for_scheduler(cls, db: AsyncSession) -> Sequence[SysJob]: + """ + 获取定时任务列表信息 + + :param db: orm对象 + :return: 定时任务列表信息对象 + """ + job_list = (await db.execute(select(SysJob).where(SysJob.status == '0').distinct())).scalars().all() + + return job_list + + @classmethod + async def get_all_job_list_for_scheduler(cls, db: AsyncSession) -> Sequence[SysJob]: + """ + 获取全部定时任务列表信息 + + :param db: orm对象 + :return: 定时任务列表信息对象 + """ + job_list = (await db.execute(select(SysJob).distinct())).scalars().all() + + return job_list + + @classmethod + async def add_job_dao(cls, db: AsyncSession, job: JobModel) -> SysJob: + """ + 新增定时任务数据库操作 + + :param db: orm对象 + :param job: 定时任务对象 + :return: + """ + db_job = SysJob(**job.model_dump()) + db.add(db_job) + await db.flush() + + return db_job + + @classmethod + async def edit_job_dao(cls, db: AsyncSession, job: dict, old_job: JobModel) -> None: + """ + 编辑定时任务数据库操作 + + :param db: orm对象 + :param job: 需要更新的定时任务字典 + :param old_job: 原定时任务对象 + :return: + """ + await db.execute( + update(SysJob) + .where( + SysJob.job_id == old_job.job_id, + SysJob.job_name == old_job.job_name, + SysJob.job_group == old_job.job_group, + ) + .values(**job) + ) + + @classmethod + async def delete_job_dao(cls, db: AsyncSession, job: JobModel) -> None: + """ + 删除定时任务数据库操作 + + :param db: orm对象 + :param job: 定时任务对象 + :return: + """ + await db.execute(delete(SysJob).where(SysJob.job_id.in_([job.job_id]))) diff --git a/shierfeng-fastapi-backend/module_admin/dao/job_log_dao.py b/shierfeng-fastapi-backend/module_admin/dao/job_log_dao.py new file mode 100644 index 0000000..4269aaf --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/job_log_dao.py @@ -0,0 +1,87 @@ +from datetime import datetime, time +from typing import Any + +from sqlalchemy import delete, desc, select +from sqlalchemy.ext.asyncio import AsyncSession +from sqlalchemy.orm import Session + +from common.vo import PageModel +from module_admin.entity.do.job_do import SysJobLog +from module_admin.entity.vo.job_vo import JobLogModel, JobLogPageQueryModel +from utils.page_util import PageUtil + + +class JobLogDao: + """ + 定时任务日志管理模块数据库操作层 + """ + + @classmethod + async def get_job_log_list( + cls, db: AsyncSession, query_object: JobLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取定时任务日志列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 定时任务日志列表信息对象 + """ + query = ( + select(SysJobLog) + .where( + SysJobLog.job_name.like(f'%{query_object.job_name}%') if query_object.job_name else True, + SysJobLog.job_group == query_object.job_group if query_object.job_group else True, + SysJobLog.status == query_object.status if query_object.status else True, + SysJobLog.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .order_by(desc(SysJobLog.create_time)) + .distinct() + ) + job_log_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return job_log_list + + @classmethod + def add_job_log_dao(cls, db: Session, job_log: JobLogModel) -> SysJobLog: + """ + 新增定时任务日志数据库操作 + + :param db: orm对象 + :param job_log: 定时任务日志对象 + :return: + """ + db_job_log = SysJobLog(**job_log.model_dump()) + db.add(db_job_log) + db.flush() + + return db_job_log + + @classmethod + async def delete_job_log_dao(cls, db: AsyncSession, job_log: JobLogModel) -> None: + """ + 删除定时任务日志数据库操作 + + :param db: orm对象 + :param job_log: 定时任务日志对象 + :return: + """ + await db.execute(delete(SysJobLog).where(SysJobLog.job_log_id.in_([job_log.job_log_id]))) + + @classmethod + async def clear_job_log_dao(cls, db: AsyncSession) -> None: + """ + 清除定时任务日志数据库操作 + + :param db: orm对象 + :return: + """ + await db.execute(delete(SysJobLog)) diff --git a/shierfeng-fastapi-backend/module_admin/dao/log_dao.py b/shierfeng-fastapi-backend/module_admin/dao/log_dao.py new file mode 100644 index 0000000..5ee3078 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/log_dao.py @@ -0,0 +1,183 @@ +from datetime import datetime, time +from typing import Any + +from sqlalchemy import asc, delete, desc, select +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.log_do import SysLogininfor, SysOperLog +from module_admin.entity.vo.log_vo import LogininforModel, LoginLogPageQueryModel, OperLogModel, OperLogPageQueryModel +from utils.common_util import SnakeCaseUtil +from utils.page_util import PageUtil +from utils.time_format_util import TimeFormatUtil + + +class OperationLogDao: + """ + 操作日志管理模块数据库操作层 + """ + + @classmethod + async def get_operation_log_list( + cls, db: AsyncSession, query_object: OperLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取操作日志列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 操作日志列表信息对象 + """ + if query_object.is_asc == 'ascending': + order_by_column = asc(getattr(SysOperLog, SnakeCaseUtil.camel_to_snake(query_object.order_by_column), None)) + elif query_object.is_asc == 'descending': + order_by_column = desc( + getattr(SysOperLog, SnakeCaseUtil.camel_to_snake(query_object.order_by_column), None) + ) + else: + order_by_column = desc(SysOperLog.oper_time) + query = ( + select(SysOperLog) + .where( + SysOperLog.title.like(f'%{query_object.title}%') if query_object.title else True, + SysOperLog.oper_name.like(f'%{query_object.oper_name}%') if query_object.oper_name else True, + SysOperLog.business_type == query_object.business_type if query_object.business_type else True, + SysOperLog.status == query_object.status if query_object.status else True, + SysOperLog.oper_time.between( + datetime.combine(TimeFormatUtil.parse_date(query_object.begin_time), time(00, 00, 00)), + datetime.combine(TimeFormatUtil.parse_date(query_object.end_time), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .distinct() + .order_by(order_by_column) + ) + operation_log_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return operation_log_list + + @classmethod + async def add_operation_log_dao(cls, db: AsyncSession, operation_log: OperLogModel) -> SysOperLog: + """ + 新增操作日志数据库操作 + + :param db: orm对象 + :param operation_log: 操作日志对象 + :return: 新增校验结果 + """ + db_operation_log = SysOperLog(**operation_log.model_dump()) + db.add(db_operation_log) + await db.flush() + + return db_operation_log + + @classmethod + async def delete_operation_log_dao(cls, db: AsyncSession, operation_log: OperLogModel) -> None: + """ + 删除操作日志数据库操作 + + :param db: orm对象 + :param operation_log: 操作日志对象 + :return: + """ + await db.execute(delete(SysOperLog).where(SysOperLog.oper_id.in_([operation_log.oper_id]))) + + @classmethod + async def clear_operation_log_dao(cls, db: AsyncSession) -> None: + """ + 清除操作日志数据库操作 + + :param db: orm对象 + :return: + """ + await db.execute(delete(SysOperLog)) + + +class LoginLogDao: + """ + 登录日志管理模块数据库操作层 + """ + + @classmethod + async def get_login_log_list( + cls, db: AsyncSession, query_object: LoginLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取登录日志列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 登录日志列表信息对象 + """ + if query_object.is_asc == 'ascending': + order_by_column = asc( + getattr(SysLogininfor, SnakeCaseUtil.camel_to_snake(query_object.order_by_column), None) + ) + elif query_object.is_asc == 'descending': + order_by_column = desc( + getattr(SysLogininfor, SnakeCaseUtil.camel_to_snake(query_object.order_by_column), None) + ) + else: + order_by_column = desc(SysLogininfor.login_time) + query = ( + select(SysLogininfor) + .where( + SysLogininfor.ipaddr.like(f'%{query_object.ipaddr}%') if query_object.ipaddr else True, + SysLogininfor.user_name.like(f'%{query_object.user_name}%') if query_object.user_name else True, + SysLogininfor.status == query_object.status if query_object.status else True, + SysLogininfor.login_time.between( + datetime.combine(TimeFormatUtil.parse_date(query_object.begin_time), time(00, 00, 00)), + datetime.combine(TimeFormatUtil.parse_date(query_object.end_time), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .distinct() + .order_by(order_by_column) + ) + login_log_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return login_log_list + + @classmethod + async def add_login_log_dao(cls, db: AsyncSession, login_log: LogininforModel) -> SysLogininfor: + """ + 新增登录日志数据库操作 + + :param db: orm对象 + :param login_log: 登录日志对象 + :return: 新增校验结果 + """ + db_login_log = SysLogininfor(**login_log.model_dump()) + db.add(db_login_log) + await db.flush() + + return db_login_log + + @classmethod + async def delete_login_log_dao(cls, db: AsyncSession, login_log: LogininforModel) -> None: + """ + 删除登录日志数据库操作 + + :param db: orm对象 + :param login_log: 登录日志对象 + :return: + """ + await db.execute(delete(SysLogininfor).where(SysLogininfor.info_id.in_([login_log.info_id]))) + + @classmethod + async def clear_login_log_dao(cls, db: AsyncSession) -> None: + """ + 清除登录日志数据库操作 + + :param db: orm对象 + :return: + """ + await db.execute(delete(SysLogininfor)) diff --git a/shierfeng-fastapi-backend/module_admin/dao/login_dao.py b/shierfeng-fastapi-backend/module_admin/dao/login_dao.py new file mode 100644 index 0000000..fe68bc2 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/login_dao.py @@ -0,0 +1,29 @@ +from sqlalchemy import Row, and_, select +from sqlalchemy.ext.asyncio import AsyncSession + +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.user_do import SysUser + + +async def login_by_account(db: AsyncSession, user_name: str) -> Row[tuple[SysUser, SysDept]] | None: + """ + 根据用户名查询用户信息 + + :param db: orm对象 + :param user_name: 用户名 + :return: 用户对象 + """ + user = ( + await db.execute( + select(SysUser, SysDept) + .where(SysUser.user_name == user_name, SysUser.del_flag == '0') + .join( + SysDept, + and_(SysUser.dept_id == SysDept.dept_id, SysDept.status == '0', SysDept.del_flag == '0'), + isouter=True, + ) + .distinct() + ) + ).first() + + return user diff --git a/shierfeng-fastapi-backend/module_admin/dao/menu_dao.py b/shierfeng-fastapi-backend/module_admin/dao/menu_dao.py new file mode 100644 index 0000000..b827e42 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/menu_dao.py @@ -0,0 +1,228 @@ +from collections.abc import Sequence + +from sqlalchemy import and_, delete, func, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from module_admin.entity.do.menu_do import SysMenu +from module_admin.entity.do.role_do import SysRole, SysRoleMenu +from module_admin.entity.do.user_do import SysUser, SysUserRole +from module_admin.entity.vo.menu_vo import MenuModel, MenuQueryModel + + +class MenuDao: + """ + 菜单管理模块数据库操作层 + """ + + @classmethod + async def get_menu_detail_by_id(cls, db: AsyncSession, menu_id: int) -> SysMenu | None: + """ + 根据菜单id获取菜单详细信息 + + :param db: orm对象 + :param menu_id: 菜单id + :return: 菜单信息对象 + """ + menu_info = (await db.execute(select(SysMenu).where(SysMenu.menu_id == menu_id))).scalars().first() + + return menu_info + + @classmethod + async def get_menu_detail_by_info(cls, db: AsyncSession, menu: MenuModel) -> SysMenu | None: + """ + 根据菜单参数获取菜单信息 + + :param db: orm对象 + :param menu: 菜单参数对象 + :return: 菜单信息对象 + """ + menu_info = ( + ( + await db.execute( + select(SysMenu).where( + SysMenu.parent_id == menu.parent_id if menu.parent_id else True, + SysMenu.menu_name == menu.menu_name if menu.menu_name else True, + SysMenu.menu_type == menu.menu_type if menu.menu_type else True, + ) + ) + ) + .scalars() + .first() + ) + + return menu_info + + @classmethod + async def get_menu_list_for_tree(cls, db: AsyncSession, user_id: int, role: list) -> Sequence[SysMenu]: + """ + 根据角色信息获取所有在用菜单列表信息 + + :param db: orm对象 + :param user_id: 用户id + :param role: 用户角色列表信息 + :return: 菜单列表信息 + """ + role_id_list = [item.role_id for item in role] + if 1 in role_id_list: + menu_query_all = ( + (await db.execute(select(SysMenu).where(SysMenu.status == '0').order_by(SysMenu.order_num).distinct())) + .scalars() + .all() + ) + else: + menu_query_all = ( + ( + await db.execute( + select(SysMenu) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_( + SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0' + ), + isouter=True, + ) + .join(SysRoleMenu, SysRole.role_id == SysRoleMenu.role_id, isouter=True) + .join(SysMenu, and_(SysRoleMenu.menu_id == SysMenu.menu_id, SysMenu.status == '0')) + .order_by(SysMenu.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + return menu_query_all + + @classmethod + async def get_menu_list( + cls, db: AsyncSession, page_object: MenuQueryModel, user_id: int, role: list + ) -> Sequence[SysMenu]: + """ + 根据查询参数获取菜单列表信息 + + :param db: orm对象 + :param page_object: 不分页查询参数对象 + :param user_id: 用户id + :param role: 用户角色列表 + :return: 菜单列表信息对象 + """ + role_id_list = [item.role_id for item in role] + if 1 in role_id_list: + menu_query_all = ( + ( + await db.execute( + select(SysMenu) + .where( + SysMenu.status == page_object.status if page_object.status else True, + SysMenu.menu_name.like(f'%{page_object.menu_name}%') if page_object.menu_name else True, + ) + .order_by(SysMenu.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + else: + menu_query_all = ( + ( + await db.execute( + select(SysMenu) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_( + SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0' + ), + isouter=True, + ) + .join(SysRoleMenu, SysRole.role_id == SysRoleMenu.role_id, isouter=True) + .join( + SysMenu, + and_( + SysRoleMenu.menu_id == SysMenu.menu_id, + SysMenu.status == page_object.status if page_object.status else True, + SysMenu.menu_name.like(f'%{page_object.menu_name}%') if page_object.menu_name else True, + ), + ) + .order_by(SysMenu.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + return menu_query_all + + @classmethod + async def add_menu_dao(cls, db: AsyncSession, menu: MenuModel) -> SysMenu: + """ + 新增菜单数据库操作 + + :param db: orm对象 + :param menu: 菜单对象 + :return: + """ + db_menu = SysMenu(**menu.model_dump()) + db.add(db_menu) + await db.flush() + + return db_menu + + @classmethod + async def edit_menu_dao(cls, db: AsyncSession, menu: dict) -> None: + """ + 编辑菜单数据库操作 + + :param db: orm对象 + :param menu: 需要更新的菜单字典 + :return: + """ + await db.execute(update(SysMenu), [menu]) + + @classmethod + async def delete_menu_dao(cls, db: AsyncSession, menu: MenuModel) -> None: + """ + 删除菜单数据库操作 + + :param db: orm对象 + :param menu: 菜单对象 + :return: + """ + await db.execute(delete(SysMenu).where(SysMenu.menu_id.in_([menu.menu_id]))) + + @classmethod + async def has_child_by_menu_id_dao(cls, db: AsyncSession, menu_id: int) -> int | None: + """ + 根据菜单id查询菜单关联子菜单的数量 + + :param db: orm对象 + :param menu_id: 菜单id + :return: 菜单关联子菜单的数量 + """ + menu_count = ( + await db.execute(select(func.count('*')).select_from(SysMenu).where(SysMenu.parent_id == menu_id)) + ).scalar() + + return menu_count + + @classmethod + async def check_menu_exist_role_dao(cls, db: AsyncSession, menu_id: int) -> int | None: + """ + 根据菜单id查询菜单关联角色数量 + + :param db: orm对象 + :param menu_id: 菜单id + :return: 菜单关联角色数量 + """ + role_count = ( + await db.execute(select(func.count('*')).select_from(SysRoleMenu).where(SysRoleMenu.menu_id == menu_id)) + ).scalar() + + return role_count diff --git a/shierfeng-fastapi-backend/module_admin/dao/notice_dao.py b/shierfeng-fastapi-backend/module_admin/dao/notice_dao.py new file mode 100644 index 0000000..942736c --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/notice_dao.py @@ -0,0 +1,125 @@ +from datetime import datetime, time +from typing import Any + +from sqlalchemy import delete, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.notice_do import SysNotice +from module_admin.entity.vo.notice_vo import NoticeModel, NoticePageQueryModel +from utils.page_util import PageUtil + + +class NoticeDao: + """ + 通知公告管理模块数据库操作层 + """ + + @classmethod + async def get_notice_detail_by_id(cls, db: AsyncSession, notice_id: int) -> SysNotice | None: + """ + 根据通知公告id获取通知公告详细信息 + + :param db: orm对象 + :param notice_id: 通知公告id + :return: 通知公告信息对象 + """ + notice_info = (await db.execute(select(SysNotice).where(SysNotice.notice_id == notice_id))).scalars().first() + + return notice_info + + @classmethod + async def get_notice_detail_by_info(cls, db: AsyncSession, notice: NoticeModel) -> SysNotice | None: + """ + 根据通知公告参数获取通知公告信息 + + :param db: orm对象 + :param notice: 通知公告参数对象 + :return: 通知公告信息对象 + """ + notice_info = ( + ( + await db.execute( + select(SysNotice).where( + SysNotice.notice_title == notice.notice_title, + SysNotice.notice_type == notice.notice_type, + SysNotice.notice_content == notice.notice_content, + ) + ) + ) + .scalars() + .first() + ) + + return notice_info + + @classmethod + async def get_notice_list( + cls, db: AsyncSession, query_object: NoticePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取通知公告列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 通知公告列表信息对象 + """ + query = ( + select(SysNotice) + .where( + SysNotice.notice_title.like(f'%{query_object.notice_title}%') if query_object.notice_title else True, + SysNotice.create_by.like(f'%{query_object.create_by}%') if query_object.create_by else True, + SysNotice.notice_type == query_object.notice_type if query_object.notice_type else True, + SysNotice.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .order_by(SysNotice.notice_id) + .distinct() + ) + notice_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return notice_list + + @classmethod + async def add_notice_dao(cls, db: AsyncSession, notice: NoticeModel) -> SysNotice: + """ + 新增通知公告数据库操作 + + :param db: orm对象 + :param notice: 通知公告对象 + :return: + """ + db_notice = SysNotice(**notice.model_dump()) + db.add(db_notice) + await db.flush() + + return db_notice + + @classmethod + async def edit_notice_dao(cls, db: AsyncSession, notice: dict) -> None: + """ + 编辑通知公告数据库操作 + + :param db: orm对象 + :param notice: 需要更新的通知公告字典 + :return: + """ + await db.execute(update(SysNotice), [notice]) + + @classmethod + async def delete_notice_dao(cls, db: AsyncSession, notice: NoticeModel) -> None: + """ + 删除通知公告数据库操作 + + :param db: orm对象 + :param notice: 通知公告对象 + :return: + """ + await db.execute(delete(SysNotice).where(SysNotice.notice_id.in_([notice.notice_id]))) diff --git a/shierfeng-fastapi-backend/module_admin/dao/post_dao.py b/shierfeng-fastapi-backend/module_admin/dao/post_dao.py new file mode 100644 index 0000000..da67123 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/post_dao.py @@ -0,0 +1,151 @@ +from typing import Any + +from sqlalchemy import delete, func, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.post_do import SysPost +from module_admin.entity.do.user_do import SysUserPost +from module_admin.entity.vo.post_vo import PostModel, PostPageQueryModel +from utils.page_util import PageUtil + + +class PostDao: + """ + 岗位管理模块数据库操作层 + """ + + @classmethod + async def get_post_by_id(cls, db: AsyncSession, post_id: int) -> SysPost | None: + """ + 根据岗位id获取在用岗位详细信息 + + :param db: orm对象 + :param post_id: 岗位id + :return: 在用岗位信息对象 + """ + post_info = ( + (await db.execute(select(SysPost).where(SysPost.post_id == post_id, SysPost.status == '0'))) + .scalars() + .first() + ) + + return post_info + + @classmethod + async def get_post_detail_by_id(cls, db: AsyncSession, post_id: int) -> SysPost | None: + """ + 根据岗位id获取岗位详细信息 + + :param db: orm对象 + :param post_id: 岗位id + :return: 岗位信息对象 + """ + post_info = (await db.execute(select(SysPost).where(SysPost.post_id == post_id))).scalars().first() + + return post_info + + @classmethod + async def get_post_detail_by_info(cls, db: AsyncSession, post: PostModel) -> SysPost | None: + """ + 根据岗位参数获取岗位信息 + + :param db: orm对象 + :param post: 岗位参数对象 + :return: 岗位信息对象 + """ + post_info = ( + ( + await db.execute( + select(SysPost).where( + SysPost.post_name == post.post_name if post.post_name else True, + SysPost.post_code == post.post_code if post.post_code else True, + SysPost.post_sort == post.post_sort if post.post_sort else True, + ) + ) + ) + .scalars() + .first() + ) + + return post_info + + @classmethod + async def get_post_list( + cls, db: AsyncSession, query_object: PostPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取岗位列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 岗位列表信息对象 + """ + query = ( + select(SysPost) + .where( + SysPost.post_code.like(f'%{query_object.post_code}%') if query_object.post_code else True, + SysPost.post_name.like(f'%{query_object.post_name}%') if query_object.post_name else True, + SysPost.status == query_object.status if query_object.status else True, + ) + .order_by(SysPost.post_sort) + .distinct() + ) + post_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return post_list + + @classmethod + async def add_post_dao(cls, db: AsyncSession, post: PostModel) -> SysPost: + """ + 新增岗位数据库操作 + + :param db: orm对象 + :param post: 岗位对象 + :return: + """ + db_post = SysPost(**post.model_dump()) + db.add(db_post) + await db.flush() + + return db_post + + @classmethod + async def edit_post_dao(cls, db: AsyncSession, post: dict) -> None: + """ + 编辑岗位数据库操作 + + :param db: orm对象 + :param post: 需要更新的岗位字典 + :return: + """ + await db.execute(update(SysPost), [post]) + + @classmethod + async def delete_post_dao(cls, db: AsyncSession, post: PostModel) -> None: + """ + 删除岗位数据库操作 + + :param db: orm对象 + :param post: 岗位对象 + :return: + """ + await db.execute(delete(SysPost).where(SysPost.post_id.in_([post.post_id]))) + + @classmethod + async def count_user_post_dao(cls, db: AsyncSession, post_id: int) -> int | None: + """ + 根据岗位id查询岗位关联的用户数量 + + :param db: orm对象 + :param post_id: 岗位id + :return: 岗位关联的用户数量 + """ + user_post_count = ( + await db.execute(select(func.count('*')).select_from(SysUserPost).where(SysUserPost.post_id == post_id)) + ).scalar() + + return user_post_count diff --git a/shierfeng-fastapi-backend/module_admin/dao/role_dao.py b/shierfeng-fastapi-backend/module_admin/dao/role_dao.py new file mode 100644 index 0000000..c4e295f --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/role_dao.py @@ -0,0 +1,345 @@ +from collections.abc import Sequence +from datetime import datetime, time +from typing import Any + +from sqlalchemy import ColumnElement, and_, delete, desc, func, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.menu_do import SysMenu +from module_admin.entity.do.role_do import SysRole, SysRoleDept, SysRoleMenu +from module_admin.entity.do.user_do import SysUser, SysUserRole +from module_admin.entity.vo.role_vo import RoleDeptModel, RoleMenuModel, RoleModel, RolePageQueryModel +from utils.page_util import PageUtil + + +class RoleDao: + """ + 角色管理模块数据库操作层 + """ + + @classmethod + async def get_role_by_name(cls, db: AsyncSession, role_name: str) -> SysRole | None: + """ + 根据角色名获取在用角色信息 + + :param db: orm对象 + :param role_name: 角色名 + :return: 当前角色名的角色信息对象 + """ + query_role_info = ( + ( + await db.execute( + select(SysRole) + .where(SysRole.status == '0', SysRole.del_flag == '0', SysRole.role_name == role_name) + .order_by(desc(SysRole.create_time)) + .distinct() + ) + ) + .scalars() + .first() + ) + + return query_role_info + + @classmethod + async def get_role_by_info(cls, db: AsyncSession, role: RoleModel) -> SysRole | None: + """ + 根据角色参数获取角色信息 + + :param db: orm对象 + :param role: 角色参数 + :return: 当前角色参数的角色信息对象 + """ + query_role_info = ( + ( + await db.execute( + select(SysRole) + .where( + SysRole.del_flag == '0', + SysRole.role_name == role.role_name if role.role_name else True, + SysRole.role_key == role.role_key if role.role_key else True, + ) + .order_by(desc(SysRole.create_time)) + .distinct() + ) + ) + .scalars() + .first() + ) + + return query_role_info + + @classmethod + async def get_role_by_id(cls, db: AsyncSession, role_id: int) -> SysRole | None: + """ + 根据角色id获取在用角色信息 + + :param db: orm对象 + :param role_id: 角色id + :return: 当前角色id的角色信息对象 + """ + role_info = ( + ( + await db.execute( + select(SysRole).where(SysRole.role_id == role_id, SysRole.status == '0', SysRole.del_flag == '0') + ) + ) + .scalars() + .first() + ) + + return role_info + + @classmethod + async def get_role_detail_by_id(cls, db: AsyncSession, role_id: int) -> SysRole | None: + """ + 根据role_id获取角色详细信息 + + :param db: orm对象 + :param role_id: 角色id + :return: 当前role_id的角色信息对象 + """ + query_role_info = ( + (await db.execute(select(SysRole).where(SysRole.del_flag == '0', SysRole.role_id == role_id).distinct())) + .scalars() + .first() + ) + + return query_role_info + + @classmethod + async def get_role_select_option_dao(cls, db: AsyncSession) -> Sequence[SysRole]: + """ + 获取编辑页面对应的在用角色列表信息 + + :param db: orm对象 + :return: 角色列表信息 + """ + role_info = ( + ( + await db.execute( + select(SysRole).where(SysRole.role_id != 1, SysRole.status == '0', SysRole.del_flag == '0') + ) + ) + .scalars() + .all() + ) + + return role_info + + @classmethod + async def get_role_list( + cls, db: AsyncSession, query_object: RolePageQueryModel, data_scope_sql: ColumnElement, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取角色列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 角色列表信息对象 + """ + query = ( + select(SysRole) + .join(SysUserRole, SysUserRole.role_id == SysRole.role_id, isouter=True) + .join(SysUser, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join(SysDept, SysDept.dept_id == SysUser.dept_id, isouter=True) + .where( + SysRole.del_flag == '0', + SysRole.role_id == query_object.role_id if query_object.role_id is not None else True, + SysRole.role_name.like(f'%{query_object.role_name}%') if query_object.role_name else True, + SysRole.role_key.like(f'%{query_object.role_key}%') if query_object.role_key else True, + SysRole.status == query_object.status if query_object.status else True, + SysRole.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + data_scope_sql, + ) + .order_by(SysRole.role_sort) + .distinct() + ) + role_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return role_list + + @classmethod + async def add_role_dao(cls, db: AsyncSession, role: RoleModel) -> SysRole: + """ + 新增角色数据库操作 + + :param db: orm对象 + :param role: 角色对象 + :return: + """ + db_role = SysRole(**role.model_dump(exclude={'admin'})) + db.add(db_role) + await db.flush() + + return db_role + + @classmethod + async def edit_role_dao(cls, db: AsyncSession, role: dict) -> None: + """ + 编辑角色数据库操作 + + :param db: orm对象 + :param role: 需要更新的角色字典 + :return: + """ + await db.execute(update(SysRole), [role]) + + @classmethod + async def delete_role_dao(cls, db: AsyncSession, role: RoleModel) -> None: + """ + 删除角色数据库操作 + + :param db: orm对象 + :param role: 角色对象 + :return: + """ + await db.execute( + update(SysRole) + .where(SysRole.role_id == role.role_id) + .values(del_flag='2', update_by=role.update_by, update_time=role.update_time) + ) + + @classmethod + async def get_role_menu_dao(cls, db: AsyncSession, role: RoleModel) -> Sequence[SysMenu]: + """ + 根据角色id获取角色菜单关联列表信息 + + :param db: orm对象 + :param role: 角色对象 + :return: 角色菜单关联列表信息 + """ + role_menu_query_all = ( + ( + await db.execute( + select(SysMenu) + .join(SysRoleMenu, SysRoleMenu.menu_id == SysMenu.menu_id) + .where( + SysRoleMenu.role_id == role.role_id, + ~SysMenu.menu_id.in_( + select(SysMenu.parent_id) + .select_from(SysMenu) + .join( + SysRoleMenu, + and_(SysRoleMenu.menu_id == SysMenu.menu_id, SysRoleMenu.role_id == role.role_id), + ) + ) + if role.menu_check_strictly + else True, + ) + .order_by(SysMenu.parent_id, SysMenu.order_num) + ) + ) + .scalars() + .all() + ) + + return role_menu_query_all + + @classmethod + async def add_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel) -> None: + """ + 新增角色菜单关联信息数据库操作 + + :param db: orm对象 + :param role_menu: 用户角色菜单关联对象 + :return: + """ + db_role_menu = SysRoleMenu(**role_menu.model_dump()) + db.add(db_role_menu) + + @classmethod + async def delete_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel) -> None: + """ + 删除角色菜单关联信息数据库操作 + + :param db: orm对象 + :param role_menu: 角色菜单关联对象 + :return: + """ + await db.execute(delete(SysRoleMenu).where(SysRoleMenu.role_id.in_([role_menu.role_id]))) + + @classmethod + async def get_role_dept_dao(cls, db: AsyncSession, role: RoleModel) -> Sequence[SysDept]: + """ + 根据角色id获取角色部门关联列表信息 + + :param db: orm对象 + :param role: 角色对象 + :return: 角色部门关联列表信息 + """ + role_dept_query_all = ( + ( + await db.execute( + select(SysDept) + .join(SysRoleDept, SysRoleDept.dept_id == SysDept.dept_id) + .where( + SysRoleDept.role_id == role.role_id, + ~SysDept.dept_id.in_( + select(SysDept.parent_id) + .select_from(SysDept) + .join( + SysRoleDept, + and_(SysRoleDept.dept_id == SysDept.dept_id, SysRoleDept.role_id == role.role_id), + ) + ) + if role.dept_check_strictly + else True, + ) + .order_by(SysDept.parent_id, SysDept.order_num) + ) + ) + .scalars() + .all() + ) + + return role_dept_query_all + + @classmethod + async def add_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel) -> None: + """ + 新增角色部门关联信息数据库操作 + + :param db: orm对象 + :param role_dept: 用户角色部门关联对象 + :return: + """ + db_role_dept = SysRoleDept(**role_dept.dict()) + db.add(db_role_dept) + + @classmethod + async def delete_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel) -> None: + """ + 删除角色部门关联信息数据库操作 + + :param db: orm对象 + :param role_dept: 角色部门关联对象 + :return: + """ + await db.execute(delete(SysRoleDept).where(SysRoleDept.role_id.in_([role_dept.role_id]))) + + @classmethod + async def count_user_role_dao(cls, db: AsyncSession, role_id: int) -> int | None: + """ + 根据角色id查询角色关联用户数量 + + :param db: orm对象 + :param role_id: 角色id + :return: 角色关联用户数量 + """ + user_count = ( + await db.execute(select(func.count('*')).select_from(SysUserRole).where(SysUserRole.role_id == role_id)) + ).scalar() + + return user_count diff --git a/shierfeng-fastapi-backend/module_admin/dao/user_dao.py b/shierfeng-fastapi-backend/module_admin/dao/user_dao.py new file mode 100644 index 0000000..71b7c4b --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/dao/user_dao.py @@ -0,0 +1,587 @@ +from collections.abc import Sequence +from datetime import datetime, time +from typing import Any + +from sqlalchemy import ColumnElement, and_, delete, desc, func, or_, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.menu_do import SysMenu +from module_admin.entity.do.post_do import SysPost +from module_admin.entity.do.role_do import SysRole, SysRoleMenu +from module_admin.entity.do.user_do import SysUser, SysUserPost, SysUserRole +from module_admin.entity.vo.user_vo import ( + UserModel, + UserPageQueryModel, + UserPostModel, + UserRoleModel, + UserRolePageQueryModel, + UserRoleQueryModel, +) +from utils.page_util import PageUtil + + +class UserDao: + """ + 用户管理模块数据库操作层 + """ + + @classmethod + async def get_user_by_name(cls, db: AsyncSession, user_name: str) -> SysUser | None: + """ + 根据用户名获取用户信息 + + :param db: orm对象 + :param user_name: 用户名 + :return: 当前用户名的用户信息对象 + """ + query_user_info = ( + ( + await db.execute( + select(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_name == user_name) + .order_by(desc(SysUser.create_time)) + .distinct() + ) + ) + .scalars() + .first() + ) + + return query_user_info + + @classmethod + async def get_user_by_info(cls, db: AsyncSession, user: UserModel) -> SysUser | None: + """ + 根据用户参数获取用户信息 + + :param db: orm对象 + :param user: 用户参数 + :return: 当前用户参数的用户信息对象 + """ + query_user_info = ( + ( + await db.execute( + select(SysUser) + .where( + SysUser.del_flag == '0', + SysUser.user_name == user.user_name if user.user_name else True, + SysUser.phonenumber == user.phonenumber if user.phonenumber else True, + SysUser.email == user.email if user.email else True, + ) + .order_by(desc(SysUser.create_time)) + .distinct() + ) + ) + .scalars() + .first() + ) + + return query_user_info + + @classmethod + async def get_user_by_id(cls, db: AsyncSession, user_id: int) -> dict[str, Any]: + """ + 根据user_id获取用户信息 + + :param db: orm对象 + :param user_id: 用户id + :return: 当前user_id的用户信息对象 + """ + query_user_basic_info = ( + ( + await db.execute( + select(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .distinct() + ) + ) + .scalars() + .first() + ) + query_user_dept_info = ( + ( + await db.execute( + select(SysDept) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join( + SysDept, + and_(SysUser.dept_id == SysDept.dept_id, SysDept.status == '0', SysDept.del_flag == '0'), + ) + .distinct() + ) + ) + .scalars() + .first() + ) + query_user_role_info = ( + ( + await db.execute( + select(SysRole) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_(SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0'), + ) + .distinct() + ) + ) + .scalars() + .all() + ) + query_user_post_info = ( + ( + await db.execute( + select(SysPost) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserPost, SysUser.user_id == SysUserPost.user_id, isouter=True) + .join(SysPost, and_(SysUserPost.post_id == SysPost.post_id, SysPost.status == '0')) + .distinct() + ) + ) + .scalars() + .all() + ) + role_id_list = [item.role_id for item in query_user_role_info] + if 1 in role_id_list: + query_user_menu_info = ( + (await db.execute(select(SysMenu).where(SysMenu.status == '0').distinct())).scalars().all() + ) + else: + query_user_menu_info = ( + ( + await db.execute( + select(SysMenu) + .select_from(SysUser) + .where(SysUser.status == '0', SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_( + SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0' + ), + isouter=True, + ) + .join(SysRoleMenu, SysRole.role_id == SysRoleMenu.role_id, isouter=True) + .join(SysMenu, and_(SysRoleMenu.menu_id == SysMenu.menu_id, SysMenu.status == '0')) + .order_by(SysMenu.order_num) + .distinct() + ) + ) + .scalars() + .all() + ) + + results = { + 'user_basic_info': query_user_basic_info, + 'user_dept_info': query_user_dept_info, + 'user_role_info': query_user_role_info, + 'user_post_info': query_user_post_info, + 'user_menu_info': query_user_menu_info, + } + + return results + + @classmethod + async def get_user_detail_by_id(cls, db: AsyncSession, user_id: int) -> dict[str, Any]: + """ + 根据user_id获取用户详细信息 + + :param db: orm对象 + :param user_id: 用户id + :return: 当前user_id的用户信息对象 + """ + query_user_basic_info = ( + (await db.execute(select(SysUser).where(SysUser.del_flag == '0', SysUser.user_id == user_id).distinct())) + .scalars() + .first() + ) + query_user_dept_info = ( + ( + await db.execute( + select(SysDept) + .select_from(SysUser) + .where(SysUser.del_flag == '0', SysUser.user_id == user_id) + .join( + SysDept, + and_(SysUser.dept_id == SysDept.dept_id, SysDept.status == '0', SysDept.del_flag == '0'), + ) + .distinct() + ) + ) + .scalars() + .first() + ) + query_user_role_info = ( + ( + await db.execute( + select(SysRole) + .select_from(SysUser) + .where(SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_(SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0'), + ) + .distinct() + ) + ) + .scalars() + .all() + ) + query_user_post_info = ( + ( + await db.execute( + select(SysPost) + .select_from(SysUser) + .where(SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserPost, SysUser.user_id == SysUserPost.user_id, isouter=True) + .join(SysPost, and_(SysUserPost.post_id == SysPost.post_id, SysPost.status == '0')) + .distinct() + ) + ) + .scalars() + .all() + ) + query_user_menu_info = ( + ( + await db.execute( + select(SysMenu) + .select_from(SysUser) + .where(SysUser.del_flag == '0', SysUser.user_id == user_id) + .join(SysUserRole, SysUser.user_id == SysUserRole.user_id, isouter=True) + .join( + SysRole, + and_(SysUserRole.role_id == SysRole.role_id, SysRole.status == '0', SysRole.del_flag == '0'), + isouter=True, + ) + .join(SysRoleMenu, SysRole.role_id == SysRoleMenu.role_id, isouter=True) + .join(SysMenu, and_(SysRoleMenu.menu_id == SysMenu.menu_id, SysMenu.status == '0')) + .distinct() + ) + ) + .scalars() + .all() + ) + results = { + 'user_basic_info': query_user_basic_info, + 'user_dept_info': query_user_dept_info, + 'user_role_info': query_user_role_info, + 'user_post_info': query_user_post_info, + 'user_menu_info': query_user_menu_info, + } + + return results + + @classmethod + async def get_user_list( + cls, db: AsyncSession, query_object: UserPageQueryModel, data_scope_sql: ColumnElement, is_page: bool = False + ) -> PageModel | list[list[dict[str, Any]]]: + """ + 根据查询参数获取用户列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 用户列表信息对象 + """ + query = ( + select(SysUser, SysDept) + .where( + SysUser.del_flag == '0', + or_( + SysUser.dept_id == query_object.dept_id, + SysUser.dept_id.in_( + select(SysDept.dept_id).where(func.find_in_set(query_object.dept_id, SysDept.ancestors)) + ), + ) + if query_object.dept_id + else True, + SysUser.user_id == query_object.user_id if query_object.user_id is not None else True, + SysUser.user_name.like(f'%{query_object.user_name}%') if query_object.user_name else True, + SysUser.nick_name.like(f'%{query_object.nick_name}%') if query_object.nick_name else True, + SysUser.email.like(f'%{query_object.email}%') if query_object.email else True, + SysUser.phonenumber.like(f'%{query_object.phonenumber}%') if query_object.phonenumber else True, + SysUser.status == query_object.status if query_object.status else True, + SysUser.sex == query_object.sex if query_object.sex else True, + SysUser.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + data_scope_sql, + ) + .join( + SysDept, + and_(SysUser.dept_id == SysDept.dept_id, SysDept.status == '0', SysDept.del_flag == '0'), + isouter=True, + ) + .order_by(SysUser.user_id) + .distinct() + ) + user_list: PageModel | list[list[dict[str, Any]]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return user_list + + @classmethod + async def add_user_dao(cls, db: AsyncSession, user: UserModel) -> SysUser: + """ + 新增用户数据库操作 + + :param db: orm对象 + :param user: 用户对象 + :return: 新增校验结果 + """ + db_user = SysUser(**user.model_dump(exclude={'admin'})) + db.add(db_user) + await db.flush() + + return db_user + + @classmethod + async def edit_user_dao(cls, db: AsyncSession, user: dict) -> None: + """ + 编辑用户数据库操作 + + :param db: orm对象 + :param user: 需要更新的用户字典 + :return: 编辑校验结果 + """ + await db.execute(update(SysUser), [user]) + + @classmethod + async def delete_user_dao(cls, db: AsyncSession, user: UserModel) -> None: + """ + 删除用户数据库操作 + + :param db: orm对象 + :param user: 用户对象 + :return: + """ + await db.execute( + update(SysUser) + .where(SysUser.user_id == user.user_id) + .values(del_flag='2', update_by=user.update_by, update_time=user.update_time) + ) + + @classmethod + async def get_user_role_allocated_list_by_user_id( + cls, db: AsyncSession, query_object: UserRoleQueryModel + ) -> Sequence[SysRole]: + """ + 根据用户id获取用户已分配的角色列表信息数据库操作 + + :param db: orm对象 + :param query_object: 用户角色查询对象 + :return: 用户已分配的角色列表信息 + """ + allocated_role_list = ( + ( + await db.execute( + select(SysRole) + .where( + SysRole.del_flag == '0', + SysRole.role_id != 1, + SysRole.role_name == query_object.role_name if query_object.role_name else True, + SysRole.role_key == query_object.role_key if query_object.role_key else True, + SysRole.role_id.in_( + select(SysUserRole.role_id).where(SysUserRole.user_id == query_object.user_id) + ), + ) + .distinct() + ) + ) + .scalars() + .all() + ) + + return allocated_role_list + + @classmethod + async def get_user_role_allocated_list_by_role_id( + cls, + db: AsyncSession, + query_object: UserRolePageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel | list[dict[str, Any]]: + """ + 根据角色id获取已分配的用户列表信息 + + :param db: orm对象 + :param query_object: 用户角色查询对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 角色已分配的用户列表信息 + """ + query = ( + select(SysUser) + .join(SysDept, SysDept.dept_id == SysUser.dept_id, isouter=True) + .join(SysUserRole, SysUserRole.user_id == SysUser.user_id, isouter=True) + .join(SysRole, SysRole.role_id == SysUserRole.role_id, isouter=True) + .where( + SysUser.del_flag == '0', + SysUser.user_name == query_object.user_name if query_object.user_name else True, + SysUser.phonenumber == query_object.phonenumber if query_object.phonenumber else True, + SysRole.role_id == query_object.role_id, + data_scope_sql, + ) + .distinct() + ) + allocated_user_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return allocated_user_list + + @classmethod + async def get_user_role_unallocated_list_by_role_id( + cls, + db: AsyncSession, + query_object: UserRolePageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel | list[dict[str, Any]]: + """ + 根据角色id获取未分配的用户列表信息 + + :param db: orm对象 + :param query_object: 用户角色查询对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 角色未分配的用户列表信息 + """ + query = ( + select(SysUser) + .join(SysDept, SysDept.dept_id == SysUser.dept_id, isouter=True) + .join(SysUserRole, SysUserRole.user_id == SysUser.user_id, isouter=True) + .join(SysRole, SysRole.role_id == SysUserRole.role_id, isouter=True) + .where( + SysUser.del_flag == '0', + SysUser.user_name == query_object.user_name if query_object.user_name else True, + SysUser.phonenumber == query_object.phonenumber if query_object.phonenumber else True, + or_(SysRole.role_id != query_object.role_id, SysRole.role_id.is_(None)), + ~SysUser.user_id.in_( + select(SysUser.user_id) + .select_from(SysUser) + .join( + SysUserRole, + and_(SysUserRole.user_id == SysUser.user_id, SysUserRole.role_id == query_object.role_id), + ) + ), + data_scope_sql, + ) + .distinct() + ) + unallocated_user_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return unallocated_user_list + + @classmethod + async def add_user_role_dao(cls, db: AsyncSession, user_role: UserRoleModel) -> None: + """ + 新增用户角色关联信息数据库操作 + + :param db: orm对象 + :param user_role: 用户角色关联对象 + :return: + """ + db_user_role = SysUserRole(**user_role.model_dump()) + db.add(db_user_role) + + @classmethod + async def delete_user_role_dao(cls, db: AsyncSession, user_role: UserRoleModel) -> None: + """ + 删除用户角色关联信息数据库操作 + + :param db: orm对象 + :param user_role: 用户角色关联对象 + :return: + """ + await db.execute(delete(SysUserRole).where(SysUserRole.user_id.in_([user_role.user_id]))) + + @classmethod + async def delete_user_role_by_user_and_role_dao(cls, db: AsyncSession, user_role: UserRoleModel) -> None: + """ + 根据用户id及角色id删除用户角色关联信息数据库操作 + + :param db: orm对象 + :param user_role: 用户角色关联对象 + :return: + """ + await db.execute( + delete(SysUserRole).where( + SysUserRole.user_id == user_role.user_id if user_role.user_id else True, + SysUserRole.role_id == user_role.role_id if user_role.role_id else True, + ) + ) + + @classmethod + async def get_user_role_detail(cls, db: AsyncSession, user_role: UserRoleModel) -> SysUserRole | None: + """ + 根据用户角色关联获取用户角色关联详细信息 + + :param db: orm对象 + :param user_role: 用户角色关联对象 + :return: 用户角色关联信息 + """ + user_role_info = ( + ( + await db.execute( + select(SysUserRole) + .where(SysUserRole.user_id == user_role.user_id, SysUserRole.role_id == user_role.role_id) + .distinct() + ) + ) + .scalars() + .first() + ) + + return user_role_info + + @classmethod + async def add_user_post_dao(cls, db: AsyncSession, user_post: UserPostModel) -> None: + """ + 新增用户岗位关联信息数据库操作 + + :param db: orm对象 + :param user_post: 用户岗位关联对象 + :return: + """ + db_user_post = SysUserPost(**user_post.model_dump()) + db.add(db_user_post) + + @classmethod + async def delete_user_post_dao(cls, db: AsyncSession, user_post: UserPostModel) -> None: + """ + 删除用户岗位关联信息数据库操作 + + :param db: orm对象 + :param user_post: 用户岗位关联对象 + :return: + """ + await db.execute(delete(SysUserPost).where(SysUserPost.user_id.in_([user_post.user_id]))) + + @classmethod + async def get_user_dept_info(cls, db: AsyncSession, dept_id: int) -> SysDept | None: + dept_basic_info = ( + ( + await db.execute( + select(SysDept).where(SysDept.dept_id == dept_id, SysDept.status == '0', SysDept.del_flag == '0') + ) + ) + .scalars() + .first() + ) + return dept_basic_info diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/config_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/config_do.py new file mode 100644 index 0000000..0c40b8d --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/config_do.py @@ -0,0 +1,32 @@ +from datetime import datetime + +from sqlalchemy import CHAR, Column, DateTime, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysConfig(Base): + """ + 参数配置表 + """ + + __tablename__ = 'sys_config' + __table_args__ = {'comment': '参数配置表'} + + config_id = Column(Integer, primary_key=True, nullable=False, autoincrement=True, comment='参数主键') + config_name = Column(String(100), nullable=True, server_default="''", comment='参数名称') + config_key = Column(String(100), nullable=True, server_default="''", comment='参数键名') + config_value = Column(String(500), nullable=True, server_default="''", comment='参数键值') + config_type = Column(CHAR(1), nullable=True, server_default='N', comment='系统内置(Y是 N否)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/dept_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/dept_do.py new file mode 100644 index 0000000..c745b56 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/dept_do.py @@ -0,0 +1,46 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysDept(Base): + """ + 部门表 + """ + + __tablename__ = 'sys_dept' + __table_args__ = {'comment': '部门表'} + + dept_id = Column(BigInteger, primary_key=True, autoincrement=True, comment='部门id') + parent_id = Column(BigInteger, server_default='0', comment='父部门id') + ancestors = Column(String(50), nullable=True, server_default="''", comment='祖级列表') + dept_name = Column(String(30), nullable=True, server_default="''", comment='部门名称') + order_num = Column(Integer, server_default='0', comment='显示顺序') + leader = Column( + String(20), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='负责人', + ) + phone = Column( + String(11), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='联系电话', + ) + email = Column( + String(50), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='邮箱', + ) + status = Column(CHAR(1), nullable=True, server_default='0', comment='部门状态(0正常 1停用)') + del_flag = Column(CHAR(1), nullable=True, server_default='0', comment='删除标志(0代表存在 2代表删除)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/dict_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/dict_do.py new file mode 100644 index 0000000..37b2b7b --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/dict_do.py @@ -0,0 +1,70 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysDictType(Base): + """ + 字典类型表 + """ + + __tablename__ = 'sys_dict_type' + __table_args__ = {'comment': '字典类型表'} + + dict_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='字典主键') + dict_name = Column(String(100), nullable=True, server_default="''", comment='字典名称') + dict_type = Column(String(100), unique=True, nullable=True, server_default="''", comment='字典类型') + status = Column(CHAR(1), nullable=True, server_default='0', comment='状态(0正常 1停用)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) + + +class SysDictData(Base): + """ + 字典数据表 + """ + + __tablename__ = 'sys_dict_data' + __table_args__ = {'comment': '字典数据表'} + + dict_code = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='字典编码') + dict_sort = Column(Integer, nullable=True, server_default='0', comment='字典排序') + dict_label = Column(String(100), nullable=True, server_default="''", comment='字典标签') + dict_value = Column(String(100), nullable=True, server_default="''", comment='字典键值') + dict_type = Column(String(100), nullable=True, server_default="''", comment='字典类型') + css_class = Column( + String(100), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='样式属性(其他样式扩展)', + ) + list_class = Column( + String(100), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='表格回显样式', + ) + is_default = Column(CHAR(1), nullable=True, server_default='N', comment='是否默认(Y是 N否)') + status = Column(CHAR(1), nullable=True, server_default='0', comment='状态(0正常 1停用)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/job_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/job_do.py new file mode 100644 index 0000000..d6850f9 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/job_do.py @@ -0,0 +1,58 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, String + +from config.database import Base + + +class SysJob(Base): + """ + 定时任务调度表 + """ + + __tablename__ = 'sys_job' + __table_args__ = {'comment': '定时任务调度表'} + + job_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='任务ID') + job_name = Column(String(64), primary_key=True, nullable=False, server_default="''", comment='任务名称') + job_group = Column(String(64), primary_key=True, nullable=False, server_default='default', comment='任务组名') + job_executor = Column(String(64), nullable=True, server_default='default', comment='任务执行器') + invoke_target = Column(String(500), nullable=False, comment='调用目标字符串') + job_args = Column(String(255), nullable=True, server_default="''", comment='位置参数') + job_kwargs = Column(String(255), nullable=True, server_default="''", comment='关键字参数') + cron_expression = Column(String(255), nullable=True, server_default="''", comment='cron执行表达式') + misfire_policy = Column( + String(20), + nullable=True, + server_default='3', + comment='计划执行错误策略(1立即执行 2执行一次 3放弃执行)', + ) + concurrent = Column(CHAR(1), nullable=True, server_default='1', comment='是否并发执行(0允许 1禁止)') + status = Column(CHAR(1), nullable=True, server_default='0', comment='状态(0正常 1暂停)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column(String(500), nullable=True, server_default="''", comment='备注信息') + + +class SysJobLog(Base): + """ + 定时任务调度日志表 + """ + + __tablename__ = 'sys_job_log' + __table_args__ = {'comment': '定时任务调度日志表'} + + job_log_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='任务日志ID') + job_name = Column(String(64), nullable=False, comment='任务名称') + job_group = Column(String(64), nullable=False, comment='任务组名') + job_executor = Column(String(64), nullable=False, comment='任务执行器') + invoke_target = Column(String(500), nullable=False, comment='调用目标字符串') + job_args = Column(String(255), nullable=True, server_default="''", comment='位置参数') + job_kwargs = Column(String(255), nullable=True, server_default="''", comment='关键字参数') + job_trigger = Column(String(255), nullable=True, server_default="''", comment='任务触发器') + job_message = Column(String(500), nullable=True, comment='日志信息') + status = Column(CHAR(1), nullable=True, server_default='0', comment='执行状态(0正常 1失败)') + exception_info = Column(String(2000), nullable=True, server_default="''", comment='异常信息') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/log_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/log_do.py new file mode 100644 index 0000000..298921c --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/log_do.py @@ -0,0 +1,60 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Index, Integer, String + +from config.database import Base + + +class SysLogininfor(Base): + """ + 系统访问记录 + """ + + __tablename__ = 'sys_logininfor' + __table_args__ = {'comment': '系统访问记录'} + + info_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='访问ID') + user_name = Column(String(50), nullable=True, server_default="''", comment='用户账号') + ipaddr = Column(String(128), nullable=True, server_default="''", comment='登录IP地址') + login_location = Column(String(255), nullable=True, server_default="''", comment='登录地点') + browser = Column(String(50), nullable=True, server_default="''", comment='浏览器类型') + os = Column(String(50), nullable=True, server_default="''", comment='操作系统') + status = Column(CHAR(1), nullable=True, server_default='0', comment='登录状态(0成功 1失败)') + msg = Column(String(255), nullable=True, server_default="''", comment='提示消息') + login_time = Column(DateTime, nullable=True, default=datetime.now(), comment='访问时间') + + idx_sys_logininfor_s = Index('idx_sys_logininfor_s', status) + idx_sys_logininfor_lt = Index('idx_sys_logininfor_lt', login_time) + + +class SysOperLog(Base): + """ + 操作日志记录 + """ + + __tablename__ = 'sys_oper_log' + __table_args__ = {'comment': '操作日志记录'} + + oper_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='日志主键') + title = Column(String(50), nullable=True, server_default="''", comment='模块标题') + business_type = Column(Integer, nullable=True, server_default='0', comment='业务类型(0其它 1新增 2修改 3删除)') + method = Column(String(100), nullable=True, server_default="''", comment='方法名称') + request_method = Column(String(10), nullable=True, server_default="''", comment='请求方式') + operator_type = Column( + Integer, nullable=True, server_default='0', comment='操作类别(0其它 1后台用户 2手机端用户)' + ) + oper_name = Column(String(50), nullable=True, server_default="''", comment='操作人员') + dept_name = Column(String(50), nullable=True, server_default="''", comment='部门名称') + oper_url = Column(String(255), nullable=True, server_default="''", comment='请求URL') + oper_ip = Column(String(128), nullable=True, server_default="''", comment='主机地址') + oper_location = Column(String(255), nullable=True, server_default="''", comment='操作地点') + oper_param = Column(String(2000), nullable=True, server_default="''", comment='请求参数') + json_result = Column(String(2000), nullable=True, server_default="''", comment='返回参数') + status = Column(Integer, nullable=True, server_default='0', comment='操作状态(0正常 1异常)') + error_msg = Column(String(2000), nullable=True, server_default="''", comment='错误消息') + oper_time = Column(DateTime, nullable=True, default=datetime.now(), comment='操作时间') + cost_time = Column(BigInteger, nullable=True, server_default='0', comment='消耗时间') + + idx_sys_oper_log_bt = Index('idx_sys_oper_log_bt', business_type) + idx_sys_oper_log_s = Index('idx_sys_oper_log_s', status) + idx_sys_oper_log_ot = Index('idx_sys_oper_log_ot', oper_time) diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/menu_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/menu_do.py new file mode 100644 index 0000000..b7aa4c7 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/menu_do.py @@ -0,0 +1,52 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysMenu(Base): + """ + 菜单权限表 + """ + + __tablename__ = 'sys_menu' + __table_args__ = {'comment': '菜单权限表'} + + menu_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='菜单ID') + menu_name = Column(String(50), nullable=False, comment='菜单名称') + parent_id = Column(BigInteger, nullable=True, server_default='0', comment='父菜单ID') + order_num = Column(Integer, server_default='0', comment='显示顺序') + path = Column(String(200), nullable=True, server_default="''", comment='路由地址') + component = Column( + String(255), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='组件路径', + ) + query = Column( + String(255), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='路由参数', + ) + route_name = Column(String(50), nullable=True, server_default="''", comment='路由名称') + is_frame = Column(Integer, nullable=True, server_default='1', comment='是否为外链(0是 1否)') + is_cache = Column(Integer, nullable=True, server_default='0', comment='是否缓存(0缓存 1不缓存)') + menu_type = Column(CHAR(1), nullable=True, server_default="''", comment='菜单类型(M目录 C菜单 F按钮)') + visible = Column(CHAR(1), nullable=True, server_default='0', comment='菜单状态(0显示 1隐藏)') + status = Column(CHAR(1), nullable=True, server_default='0', comment='菜单状态(0正常 1停用)') + perms = Column( + String(100), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='权限标识', + ) + icon = Column(String(100), nullable=True, server_default='#', comment='菜单图标') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column(String(500), nullable=True, server_default="''", comment='备注') diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/notice_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/notice_do.py new file mode 100644 index 0000000..468f599 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/notice_do.py @@ -0,0 +1,38 @@ +from datetime import datetime + +from sqlalchemy import CHAR, Column, DateTime, Integer, LargeBinary, String +from sqlalchemy.dialects import mysql + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysNotice(Base): + """ + 通知公告表 + """ + + __tablename__ = 'sys_notice' + __table_args__ = {'comment': '通知公告表'} + + notice_id = Column(Integer, primary_key=True, nullable=False, autoincrement=True, comment='公告ID') + notice_title = Column(String(50), nullable=False, comment='公告标题') + notice_type = Column(CHAR(1), nullable=False, comment='公告类型(1通知 2公告)') + notice_content = Column( + mysql.LONGBLOB if DataBaseConfig.db_type == 'mysql' else LargeBinary, + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type, False), + comment='公告内容', + ) + status = Column(CHAR(1), nullable=True, server_default='0', comment='公告状态(0正常 1关闭)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, comment='创建时间', default=datetime.now()) + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, comment='更新时间', default=datetime.now()) + remark = Column( + String(255), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/post_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/post_do.py new file mode 100644 index 0000000..5b18596 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/post_do.py @@ -0,0 +1,32 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysPost(Base): + """ + 岗位信息表 + """ + + __tablename__ = 'sys_post' + __table_args__ = {'comment': '岗位信息表'} + + post_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='岗位ID') + post_code = Column(String(64), nullable=False, comment='岗位编码') + post_name = Column(String(50), nullable=False, comment='岗位名称') + post_sort = Column(Integer, nullable=False, comment='显示顺序') + status = Column(CHAR(1), nullable=False, comment='状态(0正常 1停用)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/role_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/role_do.py new file mode 100644 index 0000000..39b0866 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/role_do.py @@ -0,0 +1,76 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, SmallInteger, String +from sqlalchemy.dialects import mysql + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysRole(Base): + """ + 角色信息表 + """ + + __tablename__ = 'sys_role' + __table_args__ = {'comment': '角色信息表'} + + role_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='角色ID') + role_name = Column(String(30), nullable=False, comment='角色名称') + role_key = Column(String(100), nullable=False, comment='角色权限字符串') + role_sort = Column(Integer, nullable=False, comment='显示顺序') + data_scope = Column( + CHAR(1), + nullable=True, + server_default='1', + comment='数据范围(1:全部数据权限 2:自定数据权限 3:本部门数据权限 4:本部门及以下数据权限)', + ) + menu_check_strictly = Column( + mysql.TINYINT(display_width=1) if DataBaseConfig.db_type == 'mysql' else SmallInteger, + nullable=True, + server_default='1', + comment='菜单树选择项是否关联显示', + ) + dept_check_strictly = Column( + mysql.TINYINT(display_width=1) if DataBaseConfig.db_type == 'mysql' else SmallInteger, + nullable=True, + server_default='1', + comment='部门树选择项是否关联显示', + ) + status = Column(CHAR(1), nullable=False, comment='角色状态(0正常 1停用)') + del_flag = Column(CHAR(1), nullable=True, server_default='0', comment='删除标志(0代表存在 2代表删除)') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) + + +class SysRoleDept(Base): + """ + 角色和部门关联表 + """ + + __tablename__ = 'sys_role_dept' + __table_args__ = {'comment': '角色和部门关联表'} + + role_id = Column(BigInteger, primary_key=True, nullable=False, comment='角色ID') + dept_id = Column(BigInteger, primary_key=True, nullable=False, comment='部门ID') + + +class SysRoleMenu(Base): + """ + 角色和菜单关联表 + """ + + __tablename__ = 'sys_role_menu' + __table_args__ = {'comment': '角色和菜单关联表'} + + role_id = Column(BigInteger, primary_key=True, nullable=False, comment='角色ID') + menu_id = Column(BigInteger, primary_key=True, nullable=False, comment='菜单ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/do/user_do.py b/shierfeng-fastapi-backend/module_admin/entity/do/user_do.py new file mode 100644 index 0000000..4d1cfe1 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/do/user_do.py @@ -0,0 +1,71 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class SysUser(Base): + """ + 用户信息表 + """ + + __tablename__ = 'sys_user' + __table_args__ = {'comment': '用户信息表'} + + user_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='用户ID') + dept_id = Column( + BigInteger, + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type, False), + comment='部门ID', + ) + user_name = Column(String(30), nullable=False, comment='用户账号') + nick_name = Column(String(30), nullable=False, comment='用户昵称') + user_type = Column(String(2), nullable=True, server_default='00', comment='用户类型(00系统用户)') + email = Column(String(50), nullable=True, server_default="''", comment='用户邮箱') + phonenumber = Column(String(11), nullable=True, server_default="''", comment='手机号码') + sex = Column(CHAR(1), nullable=True, server_default='0', comment='用户性别(0男 1女 2未知)') + avatar = Column(String(100), nullable=True, server_default="''", comment='头像地址') + password = Column(String(100), nullable=True, server_default="''", comment='密码') + status = Column(CHAR(1), nullable=True, server_default='0', comment='帐号状态(0正常 1停用)') + del_flag = Column(CHAR(1), nullable=True, server_default='0', comment='删除标志(0代表存在 2代表删除)') + login_ip = Column(String(128), nullable=True, server_default="''", comment='最后登录IP') + login_date = Column(DateTime, nullable=True, comment='最后登录时间') + pwd_update_date = Column(DateTime, nullable=True, comment='密码最后更新时间') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, comment='创建时间', default=datetime.now()) + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, comment='更新时间', default=datetime.now()) + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) + + +class SysUserRole(Base): + """ + 用户和角色关联表 + """ + + __tablename__ = 'sys_user_role' + __table_args__ = {'comment': '用户和角色关联表'} + + user_id = Column(BigInteger, primary_key=True, nullable=False, comment='用户ID') + role_id = Column(BigInteger, primary_key=True, nullable=False, comment='角色ID') + + +class SysUserPost(Base): + """ + 用户与岗位关联表 + """ + + __tablename__ = 'sys_user_post' + __table_args__ = {'comment': '用户与岗位关联表'} + + user_id = Column(BigInteger, primary_key=True, nullable=False, comment='用户ID') + post_id = Column(BigInteger, primary_key=True, nullable=False, comment='岗位ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/cache_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/cache_vo.py new file mode 100644 index 0000000..079f93c --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/cache_vo.py @@ -0,0 +1,29 @@ +from typing import Any + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class CacheMonitorModel(BaseModel): + """ + 缓存监控信息对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + command_stats: list | None = Field(default=[], description='命令统计') + db_size: int | None = Field(default=None, description='Key数量') + info: dict | None = Field(default={}, description='Redis信息') + + +class CacheInfoModel(BaseModel): + """ + 缓存监控对象对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + cache_key: str | None = Field(default=None, description='缓存键名') + cache_name: str | None = Field(default=None, description='缓存名称') + cache_value: Any | None = Field(default=None, description='缓存内容') + remark: str | None = Field(default=None, description='备注') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/common_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/common_vo.py new file mode 100644 index 0000000..8538055 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/common_vo.py @@ -0,0 +1,15 @@ +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class UploadResponseModel(BaseModel): + """ + 上传响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + file_name: str | None = Field(default=None, description='新文件映射路径') + new_file_name: str | None = Field(default=None, description='新文件名称') + original_filename: str | None = Field(default=None, description='原文件名称') + url: str | None = Field(default=None, description='新文件url') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/config_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/config_vo.py new file mode 100644 index 0000000..e6a62ae --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/config_vo.py @@ -0,0 +1,73 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class ConfigModel(BaseModel): + """ + 参数配置表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + config_id: int | None = Field(default=None, description='参数主键') + config_name: str | None = Field(default=None, description='参数名称') + config_key: str | None = Field(default=None, description='参数键名') + config_value: str | None = Field(default=None, description='参数键值') + config_type: Literal['Y', 'N'] | None = Field(default=None, description='系统内置(Y是 N否)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='config_key', message='参数名称不能为空') + @Size(field_name='config_key', min_length=0, max_length=100, message='参数名称长度不能超过100个字符') + def get_config_key(self) -> str | None: + return self.config_key + + @NotBlank(field_name='config_name', message='参数键名不能为空') + @Size(field_name='config_name', min_length=0, max_length=100, message='参数键名长度不能超过100个字符') + def get_config_name(self) -> str | None: + return self.config_name + + @NotBlank(field_name='config_value', message='参数键值不能为空') + @Size(field_name='config_value', min_length=0, max_length=500, message='参数键值长度不能超过500个字符') + def get_config_value(self) -> str | None: + return self.config_value + + def validate_fields(self) -> None: + self.get_config_key() + self.get_config_name() + self.get_config_value() + + +class ConfigQueryModel(ConfigModel): + """ + 参数配置管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class ConfigPageQueryModel(ConfigQueryModel): + """ + 参数配置管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteConfigModel(BaseModel): + """ + 删除参数配置模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + config_ids: str = Field(description='需要删除的参数主键') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/dept_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/dept_vo.py new file mode 100644 index 0000000..3222270 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/dept_vo.py @@ -0,0 +1,87 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import Network, NotBlank, Size + + +class DeptModel(BaseModel): + """ + 部门表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + dept_id: int | None = Field(default=None, description='部门id') + parent_id: int | None = Field(default=None, description='父部门id') + ancestors: str | None = Field(default=None, description='祖级列表') + dept_name: str | None = Field(default=None, description='部门名称') + order_num: int | None = Field(default=None, description='显示顺序') + leader: str | None = Field(default=None, description='负责人') + phone: str | None = Field(default=None, description='联系电话') + email: str | None = Field(default=None, description='邮箱') + status: Literal['0', '1'] | None = Field(default=None, description='部门状态(0正常 1停用)') + del_flag: Literal['0', '2'] | None = Field(default=None, description='删除标志(0代表存在 2代表删除)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + + @NotBlank(field_name='dept_name', message='部门名称不能为空') + @Size(field_name='dept_name', min_length=0, max_length=30, message='部门名称长度不能超过30个字符') + def get_dept_name(self) -> str | None: + return self.dept_name + + @NotBlank(field_name='order_num', message='显示顺序不能为空') + def get_order_num(self) -> int | None: + return self.order_num + + @Size(field_name='phone', min_length=0, max_length=11, message='联系电话长度不能超过11个字符') + def get_phone(self) -> str | None: + return self.phone + + @Network(field_name='email', field_type='EmailStr', message='邮箱格式不正确') + @Size(field_name='email', min_length=0, max_length=50, message='邮箱长度不能超过50个字符') + def get_email(self) -> str | None: + return self.email + + def validate_fields(self) -> None: + self.get_dept_name() + self.get_order_num() + self.get_phone() + self.get_email() + + +class DeptQueryModel(DeptModel): + """ + 部门管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class DeptTreeModel(BaseModel): + """ + 部门树模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + id: int = Field(description='部门id') + label: str = Field(description='部门名称') + parent_id: int = Field(description='父部门id') + children: list['DeptTreeModel'] | None = Field(default=None, description='子部门树') + + +class DeleteDeptModel(BaseModel): + """ + 删除部门模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + dept_ids: str = Field(default=None, description='需要删除的部门id') + update_by: str | None = Field(default=None, description='更新者') + update_time: str | None = Field(default=None, description='更新时间') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/dict_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/dict_vo.py new file mode 100644 index 0000000..787e00f --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/dict_vo.py @@ -0,0 +1,147 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Pattern, Size + + +class DictTypeModel(BaseModel): + """ + 字典类型表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + dict_id: int | None = Field(default=None, description='字典主键') + dict_name: str | None = Field(default=None, description='字典名称') + dict_type: str | None = Field(default=None, description='字典类型') + status: Literal['0', '1'] | None = Field(default=None, description='状态(0正常 1停用)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='dict_name', message='字典名称不能为空') + @Size(field_name='dict_name', min_length=0, max_length=100, message='字典类型名称长度不能超过100个字符') + def get_dict_name(self) -> str | None: + return self.dict_name + + @NotBlank(field_name='dict_type', message='字典类型不能为空') + @Size(field_name='dict_type', min_length=0, max_length=100, message='字典类型类型长度不能超过100个字符') + @Pattern( + field_name='dict_type', + regexp='^[a-z][a-z0-9_]*$', + message='字典类型必须以字母开头,且只能为(小写字母,数字,下滑线)', + ) + def get_dict_type(self) -> str | None: + return self.dict_type + + def validate_fields(self) -> None: + self.get_dict_name() + self.get_dict_type() + + +class DictDataModel(BaseModel): + """ + 字典数据表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + dict_code: int | None = Field(default=None, description='字典编码') + dict_sort: int | None = Field(default=None, description='字典排序') + dict_label: str | None = Field(default=None, description='字典标签') + dict_value: str | None = Field(default=None, description='字典键值') + dict_type: str | None = Field(default=None, description='字典类型') + css_class: str | None = Field(default=None, description='样式属性(其他样式扩展)') + list_class: str | None = Field(default=None, description='表格回显样式') + is_default: Literal['Y', 'N'] | None = Field(default=None, description='是否默认(Y是 N否)') + status: Literal['0', '1'] | None = Field(default=None, description='状态(0正常 1停用)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='dict_label', message='字典标签不能为空') + @Size(field_name='dict_label', min_length=0, max_length=100, message='字典标签长度不能超过100个字符') + def get_dict_label(self) -> str | None: + return self.dict_label + + @NotBlank(field_name='dict_value', message='字典键值不能为空') + @Size(field_name='dict_value', min_length=0, max_length=100, message='字典键值长度不能超过100个字符') + def get_dict_value(self) -> str | None: + return self.dict_value + + @NotBlank(field_name='dict_type', message='字典类型不能为空') + @Size(field_name='dict_type', min_length=0, max_length=100, message='字典类型长度不能超过100个字符') + def get_dict_type(self) -> str | None: + return self.dict_type + + @Size(field_name='css_class', min_length=0, max_length=100, message='样式属性长度不能超过100个字符') + def get_css_class(self) -> str | None: + return self.css_class + + def validate_fields(self) -> None: + self.get_dict_label() + self.get_dict_value() + self.get_dict_type() + self.get_css_class() + + +class DictTypeQueryModel(DictTypeModel): + """ + 字典类型管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class DictTypePageQueryModel(DictTypeQueryModel): + """ + 字典类型管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteDictTypeModel(BaseModel): + """ + 删除字典类型模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + dict_ids: str = Field(description='需要删除的字典主键') + + +class DictDataQueryModel(DictDataModel): + """ + 字典数据管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class DictDataPageQueryModel(DictDataQueryModel): + """ + 字典数据管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteDictDataModel(BaseModel): + """ + 删除字典数据模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + dict_codes: str = Field(description='需要删除的字典编码') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/job_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/job_vo.py new file mode 100644 index 0000000..84a541b --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/job_vo.py @@ -0,0 +1,132 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class JobModel(BaseModel): + """ + 定时任务调度表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + job_id: int | None = Field(default=None, description='任务ID') + job_name: str | None = Field(default=None, description='任务名称') + job_group: str | None = Field(default=None, description='任务组名') + job_executor: str | None = Field(default=None, description='任务执行器') + invoke_target: str | None = Field(default=None, description='调用目标字符串') + job_args: str | None = Field(default=None, description='位置参数') + job_kwargs: str | None = Field(default=None, description='关键字参数') + cron_expression: str | None = Field(default=None, description='cron执行表达式') + misfire_policy: Literal['1', '2', '3'] | None = Field( + default=None, description='计划执行错误策略(1立即执行 2执行一次 3放弃执行)' + ) + concurrent: Literal['0', '1'] | None = Field(default=None, description='是否并发执行(0允许 1禁止)') + status: Literal['0', '1'] | None = Field(default=None, description='状态(0正常 1暂停)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注信息') + + @NotBlank(field_name='invoke_target', message='调用目标字符串不能为空') + @Size(field_name='invoke_target', min_length=0, max_length=500, message='调用目标字符串长度不能超过500个字符') + def get_invoke_target(self) -> str | None: + return self.invoke_target + + @NotBlank(field_name='cron_expression', message='Cron执行表达式不能为空') + @Size(field_name='cron_expression', min_length=0, max_length=255, message='Cron执行表达式不能超过255个字符') + def get_cron_expression(self) -> str | None: + return self.cron_expression + + def validate_fields(self) -> None: + self.get_invoke_target() + self.get_cron_expression() + + +class JobLogModel(BaseModel): + """ + 定时任务调度日志表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + job_log_id: int | None = Field(default=None, description='任务日志ID') + job_name: str | None = Field(default=None, description='任务名称') + job_group: str | None = Field(default=None, description='任务组名') + job_executor: str | None = Field(default=None, description='任务执行器') + invoke_target: str | None = Field(default=None, description='调用目标字符串') + job_args: str | None = Field(default=None, description='位置参数') + job_kwargs: str | None = Field(default=None, description='关键字参数') + job_trigger: str | None = Field(default=None, description='任务触发器') + job_message: str | None = Field(default=None, description='日志信息') + status: Literal['0', '1'] | None = Field(default=None, description='执行状态(0正常 1失败)') + exception_info: str | None = Field(default=None, description='异常信息') + create_time: datetime | None = Field(default=None, description='创建时间') + + +class JobQueryModel(JobModel): + """ + 定时任务管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class JobPageQueryModel(JobQueryModel): + """ + 定时任务管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class EditJobModel(JobModel): + """ + 编辑定时任务模型 + """ + + type: str | None = Field(default=None, description='操作类型') + + +class DeleteJobModel(BaseModel): + """ + 删除定时任务模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + job_ids: str = Field(description='需要删除的定时任务ID') + + +class JobLogQueryModel(JobLogModel): + """ + 定时任务日志不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class JobLogPageQueryModel(JobLogQueryModel): + """ + 定时任务日志管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteJobLogModel(BaseModel): + """ + 删除定时任务日志模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + job_log_ids: str = Field(description='需要删除的定时任务日志ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/log_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/log_vo.py new file mode 100644 index 0000000..b09b4de --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/log_vo.py @@ -0,0 +1,127 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class OperLogModel(BaseModel): + """ + 操作日志表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + oper_id: int | None = Field(default=None, description='日志主键') + title: str | None = Field(default=None, description='模块标题') + business_type: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'] | None = ( + Field( + default=None, description='业务类型(0其它 1新增 2修改 3删除 4授权 5导出 6导入 7强退 8生成代码 9清空数据)' + ) + ) + method: str | None = Field(default=None, description='方法名称') + request_method: str | None = Field(default=None, description='请求方式') + operator_type: Literal[0, 1, 2] | None = Field(default=None, description='操作类别(0其它 1后台用户 2手机端用户)') + oper_name: str | None = Field(default=None, description='操作人员') + dept_name: str | None = Field(default=None, description='部门名称') + oper_url: str | None = Field(default=None, description='请求URL') + oper_ip: str | None = Field(default=None, description='主机地址') + oper_location: str | None = Field(default=None, description='操作地点') + oper_param: str | None = Field(default=None, description='请求参数') + json_result: str | None = Field(default=None, description='返回参数') + status: Literal[0, 1, '0', '1'] | None = Field(default=None, description='操作状态(0正常 1异常)') + error_msg: str | None = Field(default=None, description='错误消息') + oper_time: datetime | None = Field(default=None, description='操作时间') + cost_time: int | None = Field(default=None, description='消耗时间') + + +class LogininforModel(BaseModel): + """ + 登录日志表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + info_id: int | None = Field(default=None, description='访问ID') + user_name: str | None = Field(default=None, description='用户账号') + ipaddr: str | None = Field(default=None, description='登录IP地址') + login_location: str | None = Field(default=None, description='登录地点') + browser: str | None = Field(default=None, description='浏览器类型') + os: str | None = Field(default=None, description='操作系统') + status: Literal['0', '1'] | None = Field(default=None, description='登录状态(0成功 1失败)') + msg: str | None = Field(default=None, description='提示消息') + login_time: datetime | None = Field(default=None, description='访问时间') + + +class OperLogQueryModel(OperLogModel): + """ + 操作日志管理不分页查询模型 + """ + + order_by_column: str | None = Field(default=None, description='排序的字段名称') + is_asc: Literal['ascending', 'descending'] | None = Field( + default=None, description='排序方式(ascending升序 descending降序)' + ) + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class OperLogPageQueryModel(OperLogQueryModel): + """ + 操作日志管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteOperLogModel(BaseModel): + """ + 删除操作日志模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + oper_ids: str = Field(description='需要删除的日志主键') + + +class LoginLogQueryModel(LogininforModel): + """ + 登录日志管理不分页查询模型 + """ + + order_by_column: str | None = Field(default=None, description='排序的字段名称') + is_asc: Literal['ascending', 'descending'] | None = Field( + default=None, description='排序方式(ascending升序 descending降序)' + ) + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class LoginLogPageQueryModel(LoginLogQueryModel): + """ + 登录日志管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteLoginLogModel(BaseModel): + """ + 删除登录日志模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + info_ids: str = Field(description='需要删除的访问ID') + + +class UnlockUser(BaseModel): + """ + 解锁用户模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + user_name: str = Field(description='用户名称') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/login_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/login_vo.py new file mode 100644 index 0000000..50bbc77 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/login_vo.py @@ -0,0 +1,93 @@ +import re + +from pydantic import BaseModel, ConfigDict, Field, model_validator +from pydantic.alias_generators import to_camel + +from exceptions.exception import ModelValidatorException +from module_admin.entity.vo.menu_vo import MenuModel + + +class UserLogin(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + user_name: str = Field(description='用户名称') + password: str = Field(description='用户密码') + code: str | None = Field(default=None, description='验证码') + uuid: str | None = Field(default=None, description='会话编号') + login_info: dict | None = Field(default=None, description='登录信息,前端无需传递') + captcha_enabled: bool | None = Field(default=None, description='是否启用验证码,前端无需传递') + + +class UserRegister(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + username: str = Field(description='用户名称') + password: str = Field(description='用户密码') + confirm_password: str = Field(description='用户二次确认密码') + code: str | None = Field(default=None, description='验证码') + uuid: str | None = Field(default=None, description='会话编号') + + @model_validator(mode='after') + def check_password(self) -> 'UserRegister': + pattern = r"""^[^<>"'|\\]+$""" + if self.password is None or re.match(pattern, self.password): + return self + raise ModelValidatorException(message='密码不能包含非法字符:< > " \' \\ |') + + +class Token(BaseModel): + access_token: str = Field(description='token信息') + token_type: str = Field(description='token类型') + + +class LoginToken(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + token: str = Field(description='token信息') + + +class CaptchaCode(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + captcha_enabled: bool = Field(description='是否启用验证码') + register_enabled: bool = Field(description='是否启用注册') + img: str = Field(description='验证码图片') + uuid: str = Field(description='会话编号') + + +class SmsCode(BaseModel): + is_success: bool | None = Field(default=None, description='操作是否成功') + sms_code: str = Field(description='短信验证码') + session_id: str = Field(description='会话编号') + message: str | None = Field(default=None, description='响应信息') + + +class MenuTreeModel(MenuModel): + children: list['MenuTreeModel'] | None | None = Field(default=None, description='子菜单') + + +class MetaModel(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + title: str | None = Field(default=None, description='设置路由在侧边栏和面包屑中展示的名字') + icon: str | None = Field(default=None, description='设置路由的图标') + no_cache: bool | None = Field(default=None, description='设置为true,则不会被 缓存') + link: str | None = Field(default=None, description='内链地址(http(s)://开头)') + + +class RouterModel(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + name: str | None = Field(default=None, description='路由名称') + path: str | None = Field(default=None, description='路由地址') + hidden: bool | None = Field(default=None, description='是否隐藏路由,当设置 true 的时候该路由不会再侧边栏出现') + redirect: str | None = Field( + default=None, description='重定向地址,当设置 noRedirect 的时候该路由在面包屑导航中不可被点击' + ) + component: str | None = Field(default=None, description='组件地址') + query: str | None = Field(default=None, description='路由参数:如 {"id": 1, "name": "ry"}') + always_show: bool | None = Field( + default=None, description='当你一个路由下面的children声明的路由大于1个时,自动会变成嵌套的模式--如组件页面' + ) + meta: MetaModel | None = Field(default=None, description='其他元素') + children: list['RouterModel'] | None | None = Field(default=None, description='子路由') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/menu_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/menu_vo.py new file mode 100644 index 0000000..a35be7d --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/menu_vo.py @@ -0,0 +1,100 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class MenuModel(BaseModel): + """ + 菜单表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + menu_id: int | None = Field(default=None, description='菜单ID') + menu_name: str | None = Field(default=None, description='菜单名称') + parent_id: int | None = Field(default=None, description='父菜单ID') + order_num: int | None = Field(default=None, description='显示顺序') + path: str | None = Field(default=None, description='路由地址') + component: str | None = Field(default=None, description='组件路径') + query: str | None = Field(default=None, description='路由参数') + route_name: str | None = Field(default=None, description='路由名称') + is_frame: Literal[0, 1] | None = Field(default=None, description='是否为外链(0是 1否)') + is_cache: Literal[0, 1] | None = Field(default=None, description='是否缓存(0缓存 1不缓存)') + menu_type: Literal['M', 'C', 'F'] | None = Field(default=None, description='菜单类型(M目录 C菜单 F按钮)') + visible: Literal['0', '1'] | None = Field(default=None, description='菜单状态(0显示 1隐藏)') + status: Literal['0', '1'] | None = Field(default=None, description='菜单状态(0正常 1停用)') + perms: str | None = Field(default=None, description='权限标识') + icon: str | None = Field(default=None, description='菜单图标') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='menu_name', message='菜单名称不能为空') + @Size(field_name='menu_name', min_length=0, max_length=50, message='菜单名称长度不能超过50个字符') + def get_menu_name(self) -> str | None: + return self.menu_name + + @NotBlank(field_name='order_num', message='显示顺序不能为空') + def get_order_num(self) -> int | None: + return self.order_num + + @Size(field_name='path', min_length=0, max_length=200, message='路由地址长度不能超过200个字符') + def get_path(self) -> str | None: + return self.path + + @Size(field_name='component', min_length=0, max_length=255, message='组件路径长度不能超过255个字符') + def get_component(self) -> str | None: + return self.component + + @NotBlank(field_name='menu_type', message='菜单类型不能为空') + def get_menu_type(self) -> Literal['M', 'C', 'F'] | None: + return self.menu_type + + @Size(field_name='perms', min_length=0, max_length=100, message='权限标识长度不能超过100个字符') + def get_perms(self) -> str | None: + return self.perms + + def validate_fields(self) -> None: + self.get_menu_name() + self.get_order_num() + self.get_path() + self.get_component() + self.get_menu_type() + self.get_perms() + + +class MenuQueryModel(MenuModel): + """ + 菜单管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class MenuTreeModel(BaseModel): + """ + 菜单树模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + id: int = Field(description='菜单id') + label: str = Field(description='菜单名称') + parent_id: int = Field(description='父菜单id') + children: list['MenuTreeModel'] | None = Field(default=None, description='子菜单树') + + +class DeleteMenuModel(BaseModel): + """ + 删除菜单模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + menu_ids: str = Field(description='需要删除的菜单ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/notice_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/notice_vo.py new file mode 100644 index 0000000..40d8655 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/notice_vo.py @@ -0,0 +1,62 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size, Xss + + +class NoticeModel(BaseModel): + """ + 通知公告表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + notice_id: int | None = Field(default=None, description='公告ID') + notice_title: str | None = Field(default=None, description='公告标题') + notice_type: Literal['1', '2'] | None = Field(default=None, description='公告类型(1通知 2公告)') + notice_content: bytes | None = Field(default=None, description='公告内容') + status: Literal['0', '1'] | None = Field(default=None, description='公告状态(0正常 1关闭)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @Xss(field_name='notice_title', message='公告标题不能包含脚本字符') + @NotBlank(field_name='notice_title', message='公告标题不能为空') + @Size(field_name='notice_title', min_length=0, max_length=50, message='公告标题不能超过50个字符') + def get_notice_title(self) -> str | None: + return self.notice_title + + def validate_fields(self) -> None: + self.get_notice_title() + + +class NoticeQueryModel(NoticeModel): + """ + 通知公告管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class NoticePageQueryModel(NoticeQueryModel): + """ + 通知公告管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteNoticeModel(BaseModel): + """ + 删除通知公告模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + notice_ids: str = Field(description='需要删除的公告ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/online_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/online_vo.py new file mode 100644 index 0000000..88f5b95 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/online_vo.py @@ -0,0 +1,51 @@ +from datetime import datetime + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class OnlineModel(BaseModel): + """ + 在线用户对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + token_id: str | None = Field(default=None, description='会话编号') + user_name: str | None = Field(default=None, description='登录名称') + dept_name: str | None = Field(default=None, description='所属部门') + ipaddr: str | None = Field(default=None, description='主机') + login_location: str | None = Field(default=None, description='登录地点') + browser: str | None = Field(default=None, description='浏览器类型') + os: str | None = Field(default=None, description='操作系统') + login_time: datetime | None = Field(default=None, description='登录时间') + + +class OnlineQueryModel(OnlineModel): + """ + 岗位管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class OnlinePageResponseModel(BaseModel): + """ + 在线用户分页响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + rows: list[OnlineModel] = Field(description='在线用户记录列表') + total: int = Field(description='总记录数') + + +class DeleteOnlineModel(BaseModel): + """ + 强退在线用户模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + token_ids: str = Field(description='需要强退的会话编号') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/post_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/post_vo.py new file mode 100644 index 0000000..f3826d4 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/post_vo.py @@ -0,0 +1,72 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class PostModel(BaseModel): + """ + 岗位信息表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + post_id: int | None = Field(default=None, description='岗位ID') + post_code: str | None = Field(default=None, description='岗位编码') + post_name: str | None = Field(default=None, description='岗位名称') + post_sort: int | None = Field(default=None, description='显示顺序') + status: Literal['0', '1'] | None = Field(default=None, description='状态(0正常 1停用)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='post_code', message='岗位编码不能为空') + @Size(field_name='post_code', min_length=0, max_length=64, message='岗位编码长度不能超过64个字符') + def get_post_code(self) -> str | None: + return self.post_code + + @NotBlank(field_name='post_name', message='岗位名称不能为空') + @Size(field_name='post_name', min_length=0, max_length=50, message='岗位名称长度不能超过50个字符') + def get_post_name(self) -> str | None: + return self.post_name + + @NotBlank(field_name='post_sort', message='显示顺序不能为空') + def get_post_sort(self) -> int | None: + return self.post_sort + + def validate_fields(self) -> None: + self.get_post_code() + self.get_post_name() + self.get_post_sort() + + +class PostQueryModel(PostModel): + """ + 岗位管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class PostPageQueryModel(PostQueryModel): + """ + 岗位管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeletePostModel(BaseModel): + """ + 删除岗位模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + post_ids: str = Field(description='需要删除的岗位ID') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/role_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/role_vo.py new file mode 100644 index 0000000..aff9c38 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/role_vo.py @@ -0,0 +1,157 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class RoleModel(BaseModel): + """ + 角色表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + role_id: int | None = Field(default=None, description='角色ID') + role_name: str | None = Field(default=None, description='角色名称') + role_key: str | None = Field(default=None, description='角色权限字符串') + role_sort: int | None = Field(default=None, description='显示顺序') + data_scope: Literal['1', '2', '3', '4', '5'] | None = Field( + default=None, + description='数据范围(1:全部数据权限 2:自定数据权限 3:本部门数据权限 4:本部门及以下数据权限 5:仅本人数据权限)', + ) + menu_check_strictly: int | bool | None = Field(default=None, description='菜单树选择项是否关联显示') + dept_check_strictly: int | bool | None = Field(default=None, description='部门树选择项是否关联显示') + status: Literal['0', '1'] | None = Field(default=None, description='角色状态(0正常 1停用)') + del_flag: Literal['0', '2'] | None = Field(default=None, description='删除标志(0代表存在 2代表删除)') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + admin: bool | None = Field(default=False, description='是否为admin') + + @field_validator('menu_check_strictly', 'dept_check_strictly') + @classmethod + def check_filed_mapping(cls, v: int | bool) -> int | bool: + if v == 1: + v = True + elif v == 0: + v = False + elif v is True: + v = 1 + elif v is False: + v = 0 + return v + + @model_validator(mode='after') + def check_admin(self) -> 'RoleModel': + if self.role_id == 1: + self.admin = True + else: + self.admin = False + return self + + @NotBlank(field_name='role_name', message='角色名称不能为空') + @Size(field_name='role_name', min_length=0, max_length=30, message='角色名称长度不能超过30个字符') + def get_role_name(self) -> str | None: + return self.role_name + + @NotBlank(field_name='role_key', message='权限字符不能为空') + @Size(field_name='role_key', min_length=0, max_length=100, message='权限字符长度不能超过100个字符') + def get_role_key(self) -> str | None: + return self.role_key + + @NotBlank(field_name='role_sort', message='显示顺序不能为空') + def get_role_sort(self) -> int | None: + return self.role_sort + + def validate_fields(self) -> None: + self.get_role_name() + self.get_role_key() + self.get_role_sort() + + +class RoleMenuModel(BaseModel): + """ + 角色和菜单关联表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + role_id: int | None = Field(default=None, description='角色ID') + menu_id: int | None = Field(default=None, description='菜单ID') + + +class RoleDeptModel(BaseModel): + """ + 角色和部门关联表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + role_id: int | None = Field(default=None, description='角色ID') + dept_id: int | None = Field(default=None, description='部门ID') + + +class RoleQueryModel(RoleModel): + """ + 角色管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class RolePageQueryModel(RoleQueryModel): + """ + 角色管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class RoleMenuQueryModel(BaseModel): + """ + 角色菜单查询模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + menus: list = Field(default=[], description='菜单信息') + checked_keys: list[int] = Field(default=[], description='已选择的菜单ID信息') + + +class RoleDeptQueryModel(BaseModel): + """ + 角色部门查询模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + depts: list = Field(default=[], description='部门信息') + checked_keys: list[int] = Field(default=[], description='已选择的部门ID信息') + + +class AddRoleModel(RoleModel): + """ + 新增角色模型 + """ + + dept_ids: list = Field(default=[], description='部门ID信息') + menu_ids: list = Field(default=[], description='菜单ID信息') + type: str | None = Field(default=None, description='操作类型') + + +class DeleteRoleModel(BaseModel): + """ + 删除角色模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + role_ids: str = Field(description='需要删除的角色ID') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/server_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/server_vo.py new file mode 100644 index 0000000..6d810ba --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/server_vo.py @@ -0,0 +1,66 @@ +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class CpuInfo(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + cpu_num: int | None = Field(default=None, description='核心数') + used: float | None = Field(default=None, description='CPU用户使用率') + sys: float | None = Field(default=None, description='CPU系统使用率') + free: float | None = Field(default=None, description='CPU当前空闲率') + + +class MemoryInfo(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + total: str | None = Field(default=None, description='内存总量') + used: str | None = Field(default=None, description='已用内存') + free: str | None = Field(default=None, description='剩余内存') + usage: float | None = Field(default=None, description='使用率') + + +class SysInfo(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + computer_ip: str | None = Field(default=None, description='服务器IP') + computer_name: str | None = Field(default=None, description='服务器名称') + os_arch: str | None = Field(default=None, description='系统架构') + os_name: str | None = Field(default=None, description='操作系统') + user_dir: str | None = Field(default=None, description='项目路径') + + +class PyInfo(MemoryInfo): + model_config = ConfigDict(alias_generator=to_camel) + + name: str | None = Field(default=None, description='Python名称') + version: str | None = Field(default=None, description='Python版本') + start_time: str | None = Field(default=None, description='启动时间') + run_time: str | None = Field(default=None, description='运行时长') + home: str | None = Field(default=None, description='安装路径') + + +class SysFiles(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + dir_name: str | None = Field(default=None, description='盘符路径') + sys_type_name: str | None = Field(default=None, description='盘符类型') + type_name: str | None = Field(default=None, description='文件类型') + total: str | None = Field(default=None, description='总大小') + used: str | None = Field(default=None, description='已经使用量') + free: str | None = Field(default=None, description='剩余大小') + usage: str | None = Field(default=None, description='资源的使用率') + + +class ServerMonitorModel(BaseModel): + """ + 服务监控对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + cpu: CpuInfo | None = Field(description='CPU相关信息') + py: PyInfo | None = Field(description='Python相关信息') + mem: MemoryInfo | None = Field(description='內存相关信息') + sys: SysInfo | None = Field(description='服务器相关信息') + sys_files: list[SysFiles] | None = Field(description='磁盘相关信息') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/transport_crypto_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/transport_crypto_vo.py new file mode 100644 index 0000000..d7511fd --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/transport_crypto_vo.py @@ -0,0 +1,99 @@ +from datetime import datetime + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class TransportCryptoFrontendConfigModel(BaseModel): + """ + 传输层加解密前端运行配置模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + transport_crypto_enabled: bool = Field(description='后端是否启用传输层加解密') + transport_crypto_mode: str = Field(description='当前传输层加解密模式') + transport_crypto_active: bool = Field(description='前端当前是否应启用传输层加解密') + envelope_version: str = Field(description='当前传输层加密信封协议版本') + public_key_url: str = Field(description='传输层公钥接口路径') + request_envelope_algorithm: str = Field(description='前端请求信封算法标识') + response_envelope_algorithm: str = Field(description='前端响应信封算法标识') + enabled_paths: list[str] = Field(description='启用传输层加解密的路径列表') + required_paths: list[str] = Field(description='强制要求加密传输的路径列表') + exclude_paths: list[str] = Field(description='排除传输层加解密的路径列表') + max_encrypted_get_url_length: int = Field(description='前端执行加密GET/DELETE请求时允许的最大URL长度') + config_expire_at: int = Field(description='前端配置建议刷新时间戳') + + +class TransportCryptoPublicKeyModel(BaseModel): + """ + 传输层加解密公钥下发模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + kid: str = Field(description='当前启用的密钥版本标识') + envelope_version: str = Field(description='当前传输层加密信封协议版本') + alg: str = Field(description='当前传输层加密算法标识') + public_key: str = Field(description='当前可用的传输层公钥') + supported_kids: list[str] = Field(description='当前支持解密的密钥版本列表') + expire_at: int = Field(description='当前公钥建议刷新时间戳') + + +class TransportCryptoKidStatModel(BaseModel): + """ + 传输层加解密按密钥版本统计模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + kid: str | None = Field(default=None, description='密钥版本标识') + encrypted_requests: int | None = Field(default=0, description='加密请求次数') + decrypt_success: int | None = Field(default=0, description='请求解密成功次数') + decrypt_failure: int | None = Field(default=0, description='请求解密失败次数') + encrypted_responses: int | None = Field(default=0, description='加密响应次数') + + +class TransportCryptoFailureRecordModel(BaseModel): + """ + 传输层加解密最近失败记录模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + time: datetime | None = Field(default=None, description='失败时间') + method: str | None = Field(default=None, description='请求方法') + path: str | None = Field(default=None, description='请求路径') + reason: str | None = Field(default=None, description='失败原因分类') + kid: str | None = Field(default=None, description='密钥版本标识') + + +class TransportCryptoMonitorModel(BaseModel): + """ + 传输层加解密监控模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + monitor_scope: str | None = Field(default=None, description='监控统计范围,默认基于Redis聚合') + started_at: datetime | None = Field(default=None, description='当前监控统计起始时间') + app_env: str | None = Field(default=None, description='当前应用环境') + transport_crypto_enabled: bool | None = Field(default=None, description='是否启用传输层加解密') + transport_crypto_mode: str | None = Field(default=None, description='当前传输层加解密模式') + current_kid: str | None = Field(default=None, description='当前启用的密钥版本') + supported_kids: list[str] | None = Field(default=[], description='当前支持的密钥版本列表') + enabled_paths: list[str] | None = Field(default=[], description='启用传输层加解密的路径列表') + required_paths: list[str] | None = Field(default=[], description='强制要求加密传输的路径列表') + exclude_paths: list[str] | None = Field(default=[], description='排除传输层加解密的路径列表') + requests_total: int | None = Field(default=0, description='命中传输层加解密规则的请求总数') + plain_requests_total: int | None = Field(default=0, description='明文请求总数') + encrypted_requests_total: int | None = Field(default=0, description='加密请求总数') + required_rejected_total: int | None = Field(default=0, description='强制加密接口被拒绝的次数') + decrypt_success_total: int | None = Field(default=0, description='请求解密成功次数') + decrypt_failure_total: int | None = Field(default=0, description='请求解密失败次数') + plain_responses_total: int | None = Field(default=0, description='明文响应次数') + encrypted_responses_total: int | None = Field(default=0, description='加密响应次数') + encrypted_error_responses_total: int | None = Field(default=0, description='加密错误响应次数') + failure_reasons: dict[str, int] | None = Field(default={}, description='按失败原因归类的次数统计') + kid_stats: list[TransportCryptoKidStatModel] | None = Field(default=[], description='按密钥版本归类的统计信息') + recent_failures: list[TransportCryptoFailureRecordModel] | None = Field(default=[], description='最近失败事件列表') diff --git a/shierfeng-fastapi-backend/module_admin/entity/vo/user_vo.py b/shierfeng-fastapi-backend/module_admin/entity/vo/user_vo.py new file mode 100644 index 0000000..399b1db --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/entity/vo/user_vo.py @@ -0,0 +1,299 @@ +import re +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field, model_validator +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import Network, NotBlank, Size, Xss + +from exceptions.exception import ModelValidatorException +from module_admin.entity.vo.dept_vo import DeptModel +from module_admin.entity.vo.post_vo import PostModel +from module_admin.entity.vo.role_vo import RoleModel + + +class TokenData(BaseModel): + """ + token解析结果 + """ + + user_id: int | None = Field(default=None, description='用户ID') + + +class UserModel(BaseModel): + """ + 用户表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + user_id: int | None = Field(default=None, description='用户ID') + dept_id: int | None = Field(default=None, description='部门ID') + user_name: str | None = Field(default=None, description='用户账号') + nick_name: str | None = Field(default=None, description='用户昵称') + user_type: str | None = Field(default=None, description='用户类型(00系统用户)') + email: str | None = Field(default=None, description='用户邮箱') + phonenumber: str | None = Field(default=None, description='手机号码') + sex: Literal['0', '1', '2'] | None = Field(default=None, description='用户性别(0男 1女 2未知)') + avatar: str | None = Field(default=None, description='头像地址') + password: str | None = Field(default=None, description='密码') + status: Literal['0', '1'] | None = Field(default=None, description='帐号状态(0正常 1停用)') + del_flag: Literal['0', '2'] | None = Field(default=None, description='删除标志(0代表存在 2代表删除)') + login_ip: str | None = Field(default=None, description='最后登录IP') + login_date: datetime | None = Field(default=None, description='最后登录时间') + pwd_update_date: datetime | None = Field(default=None, description='密码最后更新时间') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + admin: bool | None = Field(default=False, description='是否为admin') + + @model_validator(mode='after') + def check_password(self) -> 'UserModel': + pattern = r"""^[^<>"'|\\]+$""" + if self.password is None or re.match(pattern, self.password): + return self + raise ModelValidatorException(message='密码不能包含非法字符:< > " \' \\ |') + + @model_validator(mode='after') + def check_admin(self) -> 'UserModel': + if self.user_id == 1: + self.admin = True + else: + self.admin = False + return self + + @Xss(field_name='user_name', message='用户账号不能包含脚本字符') + @NotBlank(field_name='user_name', message='用户账号不能为空') + @Size(field_name='user_name', min_length=0, max_length=30, message='用户账号长度不能超过30个字符') + def get_user_name(self) -> str | None: + return self.user_name + + @Xss(field_name='nick_name', message='用户昵称不能包含脚本字符') + @Size(field_name='nick_name', min_length=0, max_length=30, message='用户昵称长度不能超过30个字符') + def get_nick_name(self) -> str | None: + return self.nick_name + + @Network(field_name='email', field_type='EmailStr', message='邮箱格式不正确') + @Size(field_name='email', min_length=0, max_length=50, message='邮箱长度不能超过50个字符') + def get_email(self) -> str | None: + return self.email + + @Size(field_name='phonenumber', min_length=0, max_length=11, message='手机号码长度不能超过11个字符') + def get_phonenumber(self) -> str | None: + return self.phonenumber + + def validate_fields(self) -> None: + self.get_user_name() + self.get_nick_name() + self.get_email() + self.get_phonenumber() + + +class UserRowModel(UserModel): + """ + 用户列表行数据模型 + """ + + dept: DeptModel | None = Field(default=None, description='部门信息') + + +class UserRoleModel(BaseModel): + """ + 用户和角色关联表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + user_id: int | None = Field(default=None, description='用户ID') + role_id: int | None = Field(default=None, description='角色ID') + + +class UserPostModel(BaseModel): + """ + 用户与岗位关联表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + user_id: int | None = Field(default=None, description='用户ID') + post_id: int | None = Field(default=None, description='岗位ID') + + +class UserInfoModel(UserModel): + post_ids: str | None | None = Field(default=None, description='岗位ID信息') + role_ids: str | None | None = Field(default=None, description='角色ID信息') + dept: DeptModel | None | None = Field(default=None, description='部门信息') + role: list[RoleModel | None] | None = Field(default=[], description='角色信息') + + +class CurrentUserModel(BaseModel): + model_config = ConfigDict(alias_generator=to_camel) + + permissions: list = Field(description='权限信息') + roles: list = Field(description='角色信息') + user: UserInfoModel | None = Field(description='用户信息') + is_default_modify_pwd: bool = Field(default=False, description='是否初始密码修改提醒') + is_password_expired: bool = Field(default=False, description='密码是否过期提醒') + + +class UserDetailModel(BaseModel): + """ + 获取用户详情信息响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + data: UserInfoModel | None | None = Field(default=None, description='用户信息') + post_ids: list | None = Field(default=None, description='岗位ID信息') + posts: list[PostModel | None] = Field(description='岗位信息') + role_ids: list | None = Field(default=None, description='角色ID信息') + roles: list[RoleModel | None] = Field(description='角色信息') + + +class UserProfileModel(BaseModel): + """ + 获取个人信息响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + data: UserInfoModel | None = Field(description='用户信息') + post_group: str | None = Field(description='岗位信息') + role_group: str | None = Field(description='角色信息') + + +class AvatarModel(BaseModel): + """ + 上传头像响应模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + img_url: str = Field(description='头像地址') + + +class UserQueryModel(UserModel): + """ + 用户管理不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class UserPageQueryModel(UserQueryModel): + """ + 用户管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class AddUserModel(UserModel): + """ + 新增用户模型 + """ + + role_ids: list | None = Field(default=[], description='角色ID信息') + post_ids: list | None = Field(default=[], description='岗位ID信息') + type: str | None = Field(default=None, description='操作类型') + + +class EditUserModel(AddUserModel): + """ + 编辑用户模型 + """ + + role: list | None = Field(default=[], description='角色信息') + + +class ResetPasswordModel(BaseModel): + """ + 重置密码模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + old_password: str | None = Field(default=None, description='旧密码') + new_password: str | None = Field(default=None, description='新密码') + + @model_validator(mode='after') + def check_new_password(self) -> 'ResetPasswordModel': + pattern = r"""^[^<>"'|\\]+$""" + if self.new_password is None or re.match(pattern, self.new_password): + return self + raise ModelValidatorException(message='密码不能包含非法字符:< > " \' \\ |') + + +class ResetUserModel(UserModel): + """ + 重置用户密码模型 + """ + + old_password: str | None = Field(default=None, description='旧密码') + sms_code: str | None = Field(default=None, description='验证码') + session_id: str | None = Field(default=None, description='会话id') + + +class DeleteUserModel(BaseModel): + """ + 删除用户模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + user_ids: str = Field(description='需要删除的用户ID') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + + +class UserRoleQueryModel(UserModel): + """ + 用户角色关联管理不分页查询模型 + """ + + role_id: int | None = Field(default=None, description='角色ID') + + +class UserRolePageQueryModel(UserRoleQueryModel): + """ + 用户角色关联管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class SelectedRoleModel(RoleModel): + """ + 是否选择角色模型 + """ + + flag: bool | None = Field(default=False, description='选择标识') + + +class UserRoleResponseModel(BaseModel): + """ + 用户角色关联管理列表返回模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + roles: list[SelectedRoleModel | None] = Field(default=[], description='角色信息') + user: UserInfoModel = Field(description='用户信息') + + +class CrudUserRoleModel(BaseModel): + """ + 新增、删除用户关联角色及角色关联用户模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + user_id: int | None = Field(default=None, description='用户ID') + user_ids: str | None = Field(default=None, description='用户ID信息') + role_id: int | None = Field(default=None, description='角色ID') + role_ids: str | None = Field(default=None, description='角色ID信息') diff --git a/shierfeng-fastapi-backend/module_admin/service/cache_service.py b/shierfeng-fastapi-backend/module_admin/service/cache_service.py new file mode 100644 index 0000000..410f6b8 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/cache_service.py @@ -0,0 +1,126 @@ +from fastapi import Request + +from common.enums import RedisInitKeyConfig +from common.vo import CrudResponseModel +from config.get_redis import RedisUtil +from module_admin.entity.vo.cache_vo import CacheInfoModel, CacheMonitorModel + + +class CacheService: + """ + 缓存监控模块服务层 + """ + + @classmethod + async def get_cache_monitor_statistical_info_services(cls, request: Request) -> CacheMonitorModel: + """ + 获取缓存监控信息service + + :param request: Request对象 + :return: 缓存监控信息 + """ + info = await request.app.state.redis.info() + db_size = await request.app.state.redis.dbsize() + command_stats_dict = await request.app.state.redis.info('commandstats') + command_stats = [ + {'name': key.split('_')[1], 'value': str(value.get('calls'))} for key, value in command_stats_dict.items() + ] + result = CacheMonitorModel(commandStats=command_stats, dbSize=db_size, info=info) + + return result + + @classmethod + async def get_cache_monitor_cache_name_services(cls) -> list[CacheInfoModel]: + """ + 获取缓存名称列表信息service + + :return: 缓存名称列表信息 + """ + name_list = [ + CacheInfoModel( + cacheKey='', + cacheName=key_config.key, + cacheValue='', + remark=key_config.remark, + ) + for key_config in RedisInitKeyConfig + ] + + return name_list + + @classmethod + async def get_cache_monitor_cache_key_services(cls, request: Request, cache_name: str) -> list[str]: + """ + 获取缓存键名列表信息service + + :param request: Request对象 + :param cache_name: 缓存名称 + :return: 缓存键名列表信息 + """ + cache_keys: list[str] = await request.app.state.redis.keys(f'{cache_name}*') + cache_key_list = [key.split(':', 1)[1] for key in cache_keys if key.startswith(f'{cache_name}:')] + + return cache_key_list + + @classmethod + async def get_cache_monitor_cache_value_services( + cls, request: Request, cache_name: str, cache_key: str + ) -> CacheInfoModel: + """ + 获取缓存内容信息service + + :param request: Request对象 + :param cache_name: 缓存名称 + :param cache_key: 缓存键名 + :return: 缓存内容信息 + """ + cache_value = await request.app.state.redis.get(f'{cache_name}:{cache_key}') + + return CacheInfoModel(cacheKey=cache_key, cacheName=cache_name, cacheValue=cache_value, remark='') + + @classmethod + async def clear_cache_monitor_cache_name_services(cls, request: Request, cache_name: str) -> CrudResponseModel: + """ + 清除缓存名称对应所有键值service + + :param request: Request对象 + :param cache_name: 缓存名称 + :return: 操作缓存响应信息 + """ + cache_keys = await request.app.state.redis.keys(f'{cache_name}*') + if cache_keys: + await request.app.state.redis.delete(*cache_keys) + + return CrudResponseModel(is_success=True, message=f'{cache_name}对应键值清除成功') + + @classmethod + async def clear_cache_monitor_cache_key_services(cls, request: Request, cache_key: str) -> CrudResponseModel: + """ + 清除缓存名称对应所有键值service + + :param request: Request对象 + :param cache_key: 缓存键名 + :return: 操作缓存响应信息 + """ + cache_keys = await request.app.state.redis.keys(f'*{cache_key}') + if cache_keys: + await request.app.state.redis.delete(*cache_keys) + + return CrudResponseModel(is_success=True, message=f'{cache_key}清除成功') + + @classmethod + async def clear_cache_monitor_all_services(cls, request: Request) -> CrudResponseModel: + """ + 清除所有缓存service + + :param request: Request对象 + :return: 操作缓存响应信息 + """ + cache_keys = await request.app.state.redis.keys() + if cache_keys: + await request.app.state.redis.delete(*cache_keys) + + await RedisUtil.init_sys_dict(request.app.state.redis) + await RedisUtil.init_sys_config(request.app.state.redis) + + return CrudResponseModel(is_success=True, message='所有缓存清除成功') diff --git a/shierfeng-fastapi-backend/module_admin/service/captcha_service.py b/shierfeng-fastapi-backend/module_admin/service/captcha_service.py new file mode 100644 index 0000000..7a81269 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/captcha_service.py @@ -0,0 +1,54 @@ +import base64 +import io +import random + +import anyio +from PIL import Image, ImageDraw, ImageFont + + +class CaptchaService: + """ + 验证码模块服务层 + """ + + @classmethod + async def create_captcha_image_service(cls) -> list[str, int]: + # 创建空白图像 + image = Image.new('RGB', (160, 60), color='#EAEAEA') + + # 创建绘图对象 + draw = ImageDraw.Draw(image) + + # 设置字体 + font_path = (await anyio.Path.cwd()) / 'assets' / 'font' / 'Arial.ttf' + font = ImageFont.truetype(font_path, size=30) + + # 生成两个0-9之间的随机整数 + num1 = random.randint(0, 9) + num2 = random.randint(0, 9) + # 从运算符列表中随机选择一个 + operational_character_list = ['+', '-', '*'] + operational_character = random.choice(operational_character_list) + # 根据选择的运算符进行计算 + if operational_character == '+': + result = num1 + num2 + elif operational_character == '-': + result = num1 - num2 + # 非负数结果的验证码更友好一些 + if result < 0: + num1, num2 = num2, num1 + result = num1 - num2 + else: + result = num1 * num2 + # 绘制文本 + text = f'{num1} {operational_character} {num2} = ?' + draw.text((25, 15), text, fill='blue', font=font) + + # 将图像数据保存到内存中 + buffer = io.BytesIO() + image.save(buffer, format='PNG') + + # 将图像数据转换为base64字符串 + base64_string = base64.b64encode(buffer.getvalue()).decode() + + return [base64_string, result] diff --git a/shierfeng-fastapi-backend/module_admin/service/common_service.py b/shierfeng-fastapi-backend/module_admin/service/common_service.py new file mode 100644 index 0000000..254ad9f --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/common_service.py @@ -0,0 +1,99 @@ +import os +from datetime import datetime + +import aiofiles +from fastapi import BackgroundTasks, Request, UploadFile + +from common.vo import CrudResponseModel +from config.env import UploadConfig +from exceptions.exception import ServiceException +from module_admin.entity.vo.common_vo import UploadResponseModel +from utils.upload_util import UploadUtil + + +class CommonService: + """ + 通用模块服务层 + """ + + @classmethod + async def upload_service(cls, request: Request, file: UploadFile) -> CrudResponseModel: + """ + 通用上传service + + :param request: Request对象 + :param file: 上传文件对象 + :return: 上传结果 + """ + if not UploadUtil.check_file_extension(file): + raise ServiceException(message='文件类型不合法') + relative_path = ( + f'upload/{datetime.now().strftime("%Y")}/{datetime.now().strftime("%m")}/{datetime.now().strftime("%d")}' + ) + dir_path = os.path.join(UploadConfig.UPLOAD_PATH, relative_path) + try: + os.makedirs(dir_path) + except FileExistsError: + pass + filename = f'{file.filename.rsplit(".", 1)[0]}_{datetime.now().strftime("%Y%m%d%H%M%S")}{UploadConfig.UPLOAD_MACHINE}{UploadUtil.generate_random_number()}.{file.filename.rsplit(".")[-1]}' + filepath = os.path.join(dir_path, filename) + async with aiofiles.open(filepath, 'wb') as f: + # 流式写出大型文件,这里的10代表10MB + while True: + chunk = await file.read(1024 * 1024 * 10) + if not chunk: + break + await f.write(chunk) + + return CrudResponseModel( + is_success=True, + result=UploadResponseModel( + fileName=f'{UploadConfig.UPLOAD_PREFIX}/{relative_path}/{filename}', + newFileName=filename, + originalFilename=file.filename, + url=f'{request.base_url}{UploadConfig.UPLOAD_PREFIX[1:]}/{relative_path}/{filename}', + ), + message='上传成功', + ) + + @classmethod + async def download_services( + cls, background_tasks: BackgroundTasks, file_name: str, delete: bool + ) -> CrudResponseModel: + """ + 下载下载目录文件service + + :param background_tasks: 后台任务对象 + :param file_name: 下载的文件名称 + :param delete: 是否在下载完成后删除文件 + :return: 上传结果 + """ + filepath = os.path.join(UploadConfig.DOWNLOAD_PATH, file_name) + if '..' in file_name: + raise ServiceException(message='文件名称不合法') + if not UploadUtil.check_file_exists(filepath): + raise ServiceException(message='文件不存在') + if delete: + background_tasks.add_task(UploadUtil.delete_file, filepath) + return CrudResponseModel(is_success=True, result=UploadUtil.generate_file(filepath), message='下载成功') + + @classmethod + async def download_resource_services(cls, resource: str) -> CrudResponseModel: + """ + 下载上传目录文件service + + :param resource: 下载的文件名称 + :return: 上传结果 + """ + filepath = os.path.join(resource.replace(UploadConfig.UPLOAD_PREFIX, UploadConfig.UPLOAD_PATH)) + filename = resource.rsplit('/', 1)[-1] + if ( + '..' in filename + or not UploadUtil.check_file_timestamp(filename) + or not UploadUtil.check_file_machine(filename) + or not UploadUtil.check_file_random_code(filename) + ): + raise ServiceException(message='文件名称不合法') + if not UploadUtil.check_file_exists(filepath): + raise ServiceException(message='文件不存在') + return CrudResponseModel(is_success=True, result=UploadUtil.generate_file(filepath), message='下载成功') diff --git a/shierfeng-fastapi-backend/module_admin/service/config_service.py b/shierfeng-fastapi-backend/module_admin/service/config_service.py new file mode 100644 index 0000000..6dd3fbb --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/config_service.py @@ -0,0 +1,234 @@ +from typing import Any + +from fastapi import Request +from redis import asyncio as aioredis +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.enums import RedisInitKeyConfig +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.config_dao import ConfigDao +from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel, DeleteConfigModel +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil + + +class ConfigService: + """ + 参数配置管理模块服务层 + """ + + @classmethod + async def get_config_list_services( + cls, query_db: AsyncSession, query_object: ConfigPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取参数配置列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 参数配置列表信息对象 + """ + config_list_result = await ConfigDao.get_config_list(query_db, query_object, is_page) + + return config_list_result + + @classmethod + async def init_cache_sys_config_services(cls, query_db: AsyncSession, redis: aioredis.Redis) -> None: + """ + 应用初始化:获取所有参数配置对应的键值对信息并缓存service + + :param query_db: orm对象 + :param redis: redis对象 + :return: + """ + # 获取以sys_config:开头的键列表 + keys = await redis.keys(f'{RedisInitKeyConfig.SYS_CONFIG.key}:*') + # 删除匹配的键 + if keys: + await redis.delete(*keys) + config_all = await ConfigDao.get_config_list(query_db, ConfigPageQueryModel(), is_page=False) + for config_obj in config_all: + await redis.set( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:{config_obj.get("configKey")}', + config_obj.get('configValue'), + ) + + @classmethod + async def query_config_list_from_cache_services(cls, redis: aioredis.Redis, config_key: str) -> Any: + """ + 从缓存获取参数键名对应值service + + :param redis: redis对象 + :param config_key: 参数键名 + :return: 参数键名对应值 + """ + result = await redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:{config_key}') + + return result + + @classmethod + async def check_config_key_unique_services(cls, query_db: AsyncSession, page_object: ConfigModel) -> bool: + """ + 校验参数键名是否唯一service + + :param query_db: orm对象 + :param page_object: 参数配置对象 + :return: 校验结果 + """ + config_id = -1 if page_object.config_id is None else page_object.config_id + config = await ConfigDao.get_config_detail_by_info(query_db, ConfigModel(configKey=page_object.config_key)) + if config and config.config_id != config_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_config_services( + cls, request: Request, query_db: AsyncSession, page_object: ConfigModel + ) -> CrudResponseModel: + """ + 新增参数配置信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 新增参数配置对象 + :return: 新增参数配置校验结果 + """ + if not await cls.check_config_key_unique_services(query_db, page_object): + raise ServiceException(message=f'新增参数{page_object.config_name}失败,参数键名已存在') + try: + await ConfigDao.add_config_dao(query_db, page_object) + await query_db.commit() + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:{page_object.config_key}', page_object.config_value + ) + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_config_services( + cls, request: Request, query_db: AsyncSession, page_object: ConfigModel + ) -> CrudResponseModel: + """ + 编辑参数配置信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 编辑参数配置对象 + :return: 编辑参数配置校验结果 + """ + edit_config = page_object.model_dump(exclude_unset=True) + config_info = await cls.config_detail_services(query_db, page_object.config_id) + if config_info.config_id: + if not await cls.check_config_key_unique_services(query_db, page_object): + raise ServiceException(message=f'修改参数{page_object.config_name}失败,参数键名已存在') + try: + await ConfigDao.edit_config_dao(query_db, edit_config) + await query_db.commit() + if config_info.config_key != page_object.config_key: + await request.app.state.redis.delete( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:{config_info.config_key}' + ) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:{page_object.config_key}', page_object.config_value + ) + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='参数配置不存在') + + @classmethod + async def delete_config_services( + cls, request: Request, query_db: AsyncSession, page_object: DeleteConfigModel + ) -> CrudResponseModel: + """ + 删除参数配置信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 删除参数配置对象 + :return: 删除参数配置校验结果 + """ + if page_object.config_ids: + config_id_list = page_object.config_ids.split(',') + try: + delete_config_key_list = [] + for config_id in config_id_list: + config_info = await cls.config_detail_services(query_db, int(config_id)) + if config_info.config_type == CommonConstant.YES: + raise ServiceException(message=f'内置参数{config_info.config_key}不能删除') + await ConfigDao.delete_config_dao(query_db, ConfigModel(configId=int(config_id))) + delete_config_key_list.append(f'{RedisInitKeyConfig.SYS_CONFIG.key}:{config_info.config_key}') + await query_db.commit() + if delete_config_key_list: + await request.app.state.redis.delete(*delete_config_key_list) + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入参数配置id为空') + + @classmethod + async def config_detail_services(cls, query_db: AsyncSession, config_id: int) -> ConfigModel: + """ + 获取参数配置详细信息service + + :param query_db: orm对象 + :param config_id: 参数配置id + :return: 参数配置id对应的信息 + """ + config = await ConfigDao.get_config_detail_by_id(query_db, config_id=config_id) + result = ConfigModel(**CamelCaseUtil.transform_result(config)) if config else ConfigModel() + + return result + + @staticmethod + async def export_config_list_services(config_list: list) -> bytes: + """ + 导出参数配置信息service + + :param config_list: 参数配置信息列表 + :return: 参数配置信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'configId': '参数主键', + 'configName': '参数名称', + 'configKey': '参数键名', + 'configValue': '参数键值', + 'configType': '系统内置', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in config_list: + if item.get('configType') == 'Y': + item['configType'] = '是' + else: + item['configType'] = '否' + binary_data = ExcelUtil.export_list2excel(config_list, mapping_dict) + + return binary_data + + @classmethod + async def refresh_sys_config_services(cls, request: Request, query_db: AsyncSession) -> CrudResponseModel: + """ + 刷新字典缓存信息service + + :param request: Request对象 + :param query_db: orm对象 + :return: 刷新字典缓存校验结果 + """ + await cls.init_cache_sys_config_services(query_db, request.app.state.redis) + + return CrudResponseModel(is_success=True, message='刷新成功') diff --git a/shierfeng-fastapi-backend/module_admin/service/dept_service.py b/shierfeng-fastapi-backend/module_admin/service/dept_service.py new file mode 100644 index 0000000..da61a2b --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/dept_service.py @@ -0,0 +1,285 @@ +from collections.abc import Sequence +from typing import Any + +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel +from exceptions.exception import ServiceException, ServiceWarning +from module_admin.dao.dept_dao import DeptDao +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.vo.dept_vo import DeleteDeptModel, DeptModel, DeptTreeModel +from utils.common_util import CamelCaseUtil + + +class DeptService: + """ + 部门管理模块服务层 + """ + + @classmethod + async def get_dept_tree_services( + cls, query_db: AsyncSession, page_object: DeptModel, data_scope_sql: ColumnElement + ) -> list[dict[str, Any]]: + """ + 获取部门树信息service + + :param query_db: orm对象 + :param page_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 部门树信息对象 + """ + dept_list_result = await DeptDao.get_dept_list_for_tree(query_db, page_object, data_scope_sql) + dept_tree_model_result = cls.list_to_tree(dept_list_result) + dept_tree_result = [dept.model_dump(exclude_unset=True, by_alias=True) for dept in dept_tree_model_result] + + return dept_tree_result + + @classmethod + async def get_dept_for_edit_option_services( + cls, query_db: AsyncSession, page_object: DeptModel, data_scope_sql: ColumnElement + ) -> list[dict[str, Any]]: + """ + 获取部门编辑部门树信息service + + :param query_db: orm对象 + :param page_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 部门树信息对象 + """ + dept_list_result = await DeptDao.get_dept_info_for_edit_option(query_db, page_object, data_scope_sql) + + return CamelCaseUtil.transform_result(dept_list_result) + + @classmethod + async def get_dept_list_services( + cls, query_db: AsyncSession, page_object: DeptModel, data_scope_sql: ColumnElement + ) -> list[dict[str, Any]]: + """ + 获取部门列表信息service + + :param query_db: orm对象 + :param page_object: 分页查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 部门列表信息对象 + """ + dept_list_result = await DeptDao.get_dept_list(query_db, page_object, data_scope_sql) + + return CamelCaseUtil.transform_result(dept_list_result) + + @classmethod + async def check_dept_data_scope_services( + cls, query_db: AsyncSession, dept_id: int, data_scope_sql: ColumnElement + ) -> CrudResponseModel: + """ + 校验部门是否有数据权限service + + :param query_db: orm对象 + :param dept_id: 部门id + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 校验结果 + """ + depts = await DeptDao.get_dept_list(query_db, DeptModel(deptId=dept_id), data_scope_sql) + if depts: + return CrudResponseModel(is_success=True, message='校验通过') + raise ServiceException(message='没有权限访问部门数据') + + @classmethod + async def check_dept_name_unique_services(cls, query_db: AsyncSession, page_object: DeptModel) -> bool: + """ + 校验部门名称是否唯一service + + :param query_db: orm对象 + :param page_object: 部门对象 + :return: 校验结果 + """ + dept_id = -1 if page_object.dept_id is None else page_object.dept_id + dept = await DeptDao.get_dept_detail_by_info( + query_db, DeptModel(deptName=page_object.dept_name, parentId=page_object.parent_id) + ) + if dept and dept.dept_id != dept_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_dept_services(cls, query_db: AsyncSession, page_object: DeptModel) -> CrudResponseModel: + """ + 新增部门信息service + + :param query_db: orm对象 + :param page_object: 新增部门对象 + :return: 新增部门校验结果 + """ + if not await cls.check_dept_name_unique_services(query_db, page_object): + raise ServiceException(message=f'新增部门{page_object.dept_name}失败,部门名称已存在') + parent_info = await DeptDao.get_dept_by_id(query_db, page_object.parent_id) + if parent_info.status != CommonConstant.DEPT_NORMAL: + raise ServiceException(message=f'部门{parent_info.dept_name}停用,不允许新增') + page_object.ancestors = f'{parent_info.ancestors},{page_object.parent_id}' + try: + await DeptDao.add_dept_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_dept_services(cls, query_db: AsyncSession, page_object: DeptModel) -> CrudResponseModel: + """ + 编辑部门信息service + + :param query_db: orm对象 + :param page_object: 编辑部门对象 + :return: 编辑部门校验结果 + """ + if not await cls.check_dept_name_unique_services(query_db, page_object): + raise ServiceException(message=f'修改部门{page_object.dept_name}失败,部门名称已存在') + if page_object.dept_id == page_object.parent_id: + raise ServiceException(message=f'修改部门{page_object.dept_name}失败,上级部门不能是自己') + if ( + page_object.status == CommonConstant.DEPT_DISABLE + and (await DeptDao.count_normal_children_dept_dao(query_db, page_object.dept_id)) > 0 + ): + raise ServiceException(message=f'修改部门{page_object.dept_name}失败,该部门包含未停用的子部门') + new_parent_dept = await DeptDao.get_dept_by_id(query_db, page_object.parent_id) + old_dept = await DeptDao.get_dept_by_id(query_db, page_object.dept_id) + try: + if new_parent_dept and old_dept: + new_ancestors = f'{new_parent_dept.ancestors},{new_parent_dept.dept_id}' + old_ancestors = old_dept.ancestors + page_object.ancestors = new_ancestors + await cls.update_dept_children(query_db, page_object.dept_id, new_ancestors, old_ancestors) + edit_dept = page_object.model_dump(exclude_unset=True) + await DeptDao.edit_dept_dao(query_db, edit_dept) + if ( + page_object.status == CommonConstant.DEPT_NORMAL + and page_object.ancestors + and page_object.ancestors != 0 + ): + await cls.update_parent_dept_status_normal(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def delete_dept_services(cls, query_db: AsyncSession, page_object: DeleteDeptModel) -> CrudResponseModel: + """ + 删除部门信息service + + :param query_db: orm对象 + :param page_object: 删除部门对象 + :return: 删除部门校验结果 + """ + if page_object.dept_ids: + dept_id_list = page_object.dept_ids.split(',') + try: + for dept_id in dept_id_list: + if (await DeptDao.count_children_dept_dao(query_db, int(dept_id))) > 0: + raise ServiceWarning(message='存在下级部门,不允许删除') + if (await DeptDao.count_dept_user_dao(query_db, int(dept_id))) > 0: + raise ServiceWarning(message='部门存在用户,不允许删除') + + await DeptDao.delete_dept_dao(query_db, DeptModel(deptId=dept_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入部门id为空') + + @classmethod + async def dept_detail_services(cls, query_db: AsyncSession, dept_id: int) -> DeptModel: + """ + 获取部门详细信息service + + :param query_db: orm对象 + :param dept_id: 部门id + :return: 部门id对应的信息 + """ + dept = await DeptDao.get_dept_detail_by_id(query_db, dept_id=dept_id) + result = DeptModel(**CamelCaseUtil.transform_result(dept)) if dept else DeptModel() + + return result + + @classmethod + def list_to_tree(cls, permission_list: Sequence[SysDept]) -> list[DeptTreeModel]: + """ + 工具方法:根据部门列表信息生成树形嵌套数据 + + :param permission_list: 部门列表信息 + :return: 部门树形嵌套数据 + """ + _permission_list = [ + DeptTreeModel(id=item.dept_id, label=item.dept_name, parentId=item.parent_id) for item in permission_list + ] + # 转成id为key的字典 + mapping: dict[int, DeptTreeModel] = dict(zip([i.id for i in _permission_list], _permission_list, strict=False)) + + # 树容器 + container: list[DeptTreeModel] = [] + + for d in _permission_list: + # 如果找不到父级项,则是根节点 + parent = mapping.get(d.parent_id) + if parent is None: + container.append(d) + else: + children: list[DeptTreeModel] = parent.children + if not children: + children = [] + children.append(d) + parent.children = children + + return container + + @classmethod + async def replace_first(cls, original_str: str, old_str: str, new_str: str) -> str: + """ + 工具方法:替换字符串 + + :param original_str: 需要替换的原始字符串 + :param old_str: 用于匹配的字符串 + :param new_str: 替换的字符串 + :return: 替换后的字符串 + """ + if original_str.startswith(old_str): + return original_str.replace(old_str, new_str, 1) + return original_str + + @classmethod + async def update_parent_dept_status_normal(cls, query_db: AsyncSession, dept: DeptModel) -> None: + """ + 更新父部门状态为正常 + + :param query_db: orm对象 + :param dept: 部门对象 + :return: + """ + dept_id_list = dept.ancestors.split(',') + await DeptDao.update_dept_status_normal_dao(query_db, list(map(int, dept_id_list))) + + @classmethod + async def update_dept_children( + cls, query_db: AsyncSession, dept_id: int, new_ancestors: str, old_ancestors: str + ) -> None: + """ + 更新子部门信息 + + :param query_db: orm对象 + :param dept_id: 部门id + :param new_ancestors: 新的祖先 + :param old_ancestors: 旧的祖先 + :return: + """ + children = await DeptDao.get_children_dept_dao(query_db, dept_id) + update_children = [] + for child in children: + child_ancestors = await cls.replace_first(child.ancestors, old_ancestors, new_ancestors) + update_children.append({'dept_id': child.dept_id, 'ancestors': child_ancestors}) + if children: + await DeptDao.update_dept_children_dao(query_db, update_children) diff --git a/shierfeng-fastapi-backend/module_admin/service/dict_service.py b/shierfeng-fastapi-backend/module_admin/service/dict_service.py new file mode 100644 index 0000000..afc83ce --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/dict_service.py @@ -0,0 +1,464 @@ +import json +from collections.abc import Sequence +from typing import Any + +from fastapi import Request +from redis import asyncio as aioredis +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.enums import RedisInitKeyConfig +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.dict_dao import DictDataDao, DictTypeDao +from module_admin.entity.do.dict_do import SysDictData +from module_admin.entity.vo.dict_vo import ( + DeleteDictDataModel, + DeleteDictTypeModel, + DictDataModel, + DictDataPageQueryModel, + DictTypeModel, + DictTypePageQueryModel, +) +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil + + +class DictTypeService: + """ + 字典类型管理模块服务层 + """ + + @classmethod + async def get_dict_type_list_services( + cls, query_db: AsyncSession, query_object: DictTypePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取字典类型列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 字典类型列表信息对象 + """ + dict_type_list_result = await DictTypeDao.get_dict_type_list(query_db, query_object, is_page) + + return dict_type_list_result + + @classmethod + async def check_dict_type_unique_services(cls, query_db: AsyncSession, page_object: DictTypeModel) -> bool: + """ + 校验字典类型称是否唯一service + + :param query_db: orm对象 + :param page_object: 字典类型对象 + :return: 校验结果 + """ + dict_id = -1 if page_object.dict_id is None else page_object.dict_id + dict_type = await DictTypeDao.get_dict_type_detail_by_info( + query_db, DictTypeModel(dictType=page_object.dict_type) + ) + if dict_type and dict_type.dict_id != dict_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_dict_type_services( + cls, request: Request, query_db: AsyncSession, page_object: DictTypeModel + ) -> CrudResponseModel: + """ + 新增字典类型信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 新增岗位对象 + :return: 新增字典类型校验结果 + """ + if not await cls.check_dict_type_unique_services(query_db, page_object): + raise ServiceException(message=f'新增字典{page_object.dict_name}失败,字典类型已存在') + try: + await DictTypeDao.add_dict_type_dao(query_db, page_object) + await query_db.commit() + await request.app.state.redis.set(f'{RedisInitKeyConfig.SYS_DICT.key}:{page_object.dict_type}', '') + result = {'is_success': True, 'message': '新增成功'} + except Exception as e: + await query_db.rollback() + raise e + + return CrudResponseModel(**result) + + @classmethod + async def edit_dict_type_services( + cls, request: Request, query_db: AsyncSession, page_object: DictTypeModel + ) -> CrudResponseModel: + """ + 编辑字典类型信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 编辑字典类型对象 + :return: 编辑字典类型校验结果 + """ + edit_dict_type = page_object.model_dump(exclude_unset=True) + dict_type_info = await cls.dict_type_detail_services(query_db, page_object.dict_id) + if dict_type_info.dict_id: + if not await cls.check_dict_type_unique_services(query_db, page_object): + raise ServiceException(message=f'修改字典{page_object.dict_name}失败,字典类型已存在') + try: + query_dict_data = DictDataPageQueryModel(dictType=dict_type_info.dict_type) + dict_data_list = await DictDataDao.get_dict_data_list(query_db, query_dict_data, is_page=False) + if dict_type_info.dict_type != page_object.dict_type: + for dict_data in dict_data_list: + edit_dict_data = DictDataModel( + dictCode=dict_data.get('dict_code'), + dictType=page_object.dict_type, + updateBy=page_object.update_by, + updateTime=page_object.update_time, + ).model_dump(exclude_unset=True) + await DictDataDao.edit_dict_data_dao(query_db, edit_dict_data) + await DictTypeDao.edit_dict_type_dao(query_db, edit_dict_type) + await query_db.commit() + if dict_type_info.dict_type != page_object.dict_type: + dict_data = [CamelCaseUtil.transform_result(row) for row in dict_data_list if row] + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_DICT.key}:{page_object.dict_type}', + json.dumps(dict_data, ensure_ascii=False, default=str), + ) + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='字典类型不存在') + + @classmethod + async def delete_dict_type_services( + cls, request: Request, query_db: AsyncSession, page_object: DeleteDictTypeModel + ) -> CrudResponseModel: + """ + 删除字典类型信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 删除字典类型对象 + :return: 删除字典类型校验结果 + """ + if page_object.dict_ids: + dict_id_list = page_object.dict_ids.split(',') + try: + delete_dict_type_list = [] + for dict_id in dict_id_list: + dict_type_into = await cls.dict_type_detail_services(query_db, int(dict_id)) + if (await DictDataDao.count_dict_data_dao(query_db, dict_type_into.dict_type)) > 0: + raise ServiceException(message=f'{dict_type_into.dict_name}已分配,不能删除') + await DictTypeDao.delete_dict_type_dao(query_db, DictTypeModel(dictId=int(dict_id))) + delete_dict_type_list.append(f'{RedisInitKeyConfig.SYS_DICT.key}:{dict_type_into.dict_type}') + await query_db.commit() + if delete_dict_type_list: + await request.app.state.redis.delete(*delete_dict_type_list) + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入字典类型id为空') + + @classmethod + async def dict_type_detail_services(cls, query_db: AsyncSession, dict_id: int) -> DictTypeModel: + """ + 获取字典类型详细信息service + + :param query_db: orm对象 + :param dict_id: 字典类型id + :return: 字典类型id对应的信息 + """ + dict_type = await DictTypeDao.get_dict_type_detail_by_id(query_db, dict_id=dict_id) + result = DictTypeModel(**CamelCaseUtil.transform_result(dict_type)) if dict_type else DictTypeModel() + + return result + + @staticmethod + async def export_dict_type_list_services(dict_type_list: list) -> bytes: + """ + 导出字典类型信息service + + :param dict_type_list: 字典信息列表 + :return: 字典信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'dictId': '字典编号', + 'dictName': '字典名称', + 'dictType': '字典类型', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in dict_type_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '停用' + binary_data = ExcelUtil.export_list2excel(dict_type_list, mapping_dict) + + return binary_data + + @classmethod + async def refresh_sys_dict_services(cls, request: Request, query_db: AsyncSession) -> CrudResponseModel: + """ + 刷新字典缓存信息service + + :param request: Request对象 + :param query_db: orm对象 + :return: 刷新字典缓存校验结果 + """ + await DictDataService.init_cache_sys_dict_services(query_db, request.app.state.redis) + result = {'is_success': True, 'message': '刷新成功'} + + return CrudResponseModel(**result) + + +class DictDataService: + """ + 字典数据管理模块服务层 + """ + + @classmethod + async def get_dict_data_list_services( + cls, query_db: AsyncSession, query_object: DictDataPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取字典数据列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 字典数据列表信息对象 + """ + dict_data_list_result = await DictDataDao.get_dict_data_list(query_db, query_object, is_page) + + return dict_data_list_result + + @classmethod + async def query_dict_data_list_services(cls, query_db: AsyncSession, dict_type: str) -> Sequence[SysDictData]: + """ + 获取字典数据列表信息service + + :param query_db: orm对象 + :param dict_type: 字典类型 + :return: 字典数据列表信息对象 + """ + dict_data_list_result = await DictDataDao.query_dict_data_list(query_db, dict_type) + + return dict_data_list_result + + @classmethod + async def init_cache_sys_dict_services(cls, query_db: AsyncSession, redis: aioredis.Redis) -> None: + """ + 应用初始化:获取所有字典类型对应的字典数据信息并缓存service + + :param query_db: orm对象 + :param redis: redis对象 + :return: + """ + # 获取以sys_dict:开头的键列表 + keys = await redis.keys(f'{RedisInitKeyConfig.SYS_DICT.key}:*') + # 删除匹配的键 + if keys: + await redis.delete(*keys) + dict_type_all = await DictTypeDao.get_all_dict_type(query_db) + for dict_type_obj in [item for item in dict_type_all if item.status == '0']: + dict_type = dict_type_obj.dict_type + dict_data_list = await DictDataDao.query_dict_data_list(query_db, dict_type) + dict_data = [CamelCaseUtil.transform_result(row) for row in dict_data_list if row] + await redis.set( + f'{RedisInitKeyConfig.SYS_DICT.key}:{dict_type}', + json.dumps(dict_data, ensure_ascii=False, default=str), + ) + + @classmethod + async def query_dict_data_list_from_cache_services( + cls, redis: aioredis.Redis, dict_type: str + ) -> list[dict[str, Any]]: + """ + 从缓存获取字典数据列表信息service + + :param redis: redis对象 + :param dict_type: 字典类型 + :return: 字典数据列表信息对象 + """ + result = [] + dict_data_list_result = await redis.get(f'{RedisInitKeyConfig.SYS_DICT.key}:{dict_type}') + if dict_data_list_result: + result = json.loads(dict_data_list_result) + + return CamelCaseUtil.transform_result(result) + + @classmethod + async def check_dict_data_unique_services(cls, query_db: AsyncSession, page_object: DictDataModel) -> bool: + """ + 校验字典数据是否唯一service + + :param query_db: orm对象 + :param page_object: 字典数据对象 + :return: 校验结果 + """ + dict_code = -1 if page_object.dict_code is None else page_object.dict_code + dict_data = await DictDataDao.get_dict_data_detail_by_info(query_db, page_object) + if dict_data and dict_data.dict_code != dict_code: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_dict_data_services( + cls, request: Request, query_db: AsyncSession, page_object: DictDataModel + ) -> CrudResponseModel: + """ + 新增字典数据信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 新增岗位对象 + :return: 新增字典数据校验结果 + """ + if not await cls.check_dict_data_unique_services(query_db, page_object): + raise ServiceException( + message=f'新增字典数据{page_object.dict_label}失败,{page_object.dict_type}下已存在该字典数据' + ) + try: + await DictDataDao.add_dict_data_dao(query_db, page_object) + await query_db.commit() + dict_data_list = await cls.query_dict_data_list_services(query_db, page_object.dict_type) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_DICT.key}:{page_object.dict_type}', + json.dumps(CamelCaseUtil.transform_result(dict_data_list), ensure_ascii=False, default=str), + ) + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_dict_data_services( + cls, request: Request, query_db: AsyncSession, page_object: DictDataModel + ) -> CrudResponseModel: + """ + 编辑字典数据信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 编辑字典数据对象 + :return: 编辑字典数据校验结果 + """ + edit_data_type = page_object.model_dump(exclude_unset=True) + dict_data_info = await cls.dict_data_detail_services(query_db, page_object.dict_code) + if dict_data_info.dict_code: + if not await cls.check_dict_data_unique_services(query_db, page_object): + raise ServiceException( + message=f'新增字典数据{page_object.dict_label}失败,{page_object.dict_type}下已存在该字典数据' + ) + try: + await DictDataDao.edit_dict_data_dao(query_db, edit_data_type) + await query_db.commit() + dict_data_list = await cls.query_dict_data_list_services(query_db, page_object.dict_type) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_DICT.key}:{page_object.dict_type}', + json.dumps(CamelCaseUtil.transform_result(dict_data_list), ensure_ascii=False, default=str), + ) + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='字典数据不存在') + + @classmethod + async def delete_dict_data_services( + cls, request: Request, query_db: AsyncSession, page_object: DeleteDictDataModel + ) -> CrudResponseModel: + """ + 删除字典数据信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 删除字典数据对象 + :return: 删除字典数据校验结果 + """ + if page_object.dict_codes: + dict_code_list = page_object.dict_codes.split(',') + try: + delete_dict_type_list = [] + for dict_code in dict_code_list: + dict_data = await cls.dict_data_detail_services(query_db, int(dict_code)) + await DictDataDao.delete_dict_data_dao(query_db, DictDataModel(dictCode=dict_code)) + delete_dict_type_list.append(dict_data.dict_type) + await query_db.commit() + for dict_type in list(set(delete_dict_type_list)): + dict_data_list = await cls.query_dict_data_list_services(query_db, dict_type) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SYS_DICT.key}:{dict_type}', + json.dumps(CamelCaseUtil.transform_result(dict_data_list), ensure_ascii=False, default=str), + ) + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入字典数据id为空') + + @classmethod + async def dict_data_detail_services(cls, query_db: AsyncSession, dict_code: int) -> DictDataModel: + """ + 获取字典数据详细信息service + + :param query_db: orm对象 + :param dict_code: 字典数据id + :return: 字典数据id对应的信息 + """ + dict_data = await DictDataDao.get_dict_data_detail_by_id(query_db, dict_code=dict_code) + result = DictDataModel(**CamelCaseUtil.transform_result(dict_data)) if dict_data else DictDataModel() + + return result + + @staticmethod + async def export_dict_data_list_services(dict_data_list: list) -> bytes: + """ + 导出字典数据信息service + + :param dict_data_list: 字典数据信息列表 + :return: 字典数据信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'dictCode': '字典编码', + 'dictSort': '字典标签', + 'dictLabel': '字典键值', + 'dictValue': '字典排序', + 'dictType': '字典类型', + 'cssClass': '样式属性', + 'listClass': '表格回显样式', + 'isDefault': '是否默认', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in dict_data_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '停用' + if item.get('isDefault') == 'Y': + item['isDefault'] = '是' + else: + item['isDefault'] = '否' + binary_data = ExcelUtil.export_list2excel(dict_data_list, mapping_dict) + + return binary_data diff --git a/shierfeng-fastapi-backend/module_admin/service/job_log_service.py b/shierfeng-fastapi-backend/module_admin/service/job_log_service.py new file mode 100644 index 0000000..92b7441 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/job_log_service.py @@ -0,0 +1,144 @@ +from typing import Any + +from fastapi import Request +from sqlalchemy.ext.asyncio import AsyncSession +from sqlalchemy.orm import Session + +from common.vo import CrudResponseModel, PageModel +from module_admin.dao.job_log_dao import JobLogDao +from module_admin.entity.vo.job_vo import DeleteJobLogModel, JobLogModel, JobLogPageQueryModel +from module_admin.service.dict_service import DictDataService +from utils.excel_util import ExcelUtil + + +class JobLogService: + """ + 定时任务日志管理模块服务层 + """ + + @classmethod + async def get_job_log_list_services( + cls, query_db: AsyncSession, query_object: JobLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取定时任务日志列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 定时任务日志列表信息对象 + """ + job_log_list_result = await JobLogDao.get_job_log_list(query_db, query_object, is_page) + + return job_log_list_result + + @classmethod + def add_job_log_services(cls, query_db: Session, page_object: JobLogModel) -> CrudResponseModel: + """ + 新增定时任务日志信息service + + :param query_db: orm对象 + :param page_object: 新增定时任务日志对象 + :return: 新增定时任务日志校验结果 + """ + try: + JobLogDao.add_job_log_dao(query_db, page_object) + query_db.commit() + result = {'is_success': True, 'message': '新增成功'} + except Exception as e: + query_db.rollback() + result = {'is_success': False, 'message': str(e)} + + return CrudResponseModel(**result) + + @classmethod + async def delete_job_log_services(cls, query_db: AsyncSession, page_object: DeleteJobLogModel) -> CrudResponseModel: + """ + 删除定时任务日志信息service + + :param query_db: orm对象 + :param page_object: 删除定时任务日志对象 + :return: 删除定时任务日志校验结果 + """ + if page_object.job_log_ids: + job_log_id_list = page_object.job_log_ids.split(',') + try: + for job_log_id in job_log_id_list: + await JobLogDao.delete_job_log_dao(query_db, JobLogModel(jobLogId=job_log_id)) + await query_db.commit() + result = {'is_success': True, 'message': '删除成功'} + except Exception as e: + await query_db.rollback() + raise e + else: + result = {'is_success': False, 'message': '传入定时任务日志id为空'} + return CrudResponseModel(**result) + + @classmethod + async def clear_job_log_services(cls, query_db: AsyncSession) -> CrudResponseModel: + """ + 清除定时任务日志信息service + + :param query_db: orm对象 + :return: 清除定时任务日志校验结果 + """ + try: + await JobLogDao.clear_job_log_dao(query_db) + await query_db.commit() + result = {'is_success': True, 'message': '清除成功'} + except Exception as e: + await query_db.rollback() + raise e + + return CrudResponseModel(**result) + + @staticmethod + async def export_job_log_list_services(request: Request, job_log_list: list) -> bytes: + """ + 导出定时任务日志信息service + + :param request: Request对象 + :param job_log_list: 定时任务日志信息列表 + :return: 定时任务日志信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'jobLogId': '任务日志编码', + 'jobName': '任务名称', + 'jobGroup': '任务组名', + 'jobExecutor': '任务执行器', + 'invokeTarget': '调用目标字符串', + 'jobArgs': '位置参数', + 'jobKwargs': '关键字参数', + 'jobTrigger': '任务触发器', + 'jobMessage': '日志信息', + 'status': '执行状态', + 'exceptionInfo': '异常信息', + 'createTime': '创建时间', + } + + job_group_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type='sys_job_group' + ) + job_group_option = [{'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in job_group_list] + job_group_option_dict = {item.get('value'): item for item in job_group_option} + job_executor_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type='sys_job_executor' + ) + job_executor_option = [ + {'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in job_executor_list + ] + job_executor_option_dict = {item.get('value'): item for item in job_executor_option} + + for item in job_log_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '暂停' + if str(item.get('jobGroup')) in job_group_option_dict: + item['jobGroup'] = job_group_option_dict.get(str(item.get('jobGroup'))).get('label') + if str(item.get('jobExecutor')) in job_executor_option_dict: + item['jobExecutor'] = job_executor_option_dict.get(str(item.get('jobExecutor'))).get('label') + binary_data = ExcelUtil.export_list2excel(job_log_list, mapping_dict) + + return binary_data diff --git a/shierfeng-fastapi-backend/module_admin/service/job_service.py b/shierfeng-fastapi-backend/module_admin/service/job_service.py new file mode 100644 index 0000000..5e73135 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/job_service.py @@ -0,0 +1,273 @@ +from typing import Any + +from fastapi import Request +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant, JobConstant +from common.vo import CrudResponseModel, PageModel +from config.get_scheduler import SchedulerUtil +from exceptions.exception import ServiceException +from module_admin.dao.job_dao import JobDao +from module_admin.entity.vo.job_vo import DeleteJobModel, EditJobModel, JobModel, JobPageQueryModel +from module_admin.service.dict_service import DictDataService +from utils.common_util import CamelCaseUtil +from utils.cron_util import CronUtil +from utils.excel_util import ExcelUtil +from utils.string_util import StringUtil + + +class JobService: + """ + 定时任务管理模块服务层 + """ + + @classmethod + async def get_job_list_services( + cls, query_db: AsyncSession, query_object: JobPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取定时任务列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 定时任务列表信息对象 + """ + job_list_result = await JobDao.get_job_list(query_db, query_object, is_page) + + return job_list_result + + @classmethod + async def check_job_unique_services(cls, query_db: AsyncSession, page_object: JobModel) -> bool: + """ + 校验定时任务是否存在service + + :param query_db: orm对象 + :param page_object: 定时任务对象 + :return: 校验结果 + """ + job_id = -1 if page_object.job_id is None else page_object.job_id + job = await JobDao.get_job_detail_by_info(query_db, page_object) + if job and job.job_id != job_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_job_services(cls, query_db: AsyncSession, page_object: JobModel) -> CrudResponseModel: + """ + 新增定时任务信息service + + :param query_db: orm对象 + :param page_object: 新增定时任务对象 + :return: 新增定时任务校验结果 + """ + if not CronUtil.validate_cron_expression(page_object.cron_expression): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,Cron表达式不正确') + if StringUtil.contains_ignore_case(page_object.invoke_target, CommonConstant.LOOKUP_RMI): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,目标字符串不允许rmi调用') + if StringUtil.contains_any_ignore_case( + page_object.invoke_target, [CommonConstant.LOOKUP_LDAP, CommonConstant.LOOKUP_LDAPS] + ): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,目标字符串不允许ldap(s)调用') + if StringUtil.contains_any_ignore_case(page_object.invoke_target, [CommonConstant.HTTP, CommonConstant.HTTPS]): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,目标字符串不允许http(s)调用') + if StringUtil.startswith_any_case(page_object.invoke_target, JobConstant.JOB_ERROR_LIST): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,目标字符串存在违规') + if not StringUtil.startswith_any_case(page_object.invoke_target, JobConstant.JOB_WHITE_LIST): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,目标字符串不在白名单内') + if not await cls.check_job_unique_services(query_db, page_object): + raise ServiceException(message=f'新增定时任务{page_object.job_name}失败,定时任务已存在') + try: + add_job = await JobDao.add_job_dao(query_db, page_object) + job_info = await cls.job_detail_services(query_db, add_job.job_id) + if job_info.status == '0': + SchedulerUtil.add_scheduler_job(job_info=job_info) + await query_db.commit() + await SchedulerUtil.request_scheduler_sync() + result = {'is_success': True, 'message': '新增成功'} + except Exception as e: + await query_db.rollback() + raise e + + return CrudResponseModel(**result) + + @classmethod + def _deal_edit_job(cls, page_object: EditJobModel, edit_job: dict[str, Any]) -> None: + """ + 处理编辑定时任务字典 + + :param page_object: 编辑定时任务对象 + :param edit_job: 编辑定时任务字典 + """ + if page_object.type == 'status': + del edit_job['type'] + + @classmethod + async def edit_job_services(cls, query_db: AsyncSession, page_object: EditJobModel) -> CrudResponseModel: + """ + 编辑定时任务信息service + + :param query_db: orm对象 + :param page_object: 编辑定时任务对象 + :return: 编辑定时任务校验结果 + """ + edit_job = page_object.model_dump(exclude_unset=True) + cls._deal_edit_job(page_object, edit_job) + job_info = await cls.job_detail_services(query_db, page_object.job_id) + if job_info: + if page_object.type != 'status': + if not CronUtil.validate_cron_expression(page_object.cron_expression): + raise ServiceException(message=f'修改定时任务{page_object.job_name}失败,Cron表达式不正确') + if StringUtil.contains_ignore_case(page_object.invoke_target, CommonConstant.LOOKUP_RMI): + raise ServiceException(message=f'修改定时任务{page_object.job_name}失败,目标字符串不允许rmi调用') + if StringUtil.contains_any_ignore_case( + page_object.invoke_target, [CommonConstant.LOOKUP_LDAP, CommonConstant.LOOKUP_LDAPS] + ): + raise ServiceException( + message=f'修改定时任务{page_object.job_name}失败,目标字符串不允许ldap(s)调用' + ) + if StringUtil.contains_any_ignore_case( + page_object.invoke_target, [CommonConstant.HTTP, CommonConstant.HTTPS] + ): + raise ServiceException( + message=f'修改定时任务{page_object.job_name}失败,目标字符串不允许http(s)调用' + ) + if StringUtil.startswith_any_case(page_object.invoke_target, JobConstant.JOB_ERROR_LIST): + raise ServiceException(message=f'修改定时任务{page_object.job_name}失败,目标字符串存在违规') + if not StringUtil.startswith_any_case(page_object.invoke_target, JobConstant.JOB_WHITE_LIST): + raise ServiceException(message=f'修改定时任务{page_object.job_name}失败,目标字符串不在白名单内') + if not await cls.check_job_unique_services(query_db, page_object): + raise ServiceException(message=f'修改定时任务{page_object.job_name}失败,定时任务已存在') + try: + await JobDao.edit_job_dao(query_db, edit_job, job_info) + SchedulerUtil.remove_scheduler_job(job_id=edit_job.get('job_id')) + if edit_job.get('status') == '0': + job_info = await cls.job_detail_services(query_db, edit_job.get('job_id')) + SchedulerUtil.add_scheduler_job(job_info=job_info) + await query_db.commit() + await SchedulerUtil.request_scheduler_sync() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='定时任务不存在') + + @classmethod + async def execute_job_once_services(cls, query_db: AsyncSession, page_object: JobModel) -> CrudResponseModel: + """ + 执行一次定时任务service + + :param query_db: orm对象 + :param page_object: 定时任务对象 + :return: 执行一次定时任务结果 + """ + SchedulerUtil.remove_scheduler_job(job_id=page_object.job_id) + job_info = await cls.job_detail_services(query_db, page_object.job_id) + if job_info: + SchedulerUtil.execute_scheduler_job_once(job_info=job_info) + return CrudResponseModel(is_success=True, message='执行成功') + raise ServiceException(message='定时任务不存在') + + @classmethod + async def delete_job_services(cls, query_db: AsyncSession, page_object: DeleteJobModel) -> CrudResponseModel: + """ + 删除定时任务信息service + + :param query_db: orm对象 + :param page_object: 删除定时任务对象 + :return: 删除定时任务校验结果 + """ + if page_object.job_ids: + job_id_list = page_object.job_ids.split(',') + try: + for job_id in job_id_list: + await JobDao.delete_job_dao(query_db, JobModel(jobId=job_id)) + SchedulerUtil.remove_scheduler_job(job_id=job_id) + await query_db.commit() + await SchedulerUtil.request_scheduler_sync() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入定时任务id为空') + + @classmethod + async def job_detail_services(cls, query_db: AsyncSession, job_id: int) -> JobModel: + """ + 获取定时任务详细信息service + + :param query_db: orm对象 + :param job_id: 定时任务id + :return: 定时任务id对应的信息 + """ + job = await JobDao.get_job_detail_by_id(query_db, job_id=job_id) + result = JobModel(**CamelCaseUtil.transform_result(job)) if job else JobModel() + + return result + + @staticmethod + async def export_job_list_services(request: Request, job_list: list) -> bytes: + """ + 导出定时任务信息service + + :param request: Request对象 + :param job_list: 定时任务信息列表 + :return: 定时任务信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'jobId': '任务编码', + 'jobName': '任务名称', + 'jobGroup': '任务组名', + 'jobExecutor': '任务执行器', + 'invokeTarget': '调用目标字符串', + 'jobArgs': '位置参数', + 'jobKwargs': '关键字参数', + 'cronExpression': 'cron执行表达式', + 'misfirePolicy': '计划执行错误策略', + 'concurrent': '是否并发执行', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + job_group_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type='sys_job_group' + ) + job_group_option = [{'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in job_group_list] + job_group_option_dict = {item.get('value'): item for item in job_group_option} + job_executor_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type='sys_job_executor' + ) + job_executor_option = [ + {'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in job_executor_list + ] + job_executor_option_dict = {item.get('value'): item for item in job_executor_option} + + for item in job_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '暂停' + if str(item.get('jobGroup')) in job_group_option_dict: + item['jobGroup'] = job_group_option_dict.get(str(item.get('jobGroup'))).get('label') + if str(item.get('jobExecutor')) in job_executor_option_dict: + item['jobExecutor'] = job_executor_option_dict.get(str(item.get('jobExecutor'))).get('label') + if item.get('misfirePolicy') == '1': + item['misfirePolicy'] = '立即执行' + elif item.get('misfirePolicy') == '2': + item['misfirePolicy'] = '执行一次' + else: + item['misfirePolicy'] = '放弃执行' + if item.get('concurrent') == '0': + item['concurrent'] = '允许' + else: + item['concurrent'] = '禁止' + binary_data = ExcelUtil.export_list2excel(job_list, mapping_dict) + + return binary_data diff --git a/shierfeng-fastapi-backend/module_admin/service/log_service.py b/shierfeng-fastapi-backend/module_admin/service/log_service.py new file mode 100644 index 0000000..3560f39 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/log_service.py @@ -0,0 +1,508 @@ +import asyncio +import hashlib +import json +import os +import uuid +from typing import Any + +from fastapi import Request +from redis import asyncio as aioredis +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import CrudResponseModel, PageModel +from config.database import AsyncSessionLocal +from config.env import LogConfig +from exceptions.exception import ServiceException +from middlewares.trace_middleware.ctx import TraceCtx +from module_admin.dao.log_dao import LoginLogDao, OperationLogDao +from module_admin.entity.vo.log_vo import ( + DeleteLoginLogModel, + DeleteOperLogModel, + LogininforModel, + LoginLogPageQueryModel, + OperLogModel, + OperLogPageQueryModel, + UnlockUser, +) +from module_admin.service.dict_service import DictDataService +from utils.excel_util import ExcelUtil +from utils.log_util import LogSanitizer, logger + + +class OperationLogService: + """ + 操作日志管理模块服务层 + """ + + @classmethod + async def get_operation_log_list_services( + cls, query_db: AsyncSession, query_object: OperLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取操作日志列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 操作日志列表信息对象 + """ + operation_log_list_result = await OperationLogDao.get_operation_log_list(query_db, query_object, is_page) + + return operation_log_list_result + + @classmethod + async def add_operation_log_services(cls, query_db: AsyncSession, page_object: OperLogModel) -> CrudResponseModel: + """ + 新增操作日志service + + :param query_db: orm对象 + :param page_object: 新增操作日志对象 + :return: 新增操作日志校验结果 + """ + try: + await OperationLogDao.add_operation_log_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def delete_operation_log_services( + cls, query_db: AsyncSession, page_object: DeleteOperLogModel + ) -> CrudResponseModel: + """ + 删除操作日志信息service + + :param query_db: orm对象 + :param page_object: 删除操作日志对象 + :return: 删除操作日志校验结果 + """ + if page_object.oper_ids: + oper_id_list = page_object.oper_ids.split(',') + try: + for oper_id in oper_id_list: + await OperationLogDao.delete_operation_log_dao(query_db, OperLogModel(operId=oper_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入操作日志id为空') + + @classmethod + async def clear_operation_log_services(cls, query_db: AsyncSession) -> CrudResponseModel: + """ + 清除操作日志信息service + + :param query_db: orm对象 + :return: 清除操作日志校验结果 + """ + try: + await OperationLogDao.clear_operation_log_dao(query_db) + await query_db.commit() + return CrudResponseModel(is_success=True, message='清除成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def export_operation_log_list_services(cls, request: Request, operation_log_list: list) -> bytes: + """ + 导出操作日志信息service + + :param request: Request对象 + :param operation_log_list: 操作日志信息列表 + :return: 操作日志信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'operId': '日志编号', + 'title': '系统模块', + 'businessType': '操作类型', + 'method': '方法名称', + 'requestMethod': '请求方式', + 'operName': '操作人员', + 'deptName': '部门名称', + 'operUrl': '请求URL', + 'operIp': '操作地址', + 'operLocation': '操作地点', + 'operParam': '请求参数', + 'jsonResult': '返回参数', + 'status': '操作状态', + 'error_msg': '错误消息', + 'operTime': '操作日期', + 'costTime': '消耗时间(毫秒)', + } + + operation_type_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type='sys_oper_type' + ) + operation_type_option = [ + {'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in operation_type_list + ] + operation_type_option_dict = {item.get('value'): item for item in operation_type_option} + + for item in operation_log_list: + if item.get('status') == 0: + item['status'] = '成功' + else: + item['status'] = '失败' + if str(item.get('businessType')) in operation_type_option_dict: + item['businessType'] = operation_type_option_dict.get(str(item.get('businessType'))).get('label') + binary_data = ExcelUtil.export_list2excel(operation_log_list, mapping_dict) + + return binary_data + + +class LoginLogService: + """ + 登录日志管理模块服务层 + """ + + @classmethod + async def get_login_log_list_services( + cls, query_db: AsyncSession, query_object: LoginLogPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取登录日志列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 登录日志列表信息对象 + """ + operation_log_list_result = await LoginLogDao.get_login_log_list(query_db, query_object, is_page) + + return operation_log_list_result + + @classmethod + async def add_login_log_services(cls, query_db: AsyncSession, page_object: LogininforModel) -> CrudResponseModel: + """ + 新增登录日志service + + :param query_db: orm对象 + :param page_object: 新增登录日志对象 + :return: 新增登录日志校验结果 + """ + try: + await LoginLogDao.add_login_log_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def delete_login_log_services( + cls, query_db: AsyncSession, page_object: DeleteLoginLogModel + ) -> CrudResponseModel: + """ + 删除操作日志信息service + + :param query_db: orm对象 + :param page_object: 删除操作日志对象 + :return: 删除操作日志校验结果 + """ + if page_object.info_ids: + info_id_list = page_object.info_ids.split(',') + try: + for info_id in info_id_list: + await LoginLogDao.delete_login_log_dao(query_db, LogininforModel(infoId=info_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入登录日志id为空') + + @classmethod + async def clear_login_log_services(cls, query_db: AsyncSession) -> CrudResponseModel: + """ + 清除操作日志信息service + + :param query_db: orm对象 + :return: 清除操作日志校验结果 + """ + try: + await LoginLogDao.clear_login_log_dao(query_db) + await query_db.commit() + return CrudResponseModel(is_success=True, message='清除成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def unlock_user_services(cls, request: Request, unlock_user: UnlockUser) -> CrudResponseModel: + locked_user = await request.app.state.redis.get(f'account_lock:{unlock_user.user_name}') + if locked_user: + await request.app.state.redis.delete(f'account_lock:{unlock_user.user_name}') + return CrudResponseModel(is_success=True, message='解锁成功') + raise ServiceException(message='该用户未锁定') + + @staticmethod + async def export_login_log_list_services(login_log_list: list) -> bytes: + """ + 导出登录日志信息service + + :param login_log_list: 登录日志信息列表 + :return: 登录日志信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'infoId': '访问编号', + 'userName': '用户名称', + 'ipaddr': '登录地址', + 'loginLocation': '登录地点', + 'browser': '浏览器', + 'os': '操作系统', + 'status': '登录状态', + 'msg': '操作信息', + 'loginTime': '登录日期', + } + + for item in login_log_list: + if item.get('status') == '0': + item['status'] = '成功' + else: + item['status'] = '失败' + binary_data = ExcelUtil.export_list2excel(login_log_list, mapping_dict) + + return binary_data + + +class LogQueueService: + """ + 日志队列服务 + """ + + @classmethod + def _build_event_id(cls, request_id: str, log_type: str, source: str) -> str: + """ + 生成日志事件唯一标识 + + :param request_id: 请求唯一标识 + :param log_type: 日志类型 + :param source: 日志来源 + :return: 事件唯一标识 + """ + if not request_id: + return uuid.uuid4().hex + base = f'{request_id}:{log_type}:{source}' + return hashlib.md5(base.encode('utf-8')).hexdigest() + + @classmethod + async def _xadd_event(cls, redis: aioredis.Redis, event_type: str, payload: dict, source: str) -> None: + """ + 写入日志事件到Redis Streams + + :param redis: Redis连接对象 + :param event_type: 事件类型 + :param payload: 事件负载 + :param source: 日志来源 + :return: None + """ + request_id = TraceCtx.get_request_id() + trace_id = TraceCtx.get_trace_id() + span_id = TraceCtx.get_span_id() + event_id = cls._build_event_id(request_id, event_type, source) + await redis.xadd( + LogConfig.log_stream_key, + { + 'event_id': event_id, + 'event_type': event_type, + 'request_id': request_id, + 'trace_id': trace_id, + 'span_id': span_id, + 'payload': json.dumps(payload, ensure_ascii=False, default=str), + }, + maxlen=LogConfig.log_stream_maxlen, + approximate=True, + ) + + @classmethod + async def enqueue_login_log(cls, request: Request, login_log: LogininforModel, source: str) -> None: + """ + 登录日志入队 + + :param request: Request对象 + :param login_log: 登录日志模型 + :param source: 日志来源 + :return: None + """ + payload = LogSanitizer.sanitize_data(login_log.model_dump(by_alias=True, exclude_none=True)) + await cls._xadd_event(request.app.state.redis, 'login', payload, source) + + @classmethod + async def enqueue_operation_log(cls, request: Request, operation_log: OperLogModel, source: str) -> None: + """ + 操作日志入队 + + :param request: Request对象 + :param operation_log: 操作日志模型 + :param source: 日志来源 + :return: None + """ + payload = LogSanitizer.sanitize_data(operation_log.model_dump(by_alias=True, exclude_none=True)) + await cls._xadd_event(request.app.state.redis, 'operation', payload, source) + + +class LogAggregatorService: + """ + 日志聚合消费服务 + """ + + @classmethod + async def _ensure_group(cls, redis: aioredis.Redis) -> None: + """ + 初始化消费组 + + :param redis: Redis连接对象 + :return: None + """ + try: + await redis.xgroup_create( + name=LogConfig.log_stream_key, + groupname=LogConfig.log_stream_group, + id='0-0', + mkstream=True, + ) + except Exception as exc: + if 'BUSYGROUP' not in str(exc): + raise + + @classmethod + async def _acquire_dedup(cls, redis: aioredis.Redis, event_id: str) -> bool: + """ + 获取去重锁 + + :param redis: Redis连接对象 + :param event_id: 事件唯一标识 + :return: 是否获取成功 + """ + if not event_id: + return False + key = f'{LogConfig.log_stream_dedup_prefix}:{event_id}' + return await redis.set(key, '1', nx=True, ex=LogConfig.log_stream_dedup_ttl) + + @classmethod + async def _release_dedup(cls, redis: aioredis.Redis, event_id: str) -> None: + """ + 释放去重锁 + + :param redis: Redis连接对象 + :param event_id: 事件唯一标识 + :return: None + """ + if not event_id: + return + await redis.delete(f'{LogConfig.log_stream_dedup_prefix}:{event_id}') + + @classmethod + async def _claim_pending(cls, redis: aioredis.Redis, consumer_name: str) -> None: + """ + 认领并处理超时未确认的消息 + + :param redis: Redis连接对象 + :param consumer_name: 消费者名称 + :return: None + """ + if LogConfig.log_stream_claim_idle_ms <= 0: + return + start_id = '0-0' + while True: + result = await redis.xautoclaim( + name=LogConfig.log_stream_key, + groupname=LogConfig.log_stream_group, + consumername=consumer_name, + min_idle_time=LogConfig.log_stream_claim_idle_ms, + start_id=start_id, + count=LogConfig.log_stream_claim_batch_size, + ) + if not result: + return + next_start_id, messages = result[0], result[1] + if messages: + await cls._process_messages(redis, LogConfig.log_stream_key, messages) + if not messages or next_start_id == start_id: + return + start_id = next_start_id + + @classmethod + async def consume_stream(cls, redis: aioredis.Redis) -> None: + """ + 消费日志队列 + + :param redis: Redis连接对象 + :return: None + """ + await cls._ensure_group(redis) + consumer_name = f'{LogConfig.log_stream_consumer_prefix}-{os.getpid()}-{uuid.uuid4().hex[:6]}' + last_claim_time = 0.0 + while True: + try: + now = asyncio.get_running_loop().time() + if now - last_claim_time >= LogConfig.log_stream_claim_interval_ms / 1000: + await cls._claim_pending(redis, consumer_name) + last_claim_time = now + result = await redis.xreadgroup( + groupname=LogConfig.log_stream_group, + consumername=consumer_name, + streams={LogConfig.log_stream_key: '>'}, + count=LogConfig.log_stream_batch_size, + block=LogConfig.log_stream_block_ms, + ) + if not result: + continue + for stream_name, messages in result: + await cls._process_messages(redis, stream_name, messages) + except asyncio.CancelledError: + raise + except Exception as exc: + logger.error(f'日志聚合消费异常: {exc}') + await asyncio.sleep(1) + + @classmethod + async def _process_messages(cls, redis: aioredis.Redis, stream_name: str, messages: list[tuple[str, dict]]) -> None: + """ + 处理消息并落库 + + :param redis: Redis连接对象 + :param stream_name: Stream名称 + :param messages: 消息列表 + :return: None + """ + if not messages: + return + async with AsyncSessionLocal() as session: + ack_ids: list[str] = [] + dedup_event_ids: list[str] = [] + try: + for message_id, data in messages: + event_type = data.get('event_type') + event_id = data.get('event_id') + payload_raw = data.get('payload') or '{}' + if event_type not in {'login', 'operation'}: + ack_ids.append(message_id) + continue + acquired = await cls._acquire_dedup(redis, event_id) + if not acquired: + ack_ids.append(message_id) + continue + dedup_event_ids.append(event_id) + payload = json.loads(payload_raw) + if event_type == 'login': + await LoginLogDao.add_login_log_dao(session, LogininforModel(**payload)) + elif event_type == 'operation': + await OperationLogDao.add_operation_log_dao(session, OperLogModel(**payload)) + ack_ids.append(message_id) + if ack_ids: + await session.commit() + await redis.xack(stream_name, LogConfig.log_stream_group, *ack_ids) + except Exception: + await session.rollback() + for event_id in dedup_event_ids: + await cls._release_dedup(redis, event_id) + raise diff --git a/shierfeng-fastapi-backend/module_admin/service/login_service.py b/shierfeng-fastapi-backend/module_admin/service/login_service.py new file mode 100644 index 0000000..a136d90 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/login_service.py @@ -0,0 +1,656 @@ +import random +import uuid +from datetime import datetime, timedelta, timezone +from typing import Any + +import jwt +from fastapi import Depends, Form, Request +from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm +from jwt.exceptions import InvalidTokenError +from sqlalchemy import Row +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant, MenuConstant +from common.context import RequestContext +from common.enums import RedisInitKeyConfig +from common.vo import CrudResponseModel +from config.env import AppConfig, JwtConfig +from config.get_db import get_db +from exceptions.exception import AuthException, LoginException, ServiceException +from module_admin.dao.login_dao import login_by_account +from module_admin.dao.user_dao import UserDao +from module_admin.entity.do.dept_do import SysDept +from module_admin.entity.do.menu_do import SysMenu +from module_admin.entity.do.user_do import SysUser +from module_admin.entity.vo.login_vo import MenuTreeModel, MetaModel, RouterModel, SmsCode, UserLogin, UserRegister +from module_admin.entity.vo.user_vo import AddUserModel, CurrentUserModel, ResetUserModel, TokenData, UserInfoModel +from module_admin.service.user_service import UserService +from utils.client_ip_util import ClientIPUtil +from utils.common_util import CamelCaseUtil +from utils.log_util import logger +from utils.message_util import message_service +from utils.pwd_util import PwdUtil + +oauth2_scheme = OAuth2PasswordBearer(tokenUrl='login') + + +class CustomOAuth2PasswordRequestForm(OAuth2PasswordRequestForm): + """ + 自定义OAuth2PasswordRequestForm类,增加验证码及会话编号参数 + """ + + def __init__( + self, + grant_type: str = Form(default=None, pattern='password'), + username: str = Form(), + password: str = Form(), + scope: str = Form(default=''), + client_id: str | None = Form(default=None), + client_secret: str | None = Form(default=None), + code: str | None = Form(default=''), + uuid: str | None = Form(default=''), + login_info: dict[str, str] | None = Form(default=None), + ) -> None: + super().__init__( + grant_type=grant_type, + username=username, + password=password, + scope=scope, + client_id=client_id, + client_secret=client_secret, + ) + self.code = code + self.uuid = uuid + self.login_info = login_info + + +class LoginService: + """ + 登录模块服务层 + """ + + @classmethod + async def authenticate_user( + cls, request: Request, query_db: AsyncSession, login_user: UserLogin + ) -> Row[tuple[SysUser, SysDept]]: + """ + 根据用户名密码校验用户登录 + + :param request: Request对象 + :param query_db: orm对象 + :param login_user: 登录用户对象 + :return: 校验结果 + """ + await cls.__check_login_ip(request) + account_lock = await request.app.state.redis.get( + f'{RedisInitKeyConfig.ACCOUNT_LOCK.key}:{login_user.user_name}' + ) + if login_user.user_name == account_lock: + logger.warning('账号已锁定,请稍后再试') + raise LoginException(data='', message='账号已锁定,请稍后再试') + # 判断请求是否来自于api文档,如果是返回指定格式的结果,用于修复api文档认证成功后token显示undefined的bug + request_from_swagger = ( + request.headers.get('referer').endswith('docs') if request.headers.get('referer') else False + ) + request_from_redoc = ( + request.headers.get('referer').endswith('redoc') if request.headers.get('referer') else False + ) + # 判断是否开启验证码,开启则验证,否则不验证(dev模式下来自API文档的登录请求不检验) + if not login_user.captcha_enabled or ( + (request_from_swagger or request_from_redoc) and AppConfig.app_env == 'dev' + ): + pass + else: + await cls.__check_login_captcha(request, login_user) + user = await login_by_account(query_db, login_user.user_name) + if not user: + logger.warning('用户不存在') + raise LoginException(data='', message='用户不存在') + if not PwdUtil.verify_password(login_user.password, user[0].password): + cache_password_error_count = await request.app.state.redis.get( + f'{RedisInitKeyConfig.PASSWORD_ERROR_COUNT.key}:{login_user.user_name}' + ) + password_error_counted = 0 + if cache_password_error_count: + password_error_counted = cache_password_error_count + password_error_count = int(password_error_counted) + 1 + await request.app.state.redis.set( + f'{RedisInitKeyConfig.PASSWORD_ERROR_COUNT.key}:{login_user.user_name}', + password_error_count, + ex=timedelta(minutes=10), + ) + if password_error_count > CommonConstant.PASSWORD_ERROR_COUNT: + await request.app.state.redis.delete( + f'{RedisInitKeyConfig.PASSWORD_ERROR_COUNT.key}:{login_user.user_name}' + ) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.ACCOUNT_LOCK.key}:{login_user.user_name}', + login_user.user_name, + ex=timedelta(minutes=10), + ) + logger.warning('10分钟内密码已输错超过5次,账号已锁定,请10分钟后再试') + raise LoginException(data='', message='10分钟内密码已输错超过5次,账号已锁定,请10分钟后再试') + logger.warning('密码错误') + raise LoginException(data='', message='密码错误') + if user[0].status == '1': + logger.warning('用户已停用') + raise LoginException(data='', message='用户已停用') + await request.app.state.redis.delete(f'{RedisInitKeyConfig.PASSWORD_ERROR_COUNT.key}:{login_user.user_name}') + return user + + @classmethod + async def __check_login_ip(cls, request: Request) -> bool: + """ + 校验用户登录ip是否在黑名单内 + + :param request: Request对象 + :return: 校验结果 + """ + black_ip_value = await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.login.blackIPList') + black_ip_list = black_ip_value.split(',') if black_ip_value else [] + if ClientIPUtil.get_client_ip(request) in black_ip_list: + logger.warning('当前IP禁止登录') + raise LoginException(data='', message='当前IP禁止登录') + return True + + @classmethod + async def __check_login_captcha(cls, request: Request, login_user: UserLogin) -> bool: + """ + 校验用户登录验证码 + + :param request: Request对象 + :param login_user: 登录用户对象 + :return: 校验结果 + """ + captcha_value = await request.app.state.redis.get(f'{RedisInitKeyConfig.CAPTCHA_CODES.key}:{login_user.uuid}') + if not captcha_value: + logger.warning('验证码已失效') + raise LoginException(data='', message='验证码已失效') + if login_user.code != str(captcha_value): + logger.warning('验证码错误') + raise LoginException(data='', message='验证码错误') + return True + + @classmethod + async def create_access_token(cls, data: dict, expires_delta: timedelta | None = None) -> str: + """ + 根据登录信息创建当前用户token + + :param data: 登录信息 + :param expires_delta: token有效期 + :return: token + """ + to_encode = data.copy() + if expires_delta: + expire = datetime.now(timezone.utc) + expires_delta + else: + expire = datetime.now(timezone.utc) + timedelta(minutes=30) + to_encode.update({'exp': expire}) + encoded_jwt = jwt.encode(to_encode, JwtConfig.jwt_secret_key, algorithm=JwtConfig.jwt_algorithm) + return encoded_jwt + + @classmethod + async def get_current_user( + cls, request: Request = Request, token: str = Depends(oauth2_scheme), query_db: AsyncSession = Depends(get_db) + ) -> CurrentUserModel: + """ + 根据token获取当前用户信息 + + :param request: Request对象 + :param token: 用户token + :param query_db: orm对象 + :return: 当前用户信息对象 + :raise: 令牌异常AuthException + """ + # if token[:6] != 'Bearer': + # logger.warning("用户token不合法") + # raise AuthException(data="", message="用户token不合法") + try: + if token.startswith('Bearer'): + token = token.split(' ')[1] + payload = jwt.decode(token, JwtConfig.jwt_secret_key, algorithms=[JwtConfig.jwt_algorithm]) + user_id: str = payload.get('user_id') + session_id: str = payload.get('session_id') + if not user_id: + logger.warning('用户token不合法') + raise AuthException(data='', message='用户token不合法') + token_data = TokenData(user_id=int(user_id)) + except InvalidTokenError as e: + logger.warning('用户token已失效,请重新登录') + raise AuthException(data='', message='用户token已失效,请重新登录') from e + query_user = await UserDao.get_user_by_id(query_db, user_id=token_data.user_id) + if query_user.get('user_basic_info') is None: + logger.warning('用户token不合法') + raise AuthException(data='', message='用户token不合法') + if AppConfig.app_same_time_login: + redis_token = await request.app.state.redis.get(f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}') + else: + # 此方法可实现同一账号同一时间只能登录一次 + redis_token = await request.app.state.redis.get( + f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{query_user.get("user_basic_info").user_id}' + ) + if token == redis_token: + if AppConfig.app_same_time_login: + await request.app.state.redis.set( + f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}', + redis_token, + ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes), + ) + else: + await request.app.state.redis.set( + f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{query_user.get("user_basic_info").user_id}', + redis_token, + ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes), + ) + + role_id_list = [item.role_id for item in query_user.get('user_role_info')] + if 1 in role_id_list: # noqa: SIM108 + permissions = ['*:*:*'] + else: + permissions = [row.perms for row in query_user.get('user_menu_info')] + post_ids = ','.join([str(row.post_id) for row in query_user.get('user_post_info')]) + role_ids = ','.join([str(row.role_id) for row in query_user.get('user_role_info')]) + roles = [row.role_key for row in query_user.get('user_role_info')] + is_default_modify_pwd = await cls.__init_password_is_modify( + request, query_user.get('user_basic_info').pwd_update_date + ) + is_password_expired = await cls.__password_is_expired( + request, query_user.get('user_basic_info').pwd_update_date + ) + + current_user = CurrentUserModel( + permissions=permissions, + roles=roles, + user=UserInfoModel( + **CamelCaseUtil.transform_result(query_user.get('user_basic_info')), + postIds=post_ids, + roleIds=role_ids, + dept=CamelCaseUtil.transform_result(query_user.get('user_dept_info')), + role=CamelCaseUtil.transform_result(query_user.get('user_role_info')), + ), + isDefaultModifyPwd=is_default_modify_pwd, + isPasswordExpired=is_password_expired, + ) + # 设置当前用户信息到上下文 + RequestContext.set_current_user(current_user) + return current_user + logger.warning('用户token已失效,请重新登录') + raise AuthException(data='', message='用户token已失效,请重新登录') + + @classmethod + async def __init_password_is_modify(cls, request: Request, pwd_update_date: datetime) -> bool: + """ + 判断当前用户是否初始密码登录 + + :param request: Request对象 + :param pwd_update_date: 密码最后更新时间 + :return: 是否初始密码登录 + """ + init_password_is_modify = await request.app.state.redis.get( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.initPasswordModify' + ) + return init_password_is_modify == '1' and pwd_update_date is None + + @classmethod + async def __password_is_expired(cls, request: Request, pwd_update_date: datetime) -> bool: + """ + 判断当前用户密码是否过期 + + :param request: Request对象 + :param pwd_update_date: 密码最后更新时间 + :return: 密码是否过期 + """ + password_validate_days = await request.app.state.redis.get( + f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.passwordValidateDays' + ) + if password_validate_days and int(password_validate_days) > 0: + if pwd_update_date is None: + return True + expire_date = pwd_update_date + timedelta(days=int(password_validate_days)) + if datetime.now() > expire_date: + return True + return False + + @classmethod + async def get_current_user_routers(cls, user_id: int, query_db: AsyncSession) -> list[dict[str, Any]]: + """ + 根据用户id获取当前用户路由信息 + + :param user_id: 用户id + :param query_db: orm对象 + :return: 当前用户路由信息对象 + """ + query_user = await UserDao.get_user_by_id(query_db, user_id=user_id) + user_router_menu = sorted( + [ + row + for row in query_user.get('user_menu_info') + if row.menu_type in [MenuConstant.TYPE_DIR, MenuConstant.TYPE_MENU] + ], + key=lambda x: x.order_num, + ) + menus = cls.__generate_menus(0, user_router_menu) + user_router = cls.__generate_user_router_menu(menus) + return [router.model_dump(exclude_unset=True, by_alias=True) for router in user_router] + + @classmethod + def __generate_menus(cls, pid: int, permission_list: list[SysMenu]) -> list[MenuTreeModel]: + """ + 工具方法:根据菜单信息生成菜单信息树形嵌套数据 + + :param pid: 菜单id + :param permission_list: 菜单列表信息 + :return: 菜单信息树形嵌套数据 + """ + menu_list: list[MenuTreeModel] = [] + for permission in permission_list: + if permission.parent_id == pid: + children = cls.__generate_menus(permission.menu_id, permission_list) + menu_list_data = MenuTreeModel(**CamelCaseUtil.transform_result(permission)) + if children: + menu_list_data.children = children + menu_list.append(menu_list_data) + + return menu_list + + @classmethod + def __generate_user_router_menu(cls, permission_list: list[MenuTreeModel]) -> list[RouterModel]: + """ + 工具方法:根据菜单树信息生成路由信息树形嵌套数据 + + :param permission_list: 菜单树列表信息 + :return: 路由信息树形嵌套数据 + """ + router_list: list[RouterModel] = [] + for permission in permission_list: + router = RouterModel( + hidden=permission.visible == '1', + name=RouterUtil.get_router_name(permission), + path=RouterUtil.get_router_path(permission), + component=RouterUtil.get_component(permission), + query=permission.query, + meta=MetaModel( + title=permission.menu_name, + icon=permission.icon, + noCache=permission.is_cache == 1, + link=permission.path if RouterUtil.is_http(permission.path) else None, + ), + ) + c_menus = permission.children + if c_menus and permission.menu_type == MenuConstant.TYPE_DIR: + router.always_show = True + router.redirect = 'noRedirect' + router.children = cls.__generate_user_router_menu(c_menus) + elif RouterUtil.is_menu_frame(permission): + router.meta = None + children_list: list[RouterModel] = [] + children = RouterModel( + path=permission.path, + component=permission.component, + name=RouterUtil.get_route_name(permission.route_name, permission.path), + meta=MetaModel( + title=permission.menu_name, + icon=permission.icon, + noCache=permission.is_cache == 1, + link=permission.path if RouterUtil.is_http(permission.path) else None, + ), + query=permission.query, + ) + children_list.append(children) + router.children = children_list + elif permission.parent_id == 0 and RouterUtil.is_inner_link(permission): + router.meta = MetaModel(title=permission.menu_name, icon=permission.icon) + router.path = '/' + children_list: list[RouterModel] = [] + router_path = RouterUtil.inner_link_replace_each(permission.path) + children = RouterModel( + path=router_path, + component=MenuConstant.INNER_LINK, + name=RouterUtil.get_route_name(permission.route_name, permission.path), + meta=MetaModel( + title=permission.menu_name, + icon=permission.icon, + link=permission.path if RouterUtil.is_http(permission.path) else None, + ), + ) + children_list.append(children) + router.children = children_list + + router_list.append(router) + + return router_list + + @classmethod + async def register_user_services( + cls, request: Request, query_db: AsyncSession, user_register: UserRegister + ) -> CrudResponseModel: + """ + 用户注册services + + :param request: Request对象 + :param query_db: orm对象 + :param user_register: 注册用户对象 + :return: 注册结果 + """ + register_enabled = ( + await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.registerUser') == 'true' + ) + captcha_enabled = ( + await request.app.state.redis.get(f'{RedisInitKeyConfig.SYS_CONFIG.key}:sys.account.captchaEnabled') + == 'true' + ) + if user_register.password == user_register.confirm_password: + if register_enabled: + if captcha_enabled: + captcha_value = await request.app.state.redis.get( + f'{RedisInitKeyConfig.CAPTCHA_CODES.key}:{user_register.uuid}' + ) + if not captcha_value: + raise ServiceException(message='验证码已失效') + if user_register.code != str(captcha_value): + raise ServiceException(message='验证码错误') + add_user = AddUserModel( + userName=user_register.username, + nickName=user_register.username, + password=PwdUtil.get_password_hash(user_register.password), + pwdUpdateDate=datetime.now(), + ) + result = await UserService.add_user_services(query_db, add_user) + return result + raise ServiceException(message='注册程序已关闭,禁止注册') + raise ServiceException(message='两次输入的密码不一致') + + @classmethod + async def get_sms_code_services(cls, request: Request, query_db: AsyncSession, user: ResetUserModel) -> SmsCode: + """ + 获取短信验证码service + + :param request: Request对象 + :param query_db: orm对象 + :param user: 用户对象 + :return: 短信验证码对象 + """ + redis_sms_result = await request.app.state.redis.get(f'{RedisInitKeyConfig.SMS_CODE.key}:{user.session_id}') + if redis_sms_result: + return SmsCode(is_success=False, sms_code='', session_id='', message='短信验证码仍在有效期内') + is_user = await UserDao.get_user_by_name(query_db, user.user_name) + if is_user: + sms_code = str(random.randint(100000, 999999)) + session_id = str(uuid.uuid4()) + await request.app.state.redis.set( + f'{RedisInitKeyConfig.SMS_CODE.key}:{session_id}', sms_code, ex=timedelta(minutes=2) + ) + # 此处模拟调用短信服务 + message_service(sms_code) + + return SmsCode(is_success=True, sms_code=sms_code, session_id=session_id, message='获取成功') + + return SmsCode(is_success=False, sms_code='', session_id='', message='用户不存在') + + @classmethod + async def forget_user_services( + cls, request: Request, query_db: AsyncSession, forget_user: ResetUserModel + ) -> CrudResponseModel: + """ + 用户忘记密码services + + :param request: Request对象 + :param query_db: orm对象 + :param forget_user: 重置用户对象 + :return: 重置结果 + """ + redis_sms_result = await request.app.state.redis.get( + f'{RedisInitKeyConfig.SMS_CODE.key}:{forget_user.session_id}' + ) + if forget_user.sms_code == redis_sms_result: + forget_user.password = PwdUtil.get_password_hash(forget_user.password) + forget_user.user_id = (await UserDao.get_user_by_name(query_db, forget_user.user_name)).user_id + edit_result = await UserService.reset_user_services(query_db, forget_user) + result = edit_result.dict() + elif not redis_sms_result: + result = {'is_success': False, 'message': '短信验证码已过期'} + else: + await request.app.state.redis.delete(f'{RedisInitKeyConfig.SMS_CODE.key}:{forget_user.session_id}') + result = {'is_success': False, 'message': '短信验证码不正确'} + + return CrudResponseModel(**result) + + @classmethod + async def logout_services(cls, request: Request, token_id: str) -> bool: + """ + 退出登录services + + :param request: Request对象 + :param token_id: 令牌编号 + :return: 退出登录结果 + """ + await request.app.state.redis.delete(f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{token_id}') + # await request.app.state.redis.delete(f'{current_user.user.user_id}_access_token') + # await request.app.state.redis.delete(f'{current_user.user.user_id}_session_id') + + return True + + +class RouterUtil: + """ + 路由处理工具类 + """ + + @classmethod + def get_router_name(cls, menu: MenuTreeModel) -> str: + """ + 获取路由名称 + + :param menu: 菜单数对象 + :return: 路由名称 + """ + # 非外链并且是一级目录(类型为目录) + if cls.is_menu_frame(menu): + return '' + + return cls.get_route_name(menu.route_name, menu.path) + + @classmethod + def get_route_name(cls, name: str, path: str) -> str: + """ + 获取路由名称,如没有配置路由名称则取路由地址 + + :param name: 路由名称 + :param path: 路由地址 + :return: 路由名称(驼峰格式) + """ + router_name = name if name else path + return router_name.capitalize() + + @classmethod + def get_router_path(cls, menu: MenuTreeModel) -> str | None: + """ + 获取路由地址 + + :param menu: 菜单数对象 + :return: 路由地址 + """ + # 内链打开外网方式 + router_path = menu.path + if menu.parent_id != 0 and cls.is_inner_link(menu): + router_path = cls.inner_link_replace_each(router_path) + # 非外链并且是一级目录(类型为目录) + if menu.parent_id == 0 and menu.menu_type == MenuConstant.TYPE_DIR and menu.is_frame == MenuConstant.NO_FRAME: + router_path = f'/{menu.path}' + # 非外链并且是一级目录(类型为菜单) + elif cls.is_menu_frame(menu): + router_path = '/' + return router_path + + @classmethod + def get_component(cls, menu: MenuTreeModel) -> str: + """ + 获取组件信息 + + :param menu: 菜单数对象 + :return: 组件信息 + """ + component = MenuConstant.LAYOUT + if menu.component and not cls.is_menu_frame(menu): + component = menu.component + elif (menu.component is None or menu.component == '') and menu.parent_id != 0 and cls.is_inner_link(menu): + component = MenuConstant.INNER_LINK + elif (menu.component is None or menu.component == '') and cls.is_parent_view(menu): + component = MenuConstant.PARENT_VIEW + return component + + @classmethod + def is_menu_frame(cls, menu: MenuTreeModel) -> bool: + """ + 判断是否为菜单内部跳转 + + :param menu: 菜单数对象 + :return: 是否为菜单内部跳转 + """ + return ( + menu.parent_id == 0 and menu.menu_type == MenuConstant.TYPE_MENU and menu.is_frame == MenuConstant.NO_FRAME + ) + + @classmethod + def is_inner_link(cls, menu: MenuTreeModel) -> bool: + """ + 判断是否为内链组件 + + :param menu: 菜单数对象 + :return: 是否为内链组件 + """ + return menu.is_frame == MenuConstant.NO_FRAME and cls.is_http(menu.path) + + @classmethod + def is_parent_view(cls, menu: MenuTreeModel) -> bool: + """ + 判断是否为parent_view组件 + + :param menu: 菜单数对象 + :return: 是否为parent_view组件 + """ + return menu.parent_id != 0 and menu.menu_type == MenuConstant.TYPE_DIR + + @classmethod + def is_http(cls, link: str) -> bool: + """ + 判断是否为http(s)://开头 + + :param link: 链接 + :return: 是否为http(s)://开头 + """ + return link.startswith((CommonConstant.HTTP, CommonConstant.HTTPS)) + + @classmethod + def inner_link_replace_each(cls, path: str) -> str: + """ + 内链域名特殊字符替换 + + :param path: 内链域名 + :return: 替换后的内链域名 + """ + old_values = [CommonConstant.HTTP, CommonConstant.HTTPS, CommonConstant.WWW, '.', ':'] + new_values = ['', '', '', '/', '/'] + for old, new in zip(old_values, new_values, strict=False): + path = path.replace(old, new) + return path diff --git a/shierfeng-fastapi-backend/module_admin/service/menu_service.py b/shierfeng-fastapi-backend/module_admin/service/menu_service.py new file mode 100644 index 0000000..734bfe6 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/menu_service.py @@ -0,0 +1,217 @@ +from collections.abc import Sequence +from typing import Any + +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant, MenuConstant +from common.vo import CrudResponseModel +from exceptions.exception import ServiceException, ServiceWarning +from module_admin.dao.menu_dao import MenuDao +from module_admin.dao.role_dao import RoleDao +from module_admin.entity.do.menu_do import SysMenu +from module_admin.entity.vo.menu_vo import DeleteMenuModel, MenuModel, MenuQueryModel, MenuTreeModel +from module_admin.entity.vo.role_vo import RoleMenuQueryModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from utils.common_util import CamelCaseUtil +from utils.string_util import StringUtil + + +class MenuService: + """ + 菜单管理模块服务层 + """ + + @classmethod + async def get_menu_tree_services( + cls, query_db: AsyncSession, current_user: CurrentUserModel | None = None + ) -> list[dict[str, Any]]: + """ + 获取菜单树信息service + + :param query_db: orm对象 + :param current_user: 当前用户对象 + :return: 菜单树信息对象 + """ + menu_list_result = await MenuDao.get_menu_list_for_tree( + query_db, current_user.user.user_id, current_user.user.role + ) + menu_tree_model_result = cls.list_to_tree(menu_list_result) + menu_tree_result = [menu.model_dump(exclude_unset=True, by_alias=True) for menu in menu_tree_model_result] + + return menu_tree_result + + @classmethod + async def get_role_menu_tree_services( + cls, query_db: AsyncSession, role_id: int, current_user: CurrentUserModel | None = None + ) -> RoleMenuQueryModel: + """ + 根据角色id获取菜单树信息service + + :param query_db: orm对象 + :param role_id: 角色id + :param current_user: 当前用户对象 + :return: 当前角色id的菜单树信息对象 + """ + menu_list_result = await MenuDao.get_menu_list_for_tree( + query_db, current_user.user.user_id, current_user.user.role + ) + menu_tree_result = cls.list_to_tree(menu_list_result) + role = await RoleDao.get_role_detail_by_id(query_db, role_id) + role_menu_list = await RoleDao.get_role_menu_dao(query_db, role) + checked_keys = [row.menu_id for row in role_menu_list] + result = RoleMenuQueryModel(menus=menu_tree_result, checkedKeys=checked_keys) + + return result + + @classmethod + async def get_menu_list_services( + cls, query_db: AsyncSession, page_object: MenuQueryModel, current_user: CurrentUserModel | None = None + ) -> list[dict[str, Any]]: + """ + 获取菜单列表信息service + + :param query_db: orm对象 + :param page_object: 分页查询参数对象 + :param current_user: 当前用户对象 + :return: 菜单列表信息对象 + """ + menu_list_result = await MenuDao.get_menu_list( + query_db, page_object, current_user.user.user_id, current_user.user.role + ) + + return CamelCaseUtil.transform_result(menu_list_result) + + @classmethod + async def check_menu_name_unique_services(cls, query_db: AsyncSession, page_object: MenuModel) -> bool: + """ + 校验菜单名称是否唯一service + + :param query_db: orm对象 + :param page_object: 菜单对象 + :return: 校验结果 + """ + menu_id = -1 if page_object.menu_id is None else page_object.menu_id + menu = await MenuDao.get_menu_detail_by_info(query_db, MenuModel(menuName=page_object.menu_name)) + if menu and menu.menu_id != menu_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_menu_services(cls, query_db: AsyncSession, page_object: MenuModel) -> CrudResponseModel: + """ + 新增菜单信息service + + :param query_db: orm对象 + :param page_object: 新增菜单对象 + :return: 新增菜单校验结果 + """ + if not await cls.check_menu_name_unique_services(query_db, page_object): + raise ServiceException(message=f'新增菜单{page_object.menu_name}失败,菜单名称已存在') + if page_object.is_frame == MenuConstant.YES_FRAME and not StringUtil.is_http(page_object.path): + raise ServiceException(message=f'新增菜单{page_object.menu_name}失败,地址必须以http(s)://开头') + try: + await MenuDao.add_menu_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_menu_services(cls, query_db: AsyncSession, page_object: MenuModel) -> CrudResponseModel: + """ + 编辑菜单信息service + + :param query_db: orm对象 + :param page_object: 编辑部门对象 + :return: 编辑菜单校验结果 + """ + edit_menu = page_object.model_dump(exclude_unset=True) + menu_info = await cls.menu_detail_services(query_db, page_object.menu_id) + if menu_info.menu_id: + if not await cls.check_menu_name_unique_services(query_db, page_object): + raise ServiceException(message=f'修改菜单{page_object.menu_name}失败,菜单名称已存在') + if page_object.is_frame == MenuConstant.YES_FRAME and not StringUtil.is_http(page_object.path): + raise ServiceException(message=f'修改菜单{page_object.menu_name}失败,地址必须以http(s)://开头') + if page_object.menu_id == page_object.parent_id: + raise ServiceException(message=f'修改菜单{page_object.menu_name}失败,上级菜单不能选择自己') + try: + await MenuDao.edit_menu_dao(query_db, edit_menu) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='菜单不存在') + + @classmethod + async def delete_menu_services(cls, query_db: AsyncSession, page_object: DeleteMenuModel) -> CrudResponseModel: + """ + 删除菜单信息service + + :param query_db: orm对象 + :param page_object: 删除菜单对象 + :return: 删除菜单校验结果 + """ + if page_object.menu_ids: + menu_id_list = page_object.menu_ids.split(',') + try: + for menu_id in menu_id_list: + if (await MenuDao.has_child_by_menu_id_dao(query_db, int(menu_id))) > 0: + raise ServiceWarning(message='存在子菜单,不允许删除') + if (await MenuDao.check_menu_exist_role_dao(query_db, int(menu_id))) > 0: + raise ServiceWarning(message='菜单已分配,不允许删除') + await MenuDao.delete_menu_dao(query_db, MenuModel(menuId=menu_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入菜单id为空') + + @classmethod + async def menu_detail_services(cls, query_db: AsyncSession, menu_id: int) -> MenuModel: + """ + 获取菜单详细信息service + + :param query_db: orm对象 + :param menu_id: 菜单id + :return: 菜单id对应的信息 + """ + menu = await MenuDao.get_menu_detail_by_id(query_db, menu_id=menu_id) + result = MenuModel(**CamelCaseUtil.transform_result(menu)) if menu else MenuModel() + + return result + + @classmethod + def list_to_tree(cls, permission_list: Sequence[SysMenu]) -> list[MenuTreeModel]: + """ + 工具方法:根据菜单列表信息生成树形嵌套数据 + + :param permission_list: 菜单列表信息 + :return: 菜单树形嵌套数据 + """ + _permission_list = [ + MenuTreeModel(id=item.menu_id, label=item.menu_name, parentId=item.parent_id) for item in permission_list + ] + # 转成id为key的字典 + mapping: dict[int, MenuTreeModel] = dict(zip([i.id for i in _permission_list], _permission_list, strict=False)) + + # 树容器 + container: list[MenuTreeModel] = [] + + for d in _permission_list: + # 如果找不到父级项,则是根节点 + parent = mapping.get(d.parent_id) + if parent is None: + container.append(d) + else: + children: list[MenuTreeModel] = parent.children + if not children: + children = [] + children.append(d) + parent.children = children + + return container diff --git a/shierfeng-fastapi-backend/module_admin/service/notice_service.py b/shierfeng-fastapi-backend/module_admin/service/notice_service.py new file mode 100644 index 0000000..55c48dc --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/notice_service.py @@ -0,0 +1,126 @@ +from typing import Any + +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.notice_dao import NoticeDao +from module_admin.entity.vo.notice_vo import DeleteNoticeModel, NoticeModel, NoticePageQueryModel +from utils.common_util import CamelCaseUtil + + +class NoticeService: + """ + 通知公告管理模块服务层 + """ + + @classmethod + async def get_notice_list_services( + cls, query_db: AsyncSession, query_object: NoticePageQueryModel, is_page: bool = True + ) -> PageModel | list[dict[str, Any]]: + """ + 获取通知公告列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 通知公告列表信息对象 + """ + notice_list_result = await NoticeDao.get_notice_list(query_db, query_object, is_page) + + return notice_list_result + + @classmethod + async def check_notice_unique_services(cls, query_db: AsyncSession, page_object: NoticeModel) -> bool: + """ + 校验通知公告是否存在service + + :param query_db: orm对象 + :param page_object: 通知公告对象 + :return: 校验结果 + """ + notice_id = -1 if page_object.notice_id is None else page_object.notice_id + notice = await NoticeDao.get_notice_detail_by_info(query_db, page_object) + if notice and notice.notice_id != notice_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_notice_services(cls, query_db: AsyncSession, page_object: NoticeModel) -> CrudResponseModel: + """ + 新增通知公告信息service + + :param query_db: orm对象 + :param page_object: 新增通知公告对象 + :return: 新增通知公告校验结果 + """ + if not await cls.check_notice_unique_services(query_db, page_object): + raise ServiceException(message=f'新增通知公告{page_object.notice_title}失败,通知公告已存在') + try: + await NoticeDao.add_notice_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_notice_services(cls, query_db: AsyncSession, page_object: NoticeModel) -> CrudResponseModel: + """ + 编辑通知公告信息service + + :param query_db: orm对象 + :param page_object: 编辑通知公告对象 + :return: 编辑通知公告校验结果 + """ + edit_notice = page_object.model_dump(exclude_unset=True) + notice_info = await cls.notice_detail_services(query_db, page_object.notice_id) + if notice_info.notice_id: + if not await cls.check_notice_unique_services(query_db, page_object): + raise ServiceException(message=f'修改通知公告{page_object.notice_title}失败,通知公告已存在') + try: + await NoticeDao.edit_notice_dao(query_db, edit_notice) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='通知公告不存在') + + @classmethod + async def delete_notice_services(cls, query_db: AsyncSession, page_object: DeleteNoticeModel) -> CrudResponseModel: + """ + 删除通知公告信息service + + :param query_db: orm对象 + :param page_object: 删除通知公告对象 + :return: 删除通知公告校验结果 + """ + if page_object.notice_ids: + notice_id_list = page_object.notice_ids.split(',') + try: + for notice_id in notice_id_list: + await NoticeDao.delete_notice_dao(query_db, NoticeModel(noticeId=notice_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入通知公告id为空') + + @classmethod + async def notice_detail_services(cls, query_db: AsyncSession, notice_id: int) -> NoticeModel: + """ + 获取通知公告详细信息service + + :param query_db: orm对象 + :param notice_id: 通知公告id + :return: 通知公告id对应的信息 + """ + notice = await NoticeDao.get_notice_detail_by_id(query_db, notice_id=notice_id) + result = NoticeModel(**CamelCaseUtil.transform_result(notice)) if notice else NoticeModel() + + return result diff --git a/shierfeng-fastapi-backend/module_admin/service/online_service.py b/shierfeng-fastapi-backend/module_admin/service/online_service.py new file mode 100644 index 0000000..6ed5070 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/online_service.py @@ -0,0 +1,78 @@ +from typing import Any + +import jwt +from fastapi import Request + +from common.enums import RedisInitKeyConfig +from common.vo import CrudResponseModel +from config.env import AppConfig, JwtConfig +from exceptions.exception import ServiceException +from module_admin.entity.vo.online_vo import DeleteOnlineModel, OnlineQueryModel +from utils.common_util import CamelCaseUtil + + +class OnlineService: + """ + 在线用户管理模块服务层 + """ + + @classmethod + async def get_online_list_services(cls, request: Request, query_object: OnlineQueryModel) -> list[dict[str, Any]]: + """ + 获取在线用户表信息service + + :param request: Request对象 + :param query_object: 查询参数对象 + :return: 在线用户列表信息 + """ + access_token_keys = await request.app.state.redis.keys(f'{RedisInitKeyConfig.ACCESS_TOKEN.key}*') + if not access_token_keys: + access_token_keys = [] + access_token_values_list = [await request.app.state.redis.get(key) for key in access_token_keys] + online_info_list = [] + for item in access_token_values_list: + payload = jwt.decode(item, JwtConfig.jwt_secret_key, algorithms=[JwtConfig.jwt_algorithm]) + online_dict = { + 'token_id': payload.get('session_id') if AppConfig.app_same_time_login else payload.get('user_id'), + 'user_name': payload.get('user_name'), + 'dept_name': payload.get('dept_name'), + 'ipaddr': payload.get('login_info').get('ipaddr'), + 'login_location': payload.get('login_info').get('loginLocation'), + 'browser': payload.get('login_info').get('browser'), + 'os': payload.get('login_info').get('os'), + 'login_time': payload.get('login_info').get('loginTime'), + } + if query_object.user_name and not query_object.ipaddr: + if query_object.user_name == payload.get('user_name'): + online_info_list = [online_dict] + break + elif not query_object.user_name and query_object.ipaddr: + if query_object.ipaddr == payload.get('login_info').get('ipaddr'): + online_info_list = [online_dict] + break + elif query_object.user_name and query_object.ipaddr: + if query_object.user_name == payload.get('user_name') and query_object.ipaddr == payload.get( + 'login_info' + ).get('ipaddr'): + online_info_list = [online_dict] + break + else: + online_info_list.append(online_dict) + + return CamelCaseUtil.transform_result(online_info_list) + + @classmethod + async def delete_online_services(cls, request: Request, page_object: DeleteOnlineModel) -> CrudResponseModel: + """ + 强退在线用户信息service + + :param request: Request对象 + :param page_object: 强退在线用户对象 + :return: 强退在线用户校验结果 + """ + if page_object.token_ids: + token_id_list = page_object.token_ids.split(',') + for token_id in token_id_list: + await request.app.state.redis.delete(f'{RedisInitKeyConfig.ACCESS_TOKEN.key}:{token_id}') + return CrudResponseModel(is_success=True, message='强退成功') + raise ServiceException(message='传入session_id为空') diff --git a/shierfeng-fastapi-backend/module_admin/service/post_service.py b/shierfeng-fastapi-backend/module_admin/service/post_service.py new file mode 100644 index 0000000..9a11f23 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/post_service.py @@ -0,0 +1,180 @@ +from typing import Any + +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.post_dao import PostDao +from module_admin.entity.vo.post_vo import DeletePostModel, PostModel, PostPageQueryModel +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil + + +class PostService: + """ + 岗位管理模块服务层 + """ + + @classmethod + async def get_post_list_services( + cls, query_db: AsyncSession, query_object: PostPageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取岗位列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 岗位列表信息对象 + """ + post_list_result = await PostDao.get_post_list(query_db, query_object, is_page) + + return post_list_result + + @classmethod + async def check_post_name_unique_services(cls, query_db: AsyncSession, page_object: PostModel) -> bool: + """ + 检查岗位名称是否唯一service + + :param query_db: orm对象 + :param page_object: 岗位对象 + :return: 校验结果 + """ + post_id = -1 if page_object.post_id is None else page_object.post_id + post = await PostDao.get_post_detail_by_info(query_db, PostModel(postName=page_object.post_name)) + if post and post.post_id != post_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def check_post_code_unique_services(cls, query_db: AsyncSession, page_object: PostModel) -> bool: + """ + 检查岗位编码是否唯一service + + :param query_db: orm对象 + :param page_object: 岗位对象 + :return: 校验结果 + """ + post_id = -1 if page_object.post_id is None else page_object.post_id + post = await PostDao.get_post_detail_by_info(query_db, PostModel(postCode=page_object.post_code)) + if post and post.post_id != post_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_post_services(cls, query_db: AsyncSession, page_object: PostModel) -> CrudResponseModel: + """ + 新增岗位信息service + + :param query_db: orm对象 + :param page_object: 新增岗位对象 + :return: 新增岗位校验结果 + """ + if not await cls.check_post_name_unique_services(query_db, page_object): + raise ServiceException(message=f'新增岗位{page_object.post_name}失败,岗位名称已存在') + if not await cls.check_post_code_unique_services(query_db, page_object): + raise ServiceException(message=f'新增岗位{page_object.post_name}失败,岗位编码已存在') + try: + await PostDao.add_post_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_post_services(cls, query_db: AsyncSession, page_object: PostModel) -> CrudResponseModel: + """ + 编辑岗位信息service + + :param query_db: orm对象 + :param page_object: 编辑岗位对象 + :return: 编辑岗位校验结果 + """ + edit_post = page_object.model_dump(exclude_unset=True) + post_info = await cls.post_detail_services(query_db, page_object.post_id) + if post_info.post_id: + if not await cls.check_post_name_unique_services(query_db, page_object): + raise ServiceException(message=f'修改岗位{page_object.post_name}失败,岗位名称已存在') + if not await cls.check_post_code_unique_services(query_db, page_object): + raise ServiceException(message=f'修改岗位{page_object.post_name}失败,岗位编码已存在') + try: + await PostDao.edit_post_dao(query_db, edit_post) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='岗位不存在') + + @classmethod + async def delete_post_services(cls, query_db: AsyncSession, page_object: DeletePostModel) -> CrudResponseModel: + """ + 删除岗位信息service + + :param query_db: orm对象 + :param page_object: 删除岗位对象 + :return: 删除岗位校验结果 + """ + if page_object.post_ids: + post_id_list = page_object.post_ids.split(',') + try: + for post_id in post_id_list: + post = await cls.post_detail_services(query_db, int(post_id)) + if (await PostDao.count_user_post_dao(query_db, int(post_id))) > 0: + raise ServiceException(message=f'{post.post_name}已分配,不能删除') + await PostDao.delete_post_dao(query_db, PostModel(postId=post_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入岗位id为空') + + @classmethod + async def post_detail_services(cls, query_db: AsyncSession, post_id: int) -> PostModel: + """ + 获取岗位详细信息service + + :param query_db: orm对象 + :param post_id: 岗位id + :return: 岗位id对应的信息 + """ + post = await PostDao.get_post_detail_by_id(query_db, post_id=post_id) + result = PostModel(**CamelCaseUtil.transform_result(post)) if post else PostModel() + + return result + + @staticmethod + async def export_post_list_services(post_list: list) -> bytes: + """ + 导出岗位信息service + + :param post_list: 岗位信息列表 + :return: 岗位信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'postId': '岗位编号', + 'postCode': '岗位编码', + 'postName': '岗位名称', + 'postSort': '显示顺序', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in post_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '停用' + binary_data = ExcelUtil.export_list2excel(post_list, mapping_dict) + + return binary_data diff --git a/shierfeng-fastapi-backend/module_admin/service/role_service.py b/shierfeng-fastapi-backend/module_admin/service/role_service.py new file mode 100644 index 0000000..b7cd0a2 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/role_service.py @@ -0,0 +1,368 @@ +from typing import Any + +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.role_dao import RoleDao +from module_admin.dao.user_dao import UserDao +from module_admin.entity.vo.role_vo import ( + AddRoleModel, + DeleteRoleModel, + RoleDeptModel, + RoleDeptQueryModel, + RoleMenuModel, + RoleModel, + RolePageQueryModel, +) +from module_admin.entity.vo.user_vo import UserInfoModel, UserRolePageQueryModel +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil + + +class RoleService: + """ + 角色管理模块服务层 + """ + + @classmethod + async def get_role_select_option_services(cls, query_db: AsyncSession) -> list[dict[str, Any]]: + """ + 获取角色列表不分页信息service + + :param query_db: orm对象 + :return: 角色列表不分页信息对象 + """ + role_list_result = await RoleDao.get_role_select_option_dao(query_db) + + return CamelCaseUtil.transform_result(role_list_result) + + @classmethod + async def get_role_dept_tree_services(cls, query_db: AsyncSession, role_id: int) -> RoleDeptQueryModel: + """ + 根据角色id获取部门树信息service + + :param query_db: orm对象 + :param role_id: 角色id + :return: 当前角色id的部门树信息对象 + """ + role = await cls.role_detail_services(query_db, role_id) + role_dept_list = await RoleDao.get_role_dept_dao(query_db, role) + checked_keys = [row.dept_id for row in role_dept_list] + result = RoleDeptQueryModel(checkedKeys=checked_keys) + + return result + + @classmethod + async def get_role_list_services( + cls, + query_db: AsyncSession, + query_object: RolePageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel | list[dict[str, Any]]: + """ + 获取角色列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 角色列表信息对象 + """ + role_list_result = await RoleDao.get_role_list(query_db, query_object, data_scope_sql, is_page) + + return role_list_result + + @classmethod + async def check_role_allowed_services(cls, check_role: RoleModel) -> CrudResponseModel: + """ + 校验角色是否允许操作service + + :param check_role: 角色信息 + :return: 校验结果 + """ + if check_role.admin: + raise ServiceException(message='不允许操作超级管理员角色') + return CrudResponseModel(is_success=True, message='校验通过') + + @classmethod + async def check_role_data_scope_services( + cls, query_db: AsyncSession, role_ids: str, data_scope_sql: ColumnElement + ) -> None: + """ + 校验角色是否有数据权限service + + :param query_db: orm对象 + :param role_ids: 角色id + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 校验结果 + """ + role_id_list = role_ids.split(',') if role_ids else [] + if role_id_list: + for role_id in role_id_list: + roles = await RoleDao.get_role_list( + query_db, RolePageQueryModel(roleId=int(role_id)), data_scope_sql, is_page=False + ) + if roles: + continue + raise ServiceException(message='没有权限访问角色数据') + + @classmethod + async def check_role_name_unique_services(cls, query_db: AsyncSession, page_object: RoleModel) -> bool: + """ + 校验角色名称是否唯一service + + :param query_db: orm对象 + :param page_object: 角色对象 + :return: 校验结果 + """ + role_id = -1 if page_object.role_id is None else page_object.role_id + role = await RoleDao.get_role_by_info(query_db, RoleModel(roleName=page_object.role_name)) + if role and role.role_id != role_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def check_role_key_unique_services(cls, query_db: AsyncSession, page_object: RoleModel) -> bool: + """ + 校验角色权限字符是否唯一service + + :param query_db: orm对象 + :param page_object: 角色对象 + :return: 校验结果 + """ + role_id = -1 if page_object.role_id is None else page_object.role_id + role = await RoleDao.get_role_by_info(query_db, RoleModel(roleKey=page_object.role_key)) + if role and role.role_id != role_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_role_services(cls, query_db: AsyncSession, page_object: AddRoleModel) -> CrudResponseModel: + """ + 新增角色信息service + + :param query_db: orm对象 + :param page_object: 新增角色对象 + :return: 新增角色校验结果 + """ + add_role = RoleModel(**page_object.model_dump(by_alias=True)) + if not await cls.check_role_name_unique_services(query_db, page_object): + raise ServiceException(message=f'新增角色{page_object.role_name}失败,角色名称已存在') + if not await cls.check_role_key_unique_services(query_db, page_object): + raise ServiceException(message=f'新增角色{page_object.role_name}失败,角色权限已存在') + try: + add_result = await RoleDao.add_role_dao(query_db, add_role) + role_id = add_result.role_id + if page_object.menu_ids: + for menu in page_object.menu_ids: + await RoleDao.add_role_menu_dao(query_db, RoleMenuModel(roleId=role_id, menuId=menu)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_role_services(cls, query_db: AsyncSession, page_object: AddRoleModel) -> CrudResponseModel: + """ + 编辑角色信息service + + :param query_db: orm对象 + :param page_object: 编辑角色对象 + :return: 编辑角色校验结果 + """ + edit_role = page_object.model_dump(exclude_unset=True, exclude={'admin'}) + if page_object.type != 'status': + del edit_role['menu_ids'] + if page_object.type == 'status': + del edit_role['type'] + role_info = await cls.role_detail_services(query_db, edit_role.get('role_id')) + if role_info: + if page_object.type != 'status': + if not await cls.check_role_name_unique_services(query_db, page_object): + raise ServiceException(message=f'修改角色{page_object.role_name}失败,角色名称已存在') + if not await cls.check_role_key_unique_services(query_db, page_object): + raise ServiceException(message=f'修改角色{page_object.role_name}失败,角色权限已存在') + try: + await RoleDao.edit_role_dao(query_db, edit_role) + if page_object.type != 'status': + await RoleDao.delete_role_menu_dao(query_db, RoleMenuModel(roleId=page_object.role_id)) + if page_object.menu_ids: + for menu in page_object.menu_ids: + await RoleDao.add_role_menu_dao( + query_db, RoleMenuModel(roleId=page_object.role_id, menuId=menu) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='角色不存在') + + @classmethod + async def role_datascope_services(cls, query_db: AsyncSession, page_object: AddRoleModel) -> CrudResponseModel: + """ + 分配角色数据权限service + + :param query_db: orm对象 + :param page_object: 角色数据权限对象 + :return: 分配角色数据权限结果 + """ + edit_role = page_object.model_dump(exclude_unset=True, exclude={'admin', 'dept_ids'}) + role_info = await cls.role_detail_services(query_db, page_object.role_id) + if role_info.role_id: + try: + await RoleDao.edit_role_dao(query_db, edit_role) + await RoleDao.delete_role_dept_dao(query_db, RoleDeptModel(roleId=page_object.role_id)) + if page_object.dept_ids and page_object.data_scope == '2': + for dept in page_object.dept_ids: + await RoleDao.add_role_dept_dao( + query_db, RoleDeptModel(roleId=page_object.role_id, deptId=dept) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='分配成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='角色不存在') + + @classmethod + async def delete_role_services(cls, query_db: AsyncSession, page_object: DeleteRoleModel) -> CrudResponseModel: + """ + 删除角色信息service + + :param query_db: orm对象 + :param page_object: 删除角色对象 + :return: 删除角色校验结果 + """ + if page_object.role_ids: + role_id_list = page_object.role_ids.split(',') + try: + for role_id in role_id_list: + role = await cls.role_detail_services(query_db, int(role_id)) + if (await RoleDao.count_user_role_dao(query_db, int(role_id))) > 0: + raise ServiceException(message=f'角色{role.role_name}已分配,不能删除') + role_id_dict = { + 'roleId': role_id, + 'updateBy': page_object.update_by, + 'updateTime': page_object.update_time, + } + await RoleDao.delete_role_menu_dao(query_db, RoleMenuModel(**role_id_dict)) + await RoleDao.delete_role_dept_dao(query_db, RoleDeptModel(**role_id_dict)) + await RoleDao.delete_role_dao(query_db, RoleModel(**role_id_dict)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入角色id为空') + + @classmethod + async def role_detail_services(cls, query_db: AsyncSession, role_id: int) -> RoleModel: + """ + 获取角色详细信息service + + :param query_db: orm对象 + :param role_id: 角色id + :return: 角色id对应的信息 + """ + role = await RoleDao.get_role_detail_by_id(query_db, role_id=role_id) + result = RoleModel(**CamelCaseUtil.transform_result(role)) if role else RoleModel() + + return result + + @staticmethod + async def export_role_list_services(role_list: list) -> bytes: + """ + 导出角色列表信息service + + :param role_list: 角色信息列表 + :return: 角色列表信息对象 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'roleId': '角色编号', + 'roleName': '角色名称', + 'roleKey': '权限字符', + 'roleSort': '显示顺序', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in role_list: + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '停用' + binary_data = ExcelUtil.export_list2excel(role_list, mapping_dict) + + return binary_data + + @classmethod + async def get_role_user_allocated_list_services( + cls, + query_db: AsyncSession, + page_object: UserRolePageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel: + """ + 根据角色id获取已分配用户列表 + + :param query_db: orm对象 + :param page_object: 用户关联角色对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 已分配用户列表 + """ + query_user_list = await UserDao.get_user_role_allocated_list_by_role_id( + query_db, page_object, data_scope_sql, is_page + ) + allocated_list = PageModel[UserInfoModel]( + **{ + **query_user_list.model_dump(by_alias=True), + 'rows': [UserInfoModel(**row) for row in query_user_list.rows], + } + ) + + return allocated_list + + @classmethod + async def get_role_user_unallocated_list_services( + cls, + query_db: AsyncSession, + page_object: UserRolePageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel: + """ + 根据角色id获取未分配用户列表 + + :param query_db: orm对象 + :param page_object: 用户关联角色对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 未分配用户列表 + """ + query_user_list = await UserDao.get_user_role_unallocated_list_by_role_id( + query_db, page_object, data_scope_sql, is_page + ) + unallocated_list = PageModel[UserInfoModel]( + **{ + **query_user_list.model_dump(by_alias=True), + 'rows': [UserInfoModel(**row) for row in query_user_list.rows], + } + ) + + return unallocated_list diff --git a/shierfeng-fastapi-backend/module_admin/service/server_service.py b/shierfeng-fastapi-backend/module_admin/service/server_service.py new file mode 100644 index 0000000..ca84090 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/server_service.py @@ -0,0 +1,103 @@ +import os +import platform +import socket +import time + +import anyio +import psutil + +from module_admin.entity.vo.server_vo import CpuInfo, MemoryInfo, PyInfo, ServerMonitorModel, SysFiles, SysInfo +from utils.common_util import bytes2human + + +class ServerService: + """ + 服务监控模块服务层 + """ + + @staticmethod + async def get_server_monitor_info() -> ServerMonitorModel: + # CPU信息 + # 获取CPU总核心数 + cpu_num = psutil.cpu_count(logical=True) + cpu_usage_percent = psutil.cpu_times_percent() + cpu_used = cpu_usage_percent.user + cpu_sys = cpu_usage_percent.system + cpu_free = cpu_usage_percent.idle + cpu = CpuInfo(cpuNum=cpu_num, used=cpu_used, sys=cpu_sys, free=cpu_free) + + # 内存信息 + memory_info = psutil.virtual_memory() + memory_total = bytes2human(memory_info.total) + memory_used = bytes2human(memory_info.used) + memory_free = bytes2human(memory_info.free) + memory_usage = memory_info.percent + mem = MemoryInfo(total=memory_total, used=memory_used, free=memory_free, usage=memory_usage) + + # 主机信息 + # 获取主机名 + hostname = socket.gethostname() + # 获取IP + computer_ip = socket.gethostbyname(hostname) + os_name = platform.platform() + computer_name = platform.node() + os_arch = platform.machine() + user_dir = str(await anyio.Path.cwd()) + sys = SysInfo( + computerIp=computer_ip, computerName=computer_name, osArch=os_arch, osName=os_name, userDir=user_dir + ) + + # python解释器信息 + current_pid = os.getpid() + current_process = psutil.Process(current_pid) + python_name = current_process.name() + python_version = platform.python_version() + python_home = current_process.exe() + start_time_stamp = current_process.create_time() + start_time = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(start_time_stamp)) + current_time_stamp = time.time() + difference = current_time_stamp - start_time_stamp + # 将时间差转换为天、小时和分钟数 + days = int(difference // (24 * 60 * 60)) # 每天的秒数 + hours = int((difference % (24 * 60 * 60)) // (60 * 60)) # 每小时的秒数 + minutes = int((difference % (60 * 60)) // 60) # 每分钟的秒数 + run_time = f'{days}天{hours}小时{minutes}分钟' + # 获取当前Python程序的pid + pid = os.getpid() + # 获取该进程的内存信息 + current_process_memory_info = psutil.Process(pid).memory_info() + py = PyInfo( + name=python_name, + version=python_version, + startTime=start_time, + runTime=run_time, + home=python_home, + total=bytes2human(memory_info.available), + used=bytes2human(current_process_memory_info.rss), + free=bytes2human(memory_info.available - current_process_memory_info.rss), + usage=round((current_process_memory_info.rss / memory_info.available) * 100, 2), + ) + + # 磁盘信息 + io = psutil.disk_partitions() + sys_files = [] + for i in io: + try: + o = psutil.disk_usage(i.device) + disk_data = SysFiles( + dirName=i.device, + sysTypeName=i.fstype, + typeName='本地固定磁盘(' + i.mountpoint.replace('\\', '') + ')', + total=bytes2human(o.total), + used=bytes2human(o.used), + free=bytes2human(o.free), + usage=f'{psutil.disk_usage(i.device).percent}%', + ) + sys_files.append(disk_data) + except Exception: # noqa: PERF203 + # 忽略所有异常,跳过有问题的磁盘 + continue + + result = ServerMonitorModel(cpu=cpu, mem=mem, sys=sys, py=py, sysFiles=sys_files) + + return result diff --git a/shierfeng-fastapi-backend/module_admin/service/transport_crypto_service.py b/shierfeng-fastapi-backend/module_admin/service/transport_crypto_service.py new file mode 100644 index 0000000..f581314 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/transport_crypto_service.py @@ -0,0 +1,44 @@ +from fastapi import Request + +from module_admin.entity.vo.transport_crypto_vo import ( + TransportCryptoFrontendConfigModel, + TransportCryptoMonitorModel, + TransportCryptoPublicKeyModel, +) +from utils.transport_crypto_util import TransportCryptoMonitorUtil, TransportCryptoUtil + + +class TransportCryptoService: + """ + 传输加密模块服务层 + """ + + @classmethod + async def get_transport_frontend_config_services(cls) -> TransportCryptoFrontendConfigModel: + """ + 获取前端传输加密运行配置service + + :return: 前端传输加密运行配置 + """ + return TransportCryptoFrontendConfigModel.model_validate(TransportCryptoUtil.build_frontend_config_payload()) + + @classmethod + async def get_transport_public_key_services(cls) -> TransportCryptoPublicKeyModel: + """ + 获取传输加密公钥service + + :return: 传输加密公钥信息 + """ + return TransportCryptoPublicKeyModel.model_validate(TransportCryptoUtil.build_public_key_payload()) + + @classmethod + async def get_transport_crypto_monitor_info_services(cls, request: Request) -> TransportCryptoMonitorModel: + """ + 获取传输加密监控信息service + + :param request: Request对象 + :return: 传输加密监控信息 + """ + transport_crypto_monitor_info = await TransportCryptoMonitorUtil.get_snapshot(request.app) + + return TransportCryptoMonitorModel.model_validate(transport_crypto_monitor_info) diff --git a/shierfeng-fastapi-backend/module_admin/service/user_service.py b/shierfeng-fastapi-backend/module_admin/service/user_service.py new file mode 100644 index 0000000..5d35780 --- /dev/null +++ b/shierfeng-fastapi-backend/module_admin/service/user_service.py @@ -0,0 +1,679 @@ +import io +from datetime import datetime +from typing import Any + +import pandas as pd +from fastapi import Request, UploadFile +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_admin.dao.user_dao import UserDao +from module_admin.entity.do.user_do import SysUserRole +from module_admin.entity.vo.post_vo import PostPageQueryModel +from module_admin.entity.vo.user_vo import ( + AddUserModel, + CrudUserRoleModel, + CurrentUserModel, + DeleteUserModel, + EditUserModel, + ResetUserModel, + SelectedRoleModel, + UserDetailModel, + UserInfoModel, + UserModel, + UserPageQueryModel, + UserPostModel, + UserProfileModel, + UserRoleModel, + UserRoleQueryModel, + UserRoleResponseModel, + UserRowModel, +) +from module_admin.service.config_service import ConfigService +from module_admin.service.dept_service import DeptService +from module_admin.service.post_service import PostService +from module_admin.service.role_service import RoleService +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil +from utils.pwd_util import PwdUtil + + +class UserService: + """ + 用户管理模块服务层 + """ + + @classmethod + async def get_user_list_services( + cls, + query_db: AsyncSession, + query_object: UserPageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel[UserRowModel] | list[dict[str, Any]]: + """ + 获取用户列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: 用户列表信息对象 + """ + query_result = await UserDao.get_user_list(query_db, query_object, data_scope_sql, is_page) + if is_page: + user_list_result = PageModel[UserRowModel]( + **{ + **query_result.model_dump(by_alias=True), + 'rows': [{**row[0], 'dept': row[1]} for row in query_result.rows], + } + ) + else: + user_list_result = [] + if query_result: + user_list_result = [{**row[0], 'dept': row[1]} for row in query_result] + + return user_list_result + + @classmethod + async def check_user_allowed_services(cls, check_user: UserModel) -> CrudResponseModel: + """ + 校验用户是否允许操作service + + :param check_user: 用户信息 + :return: 校验结果 + """ + if check_user.admin: + raise ServiceException(message='不允许操作超级管理员用户') + return CrudResponseModel(is_success=True, message='校验通过') + + @classmethod + async def check_user_data_scope_services( + cls, query_db: AsyncSession, user_id: int, data_scope_sql: ColumnElement + ) -> CrudResponseModel: + """ + 校验用户数据权限service + + :param query_db: orm对象 + :param user_id: 用户id + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 校验结果 + """ + users = await UserDao.get_user_list(query_db, UserPageQueryModel(userId=user_id), data_scope_sql, is_page=False) + if users: + return CrudResponseModel(is_success=True, message='校验通过') + raise ServiceException(message='没有权限访问用户数据') + + @classmethod + async def check_user_name_unique_services(cls, query_db: AsyncSession, page_object: UserModel) -> bool: + """ + 校验用户名是否唯一service + + :param query_db: orm对象 + :param page_object: 用户对象 + :return: 校验结果 + """ + user_id = -1 if page_object.user_id is None else page_object.user_id + user = await UserDao.get_user_by_info(query_db, UserModel(userName=page_object.user_name)) + if user and user.user_id != user_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def check_phonenumber_unique_services(cls, query_db: AsyncSession, page_object: UserModel) -> bool: + """ + 校验用户手机号是否唯一service + + :param query_db: orm对象 + :param page_object: 用户对象 + :return: 校验结果 + """ + user_id = -1 if page_object.user_id is None else page_object.user_id + user = await UserDao.get_user_by_info(query_db, UserModel(phonenumber=page_object.phonenumber)) + if user and user.user_id != user_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def check_email_unique_services(cls, query_db: AsyncSession, page_object: UserModel) -> bool: + """ + 校验用户邮箱是否唯一service + + :param query_db: orm对象 + :param page_object: 用户对象 + :return: 校验结果 + """ + user_id = -1 if page_object.user_id is None else page_object.user_id + user = await UserDao.get_user_by_info(query_db, UserModel(email=page_object.email)) + if user and user.user_id != user_id: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + + @classmethod + async def add_user_services(cls, query_db: AsyncSession, page_object: AddUserModel) -> CrudResponseModel: + """ + 新增用户信息service + + :param query_db: orm对象 + :param page_object: 新增用户对象 + :return: 新增用户校验结果 + """ + add_user = UserModel(**page_object.model_dump(by_alias=True)) + if not await cls.check_user_name_unique_services(query_db, page_object): + raise ServiceException(message=f'新增用户{page_object.user_name}失败,登录账号已存在') + if page_object.phonenumber and not await cls.check_phonenumber_unique_services(query_db, page_object): + raise ServiceException(message=f'新增用户{page_object.user_name}失败,手机号码已存在') + if page_object.email and not await cls.check_email_unique_services(query_db, page_object): + raise ServiceException(message=f'新增用户{page_object.user_name}失败,邮箱账号已存在') + try: + add_result = await UserDao.add_user_dao(query_db, add_user) + user_id = add_result.user_id + if page_object.role_ids: + for role in page_object.role_ids: + await UserDao.add_user_role_dao(query_db, UserRoleModel(userId=user_id, roleId=role)) + if page_object.post_ids: + for post in page_object.post_ids: + await UserDao.add_user_post_dao(query_db, UserPostModel(userId=user_id, postId=post)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + def _deal_edit_user(cls, page_object: EditUserModel, edit_user: dict[str, Any]) -> None: + """ + 处理编辑用户字典 + + :param page_object: 编辑用户对象 + :param edit_user: 编辑用户字典 + :return: None + """ + if page_object.type not in ['status', 'avatar', 'pwd']: + del edit_user['role_ids'] + del edit_user['post_ids'] + del edit_user['role'] + else: + del edit_user['type'] + + @classmethod + async def edit_user_services(cls, query_db: AsyncSession, page_object: EditUserModel) -> CrudResponseModel: + """ + 编辑用户信息service + + :param query_db: orm对象 + :param page_object: 编辑用户对象 + :return: 编辑用户校验结果 + """ + edit_user = page_object.model_dump(exclude_unset=True, exclude={'admin'}) + cls._deal_edit_user(page_object, edit_user) + user_info = await cls.user_detail_services(query_db, edit_user.get('user_id')) + if user_info.data and user_info.data.user_id: + if page_object.type not in ['status', 'avatar', 'pwd']: + if not await cls.check_user_name_unique_services(query_db, page_object): + raise ServiceException(message=f'修改用户{page_object.user_name}失败,登录账号已存在') + if page_object.phonenumber and not await cls.check_phonenumber_unique_services(query_db, page_object): + raise ServiceException(message=f'修改用户{page_object.user_name}失败,手机号码已存在') + if page_object.email and not await cls.check_email_unique_services(query_db, page_object): + raise ServiceException(message=f'修改用户{page_object.user_name}失败,邮箱账号已存在') + try: + await UserDao.edit_user_dao(query_db, edit_user) + if page_object.type not in {'status', 'avatar', 'pwd'}: + await UserDao.delete_user_role_dao(query_db, UserRoleModel(userId=page_object.user_id)) + await UserDao.delete_user_post_dao(query_db, UserPostModel(userId=page_object.user_id)) + if page_object.role_ids: + for role in page_object.role_ids: + await UserDao.add_user_role_dao( + query_db, UserRoleModel(userId=page_object.user_id, roleId=role) + ) + if page_object.post_ids: + for post in page_object.post_ids: + await UserDao.add_user_post_dao( + query_db, UserPostModel(userId=page_object.user_id, postId=post) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='用户不存在') + + @classmethod + async def delete_user_services(cls, query_db: AsyncSession, page_object: DeleteUserModel) -> CrudResponseModel: + """ + 删除用户信息service + + :param query_db: orm对象 + :param page_object: 删除用户对象 + :return: 删除用户校验结果 + """ + if page_object.user_ids: + user_id_list = page_object.user_ids.split(',') + try: + for user_id in user_id_list: + user_id_dict = { + 'userId': user_id, + 'updateBy': page_object.update_by, + 'updateTime': page_object.update_time, + } + await UserDao.delete_user_role_dao(query_db, UserRoleModel(**user_id_dict)) + await UserDao.delete_user_post_dao(query_db, UserPostModel(**user_id_dict)) + await UserDao.delete_user_dao(query_db, UserModel(**user_id_dict)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入用户id为空') + + @classmethod + async def user_detail_services(cls, query_db: AsyncSession, user_id: int | str) -> UserDetailModel: + """ + 获取用户详细信息service + + :param query_db: orm对象 + :param user_id: 用户id + :return: 用户id对应的信息 + """ + posts = await PostService.get_post_list_services(query_db, PostPageQueryModel(), is_page=False) + roles = await RoleService.get_role_select_option_services(query_db) + if user_id != '': + query_user = await UserDao.get_user_detail_by_id(query_db, user_id=user_id) + post_ids = ','.join([str(row.post_id) for row in query_user.get('user_post_info')]) + post_ids_list = [row.post_id for row in query_user.get('user_post_info')] + role_ids = ','.join([str(row.role_id) for row in query_user.get('user_role_info')]) + role_ids_list = [row.role_id for row in query_user.get('user_role_info')] + + return UserDetailModel( + data=UserInfoModel( + **CamelCaseUtil.transform_result(query_user.get('user_basic_info')), + postIds=post_ids, + roleIds=role_ids, + dept=CamelCaseUtil.transform_result(query_user.get('user_dept_info')), + role=CamelCaseUtil.transform_result(query_user.get('user_role_info')), + ), + postIds=post_ids_list, + posts=posts, + roleIds=role_ids_list, + roles=roles, + ) + + return UserDetailModel(posts=posts, roles=roles) + + @classmethod + async def user_profile_services(cls, query_db: AsyncSession, user_id: int) -> UserProfileModel: + """ + 获取用户个人详细信息service + + :param query_db: orm对象 + :param user_id: 用户id + :return: 用户id对应的信息 + """ + query_user = await UserDao.get_user_detail_by_id(query_db, user_id=user_id) + post_ids = ','.join([str(row.post_id) for row in query_user.get('user_post_info')]) + post_group = ','.join([row.post_name for row in query_user.get('user_post_info')]) + role_ids = ','.join([str(row.role_id) for row in query_user.get('user_role_info')]) + role_group = ','.join([row.role_name for row in query_user.get('user_role_info')]) + + return UserProfileModel( + data=UserInfoModel( + **CamelCaseUtil.transform_result(query_user.get('user_basic_info')), + postIds=post_ids, + roleIds=role_ids, + dept=CamelCaseUtil.transform_result(query_user.get('user_dept_info')), + role=CamelCaseUtil.transform_result(query_user.get('user_role_info')), + ), + postGroup=post_group, + roleGroup=role_group, + ) + + @classmethod + async def reset_user_services(cls, query_db: AsyncSession, page_object: ResetUserModel) -> CrudResponseModel: + """ + 重置用户密码service + + :param query_db: orm对象 + :param page_object: 重置用户对象 + :return: 重置用户校验结果 + """ + reset_user = page_object.model_dump(exclude_unset=True, exclude={'admin'}) + if page_object.old_password: + user = (await UserDao.get_user_detail_by_id(query_db, user_id=page_object.user_id)).get('user_basic_info') + if not PwdUtil.verify_password(page_object.old_password, user.password): + raise ServiceException(message='修改密码失败,旧密码错误') + if PwdUtil.verify_password(page_object.password, user.password): + raise ServiceException(message='新密码不能与旧密码相同') + del reset_user['old_password'] + if page_object.sms_code and page_object.session_id: + del reset_user['sms_code'] + del reset_user['session_id'] + try: + reset_user['password'] = PwdUtil.get_password_hash(page_object.password) + await UserDao.edit_user_dao(query_db, reset_user) + await query_db.commit() + return CrudResponseModel(is_success=True, message='重置成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + def _set_row_sex_value(cls, row: pd.Series) -> None: + """ + 设置行性别值 + + :param row: 行数据 + :return: None + """ + if row['sex'] == '男': + row['sex'] = '0' + if row['sex'] == '女': + row['sex'] = '1' + if row['sex'] == '未知': + row['sex'] = '2' + + @classmethod + def _set_row_status_value(cls, row: pd.Series) -> None: + """ + 设置行状态值 + + :param row: 行数据 + :return: None + """ + if row['status'] == '正常': + row['status'] = '0' + if row['status'] == '停用': + row['status'] = '1' + + @classmethod + async def batch_import_user_services( + cls, + request: Request, + query_db: AsyncSession, + file: UploadFile, + update_support: bool, + current_user: CurrentUserModel, + user_data_scope_sql: ColumnElement, + dept_data_scope_sql: ColumnElement, + ) -> CrudResponseModel: + """ + 批量导入用户service + + :param request: Request对象 + :param query_db: orm对象 + :param file: 用户导入文件对象 + :param update_support: 用户存在时是否更新 + :param current_user: 当前用户对象 + :param user_data_scope_sql: 用户数据权限sql + :param dept_data_scope_sql: 部门数据权限sql + :return: 批量导入用户结果 + """ + header_dict = { + '部门编号': 'dept_id', + '登录名称': 'user_name', + '用户名称': 'nick_name', + '用户邮箱': 'email', + '手机号码': 'phonenumber', + '用户性别': 'sex', + '帐号状态': 'status', + } + contents = await file.read() + df = pd.read_excel(io.BytesIO(contents)) + await file.close() + df.rename(columns=header_dict, inplace=True) + add_error_result = [] + count = 0 + try: + for _index, row in df.iterrows(): + count = count + 1 + cls._set_row_sex_value(row) + cls._set_row_status_value(row) + add_user = UserModel( + deptId=row['dept_id'], + userName=row['user_name'], + password=PwdUtil.get_password_hash( + await ConfigService.query_config_list_from_cache_services( + request.app.state.redis, 'sys.user.initPassword' + ) + ), + nickName=row['nick_name'], + email=row['email'], + phonenumber=str(row['phonenumber']), + sex=row['sex'], + status=row['status'], + createBy=current_user.user.user_name, + createTime=datetime.now(), + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + ) + user_info = await UserDao.get_user_by_info(query_db, UserModel(userName=row['user_name'])) + if user_info: + if update_support: + edit_user_model = UserModel( + userId=user_info.user_id, + deptId=row['dept_id'], + userName=row['user_name'], + nickName=row['nick_name'], + email=row['email'], + phonenumber=str(row['phonenumber']), + sex=row['sex'], + status=row['status'], + updateBy=current_user.user.user_name, + updateTime=datetime.now(), + ) + edit_user_model.validate_fields() + await cls.check_user_allowed_services(edit_user_model) + if not current_user.user.admin: + await cls.check_user_data_scope_services( + query_db, edit_user_model.user_id, user_data_scope_sql + ) + await DeptService.check_dept_data_scope_services( + query_db, edit_user_model.dept_id, dept_data_scope_sql + ) + edit_user = edit_user_model.model_dump(exclude_unset=True) + await UserDao.edit_user_dao(query_db, edit_user) + else: + add_error_result.append(f'{count}.用户账号{row["user_name"]}已存在') + else: + add_user.validate_fields() + if not current_user.user.admin: + await DeptService.check_dept_data_scope_services( + query_db, add_user.dept_id, dept_data_scope_sql + ) + await UserDao.add_user_dao(query_db, add_user) + await query_db.commit() + return CrudResponseModel(is_success=True, message='\n'.join(add_error_result)) + except Exception as e: + await query_db.rollback() + raise e + + @staticmethod + async def get_user_import_template_services() -> bytes: + """ + 获取用户导入模板service + + :return: 用户导入模板excel的二进制数据 + """ + header_list = ['部门编号', '登录名称', '用户名称', '用户邮箱', '手机号码', '用户性别', '帐号状态'] + selector_header_list = ['用户性别', '帐号状态'] + option_list = [{'用户性别': ['男', '女', '未知']}, {'帐号状态': ['正常', '停用']}] + binary_data = ExcelUtil.get_excel_template( + header_list=header_list, selector_header_list=selector_header_list, option_list=option_list + ) + + return binary_data + + @staticmethod + async def export_user_list_services(user_list: list) -> bytes: + """ + 导出用户信息service + + :param user_list: 用户信息列表 + :return: 用户信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + 'userId': '用户编号', + 'userName': '用户名称', + 'nickName': '用户昵称', + 'deptName': '部门', + 'email': '邮箱地址', + 'phonenumber': '手机号码', + 'sex': '性别', + 'status': '状态', + 'createBy': '创建者', + 'createTime': '创建时间', + 'updateBy': '更新者', + 'updateTime': '更新时间', + 'remark': '备注', + } + + for item in user_list: + item['deptName'] = item.get('dept').get('deptName') + if item.get('status') == '0': + item['status'] = '正常' + else: + item['status'] = '停用' + if item.get('sex') == '0': + item['sex'] = '男' + elif item.get('sex') == '1': + item['sex'] = '女' + else: + item['sex'] = '未知' + binary_data = ExcelUtil.export_list2excel(user_list, mapping_dict) + + return binary_data + + @classmethod + async def get_user_role_allocated_list_services( + cls, query_db: AsyncSession, page_object: UserRoleQueryModel + ) -> UserRoleResponseModel: + """ + 根据用户id获取已分配角色列表 + + :param query_db: orm对象 + :param page_object: 用户关联角色对象 + :return: 已分配角色列表 + """ + query_user = await UserDao.get_user_detail_by_id(query_db, page_object.user_id) + post_ids = ','.join([str(row.post_id) for row in query_user.get('user_post_info')]) + role_ids = ','.join([str(row.role_id) for row in query_user.get('user_role_info')]) + user = UserInfoModel( + **CamelCaseUtil.transform_result(query_user.get('user_basic_info')), + postIds=post_ids, + roleIds=role_ids, + dept=CamelCaseUtil.transform_result(query_user.get('user_dept_info')), + role=CamelCaseUtil.transform_result(query_user.get('user_role_info')), + ) + query_role_list = [ + SelectedRoleModel(**row) for row in await RoleService.get_role_select_option_services(query_db) + ] + for model_a in query_role_list: + for model_b in user.role: + if model_a.role_id == model_b.role_id: + model_a.flag = True + result = UserRoleResponseModel(roles=query_role_list, user=user) + + return result + + @classmethod + async def add_user_role_services(cls, query_db: AsyncSession, page_object: CrudUserRoleModel) -> CrudResponseModel: + """ + 新增用户关联角色信息service + + :param query_db: orm对象 + :param page_object: 新增用户关联角色对象 + :return: 新增用户关联角色校验结果 + """ + if page_object.user_id and page_object.role_ids: + role_id_list = page_object.role_ids.split(',') + try: + await UserDao.delete_user_role_by_user_and_role_dao(query_db, UserRoleModel(userId=page_object.user_id)) + for role_id in role_id_list: + await UserDao.add_user_role_dao(query_db, UserRoleModel(userId=page_object.user_id, roleId=role_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='分配成功') + except Exception as e: + await query_db.rollback() + raise e + elif page_object.user_id and not page_object.role_ids: + try: + await UserDao.delete_user_role_by_user_and_role_dao(query_db, UserRoleModel(userId=page_object.user_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='分配成功') + except Exception as e: + await query_db.rollback() + raise e + elif page_object.user_ids and page_object.role_id: + user_id_list = page_object.user_ids.split(',') + try: + for user_id in user_id_list: + user_role = await cls.detail_user_role_services( + query_db, UserRoleModel(userId=user_id, roleId=page_object.role_id) + ) + if user_role: + continue + await UserDao.add_user_role_dao(query_db, UserRoleModel(userId=user_id, roleId=page_object.role_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='不满足新增条件') + + @classmethod + async def delete_user_role_services( + cls, query_db: AsyncSession, page_object: CrudUserRoleModel + ) -> CrudResponseModel: + """ + 删除用户关联角色信息service + + :param query_db: orm对象 + :param page_object: 删除用户关联角色对象 + :return: 删除用户关联角色校验结果 + """ + if (page_object.user_id and page_object.role_id) or (page_object.user_ids and page_object.role_id): + if page_object.user_id and page_object.role_id: + try: + await UserDao.delete_user_role_by_user_and_role_dao( + query_db, UserRoleModel(userId=page_object.user_id, roleId=page_object.role_id) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + elif page_object.user_ids and page_object.role_id: + user_id_list = page_object.user_ids.split(',') + try: + for user_id in user_id_list: + await UserDao.delete_user_role_by_user_and_role_dao( + query_db, UserRoleModel(userId=user_id, roleId=page_object.role_id) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='不满足删除条件') + else: + raise ServiceException(message='传入用户角色关联信息为空') + + @classmethod + async def detail_user_role_services(cls, query_db: AsyncSession, page_object: UserRoleModel) -> SysUserRole | None: + """ + 获取用户关联角色详细信息service + + :param query_db: orm对象 + :param page_object: 用户关联角色对象 + :return: 用户关联角色详细信息 + """ + user_role = await UserDao.get_user_role_detail(query_db, page_object) + + return user_role diff --git a/shierfeng-fastapi-backend/module_ai/controller/ai_chat_controller.py b/shierfeng-fastapi-backend/module_ai/controller/ai_chat_controller.py new file mode 100644 index 0000000..4255c7b --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/controller/ai_chat_controller.py @@ -0,0 +1,164 @@ +from typing import Annotated + +from fastapi import Body, Path, Request, Response +from fastapi.responses import StreamingResponse +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, ResponseBaseModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_ai.entity.vo.ai_chat_vo import ( + AiChatConfigModel, + AiChatRequestModel, + AiChatSessionBaseModel, + AiChatSessionModel, +) +from module_ai.service.ai_chat_service import AiChatService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +ai_chat_controller = APIRouterPro( + prefix='/ai/chat', order_num=19, tags=['AI管理-AI对话'], dependencies=[PreAuthDependency()] +) + + +@ai_chat_controller.post( + '/send', + summary='发送对话消息', + description='流式返回对话结果', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回对话结果', + 'content': { + 'text/event-stream': {}, + }, + } + }, +) +@ApiRateLimit(namespace=ApiNamespace.AI_CHAT_SEND, preset=ApiRateLimitPreset.USER_INTERACTIVE_HIGH_FREQ) +async def send_chat_message( + request: Request, + chat_req: AiChatRequestModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> StreamingResponse: + user_id = current_user.user.user_id if current_user and current_user.user else 1 + chat_stream = AiChatService.chat_services(query_db, chat_req, user_id) + logger.info(f'用户{user_id}发送对话消息成功') + + return StreamingResponse(content=chat_stream, media_type='text/event-stream') + + +@ai_chat_controller.get( + '/config', + summary='获取用户对话配置', + description='获取当前用户的AI对话配置', + response_model=DataResponseModel[AiChatConfigModel], +) +@ApiCache(namespace=ApiNamespace.AI_CHAT_CONFIG) +async def get_user_chat_config( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + user_id = current_user.user.user_id + ai_chat_config_detail_result = await AiChatService.ai_chat_config_detail_services(query_db, user_id) + logger.info(f'获取user_id为{user_id}的对话配置成功') + + return ResponseUtil.success(data=ai_chat_config_detail_result) + + +@ai_chat_controller.put( + '/config', + summary='保存用户对话配置', + description='保存当前用户的AI对话配置', + response_model=DataResponseModel[AiChatConfigModel], +) +@ApiCacheEvict(namespaces=ApiGroup.AI_CHAT_CONFIG_MUTATION) +@Log(title='AI对话配置管理', business_type=BusinessType.INSERT) +async def save_user_chat_config( + request: Request, + ai_chat_config: AiChatConfigModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + user_id = current_user.user.user_id if current_user and current_user.user else 1 + save_ai_chat_config_result = await AiChatService.save_ai_chat_config_services(query_db, user_id, ai_chat_config) + logger.info(save_ai_chat_config_result.message) + + return ResponseUtil.success(msg=save_ai_chat_config_result.message) + + +@ai_chat_controller.get( + '/session/list', + summary='获取会话列表', + description='获取用户的会话列表', + response_model=DataResponseModel[list[AiChatSessionBaseModel]], +) +async def get_chat_session_list( + request: Request, + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + result = await AiChatService.get_chat_session_list_services(current_user.user.user_id) + logger.info('获取成功') + + return ResponseUtil.success(data=result) + + +@ai_chat_controller.delete( + '/session/{session_id}', + summary='删除会话', + description='删除指定会话', + response_model=ResponseBaseModel, +) +@Log(title='AI对话会话管理', business_type=BusinessType.DELETE) +async def delete_chat_session( + request: Request, + session_id: Annotated[str, Path(description='会话ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_chat_session_result = await AiChatService.delete_chat_session_services(session_id) + logger.info(delete_chat_session_result.message) + + return ResponseUtil.success(msg=delete_chat_session_result.message) + + +@ai_chat_controller.get( + '/session/{session_id}', + summary='获取会话消息详情', + description='获取指定会话的消息详情', + response_model=DataResponseModel[AiChatSessionModel], +) +async def get_chat_session_detail( + request: Request, + session_id: Annotated[str, Path(description='会话ID')], +) -> Response: + chat_session_detail_result = await AiChatService.get_chat_session_detail_services(session_id) + logger.info(f'获取session_id为{session_id}的信息成功') + + return ResponseUtil.success(data=chat_session_detail_result) + + +@ai_chat_controller.post( + '/cancel', + summary='取消对话', + description='取消正在进行的对话', + response_model=ResponseBaseModel, +) +@ApiRateLimit(namespace=ApiNamespace.AI_CHAT_CANCEL, preset=ApiRateLimitPreset.USER_INTERACTIVE_HIGH_FREQ) +async def cancel_chat_run( + request: Request, + run_id: Annotated[str, Body(embed=True, description='运行ID', alias='runId')], +) -> Response: + cancel_result = await AiChatService.cancel_run_services(run_id) + logger.info(cancel_result.message) + + return ResponseUtil.success(msg=cancel_result.message) diff --git a/shierfeng-fastapi-backend/module_ai/controller/ai_model_controller.py b/shierfeng-fastapi-backend/module_ai/controller/ai_model_controller.py new file mode 100644 index 0000000..60292ab --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/controller/ai_model_controller.py @@ -0,0 +1,188 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from pydantic_validation_decorator import ValidateFields +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log, RequestLogFieldRoot +from common.aspect.data_scope import DataScopeDependency +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_ai.entity.do.ai_model_do import AiModels +from module_ai.entity.vo.ai_model_vo import AiModelModel, AiModelPageQueryModel, DeleteAiModelModel +from module_ai.service.ai_model_service import AiModelService +from utils.log_util import logger +from utils.response_util import ResponseUtil + +ai_model_controller = APIRouterPro( + prefix='/ai/model', order_num=18, tags=['AI管理-模型管理'], dependencies=[PreAuthDependency()] +) + + +@ai_model_controller.get( + '/list', + summary='获取AI模型分页列表接口', + description='用于获取AI模型分页列表', + response_model=PageResponseModel[AiModelModel], + dependencies=[UserInterfaceAuthDependency('ai:model:list')], +) +@ApiCache(namespace=ApiNamespace.AI_MODEL_LIST) +async def get_ai_model_list( + request: Request, + ai_model_page_query: Annotated[AiModelPageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(AiModels)], +) -> Response: + # 获取分页数据 + result = await AiModelService.get_ai_model_list_services( + query_db, ai_model_page_query, data_scope_sql, is_page=True + ) + logger.info('获取成功') + + return ResponseUtil.success(model_content=result) + + +@ai_model_controller.get( + '/all', + summary='获取AI模型不分页列表接口', + description='用于获取AI模型不分页列表', + response_model=DataResponseModel[AiModelModel], +) +@ApiCache(namespace=ApiNamespace.AI_MODEL_ALL) +async def get_ai_model_all( + request: Request, + query_db: Annotated[AsyncSession, DBSessionDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(AiModels)], +) -> Response: + # 获取不分页数据 + ai_model_page_query = AiModelPageQueryModel(status='0') + result = await AiModelService.get_ai_model_list_services( + query_db, ai_model_page_query, data_scope_sql, is_page=False + ) + logger.info('获取成功') + + return ResponseUtil.success(data=result) + + +@ai_model_controller.post( + '', + summary='新增AI模型接口', + description='用于新增AI模型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('ai:model:add')], +) +@ValidateFields(validate_model='add_ai_model') +@ApiCacheEvict(namespaces=ApiGroup.AI_MODEL_MUTATION) +@Log( + title='AI模型管理', + business_type=BusinessType.INSERT, + request_log_mode='exclude', + request_exclude_fields=(RequestLogFieldRoot.JSON_BODY.field('api_key'),), +) +async def add_ai_model( + request: Request, + add_ai_model: AiModelModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + add_ai_model.user_id = current_user.user.user_id + add_ai_model.dept_id = current_user.user.dept_id + add_ai_model.create_by = current_user.user.user_name + add_ai_model.create_time = datetime.now() + add_ai_model.update_by = current_user.user.user_name + add_ai_model.update_time = datetime.now() + add_ai_model_result = await AiModelService.add_ai_model_services(query_db, add_ai_model) + logger.info(add_ai_model_result.message) + + return ResponseUtil.success(msg=add_ai_model_result.message) + + +@ai_model_controller.put( + '', + summary='编辑AI模型接口', + description='用于编辑AI模型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('ai:model:edit')], +) +@ValidateFields(validate_model='edit_ai_model') +@ApiCacheEvict(namespaces=ApiGroup.AI_MODEL_MUTATION) +@Log( + title='AI模型管理', + business_type=BusinessType.UPDATE, + request_log_mode='exclude', + request_exclude_fields=(RequestLogFieldRoot.JSON_BODY.field('api_key'),), +) +async def edit_ai_model( + request: Request, + edit_ai_model: AiModelModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(AiModels)], +) -> Response: + if not current_user.user.admin: + await AiModelService.check_ai_model_data_scope_services(query_db, edit_ai_model.model_id, data_scope_sql) + edit_ai_model.update_by = current_user.user.user_name + edit_ai_model.update_time = datetime.now() + edit_ai_model_result = await AiModelService.edit_ai_model_services(query_db, edit_ai_model) + logger.info(edit_ai_model_result.message) + + return ResponseUtil.success(msg=edit_ai_model_result.message) + + +@ai_model_controller.delete( + '/{model_ids}', + summary='删除AI模型接口', + description='用于删除AI模型', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('ai:model:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.AI_MODEL_MUTATION) +@Log(title='AI模型管理', business_type=BusinessType.DELETE) +async def delete_ai_model( + request: Request, + model_ids: Annotated[str, Path(description='需要删除的模型ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(AiModels)], +) -> Response: + model_id_list = model_ids.split(',') + for model_id in model_id_list: + if not current_user.user.admin: + await AiModelService.check_ai_model_data_scope_services(query_db, int(model_id), data_scope_sql) + delete_ai_model = DeleteAiModelModel(modelIds=model_ids) + delete_ai_model_result = await AiModelService.delete_ai_model_services(query_db, delete_ai_model) + logger.info(delete_ai_model_result.message) + + return ResponseUtil.success(msg=delete_ai_model_result.message) + + +@ai_model_controller.get( + '/{model_id}', + summary='获取AI模型详情接口', + description='用于获取指定AI模型的详细信息', + response_model=DataResponseModel[AiModelModel], + dependencies=[UserInterfaceAuthDependency('ai:model:query')], +) +@ApiCache(namespace=ApiNamespace.AI_MODEL_DETAIL) +async def get_ai_model_detail( + request: Request, + model_id: Annotated[int, Path(description='模型ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], + data_scope_sql: Annotated[ColumnElement, DataScopeDependency(AiModels)], +) -> Response: + if not current_user.user.admin: + await AiModelService.check_ai_model_data_scope_services(query_db, model_id, data_scope_sql) + ai_model_detail_result = await AiModelService.ai_model_detail_services(query_db, model_id) + logger.info(f'获取model_id为{model_id}的信息成功') + + return ResponseUtil.success(data=ai_model_detail_result) diff --git a/shierfeng-fastapi-backend/module_ai/dao/ai_chat_dao.py b/shierfeng-fastapi-backend/module_ai/dao/ai_chat_dao.py new file mode 100644 index 0000000..b7677e1 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/dao/ai_chat_dao.py @@ -0,0 +1,52 @@ +from sqlalchemy import select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from module_ai.entity.do.ai_chat_do import AiChatConfig +from module_ai.entity.vo.ai_chat_vo import AiChatConfigModel + + +class AiChatConfigDao: + """ + AI对话配置数据库操作层 + """ + + @classmethod + async def get_chat_config_detail_by_user_id(cls, db: AsyncSession, user_id: int) -> AiChatConfig | None: + """ + 根据用户ID获取配置 + + :param db: orm对象 + :param user_id: 用户ID + :return: 配置对象 + """ + ai_chat_config = ( + (await db.execute(select(AiChatConfig).where(AiChatConfig.user_id == user_id))).scalars().first() + ) + + return ai_chat_config + + @classmethod + async def add_chat_config_dao(cls, db: AsyncSession, chat_config: AiChatConfigModel) -> AiChatConfig: + """ + 新增对话配置数据库操作 + + :param db: orm对象 + :param chat_config: 对话配置对象 + :return: 配置对象 + """ + db_chat_config = AiChatConfig(**chat_config.model_dump(exclude_unset=True)) + db.add(db_chat_config) + await db.flush() + + return db_chat_config + + @classmethod + async def edit_chat_config_dao(cls, db: AsyncSession, chat_config: dict) -> None: + """ + 编辑对话配置数据库操作 + + :param db: orm对象 + :param chat_config: 需要更新的对话配置字典 + :return: + """ + await db.execute(update(AiChatConfig), [chat_config]) diff --git a/shierfeng-fastapi-backend/module_ai/dao/ai_model_dao.py b/shierfeng-fastapi-backend/module_ai/dao/ai_model_dao.py new file mode 100644 index 0000000..60aa59f --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/dao/ai_model_dao.py @@ -0,0 +1,96 @@ +from typing import Any + +from sqlalchemy import ColumnElement, delete, select, update +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from module_ai.entity.do.ai_model_do import AiModels +from module_ai.entity.vo.ai_model_vo import AiModelModel, AiModelPageQueryModel +from utils.page_util import PageUtil + + +class AiModelDao: + """ + AI模型管理数据库操作层 + """ + + @classmethod + async def get_ai_model_detail_by_id(cls, db: AsyncSession, model_id: int) -> AiModels | None: + """ + 根据AI模型id获取AI模型详细信息 + + :param db: orm对象 + :param model_id: AI模型id + :return: AI模型信息对象 + """ + ai_model_info = (await db.execute(select(AiModels).where(AiModels.model_id == model_id))).scalars().first() + + return ai_model_info + + @classmethod + async def get_ai_model_list( + cls, db: AsyncSession, query_object: AiModelPageQueryModel, data_scope_sql: ColumnElement, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取AI模型列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: AI模型列表信息对象 + """ + query = ( + select(AiModels) + .where( + AiModels.model_id == query_object.model_id if query_object.model_id else True, + AiModels.model_name.like(f'%{query_object.model_name}%') if query_object.model_name else True, + AiModels.model_code.like(f'%{query_object.model_code}%') if query_object.model_code else True, + AiModels.provider == query_object.provider if query_object.provider else True, + AiModels.status == query_object.status if query_object.status else True, + data_scope_sql, + ) + .order_by(AiModels.model_sort) + ) + ai_model_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return ai_model_list + + @classmethod + async def add_ai_model_dao(cls, db: AsyncSession, ai_model: AiModelModel) -> AiModels: + """ + 新增AI模型数据库操作 + + :param db: orm对象 + :param ai_model: AI模型对象 + :return: AI模型信息对象 + """ + db_model = AiModels(**ai_model.model_dump(exclude_unset=True)) + db.add(db_model) + await db.flush() + + return db_model + + @classmethod + async def edit_ai_model_dao(cls, db: AsyncSession, ai_model: dict) -> None: + """ + 编辑AI模型数据库操作 + + :param db: orm对象 + :param ai_model: 需要更新的AI模型字典 + :return: + """ + await db.execute(update(AiModels), [ai_model]) + + @classmethod + async def delete_ai_model_dao(cls, db: AsyncSession, ai_model: AiModelModel) -> None: + """ + 删除AI模型数据库操作 + + :param db: orm对象 + :param ai_model: AI模型对象 + :return: + """ + await db.execute(delete(AiModels).where(AiModels.model_id.in_([ai_model.model_id]))) diff --git a/shierfeng-fastapi-backend/module_ai/entity/do/ai_chat_do.py b/shierfeng-fastapi-backend/module_ai/entity/do/ai_chat_do.py new file mode 100644 index 0000000..a07584a --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/entity/do/ai_chat_do.py @@ -0,0 +1,26 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Float, Integer, Text + +from config.database import Base + + +class AiChatConfig(Base): + """ + AI对话配置表 + """ + + __tablename__ = 'ai_chat_config' + __table_args__ = {'comment': 'AI对话配置表'} + + chat_config_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='配置主键') + user_id = Column(BigInteger, nullable=False, unique=True, comment='用户ID') + temperature = Column(Float, nullable=True, comment='默认温度') + add_history_to_context = Column(CHAR(1), server_default='0', comment='是否添加历史记录(0是, 1否)') + num_history_runs = Column(Integer, nullable=True, comment='历史记录条数') + system_prompt = Column(Text, nullable=True, comment='系统提示词') + metrics_default_visible = Column(CHAR(1), server_default='0', comment='默认显示指标(0是, 1否)') + vision_enabled = Column(CHAR(1), server_default='1', comment='是否开启视觉(0是, 1否)') + image_max_size_mb = Column(Integer, nullable=True, comment='图片最大大小(MB)') + create_time = Column(DateTime, nullable=True, default=datetime.now, comment='创建时间') + update_time = Column(DateTime, nullable=True, default=datetime.now, comment='更新时间') diff --git a/shierfeng-fastapi-backend/module_ai/entity/do/ai_model_do.py b/shierfeng-fastapi-backend/module_ai/entity/do/ai_model_do.py new file mode 100644 index 0000000..c13c279 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/entity/do/ai_model_do.py @@ -0,0 +1,62 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Float, Integer, String + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class AiModels(Base): + """ + AI模型表 + """ + + __tablename__ = 'ai_models' + __table_args__ = {'comment': 'AI模型表'} + + model_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='模型主键') + model_code = Column(String(100), nullable=False, comment='模型编码') + model_name = Column( + String(100), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='模型名称', + ) + provider = Column(String(50), nullable=False, comment='提供商') + model_sort = Column(Integer, nullable=False, comment='显示顺序') + api_key = Column( + String(255), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='API Key', + ) + base_url = Column( + String(255), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='Base URL', + ) + model_type = Column( + String(50), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='模型类型', + ) + max_tokens = Column(Integer, nullable=True, comment='最大输出token') + temperature = Column(Float, nullable=True, comment='默认温度') + support_reasoning = Column(CHAR(1), server_default='N', comment='是否支持推理') + support_images = Column(CHAR(1), server_default='N', comment='是否支持图片') + status = Column(CHAR(1), server_default='0', comment='模型状态') + user_id = Column(BigInteger, nullable=True, comment='用户ID') + dept_id = Column(BigInteger, nullable=True, comment='部门ID') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) diff --git a/shierfeng-fastapi-backend/module_ai/entity/vo/ai_chat_vo.py b/shierfeng-fastapi-backend/module_ai/entity/vo/ai_chat_vo.py new file mode 100644 index 0000000..e9d95c3 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/entity/vo/ai_chat_vo.py @@ -0,0 +1,159 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel + + +class AiChatRequestModel(BaseModel): + """ + AI对话请求模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + session_id: str | None = Field(default=None, description='会话ID') + model_id: int = Field(description='模型ID') + message: str = Field(description='用户消息') + is_reasoning: bool | None = Field(default=None, description='本次是否开启深度思考') + images: list[str] | None = Field(default=None, description='图片URL列表') + + +class AiChatConfigModel(BaseModel): + """ + AI对话配置模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + chat_config_id: int | None = Field(default=None, description='配置主键') + user_id: int | None = Field(default=None, description='用户ID') + temperature: float | None = Field(default=None, description='默认温度') + add_history_to_context: Literal['0', '1'] | None = Field(default=None, description='是否添加历史记录') + num_history_runs: int | None = Field(default=3, description='历史记录条数') + system_prompt: str | None = Field(default=None, description='系统提示词') + metrics_default_visible: Literal['0', '1'] | None = Field(default=None, description='默认显示指标') + vision_enabled: Literal['0', '1'] | None = Field(default=None, description='是否开启视觉') + image_max_size_mb: int | None = Field(default=None, description='图片最大大小(MB)') + create_time: datetime | None = Field(default=None, description='创建时间') + update_time: datetime | None = Field(default=None, description='更新时间') + + +class AiChatSessionBaseModel(BaseModel): + """ + AI对话会话基础模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + session_id: str = Field(description='会话ID') + session_title: str | None = Field(default=None, description='会话标题') + session_type: str | None = Field(default=None, description='会话类型') + user_id: str | None = Field(default=None, description='用户ID') + created_at: datetime | None = Field(default=None, description='创建时间') + updated_at: datetime | None = Field(default=None, description='更新时间') + + +class ModelInfoModel(BaseModel): + """ + 对话会话数据模型-模型信息模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + id: str | None = Field(default=None, description='模型ID') + name: str | None = Field(default=None, description='模型名称') + provider: str | None = Field(default=None, description='模型提供者') + temperature: float | None = Field(default=None, description='模型温度') + + +class AgentDataModel(BaseModel): + """ + 对话会话数据模型-智能体数据模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + model: ModelInfoModel | None = Field(default=None, description='模型信息') + agent_id: str | None = Field(default=None, description='智能体ID') + + +class SessionMetricsModel(BaseModel): + """ + 对话会话数据模型-会话指标模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + cost: float | None = Field(default=None, description='成本(元)') + timer: float | None = Field(default=None, description='运行时长(秒)') + duration: float | None = Field(default=None, description='运行时长(秒)') + input_tokens: int | None = Field(default=None, description='输入Token数量') + total_tokens: int | None = Field(default=None, description='总Token数量') + output_tokens: int | None = Field(default=None, description='输出Token数量') + provider_metrics: dict | None = Field(default=None, description='提供者指标') + reasoning_tokens: int | None = Field(default=None, description='推理Token数量') + cache_read_tokens: int | None = Field(default=None, description='缓存读取Token数量') + additional_metrics: dict | None = Field(default=None, description='其他指标') + audio_input_tokens: int | None = Field(default=None, description='音频输入Token数量') + audio_total_tokens: int | None = Field(default=None, description='音频总Token数量') + cache_write_tokens: int | None = Field(default=None, description='缓存写入Token数量') + audio_output_tokens: int | None = Field(default=None, description='音频输出Token数量') + time_to_first_token: float | None = Field(default=None, description='到第一个Token的时间(秒)') + + +class SessionDataModel(BaseModel): + """ + 对话会话数据模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + session_state: dict | None = Field(default=None, description='会话状态') + session_metrics: SessionMetricsModel | None = Field(default=None, description='会话指标') + + +class MessageMetrics(BaseModel): + """ + 对话消息模型-消息指标模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + input_tokens: int | None = Field(default=None, description='输入Token数量') + total_tokens: int | None = Field(default=None, description='总Token数量') + output_tokens: int | None = Field(default=None, description='输出Token数量') + reasoning_tokens: int | None = Field(default=None, description='推理Token数量') + duration: float | None = Field(default=None, description='运行时长(秒)') + time_to_first_token: float | None = Field(default=None, description='到第一个Token的时间(秒)') + + +class ChatMessageModel(BaseModel): + """ + 对话消息模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + id: str | None = Field(default=None, description='消息ID') + role: str | None = Field(default=None, description='角色') + content: str | None = Field(default=None, description='内容') + images: list[str] | None = Field(default=None, description='图片列表') + metrics: MessageMetrics | None = Field(default=None, description='Token使用统计') + created_at: datetime | None = Field(default=None, description='创建时间') + from_history: bool | None = Field(default=None, description='是否来自历史记录') + reasoning_content: str | None = Field(default=None, description='推理/思考内容') + stop_after_tool_call: bool | None = Field(default=None, description='是否在工具调用后停止') + + +class AiChatSessionModel(AiChatSessionBaseModel): + """ + AI对话会话模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + agent_id: str | None = Field(default=None, description='智能体ID') + session_data: SessionDataModel | None = Field(default=None, description='会话数据') + agent_data: AgentDataModel | None = Field(default=None, description='智能体数据') + messages: list[ChatMessageModel] | None = Field(default=None, description='消息列表') diff --git a/shierfeng-fastapi-backend/module_ai/entity/vo/ai_model_vo.py b/shierfeng-fastapi-backend/module_ai/entity/vo/ai_model_vo.py new file mode 100644 index 0000000..ffc3a19 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/entity/vo/ai_model_vo.py @@ -0,0 +1,64 @@ +from datetime import datetime +from typing import Literal + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank, Size + + +class AiModelModel(BaseModel): + """ + AI模型表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + model_id: int | None = Field(default=None, description='模型主键') + model_code: str | None = Field(default=None, description='模型编码') + model_name: str | None = Field(default=None, description='模型名称') + provider: str | None = Field(default=None, description='提供商') + model_sort: int | None = Field(default=None, description='显示顺序') + api_key: str | None = Field(default=None, description='API Key') + base_url: str | None = Field(default=None, description='Base URL') + max_tokens: int | None = Field(default=None, description='最大输出token') + temperature: float | None = Field(default=None, description='默认温度') + support_reasoning: Literal['Y', 'N'] | None = Field(default=None, description='是否支持推理(深度思考)') + support_images: Literal['Y', 'N'] | None = Field(default=None, description='是否支持图片') + model_type: str | None = Field(default=None, description='模型类型') + status: Literal['0', '1'] | None = Field(default=None, description='模型状态') + user_id: int | None = Field(default=None, description='用户ID') + dept_id: int | None = Field(default=None, description='部门ID') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='model_code', message='模型编码不能为空') + @Size(field_name='model_code', min_length=0, max_length=100, message='模型编码长度不能超过100个字符') + def get_model_code(self) -> str | None: + return self.model_code + + @NotBlank(field_name='base_url', message='Base URL不能为空') + @Size(field_name='base_url', min_length=0, max_length=255, message='Base URL长度不能超过255个字符') + def get_base_url(self) -> str | None: + return self.base_url + + +class AiModelPageQueryModel(AiModelModel): + """ + AI模型管理分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteAiModelModel(BaseModel): + """ + 删除AI模型模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + model_ids: str = Field(description='需要删除的模型主键') diff --git a/shierfeng-fastapi-backend/module_ai/service/ai_chat_service.py b/shierfeng-fastapi-backend/module_ai/service/ai_chat_service.py new file mode 100644 index 0000000..dfc5406 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/service/ai_chat_service.py @@ -0,0 +1,483 @@ +import json +import os +import uuid +from collections.abc import AsyncGenerator, AsyncIterator +from datetime import datetime +from typing import TYPE_CHECKING, Any + +from agno.agent import Agent +from agno.db.base import SessionType +from agno.media import Image +from agno.run.agent import RunEvent, RunOutput, RunOutputEvent +from agno.run.cancel import acancel_run +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import CrudResponseModel +from config.env import UploadConfig +from exceptions.exception import ServiceException +from module_ai.dao.ai_chat_dao import AiChatConfigDao +from module_ai.dao.ai_model_dao import AiModelDao +from module_ai.entity.do.ai_chat_do import AiChatConfig +from module_ai.entity.vo.ai_chat_vo import ( + AgentDataModel, + AiChatConfigModel, + AiChatRequestModel, + AiChatSessionBaseModel, + AiChatSessionModel, + ChatMessageModel, + MessageMetrics, + SessionDataModel, + SessionMetricsModel, +) +from module_ai.entity.vo.ai_model_vo import AiModelModel +from utils.ai_util import AiUtil +from utils.common_util import CamelCaseUtil +from utils.crypto_util import CryptoUtil + +if TYPE_CHECKING: + from agno.models.message import Message + from agno.run.team import TeamRunOutput + from agno.run.workflow import WorkflowRunOutput + from agno.session import Session + + +class AiChatService: + """ + AI对话服务层 + """ + + @classmethod + def _resolve_temperature(cls, user_config: AiChatConfigModel, model_config: AiModelModel) -> float: + """ + 解析温度配置,优先级为 用户配置 > 模型配置 + + :param user_config: 用户配置对象 + :param model_config: 模型配置对象 + :return: 解析后的温度值 + """ + temperature = user_config.temperature or model_config.temperature + return temperature + + @classmethod + def _resolve_is_reasoning(cls, chat_req: AiChatRequestModel, model_config: AiModelModel) -> bool: + """ + 解析深度思考开关,结合请求参数与模型配置确定最终是否开启 + + :param chat_req: 对话请求对象 + :param model_config: 模型配置对象 + :return: 是否开启深度思考 + """ + if model_config.support_reasoning != 'Y': + return False + return bool(chat_req.is_reasoning) + + @classmethod + def _resolve_history_config(cls, user_config: AiChatConfigModel) -> tuple[bool, int]: + """ + 解析历史消息配置,确定是否附带历史以及轮数 + + :param user_config: 用户配置对象 + :return: (是否附带历史, 历史轮数) + """ + add_history = user_config.add_history_to_context == '0' + num_history = user_config.num_history_runs or 3 + + return bool(add_history), int(num_history) + + @classmethod + def _build_agent( + cls, + model_config: AiModelModel, + temperature: float, + system_prompt: str | None, + user_id: int, + session_id: str, + add_history: bool, + num_history: int, + ) -> Agent: + """ + 构建对话Agent对象 + + :param model_config: 模型配置对象 + :param temperature: 对话温度 + :param system_prompt: 系统提示词 + :param user_id: 用户ID + :param session_id: 会话ID + :param add_history: 是否附带历史消息 + :param num_history: 历史消息轮数 + :return: Agent对象 + """ + real_api_key = CryptoUtil.decrypt(model_config.api_key) + + model = AiUtil.get_model_from_factory( + provider=model_config.provider, + model_code=model_config.model_code, + model_name=model_config.model_name, + api_key=real_api_key, + base_url=model_config.base_url, + temperature=temperature, + max_tokens=model_config.max_tokens, + ) + storage = AiUtil.get_storage_engine() + return Agent( + model=model, + id='chat-agent', + description=system_prompt or 'You are a helpful AI assistant.', + db=storage, + user_id=str(user_id), + session_id=session_id, + add_history_to_context=add_history, + num_history_runs=num_history, + markdown=True, + ) + + @classmethod + def _build_run_kwargs( + cls, + chat_req: AiChatRequestModel, + user_config: AiChatConfigModel, + ) -> dict[str, Any]: + """ + 构造Agent运行参数 + + :param chat_req: 对话请求对象 + :param user_config: 用户配置对象 + :return: 运行参数字典 + """ + run_kwargs: dict[str, Any] = {'stream': True, 'stream_events': True} + if not chat_req.images or not user_config.vision_enabled: + return run_kwargs + + processed_images: list[Image] = [] + for img in chat_req.images: + if img and img.startswith(UploadConfig.UPLOAD_PREFIX): + relative_path = img[len(UploadConfig.UPLOAD_PREFIX) :] + if relative_path.startswith('/'): + relative_path = relative_path[1:] + file_path = os.path.join(UploadConfig.UPLOAD_PATH, relative_path) + abs_path = os.path.abspath(file_path) + if os.path.exists(abs_path): + processed_images.append(Image(filepath=abs_path)) + run_kwargs['images'] = processed_images + return run_kwargs + + @classmethod + def _convert_images_to_upload_paths(cls, images: list[Image] | None) -> list[str] | None: + """ + 将Agno Image对象列表转换为前端可访问的上传路径列表 + + :param images: Image对象列表 + :return: 上传路径列表 + """ + if not images: + return None + + result = [] + for img in images: + # 如果是本地文件路径 + if hasattr(img, 'filepath') and img.filepath: + try: + # 使用 abspath 确保路径标准化 + abs_filepath = os.path.abspath(img.filepath) + abs_upload_path = os.path.abspath(UploadConfig.UPLOAD_PATH) + + if abs_filepath.startswith(abs_upload_path): + relative_path = os.path.relpath(abs_filepath, abs_upload_path) + # 转换路径分隔符为URL格式 + url_path = relative_path.replace(os.sep, '/') + # 拼接前缀 + full_url = f'{UploadConfig.UPLOAD_PREFIX}/{url_path}'.replace('//', '/') + result.append(full_url) + else: + result.append(img.filepath) + except Exception: + result.append(img.filepath) + # 如果是URL + elif hasattr(img, 'url') and img.url: + result.append(img.url) + + return result if result else None + + @classmethod + async def _stream_agent( + cls, + agent: Agent, + chat_req: AiChatRequestModel, + run_kwargs: dict[str, Any], + is_reasoning: bool, + session_id: str, + ) -> AsyncGenerator[str, None]: + """ + 将Agent输出流式转换为前端SSE消息 + + :param agent: Agent实例 + :param chat_req: 对话请求对象 + :param run_kwargs: 运行参数字典 + :param is_reasoning: 是否输出推理内容 + :param session_id: 会话ID + :return: SSE消息生成器 + """ + full_response = '' + full_reasoning = '' + try: + yield json.dumps({'session_id': session_id, 'type': 'meta'}) + '\n' + + response_stream: AsyncIterator[RunOutputEvent] = agent.arun(chat_req.message, **run_kwargs) + + async for chunk in response_stream: + content = None + reasoning = None + + if chunk.event == RunEvent.run_started and chunk.run_id: + yield json.dumps({'run_id': chunk.run_id, 'type': 'run_info'}) + '\n' + + if chunk.event == RunEvent.run_content: + content = chunk.content + if hasattr(chunk, 'reasoning_content') and chunk.reasoning_content: + reasoning = chunk.reasoning_content + + if reasoning and is_reasoning: + full_reasoning += reasoning + yield json.dumps({'content': reasoning, 'type': 'reasoning'}) + '\n' + + if chunk.event == RunEvent.run_completed and chunk.metrics: + yield ( + json.dumps( + {'metrics': CamelCaseUtil.transform_result(chunk.metrics.to_dict()), 'type': 'metrics'} + ) + + '\n' + ) + + if content: + full_response += content + yield json.dumps({'content': content, 'type': 'content'}) + '\n' + except Exception as e: + yield json.dumps({'error': str(e), 'type': 'error'}) + '\n' + + @classmethod + async def chat_services( + cls, query_db: AsyncSession, chat_req: AiChatRequestModel, user_id: int + ) -> AsyncGenerator[str, None]: + """ + 流式对话 + + :param query_db: orm对象 + :param chat_req: 对话请求对象 + :param user_id: 用户ID + :return: 对话响应流 + """ + ai_model = await AiModelDao.get_ai_model_detail_by_id(query_db, chat_req.model_id) + model_config = AiModelModel(**CamelCaseUtil.transform_result(ai_model)) if ai_model else AiModelModel() + if not model_config: + raise ServiceException(message='模型不存在') + + user_config = await cls.ai_chat_config_detail_services(query_db, user_id) + + session_id = chat_req.session_id + if not session_id: + session_id = str(uuid.uuid4()) + + temperature = cls._resolve_temperature(user_config, model_config) + is_reasoning = cls._resolve_is_reasoning(chat_req, model_config) + add_history, num_history = cls._resolve_history_config(user_config) + system_prompt = user_config.system_prompt + + agent = cls._build_agent( + model_config=model_config, + temperature=temperature, + system_prompt=system_prompt, + user_id=user_id, + session_id=session_id, + add_history=add_history, + num_history=num_history, + ) + run_kwargs = cls._build_run_kwargs(chat_req, user_config) + async for chunk in cls._stream_agent( + agent=agent, + chat_req=chat_req, + run_kwargs=run_kwargs, + is_reasoning=is_reasoning, + session_id=session_id, + ): + yield chunk + + @classmethod + async def ai_chat_config_detail_services(cls, query_db: AsyncSession, user_id: int) -> AiChatConfigModel: + """ + 获取用户配置 + + :param query_db: orm对象 + :param user_id: 用户ID + :return: 配置模型 + """ + chat_config = await AiChatConfigDao.get_chat_config_detail_by_user_id(query_db, user_id) + result = AiChatConfigModel(**CamelCaseUtil.transform_result(chat_config)) if chat_config else AiChatConfig() + + return result + + @classmethod + async def save_ai_chat_config_services( + cls, query_db: AsyncSession, user_id: int, page_object: AiChatConfigModel + ) -> CrudResponseModel: + """ + 保存用户配置 + + :param query_db: orm对象 + :param user_id: 用户ID + :param page_object: AI对话配置对象 + :return: 更新后的配置模型 + """ + chat_config = await AiChatConfigDao.get_chat_config_detail_by_user_id(query_db, user_id) + if page_object.user_id is None: + page_object.user_id = user_id + + try: + if chat_config: + if chat_config.chat_config_id != page_object.chat_config_id: + raise ServiceException(message='只允许修改当前用户的配置') + page_object.update_time = datetime.now() + edit_ai_chat_config = page_object.model_dump(exclude_unset=True) + await AiChatConfigDao.edit_chat_config_dao(query_db, edit_ai_chat_config) + else: + page_object.create_time = datetime.now() + await AiChatConfigDao.add_chat_config_dao(query_db, page_object) + + await query_db.commit() + except Exception as e: + await query_db.rollback() + raise e + + return CrudResponseModel(is_success=True, message='保存成功') + + @classmethod + async def get_chat_session_list_services(cls, user_id: int) -> list[AiChatSessionBaseModel]: + """ + 获取用户会话列表 + + :param user_id: 用户ID + :return: 用户会话列表 + """ + # 获取Agno会话列表 + storage = AiUtil.get_storage_engine() + sessions: list[Session] = await storage.get_sessions( + user_id=str(user_id), + component_id='chat-agent', + session_type=SessionType.AGENT, + ) + + result = [] + for s in sessions: + created_at = datetime.fromtimestamp(s.created_at) if s.created_at else None + updated_at = datetime.fromtimestamp(s.updated_at) if s.updated_at else None + + title_limit = 20 + session_title = s.runs[0].input.input_content[:title_limit] + '...' if s.runs else '' + + result.append( + AiChatSessionBaseModel( + sessionId=s.session_id, + sessionTitle=session_title if len(session_title) <= title_limit else session_title[:title_limit], + userId=s.user_id, + createdAt=created_at, + updatedAt=updated_at, + ) + ) + return result + + @classmethod + async def delete_chat_session_services(cls, session_id: str) -> CrudResponseModel: + """ + 删除会话 + + :param session_id: 会话ID + :return: 删除结果 + """ + storage = AiUtil.get_storage_engine() + delete_result = await storage.delete_session(session_id=session_id) + if not delete_result: + raise ServiceException(message='删除会话失败') + return CrudResponseModel(is_success=True, message='删除成功') + + @classmethod + async def get_chat_session_detail_services(cls, session_id: str) -> AiChatSessionModel: + """ + 获取会话消息详情 + + :param session_id: 会话ID + :return: 会话消息详情 + """ + storage = AiUtil.get_storage_engine() + session: Session | None = await storage.get_session(session_id=session_id, session_type=SessionType.AGENT) + + if not session: + raise ServiceException(message='会话不存在') + + session_data: dict[str, Any] = session.session_data + agent_data: dict[str, Any] = session.agent_data + runs: list[RunOutput | TeamRunOutput | WorkflowRunOutput] = session.runs + messages: list[Message] = session.get_messages(skip_roles=['system']) + + run_metrics_map = {} + if runs: + for run in runs: + if run.model_provider_data and (provider_id := run.model_provider_data.get('id')): + run_metrics_map[provider_id] = run.metrics + + chat_messages = [] + for m in messages: + if hasattr(m, 'provider_data') and m.provider_data: + provider_id = m.provider_data.get('id') + if provider_id and provider_id in run_metrics_map: + m.metrics = run_metrics_map[provider_id] + + metrics_model = None + if getattr(m, 'metrics', None) and hasattr(m.metrics, 'to_dict'): + metrics_dict = m.metrics.to_dict() + if metrics_dict: + metrics_model = MessageMetrics(**CamelCaseUtil.transform_result(metrics_dict)) + + chat_messages.append( + ChatMessageModel( + id=m.id, + role=m.role, + content=m.content, + images=cls._convert_images_to_upload_paths(m.images), + metrics=metrics_model, + createdAt=datetime.fromtimestamp(m.created_at) if m.created_at else None, + reasoningContent=m.reasoning_content, + fromHistory=m.from_history, + stopAfterToolCall=m.stop_after_tool_call, + ) + ) + + session_detail = AiChatSessionModel( + sessionId=session.session_id, + sessionTitle=session.runs[0].input.input_content[:20] + '...' if session.runs else '', + userId=session.user_id, + createdAt=datetime.fromtimestamp(session.created_at) if session.created_at else None, + updatedAt=datetime.fromtimestamp(session.updated_at) if session.updated_at else None, + agentId=session.agent_id, + sessionData=SessionDataModel( + sessionState=session_data.get('session_state'), + sessionMetrics=SessionMetricsModel( + **CamelCaseUtil.transform_result(session_data.get('session_metrics')) + ), + ), + agentData=AgentDataModel(**CamelCaseUtil.transform_result(agent_data)), + messages=chat_messages, + ) + + return session_detail + + @classmethod + async def cancel_run_services(cls, run_id: str) -> CrudResponseModel: + """ + 取消运行 + + :param run_id: 运行ID + :return: 取消结果 + """ + cancel_result = await acancel_run(run_id) + if not cancel_result: + raise ServiceException(message='取消运行失败') + return CrudResponseModel(is_success=True, message='取消成功') diff --git a/shierfeng-fastapi-backend/module_ai/service/ai_model_service.py b/shierfeng-fastapi-backend/module_ai/service/ai_model_service.py new file mode 100644 index 0000000..15fc608 --- /dev/null +++ b/shierfeng-fastapi-backend/module_ai/service/ai_model_service.py @@ -0,0 +1,155 @@ +from typing import Any + +from sqlalchemy import ColumnElement +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from module_ai.dao.ai_model_dao import AiModelDao +from module_ai.entity.vo.ai_model_vo import AiModelModel, AiModelPageQueryModel, DeleteAiModelModel +from utils.common_util import CamelCaseUtil +from utils.crypto_util import CryptoUtil + + +class AiModelService: + """ + AI模型管理服务层 + """ + + @classmethod + async def get_ai_model_list_services( + cls, + query_db: AsyncSession, + query_object: AiModelPageQueryModel, + data_scope_sql: ColumnElement, + is_page: bool = False, + ) -> PageModel | list[dict[str, Any]]: + """ + 获取AI模型列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param data_scope_sql: 数据权限对应的查询sql语句 + :param is_page: 是否开启分页 + :return: AI模型列表信息对象 + """ + ai_model_list_result = await AiModelDao.get_ai_model_list(query_db, query_object, data_scope_sql, is_page) + rows = ai_model_list_result.rows if isinstance(ai_model_list_result, PageModel) else ai_model_list_result + + for row in rows: + if 'apiKey' in row: + row['apiKey'] = '********' * 3 + + return ai_model_list_result + + @classmethod + async def check_ai_model_data_scope_services( + cls, + query_db: AsyncSession, + model_id: int, + data_scope_sql: ColumnElement, + ) -> CrudResponseModel: + """ + 校验用户是否有AI模型数据权限service + + :param query_db: orm对象 + :param model_id: 模型主键 + :param data_scope_sql: 数据权限对应的查询sql语句 + :return: 校验结果 + """ + ai_models = await AiModelDao.get_ai_model_list( + query_db, AiModelModel(modelId=model_id), data_scope_sql, is_page=False + ) + if ai_models: + return CrudResponseModel(is_success=True, message='校验通过') + raise ServiceException(message='没有权限访问AI模型数据') + + @classmethod + async def add_ai_model_services(cls, query_db: AsyncSession, page_object: AiModelModel) -> CrudResponseModel: + """ + 新增AI模型信息service + + :param request: Request对象 + :param query_db: orm对象 + :param page_object: 新增AI模型对象 + :return: 新增AI模型校验结果 + """ + try: + if page_object.api_key: + page_object.api_key = CryptoUtil.encrypt(page_object.api_key) + await AiModelDao.add_ai_model_dao(query_db, page_object) + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_ai_model_services(cls, query_db: AsyncSession, page_object: AiModelModel) -> CrudResponseModel: + """ + 编辑AI模型信息service + + :param query_db: orm对象 + :param page_object: 编辑AI模型对象 + :return: 编辑AI模型校验结果 + """ + edit_ai_model = page_object.model_dump(exclude_unset=True) + if page_object.api_key: + if page_object.api_key == '********' * 3: + if 'api_key' in edit_ai_model: + del edit_ai_model['api_key'] + else: + edit_ai_model['api_key'] = CryptoUtil.encrypt(page_object.api_key) + + ai_model_info = await cls.ai_model_detail_services(query_db, page_object.model_id) + if ai_model_info.model_id: + try: + await AiModelDao.edit_ai_model_dao(query_db, edit_ai_model) + await query_db.commit() + return CrudResponseModel(is_success=True, message='修改成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='AI模型不存在') + + @classmethod + async def delete_ai_model_services( + cls, query_db: AsyncSession, page_object: DeleteAiModelModel + ) -> CrudResponseModel: + """ + 删除AI模型信息service + + :param query_db: orm对象 + :param page_object: 删除AI模型对象 + :return: 删除AI模型校验结果 + """ + if page_object.model_ids: + model_id_list = page_object.model_ids.split(',') + try: + for model_id in model_id_list: + await AiModelDao.delete_ai_model_dao(query_db, AiModelModel(modelId=model_id)) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入AI模型id为空') + + @classmethod + async def ai_model_detail_services(cls, query_db: AsyncSession, model_id: int) -> AiModelModel: + """ + 获取AI模型详细信息service + + :param query_db: orm对象 + :param model_id: AI模型id + :return: AI模型id对应的信息 + """ + ai_model = await AiModelDao.get_ai_model_detail_by_id(query_db, model_id=model_id) + result = AiModelModel(**CamelCaseUtil.transform_result(ai_model)) if ai_model else AiModelModel() + + if result.api_key: + result.api_key = '********' * 3 + + return result diff --git a/shierfeng-fastapi-backend/module_generator/controller/gen_controller.py b/shierfeng-fastapi-backend/module_generator/controller/gen_controller.py new file mode 100644 index 0000000..a62e82c --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/controller/gen_controller.py @@ -0,0 +1,297 @@ +from datetime import datetime +from typing import Annotated + +from fastapi import Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.cache_annotation import ApiCache, ApiCacheEvict +from common.annotation.log_annotation import Log +from common.annotation.rate_limit_annotation import ApiRateLimit, ApiRateLimitBypassConfig, ApiRateLimitPreset +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import RoleInterfaceAuthDependency, UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.constant import ApiGroup, ApiNamespace +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from config.env import GenConfig +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_generator.entity.vo.gen_vo import ( + DeleteGenTableModel, + EditGenTableModel, + GenTableDbRowModel, + GenTableDetailModel, + GenTablePageQueryModel, + GenTableRowModel, +) +from module_generator.service.gen_service import GenTableColumnService, GenTableService +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + +gen_controller = APIRouterPro(prefix='/tool/gen', order_num=17, tags=['代码生成'], dependencies=[PreAuthDependency()]) + + +@gen_controller.get( + '/list', + summary='获取代码生成表分页列表接口', + description='用于获取代码生成表分页列表', + response_model=PageResponseModel[GenTableRowModel], + dependencies=[UserInterfaceAuthDependency('tool:gen:list')], +) +@ApiCache(namespace=ApiNamespace.TOOL_GEN_LIST) +async def get_gen_table_list( + request: Request, + gen_page_query: Annotated[GenTablePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + gen_page_query_result = await GenTableService.get_gen_table_list_services(query_db, gen_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=gen_page_query_result) + + +@gen_controller.get( + '/db/list', + summary='获取数据库表分页列表接口', + description='用于获取数据库表分页列表', + response_model=PageResponseModel[GenTableDbRowModel], + dependencies=[UserInterfaceAuthDependency('tool:gen:list')], +) +@ApiCache(namespace=ApiNamespace.TOOL_GEN_DB_LIST) +async def get_gen_db_table_list( + request: Request, + gen_page_query: Annotated[GenTablePageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取分页数据 + gen_page_query_result = await GenTableService.get_gen_db_table_list_services(query_db, gen_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content=gen_page_query_result) + + +@gen_controller.post( + '/importTable', + summary='导入数据库表接口', + description='用于导入数据库表', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('tool:gen:import')], +) +@ApiRateLimit( + namespace=ApiNamespace.TOOL_GEN_IMPORT_TABLE, + preset=ApiRateLimitPreset.USER_RESOURCE_GENERATE, + bypass=ApiRateLimitBypassConfig(roles=('admin',)), +) +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='代码生成', business_type=BusinessType.IMPORT) +async def import_gen_table( + request: Request, + tables: Annotated[str, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + table_names = tables.split(',') if tables else [] + add_gen_table_list = await GenTableService.get_gen_db_table_list_by_name_services(query_db, table_names) + add_gen_table_result = await GenTableService.import_gen_table_services(query_db, add_gen_table_list, current_user) + logger.info(add_gen_table_result.message) + + return ResponseUtil.success(msg=add_gen_table_result.message) + + +@gen_controller.put( + '', + summary='编辑代码生成表接口', + description='用于编辑代码生成表', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('tool:gen:edit')], +) +@ValidateFields(validate_model='edit_gen_table') +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='代码生成', business_type=BusinessType.UPDATE) +async def edit_gen_table( + request: Request, + edit_gen_table: EditGenTableModel, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + edit_gen_table.update_by = current_user.user.user_name + edit_gen_table.update_time = datetime.now() + await GenTableService.validate_edit(edit_gen_table) + edit_gen_result = await GenTableService.edit_gen_table_services(query_db, edit_gen_table) + logger.info(edit_gen_result.message) + + return ResponseUtil.success(msg=edit_gen_result.message) + + +@gen_controller.delete( + '/{table_ids}', + summary='删除代码生成表接口', + description='用于删除代码生成表', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('tool:gen:remove')], +) +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='代码生成', business_type=BusinessType.DELETE) +async def delete_gen_table( + request: Request, + table_ids: Annotated[str, Path(description='需要删除的代码生成业务表ID')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_gen_table = DeleteGenTableModel(tableIds=table_ids) + delete_gen_table_result = await GenTableService.delete_gen_table_services(query_db, delete_gen_table) + logger.info(delete_gen_table_result.message) + + return ResponseUtil.success(msg=delete_gen_table_result.message) + + +@gen_controller.post( + '/createTable', + summary='创建数据库表接口', + description='用于创建数据库表', + response_model=ResponseBaseModel, + dependencies=[RoleInterfaceAuthDependency('admin')], +) +@ApiRateLimit( + namespace=ApiNamespace.TOOL_GEN_CREATE_TABLE, + preset=ApiRateLimitPreset.USER_RESOURCE_GENERATE, + bypass=ApiRateLimitBypassConfig(roles=('admin',)), +) +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='创建表', business_type=BusinessType.OTHER) +async def create_table( + request: Request, + sql: Annotated[str, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + create_table_result = await GenTableService.create_table_services(query_db, sql, current_user) + logger.info(create_table_result.message) + + return ResponseUtil.success(msg=create_table_result.message) + + +@gen_controller.get( + '/batchGenCode', + summary='生成代码文件接口', + description='用于生成代码文件', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回生成的代码文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('tool:gen:code')], +) +@ApiRateLimit( + namespace=ApiNamespace.TOOL_GEN_BATCH_GEN_CODE, + preset=ApiRateLimitPreset.USER_RESOURCE_DOWNLOAD, + bypass=ApiRateLimitBypassConfig(roles=('admin',)), +) +@Log(title='代码生成', business_type=BusinessType.GENCODE) +async def batch_gen_code( + request: Request, + tables: Annotated[str, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + table_names = tables.split(',') if tables else [] + batch_gen_code_result = await GenTableService.batch_gen_code_services(query_db, table_names) + logger.info('生成代码成功') + + return ResponseUtil.streaming(data=bytes2file_response(batch_gen_code_result)) + + +@gen_controller.get( + '/genCode/{table_name}', + summary='生成代码文件到本地接口', + description='用于生成代码文件到本地', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('tool:gen:code')], +) +@ApiRateLimit( + namespace=ApiNamespace.TOOL_GEN_GEN_CODE_LOCAL, + preset=ApiRateLimitPreset.USER_RESOURCE_GENERATE, + bypass=ApiRateLimitBypassConfig(roles=('admin',)), +) +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='代码生成', business_type=BusinessType.GENCODE) +async def gen_code_local( + request: Request, + table_name: Annotated[str, Path(description='表名称')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + if not GenConfig.allow_overwrite: + logger.error('【系统预设】不允许生成文件覆盖到本地') + return ResponseUtil.error('【系统预设】不允许生成文件覆盖到本地') + gen_code_local_result = await GenTableService.generate_code_services(query_db, table_name) + logger.info(gen_code_local_result.message) + + return ResponseUtil.success(msg=gen_code_local_result.message) + + +@gen_controller.get( + '/{table_id}', + summary='获取代码生成表详情接口', + description='用于获取指定代码生成表的详细信息', + response_model=DataResponseModel[GenTableDetailModel], + dependencies=[UserInterfaceAuthDependency('tool:gen:query')], +) +@ApiCache(namespace=ApiNamespace.TOOL_GEN_DETAIL) +async def query_detail_gen_table( + request: Request, + table_id: Annotated[int, Path(description='表编号')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + gen_table = await GenTableService.get_gen_table_by_id_services(query_db, table_id) + gen_tables = await GenTableService.get_gen_table_all_services(query_db) + gen_columns = await GenTableColumnService.get_gen_table_column_list_by_table_id_services(query_db, table_id) + gen_table_detail_result = {'info': gen_table, 'rows': gen_columns, 'tables': gen_tables} + logger.info(f'获取table_id为{table_id}的信息成功') + + return ResponseUtil.success(data=gen_table_detail_result) + + +@gen_controller.get( + '/preview/{table_id}', + summary='预览生成的代码接口', + description='用于预览指定代码生成表生成的代码', + response_model=DataResponseModel[dict[str, str]], + dependencies=[UserInterfaceAuthDependency('tool:gen:preview')], +) +@ApiCache(namespace=ApiNamespace.TOOL_GEN_PREVIEW) +async def preview_code( + request: Request, + table_id: Annotated[int, Path(description='表编号')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + preview_code_result = await GenTableService.preview_code_services(query_db, table_id) + logger.info('获取预览代码成功') + + return ResponseUtil.success(data=preview_code_result) + + +@gen_controller.get( + '/synchDb/{table_name}', + summary='同步数据库接口', + description='用于同步指定数据库信息到指定代码生成表', + response_model=DataResponseModel[str], + dependencies=[UserInterfaceAuthDependency('tool:gen:edit')], +) +@ApiRateLimit(namespace=ApiNamespace.TOOL_GEN_SYNC_DB, preset=ApiRateLimitPreset.USER_RESOURCE_SYNC) +@ApiCacheEvict(namespaces=ApiGroup.GEN_MUTATION) +@Log(title='代码生成', business_type=BusinessType.UPDATE) +async def sync_db( + request: Request, + table_name: Annotated[str, Path(description='表名称')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + sync_db_result = await GenTableService.sync_db_services(query_db, table_name) + logger.info(sync_db_result.message) + + return ResponseUtil.success(data=sync_db_result.message) diff --git a/shierfeng-fastapi-backend/module_generator/dao/gen_dao.py b/shierfeng-fastapi-backend/module_generator/dao/gen_dao.py new file mode 100644 index 0000000..f26c071 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/dao/gen_dao.py @@ -0,0 +1,404 @@ +from collections.abc import Sequence +from datetime import datetime, time +from typing import Any + +from sqlalchemy import Row, delete, func, select, text, update +from sqlalchemy.ext.asyncio import AsyncSession +from sqlalchemy.orm import selectinload +from sqlglot.expressions import Expression + +from common.vo import PageModel +from config.env import DataBaseConfig +from module_generator.entity.do.gen_do import GenTable, GenTableColumn +from module_generator.entity.vo.gen_vo import ( + GenTableBaseModel, + GenTableColumnBaseModel, + GenTableColumnModel, + GenTableModel, + GenTablePageQueryModel, +) +from utils.page_util import PageUtil + + +class GenTableDao: + """ + 代码生成业务表模块数据库操作层 + """ + + @classmethod + async def get_gen_table_by_id(cls, db: AsyncSession, table_id: int) -> GenTable | None: + """ + 根据业务表id获取需要生成的业务表信息 + + :param db: orm对象 + :param table_id: 业务表id + :return: 需要生成的业务表信息对象 + """ + gen_table_info = ( + ( + await db.execute( + select(GenTable).options(selectinload(GenTable.columns)).where(GenTable.table_id == table_id) + ) + ) + .scalars() + .first() + ) + + return gen_table_info + + @classmethod + async def get_gen_table_by_name(cls, db: AsyncSession, table_name: str) -> GenTable | None: + """ + 根据业务表名称获取需要生成的业务表信息 + + :param db: orm对象 + :param table_name: 业务表名称 + :return: 需要生成的业务表信息对象 + """ + gen_table_info = ( + ( + await db.execute( + select(GenTable).options(selectinload(GenTable.columns)).where(GenTable.table_name == table_name) + ) + ) + .scalars() + .first() + ) + + return gen_table_info + + @classmethod + async def get_gen_table_all(cls, db: AsyncSession) -> Sequence[GenTable]: + """ + 获取所有业务表信息 + + :param db: orm对象 + :return: 所有业务表信息 + """ + gen_table_all = (await db.execute(select(GenTable).options(selectinload(GenTable.columns)))).scalars().all() + + return gen_table_all + + @classmethod + async def create_table_by_sql_dao(cls, db: AsyncSession, sql_statements: list[Expression]) -> None: + """ + 根据sql语句创建表结构 + + :param db: orm对象 + :param sql_statements: sql语句的ast列表 + :return: + """ + for sql_statement in sql_statements: + sql = sql_statement.sql(dialect=DataBaseConfig.sqlglot_parse_dialect) + await db.execute(text(sql)) + + @classmethod + async def get_gen_table_list( + cls, db: AsyncSession, query_object: GenTablePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取代码生成业务表列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 代码生成业务表列表信息对象 + """ + query = ( + select(GenTable) + .options(selectinload(GenTable.columns)) + .where( + func.lower(GenTable.table_name).like(f'%{query_object.table_name.lower()}%') + if query_object.table_name + else True, + func.lower(GenTable.table_comment).like(f'%{query_object.table_comment.lower()}%') + if query_object.table_comment + else True, + GenTable.create_time.between( + datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_time and query_object.end_time + else True, + ) + .distinct() + ) + gen_table_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return gen_table_list + + @classmethod + async def get_gen_db_table_list( + cls, db: AsyncSession, query_object: GenTablePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取数据库列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 数据库列表信息对象 + """ + if DataBaseConfig.db_type == 'postgresql': + query_sql = """ + table_name as table_name, + table_comment as table_comment, + create_time as create_time, + update_time as update_time + from + list_table + where + table_name not like 'apscheduler_%' + and table_name not like 'gen_%' + and table_name not in (select table_name from gen_table) + """ + else: + query_sql = r""" + table_name as table_name, + table_comment as table_comment, + create_time as create_time, + update_time as update_time + from + information_schema.tables + where + table_schema = (select database()) + and table_name not like 'apscheduler\_%' + and table_name not like 'gen\_%' + and table_name not in (select table_name from gen_table) + """ + if query_object.table_name: + query_sql += """and lower(table_name) like lower(concat('%', :table_name, '%'))""" + if query_object.table_comment: + query_sql += """and lower(table_comment) like lower(concat('%', :table_comment, '%'))""" + if query_object.begin_time: + if DataBaseConfig.db_type == 'postgresql': + query_sql += """and create_time::date >= to_date(:begin_time, 'yyyy-MM-dd')""" + else: + query_sql += """and date_format(create_time, '%Y%m%d') >= date_format(:begin_time, '%Y%m%d')""" + if query_object.end_time: + if DataBaseConfig.db_type == 'postgresql': + query_sql += """and create_time::date <= to_date(:end_time, 'yyyy-MM-dd')""" + else: + query_sql += """and date_format(create_time, '%Y%m%d') >= date_format(:end_time, '%Y%m%d')""" + query_sql += """order by create_time desc""" + query = select( + text(query_sql).bindparams(**query_object.model_dump(exclude_none=True, exclude={'page_num', 'page_size'})) + ) + gen_db_table_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return gen_db_table_list + + @classmethod + async def get_gen_db_table_list_by_names(cls, db: AsyncSession, table_names: list[str]) -> Sequence[Row]: + """ + 根据业务表名称组获取数据库列表信息 + + :param db: orm对象 + :param table_names: 业务表名称组 + :return: 数据库列表信息对象 + """ + if DataBaseConfig.db_type == 'postgresql': + query_sql = """ + select + table_name as table_name, + table_comment as table_comment, + create_time as create_time, + update_time as update_time + from + list_table + where + table_name not like 'qrtz_%' + and table_name not like 'gen_%' + and table_name = any(:table_names) + """ + else: + query_sql = r""" + select + table_name as table_name, + table_comment as table_comment, + create_time as create_time, + update_time as update_time + from + information_schema.tables + where + table_name not like 'qrtz\_%' + and table_name not like 'gen\_%' + and table_schema = (select database()) + and table_name in :table_names + """ + query = text(query_sql).bindparams(table_names=tuple(table_names)) + gen_db_table_list = (await db.execute(query)).fetchall() + + return gen_db_table_list + + @classmethod + async def add_gen_table_dao(cls, db: AsyncSession, gen_table: GenTableModel) -> GenTable: + """ + 新增业务表数据库操作 + + :param db: orm对象 + :param gen_table: 业务表对象 + :return: + """ + db_gen_table = GenTable(**GenTableBaseModel(**gen_table.model_dump(by_alias=True)).model_dump()) + db.add(db_gen_table) + await db.flush() + + return db_gen_table + + @classmethod + async def edit_gen_table_dao(cls, db: AsyncSession, gen_table: dict) -> None: + """ + 编辑业务表数据库操作 + + :param db: orm对象 + :param gen_table: 需要更新的业务表字典 + :return: + """ + await db.execute(update(GenTable), [GenTableBaseModel(**gen_table).model_dump()]) + + @classmethod + async def delete_gen_table_dao(cls, db: AsyncSession, gen_table: GenTableModel) -> None: + """ + 删除业务表数据库操作 + + :param db: orm对象 + :param gen_table: 业务表对象 + :return: + """ + await db.execute(delete(GenTable).where(GenTable.table_id.in_([gen_table.table_id]))) + + +class GenTableColumnDao: + """ + 代码生成业务表字段模块数据库操作层 + """ + + @classmethod + async def get_gen_table_column_list_by_table_id(cls, db: AsyncSession, table_id: int) -> GenTableColumn: + """ + 根据业务表id获取需要生成的业务表字段列表信息 + + :param db: orm对象 + :param table_id: 业务表id + :return: 需要生成的业务表字段列表信息对象 + """ + gen_table_column_list = ( + ( + await db.execute( + select(GenTableColumn).where(GenTableColumn.table_id == table_id).order_by(GenTableColumn.sort) + ) + ) + .scalars() + .all() + ) + + return gen_table_column_list + + @classmethod + async def get_gen_db_table_columns_by_name(cls, db: AsyncSession, table_name: str) -> Sequence[Row]: + """ + 根据业务表名称获取业务表字段列表信息 + + :param db: orm对象 + :param table_name: 业务表名称 + :return: 业务表字段列表信息对象 + """ + if DataBaseConfig.db_type == 'postgresql': + query_sql = """ + select + column_name, is_required, is_pk, sort, column_comment, is_increment, column_type + from + list_column + where + table_name = :table_name + """ + else: + query_sql = """ + select + column_name as column_name, + case + when is_nullable = 'no' and column_key != 'PRI' then '1' + else '0' + end as is_required, + case + when column_key = 'PRI' then '1' + else '0' + end as is_pk, + ordinal_position as sort, + column_comment as column_comment, + case + when extra = 'auto_increment' then '1' + else '0' + end as is_increment, + column_type as column_type + from + information_schema.columns + where + table_schema = (select database()) + and table_name = :table_name + order by + ordinal_position + """ + query = text(query_sql).bindparams(table_name=table_name) + gen_db_table_columns = (await db.execute(query)).fetchall() + + return gen_db_table_columns + + @classmethod + async def add_gen_table_column_dao(cls, db: AsyncSession, gen_table_column: GenTableColumnModel) -> GenTableColumn: + """ + 新增业务表字段数据库操作 + + :param db: orm对象 + :param gen_table_column: 岗位对象 + :return: + """ + db_gen_table_column = GenTableColumn( + **GenTableColumnBaseModel(**gen_table_column.model_dump(by_alias=True)).model_dump() + ) + db.add(db_gen_table_column) + await db.flush() + + return db_gen_table_column + + @classmethod + async def edit_gen_table_column_dao(cls, db: AsyncSession, gen_table_column: dict) -> None: + """ + 编辑业务表字段数据库操作 + + :param db: orm对象 + :param gen_table_column: 需要更新的业务表字段字典 + :return: + """ + await db.execute(update(GenTableColumn), [GenTableColumnBaseModel(**gen_table_column).model_dump()]) + + @classmethod + async def delete_gen_table_column_by_table_id_dao( + cls, db: AsyncSession, gen_table_column: GenTableColumnModel + ) -> None: + """ + 通过业务表id删除业务表字段数据库操作 + + :param db: orm对象 + :param gen_table_column: 业务表字段对象 + :return: + """ + await db.execute(delete(GenTableColumn).where(GenTableColumn.table_id.in_([gen_table_column.table_id]))) + + @classmethod + async def delete_gen_table_column_by_column_id_dao( + cls, db: AsyncSession, gen_table_column: GenTableColumnModel + ) -> None: + """ + 通过业务字段id删除业务表字段数据库操作 + + :param db: orm对象 + :param post: 业务表字段对象 + :return: + """ + await db.execute(delete(GenTableColumn).where(GenTableColumn.column_id.in_([gen_table_column.column_id]))) diff --git a/shierfeng-fastapi-backend/module_generator/entity/do/gen_do.py b/shierfeng-fastapi-backend/module_generator/entity/do/gen_do.py new file mode 100644 index 0000000..90b25e0 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/entity/do/gen_do.py @@ -0,0 +1,106 @@ +from datetime import datetime + +from sqlalchemy import CHAR, BigInteger, Column, DateTime, Integer, String +from sqlalchemy.orm import foreign, relationship + +from config.database import Base +from config.env import DataBaseConfig +from utils.common_util import SqlalchemyUtil + + +class GenTable(Base): + """ + 代码生成业务表 + """ + + __tablename__ = 'gen_table' + __table_args__ = {'comment': '代码生成业务表'} + + table_id = Column(BigInteger, primary_key=True, nullable=False, autoincrement=True, comment='编号') + table_name = Column(String(200), nullable=True, server_default="''", comment='表名称') + table_comment = Column(String(500), nullable=True, server_default="''", comment='表描述') + sub_table_name = Column( + String(64), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='关联子表的表名', + ) + sub_table_fk_name = Column( + String(64), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='子表关联的外键名', + ) + class_name = Column(String(100), nullable=True, server_default="''", comment='实体类名称') + tpl_category = Column( + String(200), nullable=True, server_default='crud', comment='使用的模板(crud单表操作 tree树表操作)' + ) + tpl_web_type = Column( + String(30), nullable=True, server_default="''", comment='前端模板类型(element-ui模版 element-plus模版)' + ) + package_name = Column(String(100), nullable=True, comment='生成包路径') + module_name = Column(String(30), nullable=True, comment='生成模块名') + business_name = Column(String(30), nullable=True, comment='生成业务名') + function_name = Column(String(50), nullable=True, comment='生成功能名') + function_author = Column(String(50), nullable=True, comment='生成功能作者') + gen_type = Column(CHAR(1), nullable=True, server_default='0', comment='生成代码方式(0zip压缩包 1自定义路径)') + gen_path = Column(String(200), nullable=True, server_default='/', comment='生成路径(不填默认项目路径)') + options = Column(String(1000), nullable=True, comment='其它生成选项') + create_by = Column(String(64), nullable=True, server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), nullable=True, server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + remark = Column( + String(500), + nullable=True, + server_default=SqlalchemyUtil.get_server_default_null(DataBaseConfig.db_type), + comment='备注', + ) + + columns = relationship( + 'GenTableColumn', + primaryjoin=lambda: GenTable.table_id == foreign(GenTableColumn.table_id), + order_by='GenTableColumn.sort', + back_populates='tables', + ) + + +class GenTableColumn(Base): + """ + 代码生成业务表字段 + """ + + __tablename__ = 'gen_table_column' + __table_args__ = {'comment': '代码生成业务表字段'} + + column_id = Column(BigInteger, primary_key=True, autoincrement=True, nullable=False, comment='编号') + table_id = Column(BigInteger, nullable=True, comment='归属表编号') + column_name = Column(String(200), nullable=True, comment='列名称') + column_comment = Column(String(500), nullable=True, comment='列描述') + column_type = Column(String(100), nullable=True, comment='列类型') + python_type = Column(String(500), nullable=True, comment='PYTHON类型') + python_field = Column(String(200), nullable=True, comment='PYTHON字段名') + is_pk = Column(CHAR(1), nullable=True, comment='是否主键(1是)') + is_increment = Column(CHAR(1), nullable=True, comment='是否自增(1是)') + is_required = Column(CHAR(1), nullable=True, comment='是否必填(1是)') + is_unique = Column(CHAR(1), nullable=True, comment='是否唯一(1是)') + is_insert = Column(CHAR(1), nullable=True, comment='是否为插入字段(1是)') + is_edit = Column(CHAR(1), nullable=True, comment='是否编辑字段(1是)') + is_list = Column(CHAR(1), nullable=True, comment='是否列表字段(1是)') + is_query = Column(CHAR(1), nullable=True, comment='是否查询字段(1是)') + query_type = Column( + String(200), nullable=True, server_default='EQ', comment='查询方式(等于、不等于、大于、小于、范围)' + ) + html_type = Column( + String(200), nullable=True, comment='显示类型(文本框、文本域、下拉框、复选框、单选框、日期控件)' + ) + dict_type = Column(String(200), nullable=True, server_default="''", comment='字典类型') + sort = Column(Integer, nullable=True, comment='排序') + create_by = Column(String(64), server_default="''", comment='创建者') + create_time = Column(DateTime, nullable=True, default=datetime.now(), comment='创建时间') + update_by = Column(String(64), server_default="''", comment='更新者') + update_time = Column(DateTime, nullable=True, default=datetime.now(), comment='更新时间') + + tables = relationship( + 'GenTable', primaryjoin=lambda: foreign(GenTableColumn.table_id) == GenTable.table_id, back_populates='columns' + ) diff --git a/shierfeng-fastapi-backend/module_generator/entity/vo/gen_vo.py b/shierfeng-fastapi-backend/module_generator/entity/vo/gen_vo.py new file mode 100644 index 0000000..2d655ba --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/entity/vo/gen_vo.py @@ -0,0 +1,294 @@ +from datetime import datetime +from typing import Literal, Optional + +from pydantic import BaseModel, ConfigDict, Field, model_validator +from pydantic.alias_generators import to_camel +from pydantic_validation_decorator import NotBlank + +from common.constant import GenConstant +from utils.string_util import StringUtil + + +class GenTableBaseModel(BaseModel): + """ + 代码生成业务表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + table_id: int | None = Field(default=None, description='编号') + table_name: str | None = Field(default=None, description='表名称') + table_comment: str | None = Field(default=None, description='表描述') + sub_table_name: str | None = Field(default=None, description='关联子表的表名') + sub_table_fk_name: str | None = Field(default=None, description='子表关联的外键名') + class_name: str | None = Field(default=None, description='实体类名称') + tpl_category: str | None = Field(default=None, description='使用的模板(crud单表操作 tree树表操作)') + tpl_web_type: str | None = Field(default=None, description='前端模板类型(element-ui模版 element-plus模版)') + package_name: str | None = Field(default=None, description='生成包路径') + module_name: str | None = Field(default=None, description='生成模块名') + business_name: str | None = Field(default=None, description='生成业务名') + function_name: str | None = Field(default=None, description='生成功能名') + function_author: str | None = Field(default=None, description='生成功能作者') + gen_type: Literal['0', '1'] | None = Field(default=None, description='生成代码方式(0zip压缩包 1自定义路径)') + gen_path: str | None = Field(default=None, description='生成路径(不填默认项目路径)') + options: str | None = Field(default=None, description='其它生成选项') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + remark: str | None = Field(default=None, description='备注') + + @NotBlank(field_name='table_name', message='表名称不能为空') + def get_table_name(self) -> str | None: + return self.table_name + + @NotBlank(field_name='table_comment', message='表描述不能为空') + def get_table_comment(self) -> str | None: + return self.table_comment + + @NotBlank(field_name='class_name', message='实体类名称不能为空') + def get_class_name(self) -> str | None: + return self.class_name + + @NotBlank(field_name='package_name', message='生成包路径不能为空') + def get_package_name(self) -> str | None: + return self.package_name + + @NotBlank(field_name='module_name', message='生成模块名不能为空') + def get_module_name(self) -> str | None: + return self.module_name + + @NotBlank(field_name='business_name', message='生成业务名不能为空') + def get_business_name(self) -> str | None: + return self.business_name + + @NotBlank(field_name='function_name', message='生成功能名不能为空') + def get_function_name(self) -> str | None: + return self.function_name + + @NotBlank(field_name='function_author', message='生成功能作者不能为空') + def get_function_author(self) -> str | None: + return self.function_author + + def validate_fields(self) -> None: + self.get_table_name() + self.get_table_comment() + self.get_class_name() + self.get_package_name() + self.get_module_name() + self.get_business_name() + self.get_function_name() + self.get_function_author() + + +class GenTableRowModel(GenTableBaseModel): + """ + 代码生成业务表行数据模型 + """ + + columns: list['GenTableColumnBaseModel'] | None = Field(default=None, description='表列信息') + + +class GenTableDbRowModel(BaseModel): + """ + 代码生成业务表数据库行数据模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + table_name: str | None = Field(default=None, description='表名称') + table_comment: str | None = Field(default=None, description='表描述') + create_time: datetime | None = Field(default=None, description='创建时间') + update_time: datetime | None = Field(default=None, description='更新时间') + + +class GenTableModel(GenTableBaseModel): + """ + 代码生成业务表模型 + """ + + pk_column: Optional['GenTableColumnModel'] = Field(default=None, description='主键信息') + sub_table: Optional['GenTableModel'] = Field(default=None, description='子表信息') + columns: list['GenTableColumnModel'] | None = Field(default=None, description='表列信息') + tree_code: str | None = Field(default=None, description='树编码字段') + tree_parent_code: str | None = Field(default=None, description='树父编码字段') + tree_name: str | None = Field(default=None, description='树名称字段') + parent_menu_id: int | None = Field(default=None, description='上级菜单ID字段') + parent_menu_name: str | None = Field(default=None, description='上级菜单名称字段') + sub: bool | None = Field(default=None, description='是否为子表') + tree: bool | None = Field(default=None, description='是否为树表') + crud: bool | None = Field(default=None, description='是否为单表') + + @model_validator(mode='after') + def check_some_is(self) -> 'GenTableModel': + self.sub = bool(self.tpl_category and self.tpl_category == GenConstant.TPL_SUB) + self.tree = bool(self.tpl_category and self.tpl_category == GenConstant.TPL_TREE) + self.crud = bool(self.tpl_category and self.tpl_category == GenConstant.TPL_CRUD) + return self + + +class EditGenTableModel(GenTableModel): + """ + 修改代码生成业务表模型 + """ + + params: Optional['GenTableParamsModel'] = Field(default=None, description='业务表参数') + + +class GenTableParamsModel(BaseModel): + """ + 代码生成业务表参数模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + tree_code: str | None = Field(default=None, description='树编码字段') + tree_parent_code: str | None = Field(default=None, description='树父编码字段') + tree_name: str | None = Field(default=None, description='树名称字段') + parent_menu_id: int | None = Field(default=None, description='上级菜单ID字段') + + +class GenTableQueryModel(GenTableBaseModel): + """ + 代码生成业务表不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class GenTablePageQueryModel(GenTableQueryModel): + """ + 代码生成业务表分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class GenTableDetailModel(BaseModel): + """ + 代码生成业务表详情模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + info: GenTableModel | None = Field(default=None, description='业务表信息') + rows: list['GenTableColumnModel'] | None = Field(default=None, description='表列信息') + tables: list['GenTableModel'] | None = Field(default=None, description='所有业务表信息') + + +class DeleteGenTableModel(BaseModel): + """ + 删除代码生成业务表模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + table_ids: str = Field(description='需要删除的代码生成业务表ID') + + +class GenTableColumnBaseModel(BaseModel): + """ + 代码生成业务表字段对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + column_id: int | None = Field(default=None, description='编号') + table_id: int | None = Field(default=None, description='归属表编号') + column_name: str | None = Field(default=None, description='列名称') + column_comment: str | None = Field(default=None, description='列描述') + column_type: str | None = Field(default=None, description='列类型') + python_type: str | None = Field(default=None, description='PYTHON类型') + python_field: str | None = Field(default=None, description='PYTHON字段名') + is_pk: str | None = Field(default=None, description='是否主键(1是)') + is_increment: str | None = Field(default=None, description='是否自增(1是)') + is_required: str | None = Field(default=None, description='是否必填(1是)') + is_unique: str | None = Field(default=None, description='是否唯一(1是)') + is_insert: str | None = Field(default=None, description='是否为插入字段(1是)') + is_edit: str | None = Field(default=None, description='是否编辑字段(1是)') + is_list: str | None = Field(default=None, description='是否列表字段(1是)') + is_query: str | None = Field(default=None, description='是否查询字段(1是)') + query_type: str | None = Field(default=None, description='查询方式(等于、不等于、大于、小于、范围)') + html_type: str | None = Field( + default=None, description='显示类型(文本框、文本域、下拉框、复选框、单选框、日期控件)' + ) + dict_type: str | None = Field(default=None, description='字典类型') + sort: int | None = Field(default=None, description='排序') + create_by: str | None = Field(default=None, description='创建者') + create_time: datetime | None = Field(default=None, description='创建时间') + update_by: str | None = Field(default=None, description='更新者') + update_time: datetime | None = Field(default=None, description='更新时间') + + @NotBlank(field_name='python_field', message='Python属性不能为空') + def get_python_field(self) -> str | None: + return self.python_field + + def validate_fields(self) -> None: + self.get_python_field() + + +class GenTableColumnModel(GenTableColumnBaseModel): + """ + 代码生成业务表字段模型 + """ + + cap_python_field: str | None = Field(default=None, description='字段大写形式') + pk: bool | None = Field(default=None, description='是否主键') + increment: bool | None = Field(default=None, description='是否自增') + required: bool | None = Field(default=None, description='是否必填') + unique: bool | None = Field(default=None, description='是否唯一') + insert: bool | None = Field(default=None, description='是否为插入字段') + edit: bool | None = Field(default=None, description='是否编辑字段') + list: bool | None = Field(default=None, description='是否列表字段') + query: bool | None = Field(default=None, description='是否查询字段') + super_column: bool | None = Field(default=None, description='是否为基类字段') + usable_column: bool | None = Field(default=None, description='是否为基类字段白名单') + + @model_validator(mode='after') + def check_some_is(self) -> 'GenTableModel': + self.cap_python_field = self.python_field[0].upper() + self.python_field[1:] if self.python_field else None + self.pk = self.is_pk and self.is_pk == '1' + self.increment = bool(self.is_increment and self.is_increment == '1') + self.required = bool(self.is_required and self.is_required == '1') + self.unique = bool(self.is_unique and self.is_unique == '1') + self.insert = bool(self.is_insert and self.is_insert == '1') + self.edit = bool(self.is_edit and self.is_edit == '1') + self.list = bool(self.is_list and self.is_list == '1') + self.query = bool(self.is_query and self.is_query == '1') + self.super_column = bool( + StringUtil.equals_any_ignore_case(self.python_field, GenConstant.TREE_ENTITY + GenConstant.BASE_ENTITY) + ) + self.usable_column = bool( + StringUtil.equals_any_ignore_case(self.python_field, ['parentId', 'orderNum', 'remark']) + ) + return self + + +class GenTableColumnQueryModel(GenTableColumnBaseModel): + """ + 代码生成业务表字段不分页查询模型 + """ + + begin_time: str | None = Field(default=None, description='开始时间') + end_time: str | None = Field(default=None, description='结束时间') + + +class GenTableColumnPageQueryModel(GenTableColumnQueryModel): + """ + 代码生成业务表字段分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class DeleteGenTableColumnModel(BaseModel): + """ + 删除代码生成业务表字段模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + column_ids: str = Field(description='需要删除的代码生成业务表字段ID') diff --git a/shierfeng-fastapi-backend/module_generator/service/gen_service.py b/shierfeng-fastapi-backend/module_generator/service/gen_service.py new file mode 100644 index 0000000..1ef9bc5 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/service/gen_service.py @@ -0,0 +1,506 @@ +import io +import json +import os +import zipfile +from datetime import datetime +from typing import Any + +import aiofiles +from sqlalchemy.ext.asyncio import AsyncSession +from sqlglot import parse as sqlglot_parse +from sqlglot.expressions import Add, Alter, Create, Delete, Drop, Expression, Insert, Table, TruncateTable, Update + +from common.constant import GenConstant +from common.vo import CrudResponseModel, PageModel +from config.env import DataBaseConfig, GenConfig +from exceptions.exception import ServiceException +from module_admin.entity.vo.user_vo import CurrentUserModel +from module_generator.dao.gen_dao import GenTableColumnDao, GenTableDao +from module_generator.entity.vo.gen_vo import ( + DeleteGenTableModel, + EditGenTableModel, + GenTableColumnModel, + GenTableModel, + GenTablePageQueryModel, +) +from utils.common_util import CamelCaseUtil +from utils.gen_util import GenUtils +from utils.template_util import TemplateInitializer, TemplateUtils + + +class GenTableService: + """ + 代码生成业务表服务层 + """ + + @classmethod + async def get_gen_table_list_services( + cls, query_db: AsyncSession, query_object: GenTablePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取代码生成业务表列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 代码生成业务列表信息对象 + """ + gen_table_list_result = await GenTableDao.get_gen_table_list(query_db, query_object, is_page) + + return gen_table_list_result + + @classmethod + async def get_gen_db_table_list_services( + cls, query_db: AsyncSession, query_object: GenTablePageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取数据库列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: 数据库列表信息对象 + """ + gen_db_table_list_result = await GenTableDao.get_gen_db_table_list(query_db, query_object, is_page) + + return gen_db_table_list_result + + @classmethod + async def get_gen_db_table_list_by_name_services( + cls, query_db: AsyncSession, table_names: list[str] + ) -> list[GenTableModel]: + """ + 根据表名称组获取数据库列表信息service + + :param query_db: orm对象 + :param table_names: 表名称组 + :return: 数据库列表信息对象 + """ + gen_db_table_list_result = await GenTableDao.get_gen_db_table_list_by_names(query_db, table_names) + + return [GenTableModel(**gen_table) for gen_table in CamelCaseUtil.transform_result(gen_db_table_list_result)] + + @classmethod + async def import_gen_table_services( + cls, query_db: AsyncSession, gen_table_list: list[GenTableModel], current_user: CurrentUserModel + ) -> CrudResponseModel: + """ + 导入表结构service + + :param query_db: orm对象 + :param gen_table_list: 导入表列表 + :param current_user: 当前用户信息对象 + :return: 导入结果 + """ + try: + for table in gen_table_list: + table_name = table.table_name + GenUtils.init_table(table, current_user.user.user_name) + add_gen_table = await GenTableDao.add_gen_table_dao(query_db, table) + if add_gen_table: + table.table_id = add_gen_table.table_id + gen_table_columns = await GenTableColumnDao.get_gen_db_table_columns_by_name(query_db, table_name) + for column in [ + GenTableColumnModel(**gen_table_column) + for gen_table_column in CamelCaseUtil.transform_result(gen_table_columns) + ]: + GenUtils.init_column_field(column, table) + await GenTableColumnDao.add_gen_table_column_dao(query_db, column) + await query_db.commit() + return CrudResponseModel(is_success=True, message='导入成功') + except Exception as e: + await query_db.rollback() + raise ServiceException(message=f'导入失败, {e}') from e + + @classmethod + async def edit_gen_table_services(cls, query_db: AsyncSession, page_object: EditGenTableModel) -> CrudResponseModel: + """ + 编辑业务表信息service + + :param query_db: orm对象 + :param page_object: 编辑业务表对象 + :return: 编辑业务表校验结果 + """ + edit_gen_table = page_object.model_dump(exclude_unset=True, by_alias=True) + gen_table_info = await cls.get_gen_table_by_id_services(query_db, page_object.table_id) + if gen_table_info.table_id: + try: + edit_gen_table['options'] = json.dumps(edit_gen_table.get('params')) + await GenTableDao.edit_gen_table_dao(query_db, edit_gen_table) + for gen_table_column in page_object.columns: + gen_table_column.update_by = page_object.update_by + gen_table_column.update_time = datetime.now() + await GenTableColumnDao.edit_gen_table_column_dao( + query_db, gen_table_column.model_dump(by_alias=True) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='业务表不存在') + + @classmethod + async def delete_gen_table_services( + cls, query_db: AsyncSession, page_object: DeleteGenTableModel + ) -> CrudResponseModel: + """ + 删除业务表信息service + + :param query_db: orm对象 + :param page_object: 删除业务表对象 + :return: 删除业务表校验结果 + """ + if page_object.table_ids: + table_id_list = page_object.table_ids.split(',') + try: + for table_id in table_id_list: + await GenTableDao.delete_gen_table_dao(query_db, GenTableModel(tableId=table_id)) + await GenTableColumnDao.delete_gen_table_column_by_table_id_dao( + query_db, GenTableColumnModel(tableId=table_id) + ) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入业务表id为空') + + @classmethod + async def get_gen_table_by_id_services(cls, query_db: AsyncSession, table_id: int) -> GenTableModel: + """ + 获取需要生成的业务表详细信息service + + :param query_db: orm对象 + :param table_id: 需要生成的业务表id + :return: 需要生成的业务表id对应的信息 + """ + gen_table = await GenTableDao.get_gen_table_by_id(query_db, table_id) + result = await cls.set_table_from_options(GenTableModel(**CamelCaseUtil.transform_result(gen_table))) + + return result + + @classmethod + async def get_gen_table_all_services(cls, query_db: AsyncSession) -> list[GenTableModel]: + """ + 获取所有业务表信息service + + :param query_db: orm对象 + :return: 所有业务表信息 + """ + gen_table_all = await GenTableDao.get_gen_table_all(query_db) + result = [GenTableModel(**gen_table) for gen_table in CamelCaseUtil.transform_result(gen_table_all)] + + return result + + @classmethod + async def create_table_services( + cls, query_db: AsyncSession, sql: str, current_user: CurrentUserModel + ) -> CrudResponseModel: + """ + 创建表结构service + + :param query_db: orm对象 + :param sql: 建表语句 + :param current_user: 当前用户信息对象 + :return: 创建表结构结果 + """ + sql_statements = sqlglot_parse(sql, dialect=DataBaseConfig.sqlglot_parse_dialect) + if cls.__is_valid_create_table(sql_statements): + try: + table_names = cls.__get_table_names(sql_statements) + await GenTableDao.create_table_by_sql_dao(query_db, sql_statements) + gen_table_list = await cls.get_gen_db_table_list_by_name_services(query_db, table_names) + await cls.import_gen_table_services(query_db, gen_table_list, current_user) + + return CrudResponseModel(is_success=True, message='创建表结构成功') + except Exception as e: + raise ServiceException(message=f'创建表结构异常,详细错误信息:{e}') from e + else: + raise ServiceException(message='建表语句不合法') + + @classmethod + def __is_valid_create_table(cls, sql_statements: list[Expression]) -> bool: + """ + 校验sql语句是否为合法的建表语句 + + :param sql_statements: sql语句的ast列表 + :return: 校验结果 + """ + validate_create = [isinstance(sql_statement, Create) for sql_statement in sql_statements] + validate_forbidden_keywords = [ + isinstance( + sql_statement, + (Add, Alter, Delete, Drop, Insert, TruncateTable, Update), + ) + for sql_statement in sql_statements + ] + return not (not any(validate_create) or any(validate_forbidden_keywords)) + + @classmethod + def __get_table_names(cls, sql_statements: list[Expression]) -> list[str]: + """ + 获取sql语句中所有的建表表名 + + :param sql_statements: sql语句的ast列表 + :return: 建表表名列表 + """ + table_names = [ + sql_statement.find(Table).name for sql_statement in sql_statements if isinstance(sql_statement, Create) + ] + + return table_names + + @classmethod + async def preview_code_services(cls, query_db: AsyncSession, table_id: int) -> dict[str, str]: + """ + 预览代码service + + :param query_db: orm对象 + :param table_id: 业务表id + :return: 预览数据列表 + """ + gen_table = GenTableModel( + **CamelCaseUtil.transform_result(await GenTableDao.get_gen_table_by_id(query_db, table_id)) + ) + await cls.set_sub_table(query_db, gen_table) + await cls.set_pk_column(gen_table) + env = TemplateInitializer.init_jinja2() + context = TemplateUtils.prepare_context(gen_table) + template_list = TemplateUtils.get_template_list(gen_table.tpl_category, gen_table.tpl_web_type) + preview_code_result = {} + for template in template_list: + render_content = env.get_template(template).render(**context) + preview_code_result[template] = render_content + return preview_code_result + + @classmethod + async def generate_code_services(cls, query_db: AsyncSession, table_name: str) -> CrudResponseModel: + """ + 生成代码至指定路径service + + :param query_db: orm对象 + :param table_name: 业务表名称 + :return: 生成代码结果 + """ + env = TemplateInitializer.init_jinja2() + render_info = await cls.__get_gen_render_info(query_db, table_name) + try: + for template in render_info[0]: + render_content = env.get_template(template).render(**render_info[2]) + gen_path = cls.__get_gen_path(render_info[3], template) + os.makedirs(os.path.dirname(gen_path), exist_ok=True) + async with aiofiles.open(gen_path, 'w', encoding='utf-8') as f: + await f.write(render_content) + except Exception as e: + raise ServiceException(message=f'渲染模板失败,表名:{render_info[3].table_name},详细错误信息:{e}') from e + + return CrudResponseModel(is_success=True, message='生成代码成功') + + @classmethod + async def batch_gen_code_services(cls, query_db: AsyncSession, table_names: list[str]) -> bytes: + """ + 批量生成代码service + + :param query_db: orm对象 + :param table_names: 业务表名称组 + :return: 下载代码结果 + """ + zip_buffer = io.BytesIO() + with zipfile.ZipFile(zip_buffer, 'w', zipfile.ZIP_DEFLATED) as zip_file: + for table_name in table_names: + env = TemplateInitializer.init_jinja2() + render_info = await cls.__get_gen_render_info(query_db, table_name) + for template_file, output_file in zip(render_info[0], render_info[1], strict=False): + render_content = env.get_template(template_file).render(**render_info[2]) + zip_file.writestr(output_file, render_content) + + zip_data = zip_buffer.getvalue() + zip_buffer.close() + return zip_data + + @classmethod + async def __get_gen_render_info(cls, query_db: AsyncSession, table_name: str) -> list: + """ + 获取生成代码渲染模板相关信息 + + :param query_db: orm对象 + :param table_name: 业务表名称 + :return: 生成代码渲染模板相关信息 + """ + gen_table = GenTableModel( + **CamelCaseUtil.transform_result(await GenTableDao.get_gen_table_by_name(query_db, table_name)) + ) + await cls.set_sub_table(query_db, gen_table) + await cls.set_pk_column(gen_table) + context = TemplateUtils.prepare_context(gen_table) + template_list = TemplateUtils.get_template_list(gen_table.tpl_category, gen_table.tpl_web_type) + output_files = [TemplateUtils.get_file_name(template, gen_table) for template in template_list] + + return [template_list, output_files, context, gen_table] + + @classmethod + def __get_gen_path(cls, gen_table: GenTableModel, template: str) -> str: + """ + 根据GenTableModel对象和模板名称生成路径 + + :param gen_table: GenTableModel对象 + :param template: 模板名称 + :return: 生成的路径 + """ + gen_path = gen_table.gen_path + if gen_path == '/': + return os.path.join(os.getcwd(), GenConfig.GEN_PATH, TemplateUtils.get_file_name(template, gen_table)) + + return os.path.join(gen_path, TemplateUtils.get_file_name(template, gen_table)) + + @classmethod + async def sync_db_services(cls, query_db: AsyncSession, table_name: str) -> CrudResponseModel: + """ + 同步数据库service + + :param query_db: orm对象 + :param table_name: 业务表名称 + :return: 同步数据库结果 + """ + gen_table = await GenTableDao.get_gen_table_by_name(query_db, table_name) + table = GenTableModel(**CamelCaseUtil.transform_result(gen_table)) + table_columns = table.columns + table_column_map = {column.column_name: column for column in table_columns} + query_db_table_columns = await GenTableColumnDao.get_gen_db_table_columns_by_name(query_db, table_name) + db_table_columns = [ + GenTableColumnModel(**column) for column in CamelCaseUtil.transform_result(query_db_table_columns) + ] + if not db_table_columns: + raise ServiceException('同步数据失败,原表结构不存在') + db_table_column_names = [column.column_name for column in db_table_columns] + try: + for column in db_table_columns: + GenUtils.init_column_field(column, table) + if column.column_name in table_column_map: + prev_column = table_column_map[column.column_name] + column.column_id = prev_column.column_id + if column.list: + column.dict_type = prev_column.dict_type + column.query_type = prev_column.query_type + if ( + prev_column.is_required != '' + and not column.pk + and (column.insert or column.edit) + and (column.usable_column or column.super_column) + ): + column.is_required = prev_column.is_required + column.html_type = prev_column.html_type + await GenTableColumnDao.edit_gen_table_column_dao(query_db, column.model_dump(by_alias=True)) + else: + await GenTableColumnDao.add_gen_table_column_dao(query_db, column) + del_columns = [column for column in table_columns if column.column_name not in db_table_column_names] + if del_columns: + for column in del_columns: + await GenTableColumnDao.delete_gen_table_column_by_column_id_dao(query_db, column) + await query_db.commit() + return CrudResponseModel(is_success=True, message='同步成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def set_sub_table(cls, query_db: AsyncSession, gen_table: GenTableModel) -> None: + """ + 设置主子表信息 + + :param query_db: orm对象 + :param gen_table: 业务表信息 + :return: + """ + if gen_table.sub_table_name: + sub_table = await GenTableDao.get_gen_table_by_name(query_db, gen_table.sub_table_name) + gen_table.sub_table = GenTableModel(**CamelCaseUtil.transform_result(sub_table)) + + @classmethod + async def set_pk_column(cls, gen_table: GenTableModel) -> None: + """ + 设置主键列信息 + + :param gen_table: 业务表信息 + :return: + """ + for column in gen_table.columns: + if column.pk: + gen_table.pk_column = column + break + if gen_table.pk_column is None: + gen_table.pk_column = gen_table.columns[0] + if gen_table.tpl_category == GenConstant.TPL_SUB: + for column in gen_table.sub_table.columns: + if column.pk: + gen_table.sub_table.pk_column = column + break + if gen_table.sub_table.columns is None: + gen_table.sub_table.pk_column = gen_table.sub_table.columns[0] + + @classmethod + async def set_table_from_options(cls, gen_table: GenTableModel) -> GenTableModel: + """ + 设置代码生成其他选项值 + + :param gen_table: 生成对象 + :return: 设置后的生成对象 + """ + params_obj = json.loads(gen_table.options) if gen_table.options else None + if params_obj: + gen_table.tree_code = params_obj.get(GenConstant.TREE_CODE) + gen_table.tree_parent_code = params_obj.get(GenConstant.TREE_PARENT_CODE) + gen_table.tree_name = params_obj.get(GenConstant.TREE_NAME) + gen_table.parent_menu_id = params_obj.get(GenConstant.PARENT_MENU_ID) + gen_table.parent_menu_name = params_obj.get(GenConstant.PARENT_MENU_NAME) + + return gen_table + + @classmethod + async def validate_edit(cls, edit_gen_table: EditGenTableModel) -> None: + """ + 编辑保存参数校验 + + :param edit_gen_table: 编辑业务表对象 + """ + if edit_gen_table.tpl_category == GenConstant.TPL_TREE: + params_obj = edit_gen_table.params.model_dump(by_alias=True) + + if GenConstant.TREE_CODE not in params_obj: + raise ServiceException(message='树编码字段不能为空') + if GenConstant.TREE_PARENT_CODE not in params_obj: + raise ServiceException(message='树父编码字段不能为空') + if GenConstant.TREE_NAME not in params_obj: + raise ServiceException(message='树名称字段不能为空') + if edit_gen_table.tpl_category == GenConstant.TPL_SUB: + if not edit_gen_table.sub_table_name: + raise ServiceException(message='关联子表的表名不能为空') + if not edit_gen_table.sub_table_fk_name: + raise ServiceException(message='子表关联的外键名不能为空') + + +class GenTableColumnService: + """ + 代码生成业务表字段服务层 + """ + + @classmethod + async def get_gen_table_column_list_by_table_id_services( + cls, query_db: AsyncSession, table_id: int + ) -> list[GenTableColumnModel]: + """ + 获取业务表字段列表信息service + + :param query_db: orm对象 + :param table_id: 业务表格id + :return: 业务表字段列表信息对象 + """ + gen_table_column_list_result = await GenTableColumnDao.get_gen_table_column_list_by_table_id(query_db, table_id) + + return [ + GenTableColumnModel(**gen_table_column) + for gen_table_column in CamelCaseUtil.transform_result(gen_table_column_list_result) + ] diff --git a/shierfeng-fastapi-backend/module_generator/templates/js/api.js.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/js/api.js.jinja2 new file mode 100644 index 0000000..3a2a5a9 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/js/api.js.jinja2 @@ -0,0 +1,44 @@ +import request from '@/utils/request' + +// 查询{{ functionName }}列表 +export function list{{ BusinessName }}(query) { + return request({ + url: '/{{ moduleName }}/{{ businessName }}/list', + method: 'get', + params: query + }) +} + +// 查询{{ functionName }}详细 +export function get{{ BusinessName }}({{ pkColumn.python_field }}) { + return request({ + url: '/{{ moduleName }}/{{ businessName }}/' + {{ pkColumn.python_field }}, + method: 'get' + }) +} + +// 新增{{ functionName }} +export function add{{ BusinessName }}(data) { + return request({ + url: '/{{ moduleName }}/{{ businessName }}', + method: 'post', + data: data + }) +} + +// 修改{{ functionName }} +export function update{{ BusinessName }}(data) { + return request({ + url: '/{{ moduleName }}/{{ businessName }}', + method: 'put', + data: data + }) +} + +// 删除{{ functionName }} +export function del{{ BusinessName }}({{ pkColumn.python_field }}) { + return request({ + url: '/{{ moduleName }}/{{ businessName }}/' + {{ pkColumn.python_field }}, + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-backend/module_generator/templates/python/controller.py.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/python/controller.py.jinja2 new file mode 100644 index 0000000..b4340ea --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/python/controller.py.jinja2 @@ -0,0 +1,191 @@ +{% set pkField = pkColumn.python_field %} +{% set pk_field = pkColumn.python_field | camel_to_snake %} +{% set pkParentheseIndex = pkColumn.column_comment.find("(") %} +{% set pk_field_comment = pkColumn.column_comment[:pkParentheseIndex] if pkParentheseIndex != -1 else pkColumn.column_comment %} +{% set need_import_datetime = namespace(has_datetime=False) %} +{% for column in columns %} +{% if column.python_field in ["createTime", "updateTime"] %} +{% set need_import_datetime.has_datetime = True %} +{% endif %} +{% endfor %} +{% if need_import_datetime.has_datetime %} +from datetime import datetime +{% endif %} +from typing import Annotated + +from fastapi import Form, Path, Query, Request, Response +from fastapi.responses import StreamingResponse +from pydantic_validation_decorator import ValidateFields +from sqlalchemy.ext.asyncio import AsyncSession + +from common.annotation.log_annotation import Log +from common.aspect.db_seesion import DBSessionDependency +from common.aspect.interface_auth import UserInterfaceAuthDependency +from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency +from common.enums import BusinessType +from common.router import APIRouterPro +from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel +from module_admin.entity.vo.user_vo import CurrentUserModel +from {{ packageName }}.service.{{ businessName }}_service import {{ BusinessName }}Service +from {{ packageName }}.entity.vo.{{ businessName }}_vo import Delete{{ BusinessName }}Model, {{ BusinessName }}Model, {{ BusinessName }}PageQueryModel +from utils.common_util import bytes2file_response +from utils.log_util import logger +from utils.response_util import ResponseUtil + + +{{ businessName }}_controller = APIRouterPro( + prefix='/{{ moduleName }}/{{ businessName }}', order_num=50, tags=['{{ functionName }}'], dependencies=[PreAuthDependency()] +) + + +@{{ businessName }}_controller.get( + '/list', + summary='获取{{ functionName }}分页列表接口', + description='用于获取{{ functionName }}分页列表', + response_model=PageResponseModel[{{ BusinessName }}Model], + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:list')], +) +async def get_{{ moduleName }}_{{ businessName }}_list( + request: Request, + {% if table.crud or table.sub %}{{ businessName }}_page_query{% elif table.tree %}{{ businessName }}_query{% endif %}: Annotated[{{ BusinessName }}PageQueryModel, Query()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + {% if table.crud or table.sub %} + # 获取分页数据 + {{ businessName }}_page_query_result = await {{ BusinessName }}Service.get_{{ businessName }}_list_services(query_db, {{ businessName }}_page_query, is_page=True) + logger.info('获取成功') + + return ResponseUtil.success(model_content={{ businessName }}_page_query_result) + {% elif table.tree %} + {{ businessName }}_query_result = await {{ BusinessName }}Service.get_{{ businessName }}_list_services(query_db, {{ businessName }}_query) + logger.info('获取成功') + + return ResponseUtil.success(data={{ businessName }}_query_result) + {% endif %} + + +@{{ businessName }}_controller.post( + '', + summary='新增{{ functionName }}接口', + description='用于新增{{ functionName }}', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:add')], +) +@ValidateFields(validate_model='add_{{ businessName }}') +@Log(title='{{ functionName }}', business_type=BusinessType.INSERT) +async def add_{{ moduleName }}_{{ businessName }}( + request: Request, + add_{{ businessName }}: {{ BusinessName }}Model, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + {% for column in columns %} + {% if column.python_field == "createBy" %} + add_{{ businessName }}.create_by = current_user.user.user_name + {% elif column.python_field == "createTime" %} + add_{{ businessName }}.create_time = datetime.now() + {% elif column.python_field == "updateBy" %} + add_{{ businessName }}.update_by = current_user.user.user_name + {% elif column.python_field == "updateTime" %} + add_{{ businessName }}.update_time = datetime.now() + {% endif %} + {% endfor %} + add_{{ businessName }}_result = await {{ BusinessName }}Service.add_{{ businessName }}_services(query_db, add_{{ businessName }}) + logger.info(add_{{ businessName }}_result.message) + + return ResponseUtil.success(msg=add_{{ businessName }}_result.message) + + +@{{ businessName }}_controller.put( + '', + summary='编辑{{ functionName }}接口', + description='用于编辑{{ functionName }}', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:edit')], +) +@ValidateFields(validate_model='edit_{{ businessName }}') +@Log(title='{{ functionName }}', business_type=BusinessType.UPDATE) +async def edit_{{ moduleName }}_{{ businessName }}( + request: Request, + edit_{{ businessName }}: {{ BusinessName }}Model, + query_db: Annotated[AsyncSession, DBSessionDependency()], + current_user: Annotated[CurrentUserModel, CurrentUserDependency()], +) -> Response: + {% for column in columns %} + {% if column.python_field == "updateBy" %} + edit_{{ businessName }}.update_by = current_user.user.user_name + {% elif column.python_field == "updateTime" %} + edit_{{ businessName }}.update_time = datetime.now() + {% endif %} + {% endfor %} + edit_{{ businessName }}_result = await {{ BusinessName }}Service.edit_{{ businessName }}_services(query_db, edit_{{ businessName }}) + logger.info(edit_{{ businessName }}_result.message) + + return ResponseUtil.success(msg=edit_{{ businessName }}_result.message) + + +@{{ businessName }}_controller.delete( + '/{% raw %}{{% endraw %}{{ pk_field }}s{% raw %}}{% endraw %}', + summary='删除{{ functionName }}接口', + description='用于删除{{ functionName }}', + response_model=ResponseBaseModel, + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:remove')], +) +@Log(title='{{ functionName }}', business_type=BusinessType.DELETE) +async def delete_{{ moduleName }}_{{ businessName }}( + request: Request, + {{ pk_field }}s: Annotated[str, Path(description='需要删除的{{ pk_field_comment }}')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + delete_{{ businessName }} = Delete{{ BusinessName }}Model({{ pkField }}s={{ pk_field }}s) + delete_{{ businessName }}_result = await {{ BusinessName }}Service.delete_{{ businessName }}_services(query_db, delete_{{ businessName }}) + logger.info(delete_{{ businessName }}_result.message) + + return ResponseUtil.success(msg=delete_{{ businessName }}_result.message) + + +@{{ businessName }}_controller.get( + '/{% raw %}{{% endraw %}{{ pk_field }}{% raw %}}{% endraw %}', + summary='获取{{ functionName }}详情接口', + description='用于获取指定{{ functionName }}的详细信息', + response_model=DataResponseModel[{{ BusinessName }}Model], + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:query')] +) +async def query_detail_{{ moduleName }}_{{ businessName }}( + request: Request, + {{ pk_field }}: Annotated[{{ pkColumn.python_type }}, Path(description='{{ pk_field_comment }}')], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + {{ businessName }}_detail_result = await {{ BusinessName }}Service.{{ businessName }}_detail_services(query_db, {{ pk_field }}) + logger.info(f'获取{{ pk_field }}为{% raw %}{{% endraw %}{{ pk_field }}{% raw %}}{% endraw %}的信息成功') + + return ResponseUtil.success(data={{ businessName }}_detail_result) + + +@{{ businessName }}_controller.post( + '/export', + summary='导出{{ functionName }}列表接口', + description='用于导出当前符合查询条件的{{ functionName }}列表数据', + response_class=StreamingResponse, + responses={ + 200: { + 'description': '流式返回{{ functionName }}列表excel文件', + 'content': { + 'application/octet-stream': {}, + }, + } + }, + dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:export')], +) +@Log(title='{{ functionName }}', business_type=BusinessType.EXPORT) +async def export_{{ moduleName }}_{{ businessName }}_list( + request: Request, + {{ businessName }}_page_query: Annotated[{{ BusinessName }}PageQueryModel, Form()], + query_db: Annotated[AsyncSession, DBSessionDependency()], +) -> Response: + # 获取全量数据 + {{ businessName }}_query_result = await {{ BusinessName }}Service.get_{{ businessName }}_list_services(query_db, {{ businessName }}_page_query, is_page=False) + {{ businessName }}_export_result = await {{ BusinessName }}Service.export_{{ businessName }}_list_services({% if dicts %}request, {% endif %}{{ businessName }}_query_result) + logger.info('导出成功') + + return ResponseUtil.streaming(data=bytes2file_response({{ businessName }}_export_result)) diff --git a/shierfeng-fastapi-backend/module_generator/templates/python/dao.py.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/python/dao.py.jinja2 new file mode 100644 index 0000000..3337e37 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/python/dao.py.jinja2 @@ -0,0 +1,221 @@ +{% set pkField = pkColumn.python_field %} +{% set pk_field = pkColumn.python_field | camel_to_snake %} +{% set pkParentheseIndex = pkColumn.column_comment.find("(") %} +{% set pk_field_comment = pkColumn.column_comment[:pkParentheseIndex] if pkParentheseIndex != -1 else pkColumn.column_comment %} +{% for column in columns %} +{% if column.query and column.query_type == 'BETWEEN' and column.python_field == "createTime" %} +from datetime import datetime, time +{% endif %} +{% endfor %} +from typing import Any + +from sqlalchemy import delete, select, update +from sqlalchemy.ext.asyncio import AsyncSession +{% if table.sub %} +from sqlalchemy.orm import selectinload +{% endif %} + +from common.vo import PageModel +{% if table.sub %} +from {{ packageName }}.entity.do.{{ businessName }}_do import {{ ClassName }}, {{ subClassName }} +from {{ packageName }}.entity.vo.{{ businessName }}_vo import {{ BusinessName }}Model, {{ BusinessName }}PageQueryModel, {{ subTable.business_name | capitalize }}Model +{% else %} +from {{ packageName }}.entity.do.{{ businessName }}_do import {{ ClassName }} +from {{ packageName }}.entity.vo.{{ businessName }}_vo import {{ BusinessName }}Model, {{ BusinessName }}PageQueryModel +{% endif %} +from utils.page_util import PageUtil + + +class {{ BusinessName }}Dao: + """ + {{ functionName }}模块数据库操作层 + """ + + @classmethod + async def get_{{ businessName }}_detail_by_id(cls, db: AsyncSession, {{ pk_field }}: int) -> {{ ClassName }} | None: + """ + 根据{{ pk_field_comment }}获取{{ functionName }}详细信息 + + :param db: orm对象 + :param {{ pk_field }}: {{ pk_field_comment }} + :return: {{ functionName }}信息对象 + """ + {{ businessName }}_info = ( + ( + await db.execute( + {% if table.sub %} + select({{ ClassName }}) + .options(selectinload({{ ClassName }}.{{ subclassName }}_list)) + {% else %} + select({{ ClassName }}) + {% endif %} + .where( + {{ ClassName }}.{{ pk_field }} == {{ pk_field }} + ) + ) + ) + .scalars() + .first() + ) + + return {{ businessName }}_info + + @classmethod + async def get_{{ businessName }}_detail_by_info(cls, db: AsyncSession, {{ businessName }}: {{ BusinessName }}Model) -> {{ ClassName }} | None: + """ + 根据{{ functionName }}参数获取{{ functionName }}信息 + + :param db: orm对象 + :param {{ businessName }}: {{ functionName }}参数对象 + :return: {{ functionName }}信息对象 + """ + {{ businessName }}_info = ( + ( + await db.execute( + select({{ ClassName }}).where( + {% for column in columns %} + {% if column.unique %} + {{ ClassName }}.{{ column.python_field | camel_to_snake }} == {{ businessName }}.{{ column.python_field | camel_to_snake }} if {{ businessName }}.{{ column.python_field | camel_to_snake }} else True, + {% endif %} + {% endfor %} + ) + ) + ) + .scalars() + .first() + ) + + return {{ businessName }}_info + + @classmethod + async def get_{{ businessName }}_list( + cls, db: AsyncSession, query_object: {{ BusinessName }}PageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 根据查询参数获取{{ functionName }}列表信息 + + :param db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: {{ functionName }}列表信息对象 + """ + query = ( + {% if table.sub %} + select({{ ClassName }}) + .options(selectinload({{ ClassName }}.{{ subclassName }}_list)) + {% else %} + select({{ ClassName }}) + {% endif %} + .where( + {% for column in columns %} + {% set field = column.python_field | camel_to_snake %} + {% if column.query %} + {% if column.query_type == "EQ" %} + {{ ClassName }}.{{ field }} == query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "NE" %} + {{ ClassName }}.{{ field }} != query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "GT" %} + {{ ClassName }}.{{ field }} > query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "GTE" %} + {{ ClassName }}.{{ field }} >= query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "LT" %} + {{ ClassName }}.{{ field }} < query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "LTE" %} + {{ ClassName }}.{{ field }} <= query_object.{{ field }} if query_object.{{ field }} else True, + {% elif column.query_type == "LIKE" %} + {{ ClassName }}.{{ field }}.like(f'%{% raw %}{{% endraw %}query_object.{{ field }}{% raw %}}{% endraw %}%') if query_object.{{ field }} else True, + {% elif column.html_type == "datetime" and column.query_type == "BETWEEN" %} + {{ ClassName }}.{{ field }}.between( + datetime.combine(datetime.strptime(query_object.begin_{{ column.column_name }}, '%Y-%m-%d'), time(00, 00, 00)), + datetime.combine(datetime.strptime(query_object.end_{{ column.column_name }}, '%Y-%m-%d'), time(23, 59, 59)), + ) + if query_object.begin_{{ column.column_name }} and query_object.end_{{ column.column_name }} + else True, + {% endif %} + {% endif %} + {% endfor %} + ) + .order_by({{ ClassName }}.{{ pk_field }}) + .distinct() + ) + {{ businessName }}_list: PageModel | list[dict[str, Any]] = await PageUtil.paginate( + db, query, query_object.page_num, query_object.page_size, is_page + ) + + return {{ businessName }}_list + + @classmethod + async def add_{{ businessName }}_dao(cls, db: AsyncSession, {{ businessName }}: {{ BusinessName }}Model) -> {{ ClassName }}: + """ + 新增{{ functionName }}数据库操作 + + :param db: orm对象 + :param {{ businessName }}: {{ functionName }}对象 + :return: + """ + db_{{ businessName }} = {{ ClassName }}(**{{ businessName }}.model_dump(exclude={% raw %}{{% endraw %}{% if table.sub %}'{{ subclassName }}_list', {% endif %}{% for column in columns %}{% if not column.insert and column.column_name not in column_not_add_show + column_not_edit_show %}'{{ column.python_field | camel_to_snake }}'{% if not loop.last %}, {% endif %}{% endif %}{% endfor %}{% raw %}}{% endraw %})) + db.add(db_{{ businessName }}) + await db.flush() + + return db_{{ businessName }} + + @classmethod + async def edit_{{ businessName }}_dao(cls, db: AsyncSession, {{ businessName }}: dict) -> None: + """ + 编辑{{ functionName }}数据库操作 + + :param db: orm对象 + :param {{ businessName }}: 需要更新的{{ functionName }}字典 + :return: + """ + await db.execute(update({{ ClassName }}), [{{ businessName }}]) + + @classmethod + async def delete_{{ businessName }}_dao(cls, db: AsyncSession, {{ businessName }}: {{ BusinessName }}Model) -> None: + """ + 删除{{ functionName }}数据库操作 + + :param db: orm对象 + :param {{ businessName }}: {{ functionName }}对象 + :return: + """ + await db.execute(delete({{ ClassName }}).where({{ ClassName }}.{{ pk_field }}.in_([{{ businessName }}.{{ pk_field }}]))) + + {% if table.sub %} + @classmethod + async def add_{{ subTable.business_name }}_dao(cls, db: AsyncSession, {{ subTable.business_name }}: {{ subTable.business_name | capitalize }}Model) -> {{ subClassName }}: + """ + 新增{{ subTable.function_name }}数据库操作 + + :param db: orm对象 + :param {{ subTable.business_name }}: {{ subTable.function_name }}对象 + :return: + """ + db_{{ subTable.business_name }} = {{ subClassName }}(**{{ subTable.business_name }}.model_dump()) + db.add(db_{{ subTable.business_name }}) + await db.flush() + + return db_{{ subTable.business_name }} + + @classmethod + async def edit_{{ subTable.business_name }}_dao(cls, db: AsyncSession, {{ subTable.business_name }}: dict) -> None: + """ + 编辑{{ subTable.function_name }}数据库操作 + + :param db: orm对象 + :param {{ subTable.business_name }}: 需要更新的{{ subTable.function_name }}字典 + :return: + """ + await db.execute(update({{ subClassName }}), [{{ subTable.business_name }}]) + + @classmethod + async def delete_{{ subTable.business_name }}_dao(cls, db: AsyncSession, {{ subTable.business_name }}: {{ subTable.business_name | capitalize }}Model) -> None: + """ + 删除{{ subTable.function_name }}数据库操作 + + :param db: orm对象 + :param {{ subTable.business_name }}: {{ subTable.function_name }}对象 + :return: + """ + await db.execute(delete({{ subClassName }}).where({{ subClassName }}.{{ subTable.pk_column.python_field | camel_to_snake }}.in_([{{ subTable.business_name }}.{{ subTable.pk_column.python_field | camel_to_snake }}]))) + {% endif %} diff --git a/shierfeng-fastapi-backend/module_generator/templates/python/do.py.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/python/do.py.jinja2 new file mode 100644 index 0000000..76137e3 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/python/do.py.jinja2 @@ -0,0 +1,43 @@ +{% for do_import in doImportList %} +{{ do_import }} +{% endfor %} +{% if table.sub %} +from sqlalchemy.orm import relationship +{% endif %} + +from config.database import Base + + +class {{ ClassName }}(Base): + """ + {{ functionName }}表 + """ + + __tablename__ = '{{ tableName }}' + __table_args__ = {'comment': '{{ tableComment }}'} + + {% for column in columns %} + {{ column.column_name }} = Column({{ column.column_type | get_sqlalchemy_type }}, {% if column.pk %}primary_key=True, {% endif %}{% if column.increment %}autoincrement=True, {% endif %}{% if column.required or column.pk %}nullable=False{% else %}nullable=True{% endif %}, comment='{{ column.column_comment }}') + {% endfor %} + + {% if table.sub %} + {{ subclassName }}_list = relationship('{{ subClassName }}', back_populates='{{ businessName }}') + {% endif %} + + +{% if table.sub %} +class {{ subClassName }}(Base): + """ + {{ subTable.function_name }}表 + """ + + __tablename__ = '{{ subTableName }}' + + {% for column in subTable.columns %} + {{ column.column_name }} = Column({{ column.column_type | get_sqlalchemy_type }}, {% if column.column_name == subTableFkName %}ForeignKey('{{ tableName }}.{{ subTableFkName }}'), {% endif %}{% if column.pk %}primary_key=True, {% endif %}{% if column.increment %}autoincrement=True, {% endif %}{% if column.required %}nullable=True{% else %}nullable=False{% endif %}, comment='{{ column.column_comment }}') + {% endfor %} + + {% if table.sub %} + {{ businessName }} = relationship('{{ ClassName }}', back_populates='{{ subclassName }}_list') + {% endif %} +{% endif %} diff --git a/shierfeng-fastapi-backend/module_generator/templates/python/service.py.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/python/service.py.jinja2 new file mode 100644 index 0000000..8349699 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/python/service.py.jinja2 @@ -0,0 +1,210 @@ +{% set pkField = pkColumn.python_field %} +{% set pk_field = pkColumn.python_field | camel_to_snake %} +{% set pkParentheseIndex = pkColumn.column_comment.find("(") %} +{% set pk_field_comment = pkColumn.column_comment[:pkParentheseIndex] if pkParentheseIndex != -1 else pkColumn.column_comment %} +from typing import Any + +{% if dicts %} +from fastapi import Request +{% endif %} +from sqlalchemy.ext.asyncio import AsyncSession + +from common.constant import CommonConstant +from common.vo import CrudResponseModel, PageModel +from exceptions.exception import ServiceException +from {{ packageName }}.dao.{{ businessName }}_dao import {{ BusinessName }}Dao +from {{ packageName }}.entity.vo.{{ businessName }}_vo import Delete{{ BusinessName }}Model, {{ BusinessName }}Model, {{ BusinessName }}PageQueryModel +{% if dicts %} +from module_admin.service.dict_service import DictDataService +{% endif %} +from utils.common_util import CamelCaseUtil +from utils.excel_util import ExcelUtil + + +class {{ BusinessName }}Service: + """ + {{ functionName }}模块服务层 + """ + + @classmethod + async def get_{{ businessName }}_list_services( + cls, query_db: AsyncSession, query_object: {{ BusinessName }}PageQueryModel, is_page: bool = False + ) -> PageModel | list[dict[str, Any]]: + """ + 获取{{ functionName }}列表信息service + + :param query_db: orm对象 + :param query_object: 查询参数对象 + :param is_page: 是否开启分页 + :return: {{ functionName }}列表信息对象 + """ + {{ businessName }}_list_result = await {{ BusinessName }}Dao.get_{{ businessName }}_list(query_db, query_object, is_page) + + return {{ businessName }}_list_result + + {% for column in columns %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + {% if column.unique %} + @classmethod + async def check_{{ column.python_field | camel_to_snake }}_unique_services(cls, query_db: AsyncSession, page_object: {{ BusinessName }}Model) -> bool: + """ + 检查{{ comment }}是否唯一service + + :param query_db: orm对象 + :param page_object: {{ functionName }}对象 + :return: 校验结果 + """ + {{ pk_field }} = -1 if page_object.{{ pk_field }} is None else page_object.{{ pk_field }} + {{ businessName }} = await {{ BusinessName }}Dao.get_{{ businessName }}_detail_by_info(query_db, {{ BusinessName }}Model({{ column.python_field }}=page_object.{{ column.python_field | camel_to_snake }})) + if {{ businessName }} and {{ businessName }}.{{ pk_field }} != {{ pk_field }}: + return CommonConstant.NOT_UNIQUE + return CommonConstant.UNIQUE + {% if not loop.last %}{{ "\n" }}{% endif %} + {% endif %} + {% endfor %} + + @classmethod + async def add_{{ businessName }}_services(cls, query_db: AsyncSession, page_object: {{ BusinessName }}Model) -> CrudResponseModel: + """ + 新增{{ functionName }}信息service + + :param query_db: orm对象 + :param page_object: 新增{{ functionName }}对象 + :return: 新增{{ functionName }}校验结果 + """ + {% for column in columns %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + {% if column.unique %} + if not await cls.check_{{ column.python_field | camel_to_snake }}_unique_services(query_db, page_object): + raise ServiceException(message=f'新增{{ functionName }}{page_object.{{ column.python_field | camel_to_snake }}}失败,{{ comment }}已存在') + {% endif %} + {% endfor %} + try: + {% if table.sub %} + add_{{ businessName }} = await {{ BusinessName }}Dao.add_{{ businessName }}_dao(query_db, page_object) + if add_{{ businessName }}: + for sub_table in page_object.{{ subclassName }}_list: + await {{ BusinessName }}Dao.add_{{ subTable.business_name }}_dao(query_db, sub_table) + {% else %} + await {{ BusinessName }}Dao.add_{{ businessName }}_dao(query_db, page_object) + {% endif %} + await query_db.commit() + return CrudResponseModel(is_success=True, message='新增成功') + except Exception as e: + await query_db.rollback() + raise e + + @classmethod + async def edit_{{ businessName }}_services(cls, query_db: AsyncSession, page_object: {{ BusinessName }}Model) -> CrudResponseModel: + """ + 编辑{{ functionName }}信息service + + :param query_db: orm对象 + :param page_object: 编辑{{ functionName }}对象 + :return: 编辑{{ functionName }}校验结果 + """ + edit_{{ businessName }} = page_object.model_dump(exclude_unset=True, exclude={% raw %}{{% endraw %}{% if table.sub %}'{{ subclassName }}_list', {% endif %}{% for column in columns %}{% if not column.edit and not column.pk and column.column_name not in column_not_edit_show %}'{{ column.python_field | camel_to_snake }}'{% if not loop.last %}, {% endif %}{% endif %}{% endfor %}{% raw %}}{% endraw %}) + {{ businessName }}_info = await cls.{{ businessName }}_detail_services(query_db, page_object.{{ pk_field }}) + if {{ businessName }}_info.{{ pk_field }}: + {% for column in columns %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + {% if column.unique %} + if not await cls.check_{{ column.python_field | camel_to_snake }}_unique_services(query_db, page_object): + raise ServiceException(message=f'修改{{ functionName }}{page_object.{{ column.python_field | camel_to_snake }}}失败,{{ comment }}已存在') + {% endif %} + {% endfor %} + try: + await {{ BusinessName }}Dao.edit_{{ businessName }}_dao(query_db, edit_{{ businessName }}) + {% if table.sub %} + for sub_table in {{ businessName }}_info.{{ subclassName }}_list: + await {{ BusinessName }}Dao.delete_{{ subTable.business_name }}_dao(query_db, sub_table) + for sub_table in page_object.{{ subclassName }}_list: + await {{ BusinessName }}Dao.add_{{ subTable.business_name }}_dao(query_db, sub_table) + {% endif %} + await query_db.commit() + return CrudResponseModel(is_success=True, message='更新成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='{{ functionName }}不存在') + + @classmethod + async def delete_{{ businessName }}_services(cls, query_db: AsyncSession, page_object: Delete{{ BusinessName }}Model) -> CrudResponseModel: + """ + 删除{{ functionName }}信息service + + :param query_db: orm对象 + :param page_object: 删除{{ functionName }}对象 + :return: 删除{{ functionName }}校验结果 + """ + if page_object.{{ pk_field }}s: + {{ pk_field }}_list = page_object.{{ pk_field }}s.split(',') + try: + for {{ pk_field }} in {{ pk_field }}_list: + {% if table.sub %} + {{ businessName }} = await cls.{{ businessName }}_detail_services(query_db, int({{ pk_field }})) + for sub_table in {{ businessName }}.{{ subclassName }}_list: + await {{ BusinessName }}Dao.delete_{{ subTable.business_name }}_dao(query_db, sub_table) + {% endif %} + await {{ BusinessName }}Dao.delete_{{ businessName }}_dao(query_db, {{ BusinessName }}Model({{ pkField }}={{ pk_field }})) + await query_db.commit() + return CrudResponseModel(is_success=True, message='删除成功') + except Exception as e: + await query_db.rollback() + raise e + else: + raise ServiceException(message='传入{{ pk_field_comment }}为空') + + @classmethod + async def {{ businessName }}_detail_services(cls, query_db: AsyncSession, {{ pk_field }}: int) -> {{ BusinessName }}Model: + """ + 获取{{ functionName }}详细信息service + + :param query_db: orm对象 + :param {{ pk_field }}: {{ pk_field_comment }} + :return: {{ pk_field_comment }}对应的信息 + """ + {{ businessName }} = await {{ BusinessName }}Dao.get_{{ businessName }}_detail_by_id(query_db, {{ pk_field }}={{ pk_field }}) + result = {{ BusinessName }}Model(**CamelCaseUtil.transform_result({{ businessName }})) if {{ businessName }} else {{ BusinessName }}Model() + + return result + + @staticmethod + async def export_{{ businessName }}_list_services({% if dicts %}request: Request, {% endif %}{{ businessName }}_list: list) -> bytes: + """ + 导出{{ functionName }}信息service + + :param {{ businessName }}_list: {{ functionName }}信息列表 + :return: {{ functionName }}信息对应excel的二进制数据 + """ + # 创建一个映射字典,将英文键映射到中文键 + mapping_dict = { + {% for column in columns %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + '{{ column.python_field }}': '{{ comment }}', + {% endfor %} + } + {% if dicts %} + {% for dict_type in dicts.split(", ") %} + {{ dict_type[1:-1] }}_list = await DictDataService.query_dict_data_list_from_cache_services( + request.app.state.redis, dict_type={{ dict_type }} + ) + {{ dict_type[1:-1] }}_option = [{'label': item.get('dictLabel'), 'value': item.get('dictValue')} for item in {{ dict_type[1:-1] }}_list] + {{ dict_type[1:-1] }}_option_dict = {item.get('value'): item for item in {{ dict_type[1:-1] }}_option} + {% endfor %} + for item in {{ businessName }}_list: + {% for column in columns %} + {% if column.dict_type %} + if str(item.get('{{ column.python_field }}')) in {{ column.dict_type }}_option_dict: + item['{{ column.python_field }}'] = {{ column.dict_type }}_option_dict.get(str(item.get('{{ column.python_field }}'))).get('label') + {% endif %} + {% endfor %} + {% endif %} + binary_data = ExcelUtil.export_list2excel({{ businessName }}_list, mapping_dict) + + return binary_data diff --git a/shierfeng-fastapi-backend/module_generator/templates/python/vo.py.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/python/vo.py.jinja2 new file mode 100644 index 0000000..a21fb84 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/python/vo.py.jinja2 @@ -0,0 +1,172 @@ +{% set pkField = pkColumn.python_field %} +{% set pk_field = pkColumn.python_field | camel_to_snake %} +{% set pkParentheseIndex = pkColumn.column_comment.find("(") %} +{% set pk_field_comment = pkColumn.column_comment[:pkParentheseIndex] if pkParentheseIndex != -1 else pkColumn.column_comment %} +{% set vo_field_required = namespace(has_required=False) %} +{% set vo_field_daterange = namespace(has_daterange=False) %} +{% for column in columns %} +{% if column.required %} + {% set vo_field_required.has_required = True %} +{% endif %} +{% if column.html_type == "datetime" and column.query_type == "BETWEEN" %} + {% set vo_field_daterange.has_daterange = True %} +{% endif %} +{% endfor %} +{% set sub_vo_field_required = namespace(has_required=False) %} +{% if table.sub %} +{% for sub_column in subTable.columns %} +{% if sub_column.required %} + {% set sub_vo_field_required.has_required = True %} +{% endif %} +{% endfor %} +{% endif %} +{% for vo_import in voImportList %} +{{ vo_import }} +{% endfor %} + +from pydantic import BaseModel, ConfigDict, Field +from pydantic.alias_generators import to_camel +{% if vo_field_required.has_required or sub_vo_field_required.has_required %} +from pydantic_validation_decorator import NotBlank +{% endif %} + + +{% if table.sub %} +class {{ BusinessName }}BaseModel(BaseModel): + """ + {{ functionName }}表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + {% for column in columns %} + {{ column.column_name }}: {{ column.python_type }} | None = Field(default=None, description='{{ column.column_comment }}') + {% endfor %} + + {% for column in columns %} + {% if column.required %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + @NotBlank(field_name='{{ column.column_name }}', message='{{ comment }}不能为空') + def get_{{ column.column_name }}(self) -> {{ column.python_type }} | None: + return self.{{ column.column_name }} + {% if not loop.last %}{{ "\n" }}{% endif %} + {% endif %} + {% endfor %} + + {% if vo_field_required.has_required %} + def validate_fields(self) -> None: + {% for column in columns %} + {% if column.required %} + self.get_{{ column.column_name }}() + {% endif %} + {% endfor %} + {% endif %} +{% endif %} + + +class {{ BusinessName }}Model({% if table.sub %}{{ BusinessName }}BaseModel{% else %}BaseModel{% endif %}): + """ + {{ functionName }}表对应pydantic模型 + """ + {% if not table.sub %} + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + {% for column in columns %} + {{ column.column_name }}: {{ column.python_type }} | None = Field(default=None, description='{{ column.column_comment }}') + {% endfor %} + {% endif %} + {% if table.sub %} + {{ subclassName }}_list: list['{{ subTable.business_name | capitalize }}Model'] | None = Field(default=None, description='子表列信息') + {% endif %} + + {% if not table.sub %} + {% for column in columns %} + {% if column.required %} + {% set parentheseIndex = column.column_comment.find("(") %} + {% set comment = column.column_comment[:parentheseIndex] if parentheseIndex != -1 else column.column_comment %} + @NotBlank(field_name='{{ column.column_name }}', message='{{ comment }}不能为空') + def get_{{ column.column_name }}(self) -> {{ column.python_type }} | None: + return self.{{ column.column_name }} + {% if not loop.last %}{{ "\n" }}{% endif %} + {% endif %} + {% endfor %} + + {% if vo_field_required.has_required %} + def validate_fields(self) -> None: + {% for column in columns %} + {% if column.required %} + self.get_{{ column.column_name }}() + {% endif %} + {% endfor %} + {% endif %} + {% endif %} + + +{% if table.sub %} +class {{ subTable.business_name | capitalize }}Model(BaseModel): + """ + {{ subTable.function_name }}表对应pydantic模型 + """ + + model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) + + {% for sub_column in subTable.columns %} + {{ sub_column.column_name }}: {{ sub_column.python_type }} | None = Field(default=None, description='{{ sub_column.column_comment}}') + {% endfor %} + + {% for sub_column in subTable.columns %} + {% if sub_column.required %} + {% set parentheseIndex = sub_column.column_comment.find("(") %} + {% set comment = sub_column.column_comment[:parentheseIndex] if parentheseIndex != -1 else sub_column.column_comment %} + @NotBlank(field_name='{{ sub_column.column_name }}', message='{{ comment }}不能为空') + def get_{{ sub_column.column_name }}(self) -> {{ sub_column.python_type }} | None: + return self.{{ sub_column.column_name }} + {% if not loop.last %}{{ "\n" }}{% endif %} + {% endif %} + {% endfor %} + + {% if sub_vo_field_required.has_required %} + def validate_fields(self) -> None: + {% for sub_column in subTable.columns %} + {% if sub_column.required %} + self.get_{{ sub_column.column_name }}() + {% endif %} + {% endfor %} + {% endif %} +{% endif %} + + +class {{ BusinessName }}QueryModel({% if table.sub %}{{ BusinessName }}BaseModel{% else %}{{ BusinessName }}Model{% endif %}): + """ + {{ functionName }}不分页查询模型 + """ + {% if vo_field_daterange.has_daterange %} + {% for column in columns %} + {% if column.html_type == "datetime" and column.query_type == "BETWEEN" %} + begin_{{ column.column_name }}: str | None = Field(default=None, description='开始{{ column.column_comment }}') + end_{{ column.column_name }}: str | None = Field(default=None, description='结束{{ column.column_comment }}') + {% endif %} + {% endfor %} + {% else %} + pass + {% endif %} + + +class {{ BusinessName }}PageQueryModel({{ BusinessName }}QueryModel): + """ + {{ functionName }}分页查询模型 + """ + + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') + + +class Delete{{ BusinessName }}Model(BaseModel): + """ + 删除{{ functionName }}模型 + """ + + model_config = ConfigDict(alias_generator=to_camel) + + {{ pk_field }}s: str = Field(description='需要删除的{{ pk_field_comment }}') diff --git a/shierfeng-fastapi-backend/module_generator/templates/sql/sql.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/sql/sql.jinja2 new file mode 100644 index 0000000..654216c --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/sql/sql.jinja2 @@ -0,0 +1,50 @@ +{% if dbType == 'postgresql' %} +DO $$ +DECLARE + parentId bigint; +BEGIN + -- 菜单 SQL + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}', '{{ parentMenuId }}', '1', '{{ businessName }}', '{{ moduleName }}/{{ businessName }}/index', 1, 0, 'C', '0', '0', '{{ permissionPrefix }}:list', '#', 'admin', current_timestamp, '', null, '{{ functionName }}菜单') + returning menu_id into parentId; + + -- 按钮 SQL + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}查询', parentId, '1', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:query', '#', 'admin', current_timestamp, '', null, ''); + + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}新增', parentId, '2', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:add', '#', 'admin', current_timestamp, '', null, ''); + + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}修改', parentId, '3', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:edit', '#', 'admin', current_timestamp, '', null, ''); + + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}删除', parentId, '4', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:remove', '#', 'admin', current_timestamp, '', null, ''); + + insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) + values('{{ functionName }}导出', parentId, '5', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:export', '#', 'admin', current_timestamp, '', null, ''); +END $$; +{% else %} +-- 菜单 SQL +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}', '{{ parentMenuId }}', '1', '{{ businessName }}', '{{ moduleName }}/{{ businessName }}/index', 1, 0, 'C', '0', '0', '{{ permissionPrefix }}:list', '#', 'admin', sysdate(), '', null, '{{ functionName }}菜单'); + +-- 按钮父菜单ID +SELECT @parentId := LAST_INSERT_ID(); + +-- 按钮 SQL +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}查询', @parentId, '1', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:query', '#', 'admin', sysdate(), '', null, ''); + +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}新增', @parentId, '2', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:add', '#', 'admin', sysdate(), '', null, ''); + +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}修改', @parentId, '3', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:edit', '#', 'admin', sysdate(), '', null, ''); + +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}删除', @parentId, '4', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:remove', '#', 'admin', sysdate(), '', null, ''); + +insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark) +values('{{ functionName }}导出', @parentId, '5', '#', '', 1, 0, 'F', '0', '0', '{{ permissionPrefix }}:export', '#', 'admin', sysdate(), '', null, ''); +{% endif %} \ No newline at end of file diff --git a/shierfeng-fastapi-backend/module_generator/templates/vue/index-tree.vue.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/vue/index-tree.vue.jinja2 new file mode 100644 index 0000000..eb8ceaf --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/vue/index-tree.vue.jinja2 @@ -0,0 +1,496 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-backend/module_generator/templates/vue/index.vue.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/vue/index.vue.jinja2 new file mode 100644 index 0000000..39f861d --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/vue/index.vue.jinja2 @@ -0,0 +1,591 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index-tree.vue.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index-tree.vue.jinja2 new file mode 100644 index 0000000..79fc220 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index-tree.vue.jinja2 @@ -0,0 +1,463 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index.vue.jinja2 b/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index.vue.jinja2 new file mode 100644 index 0000000..8e2c886 --- /dev/null +++ b/shierfeng-fastapi-backend/module_generator/templates/vue/v3/index.vue.jinja2 @@ -0,0 +1,580 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-backend/module_task/__init__.py b/shierfeng-fastapi-backend/module_task/__init__.py new file mode 100644 index 0000000..1f4b412 --- /dev/null +++ b/shierfeng-fastapi-backend/module_task/__init__.py @@ -0,0 +1 @@ +from . import scheduler_test # noqa: F401 diff --git a/shierfeng-fastapi-backend/module_task/scheduler_test.py b/shierfeng-fastapi-backend/module_task/scheduler_test.py new file mode 100644 index 0000000..7862c6d --- /dev/null +++ b/shierfeng-fastapi-backend/module_task/scheduler_test.py @@ -0,0 +1,19 @@ +from datetime import datetime + + +def job(*args, **kwargs) -> None: + """ + 定时任务执行同步函数示例 + """ + print(args) + print(kwargs) + print(f'{datetime.now()}同步函数执行了') + + +async def async_job(*args, **kwargs) -> None: + """ + 定时任务执行异步函数示例 + """ + print(args) + print(kwargs) + print(f'{datetime.now()}异步函数执行了') diff --git a/shierfeng-fastapi-backend/pyproject.toml b/shierfeng-fastapi-backend/pyproject.toml new file mode 100644 index 0000000..04016e3 --- /dev/null +++ b/shierfeng-fastapi-backend/pyproject.toml @@ -0,0 +1,15 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name = "shierfeng-fastapi-backend-cli" +version = "1.9.0" +description = "ShiErFeng FastAPI backend internal CLI entrypoint" +requires-python = ">=3.10" + +[project.scripts] +shierfeng = "cli.main:main" + +[tool.setuptools.packages.find] +include = ["cli*"] diff --git a/shierfeng-fastapi-backend/requirements-pg.txt b/shierfeng-fastapi-backend/requirements-pg.txt new file mode 100644 index 0000000..43d7532 --- /dev/null +++ b/shierfeng-fastapi-backend/requirements-pg.txt @@ -0,0 +1,35 @@ +agno==2.4.8 +aiofiles==25.1.0 +alembic==1.18.3 +anthropic==0.78.0 +APScheduler==3.11.2 +async-lru==2.1.0 +asyncpg==0.31.0 +bcrypt==5.0.0 +cerebras-cloud-sdk==1.67.0 +cohere==5.20.4 +fastapi[all]==0.128.2 +google-genai==1.62.0 +groq==1.0.0 +litellm==1.81.8 +llama-api-client==0.6.0 +loguru==0.7.3 +mistralai==1.12.0 +ollama==0.6.1 +openai==2.17.0 +openpyxl==3.1.5 +pandas==2.3.3 +Pillow==12.1.1 +portkey-ai==2.1.0 +psutil==7.2.2 +psycopg2==2.9.11 +pydantic>=2.11.4 +pydantic-validation-decorator==0.1.5 +PyJWT[crypto]==2.11.0 +redis==7.1.0 +ruff==0.15.0 +SQLAlchemy[asyncio]==2.0.46 +sqlglot[rs]==28.10.0 +textual==8.2.5 +user-agents==2.2.0 +. diff --git a/shierfeng-fastapi-backend/requirements.txt b/shierfeng-fastapi-backend/requirements.txt new file mode 100644 index 0000000..5c17e51 --- /dev/null +++ b/shierfeng-fastapi-backend/requirements.txt @@ -0,0 +1,35 @@ +agno==2.4.8 +aiofiles==25.1.0 +alembic==1.18.3 +anthropic==0.78.0 +APScheduler==3.11.2 +async-lru==2.1.0 +asyncmy==0.2.11 +bcrypt==5.0.0 +cerebras-cloud-sdk==1.67.0 +cohere==5.20.4 +fastapi[all]==0.128.2 +google-genai==1.62.0 +groq==1.0.0 +litellm==1.81.8 +llama-api-client==0.6.0 +loguru==0.7.3 +mistralai==1.12.0 +ollama==0.6.1 +openai==2.17.0 +openpyxl==3.1.5 +pandas==2.3.3 +Pillow==12.1.1 +portkey-ai==2.1.0 +psutil==7.2.2 +pydantic>=2.11.4 +pydantic-validation-decorator==0.1.5 +PyJWT[crypto]==2.11.0 +PyMySQL==1.1.2 +redis==7.1.0 +ruff==0.15.0 +SQLAlchemy[asyncio]==2.0.46 +sqlglot[rs]==28.10.0 +textual==8.2.5 +user-agents==2.2.0 +. diff --git a/shierfeng-fastapi-backend/ruff.toml b/shierfeng-fastapi-backend/ruff.toml new file mode 100644 index 0000000..23d788c --- /dev/null +++ b/shierfeng-fastapi-backend/ruff.toml @@ -0,0 +1,68 @@ +line-length = 120 +show-fixes = true +target-version = "py310" +unsafe-fixes = true + +[lint] +select = [ + "FAST", # fastapi + "ANN", # flake8-annotations + "ASYNC", # flake8-async + "B", # flake8-bugbear + "A", # flake8-builtins + "COM", # flake8-commas + "C4", # flake8-comprehensions + "ISC", # flake8-implicit-str-concat + "ICN", # flake8-import-conventions + "PIE", # flake8-pie + "RSE", # flake8-raise + "RET", # flake8-return + "SIM", # flake8-simplify + "TC", # flake8-type-checking + "FLY", # flynt + "I", # isort + "N", # pep8-naming + "PERF", # perflint + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "PGH", # pygrep-hooks + "PL", # pylint + "UP", # pyupgrade + "RUF", # Ruff-specific rules +] +ignore = [ + "ANN002", # missing type annotation for *{name} + "ANN003", # missing type annotation for **{name} + "ANN401", # dynamically typed expressions (typing.Any) are disallowed in {name} + "B008", # do not perform function calls in argument defaults + "COM812", # trailing comma missing + "RET504", # unnecessary assignment to {name} before return statement + "SIM105", # use contextlib.suppress({exception}) instead of try-except-pass + "C901", # too complex + "N818", # exception name {name} should be named with an Error suffix + "E501", # line too long + "W191", # indentation contains tabs + "RUF001", # string contains ambiguous + "RUF002", # docstring contains ambiguous + "RUF003", # comment contains ambiguous + "RUF012", # mutable class attributes should be annotated with typing.ClassVar +] + +[lint.flake8-type-checking] +runtime-evaluated-base-classes = ["pydantic.BaseModel", "sqlalchemy.orm.DeclarativeBase"] + +[lint.isort] +known-third-party = ["alembic"] + +[lint.pylint] +max-args = 10 +max-returns = 10 + +[lint.pyupgrade] +# Preserve types, even if a file imports `from __future__ import annotations`. +keep-runtime-typing = true + +[format] +docstring-code-format = true +quote-style = "single" \ No newline at end of file diff --git a/shierfeng-fastapi-backend/server.py b/shierfeng-fastapi-backend/server.py new file mode 100644 index 0000000..c635503 --- /dev/null +++ b/shierfeng-fastapi-backend/server.py @@ -0,0 +1,168 @@ +import asyncio +from collections.abc import AsyncGenerator +from contextlib import asynccontextmanager + +from fastapi import FastAPI + +from common.constant import LockConstant +from common.router import auto_register_routers +from config.env import AppConfig +from config.get_db import close_async_engine, init_create_table +from config.get_redis import RedisUtil +from config.get_scheduler import SchedulerUtil +from exceptions.handle import handle_exception +from middlewares.handle import handle_middleware +from module_admin.service.log_service import LogAggregatorService +from sub_applications.handle import handle_sub_applications +from utils.common_util import worship +from utils.log_util import logger +from utils.server_util import APIDocsUtil, IPUtil, StartupUtil +from utils.transport_crypto_util import TransportKeyProvider + + +async def _start_background_tasks(app: FastAPI) -> None: + """ + 启动应用后台任务 + + :param app: FastAPI对象 + :return: None + """ + await SchedulerUtil.init_system_scheduler(app.state.redis) + app.state.log_aggregator_task = asyncio.create_task(LogAggregatorService.consume_stream(app.state.redis)) + + +async def _stop_background_tasks(app: FastAPI) -> None: + """ + 停止应用后台任务并释放资源 + + :param app: FastAPI对象 + :return: None + """ + log_task = getattr(app.state, 'log_aggregator_task', None) + if log_task: + log_task.cancel() + try: + await log_task + except asyncio.CancelledError: + pass + lock_task = getattr(app.state, 'lock_renewal_task', None) + if lock_task: + lock_task.cancel() + try: + await lock_task + except asyncio.CancelledError: + pass + await RedisUtil.close_redis_pool(app) + await SchedulerUtil.close_system_scheduler() + await close_async_engine() + + +# 生命周期事件 +@asynccontextmanager +async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]: + """ + 应用生命周期管理 + + :param app: FastAPI对象 + :return: None + """ + app.state.redis = await RedisUtil.create_redis_pool(log_enabled=False) + startup_log_enabled = await StartupUtil.acquire_startup_log_gate( + redis=app.state.redis, + lock_key=LockConstant.APP_STARTUP_LOCK_KEY, + worker_id=SchedulerUtil._worker_id, + lock_expire_seconds=LockConstant.LOCK_EXPIRE_SECONDS, + ) + app.state.startup_log_enabled = startup_log_enabled + + # 获取锁成功后立即启动锁续期任务,避免初始化时间过长导致锁过期 + if startup_log_enabled: + app.state.lock_renewal_task = StartupUtil.start_lock_renewal( + redis=app.state.redis, + lock_key=LockConstant.APP_STARTUP_LOCK_KEY, + worker_id=SchedulerUtil._worker_id, + lock_expire_seconds=LockConstant.LOCK_EXPIRE_SECONDS, + interval_seconds=LockConstant.LOCK_RENEWAL_INTERVAL, + on_lock_lost=SchedulerUtil.on_lock_lost, + ) + + with logger.contextualize(startup_phase=True, startup_log_enabled=startup_log_enabled): + logger.info(f'⏰️ {AppConfig.app_name}开始启动') + if startup_log_enabled: + worship() + TransportKeyProvider.validate_runtime_configuration() + await init_create_table() + await RedisUtil.check_redis_connection(app.state.redis, log_enabled=startup_log_enabled) + await RedisUtil.init_sys_dict(app.state.redis) + await RedisUtil.init_sys_config(app.state.redis) + await _start_background_tasks(app) + + if startup_log_enabled: + # 短暂等待确保下面的启动日志在最后打印 + await asyncio.sleep(0.5) + logger.info(f'🚀 {AppConfig.app_name}启动成功') + host = AppConfig.app_host + port = AppConfig.app_port + if host == '0.0.0.0': + local_ip = IPUtil.get_local_ip() + network_ips = IPUtil.get_network_ips() + else: + local_ip = host + network_ips = [host] + + app_links = [f'🏠 Local: http://{local_ip}:{port}'] + app_links.extend(f'📡 Network: http://{ip}:{port}' for ip in network_ips) + logger.opt(colors=True).info('💻 应用地址:\n' + '\n'.join(app_links)) + + if not AppConfig.app_disable_swagger: + swagger_links = [f'🏠 Local: http://{local_ip}:{port}{APIDocsUtil.docs_url()}'] + swagger_links.extend( + f'📡 Network: http://{ip}:{port}{APIDocsUtil.docs_url()}' for ip in network_ips + ) + logger.opt(colors=True).info('📄 Swagger文档:\n' + '\n'.join(swagger_links)) + + if not AppConfig.app_disable_redoc: + redoc_links = [f'🏠 Local: http://{local_ip}:{port}{APIDocsUtil.redoc_url()}'] + redoc_links.extend( + f'📡 Network: http://{ip}:{port}{APIDocsUtil.redoc_url()}' for ip in network_ips + ) + logger.opt(colors=True).info('📚 ReDoc文档:\n' + '\n'.join(redoc_links)) + yield + shutdown_log_enabled = getattr(app.state, 'startup_log_enabled', False) + with logger.contextualize(startup_phase=True, startup_log_enabled=shutdown_log_enabled): + await _stop_background_tasks(app) + + +def create_app() -> FastAPI: + """ + 创建FastAPI应用 + + :return: FastAPI对象 + """ + # 配置API文档静态资源 + APIDocsUtil.setup_docs_static_resources() + # 初始化FastAPI对象 + app = FastAPI( + title=AppConfig.app_name, + description=f'{AppConfig.app_name}接口文档', + version=AppConfig.app_version, + lifespan=lifespan, + openapi_url=APIDocsUtil.proxy_openapi_url(), + docs_url=APIDocsUtil.proxy_docs_url(), + redoc_url=APIDocsUtil.proxy_redoc_url(), + swagger_ui_oauth2_redirect_url=APIDocsUtil.proxy_oauth2_redirect_url(), + ) + + # 自定义API文档路由,修复无法直接通过后端地址访问文档的问题 + APIDocsUtil.custom_api_docs_router(app) + + # 挂载子应用 + handle_sub_applications(app) + # 加载中间件处理方法 + handle_middleware(app) + # 加载全局异常处理方法 + handle_exception(app) + # 自动注册路由 + auto_register_routers(app) + + return app diff --git a/shierfeng-fastapi-backend/sql/shierfeng-fastapi-pg.sql b/shierfeng-fastapi-backend/sql/shierfeng-fastapi-pg.sql new file mode 100644 index 0000000..7c59a84 --- /dev/null +++ b/shierfeng-fastapi-backend/sql/shierfeng-fastapi-pg.sql @@ -0,0 +1,1180 @@ +-- ---------------------------- +-- 1、部门表 +-- ---------------------------- +drop table if exists sys_dept; +create table sys_dept ( + dept_id bigserial, + parent_id bigint default 0, + ancestors varchar(50) default '', + dept_name varchar(30) default '', + order_num int4 default 0, + leader varchar(20) default null, + phone varchar(11) default null, + email varchar(50) default null, + status char(1) default '0', + del_flag char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + primary key (dept_id) +); +alter sequence sys_dept_dept_id_seq restart 200; +comment on column sys_dept.dept_id is '部门id'; +comment on column sys_dept.parent_id is '父部门id'; +comment on column sys_dept.ancestors is '祖级列表'; +comment on column sys_dept.dept_name is '部门名称'; +comment on column sys_dept.order_num is '显示顺序'; +comment on column sys_dept.leader is '负责人'; +comment on column sys_dept.phone is '联系电话'; +comment on column sys_dept.email is '邮箱'; +comment on column sys_dept.status is '部门状态(0正常 1停用)'; +comment on column sys_dept.del_flag is '删除标志(0代表存在 2代表删除)'; +comment on column sys_dept.create_by is '创建者'; +comment on column sys_dept.create_time is '创建时间'; +comment on column sys_dept.update_by is '更新者'; +comment on column sys_dept.update_time is '更新时间'; +comment on table sys_dept is '部门表'; + +-- ---------------------------- +-- 初始化-部门表数据 +-- ---------------------------- +insert into sys_dept values(100, 0, '0', '集团总公司', 0, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(101, 100, '0,100', '深圳分公司', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(102, 100, '0,100', '长沙分公司', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(103, 101, '0,100,101', '研发部门', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(104, 101, '0,100,101', '市场部门', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(105, 101, '0,100,101', '测试部门', 3, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(106, 101, '0,100,101', '财务部门', 4, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(107, 101, '0,100,101', '运维部门', 5, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(108, 102, '0,100,102', '市场部门', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); +insert into sys_dept values(109, 102, '0,100,102', '财务部门', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', current_timestamp, '', null); + +-- ---------------------------- +-- 2、用户信息表 +-- ---------------------------- +drop table if exists sys_user; +create table sys_user ( + user_id bigserial not null, + dept_id bigint default null, + user_name varchar(30) not null, + nick_name varchar(30) not null, + user_type varchar(2) default '00', + email varchar(50) default '', + phonenumber varchar(11) default '', + sex char(1) default '0', + avatar varchar(100) default '', + password varchar(100) default '', + status char(1) default '0', + del_flag char(1) default '0', + login_ip varchar(128) default '', + login_date timestamp(0), + pwd_update_date timestamp(0), + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (user_id) +); +alter sequence sys_user_user_id_seq restart 100; +comment on column sys_user.user_id is '用户ID'; +comment on column sys_user.dept_id is '部门ID'; +comment on column sys_user.user_name is '用户账号'; +comment on column sys_user.nick_name is '用户昵称'; +comment on column sys_user.user_type is '用户类型(00系统用户)'; +comment on column sys_user.email is '用户邮箱'; +comment on column sys_user.phonenumber is '手机号码'; +comment on column sys_user.sex is '用户性别(0男 1女 2未知)'; +comment on column sys_user.avatar is '头像地址'; +comment on column sys_user.password is '密码'; +comment on column sys_user.status is '帐号状态(0正常 1停用)'; +comment on column sys_user.del_flag is '删除标志(0代表存在 2代表删除)'; +comment on column sys_user.login_ip is '最后登录IP'; +comment on column sys_user.login_date is '最后登录时间'; +comment on column sys_user.pwd_update_date is '密码最后更新时间'; +comment on column sys_user.create_by is '创建者'; +comment on column sys_user.create_time is '创建时间'; +comment on column sys_user.update_by is '更新者'; +comment on column sys_user.update_time is '更新时间'; +comment on column sys_user.remark is '备注'; +comment on table sys_user is '用户信息表'; + +-- ---------------------------- +-- 初始化-用户信息表数据 +-- ---------------------------- +insert into sys_user values(1, 103, 'admin', '超级管理员', '00', 'niangao@163.com', '15888888888', '1', '', '$2a$10$7JB720yubVSZvUI0rEqK/.VqGOZTH.ulu33dHOiBE8ByOhJIrdAu2', '0', '0', '127.0.0.1', current_timestamp, current_timestamp, 'admin', current_timestamp, '', null, '管理员'); +insert into sys_user values(2, 105, 'niangao', '年糕', '00', 'niangao@qq.com', '15666666666', '1', '', '$2a$10$7JB720yubVSZvUI0rEqK/.VqGOZTH.ulu33dHOiBE8ByOhJIrdAu2', '0', '0', '127.0.0.1', current_timestamp, current_timestamp, 'admin', current_timestamp, '', null, '测试员'); + +-- ---------------------------- +-- 3、岗位信息表 +-- ---------------------------- +drop table if exists sys_post; +create table sys_post ( + post_id bigserial not null, + post_code varchar(64) not null, + post_name varchar(50) not null, + post_sort int4 not null, + status char(1) not null, + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (post_id) +); +alter sequence sys_post_post_id_seq restart 5; +comment on column sys_post.post_id is '岗位ID'; +comment on column sys_post.post_code is '岗位编码'; +comment on column sys_post.post_name is '岗位名称'; +comment on column sys_post.post_sort is '显示顺序'; +comment on column sys_post.status is '状态(0正常 1停用)'; +comment on column sys_post.create_by is '创建者'; +comment on column sys_post.create_time is '创建时间'; +comment on column sys_post.update_by is '更新者'; +comment on column sys_post.update_time is '更新时间'; +comment on column sys_post.remark is '备注'; +comment on table sys_post is '岗位信息表'; + +-- ---------------------------- +-- 初始化-岗位信息表数据 +-- ---------------------------- +insert into sys_post values(1, 'ceo', '董事长', 1, '0', 'admin', current_timestamp, '', null, ''); +insert into sys_post values(2, 'se', '项目经理', 2, '0', 'admin', current_timestamp, '', null, ''); +insert into sys_post values(3, 'hr', '人力资源', 3, '0', 'admin', current_timestamp, '', null, ''); +insert into sys_post values(4, 'user', '普通员工', 4, '0', 'admin', current_timestamp, '', null, ''); + +-- ---------------------------- +-- 4、角色信息表 +-- ---------------------------- +drop table if exists sys_role; +create table sys_role ( + role_id bigserial not null, + role_name varchar(30) not null, + role_key varchar(100) not null, + role_sort int4 not null, + data_scope char(1) default '1', + menu_check_strictly smallint default 1, + dept_check_strictly smallint default 1, + status char(1) not null, + del_flag char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (role_id) +); +alter sequence sys_role_role_id_seq restart 3; +comment on column sys_role.role_id is '角色ID'; +comment on column sys_role.role_name is '角色名称'; +comment on column sys_role.role_key is '角色权限字符串'; +comment on column sys_role.role_sort is '显示顺序'; +comment on column sys_role.data_scope is '数据范围(1:全部数据权限 2:自定数据权限 3:本部门数据权限 4:本部门及以下数据权限)'; +comment on column sys_role.menu_check_strictly is '菜单树选择项是否关联显示'; +comment on column sys_role.dept_check_strictly is '部门树选择项是否关联显示'; +comment on column sys_role.status is '角色状态(0正常 1停用)'; +comment on column sys_role.del_flag is '删除标志(0代表存在 2代表删除)'; +comment on column sys_role.create_by is '创建者'; +comment on column sys_role.create_time is '创建时间'; +comment on column sys_role.update_by is '更新者'; +comment on column sys_role.update_time is '更新时间'; +comment on column sys_role.remark is '备注'; +comment on table sys_role is '角色信息表'; + +-- ---------------------------- +-- 初始化-角色信息表数据 +-- ---------------------------- +insert into sys_role values(1, '超级管理员', 'admin', 1, 1, 1, 1, '0', '0', 'admin', current_timestamp, '', null, '超级管理员'); +insert into sys_role values(2, '普通角色', 'common', 2, 2, 1, 1, '0', '0', 'admin', current_timestamp, '', null, '普通角色'); + +-- ---------------------------- +-- 5、菜单权限表 +-- ---------------------------- +drop table if exists sys_menu; +create table sys_menu ( + menu_id bigserial not null, + menu_name varchar(50) not null, + parent_id bigint default 0, + order_num int4 default 0, + path varchar(200) default '', + component varchar(255) default null, + query varchar(255) default null, + route_name varchar(50) default '', + is_frame int4 default 1, + is_cache int4 default 0, + menu_type char(1) default '', + visible char(1) default '0', + status char(1) default '0', + perms varchar(100) default null, + icon varchar(100) default '#', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default '', + primary key (menu_id) +); +alter sequence sys_menu_menu_id_seq restart 2000; +comment on column sys_menu.menu_id is '菜单ID'; +comment on column sys_menu.menu_name is '菜单名称'; +comment on column sys_menu.parent_id is '父菜单ID'; +comment on column sys_menu.order_num is '显示顺序'; +comment on column sys_menu.path is '路由地址'; +comment on column sys_menu.component is '组件路径'; +comment on column sys_menu.query is '路由参数'; +comment on column sys_menu.route_name is '路由名称'; +comment on column sys_menu.is_frame is '是否为外链(0是 1否)'; +comment on column sys_menu.is_cache is '是否缓存(0缓存 1不缓存)'; +comment on column sys_menu.menu_type is '菜单类型(M目录 C菜单 F按钮)'; +comment on column sys_menu.visible is '菜单状态(0显示 1隐藏)'; +comment on column sys_menu.status is '菜单状态(0正常 1停用)'; +comment on column sys_menu.perms is '权限标识'; +comment on column sys_menu.icon is '菜单图标'; +comment on column sys_menu.create_by is '创建者'; +comment on column sys_menu.create_time is '创建时间'; +comment on column sys_menu.update_by is '更新者'; +comment on column sys_menu.update_time is '更新时间'; +comment on column sys_menu.remark is '备注'; +comment on table sys_menu is '菜单权限表'; + +-- ---------------------------- +-- 初始化-菜单信息表数据 +-- ---------------------------- +-- 一级菜单 +insert into sys_menu values(1, '系统管理', 0, '1', 'system', null, '', '', 1, 0, 'M', '0', '0', '', 'system', 'admin', current_timestamp, '', null, '系统管理目录'); +insert into sys_menu values(2, '系统监控', 0, '2', 'monitor', null, '', '', 1, 0, 'M', '0', '0', '', 'monitor', 'admin', current_timestamp, '', null, '系统监控目录'); +insert into sys_menu values(3, '系统工具', 0, '3', 'tool', null, '', '', 1, 0, 'M', '0', '0', '', 'tool', 'admin', current_timestamp, '', null, '系统工具目录'); +insert into sys_menu values(4, 'AI 管理', 0, '4', 'ai', null, '', '', 1, 0, 'M', '0', '0', '', 'bug', 'admin', current_timestamp, '', null, 'AI 管理目录'); +insert into sys_menu values(99, '施尔丰仓库', 0, '99', 'https://git.yujiangrubber.cn/niuniu/ShiErFeng', null, '', '', 0, 0, 'M', '0', '0', '', 'guide', 'admin', current_timestamp, '', null, '施尔丰仓库地址'); +-- 二级菜单 +insert into sys_menu values(100, '用户管理', 1, '1', 'user', 'system/user/index', '', '', 1, 0, 'C', '0', '0', 'system:user:list', 'user', 'admin', current_timestamp, '', null, '用户管理菜单'); +insert into sys_menu values(101, '角色管理', 1, '2', 'role', 'system/role/index', '', '', 1, 0, 'C', '0', '0', 'system:role:list', 'peoples', 'admin', current_timestamp, '', null, '角色管理菜单'); +insert into sys_menu values(102, '菜单管理', 1, '3', 'menu', 'system/menu/index', '', '', 1, 0, 'C', '0', '0', 'system:menu:list', 'tree-table', 'admin', current_timestamp, '', null, '菜单管理菜单'); +insert into sys_menu values(103, '部门管理', 1, '4', 'dept', 'system/dept/index', '', '', 1, 0, 'C', '0', '0', 'system:dept:list', 'tree', 'admin', current_timestamp, '', null, '部门管理菜单'); +insert into sys_menu values(104, '岗位管理', 1, '5', 'post', 'system/post/index', '', '', 1, 0, 'C', '0', '0', 'system:post:list', 'post', 'admin', current_timestamp, '', null, '岗位管理菜单'); +insert into sys_menu values(105, '字典管理', 1, '6', 'dict', 'system/dict/index', '', '', 1, 0, 'C', '0', '0', 'system:dict:list', 'dict', 'admin', current_timestamp, '', null, '字典管理菜单'); +insert into sys_menu values(106, '参数设置', 1, '7', 'config', 'system/config/index', '', '', 1, 0, 'C', '0', '0', 'system:config:list', 'edit', 'admin', current_timestamp, '', null, '参数设置菜单'); +insert into sys_menu values(107, '通知公告', 1, '8', 'notice', 'system/notice/index', '', '', 1, 0, 'C', '0', '0', 'system:notice:list', 'message', 'admin', current_timestamp, '', null, '通知公告菜单'); +insert into sys_menu values(108, '日志管理', 1, '9', 'log', '', '', '', 1, 0, 'M', '0', '0', '', 'log', 'admin', current_timestamp, '', null, '日志管理菜单'); +insert into sys_menu values(109, '在线用户', 2, '1', 'online', 'monitor/online/index', '', '', 1, 0, 'C', '0', '0', 'monitor:online:list', 'online', 'admin', current_timestamp, '', null, '在线用户菜单'); +insert into sys_menu values(110, '定时任务', 2, '2', 'job', 'monitor/job/index', '', '', 1, 0, 'C', '0', '0', 'monitor:job:list', 'job', 'admin', current_timestamp, '', null, '定时任务菜单'); +insert into sys_menu values(111, '数据监控', 2, '3', 'druid', 'monitor/druid/index', '', '', 1, 0, 'C', '0', '0', 'monitor:druid:list', 'druid', 'admin', current_timestamp, '', null, '数据监控菜单'); +insert into sys_menu values(112, '服务监控', 2, '4', 'server', 'monitor/server/index', '', '', 1, 0, 'C', '0', '0', 'monitor:server:list', 'server', 'admin', current_timestamp, '', null, '服务监控菜单'); +insert into sys_menu values(113, '缓存监控', 2, '5', 'cache', 'monitor/cache/index', '', '', 1, 0, 'C', '0', '0', 'monitor:cache:list', 'redis', 'admin', current_timestamp, '', null, '缓存监控菜单'); +insert into sys_menu values(114, '缓存列表', 2, '6', 'cacheList', 'monitor/cache/list', '', '', 1, 0, 'C', '0', '0', 'monitor:cache:list', 'redis-list', 'admin', current_timestamp, '', null, '缓存列表菜单'); +insert into sys_menu values(120, '传输加密', 2, '7', 'transportCrypto', 'monitor/transportCrypto/index', '', '', 1, 0, 'C', '0', '0', 'monitor:transportCrypto:list', 'chart', 'admin', current_timestamp, '', null, '传输加密监控菜单'); +insert into sys_menu values(115, '表单构建', 3, '1', 'build', 'tool/build/index', '', '', 1, 0, 'C', '0', '0', 'tool:build:list', 'build', 'admin', current_timestamp, '', null, '表单构建菜单'); +insert into sys_menu values(116, '代码生成', 3, '2', 'gen', 'tool/gen/index', '', '', 1, 0, 'C', '0', '0', 'tool:gen:list', 'code', 'admin', current_timestamp, '', null, '代码生成菜单'); +insert into sys_menu values(117, '系统接口', 3, '3', 'swagger', 'tool/swagger/index', '', '', 1, 0, 'C', '0', '0', 'tool:swagger:list', 'swagger', 'admin', current_timestamp, '', null, '系统接口菜单'); +insert into sys_menu values(118, '模型管理', 4, '1', 'model', 'ai/model/index', '', '', 1, 0, 'C', '0', '0', 'ai:model:list', 'form', 'admin', current_timestamp, '', null, '模型管理菜单'); +insert into sys_menu values(119, 'AI 对话', 4, '2', 'chat', 'ai/chat/index', '', '', 1, 0, 'C', '0', '0', 'ai:chat:list', 'wechat', 'admin', current_timestamp, '', null, 'AI 对话菜单'); +-- 三级菜单 +insert into sys_menu values(500, '操作日志', 108, '1', 'operlog', 'monitor/operlog/index', '', '', 1, 0, 'C', '0', '0', 'monitor:operlog:list', 'form', 'admin', current_timestamp, '', null, '操作日志菜单'); +insert into sys_menu values(501, '登录日志', 108, '2', 'logininfor', 'monitor/logininfor/index', '', '', 1, 0, 'C', '0', '0', 'monitor:logininfor:list', 'logininfor', 'admin', current_timestamp, '', null, '登录日志菜单'); +-- 用户管理按钮 +insert into sys_menu values(1000, '用户查询', 100, '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1001, '用户新增', 100, '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1002, '用户修改', 100, '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1003, '用户删除', 100, '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1004, '用户导出', 100, '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:export', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1005, '用户导入', 100, '6', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:import', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1006, '重置密码', 100, '7', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:resetPwd', '#', 'admin', current_timestamp, '', null, ''); +-- 角色管理按钮 +insert into sys_menu values(1007, '角色查询', 101, '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1008, '角色新增', 101, '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1009, '角色修改', 101, '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1010, '角色删除', 101, '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1011, '角色导出', 101, '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:export', '#', 'admin', current_timestamp, '', null, ''); +-- 菜单管理按钮 +insert into sys_menu values(1012, '菜单查询', 102, '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1013, '菜单新增', 102, '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1014, '菜单修改', 102, '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1015, '菜单删除', 102, '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:remove', '#', 'admin', current_timestamp, '', null, ''); +-- 部门管理按钮 +insert into sys_menu values(1016, '部门查询', 103, '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1017, '部门新增', 103, '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1018, '部门修改', 103, '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1019, '部门删除', 103, '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:remove', '#', 'admin', current_timestamp, '', null, ''); +-- 岗位管理按钮 +insert into sys_menu values(1020, '岗位查询', 104, '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1021, '岗位新增', 104, '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1022, '岗位修改', 104, '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1023, '岗位删除', 104, '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1024, '岗位导出', 104, '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:export', '#', 'admin', current_timestamp, '', null, ''); +-- 字典管理按钮 +insert into sys_menu values(1025, '字典查询', 105, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1026, '字典新增', 105, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1027, '字典修改', 105, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1028, '字典删除', 105, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1029, '字典导出', 105, '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:export', '#', 'admin', current_timestamp, '', null, ''); +-- 参数设置按钮 +insert into sys_menu values(1030, '参数查询', 106, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1031, '参数新增', 106, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1032, '参数修改', 106, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1033, '参数删除', 106, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1034, '参数导出', 106, '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:export', '#', 'admin', current_timestamp, '', null, ''); +-- 通知公告按钮 +insert into sys_menu values(1035, '公告查询', 107, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1036, '公告新增', 107, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1037, '公告修改', 107, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1038, '公告删除', 107, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:remove', '#', 'admin', current_timestamp, '', null, ''); +-- 操作日志按钮 +insert into sys_menu values(1039, '操作查询', 500, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1040, '操作删除', 500, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1041, '日志导出', 500, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:export', '#', 'admin', current_timestamp, '', null, ''); +-- 登录日志按钮 +insert into sys_menu values(1042, '登录查询', 501, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1043, '登录删除', 501, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1044, '日志导出', 501, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:export', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1045, '账户解锁', 501, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:unlock', '#', 'admin', current_timestamp, '', null, ''); +-- 在线用户按钮 +insert into sys_menu values(1046, '在线查询', 109, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1047, '批量强退', 109, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:batchLogout', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1048, '单条强退', 109, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:forceLogout', '#', 'admin', current_timestamp, '', null, ''); +-- 定时任务按钮 +insert into sys_menu values(1049, '任务查询', 110, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1050, '任务新增', 110, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1051, '任务修改', 110, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1052, '任务删除', 110, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1053, '状态修改', 110, '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:changeStatus', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1054, '任务导出', 110, '6', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:export', '#', 'admin', current_timestamp, '', null, ''); +-- 代码生成按钮 +insert into sys_menu values(1055, '生成查询', 116, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1056, '生成修改', 116, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1057, '生成删除', 116, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:remove', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1058, '导入代码', 116, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:import', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1059, '预览代码', 116, '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:preview', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1060, '生成代码', 116, '6', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:code', '#', 'admin', current_timestamp, '', null, ''); +-- 模型管理按钮 +insert into sys_menu values(1061, '模型查询', 118, '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:query', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1062, '模型新增', 118, '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:add', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1063, '模型修改', 118, '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:edit', '#', 'admin', current_timestamp, '', null, ''); +insert into sys_menu values(1064, '模型删除', 118, '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:remove', '#', 'admin', current_timestamp, '', null, ''); + +-- ---------------------------- +-- 6、用户和角色关联表 用户N-1角色 +-- ---------------------------- +drop table if exists sys_user_role; +create table sys_user_role ( + user_id bigint not null, + role_id bigint not null, + primary key (user_id, role_id) +); +comment on column sys_user_role.user_id is '用户ID'; +comment on column sys_user_role.role_id is '角色ID'; +comment on table sys_user_role is '用户和角色关联表'; + +-- ---------------------------- +-- 初始化-用户和角色关联表数据 +-- ---------------------------- +insert into sys_user_role values (1, 1); +insert into sys_user_role values (2, 2); + +-- ---------------------------- +-- 7、角色和菜单关联表 角色1-N菜单 +-- ---------------------------- +drop table if exists sys_role_menu; +create table sys_role_menu ( + role_id bigint not null, + menu_id bigint not null, + primary key (role_id, menu_id) +); +comment on column sys_role_menu.role_id is '角色ID'; +comment on column sys_role_menu.menu_id is '菜单ID'; +comment on table sys_role_menu is '角色和菜单关联表'; + +-- ---------------------------- +-- 初始化-角色和菜单关联表数据 +-- ---------------------------- +insert into sys_role_menu values (2, 1); +insert into sys_role_menu values (2, 2); +insert into sys_role_menu values (2, 3); +insert into sys_role_menu values (2, 4); +insert into sys_role_menu values (2, 100); +insert into sys_role_menu values (2, 101); +insert into sys_role_menu values (2, 102); +insert into sys_role_menu values (2, 103); +insert into sys_role_menu values (2, 104); +insert into sys_role_menu values (2, 105); +insert into sys_role_menu values (2, 106); +insert into sys_role_menu values (2, 107); +insert into sys_role_menu values (2, 108); +insert into sys_role_menu values (2, 109); +insert into sys_role_menu values (2, 110); +insert into sys_role_menu values (2, 111); +insert into sys_role_menu values (2, 112); +insert into sys_role_menu values (2, 113); +insert into sys_role_menu values (2, 114); +insert into sys_role_menu values (2, 120); +insert into sys_role_menu values (2, 115); +insert into sys_role_menu values (2, 116); +insert into sys_role_menu values (2, 117); +insert into sys_role_menu values (2, 500); +insert into sys_role_menu values (2, 501); +insert into sys_role_menu values (2, 1000); +insert into sys_role_menu values (2, 1001); +insert into sys_role_menu values (2, 1002); +insert into sys_role_menu values (2, 1003); +insert into sys_role_menu values (2, 1004); +insert into sys_role_menu values (2, 1005); +insert into sys_role_menu values (2, 1006); +insert into sys_role_menu values (2, 1007); +insert into sys_role_menu values (2, 1008); +insert into sys_role_menu values (2, 1009); +insert into sys_role_menu values (2, 1010); +insert into sys_role_menu values (2, 1011); +insert into sys_role_menu values (2, 1012); +insert into sys_role_menu values (2, 1013); +insert into sys_role_menu values (2, 1014); +insert into sys_role_menu values (2, 1015); +insert into sys_role_menu values (2, 1016); +insert into sys_role_menu values (2, 1017); +insert into sys_role_menu values (2, 1018); +insert into sys_role_menu values (2, 1019); +insert into sys_role_menu values (2, 1020); +insert into sys_role_menu values (2, 1021); +insert into sys_role_menu values (2, 1022); +insert into sys_role_menu values (2, 1023); +insert into sys_role_menu values (2, 1024); +insert into sys_role_menu values (2, 1025); +insert into sys_role_menu values (2, 1026); +insert into sys_role_menu values (2, 1027); +insert into sys_role_menu values (2, 1028); +insert into sys_role_menu values (2, 1029); +insert into sys_role_menu values (2, 1030); +insert into sys_role_menu values (2, 1031); +insert into sys_role_menu values (2, 1032); +insert into sys_role_menu values (2, 1033); +insert into sys_role_menu values (2, 1034); +insert into sys_role_menu values (2, 1035); +insert into sys_role_menu values (2, 1036); +insert into sys_role_menu values (2, 1037); +insert into sys_role_menu values (2, 1038); +insert into sys_role_menu values (2, 1039); +insert into sys_role_menu values (2, 1040); +insert into sys_role_menu values (2, 1041); +insert into sys_role_menu values (2, 1042); +insert into sys_role_menu values (2, 1043); +insert into sys_role_menu values (2, 1044); +insert into sys_role_menu values (2, 1045); +insert into sys_role_menu values (2, 1046); +insert into sys_role_menu values (2, 1047); +insert into sys_role_menu values (2, 1048); +insert into sys_role_menu values (2, 1049); +insert into sys_role_menu values (2, 1050); +insert into sys_role_menu values (2, 1051); +insert into sys_role_menu values (2, 1052); +insert into sys_role_menu values (2, 1053); +insert into sys_role_menu values (2, 1054); +insert into sys_role_menu values (2, 1055); +insert into sys_role_menu values (2, 1056); +insert into sys_role_menu values (2, 1057); +insert into sys_role_menu values (2, 1058); +insert into sys_role_menu values (2, 1059); +insert into sys_role_menu values (2, 1060); + +-- ---------------------------- +-- 8、角色和部门关联表 角色1-N部门 +-- ---------------------------- +drop table if exists sys_role_dept; +create table sys_role_dept ( + role_id bigint not null, + dept_id bigint not null, + primary key (role_id, dept_id) +); +comment on column sys_role_dept.role_id is '角色ID'; +comment on column sys_role_dept.dept_id is '部门ID'; +comment on table sys_role_dept is '角色和部门关联表'; + +-- ---------------------------- +-- 初始化-角色和部门关联表数据 +-- ---------------------------- +insert into sys_role_dept values (2, 100); +insert into sys_role_dept values (2, 101); +insert into sys_role_dept values (2, 105); + +-- ---------------------------- +-- 9、用户与岗位关联表 用户1-N岗位 +-- ---------------------------- +drop table if exists sys_user_post; +create table sys_user_post ( + user_id bigint not null, + post_id bigint not null, + primary key (user_id, post_id) +); +comment on column sys_user_post.user_id is '用户ID'; +comment on column sys_user_post.post_id is '岗位ID'; +comment on table sys_user_post is '用户与岗位关联表'; + +-- ---------------------------- +-- 初始化-用户与岗位关联表数据 +-- ---------------------------- +insert into sys_user_post values (1, 1); +insert into sys_user_post values (2, 2); + +-- ---------------------------- +-- 10、操作日志记录 +-- ---------------------------- +drop table if exists sys_oper_log; +create table sys_oper_log ( + oper_id bigserial not null, + title varchar(50) default '', + business_type int4 default 0, + method varchar(100) default '', + request_method varchar(10) default '', + operator_type int4 default 0, + oper_name varchar(50) default '', + dept_name varchar(50) default '', + oper_url varchar(255) default '', + oper_ip varchar(128) default '', + oper_location varchar(255) default '', + oper_param varchar(2000) default '', + json_result varchar(2000) default '', + status int4 default 0, + error_msg varchar(2000) default '', + oper_time timestamp(0), + cost_time bigint default 0, + primary key (oper_id) +); +alter sequence sys_oper_log_oper_id_seq restart 100; +create index idx_sys_oper_log_bt on sys_oper_log(business_type); +create index idx_sys_oper_log_s on sys_oper_log(status); +create index idx_sys_oper_log_ot on sys_oper_log(oper_time); +comment on column sys_oper_log.oper_id is '日志主键'; +comment on column sys_oper_log.title is '模块标题'; +comment on column sys_oper_log.business_type is '业务类型(0其它 1新增 2修改 3删除)'; +comment on column sys_oper_log.method is '方法名称'; +comment on column sys_oper_log.request_method is '请求方式'; +comment on column sys_oper_log.operator_type is '操作类别(0其它 1后台用户 2手机端用户)'; +comment on column sys_oper_log.oper_name is '操作人员'; +comment on column sys_oper_log.dept_name is '部门名称'; +comment on column sys_oper_log.oper_url is '请求URL'; +comment on column sys_oper_log.oper_ip is '主机地址'; +comment on column sys_oper_log.oper_location is '操作地点'; +comment on column sys_oper_log.oper_param is '请求参数'; +comment on column sys_oper_log.json_result is '返回参数'; +comment on column sys_oper_log.status is '操作状态(0正常 1异常)'; +comment on column sys_oper_log.error_msg is '错误消息'; +comment on column sys_oper_log.oper_time is '操作时间'; +comment on column sys_oper_log.cost_time is '消耗时间'; +comment on table sys_oper_log is '操作日志记录'; + +-- ---------------------------- +-- 11、字典类型表 +-- ---------------------------- +drop table if exists sys_dict_type; +create table sys_dict_type ( + dict_id bigserial not null, + dict_name varchar(100) default '', + dict_type varchar(100) unique default '', + status char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (dict_id) +); +alter sequence sys_dict_type_dict_id_seq restart 100; +comment on column sys_dict_type.dict_id is '字典主键'; +comment on column sys_dict_type.dict_name is '字典名称'; +comment on column sys_dict_type.dict_type is '字典类型'; +comment on column sys_dict_type.status is '状态(0正常 1停用)'; +comment on column sys_dict_type.create_by is '创建者'; +comment on column sys_dict_type.create_time is '创建时间'; +comment on column sys_dict_type.update_by is '更新者'; +comment on column sys_dict_type.update_time is '更新时间'; +comment on column sys_dict_type.remark is '备注'; +comment on table sys_dict_type is '字典类型表'; + +-- ---------------------------- +-- 初始化-字典类型表数据 +-- ---------------------------- +insert into sys_dict_type values(1, '用户性别', 'sys_user_sex', '0', 'admin', current_timestamp, '', null, '用户性别列表'); +insert into sys_dict_type values(2, '菜单状态', 'sys_show_hide', '0', 'admin', current_timestamp, '', null, '菜单状态列表'); +insert into sys_dict_type values(3, '系统开关', 'sys_normal_disable', '0', 'admin', current_timestamp, '', null, '系统开关列表'); +insert into sys_dict_type values(4, '任务状态', 'sys_job_status', '0', 'admin', current_timestamp, '', null, '任务状态列表'); +insert into sys_dict_type values(5, '任务分组', 'sys_job_group', '0', 'admin', current_timestamp, '', null, '任务分组列表'); +insert into sys_dict_type values(6, '任务执行器', 'sys_job_executor', '0', 'admin', current_timestamp, '', null, '任务执行器列表'); +insert into sys_dict_type values(7, '系统是否', 'sys_yes_no', '0', 'admin', current_timestamp, '', null, '系统是否列表'); +insert into sys_dict_type values(8, '通知类型', 'sys_notice_type', '0', 'admin', current_timestamp, '', null, '通知类型列表'); +insert into sys_dict_type values(9, '通知状态', 'sys_notice_status', '0', 'admin', current_timestamp, '', null, '通知状态列表'); +insert into sys_dict_type values(10, '操作类型', 'sys_oper_type', '0', 'admin', current_timestamp, '', null, '操作类型列表'); +insert into sys_dict_type values(11, '系统状态', 'sys_common_status', '0', 'admin', current_timestamp, '', null, '登录状态列表'); +insert into sys_dict_type values(12, 'AI模型提供商', 'ai_provider_type', '0', 'admin', current_timestamp, '', null, 'AI模型提供商列表'); + +-- ---------------------------- +-- 12、字典数据表 +-- ---------------------------- +drop table if exists sys_dict_data; +create table sys_dict_data ( + dict_code bigserial not null, + dict_sort int4 default 0, + dict_label varchar(100) default '', + dict_value varchar(100) default '', + dict_type varchar(100) default '', + css_class varchar(100) default null, + list_class varchar(100) default null, + is_default char(1) default 'N', + status char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (dict_code) +); +alter sequence sys_dict_data_dict_code_seq restart 100; +comment on column sys_dict_data.dict_code is '字典编码'; +comment on column sys_dict_data.dict_sort is '字典排序'; +comment on column sys_dict_data.dict_label is '字典标签'; +comment on column sys_dict_data.dict_value is '字典键值'; +comment on column sys_dict_data.dict_type is '字典类型'; +comment on column sys_dict_data.css_class is '样式属性(其他样式扩展)'; +comment on column sys_dict_data.list_class is '表格回显样式'; +comment on column sys_dict_data.is_default is '是否默认(Y是 N否)'; +comment on column sys_dict_data.status is '状态(0正常 1停用)'; +comment on column sys_dict_data.create_by is '创建者'; +comment on column sys_dict_data.create_time is '创建时间'; +comment on column sys_dict_data.update_by is '更新者'; +comment on column sys_dict_data.update_time is '更新时间'; +comment on column sys_dict_data.remark is '备注'; +comment on table sys_dict_data is '字典数据表'; + +-- ---------------------------- +-- 初始化-字典数据表数据 +-- ---------------------------- +insert into sys_dict_data values(1, 1, '男', '0', 'sys_user_sex', '', '', 'Y', '0', 'admin', current_timestamp, '', null, '性别男'); +insert into sys_dict_data values(2, 2, '女', '1', 'sys_user_sex', '', '', 'N', '0', 'admin', current_timestamp, '', null, '性别女'); +insert into sys_dict_data values(3, 3, '未知', '2', 'sys_user_sex', '', '', 'N', '0', 'admin', current_timestamp, '', null, '性别未知'); +insert into sys_dict_data values(4, 1, '显示', '0', 'sys_show_hide', '', 'primary', 'Y', '0', 'admin', current_timestamp, '', null, '显示菜单'); +insert into sys_dict_data values(5, 2, '隐藏', '1', 'sys_show_hide', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '隐藏菜单'); +insert into sys_dict_data values(6, 1, '正常', '0', 'sys_normal_disable', '', 'primary', 'Y', '0', 'admin', current_timestamp, '', null, '正常状态'); +insert into sys_dict_data values(7, 2, '停用', '1', 'sys_normal_disable', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '停用状态'); +insert into sys_dict_data values(8, 1, '正常', '0', 'sys_job_status', '', 'primary', 'Y', '0', 'admin', current_timestamp, '', null, '正常状态'); +insert into sys_dict_data values(9, 2, '暂停', '1', 'sys_job_status', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '停用状态'); +insert into sys_dict_data values(10, 1, '默认', 'default', 'sys_job_group', '', '', 'Y', '0', 'admin', current_timestamp, '', null, '默认分组'); +insert into sys_dict_data values(11, 2, '数据库', 'sqlalchemy', 'sys_job_group', '', '', 'N', '0', 'admin', current_timestamp, '', null, '数据库分组'); +insert into sys_dict_data values(12, 3, 'redis', 'redis', 'sys_job_group', '', '', 'N', '0', 'admin', current_timestamp, '', null, 'reids分组'); +insert into sys_dict_data values(13, 1, '默认', 'default', 'sys_job_executor', '', '', 'N', '0', 'admin', current_timestamp, '', null, '线程池'); +insert into sys_dict_data values(14, 2, '进程池', 'processpool', 'sys_job_executor', '', '', 'N', '0', 'admin', current_timestamp, '', null, '进程池'); +insert into sys_dict_data values(15, 1, '是', 'Y', 'sys_yes_no', '', 'primary', 'Y', '0', 'admin', current_timestamp, '', null, '系统默认是'); +insert into sys_dict_data values(16, 2, '否', 'N', 'sys_yes_no', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '系统默认否'); +insert into sys_dict_data values(17, 1, '通知', '1', 'sys_notice_type', '', 'warning', 'Y', '0', 'admin', current_timestamp, '', null, '通知'); +insert into sys_dict_data values(18, 2, '公告', '2', 'sys_notice_type', '', 'success', 'N', '0', 'admin', current_timestamp, '', null, '公告'); +insert into sys_dict_data values(19, 1, '正常', '0', 'sys_notice_status', '', 'primary', 'Y', '0', 'admin', current_timestamp, '', null, '正常状态'); +insert into sys_dict_data values(20, 2, '关闭', '1', 'sys_notice_status', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '关闭状态'); +insert into sys_dict_data values(21, 99, '其他', '0', 'sys_oper_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, '其他操作'); +insert into sys_dict_data values(22, 1, '新增', '1', 'sys_oper_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, '新增操作'); +insert into sys_dict_data values(23, 2, '修改', '2', 'sys_oper_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, '修改操作'); +insert into sys_dict_data values(24, 3, '删除', '3', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '删除操作'); +insert into sys_dict_data values(25, 4, '授权', '4', 'sys_oper_type', '', 'primary', 'N', '0', 'admin', current_timestamp, '', null, '授权操作'); +insert into sys_dict_data values(26, 5, '导出', '5', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', current_timestamp, '', null, '导出操作'); +insert into sys_dict_data values(27, 6, '导入', '6', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', current_timestamp, '', null, '导入操作'); +insert into sys_dict_data values(28, 7, '强退', '7', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '强退操作'); +insert into sys_dict_data values(29, 8, '生成代码', '8', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', current_timestamp, '', null, '生成操作'); +insert into sys_dict_data values(30, 9, '清空数据', '9', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '清空操作'); +insert into sys_dict_data values(31, 1, '成功', '0', 'sys_common_status', '', 'primary', 'N', '0', 'admin', current_timestamp, '', null, '正常状态'); +insert into sys_dict_data values(32, 2, '失败', '1', 'sys_common_status', '', 'danger', 'N', '0', 'admin', current_timestamp, '', null, '停用状态'); +insert into sys_dict_data values(33, 1, 'AIMLAPI', 'AIMLAPI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'AIMLAPI'); +insert into sys_dict_data values(34, 2, 'Anthropic', 'Anthropic', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Anthropic'); +insert into sys_dict_data values(35, 3, 'Cerebras', 'Cerebras', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Cerebras'); +insert into sys_dict_data values(36, 4, 'CerebrasOpenAI', 'CerebrasOpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'CerebrasOpenAI'); +insert into sys_dict_data values(37, 5, 'Cohere', 'Cohere', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Cohere'); +insert into sys_dict_data values(38, 6, 'CometAPI', 'CometAPI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'CometAPI'); +insert into sys_dict_data values(39, 7, 'DashScope', 'DashScope', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'DashScope'); +insert into sys_dict_data values(40, 8, 'DeepInfra', 'DeepInfra', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'DeepInfra'); +insert into sys_dict_data values(41, 9, 'DeepSeek', 'DeepSeek', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'DeepSeek'); +insert into sys_dict_data values(42, 10, 'Fireworks', 'Fireworks', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Fireworks'); +insert into sys_dict_data values(43, 11, 'Google', 'Google', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Google'); +insert into sys_dict_data values(44, 12, 'Groq', 'Groq', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Groq'); +insert into sys_dict_data values(45, 13, 'HuggingFace', 'HuggingFace', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'HuggingFace'); +insert into sys_dict_data values(46, 14, 'LangDB', 'LangDB', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'LangDB'); +insert into sys_dict_data values(47, 15, 'LiteLLM', 'LiteLLM', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'LiteLLM'); +insert into sys_dict_data values(48, 16, 'LiteLLMOpenAI', 'LiteLLMOpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'LiteLLMOpenAI'); +insert into sys_dict_data values(49, 17, 'LlamaCpp', 'LlamaCpp', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'LlamaCpp'); +insert into sys_dict_data values(50, 18, 'LMStudio', 'LMStudio', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'LMStudio'); +insert into sys_dict_data values(51, 19, 'Meta', 'Meta', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Meta'); +insert into sys_dict_data values(52, 20, 'Mistral', 'Mistral', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Mistral'); +insert into sys_dict_data values(53, 21, 'N1N', 'N1N', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'N1N'); +insert into sys_dict_data values(54, 22, 'Nebius', 'Nebius', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Nebius'); +insert into sys_dict_data values(55, 23, 'Nexus', 'Nexus', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Nexus'); +insert into sys_dict_data values(56, 24, 'Nvidia', 'Nvidia', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Nvidia'); +insert into sys_dict_data values(57, 25, 'Ollama', 'Ollama', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Ollama'); +insert into sys_dict_data values(58, 26, 'OpenAI', 'OpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'OpenAI'); +insert into sys_dict_data values(59, 27, 'OpenAIResponses', 'OpenAIResponses', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'OpenAIResponses'); +insert into sys_dict_data values(60, 28, 'OpenRouter', 'OpenRouter', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'OpenRouter'); +insert into sys_dict_data values(61, 29, 'Perplexity', 'Perplexity', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Perplexity'); +insert into sys_dict_data values(62, 30, 'Portkey', 'Portkey', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Portkey'); +insert into sys_dict_data values(63, 31, 'Requesty', 'Requesty', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Requesty'); +insert into sys_dict_data values(64, 32, 'Sambanova', 'Sambanova', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Sambanova'); +insert into sys_dict_data values(65, 33, 'SiliconFlow', 'SiliconFlow', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'SiliconFlow'); +insert into sys_dict_data values(66, 34, 'Together', 'Together', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Together'); +insert into sys_dict_data values(67, 35, 'Vercel', 'Vercel', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'Vercel'); +insert into sys_dict_data values(68, 36, 'VLLM', 'VLLM', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'VLLM'); +insert into sys_dict_data values(69, 37, 'xAI', 'xAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', current_timestamp, '', null, 'xAI'); + +-- ---------------------------- +-- 13、参数配置表 +-- ---------------------------- +drop table if exists sys_config; +create table sys_config ( + config_id serial not null, + config_name varchar(100) default '', + config_key varchar(100) default '', + config_value varchar(500) default '', + config_type char(1) default 'N', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (config_id) +); +alter sequence sys_config_config_id_seq restart 100; +comment on column sys_config.config_id is '参数主键'; +comment on column sys_config.config_name is '参数名称'; +comment on column sys_config.config_key is '参数键名'; +comment on column sys_config.config_value is '参数键值'; +comment on column sys_config.config_type is '系统内置(Y是 N否)'; +comment on column sys_config.create_by is '创建者'; +comment on column sys_config.create_time is '创建时间'; +comment on column sys_config.update_by is '更新者'; +comment on column sys_config.update_time is '更新时间'; +comment on column sys_config.remark is '备注'; +comment on table sys_config is '参数配置表'; + +-- ---------------------------- +-- 初始化-参数配置表数据 +-- ---------------------------- +insert into sys_config values(1, '主框架页-默认皮肤样式名称', 'sys.index.skinName', 'skin-blue', 'Y', 'admin', current_timestamp, '', null, '蓝色 skin-blue、绿色 skin-green、紫色 skin-purple、红色 skin-red、黄色 skin-yellow' ); +insert into sys_config values(2, '用户管理-账号初始密码', 'sys.user.initPassword', '123456', 'Y', 'admin', current_timestamp, '', null, '初始化密码 123456' ); +insert into sys_config values(3, '主框架页-侧边栏主题', 'sys.index.sideTheme', 'theme-dark', 'Y', 'admin', current_timestamp, '', null, '深色主题theme-dark,浅色主题theme-light' ); +insert into sys_config values(4, '账号自助-验证码开关', 'sys.account.captchaEnabled', 'true', 'Y', 'admin', current_timestamp, '', null, '是否开启验证码功能(true开启,false关闭)'); +insert into sys_config values(5, '账号自助-是否开启用户注册功能', 'sys.account.registerUser', 'false', 'Y', 'admin', current_timestamp, '', null, '是否开启注册用户功能(true开启,false关闭)'); +insert into sys_config values(6, '用户登录-黑名单列表', 'sys.login.blackIPList', '', 'Y', 'admin', current_timestamp, '', null, '设置登录IP黑名单限制,多个匹配项以;分隔,支持匹配(*通配、网段)'); +insert into sys_config values(7, '用户管理-初始密码修改策略', 'sys.account.initPasswordModify', '1', 'Y', 'admin', current_timestamp, '', null, '0:初始密码修改策略关闭,没有任何提示,1:提醒用户,如果未修改初始密码,则在登录时就会提醒修改密码对话框'); +insert into sys_config values(8, '用户管理-账号密码更新周期', 'sys.account.passwordValidateDays', '0', 'Y', 'admin', current_timestamp, '', null, '密码更新周期(填写数字,数据初始化值为0不限制,若修改必须为大于0小于365的正整数),如果超过这个周期登录系统时,则在登录时就会提醒修改密码对话框'); + +-- ---------------------------- +-- 14、系统访问记录 +-- ---------------------------- +drop table if exists sys_logininfor; +create table sys_logininfor ( + info_id bigserial not null, + user_name varchar(50) default '', + ipaddr varchar(128) default '', + login_location varchar(255) default '', + browser varchar(50) default '', + os varchar(50) default '', + status char(1) default '0', + msg varchar(255) default '', + login_time timestamp(0), + primary key (info_id) +); +alter sequence sys_logininfor_info_id_seq restart 100; +create index idx_sys_logininfor_s on sys_logininfor(status); +create index idx_sys_logininfor_lt on sys_logininfor(login_time); +comment on column sys_logininfor.info_id is '访问ID'; +comment on column sys_logininfor.user_name is '用户账号'; +comment on column sys_logininfor.ipaddr is '登录IP地址'; +comment on column sys_logininfor.login_location is '登录地点'; +comment on column sys_logininfor.browser is '浏览器类型'; +comment on column sys_logininfor.os is '操作系统'; +comment on column sys_logininfor.status is '登录状态(0成功 1失败)'; +comment on column sys_logininfor.msg is '提示消息'; +comment on column sys_logininfor.login_time is '访问时间'; +comment on table sys_logininfor is '系统访问记录'; + +-- ---------------------------- +-- 15、定时任务调度表 +-- ---------------------------- +drop table if exists sys_job; +create table sys_job ( + job_id bigserial not null, + job_name varchar(64) default '', + job_group varchar(64) default 'default', + job_executor varchar(64) default 'default', + invoke_target varchar(500) not null, + job_args varchar(255) default '', + job_kwargs varchar(255) default '', + cron_expression varchar(255) default '', + misfire_policy varchar(20) default '3', + concurrent char(1) default '1', + status char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default '', + primary key (job_id, job_name, job_group) +); +alter sequence sys_job_job_id_seq restart 100; +comment on column sys_job.job_id is '任务ID'; +comment on column sys_job.job_name is '任务名称'; +comment on column sys_job.job_group is '任务组名'; +comment on column sys_job.job_executor is '任务执行器'; +comment on column sys_job.invoke_target is '调用目标字符串'; +comment on column sys_job.job_args is '位置参数'; +comment on column sys_job.job_kwargs is '关键字参数'; +comment on column sys_job.cron_expression is 'cron执行表达式'; +comment on column sys_job.misfire_policy is '计划执行错误策略(1立即执行 2执行一次 3放弃执行)'; +comment on column sys_job.concurrent is '是否并发执行(0允许 1禁止)'; +comment on column sys_job.status is '状态(0正常 1暂停)'; +comment on column sys_job.create_by is '创建者'; +comment on column sys_job.create_time is '创建时间'; +comment on column sys_job.update_by is '更新者'; +comment on column sys_job.update_time is '更新时间'; +comment on column sys_job.remark is '备注信息'; +comment on table sys_job is '定时任务调度表'; + +-- ---------------------------- +-- 初始化-定时任务调度表数据 +-- ---------------------------- +insert into sys_job values(1, '系统默认(无参)', 'default', 'default', 'module_task.scheduler_test.job', null, null, '0/10 * * * * ?', '3', '1', '1', 'admin', current_timestamp, '', null, ''); +insert into sys_job values(2, '系统默认(有参)', 'default', 'default', 'module_task.scheduler_test.job', 'test', null, '0/15 * * * * ?', '3', '1', '1', 'admin', current_timestamp, '', null, ''); +insert into sys_job values(3, '系统默认(多参)', 'default', 'default', 'module_task.scheduler_test.job', 'new', '{test: 111}', '0/20 * * * * ?', '3', '1', '1', 'admin', current_timestamp, '', null, ''); + +-- ---------------------------- +-- 16、定时任务调度日志表 +-- ---------------------------- +drop table if exists sys_job_log; +create table sys_job_log ( + job_log_id bigserial not null, + job_name varchar(64) not null, + job_group varchar(64) not null, + job_executor varchar(64) not null, + invoke_target varchar(500) not null, + job_args varchar(255) default '', + job_kwargs varchar(255) default '', + job_trigger varchar(255) default '', + job_message varchar(500), + status char(1) default '0', + exception_info varchar(2000) default '', + create_time timestamp(0), + primary key (job_log_id) +); +comment on column sys_job_log.job_log_id is '任务日志ID'; +comment on column sys_job_log.job_name is '任务名称'; +comment on column sys_job_log.job_group is '任务组名'; +comment on column sys_job_log.job_executor is '任务执行器'; +comment on column sys_job_log.invoke_target is '调用目标字符串'; +comment on column sys_job_log.job_args is '位置参数'; +comment on column sys_job_log.job_kwargs is '关键字参数'; +comment on column sys_job_log.job_trigger is '任务触发器'; +comment on column sys_job_log.job_message is '日志信息'; +comment on column sys_job_log.status is '执行状态(0正常 1失败)'; +comment on column sys_job_log.exception_info is '异常信息'; +comment on column sys_job_log.create_time is '创建时间'; +comment on table sys_job_log is '定时任务调度日志表'; + +-- ---------------------------- +-- 17、通知公告表 +-- ---------------------------- +drop table if exists sys_notice; +create table sys_notice ( + notice_id serial not null, + notice_title varchar(50) not null, + notice_type char(1) not null, + notice_content bytea default null, + status char(1) default '0', + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(255) default null, + primary key (notice_id) +); +alter sequence sys_notice_notice_id_seq restart 10; +comment on column sys_notice.notice_id is '公告ID'; +comment on column sys_notice.notice_title is '公告标题'; +comment on column sys_notice.notice_type is '公告类型(1通知 2公告)'; +comment on column sys_notice.notice_content is '公告内容'; +comment on column sys_notice.status is '公告状态(0正常 1关闭)'; +comment on column sys_notice.create_by is '创建者'; +comment on column sys_notice.create_time is '创建时间'; +comment on column sys_notice.update_by is '更新者'; +comment on column sys_notice.update_time is '更新时间'; +comment on column sys_notice.remark is '备注'; +comment on table sys_notice is '通知公告表'; + +-- ---------------------------- +-- 初始化-公告信息表数据 +-- ---------------------------- +insert into sys_notice values(1, '温馨提醒:2018-07-01 vfadmin新版本发布啦', '2', '新版本内容', '0', 'admin', current_timestamp, '', null, '管理员'); +insert into sys_notice values(2, '维护通知:2018-07-01 vfadmin系统凌晨维护', '1', '维护内容', '0', 'admin', current_timestamp, '', null, '管理员'); + +-- ---------------------------- +-- 18、代码生成业务表 +-- ---------------------------- +drop table if exists gen_table; +create table gen_table ( + table_id bigserial not null, + table_name varchar(200) default '', + table_comment varchar(500) default '', + sub_table_name varchar(64) default null, + sub_table_fk_name varchar(64) default null, + class_name varchar(100) default '', + tpl_category varchar(200) default 'crud', + tpl_web_type varchar(30) default '', + package_name varchar(100), + module_name varchar(30), + business_name varchar(30), + function_name varchar(50), + function_author varchar(50), + gen_type char(1) default '0', + gen_path varchar(200) default '/', + options varchar(1000), + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (table_id) +); +comment on column gen_table.table_id is '编号'; +comment on column gen_table.table_name is '表名称'; +comment on column gen_table.table_comment is '表描述'; +comment on column gen_table.sub_table_name is '关联子表的表名'; +comment on column gen_table.sub_table_fk_name is '子表关联的外键名'; +comment on column gen_table.class_name is '实体类名称'; +comment on column gen_table.tpl_category is '使用的模板(crud单表操作 tree树表操作)'; +comment on column gen_table.tpl_web_type is '前端模板类型(element-ui模版 element-plus模版)'; +comment on column gen_table.package_name is '生成包路径'; +comment on column gen_table.module_name is '生成模块名'; +comment on column gen_table.business_name is '生成业务名'; +comment on column gen_table.function_name is '生成功能名'; +comment on column gen_table.function_author is '生成功能作者'; +comment on column gen_table.gen_type is '生成代码方式(0zip压缩包 1自定义路径)'; +comment on column gen_table.gen_path is '生成路径(不填默认项目路径)'; +comment on column gen_table.options is '其它生成选项'; +comment on column gen_table.create_by is '创建者'; +comment on column gen_table.create_time is '创建时间'; +comment on column gen_table.update_by is '更新者'; +comment on column gen_table.update_time is '更新时间'; +comment on column gen_table.remark is '备注'; +comment on table gen_table is '代码生成业务表'; + +-- ---------------------------- +-- 19、代码生成业务表字段 +-- ---------------------------- +drop table if exists gen_table_column; +create table gen_table_column ( + column_id bigserial not null, + table_id bigint, + column_name varchar(200), + column_comment varchar(500), + column_type varchar(100), + python_type varchar(500), + python_field varchar(200), + is_pk char(1), + is_increment char(1), + is_required char(1), + is_unique char(1), + is_insert char(1), + is_edit char(1), + is_list char(1), + is_query char(1), + query_type varchar(200) default 'EQ', + html_type varchar(200), + dict_type varchar(200) default '', + sort int4, + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + primary key (column_id) +); +comment on column gen_table_column.column_id is '编号'; +comment on column gen_table_column.table_id is '归属表编号'; +comment on column gen_table_column.column_name is '列名称'; +comment on column gen_table_column.column_comment is '列描述'; +comment on column gen_table_column.column_type is '列类型'; +comment on column gen_table_column.python_type is 'PYTHON类型'; +comment on column gen_table_column.python_field is 'PYTHON字段名'; +comment on column gen_table_column.is_pk is '是否主键(1是)'; +comment on column gen_table_column.is_increment is '是否自增(1是)'; +comment on column gen_table_column.is_required is '是否必填(1是)'; +comment on column gen_table_column.is_unique is '是否唯一(1是)'; +comment on column gen_table_column.is_insert is '是否为插入字段(1是)'; +comment on column gen_table_column.is_edit is '是否编辑字段(1是)'; +comment on column gen_table_column.is_list is '是否列表字段(1是)'; +comment on column gen_table_column.is_query is '是否查询字段(1是)'; +comment on column gen_table_column.query_type is '查询方式(等于、不等于、大于、小于、范围)'; +comment on column gen_table_column.html_type is '显示类型(文本框、文本域、下拉框、复选框、单选框、日期控件)'; +comment on column gen_table_column.dict_type is '字典类型'; +comment on column gen_table_column.sort is '排序'; +comment on column gen_table_column.create_by is '创建者'; +comment on column gen_table_column.create_time is '创建时间'; +comment on column gen_table_column.update_by is '更新者'; +comment on column gen_table_column.update_time is '更新时间'; +comment on table gen_table_column is '代码生成业务表字段'; + +-- ---------------------------- +-- 20、AI模型表 +-- ---------------------------- +drop table if exists ai_models; +create table ai_models ( + model_id bigserial not null, + model_code varchar(100) not null, + model_name varchar(100) default null, + provider varchar(50) not null, + model_sort int4 not null, + api_key varchar(255) default null, + base_url varchar(255) default null, + model_type varchar(50) default null, + max_tokens integer default null, + temperature float default null, + support_reasoning char(1) default 'N', + support_images char(1) default 'N', + status char(1) default '0', + user_id bigint, + dept_id bigint, + create_by varchar(64) default '', + create_time timestamp(0), + update_by varchar(64) default '', + update_time timestamp(0), + remark varchar(500) default null, + primary key (model_id) +); +comment on table ai_models is 'AI模型表'; +comment on column ai_models.model_id is '模型主键'; +comment on column ai_models.model_code is '模型编码'; +comment on column ai_models.model_name is '模型名称'; +comment on column ai_models.provider is '提供商'; +comment on column ai_models.model_sort is '显示顺序'; +comment on column ai_models.api_key is 'API Key'; +comment on column ai_models.base_url is 'Base URL'; +comment on column ai_models.model_type is '模型类型'; +comment on column ai_models.max_tokens is '最大输出token'; +comment on column ai_models.temperature is '默认温度'; +comment on column ai_models.support_reasoning is '是否支持推理'; +comment on column ai_models.support_images is '是否支持图片'; +comment on column ai_models.status is '模型状态'; +comment on column ai_models.user_id is '用户ID'; +comment on column ai_models.dept_id is '部门ID'; +comment on column ai_models.create_by is '创建者'; +comment on column ai_models.create_time is '创建时间'; +comment on column ai_models.update_by is '更新者'; +comment on column ai_models.update_time is '更新时间'; +comment on column ai_models.remark is '备注'; + +-- ---------------------------- +-- 21、AI对话配置表 +-- ---------------------------- +drop table if exists ai_chat_config; +create table ai_chat_config ( + chat_config_id bigserial not null, + user_id bigint not null unique, + temperature float default null, + add_history_to_context char(1) default '0', + num_history_runs int4 default null, + system_prompt text default null, + metrics_default_visible char(1) default '0', + vision_enabled char(1) default '1', + image_max_size_mb int4 default null, + create_time timestamp(0), + update_time timestamp(0), + primary key (chat_config_id) +); +comment on table ai_chat_config is 'AI对话配置表'; +comment on column ai_chat_config.chat_config_id is '配置主键'; +comment on column ai_chat_config.user_id is '用户ID'; +comment on column ai_chat_config.temperature is '默认温度'; +comment on column ai_chat_config.add_history_to_context is '是否添加历史记录(0是, 1否)'; +comment on column ai_chat_config.num_history_runs is '历史记录条数'; +comment on column ai_chat_config.system_prompt is '系统提示词'; +comment on column ai_chat_config.metrics_default_visible is '默认显示指标(0是, 1否)'; +comment on column ai_chat_config.vision_enabled is '是否开启视觉(0是, 1否)'; +comment on column ai_chat_config.image_max_size_mb is '图片最大大小(MB)'; +comment on column ai_chat_config.create_time is '创建时间'; +comment on column ai_chat_config.update_time is '更新时间'; + +CREATE OR REPLACE FUNCTION "find_in_set"(int8, varchar) + RETURNS "pg_catalog"."bool" AS $BODY$ +DECLARE + STR ALIAS FOR $1; + STRS ALIAS FOR $2; + POS INTEGER; + STATUS BOOLEAN; +BEGIN + SELECT POSITION( ','||STR||',' IN ','||STRS||',') INTO POS; + IF POS > 0 THEN + STATUS = TRUE; + ELSE + STATUS = FALSE; + END IF; + RETURN STATUS; +END; +$BODY$ + LANGUAGE plpgsql VOLATILE + COST 100; + +create or replace view list_column as +SELECT c.relname AS table_name, + a.attname AS column_name, + d.description AS column_comment, + CASE + WHEN a.attnotnull AND con.conname IS NULL THEN '1' + ELSE '0' + END AS is_required, + CASE + WHEN con.conname IS NOT NULL THEN '1' + ELSE '0' + END AS is_pk, + a.attnum AS sort, + CASE + WHEN "position"(pg_get_expr(ad.adbin, ad.adrelid), ((c.relname::text || '_'::text) || a.attname + ::text) || '_seq'::text) > 0 THEN '1' + ELSE '0' + END AS is_increment, + btrim( + CASE + WHEN t.typelem <> 0::oid AND t.typlen = '-1'::integer THEN 'ARRAY'::text + ELSE + CASE + WHEN t.typtype = 'd'::"char" THEN format_type(t.typbasetype, NULL::integer) + ELSE format_type(a.atttypid, NULL::integer) + END + END, '"'::text) AS column_type +FROM pg_attribute a + JOIN (pg_class c + JOIN pg_namespace n ON c.relnamespace = n.oid) ON a.attrelid = c.oid + LEFT JOIN pg_description d ON d.objoid = c.oid AND a.attnum = d.objsubid + LEFT JOIN pg_constraint con ON con.conrelid = c.oid AND (a.attnum = ANY (con.conkey)) + LEFT JOIN pg_attrdef ad ON a.attrelid = ad.adrelid AND a.attnum = ad.adnum + LEFT JOIN pg_type t ON a.atttypid = t.oid +WHERE (c.relkind = ANY (ARRAY['r'::"char", 'p'::"char"])) + AND a.attnum > 0 + AND n.nspname = 'public'::name + AND not a.attisdropped + ORDER BY c.relname, a.attnum; + +create or replace view list_table as +SELECT c.relname AS table_name, + obj_description(c.oid) AS table_comment, + CURRENT_TIMESTAMP AS create_time, + CURRENT_TIMESTAMP AS update_time +FROM pg_class c + LEFT JOIN pg_namespace n ON n.oid = c.relnamespace +WHERE (c.relkind = ANY (ARRAY['r'::"char", 'p'::"char"])) + AND c.relname !~~ 'spatial_%'::text AND n.nspname = 'public'::name AND n.nspname <> ''::name; + +CREATE OR REPLACE FUNCTION substring_index(varchar, varchar, integer) +RETURNS varchar AS $$ +DECLARE +tokens varchar[]; +length integer ; +indexnum integer; +BEGIN +tokens := pg_catalog.string_to_array($1, $2); +length := pg_catalog.array_upper(tokens, 1); +indexnum := length - ($3 * -1) + 1; +IF $3 >= 0 THEN +RETURN pg_catalog.array_to_string(tokens[1:$3], $2); +ELSE +RETURN pg_catalog.array_to_string(tokens[indexnum:length], $2); +END IF; +END; +$$ IMMUTABLE STRICT LANGUAGE PLPGSQL; diff --git a/shierfeng-fastapi-backend/sql/shierfeng-fastapi.sql b/shierfeng-fastapi-backend/sql/shierfeng-fastapi.sql new file mode 100644 index 0000000..4295803 --- /dev/null +++ b/shierfeng-fastapi-backend/sql/shierfeng-fastapi.sql @@ -0,0 +1,813 @@ +-- ---------------------------- +-- 1、部门表 +-- ---------------------------- +drop table if exists sys_dept; +create table sys_dept ( + dept_id bigint(20) not null auto_increment comment '部门id', + parent_id bigint(20) default 0 comment '父部门id', + ancestors varchar(50) default '' comment '祖级列表', + dept_name varchar(30) default '' comment '部门名称', + order_num int(4) default 0 comment '显示顺序', + leader varchar(20) default null comment '负责人', + phone varchar(11) default null comment '联系电话', + email varchar(50) default null comment '邮箱', + status char(1) default '0' comment '部门状态(0正常 1停用)', + del_flag char(1) default '0' comment '删除标志(0代表存在 2代表删除)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + primary key (dept_id) +) engine=innodb auto_increment=200 comment = '部门表'; + +-- ---------------------------- +-- 初始化-部门表数据 +-- ---------------------------- +insert into sys_dept values(100, 0, '0', '集团总公司', 0, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(101, 100, '0,100', '深圳分公司', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(102, 100, '0,100', '长沙分公司', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(103, 101, '0,100,101', '研发部门', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(104, 101, '0,100,101', '市场部门', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(105, 101, '0,100,101', '测试部门', 3, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(106, 101, '0,100,101', '财务部门', 4, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(107, 101, '0,100,101', '运维部门', 5, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(108, 102, '0,100,102', '市场部门', 1, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); +insert into sys_dept values(109, 102, '0,100,102', '财务部门', 2, '年糕', '15888888888', 'niangao@qq.com', '0', '0', 'admin', sysdate(), '', null); + + +-- ---------------------------- +-- 2、用户信息表 +-- ---------------------------- +drop table if exists sys_user; +create table sys_user ( + user_id bigint(20) not null auto_increment comment '用户ID', + dept_id bigint(20) default null comment '部门ID', + user_name varchar(30) not null comment '用户账号', + nick_name varchar(30) not null comment '用户昵称', + user_type varchar(2) default '00' comment '用户类型(00系统用户)', + email varchar(50) default '' comment '用户邮箱', + phonenumber varchar(11) default '' comment '手机号码', + sex char(1) default '0' comment '用户性别(0男 1女 2未知)', + avatar varchar(100) default '' comment '头像地址', + password varchar(100) default '' comment '密码', + status char(1) default '0' comment '帐号状态(0正常 1停用)', + del_flag char(1) default '0' comment '删除标志(0代表存在 2代表删除)', + login_ip varchar(128) default '' comment '最后登录IP', + login_date datetime comment '最后登录时间', + pwd_update_date datetime comment '密码最后更新时间', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (user_id) +) engine=innodb auto_increment=100 comment = '用户信息表'; + +-- ---------------------------- +-- 初始化-用户信息表数据 +-- ---------------------------- +insert into sys_user values(1, 103, 'admin', '超级管理员', '00', 'niangao@163.com', '15888888888', '1', '', '$2a$10$7JB720yubVSZvUI0rEqK/.VqGOZTH.ulu33dHOiBE8ByOhJIrdAu2', '0', '0', '127.0.0.1', sysdate(), sysdate(), 'admin', sysdate(), '', null, '管理员'); +insert into sys_user values(2, 105, 'niangao', '年糕', '00', 'niangao@qq.com', '15666666666', '1', '', '$2a$10$7JB720yubVSZvUI0rEqK/.VqGOZTH.ulu33dHOiBE8ByOhJIrdAu2', '0', '0', '127.0.0.1', sysdate(), sysdate(), 'admin', sysdate(), '', null, '测试员'); + + +-- ---------------------------- +-- 3、岗位信息表 +-- ---------------------------- +drop table if exists sys_post; +create table sys_post +( + post_id bigint(20) not null auto_increment comment '岗位ID', + post_code varchar(64) not null comment '岗位编码', + post_name varchar(50) not null comment '岗位名称', + post_sort int(4) not null comment '显示顺序', + status char(1) not null comment '状态(0正常 1停用)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (post_id) +) engine=innodb comment = '岗位信息表'; + +-- ---------------------------- +-- 初始化-岗位信息表数据 +-- ---------------------------- +insert into sys_post values(1, 'ceo', '董事长', 1, '0', 'admin', sysdate(), '', null, ''); +insert into sys_post values(2, 'se', '项目经理', 2, '0', 'admin', sysdate(), '', null, ''); +insert into sys_post values(3, 'hr', '人力资源', 3, '0', 'admin', sysdate(), '', null, ''); +insert into sys_post values(4, 'user', '普通员工', 4, '0', 'admin', sysdate(), '', null, ''); + + +-- ---------------------------- +-- 4、角色信息表 +-- ---------------------------- +drop table if exists sys_role; +create table sys_role ( + role_id bigint(20) not null auto_increment comment '角色ID', + role_name varchar(30) not null comment '角色名称', + role_key varchar(100) not null comment '角色权限字符串', + role_sort int(4) not null comment '显示顺序', + data_scope char(1) default '1' comment '数据范围(1:全部数据权限 2:自定数据权限 3:本部门数据权限 4:本部门及以下数据权限)', + menu_check_strictly tinyint(1) default 1 comment '菜单树选择项是否关联显示', + dept_check_strictly tinyint(1) default 1 comment '部门树选择项是否关联显示', + status char(1) not null comment '角色状态(0正常 1停用)', + del_flag char(1) default '0' comment '删除标志(0代表存在 2代表删除)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (role_id) +) engine=innodb auto_increment=100 comment = '角色信息表'; + +-- ---------------------------- +-- 初始化-角色信息表数据 +-- ---------------------------- +insert into sys_role values('1', '超级管理员', 'admin', 1, 1, 1, 1, '0', '0', 'admin', sysdate(), '', null, '超级管理员'); +insert into sys_role values('2', '普通角色', 'common', 2, 2, 1, 1, '0', '0', 'admin', sysdate(), '', null, '普通角色'); + + +-- ---------------------------- +-- 5、菜单权限表 +-- ---------------------------- +drop table if exists sys_menu; +create table sys_menu ( + menu_id bigint(20) not null auto_increment comment '菜单ID', + menu_name varchar(50) not null comment '菜单名称', + parent_id bigint(20) default 0 comment '父菜单ID', + order_num int(4) default 0 comment '显示顺序', + path varchar(200) default '' comment '路由地址', + component varchar(255) default null comment '组件路径', + query varchar(255) default null comment '路由参数', + route_name varchar(50) default '' comment '路由名称', + is_frame int(1) default 1 comment '是否为外链(0是 1否)', + is_cache int(1) default 0 comment '是否缓存(0缓存 1不缓存)', + menu_type char(1) default '' comment '菜单类型(M目录 C菜单 F按钮)', + visible char(1) default 0 comment '菜单状态(0显示 1隐藏)', + status char(1) default 0 comment '菜单状态(0正常 1停用)', + perms varchar(100) default null comment '权限标识', + icon varchar(100) default '#' comment '菜单图标', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default '' comment '备注', + primary key (menu_id) +) engine=innodb auto_increment=2000 comment = '菜单权限表'; + +-- ---------------------------- +-- 初始化-菜单信息表数据 +-- ---------------------------- +-- 一级菜单 +insert into sys_menu values('1', '系统管理', '0', '1', 'system', null, '', '', 1, 0, 'M', '0', '0', '', 'system', 'admin', sysdate(), '', null, '系统管理目录'); +insert into sys_menu values('2', '系统监控', '0', '2', 'monitor', null, '', '', 1, 0, 'M', '0', '0', '', 'monitor', 'admin', sysdate(), '', null, '系统监控目录'); +insert into sys_menu values('3', '系统工具', '0', '3', 'tool', null, '', '', 1, 0, 'M', '0', '0', '', 'tool', 'admin', sysdate(), '', null, '系统工具目录'); +insert into sys_menu values('4', 'AI 管理', '0', '4', 'ai', null, '', '', 1, 0, 'M', '0', '0', '', 'ai-manage', 'admin', sysdate(), '', null, 'AI 管理目录'); +insert into sys_menu values('99', '施尔丰仓库', '0', '99', 'https://git.yujiangrubber.cn/niuniu/ShiErFeng', null, '', '', 0, 0, 'M', '0', '0', '', 'guide', 'admin', sysdate(), '', null, '施尔丰仓库地址'); +-- 二级菜单 +insert into sys_menu values('100', '用户管理', '1', '1', 'user', 'system/user/index', '', '', 1, 0, 'C', '0', '0', 'system:user:list', 'user', 'admin', sysdate(), '', null, '用户管理菜单'); +insert into sys_menu values('101', '角色管理', '1', '2', 'role', 'system/role/index', '', '', 1, 0, 'C', '0', '0', 'system:role:list', 'peoples', 'admin', sysdate(), '', null, '角色管理菜单'); +insert into sys_menu values('102', '菜单管理', '1', '3', 'menu', 'system/menu/index', '', '', 1, 0, 'C', '0', '0', 'system:menu:list', 'tree-table', 'admin', sysdate(), '', null, '菜单管理菜单'); +insert into sys_menu values('103', '部门管理', '1', '4', 'dept', 'system/dept/index', '', '', 1, 0, 'C', '0', '0', 'system:dept:list', 'tree', 'admin', sysdate(), '', null, '部门管理菜单'); +insert into sys_menu values('104', '岗位管理', '1', '5', 'post', 'system/post/index', '', '', 1, 0, 'C', '0', '0', 'system:post:list', 'post', 'admin', sysdate(), '', null, '岗位管理菜单'); +insert into sys_menu values('105', '字典管理', '1', '6', 'dict', 'system/dict/index', '', '', 1, 0, 'C', '0', '0', 'system:dict:list', 'dict', 'admin', sysdate(), '', null, '字典管理菜单'); +insert into sys_menu values('106', '参数设置', '1', '7', 'config', 'system/config/index', '', '', 1, 0, 'C', '0', '0', 'system:config:list', 'edit', 'admin', sysdate(), '', null, '参数设置菜单'); +insert into sys_menu values('107', '通知公告', '1', '8', 'notice', 'system/notice/index', '', '', 1, 0, 'C', '0', '0', 'system:notice:list', 'message', 'admin', sysdate(), '', null, '通知公告菜单'); +insert into sys_menu values('108', '日志管理', '1', '9', 'log', '', '', '', 1, 0, 'M', '0', '0', '', 'log', 'admin', sysdate(), '', null, '日志管理菜单'); +insert into sys_menu values('109', '在线用户', '2', '1', 'online', 'monitor/online/index', '', '', 1, 0, 'C', '0', '0', 'monitor:online:list', 'online', 'admin', sysdate(), '', null, '在线用户菜单'); +insert into sys_menu values('110', '定时任务', '2', '2', 'job', 'monitor/job/index', '', '', 1, 0, 'C', '0', '0', 'monitor:job:list', 'job', 'admin', sysdate(), '', null, '定时任务菜单'); +insert into sys_menu values('111', '数据监控', '2', '3', 'druid', 'monitor/druid/index', '', '', 1, 0, 'C', '0', '0', 'monitor:druid:list', 'druid', 'admin', sysdate(), '', null, '数据监控菜单'); +insert into sys_menu values('112', '服务监控', '2', '4', 'server', 'monitor/server/index', '', '', 1, 0, 'C', '0', '0', 'monitor:server:list', 'server', 'admin', sysdate(), '', null, '服务监控菜单'); +insert into sys_menu values('113', '缓存监控', '2', '5', 'cache', 'monitor/cache/index', '', '', 1, 0, 'C', '0', '0', 'monitor:cache:list', 'redis', 'admin', sysdate(), '', null, '缓存监控菜单'); +insert into sys_menu values('114', '缓存列表', '2', '6', 'cacheList', 'monitor/cache/list', '', '', 1, 0, 'C', '0', '0', 'monitor:cache:list', 'redis-list', 'admin', sysdate(), '', null, '缓存列表菜单'); +insert into sys_menu values('120', '传输加密', '2', '7', 'transportCrypto', 'monitor/transportCrypto/index', '', '', 1, 0, 'C', '0', '0', 'monitor:transportCrypto:list', 'chart', 'admin', sysdate(), '', null, '传输加密监控菜单'); +insert into sys_menu values('115', '表单构建', '3', '1', 'build', 'tool/build/index', '', '', 1, 0, 'C', '0', '0', 'tool:build:list', 'build', 'admin', sysdate(), '', null, '表单构建菜单'); +insert into sys_menu values('116', '代码生成', '3', '2', 'gen', 'tool/gen/index', '', '', 1, 0, 'C', '0', '0', 'tool:gen:list', 'code', 'admin', sysdate(), '', null, '代码生成菜单'); +insert into sys_menu values('117', '系统接口', '3', '3', 'swagger', 'tool/swagger/index', '', '', 1, 0, 'C', '0', '0', 'tool:swagger:list', 'swagger', 'admin', sysdate(), '', null, '系统接口菜单'); +insert into sys_menu values('118', '模型管理', '4', '1', 'model', 'ai/model/index', '', '', 1, 0, 'C', '0', '0', 'ai:model:list', 'ai-model', 'admin', sysdate(), '', null, '模型管理菜单'); +insert into sys_menu values('119', 'AI 对话', '4', '2', 'chat', 'ai/chat/index', '', '', 1, 0, 'C', '0', '0', 'ai:chat:list', 'ai-chat', 'admin', sysdate(), '', null, 'AI 对话菜单'); +-- 三级菜单 +insert into sys_menu values('500', '操作日志', '108', '1', 'operlog', 'monitor/operlog/index', '', '', 1, 0, 'C', '0', '0', 'monitor:operlog:list', 'form', 'admin', sysdate(), '', null, '操作日志菜单'); +insert into sys_menu values('501', '登录日志', '108', '2', 'logininfor', 'monitor/logininfor/index', '', '', 1, 0, 'C', '0', '0', 'monitor:logininfor:list', 'logininfor', 'admin', sysdate(), '', null, '登录日志菜单'); +-- 用户管理按钮 +insert into sys_menu values('1000', '用户查询', '100', '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1001', '用户新增', '100', '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1002', '用户修改', '100', '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1003', '用户删除', '100', '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1004', '用户导出', '100', '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:export', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1005', '用户导入', '100', '6', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:import', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1006', '重置密码', '100', '7', '', '', '', '', 1, 0, 'F', '0', '0', 'system:user:resetPwd', '#', 'admin', sysdate(), '', null, ''); +-- 角色管理按钮 +insert into sys_menu values('1007', '角色查询', '101', '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1008', '角色新增', '101', '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1009', '角色修改', '101', '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1010', '角色删除', '101', '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1011', '角色导出', '101', '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:role:export', '#', 'admin', sysdate(), '', null, ''); +-- 菜单管理按钮 +insert into sys_menu values('1012', '菜单查询', '102', '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1013', '菜单新增', '102', '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1014', '菜单修改', '102', '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1015', '菜单删除', '102', '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:menu:remove', '#', 'admin', sysdate(), '', null, ''); +-- 部门管理按钮 +insert into sys_menu values('1016', '部门查询', '103', '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1017', '部门新增', '103', '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1018', '部门修改', '103', '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1019', '部门删除', '103', '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:dept:remove', '#', 'admin', sysdate(), '', null, ''); +-- 岗位管理按钮 +insert into sys_menu values('1020', '岗位查询', '104', '1', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1021', '岗位新增', '104', '2', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1022', '岗位修改', '104', '3', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1023', '岗位删除', '104', '4', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1024', '岗位导出', '104', '5', '', '', '', '', 1, 0, 'F', '0', '0', 'system:post:export', '#', 'admin', sysdate(), '', null, ''); +-- 字典管理按钮 +insert into sys_menu values('1025', '字典查询', '105', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1026', '字典新增', '105', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1027', '字典修改', '105', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1028', '字典删除', '105', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1029', '字典导出', '105', '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:dict:export', '#', 'admin', sysdate(), '', null, ''); +-- 参数设置按钮 +insert into sys_menu values('1030', '参数查询', '106', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1031', '参数新增', '106', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1032', '参数修改', '106', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1033', '参数删除', '106', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1034', '参数导出', '106', '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:config:export', '#', 'admin', sysdate(), '', null, ''); +-- 通知公告按钮 +insert into sys_menu values('1035', '公告查询', '107', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1036', '公告新增', '107', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1037', '公告修改', '107', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1038', '公告删除', '107', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'system:notice:remove', '#', 'admin', sysdate(), '', null, ''); +-- 操作日志按钮 +insert into sys_menu values('1039', '操作查询', '500', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1040', '操作删除', '500', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1041', '日志导出', '500', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:operlog:export', '#', 'admin', sysdate(), '', null, ''); +-- 登录日志按钮 +insert into sys_menu values('1042', '登录查询', '501', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1043', '登录删除', '501', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1044', '日志导出', '501', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:export', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1045', '账户解锁', '501', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:logininfor:unlock', '#', 'admin', sysdate(), '', null, ''); +-- 在线用户按钮 +insert into sys_menu values('1046', '在线查询', '109', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1047', '批量强退', '109', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:batchLogout', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1048', '单条强退', '109', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:online:forceLogout', '#', 'admin', sysdate(), '', null, ''); +-- 定时任务按钮 +insert into sys_menu values('1049', '任务查询', '110', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1050', '任务新增', '110', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1051', '任务修改', '110', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1052', '任务删除', '110', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1053', '状态修改', '110', '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:changeStatus', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1054', '任务导出', '110', '6', '#', '', '', '', 1, 0, 'F', '0', '0', 'monitor:job:export', '#', 'admin', sysdate(), '', null, ''); +-- 代码生成按钮 +insert into sys_menu values('1055', '生成查询', '116', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1056', '生成修改', '116', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1057', '生成删除', '116', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:remove', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1058', '导入代码', '116', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:import', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1059', '预览代码', '116', '5', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:preview', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1060', '生成代码', '116', '6', '#', '', '', '', 1, 0, 'F', '0', '0', 'tool:gen:code', '#', 'admin', sysdate(), '', null, ''); +-- 模型管理按钮 +insert into sys_menu values('1061', '模型查询', '118', '1', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:query', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1062', '模型新增', '118', '2', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:add', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1063', '模型修改', '118', '3', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:edit', '#', 'admin', sysdate(), '', null, ''); +insert into sys_menu values('1064', '模型删除', '118', '4', '#', '', '', '', 1, 0, 'F', '0', '0', 'ai:model:remove', '#', 'admin', sysdate(), '', null, ''); + + +-- ---------------------------- +-- 6、用户和角色关联表 用户N-1角色 +-- ---------------------------- +drop table if exists sys_user_role; +create table sys_user_role ( + user_id bigint(20) not null comment '用户ID', + role_id bigint(20) not null comment '角色ID', + primary key(user_id, role_id) +) engine=innodb comment = '用户和角色关联表'; + +-- ---------------------------- +-- 初始化-用户和角色关联表数据 +-- ---------------------------- +insert into sys_user_role values ('1', '1'); +insert into sys_user_role values ('2', '2'); + + +-- ---------------------------- +-- 7、角色和菜单关联表 角色1-N菜单 +-- ---------------------------- +drop table if exists sys_role_menu; +create table sys_role_menu ( + role_id bigint(20) not null comment '角色ID', + menu_id bigint(20) not null comment '菜单ID', + primary key(role_id, menu_id) +) engine=innodb comment = '角色和菜单关联表'; + +-- ---------------------------- +-- 初始化-角色和菜单关联表数据 +-- ---------------------------- +insert into sys_role_menu values ('2', '1'); +insert into sys_role_menu values ('2', '2'); +insert into sys_role_menu values ('2', '3'); +insert into sys_role_menu values ('2', '4'); +insert into sys_role_menu values ('2', '100'); +insert into sys_role_menu values ('2', '101'); +insert into sys_role_menu values ('2', '102'); +insert into sys_role_menu values ('2', '103'); +insert into sys_role_menu values ('2', '104'); +insert into sys_role_menu values ('2', '105'); +insert into sys_role_menu values ('2', '106'); +insert into sys_role_menu values ('2', '107'); +insert into sys_role_menu values ('2', '108'); +insert into sys_role_menu values ('2', '109'); +insert into sys_role_menu values ('2', '110'); +insert into sys_role_menu values ('2', '111'); +insert into sys_role_menu values ('2', '112'); +insert into sys_role_menu values ('2', '113'); +insert into sys_role_menu values ('2', '114'); +insert into sys_role_menu values ('2', '120'); +insert into sys_role_menu values ('2', '115'); +insert into sys_role_menu values ('2', '116'); +insert into sys_role_menu values ('2', '117'); +insert into sys_role_menu values ('2', '500'); +insert into sys_role_menu values ('2', '501'); +insert into sys_role_menu values ('2', '1000'); +insert into sys_role_menu values ('2', '1001'); +insert into sys_role_menu values ('2', '1002'); +insert into sys_role_menu values ('2', '1003'); +insert into sys_role_menu values ('2', '1004'); +insert into sys_role_menu values ('2', '1005'); +insert into sys_role_menu values ('2', '1006'); +insert into sys_role_menu values ('2', '1007'); +insert into sys_role_menu values ('2', '1008'); +insert into sys_role_menu values ('2', '1009'); +insert into sys_role_menu values ('2', '1010'); +insert into sys_role_menu values ('2', '1011'); +insert into sys_role_menu values ('2', '1012'); +insert into sys_role_menu values ('2', '1013'); +insert into sys_role_menu values ('2', '1014'); +insert into sys_role_menu values ('2', '1015'); +insert into sys_role_menu values ('2', '1016'); +insert into sys_role_menu values ('2', '1017'); +insert into sys_role_menu values ('2', '1018'); +insert into sys_role_menu values ('2', '1019'); +insert into sys_role_menu values ('2', '1020'); +insert into sys_role_menu values ('2', '1021'); +insert into sys_role_menu values ('2', '1022'); +insert into sys_role_menu values ('2', '1023'); +insert into sys_role_menu values ('2', '1024'); +insert into sys_role_menu values ('2', '1025'); +insert into sys_role_menu values ('2', '1026'); +insert into sys_role_menu values ('2', '1027'); +insert into sys_role_menu values ('2', '1028'); +insert into sys_role_menu values ('2', '1029'); +insert into sys_role_menu values ('2', '1030'); +insert into sys_role_menu values ('2', '1031'); +insert into sys_role_menu values ('2', '1032'); +insert into sys_role_menu values ('2', '1033'); +insert into sys_role_menu values ('2', '1034'); +insert into sys_role_menu values ('2', '1035'); +insert into sys_role_menu values ('2', '1036'); +insert into sys_role_menu values ('2', '1037'); +insert into sys_role_menu values ('2', '1038'); +insert into sys_role_menu values ('2', '1039'); +insert into sys_role_menu values ('2', '1040'); +insert into sys_role_menu values ('2', '1041'); +insert into sys_role_menu values ('2', '1042'); +insert into sys_role_menu values ('2', '1043'); +insert into sys_role_menu values ('2', '1044'); +insert into sys_role_menu values ('2', '1045'); +insert into sys_role_menu values ('2', '1046'); +insert into sys_role_menu values ('2', '1047'); +insert into sys_role_menu values ('2', '1048'); +insert into sys_role_menu values ('2', '1049'); +insert into sys_role_menu values ('2', '1050'); +insert into sys_role_menu values ('2', '1051'); +insert into sys_role_menu values ('2', '1052'); +insert into sys_role_menu values ('2', '1053'); +insert into sys_role_menu values ('2', '1054'); +insert into sys_role_menu values ('2', '1055'); +insert into sys_role_menu values ('2', '1056'); +insert into sys_role_menu values ('2', '1057'); +insert into sys_role_menu values ('2', '1058'); +insert into sys_role_menu values ('2', '1059'); +insert into sys_role_menu values ('2', '1060'); + +-- ---------------------------- +-- 8、角色和部门关联表 角色1-N部门 +-- ---------------------------- +drop table if exists sys_role_dept; +create table sys_role_dept ( + role_id bigint(20) not null comment '角色ID', + dept_id bigint(20) not null comment '部门ID', + primary key(role_id, dept_id) +) engine=innodb comment = '角色和部门关联表'; + +-- ---------------------------- +-- 初始化-角色和部门关联表数据 +-- ---------------------------- +insert into sys_role_dept values ('2', '100'); +insert into sys_role_dept values ('2', '101'); +insert into sys_role_dept values ('2', '105'); + + +-- ---------------------------- +-- 9、用户与岗位关联表 用户1-N岗位 +-- ---------------------------- +drop table if exists sys_user_post; +create table sys_user_post +( + user_id bigint(20) not null comment '用户ID', + post_id bigint(20) not null comment '岗位ID', + primary key (user_id, post_id) +) engine=innodb comment = '用户与岗位关联表'; + +-- ---------------------------- +-- 初始化-用户与岗位关联表数据 +-- ---------------------------- +insert into sys_user_post values ('1', '1'); +insert into sys_user_post values ('2', '2'); + + +-- ---------------------------- +-- 10、操作日志记录 +-- ---------------------------- +drop table if exists sys_oper_log; +create table sys_oper_log ( + oper_id bigint(20) not null auto_increment comment '日志主键', + title varchar(50) default '' comment '模块标题', + business_type int(2) default 0 comment '业务类型(0其它 1新增 2修改 3删除)', + method varchar(100) default '' comment '方法名称', + request_method varchar(10) default '' comment '请求方式', + operator_type int(1) default 0 comment '操作类别(0其它 1后台用户 2手机端用户)', + oper_name varchar(50) default '' comment '操作人员', + dept_name varchar(50) default '' comment '部门名称', + oper_url varchar(255) default '' comment '请求URL', + oper_ip varchar(128) default '' comment '主机地址', + oper_location varchar(255) default '' comment '操作地点', + oper_param varchar(2000) default '' comment '请求参数', + json_result varchar(2000) default '' comment '返回参数', + status int(1) default 0 comment '操作状态(0正常 1异常)', + error_msg varchar(2000) default '' comment '错误消息', + oper_time datetime comment '操作时间', + cost_time bigint(20) default 0 comment '消耗时间', + primary key (oper_id), + key idx_sys_oper_log_bt (business_type), + key idx_sys_oper_log_s (status), + key idx_sys_oper_log_ot (oper_time) +) engine=innodb auto_increment=100 comment = '操作日志记录'; + + +-- ---------------------------- +-- 11、字典类型表 +-- ---------------------------- +drop table if exists sys_dict_type; +create table sys_dict_type +( + dict_id bigint(20) not null auto_increment comment '字典主键', + dict_name varchar(100) default '' comment '字典名称', + dict_type varchar(100) default '' comment '字典类型', + status char(1) default '0' comment '状态(0正常 1停用)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (dict_id), + unique (dict_type) +) engine=innodb auto_increment=100 comment = '字典类型表'; + +insert into sys_dict_type values(1, '用户性别', 'sys_user_sex', '0', 'admin', sysdate(), '', null, '用户性别列表'); +insert into sys_dict_type values(2, '菜单状态', 'sys_show_hide', '0', 'admin', sysdate(), '', null, '菜单状态列表'); +insert into sys_dict_type values(3, '系统开关', 'sys_normal_disable', '0', 'admin', sysdate(), '', null, '系统开关列表'); +insert into sys_dict_type values(4, '任务状态', 'sys_job_status', '0', 'admin', sysdate(), '', null, '任务状态列表'); +insert into sys_dict_type values(5, '任务分组', 'sys_job_group', '0', 'admin', sysdate(), '', null, '任务分组列表'); +insert into sys_dict_type values(6, '任务执行器', 'sys_job_executor', '0', 'admin', sysdate(), '', null, '任务执行器列表'); +insert into sys_dict_type values(7, '系统是否', 'sys_yes_no', '0', 'admin', sysdate(), '', null, '系统是否列表'); +insert into sys_dict_type values(8, '通知类型', 'sys_notice_type', '0', 'admin', sysdate(), '', null, '通知类型列表'); +insert into sys_dict_type values(9, '通知状态', 'sys_notice_status', '0', 'admin', sysdate(), '', null, '通知状态列表'); +insert into sys_dict_type values(10, '操作类型', 'sys_oper_type', '0', 'admin', sysdate(), '', null, '操作类型列表'); +insert into sys_dict_type values(11, '系统状态', 'sys_common_status', '0', 'admin', sysdate(), '', null, '登录状态列表'); +insert into sys_dict_type values(12, 'AI模型提供商', 'ai_provider_type', '0', 'admin', sysdate(), '', null, 'AI模型提供商列表'); + + +-- ---------------------------- +-- 12、字典数据表 +-- ---------------------------- +drop table if exists sys_dict_data; +create table sys_dict_data +( + dict_code bigint(20) not null auto_increment comment '字典编码', + dict_sort int(4) default 0 comment '字典排序', + dict_label varchar(100) default '' comment '字典标签', + dict_value varchar(100) default '' comment '字典键值', + dict_type varchar(100) default '' comment '字典类型', + css_class varchar(100) default null comment '样式属性(其他样式扩展)', + list_class varchar(100) default null comment '表格回显样式', + is_default char(1) default 'N' comment '是否默认(Y是 N否)', + status char(1) default '0' comment '状态(0正常 1停用)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (dict_code) +) engine=innodb auto_increment=100 comment = '字典数据表'; + +insert into sys_dict_data values(1, 1, '男', '0', 'sys_user_sex', '', '', 'Y', '0', 'admin', sysdate(), '', null, '性别男'); +insert into sys_dict_data values(2, 2, '女', '1', 'sys_user_sex', '', '', 'N', '0', 'admin', sysdate(), '', null, '性别女'); +insert into sys_dict_data values(3, 3, '未知', '2', 'sys_user_sex', '', '', 'N', '0', 'admin', sysdate(), '', null, '性别未知'); +insert into sys_dict_data values(4, 1, '显示', '0', 'sys_show_hide', '', 'primary', 'Y', '0', 'admin', sysdate(), '', null, '显示菜单'); +insert into sys_dict_data values(5, 2, '隐藏', '1', 'sys_show_hide', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '隐藏菜单'); +insert into sys_dict_data values(6, 1, '正常', '0', 'sys_normal_disable', '', 'primary', 'Y', '0', 'admin', sysdate(), '', null, '正常状态'); +insert into sys_dict_data values(7, 2, '停用', '1', 'sys_normal_disable', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '停用状态'); +insert into sys_dict_data values(8, 1, '正常', '0', 'sys_job_status', '', 'primary', 'Y', '0', 'admin', sysdate(), '', null, '正常状态'); +insert into sys_dict_data values(9, 2, '暂停', '1', 'sys_job_status', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '停用状态'); +insert into sys_dict_data values(10, 1, '默认', 'default', 'sys_job_group', '', '', 'Y', '0', 'admin', sysdate(), '', null, '默认分组'); +insert into sys_dict_data values(11, 2, '数据库', 'sqlalchemy', 'sys_job_group', '', '', 'N', '0', 'admin', sysdate(), '', null, '数据库分组'); +insert into sys_dict_data values(12, 3, 'redis', 'redis', 'sys_job_group', '', '', 'N', '0', 'admin', sysdate(), '', null, 'reids分组'); +insert into sys_dict_data values(13, 1, '默认', 'default', 'sys_job_executor', '', '', 'N', '0', 'admin', sysdate(), '', null, '线程池'); +insert into sys_dict_data values(14, 2, '进程池', 'processpool', 'sys_job_executor', '', '', 'N', '0', 'admin', sysdate(), '', null, '进程池'); +insert into sys_dict_data values(15, 1, '是', 'Y', 'sys_yes_no', '', 'primary', 'Y', '0', 'admin', sysdate(), '', null, '系统默认是'); +insert into sys_dict_data values(16, 2, '否', 'N', 'sys_yes_no', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '系统默认否'); +insert into sys_dict_data values(17, 1, '通知', '1', 'sys_notice_type', '', 'warning', 'Y', '0', 'admin', sysdate(), '', null, '通知'); +insert into sys_dict_data values(18, 2, '公告', '2', 'sys_notice_type', '', 'success', 'N', '0', 'admin', sysdate(), '', null, '公告'); +insert into sys_dict_data values(19, 1, '正常', '0', 'sys_notice_status', '', 'primary', 'Y', '0', 'admin', sysdate(), '', null, '正常状态'); +insert into sys_dict_data values(20, 2, '关闭', '1', 'sys_notice_status', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '关闭状态'); +insert into sys_dict_data values(21, 99, '其他', '0', 'sys_oper_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, '其他操作'); +insert into sys_dict_data values(22, 1, '新增', '1', 'sys_oper_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, '新增操作'); +insert into sys_dict_data values(23, 2, '修改', '2', 'sys_oper_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, '修改操作'); +insert into sys_dict_data values(24, 3, '删除', '3', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '删除操作'); +insert into sys_dict_data values(25, 4, '授权', '4', 'sys_oper_type', '', 'primary', 'N', '0', 'admin', sysdate(), '', null, '授权操作'); +insert into sys_dict_data values(26, 5, '导出', '5', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', sysdate(), '', null, '导出操作'); +insert into sys_dict_data values(27, 6, '导入', '6', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', sysdate(), '', null, '导入操作'); +insert into sys_dict_data values(28, 7, '强退', '7', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '强退操作'); +insert into sys_dict_data values(29, 8, '生成代码', '8', 'sys_oper_type', '', 'warning', 'N', '0', 'admin', sysdate(), '', null, '生成操作'); +insert into sys_dict_data values(30, 9, '清空数据', '9', 'sys_oper_type', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '清空操作'); +insert into sys_dict_data values(31, 1, '成功', '0', 'sys_common_status', '', 'primary', 'N', '0', 'admin', sysdate(), '', null, '正常状态'); +insert into sys_dict_data values(32, 2, '失败', '1', 'sys_common_status', '', 'danger', 'N', '0', 'admin', sysdate(), '', null, '停用状态'); +insert into sys_dict_data values(33, 1, 'AIMLAPI', 'AIMLAPI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'AIMLAPI'); +insert into sys_dict_data values(34, 2, 'Anthropic', 'Anthropic', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Anthropic'); +insert into sys_dict_data values(35, 3, 'Cerebras', 'Cerebras', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Cerebras'); +insert into sys_dict_data values(36, 4, 'CerebrasOpenAI', 'CerebrasOpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'CerebrasOpenAI'); +insert into sys_dict_data values(37, 5, 'Cohere', 'Cohere', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Cohere'); +insert into sys_dict_data values(38, 6, 'CometAPI', 'CometAPI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'CometAPI'); +insert into sys_dict_data values(39, 7, 'DashScope', 'DashScope', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'DashScope'); +insert into sys_dict_data values(40, 8, 'DeepInfra', 'DeepInfra', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'DeepInfra'); +insert into sys_dict_data values(41, 9, 'DeepSeek', 'DeepSeek', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'DeepSeek'); +insert into sys_dict_data values(42, 10, 'Fireworks', 'Fireworks', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Fireworks'); +insert into sys_dict_data values(43, 11, 'Google', 'Google', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Google'); +insert into sys_dict_data values(44, 12, 'Groq', 'Groq', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Groq'); +insert into sys_dict_data values(45, 13, 'HuggingFace', 'HuggingFace', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'HuggingFace'); +insert into sys_dict_data values(46, 14, 'LangDB', 'LangDB', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'LangDB'); +insert into sys_dict_data values(47, 15, 'LiteLLM', 'LiteLLM', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'LiteLLM'); +insert into sys_dict_data values(48, 16, 'LiteLLMOpenAI', 'LiteLLMOpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'LiteLLMOpenAI'); +insert into sys_dict_data values(49, 17, 'LlamaCpp', 'LlamaCpp', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'LlamaCpp'); +insert into sys_dict_data values(50, 18, 'LMStudio', 'LMStudio', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'LMStudio'); +insert into sys_dict_data values(51, 19, 'Meta', 'Meta', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Meta'); +insert into sys_dict_data values(52, 20, 'Mistral', 'Mistral', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Mistral'); +insert into sys_dict_data values(53, 21, 'N1N', 'N1N', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'N1N'); +insert into sys_dict_data values(54, 22, 'Nebius', 'Nebius', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Nebius'); +insert into sys_dict_data values(55, 23, 'Nexus', 'Nexus', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Nexus'); +insert into sys_dict_data values(56, 24, 'Nvidia', 'Nvidia', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Nvidia'); +insert into sys_dict_data values(57, 25, 'Ollama', 'Ollama', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Ollama'); +insert into sys_dict_data values(58, 26, 'OpenAI', 'OpenAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'OpenAI'); +insert into sys_dict_data values(59, 27, 'OpenAIResponses', 'OpenAIResponses', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'OpenAIResponses'); +insert into sys_dict_data values(60, 28, 'OpenRouter', 'OpenRouter', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'OpenRouter'); +insert into sys_dict_data values(61, 29, 'Perplexity', 'Perplexity', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Perplexity'); +insert into sys_dict_data values(62, 30, 'Portkey', 'Portkey', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Portkey'); +insert into sys_dict_data values(63, 31, 'Requesty', 'Requesty', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Requesty'); +insert into sys_dict_data values(64, 32, 'Sambanova', 'Sambanova', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Sambanova'); +insert into sys_dict_data values(65, 33, 'SiliconFlow', 'SiliconFlow', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'SiliconFlow'); +insert into sys_dict_data values(66, 34, 'Together', 'Together', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Together'); +insert into sys_dict_data values(67, 35, 'Vercel', 'Vercel', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'Vercel'); +insert into sys_dict_data values(68, 36, 'VLLM', 'VLLM', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'VLLM'); +insert into sys_dict_data values(69, 37, 'xAI', 'xAI', 'ai_provider_type', '', 'info', 'N', '0', 'admin', sysdate(), '', null, 'xAI'); + + +-- ---------------------------- +-- 13、参数配置表 +-- ---------------------------- +drop table if exists sys_config; +create table sys_config ( + config_id int(5) not null auto_increment comment '参数主键', + config_name varchar(100) default '' comment '参数名称', + config_key varchar(100) default '' comment '参数键名', + config_value varchar(500) default '' comment '参数键值', + config_type char(1) default 'N' comment '系统内置(Y是 N否)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (config_id) +) engine=innodb auto_increment=100 comment = '参数配置表'; + +insert into sys_config values(1, '主框架页-默认皮肤样式名称', 'sys.index.skinName', 'skin-blue', 'Y', 'admin', sysdate(), '', null, '蓝色 skin-blue、绿色 skin-green、紫色 skin-purple、红色 skin-red、黄色 skin-yellow' ); +insert into sys_config values(2, '用户管理-账号初始密码', 'sys.user.initPassword', '123456', 'Y', 'admin', sysdate(), '', null, '初始化密码 123456' ); +insert into sys_config values(3, '主框架页-侧边栏主题', 'sys.index.sideTheme', 'theme-dark', 'Y', 'admin', sysdate(), '', null, '深色主题theme-dark,浅色主题theme-light' ); +insert into sys_config values(4, '账号自助-验证码开关', 'sys.account.captchaEnabled', 'true', 'Y', 'admin', sysdate(), '', null, '是否开启验证码功能(true开启,false关闭)'); +insert into sys_config values(5, '账号自助-是否开启用户注册功能', 'sys.account.registerUser', 'false', 'Y', 'admin', sysdate(), '', null, '是否开启注册用户功能(true开启,false关闭)'); +insert into sys_config values(6, '用户登录-黑名单列表', 'sys.login.blackIPList', '', 'Y', 'admin', sysdate(), '', null, '设置登录IP黑名单限制,多个匹配项以;分隔,支持匹配(*通配、网段)'); +insert into sys_config values(7, '用户管理-初始密码修改策略', 'sys.account.initPasswordModify', '1', 'Y', 'admin', sysdate(), '', null, '0:初始密码修改策略关闭,没有任何提示,1:提醒用户,如果未修改初始密码,则在登录时就会提醒修改密码对话框'); +insert into sys_config values(8, '用户管理-账号密码更新周期', 'sys.account.passwordValidateDays', '0', 'Y', 'admin', sysdate(), '', null, '密码更新周期(填写数字,数据初始化值为0不限制,若修改必须为大于0小于365的正整数),如果超过这个周期登录系统时,则在登录时就会提醒修改密码对话框'); + + +-- ---------------------------- +-- 14、系统访问记录 +-- ---------------------------- +drop table if exists sys_logininfor; +create table sys_logininfor ( + info_id bigint(20) not null auto_increment comment '访问ID', + user_name varchar(50) default '' comment '用户账号', + ipaddr varchar(128) default '' comment '登录IP地址', + login_location varchar(255) default '' comment '登录地点', + browser varchar(50) default '' comment '浏览器类型', + os varchar(50) default '' comment '操作系统', + status char(1) default '0' comment '登录状态(0成功 1失败)', + msg varchar(255) default '' comment '提示消息', + login_time datetime comment '访问时间', + primary key (info_id), + key idx_sys_logininfor_s (status), + key idx_sys_logininfor_lt (login_time) +) engine=innodb auto_increment=100 comment = '系统访问记录'; + + +-- ---------------------------- +-- 15、定时任务调度表 +-- ---------------------------- +drop table if exists sys_job; +create table sys_job ( + job_id bigint(20) not null auto_increment comment '任务ID', + job_name varchar(64) default '' comment '任务名称', + job_group varchar(64) default 'default' comment '任务组名', + job_executor varchar(64) default 'default' comment '任务执行器', + invoke_target varchar(500) not null comment '调用目标字符串', + job_args varchar(255) default '' comment '位置参数', + job_kwargs varchar(255) default '' comment '关键字参数', + cron_expression varchar(255) default '' comment 'cron执行表达式', + misfire_policy varchar(20) default '3' comment '计划执行错误策略(1立即执行 2执行一次 3放弃执行)', + concurrent char(1) default '1' comment '是否并发执行(0允许 1禁止)', + status char(1) default '0' comment '状态(0正常 1暂停)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default '' comment '备注信息', + primary key (job_id, job_name, job_group) +) engine=innodb auto_increment=100 comment = '定时任务调度表'; + +insert into sys_job values(1, '系统默认(无参)', 'default', 'default', 'module_task.scheduler_test.job', NULL, NULL, '0/10 * * * * ?', '3', '1', '1', 'admin', sysdate(), '', null, ''); +insert into sys_job values(2, '系统默认(有参)', 'default', 'default', 'module_task.scheduler_test.job', 'test', NULL, '0/15 * * * * ?', '3', '1', '1', 'admin', sysdate(), '', null, ''); +insert into sys_job values(3, '系统默认(多参)', 'default', 'default', 'module_task.scheduler_test.job', 'new', '{\"test\": 111}', '0/20 * * * * ?', '3', '1', '1', 'admin', sysdate(), '', null, ''); + + +-- ---------------------------- +-- 16、定时任务调度日志表 +-- ---------------------------- +drop table if exists sys_job_log; +create table sys_job_log ( + job_log_id bigint(20) not null auto_increment comment '任务日志ID', + job_name varchar(64) not null comment '任务名称', + job_group varchar(64) not null comment '任务组名', + job_executor varchar(64) not null comment '任务执行器', + invoke_target varchar(500) not null comment '调用目标字符串', + job_args varchar(255) default '' comment '位置参数', + job_kwargs varchar(255) default '' comment '关键字参数', + job_trigger varchar(255) default '' comment '任务触发器', + job_message varchar(500) comment '日志信息', + status char(1) default '0' comment '执行状态(0正常 1失败)', + exception_info varchar(2000) default '' comment '异常信息', + create_time datetime comment '创建时间', + primary key (job_log_id) +) engine=innodb comment = '定时任务调度日志表'; + + +-- ---------------------------- +-- 17、通知公告表 +-- ---------------------------- +drop table if exists sys_notice; +create table sys_notice ( + notice_id int(4) not null auto_increment comment '公告ID', + notice_title varchar(50) not null comment '公告标题', + notice_type char(1) not null comment '公告类型(1通知 2公告)', + notice_content longblob default null comment '公告内容', + status char(1) default '0' comment '公告状态(0正常 1关闭)', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(255) default null comment '备注', + primary key (notice_id) +) engine=innodb auto_increment=10 comment = '通知公告表'; + +-- ---------------------------- +-- 初始化-公告信息表数据 +-- ---------------------------- +insert into sys_notice values('1', '温馨提醒:2018-07-01 vfadmin新版本发布啦', '2', '新版本内容', '0', 'admin', sysdate(), '', null, '管理员'); +insert into sys_notice values('2', '维护通知:2018-07-01 vfadmin系统凌晨维护', '1', '维护内容', '0', 'admin', sysdate(), '', null, '管理员'); + + +-- ---------------------------- +-- 18、代码生成业务表 +-- ---------------------------- +drop table if exists gen_table; +create table gen_table ( + table_id bigint(20) not null auto_increment comment '编号', + table_name varchar(200) default '' comment '表名称', + table_comment varchar(500) default '' comment '表描述', + sub_table_name varchar(64) default null comment '关联子表的表名', + sub_table_fk_name varchar(64) default null comment '子表关联的外键名', + class_name varchar(100) default '' comment '实体类名称', + tpl_category varchar(200) default 'crud' comment '使用的模板(crud单表操作 tree树表操作)', + tpl_web_type varchar(30) default '' comment '前端模板类型(element-ui模版 element-plus模版)', + package_name varchar(100) comment '生成包路径', + module_name varchar(30) comment '生成模块名', + business_name varchar(30) comment '生成业务名', + function_name varchar(50) comment '生成功能名', + function_author varchar(50) comment '生成功能作者', + gen_type char(1) default '0' comment '生成代码方式(0zip压缩包 1自定义路径)', + gen_path varchar(200) default '/' comment '生成路径(不填默认项目路径)', + options varchar(1000) comment '其它生成选项', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (table_id) +) engine=innodb auto_increment=1 comment = '代码生成业务表'; + + +-- ---------------------------- +-- 19、代码生成业务表字段 +-- ---------------------------- +drop table if exists gen_table_column; +create table gen_table_column ( + column_id bigint(20) not null auto_increment comment '编号', + table_id bigint(20) comment '归属表编号', + column_name varchar(200) comment '列名称', + column_comment varchar(500) comment '列描述', + column_type varchar(100) comment '列类型', + python_type varchar(500) comment 'PYTHON类型', + python_field varchar(200) comment 'PYTHON字段名', + is_pk char(1) comment '是否主键(1是)', + is_increment char(1) comment '是否自增(1是)', + is_required char(1) comment '是否必填(1是)', + is_unique char(1) comment '是否唯一(1是)', + is_insert char(1) comment '是否为插入字段(1是)', + is_edit char(1) comment '是否编辑字段(1是)', + is_list char(1) comment '是否列表字段(1是)', + is_query char(1) comment '是否查询字段(1是)', + query_type varchar(200) default 'EQ' comment '查询方式(等于、不等于、大于、小于、范围)', + html_type varchar(200) comment '显示类型(文本框、文本域、下拉框、复选框、单选框、日期控件)', + dict_type varchar(200) default '' comment '字典类型', + sort int comment '排序', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + primary key (column_id) +) engine=innodb auto_increment=1 comment = '代码生成业务表字段'; + + +-- ---------------------------- +-- 20、AI模型表 +-- ---------------------------- +drop table if exists ai_models; +create table ai_models ( + model_id bigint(20) not null auto_increment comment '模型主键', + model_code varchar(100) not null comment '模型编码', + model_name varchar(100) default null comment '模型名称', + provider varchar(50) not null comment '提供商', + model_sort int(4) not null comment '显示顺序', + api_key varchar(255) default null comment 'API Key', + base_url varchar(255) default null comment 'Base URL', + model_type varchar(50) default null comment '模型类型', + max_tokens int(11) default null comment '最大输出token', + temperature float default null comment '默认温度', + support_reasoning char(1) default 'N' comment '是否支持推理', + support_images char(1) default 'N' comment '是否支持图片', + status char(1) default '0' comment '模型状态', + user_id bigint(20) comment '用户ID', + dept_id bigint(20) comment '部门ID', + create_by varchar(64) default '' comment '创建者', + create_time datetime comment '创建时间', + update_by varchar(64) default '' comment '更新者', + update_time datetime comment '更新时间', + remark varchar(500) default null comment '备注', + primary key (model_id) +) engine=innodb auto_increment=1 comment = 'AI模型表'; + + +-- ---------------------------- +-- 21、AI对话配置表 +-- ---------------------------- +drop table if exists ai_chat_config; +create table ai_chat_config ( + chat_config_id bigint(20) not null auto_increment comment '配置主键', + user_id bigint(20) not null unique comment '用户ID', + temperature float default null comment '默认温度', + add_history_to_context char(1) default '0' comment '是否添加历史记录(0是, 1否)', + num_history_runs int(4) default null comment '历史记录条数', + system_prompt text default null comment '系统提示词', + metrics_default_visible char(1) default '0' comment '默认显示指标(0是, 1否)', + vision_enabled char(1) default '1' comment '是否开启视觉(0是, 1否)', + image_max_size_mb int(4) default null comment '图片最大大小(MB)', + create_time datetime comment '创建时间', + update_time datetime comment '更新时间', + primary key (chat_config_id) +) engine=innodb auto_increment=1 comment = 'AI对话配置表'; diff --git a/shierfeng-fastapi-backend/sub_applications/handle.py b/shierfeng-fastapi-backend/sub_applications/handle.py new file mode 100644 index 0000000..325193e --- /dev/null +++ b/shierfeng-fastapi-backend/sub_applications/handle.py @@ -0,0 +1,11 @@ +from fastapi import FastAPI + +from sub_applications.staticfiles import mount_staticfiles + + +def handle_sub_applications(app: FastAPI) -> None: + """ + 全局处理子应用挂载 + """ + # 挂载静态文件 + mount_staticfiles(app) diff --git a/shierfeng-fastapi-backend/sub_applications/staticfiles.py b/shierfeng-fastapi-backend/sub_applications/staticfiles.py new file mode 100644 index 0000000..5e5d4e5 --- /dev/null +++ b/shierfeng-fastapi-backend/sub_applications/staticfiles.py @@ -0,0 +1,11 @@ +from fastapi import FastAPI +from fastapi.staticfiles import StaticFiles + +from config.env import UploadConfig + + +def mount_staticfiles(app: FastAPI) -> None: + """ + 挂载静态文件 + """ + app.mount(f'{UploadConfig.UPLOAD_PREFIX}', StaticFiles(directory=f'{UploadConfig.UPLOAD_PATH}'), name='profile') diff --git a/shierfeng-fastapi-backend/tests/cli/completion/test_installers.py b/shierfeng-fastapi-backend/tests/cli/completion/test_installers.py new file mode 100644 index 0000000..f0dd607 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/completion/test_installers.py @@ -0,0 +1,112 @@ +from pathlib import Path + +import typer +from pytest import MonkeyPatch + +from cli.completion.installers import ( + CompletionInstallerService, + CompletionInstallerShellSupport, + CompletionShellRuntimePolicy, + CompletionShellRuntimePolicyRegistry, +) + + +def test_build_source_command_uses_shell_runtime_policy() -> None: + """ + 校验安装服务会按 shell 运行时策略构建 source 命令。 + + :return: None + """ + installer = CompletionInstallerService() + target_file = Path('/tmp/shierfeng-completion') + + assert installer.build_source_command(target_file, 'bash') == 'source /tmp/shierfeng-completion' + assert installer.build_source_command(target_file, 'zsh') == 'source /tmp/shierfeng-completion' + assert ( + installer.build_source_command(target_file, 'fish') + == 'status --is-interactive; and source /tmp/shierfeng-completion' + ) + assert installer.build_source_command(target_file, 'powershell') == '. "/tmp/shierfeng-completion"' + + +def test_make_bash_completion_script_compatible_wraps_legacy_instructions() -> None: + """ + 校验 Bash 兼容转换会包装旧版 shell 不支持的指令。 + + :return: None + """ + script_text = 'compopt -o dirnames\ncompopt -o default\ncomplete -o nosort -F _shierfeng_completion shierfeng' + + compatible_script = CompletionInstallerShellSupport.make_bash_completion_script_compatible(script_text) + + assert 'if command -v compopt >/dev/null 2>&1; then' in compatible_script + assert 'complete -F _shierfeng_completion shierfeng' in compatible_script + assert 'complete -o nosort -F _shierfeng_completion shierfeng 2>/dev/null' in compatible_script + + +def test_render_completion_script_uses_runtime_policy_transformer(monkeypatch: MonkeyPatch) -> None: + """ + 校验脚本渲染会通过 shell 运行时策略执行脚本后处理。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class DummyComplete: + """ + 模拟 Click completion 生成器。 + """ + + def __init__(self, *args, **kwargs) -> None: + """ + 初始化模拟生成器。 + + :param args: 位置参数 + :param kwargs: 关键字参数 + :return: None + """ + + @staticmethod + def source() -> str: + """ + 返回原始脚本文本。 + + :return: 原始脚本文本 + """ + return 'raw-script' + + runtime_policy_registry = CompletionShellRuntimePolicyRegistry( + policies={ + 'bash': CompletionShellRuntimePolicy( + name='bash', + click_completion_class=DummyComplete, + script_transformer=lambda script_text: f'transformed::{script_text}', + source_command_builder=lambda target_file: f'source {target_file}', + ) + } + ) + installer = CompletionInstallerService(shell_runtime_policy_registry=runtime_policy_registry) + monkeypatch.setattr(installer, 'build_completion_click_command', lambda root_cli: object()) + + rendered_script = installer.render_completion_script(typer.Typer(), 'bash') + + assert rendered_script == 'transformed::raw-script' + + +def test_render_powershell_completion_script_contains_native_completer() -> None: + """ + 校验 PowerShell completion 脚本会注册原生命令补全器。 + + :return: None + """ + installer = CompletionInstallerService() + root_cli = typer.Typer() + + @root_cli.command() + def demo() -> None: + return None + + rendered_script = installer.render_completion_script(root_cli, 'powershell') + + assert 'Register-ArgumentCompleter -Native -CommandName shierfeng' in rendered_script + assert '$env:_SHIERFENG_COMPLETE = "powershell_complete"' in rendered_script diff --git a/shierfeng-fastapi-backend/tests/cli/completion/test_providers.py b/shierfeng-fastapi-backend/tests/cli/completion/test_providers.py new file mode 100644 index 0000000..32d8c71 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/completion/test_providers.py @@ -0,0 +1,442 @@ +import importlib +import os +import sys +from pathlib import Path + +from pytest import MonkeyPatch + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +sys.path.insert(0, str(BACKEND_DIR)) +sys.modules.pop('cli.completion.providers', None) +sys.modules.pop('cli', None) + +completion_support = importlib.import_module('cli.completion.providers') +completion_gateway = completion_support.COMPLETION_PROVIDER_GATEWAY +completion_registry = completion_gateway.provider_registry + + +def test_complete_alembic_revisions_returns_default_choices_and_local_revisions( + tmp_path: Path, + monkeypatch: MonkeyPatch, +) -> None: + """ + 校验 Alembic 版本补全会返回默认候选和本地迁移版本。 + + :param tmp_path: pytest 临时目录 + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + versions_dir = tmp_path / 'alembic' / 'versions' + versions_dir.mkdir(parents=True) + (versions_dir / '2026_04_29_1000-abc123_add_demo_table.py').write_text('# test', encoding='utf-8') + + monkeypatch.chdir(tmp_path) + + candidates = completion_gateway.complete_alembic_revisions(None, None, 'a') + default_candidates = completion_gateway.complete_alembic_revisions(None, None, '') + + assert 'abc123' in candidates + assert 'head' in default_candidates + assert 'base' in default_candidates + assert 'current' in default_candidates + assert '-1' in default_candidates + + +def test_complete_sql_files_returns_project_relative_sql_paths( + tmp_path: Path, + monkeypatch: MonkeyPatch, +) -> None: + """ + 校验 SQL 文件补全会返回项目相对路径。 + + :param tmp_path: pytest 临时目录 + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + sql_dir = tmp_path / 'sql' + sql_dir.mkdir() + (sql_dir / 'demo.sql').write_text('select 1;', encoding='utf-8') + + monkeypatch.chdir(tmp_path) + + candidates = completion_gateway.complete_sql_files(None, None, 'sql/d') + + assert candidates == ['sql/demo.sql'] + + +def test_complete_cache_names_returns_static_cache_name_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验缓存名称补全会返回系统内置缓存名称。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeCacheKeyConfig: + """ + 模拟缓存键配置对象。 + """ + + def __init__(self, key: str) -> None: + """ + 初始化模拟缓存键配置对象。 + + :param key: 缓存名称 + :return: None + """ + self.key = key + + class _FakeEnumsModule: + """ + 模拟枚举模块。 + """ + + RedisInitKeyConfig = [_FakeCacheKeyConfig('sys_config'), _FakeCacheKeyConfig('login_tokens')] + + monkeypatch.setattr( + completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeEnumsModule + ) + + candidates = completion_gateway.complete_cache_names(None, None, 'sys') + + assert candidates == ['sys_config'] + + +def test_complete_output_paths_returns_directories_and_zip_files( + tmp_path: Path, + monkeypatch: MonkeyPatch, +) -> None: + """ + 校验导出路径补全会返回目录和 zip 文件。 + + :param tmp_path: pytest 临时目录 + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + build_dir = tmp_path / 'build' + build_dir.mkdir() + (build_dir / 'gen.zip').write_text('zip', encoding='utf-8') + (build_dir / 'notes.txt').write_text('ignore', encoding='utf-8') + + monkeypatch.chdir(tmp_path) + + candidates = completion_gateway.complete_output_paths(None, None, 'build/') + + assert 'build/gen.zip' in candidates + assert 'build/notes.txt' not in candidates + + +def test_complete_config_keys_returns_dynamic_readonly_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验参数键名补全会返回动态只读查询结果。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeConfigRuntime: + """ + 模拟配置运行时模块。 + """ + + class ConfigRuntime: + """ + 模拟配置运行时服务对象。 + """ + + @staticmethod + def list_configs(**kwargs: str) -> dict: + """ + 模拟配置列表查询入口。 + + :param kwargs: 查询参数 + :return: 伪造的结果字典 + """ + return kwargs + + CONFIG_RUNTIME = ConfigRuntime() + + monkeypatch.setattr( + completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeConfigRuntime + ) + monkeypatch.setattr( + completion_registry.dynamic_service, + 'run_completion_coroutine', + lambda coroutine, *, env: { + 'ok': True, + 'items': [ + {'configKey': 'sys.user.initPassword'}, + {'configKey': 'sys.user.maxRetryCount'}, + ], + }, + ) + + candidates = completion_gateway.complete_config_keys(None, None, 'sys.user.i') + + assert candidates == ['sys.user.initPassword'] + + +def test_complete_gen_table_names_returns_dynamic_readonly_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验代码生成业务表补全会返回动态只读查询结果。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeGenRuntime: + """ + 模拟代码生成运行时模块。 + """ + + class GenRuntime: + """ + 模拟代码生成运行时服务对象。 + """ + + @staticmethod + def list_gen_tables(**kwargs: str) -> dict: + """ + 模拟业务表列表查询入口。 + + :param kwargs: 查询参数 + :return: 伪造的结果字典 + """ + return kwargs + + @staticmethod + def list_gen_db_tables(**kwargs: str) -> dict: + """ + 模拟数据库物理表列表查询入口。 + + :param kwargs: 查询参数 + :return: 伪造的结果字典 + """ + return kwargs + + GEN_RUNTIME = GenRuntime() + + monkeypatch.setattr(completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeGenRuntime) + monkeypatch.setattr( + completion_registry.dynamic_service, + 'run_completion_coroutine', + lambda coroutine, *, env: { + 'ok': True, + 'items': [ + {'tableName': 'sys_user'}, + {'tableName': 'sys_role'}, + ], + }, + ) + + candidates = completion_gateway.complete_gen_table_names(None, None, 'sys_u') + + assert candidates == ['sys_user'] + + +def test_dynamic_completion_returns_empty_list_when_runtime_fails(monkeypatch: MonkeyPatch) -> None: + """ + 校验动态补全在运行时失败时会优雅降级为空列表。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + monkeypatch.setattr( + completion_registry.dynamic_service, + 'load_runtime_module', + lambda module_name: (_ for _ in ()).throw(RuntimeError('boom')), + ) + + candidates = completion_gateway.complete_gen_db_table_names(None, None, 'sys') + + assert candidates == [] + + +def test_complete_cache_keys_returns_dynamic_readonly_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验缓存键名补全会基于缓存名称返回动态只读查询结果。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeCacheRuntime: + """ + 模拟缓存运行时模块。 + """ + + class CacheRuntime: + """ + 模拟缓存运行时服务对象。 + """ + + @staticmethod + def list_cache_keys(cache_name: str) -> dict[str, str]: + """ + 模拟缓存键列表查询入口。 + + :param cache_name: 缓存名称 + :return: 伪造的参数字典 + """ + return {'cache_name': cache_name} + + CACHE_RUNTIME = CacheRuntime() + + class _FakeContext: + """ + 模拟 Click 上下文。 + """ + + params = {'cache_name': 'sys_config'} + + monkeypatch.setattr( + completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeCacheRuntime + ) + monkeypatch.setattr( + completion_registry.dynamic_service, + 'run_completion_coroutine', + lambda coroutine, *, env: { + 'ok': True, + 'keys': ['site.name', 'site.logo'], + }, + ) + + candidates = completion_gateway.complete_cache_keys(_FakeContext(), None, 'site.n') + + assert candidates == ['site.name'] + + +def test_complete_job_names_returns_dynamic_readonly_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验任务名称补全会返回动态只读查询结果。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeJobRuntime: + """ + 模拟任务运行时模块。 + """ + + class JobRuntime: + """ + 模拟任务运行时服务对象。 + """ + + @staticmethod + def list_jobs(**kwargs: str) -> dict: + """ + 模拟任务列表查询入口。 + + :param kwargs: 查询参数 + :return: 伪造的参数字典 + """ + return kwargs + + JOB_RUNTIME = JobRuntime() + + monkeypatch.setattr(completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeJobRuntime) + monkeypatch.setattr( + completion_registry.dynamic_service, + 'run_completion_coroutine', + lambda coroutine, *, env: { + 'ok': True, + 'items': [ + {'jobName': '同步任务'}, + {'jobName': '缓存预热'}, + ], + }, + ) + + candidates = completion_gateway.complete_job_names(None, None, '同') + + assert candidates == ['同步任务'] + + +def test_complete_job_ids_returns_dynamic_readonly_choices(monkeypatch: MonkeyPatch) -> None: + """ + 校验任务 ID 补全会返回动态只读查询结果。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class _FakeJobRuntime: + """ + 模拟任务运行时模块。 + """ + + class JobRuntime: + """ + 模拟任务运行时服务对象。 + """ + + @staticmethod + def list_jobs(**kwargs: str) -> dict: + """ + 模拟任务列表查询入口。 + + :param kwargs: 查询参数 + :return: 伪造的参数字典 + """ + return kwargs + + JOB_RUNTIME = JobRuntime() + + monkeypatch.setattr(completion_registry.dynamic_service, 'load_runtime_module', lambda module_name: _FakeJobRuntime) + monkeypatch.setattr( + completion_registry.dynamic_service, + 'run_completion_coroutine', + lambda coroutine, *, env: { + 'ok': True, + 'items': [ + {'jobId': 101}, + {'jobId': 202}, + ], + }, + ) + + candidates = completion_gateway.complete_job_ids(None, None, '1') + + assert candidates == ['101'] + + +def test_run_completion_coroutine_scopes_app_env(monkeypatch: MonkeyPatch) -> None: + """ + 校验动态补全执行时会临时注入 APP_ENV,并在结束后恢复原值。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + monkeypatch.setenv('APP_ENV', 'prod') + captured: dict[str, str | None] = {} + + async def _read_env() -> str | None: + captured['during'] = os.environ.get('APP_ENV') + return captured['during'] + + result = completion_registry.dynamic_service.run_completion_coroutine(_read_env(), env='dev') + + assert result == 'dev' + assert captured['during'] == 'dev' + assert os.environ.get('APP_ENV') == 'prod' + + +def test_run_completion_coroutine_clears_scoped_app_env_when_original_missing(monkeypatch: MonkeyPatch) -> None: + """ + 校验动态补全执行结束后会移除临时注入的 APP_ENV。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + monkeypatch.delenv('APP_ENV', raising=False) + + async def _read_env() -> str | None: + return os.environ.get('APP_ENV') + + result = completion_registry.dynamic_service.run_completion_coroutine(_read_env(), env='dockerpg') + + assert result == 'dockerpg' + assert 'APP_ENV' not in os.environ diff --git a/shierfeng-fastapi-backend/tests/cli/core/test_execution_service.py b/shierfeng-fastapi-backend/tests/cli/core/test_execution_service.py new file mode 100644 index 0000000..802c3c6 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/core/test_execution_service.py @@ -0,0 +1,74 @@ +import importlib +import sys +from pathlib import Path + +from cli.exit_codes import RUNTIME_ERROR + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +sys.path.insert(0, str(BACKEND_DIR)) +sys.modules.pop('cli.core.execution', None) +sys.modules.pop('cli', None) + +cli_execution = importlib.import_module('cli.core.execution') +EXPLICIT_EXIT_CODE = 23 +DEFAULT_EXIT_CODE = 7 + + +def test_build_result_does_not_mutate_payload_and_removes_exit_code_from_result_data() -> None: + """ + 校验结果翻译不会修改调用方 payload,且会从结果数据中移除 exit_code 字段。 + + :return: None + """ + payload = {'ok': True, 'message': 'done', 'exit_code': EXPLICIT_EXIT_CODE} + + result = cli_execution.CliExecutionService.build_result(payload) + + assert result.exit_code == EXPLICIT_EXIT_CODE + assert result.data == {'ok': True, 'message': 'done'} + assert payload == {'ok': True, 'message': 'done', 'exit_code': EXPLICIT_EXIT_CODE} + + +def test_build_result_uses_runtime_error_when_failed_payload_has_no_explicit_exit_code() -> None: + """ + 校验失败 payload 未显式提供退出码时,会回退到统一运行时错误码。 + + :return: None + """ + payload = {'ok': False, 'message': 'failed'} + + result = cli_execution.CliExecutionService.build_result(payload) + + assert result.exit_code == RUNTIME_ERROR + assert result.data == {'ok': False, 'message': 'failed'} + assert payload == {'ok': False, 'message': 'failed'} + + +def test_build_result_uses_default_exit_code_without_mutating_payload() -> None: + """ + 校验显式默认退出码会参与结果翻译,且不会修改原始 payload。 + + :return: None + """ + payload = {'ok': True, 'message': 'warn'} + + result = cli_execution.CliExecutionService.build_result(payload, default_exit_code=DEFAULT_EXIT_CODE) + + assert result.exit_code == DEFAULT_EXIT_CODE + assert result.data == {'ok': True, 'message': 'warn'} + assert payload == {'ok': True, 'message': 'warn'} + + +def test_build_result_uses_runtime_error_when_failed_payload_keeps_default_zero() -> None: + """ + 校验失败 payload 在未显式提供退出码且默认退出码为 0 时,会回退到统一运行时错误码。 + + :return: None + """ + payload = {'ok': False, 'message': 'failed'} + + result = cli_execution.CliExecutionService.build_result(payload, default_exit_code=0) + + assert result.exit_code == RUNTIME_ERROR + assert result.data == {'ok': False, 'message': 'failed'} diff --git a/shierfeng-fastapi-backend/tests/cli/root/conftest.py b/shierfeng-fastapi-backend/tests/cli/root/conftest.py new file mode 100644 index 0000000..068b9f0 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/conftest.py @@ -0,0 +1,93 @@ +import json +import os +import subprocess +import sys +from collections.abc import Callable +from pathlib import Path +from typing import Any + +import pytest + + +@pytest.fixture +def backend_dir() -> Path: + return Path(__file__).resolve().parents[3] + + +@pytest.fixture +def run_cli_command(backend_dir: Path) -> Callable[..., subprocess.CompletedProcess[str]]: + def _run_cli_command(*args: str) -> subprocess.CompletedProcess[str]: + return subprocess.run( + [sys.executable, '-m', 'cli.main', *args], + cwd=backend_dir, + capture_output=True, + text=True, + check=False, + ) + + return _run_cli_command + + +@pytest.fixture +def run_text_cli_command( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> Callable[..., subprocess.CompletedProcess[str]]: + def _run_text_cli_command(*args: str) -> subprocess.CompletedProcess[str]: + return run_cli_command('--color=never', '--icon=none', *args) + + return _run_text_cli_command + + +@pytest.fixture +def run_cli_completion_command( + backend_dir: Path, +) -> Callable[..., subprocess.CompletedProcess[str]]: + def _run_cli_completion_command( + *, + comp_words: str, + comp_cword: int | str, + instruction: str = 'bash_complete', + ) -> subprocess.CompletedProcess[str]: + return subprocess.run( + [sys.executable, '-m', 'cli.main'], + cwd=backend_dir, + capture_output=True, + text=True, + check=False, + env={ + **os.environ, + 'COMP_WORDS': comp_words, + 'COMP_CWORD': str(comp_cword), + '_SHIERFENG_COMPLETE': instruction, + }, + ) + + return _run_cli_completion_command + + +@pytest.fixture +def parse_json_stdout() -> Callable[[subprocess.CompletedProcess[str]], dict[str, Any]]: + def _parse_json_stdout(completed: subprocess.CompletedProcess[str]) -> dict[str, Any]: + return json.loads(completed.stdout) + + return _parse_json_stdout + + +@pytest.fixture +def assert_check_payload_contract() -> Callable[[dict[str, Any], bool], None]: + def _assert_check_payload_contract(payload: dict[str, Any], allow_exit_code: bool) -> None: + assert isinstance(payload, dict) + assert isinstance(payload.get('ok'), bool) + assert isinstance(payload.get('message'), str) + + if payload['ok']: + if 'error' in payload: + assert isinstance(payload['error'], str) + if 'exit_code' in payload: + assert isinstance(payload['exit_code'], int) + else: + assert isinstance(payload.get('error'), str) + if allow_exit_code: + assert isinstance(payload.get('exit_code'), int) + + return _assert_check_payload_contract diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_bootstrap.py b/shierfeng-fastapi-backend/tests/cli/root/test_bootstrap.py new file mode 100644 index 0000000..96559d5 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_bootstrap.py @@ -0,0 +1,184 @@ +import json +import subprocess +import sys +from pathlib import Path + +BACKEND_DIR = Path(__file__).resolve().parents[3] + + +def test_bootstrap_import_does_not_eagerly_load_heavy_runtime_modules() -> None: + """ + 校验导入 `cli.bootstrap` 时不会提前加载重依赖模块。 + + :return: None + """ + script = """ +import json +import sys + +sys.path.insert(0, '.') +for module_name in [ + 'cli.bootstrap', + 'config.database', + 'config.get_redis', + 'config.get_scheduler', + 'module_admin.service.server_service', + 'utils.transport_crypto_util', +]: + sys.modules.pop(module_name, None) + +import cli.bootstrap + +print(json.dumps({ + 'config.database': 'config.database' in sys.modules, + 'config.get_redis': 'config.get_redis' in sys.modules, + 'config.get_scheduler': 'config.get_scheduler' in sys.modules, + 'module_admin.service.server_service': 'module_admin.service.server_service' in sys.modules, + 'utils.transport_crypto_util': 'utils.transport_crypto_util' in sys.modules, +}, ensure_ascii=False)) +""" + completed = subprocess.run( + [sys.executable, '-c', script], + cwd=BACKEND_DIR, + capture_output=True, + text=True, + check=False, + ) + + assert completed.returncode == 0, completed.stderr + payload = json.loads(completed.stdout) + + assert payload == { + 'config.database': False, + 'config.get_redis': False, + 'config.get_scheduler': False, + 'module_admin.service.server_service': False, + 'utils.transport_crypto_util': False, + } + + +def test_build_cli_does_not_eagerly_load_heavy_runtime_dependencies() -> None: + """ + 校验构建 CLI 根应用时不会提前加载 DB、Redis、Scheduler 和业务服务依赖。 + + :return: None + """ + script = """ +import json +import sys + +sys.path.insert(0, '.') +for module_name in [ + 'cli.main', + 'config.env', + 'config.database', + 'config.get_redis', + 'config.get_scheduler', + 'cli.tui.app', + 'module_admin.service.server_service', + 'module_admin.service.job_service', + 'module_admin.service.config_service', + 'module_generator.service.gen_service', + 'textual', + 'utils.transport_crypto_util', +]: + sys.modules.pop(module_name, None) + +import cli.main + +cli.main.CLI_APPLICATION_BUILDER.build() + +print(json.dumps({ + 'config.env': 'config.env' in sys.modules, + 'config.database': 'config.database' in sys.modules, + 'config.get_redis': 'config.get_redis' in sys.modules, + 'config.get_scheduler': 'config.get_scheduler' in sys.modules, + 'cli.tui.app': 'cli.tui.app' in sys.modules, + 'module_admin.service.server_service': 'module_admin.service.server_service' in sys.modules, + 'module_admin.service.job_service': 'module_admin.service.job_service' in sys.modules, + 'module_admin.service.config_service': 'module_admin.service.config_service' in sys.modules, + 'module_generator.service.gen_service': 'module_generator.service.gen_service' in sys.modules, + 'textual': 'textual' in sys.modules, + 'utils.transport_crypto_util': 'utils.transport_crypto_util' in sys.modules, +}, ensure_ascii=False)) +""" + completed = subprocess.run( + [sys.executable, '-c', script], + cwd=BACKEND_DIR, + capture_output=True, + text=True, + check=False, + ) + + assert completed.returncode == 0, completed.stderr + payload = json.loads(completed.stdout) + + assert payload == { + 'config.env': False, + 'config.database': False, + 'config.get_redis': False, + 'config.get_scheduler': False, + 'cli.tui.app': False, + 'module_admin.service.server_service': False, + 'module_admin.service.job_service': False, + 'module_admin.service.config_service': False, + 'module_generator.service.gen_service': False, + 'textual': False, + 'utils.transport_crypto_util': False, + } + + +def test_build_wizard_app_does_not_eagerly_load_flow_modules() -> None: + """ + 校验构建 `wizard` 子应用时不会提前加载各个 flow 模块。 + + :return: None + """ + script = """ +import json +import sys + +sys.path.insert(0, '.') +for module_name in [ + 'cli.wizard.commands', + 'cli.wizard.flows.app_run', + 'cli.wizard.flows.db_upgrade', + 'cli.wizard.flows.cache_clear', + 'cli.wizard.flows.gen_export', + 'cli.wizard.flows.gen_import', + 'cli.wizard.flows.prod_check', +]: + sys.modules.pop(module_name, None) + +from cli.wizard.commands import WIZARD_COMMAND_BUILDER + +WIZARD_COMMAND_BUILDER.build() + +print(json.dumps({ + 'cli.wizard.flows.app_run': 'cli.wizard.flows.app_run' in sys.modules, + 'cli.wizard.flows.db_upgrade': 'cli.wizard.flows.db_upgrade' in sys.modules, + 'cli.wizard.flows.cache_clear': 'cli.wizard.flows.cache_clear' in sys.modules, + 'cli.wizard.flows.gen_export': 'cli.wizard.flows.gen_export' in sys.modules, + 'cli.wizard.flows.gen_import': 'cli.wizard.flows.gen_import' in sys.modules, + 'cli.wizard.flows.prod_check': 'cli.wizard.flows.prod_check' in sys.modules, +}, ensure_ascii=False)) +""" + completed = subprocess.run( + [sys.executable, '-c', script], + cwd=BACKEND_DIR, + capture_output=True, + text=True, + check=False, + ) + + assert completed.returncode == 0, completed.stderr + payload = json.loads(completed.stdout) + + assert payload == { + 'cli.wizard.flows.app_run': False, + 'cli.wizard.flows.db_upgrade': False, + 'cli.wizard.flows.cache_clear': False, + 'cli.wizard.flows.gen_export': False, + 'cli.wizard.flows.gen_import': False, + 'cli.wizard.flows.prod_check': False, + } diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_contract_app_ops.py b/shierfeng-fastapi-backend/tests/cli/root/test_contract_app_ops.py new file mode 100644 index 0000000..4c9040d --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_contract_app_ops.py @@ -0,0 +1,311 @@ +import subprocess +from collections.abc import Callable + +from cli.exit_codes import DEPENDENCY_ERROR, SUCCESS + + +def test_app_config_json_output_is_pure_json( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('app', 'config', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == 0 + assert completed.stderr == '' + assert payload['ok'] is True + assert payload['env'] == 'dev' + assert isinstance(payload['config'], dict) + assert '\u001b[' not in completed.stdout + assert '✅' not in completed.stdout + assert '❌' not in completed.stdout + + +def test_app_config_text_output_has_stable_section_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('app', 'config', '--env=dev', '--output=text') + + assert completed.returncode == SUCCESS + assert '\x1b[' not in completed.stdout + assert '✅' not in completed.stdout + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'env: dev\n' in completed.stdout + assert 'application:\n' in completed.stdout + assert 'database:\n' in completed.stdout + assert 'redis:\n' in completed.stdout + assert 'logging:\n' in completed.stdout + assert 'transport_crypto:\n' in completed.stdout + + +def test_app_env_text_output_has_stable_section_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('app', 'env', '--env=dev', '--output=text') + + assert completed.returncode == SUCCESS + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'env: dev\n' in completed.stdout + assert 'runtime:\n' in completed.stdout + assert 'cli_env: dev\n' in completed.stdout + assert 'config_env:' in completed.stdout + assert 'app_env: dev\n' in completed.stdout + assert 'env_file: .env.dev\n' in completed.stdout + assert 'env_file_exists:' in completed.stdout + assert 'backend_dir:' in completed.stdout + assert 'python_executable:' in completed.stdout + + +def test_app_doctor_text_output_has_stable_check_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('app', 'doctor', '--env=dev', '--output=text') + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert '\x1b[' not in completed.stdout + assert '✅' not in completed.stdout + assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n')) + assert 'env: dev\n' in completed.stdout + assert 'checks:\n' in completed.stdout + assert 'database:' in completed.stdout + assert 'redis:' in completed.stdout + assert 'crypto:' in completed.stdout + + +def test_app_doctor_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], + assert_check_payload_contract: Callable[[dict, bool], None], +) -> None: + completed = run_cli_command('app', 'doctor', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert completed.stderr == '' + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + assert set(payload) == {'env', 'database', 'redis', 'crypto', 'ok'} + assert_check_payload_contract(payload['database'], True) + assert_check_payload_contract(payload['redis'], True) + assert_check_payload_contract(payload['crypto'], False) + + +def test_app_env_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('app', 'env', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['env'] == 'dev' + assert set(payload) == {'ok', 'env', 'runtime'} + assert isinstance(payload['runtime'], dict) + assert set(payload['runtime']) == { + 'cliEnv', + 'configEnv', + 'appEnv', + 'envFile', + 'envFilePath', + 'envFileExists', + 'backendDir', + 'pythonExecutable', + } + assert payload['runtime']['cliEnv'] == 'dev' + assert payload['runtime']['appEnv'] == 'dev' + assert payload['runtime']['envFile'] == '.env.dev' + assert isinstance(payload['runtime']['envFileExists'], bool) + + +def test_app_routes_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('app', 'routes', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == 0 + assert payload['ok'] is True + assert payload['env'] == 'dev' + assert isinstance(payload['count'], int) + assert payload['count'] > 0 + assert payload['groupedRoutes'] is None + assert payload['filters'] == { + 'pathPrefix': '', + 'method': '', + 'groupBy': 'none', + 'includeHidden': False, + } + assert isinstance(payload['routes'], list) + assert payload['routes'] + + first_route = payload['routes'][0] + assert set(first_route) == { + 'path', + 'methods', + 'name', + 'summary', + 'operationId', + 'tags', + 'includeInSchema', + } + assert isinstance(first_route['path'], str) + assert isinstance(first_route['methods'], list) + assert first_route['methods'] + assert all(isinstance(method, str) for method in first_route['methods']) + assert isinstance(first_route['name'], str | None) + assert isinstance(first_route['summary'], str | None) + assert isinstance(first_route['operationId'], str | None) + assert isinstance(first_route['tags'], list) + assert all(isinstance(tag, str) for tag in first_route['tags']) + assert isinstance(first_route['includeInSchema'], bool) + + +def test_server_info_text_output_has_stable_section_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('ops', 'server-info', '--env=dev') + + assert completed.returncode == 0 + assert '\x1b[' not in completed.stdout + assert '✅' not in completed.stdout + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'host:\n' in completed.stdout + assert 'cpu:\n' in completed.stdout + assert 'memory:\n' in completed.stdout + assert 'python:\n' in completed.stdout + assert 'disks:' in completed.stdout + + +def test_ops_health_text_output_has_stable_check_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('ops', 'health', '--env=dev', '--output=text') + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert '\x1b[' not in completed.stdout + assert '✅' not in completed.stdout + assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n')) + assert 'env: dev\n' in completed.stdout + assert 'checks:\n' in completed.stdout + assert 'database:' in completed.stdout + assert 'redis:' in completed.stdout + + +def test_ops_deps_text_output_has_stable_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('ops', 'deps', '--env=dev', '--output=text') + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n')) + assert 'message:' in completed.stdout + assert 'include_dev: false\n' in completed.stdout + assert 'missing_required:' in completed.stdout + assert 'packages:\n' in completed.stdout + assert 'python:' in completed.stdout + assert 'fastapi:' in completed.stdout + assert 'typer:' in completed.stdout + + +def test_ops_health_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], + assert_check_payload_contract: Callable[[dict, bool], None], +) -> None: + completed = run_cli_command('ops', 'health', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert completed.stderr == '' + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + assert set(payload) == {'env', 'database', 'redis', 'ok'} + assert_check_payload_contract(payload['database'], True) + assert_check_payload_contract(payload['redis'], True) + + +def test_ops_deps_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('ops', 'deps', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR} + assert set(payload) == {'ok', 'message', 'missingRequired', 'includeDev', 'packages'} + assert isinstance(payload['ok'], bool) + assert isinstance(payload['message'], str) + assert isinstance(payload['missingRequired'], list) + assert payload['includeDev'] is False + assert isinstance(payload['packages'], dict) + assert 'python' in payload['packages'] + assert 'fastapi' in payload['packages'] + assert 'typer' in payload['packages'] + for package_payload in payload['packages'].values(): + assert isinstance(package_payload, dict) + assert isinstance(package_payload.get('installed'), bool) + assert isinstance(package_payload.get('version'), str) + assert isinstance(package_payload.get('required'), bool) + + +def test_ops_server_info_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('ops', 'server-info', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == 0 + assert payload['ok'] is True + assert isinstance(payload['server'], dict) + + server = payload['server'] + assert set(server) == {'cpu', 'mem', 'sys', 'py', 'sysFiles'} + + cpu = server['cpu'] + assert set(cpu) == {'cpuNum', 'used', 'sys', 'free'} + assert isinstance(cpu['cpuNum'], int) + assert isinstance(cpu['used'], float | int | str) + assert isinstance(cpu['sys'], float | int | str) + assert isinstance(cpu['free'], float | int | str) + + memory = server['mem'] + assert set(memory) == {'total', 'used', 'free', 'usage'} + assert isinstance(memory['total'], str) + assert isinstance(memory['used'], str) + assert isinstance(memory['free'], str) + assert isinstance(memory['usage'], float | int) + + sys_info = server['sys'] + assert set(sys_info) == {'computerIp', 'computerName', 'osArch', 'osName', 'userDir'} + assert all(isinstance(value, str) for value in sys_info.values()) + + py_info = server['py'] + assert set(py_info) == { + 'name', + 'version', + 'startTime', + 'runTime', + 'home', + 'total', + 'used', + 'free', + 'usage', + } + assert isinstance(py_info['name'], str) + assert isinstance(py_info['version'], str) + assert isinstance(py_info['startTime'], str) + assert isinstance(py_info['runTime'], str) + assert isinstance(py_info['home'], str) + assert isinstance(py_info['total'], str) + assert isinstance(py_info['used'], str) + assert isinstance(py_info['free'], str) + assert isinstance(py_info['usage'], float | int) + + assert isinstance(server['sysFiles'], list) + assert server['sysFiles'] + first_disk = server['sysFiles'][0] + assert set(first_disk) == {'dirName', 'sysTypeName', 'typeName', 'total', 'used', 'free', 'usage'} + assert all(isinstance(value, str) for value in first_disk.values()) diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_contract_cli.py b/shierfeng-fastapi-backend/tests/cli/root/test_contract_cli.py new file mode 100644 index 0000000..42f1bab --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_contract_cli.py @@ -0,0 +1,207 @@ +import subprocess +from collections.abc import Callable +from pathlib import Path + +from cli.exit_codes import SUCCESS + + +def test_root_help_shows_commands_without_completion_options( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_command('--help') + + assert completed.returncode == 0 + assert 'Usage: shierfeng [OPTIONS] COMMAND [ARGS]...' in completed.stdout + assert 'app' in completed.stdout + assert 'db' in completed.stdout + assert 'completion' in completed.stdout + assert 'wizard' in completed.stdout + assert 'tui' in completed.stdout + assert completed.stdout.index('wizard') < completed.stdout.index('tui') + assert '--install-completion' not in completed.stdout + assert '--show-completion' not in completed.stdout + + +def test_completion_show_bash_outputs_completion_script( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_command('completion', 'show', 'bash') + + assert completed.returncode == SUCCESS + assert completed.stderr == '' + assert '_SHIERFENG_COMPLETE=bash_complete' in completed.stdout + assert '_shierfeng_completion()' in completed.stdout + assert 'if command -v compopt >/dev/null 2>&1; then' in completed.stdout + assert 'if complete -o nosort -F _shierfeng_completion shierfeng 2>/dev/null; then' in completed.stdout + assert 'complete -F _shierfeng_completion shierfeng' in completed.stdout + + +def test_completion_show_powershell_outputs_completion_script( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_command('completion', 'show', 'powershell') + + assert completed.returncode == SUCCESS + assert completed.stderr == '' + assert 'Register-ArgumentCompleter -Native -CommandName shierfeng' in completed.stdout + assert '$env:_SHIERFENG_COMPLETE = "powershell_complete"' in completed.stdout + + +def test_bash_completion_protocol_returns_candidates_without_not_supported_error( + run_cli_completion_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_completion_command(comp_words='shierfeng comp', comp_cword=1) + + assert completed.returncode == SUCCESS + assert 'plain,completion' in completed.stdout + assert 'not supported' not in completed.stdout.lower() + assert completed.stderr == '' + + +def test_powershell_completion_protocol_returns_candidates_without_not_supported_error( + run_cli_completion_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_completion_command( + comp_words='shierfeng comp', + comp_cword='comp', + instruction='powershell_complete', + ) + + assert completed.returncode == SUCCESS + assert 'completion' in completed.stdout + assert 'not supported' not in completed.stdout.lower() + assert completed.stderr == '' + + +def test_completion_doctor_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('completion', 'doctor', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['message'] == 'completion 诊断信息已生成' + assert set(payload) == { + 'ok', + 'message', + 'activeShell', + 'projectDir', + 'envChoices', + 'completeEnvVar', + 'recommendedInstallCommand', + 'shells', + } + assert isinstance(payload['envChoices'], list) + assert payload['completeEnvVar'] == '_SHIERFENG_COMPLETE' + assert isinstance(payload['shells'], dict) + assert set(payload['shells']) == {'bash', 'zsh', 'fish', 'powershell'} + assert payload['shells']['bash']['supported'] is True + assert payload['shells']['fish']['autoDiscovery'] is True + assert payload['shells']['powershell']['supported'] is True + assert isinstance(payload['shells']['bash']['sourceCommand'], str) + assert isinstance(payload['shells']['bash']['recommendedInstallCommand'], str) + assert isinstance(payload['shells']['powershell']['sourceCommand'], str) + assert isinstance(payload['shells']['powershell']['recommendedInstallCommand'], str) + + +def test_completion_install_json_output_has_stable_contract( + tmp_path: Path, + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + target_file = tmp_path / 'shierfeng.bash' + rc_file = tmp_path / '.bashrc' + completed = run_cli_command( + 'completion', + 'install', + '--shell=bash', + '--target-file', + str(target_file), + '--activate', + '--rc-file', + str(rc_file), + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert set(payload) == { + 'ok', + 'message', + 'shell', + 'detectedShell', + 'targetFile', + 'activated', + 'activateRequested', + 'rcFile', + 'rcFileUpdated', + 'sourceCommand', + 'autoDiscovery', + 'activationRequired', + 'nextStep', + 'completeEnvVar', + } + assert payload['shell'] == 'bash' + assert payload['targetFile'] == str(target_file.resolve()) + assert payload['activated'] is True + assert payload['activateRequested'] is True + assert payload['rcFile'] == str(rc_file.resolve()) + assert payload['rcFileUpdated'] is True + assert payload['autoDiscovery'] is False + assert payload['activationRequired'] is True + assert isinstance(payload['nextStep'], str) + assert target_file.exists() + assert rc_file.exists() + assert '_SHIERFENG_COMPLETE=bash_complete' in target_file.read_text(encoding='utf-8') + assert payload['sourceCommand'] in rc_file.read_text(encoding='utf-8') + + +def test_completion_install_powershell_json_output_has_stable_contract( + tmp_path: Path, + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + target_file = tmp_path / 'shierfeng.ps1' + rc_file = tmp_path / 'Microsoft.PowerShell_profile.ps1' + completed = run_cli_command( + 'completion', + 'install', + '--shell=powershell', + '--target-file', + str(target_file), + '--activate', + '--rc-file', + str(rc_file), + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['shell'] == 'powershell' + assert payload['targetFile'] == str(target_file.resolve()) + assert payload['activated'] is True + assert payload['activateRequested'] is True + assert payload['rcFile'] == str(rc_file.resolve()) + assert payload['rcFileUpdated'] is True + assert payload['autoDiscovery'] is False + assert payload['activationRequired'] is True + assert payload['sourceCommand'] == f'. "{target_file.resolve()}"' + assert target_file.exists() + assert rc_file.exists() + assert 'Register-ArgumentCompleter -Native -CommandName shierfeng' in target_file.read_text(encoding='utf-8') + assert payload['sourceCommand'] in rc_file.read_text(encoding='utf-8') + + +def test_app_run_help_only_exposes_env_option( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_cli_command('app', 'run', '--help') + + assert completed.returncode == 0 + assert 'Usage: shierfeng app run [OPTIONS]' in completed.stdout + assert '--env' in completed.stdout + assert '--output' not in completed.stdout diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_contract_config.py b/shierfeng-fastapi-backend/tests/cli/root/test_contract_config.py new file mode 100644 index 0000000..d7f00c3 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_contract_config.py @@ -0,0 +1,40 @@ +import subprocess +from collections.abc import Callable + +from cli.exit_codes import DATABASE_ERROR, REDIS_ERROR, RUNTIME_ERROR, SUCCESS + + +def test_config_doctor_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('config', 'doctor', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, REDIS_ERROR, DATABASE_ERROR, RUNTIME_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == { + 'ok', + 'message', + 'databaseCount', + 'cacheCount', + 'missingInCacheCount', + 'orphanInCacheCount', + 'mismatchCount', + 'sampleLimit', + 'missingInCache', + 'orphanInCache', + 'mismatchKeys', + 'env', + } + assert isinstance(payload['databaseCount'], int) + assert isinstance(payload['cacheCount'], int) + assert isinstance(payload['missingInCache'], list) + assert isinstance(payload['orphanInCache'], list) + assert isinstance(payload['mismatchKeys'], list) diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_contract_db_cache_dev.py b/shierfeng-fastapi-backend/tests/cli/root/test_contract_db_cache_dev.py new file mode 100644 index 0000000..1e5ed95 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_contract_db_cache_dev.py @@ -0,0 +1,235 @@ +import subprocess +from collections.abc import Callable +from pathlib import Path + +from cli.exit_codes import DATABASE_ERROR, GUARD_REJECTED, REDIS_ERROR, RUNTIME_ERROR, SUCCESS + +DB_HISTORY_TEST_LIMIT = 5 + + +def test_dangerous_command_is_rejected_without_yes_in_non_interactive_mode( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('db', 'revision', '--env=dev', '--message=test-contract', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == GUARD_REJECTED + assert payload['ok'] is False + assert payload['message'] == '已取消危险命令执行:db revision' + assert '--yes' in payload['hint'] + + +def test_prod_dangerous_command_is_rejected_without_allow_prod( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('db', 'revision', '--env=prod', '--message=test-contract', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == GUARD_REJECTED + assert payload['ok'] is False + assert payload['message'] == '生产环境默认禁止直接执行危险命令:db revision' + assert '--allow-prod' in payload['hint'] + assert '--yes' in payload['hint'] + + +def test_dry_run_command_returns_structured_preview_payload( + backend_dir: Path, + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'db', + 'upgrade', + '--env=dev', + '--revision=head', + '--dry-run', + '--yes', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == 0 + assert payload['ok'] is True + assert payload['dryRun'] is True + assert isinstance(payload['command'], list) + assert payload['command'][-2:] == ['upgrade', 'head'] + assert payload['cwd'] == str(backend_dir) + + +def test_db_heads_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('db', 'heads', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'message', 'count', 'items', 'env'} + assert isinstance(payload['count'], int) + assert isinstance(payload['items'], list) + if payload['items']: + first_item = payload['items'][0] + assert set(first_item) == {'revision', 'downRevisions', 'branchLabels', 'dependsOn', 'doc', 'path'} + assert isinstance(first_item['revision'], str) + assert isinstance(first_item['downRevisions'], list) + assert isinstance(first_item['branchLabels'], list) + assert isinstance(first_item['dependsOn'], list) + assert isinstance(first_item['doc'], str) + assert isinstance(first_item['path'], str) + + +def test_db_history_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'db', + 'history', + '--env=dev', + f'--limit={DB_HISTORY_TEST_LIMIT}', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'message', 'count', 'totalCount', 'limit', 'items', 'env'} + assert payload['limit'] == DB_HISTORY_TEST_LIMIT + assert isinstance(payload['count'], int) + assert isinstance(payload['totalCount'], int) + assert isinstance(payload['items'], list) + + +def test_cache_ttl_json_output_has_stable_contract_for_missing_key_or_redis_error( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'cache', + 'ttl', + 'sys_config', + 'definitely_missing_cli_key', + '--env=dev', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, REDIS_ERROR, RUNTIME_ERROR} + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert payload['message'] == '读取缓存剩余过期时间失败' + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'message', 'cacheName', 'cacheKey', 'fullCacheKey'} + assert payload['ok'] is False + assert payload['cacheName'] == 'sys_config' + assert payload['cacheKey'] == 'definitely_missing_cli_key' + assert payload['fullCacheKey'] == 'sys_config:definitely_missing_cli_key' + + +def test_dangerous_command_rejection_text_output_is_human_readable( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command('db', 'revision', '--env=dev', '--message=test-contract', '--output=text') + + assert completed.returncode == GUARD_REJECTED + assert completed.stdout == ( + 'FAIL FAILED\n' + 'message: 已取消危险命令执行:db revision\n' + 'hint: 当前命令需要交互确认;如需非交互执行,请传入 --yes\n' + ) + + +def test_dry_run_text_output_contains_preview_command_and_workdir( + backend_dir: Path, + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'db', + 'upgrade', + '--env=dev', + '--revision=head', + '--dry-run', + '--yes', + '--output=text', + ) + + assert completed.returncode == 0 + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'message: 数据库已升级到 head(dry-run)\n' in completed.stdout + assert 'dry_run: true\n' in completed.stdout + assert 'command:\n - alembic\n - -c\n' in completed.stdout + assert f' - {backend_dir / "alembic.ini"}\n' in completed.stdout + assert f'cwd: {backend_dir}\n' in completed.stdout + + +def test_dev_lint_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'dev', + 'lint', + 'cli/groups/dev/command.py', + '--env=dev', + '--check-only', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['message'] == '开发检查已完成' + assert payload['env'] == 'dev' + assert payload['checkOnly'] is True + assert payload['fix'] is False + assert payload['unsafeFixes'] is False + assert payload['targets'] == ['cli/groups/dev/command.py'] + assert isinstance(payload['format'], dict) + assert isinstance(payload['check'], dict) + assert payload['format']['ok'] is True + assert payload['check']['ok'] is True + assert isinstance(payload['format']['command'], list) + assert isinstance(payload['check']['command'], list) + + +def test_dev_test_text_output_has_stable_summary( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'dev', + 'test', + 'tests/cli/root/test_contract_cli.py', + '--env=dev', + '--keyword=test_root_help_shows_commands_without_completion_options', + '--maxfail=1', + '--quiet', + '--output=text', + ) + + assert completed.returncode == SUCCESS + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'ok: true\n' in completed.stdout + assert 'env: dev\n' in completed.stdout + assert 'keyword: test_root_help_shows_commands_without_completion_options\n' in completed.stdout + assert 'maxfail: 1\n' in completed.stdout + assert 'quiet: true\n' in completed.stdout + assert 'targets:\n - tests/cli/root/test_contract_cli.py\n' in completed.stdout + assert 'test:\n ok: true\n' in completed.stdout + assert 'command: ' in completed.stdout diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_contract_job_gen.py b/shierfeng-fastapi-backend/tests/cli/root/test_contract_job_gen.py new file mode 100644 index 0000000..f713da5 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_contract_job_gen.py @@ -0,0 +1,368 @@ +import subprocess +from collections.abc import Callable + +from cli.exit_codes import ARGUMENT_ERROR, DATABASE_ERROR, GUARD_REJECTED, RUNTIME_ERROR, SUCCESS + +GEN_TEST_TABLE_NAME = 'demo_table' +GEN_CREATE_SQL = 'CREATE TABLE demo_cli_test (id bigint);' +MISSING_JOB_ID = 999999999 +MISSING_GEN_TABLE_ID = 999999999 + + +def test_job_detail_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + list_completed = run_cli_command('job', 'list', '--env=dev', '--output=json') + list_payload = parse_json_stdout(list_completed) + job_id = MISSING_JOB_ID + if list_payload.get('ok') and isinstance(list_payload.get('items'), list) and list_payload['items']: + first_job = list_payload['items'][0] + if isinstance(first_job, dict) and isinstance(first_job.get('jobId'), int): + job_id = first_job['jobId'] + + completed = run_cli_command('job', 'detail', str(job_id), '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR, RUNTIME_ERROR} + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + if payload['ok'] is False: + assert set(payload) == {'ok', 'message', 'jobId'} + assert payload['jobId'] == job_id + return + + assert set(payload) == {'ok', 'job'} + assert isinstance(payload['job'], dict) + assert payload['job']['jobId'] == job_id + assert isinstance(payload['job'].get('jobName'), str) + assert isinstance(payload['job'].get('invokeTarget'), str) + + +def test_job_logs_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('job', 'logs', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR} + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'filters', 'count', 'items'} + assert isinstance(payload['filters'], dict) + assert isinstance(payload['count'], int) + assert isinstance(payload['items'], list) + if payload['items']: + first_item = payload['items'][0] + assert isinstance(first_item, dict) + assert isinstance(first_item.get('jobLogId'), int) + assert isinstance(first_item.get('jobName'), str | None) + assert isinstance(first_item.get('jobMessage'), str | None) + + +def test_gen_list_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('gen', 'list', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'filters', 'count', 'items', 'env'} + assert isinstance(payload['filters'], dict) + assert isinstance(payload['count'], int) + assert isinstance(payload['items'], list) + if payload['items']: + first_item = payload['items'][0] + assert isinstance(first_item, dict) + assert isinstance(first_item.get('tableId'), int) + assert isinstance(first_item.get('tableName'), str) + + +def test_gen_db_list_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('gen', 'db-list', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + assert set(payload) == {'ok', 'filters', 'count', 'items', 'env'} + assert isinstance(payload['filters'], dict) + assert isinstance(payload['count'], int) + assert isinstance(payload['items'], list) + if payload['items']: + first_item = payload['items'][0] + assert isinstance(first_item, dict) + assert isinstance(first_item.get('tableName'), str) + + +def test_gen_detail_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + list_completed = run_cli_command('gen', 'list', '--env=dev', '--output=json') + list_payload = parse_json_stdout(list_completed) + table_id = MISSING_GEN_TABLE_ID + if list_payload.get('ok') and isinstance(list_payload.get('items'), list) and list_payload['items']: + first_item = list_payload['items'][0] + if isinstance(first_item, dict) and isinstance(first_item.get('tableId'), int): + table_id = first_item['tableId'] + + completed = run_cli_command('gen', 'detail', str(table_id), '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode in {SUCCESS, DATABASE_ERROR, RUNTIME_ERROR} + assert payload['env'] == 'dev' + assert isinstance(payload['ok'], bool) + if 'error' in payload: + assert isinstance(payload['message'], str) + assert isinstance(payload['error'], str) + return + + if payload['ok'] is False: + assert set(payload) == {'ok', 'message', 'tableId', 'env'} + assert payload['tableId'] == table_id + return + + assert set(payload) == {'ok', 'tableId', 'tableName', 'columnCount', 'tableCount', 'detail', 'env'} + assert payload['tableId'] == table_id + assert isinstance(payload['tableName'], str) + assert isinstance(payload['columnCount'], int) + assert isinstance(payload['tableCount'], int) + assert isinstance(payload['detail'], dict) + assert isinstance(payload['detail'].get('info'), dict) + assert isinstance(payload['detail'].get('rows'), list) + assert isinstance(payload['detail'].get('tables'), list) + + +def test_gen_sync_db_is_rejected_without_yes_in_non_interactive_mode( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command('gen', 'sync-db', 'demo_table', '--env=dev', '--output=json') + payload = parse_json_stdout(completed) + + assert completed.returncode == GUARD_REJECTED + assert payload['ok'] is False + assert payload['message'] == '已取消危险命令执行:gen sync-db' + assert '--yes' in payload['hint'] + + +def test_gen_export_dry_run_text_output_has_stable_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'gen', + 'export', + GEN_TEST_TABLE_NAME, + '--env=dev', + '--dry-run', + '--yes', + '--output=text', + ) + + assert completed.returncode == SUCCESS + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'env: dev\n' in completed.stdout + assert 'mode: zip\n' in completed.stdout + assert 'dry_run: true\n' in completed.stdout + assert 'message: 代码导出演练完成,未执行实际导出\n' in completed.stdout + assert 'table_names:\n' in completed.stdout + assert f' - {GEN_TEST_TABLE_NAME}\n' in completed.stdout + assert 'output_file:' in completed.stdout + assert f'gen_code_{GEN_TEST_TABLE_NAME}.zip' in completed.stdout + + +def test_gen_export_dry_run_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'gen', + 'export', + GEN_TEST_TABLE_NAME, + '--env=dev', + '--dry-run', + '--yes', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['env'] == 'dev' + assert payload['dryRun'] is True + assert payload['mode'] == 'zip' + assert payload['message'] == '代码导出演练完成,未执行实际导出' + assert payload['tableNames'] == [GEN_TEST_TABLE_NAME] + assert isinstance(payload['outputFile'], str) + assert payload['outputFile'].endswith(f'gen_code_{GEN_TEST_TABLE_NAME}.zip') + + +def test_gen_create_table_dry_run_text_output_has_stable_structure( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + GEN_CREATE_SQL, + '--output=text', + ) + + assert completed.returncode == SUCCESS + assert completed.stdout.startswith('OK SUCCESS\n') + assert 'env: dev\n' in completed.stdout + assert 'message: 建表语句演练完成,未执行实际建表\n' in completed.stdout + assert 'dry_run: true\n' in completed.stdout + assert 'statement_count: 1\n' in completed.stdout + assert 'table_names:\n' in completed.stdout + assert ' - demo_cli_test\n' in completed.stdout + assert f'sql: {GEN_CREATE_SQL}\n' in completed.stdout + + +def test_gen_create_table_dry_run_json_output_has_stable_contract( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + GEN_CREATE_SQL, + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == SUCCESS + assert payload['ok'] is True + assert payload['env'] == 'dev' + assert payload['dryRun'] is True + assert payload['message'] == '建表语句演练完成,未执行实际建表' + assert payload['statementCount'] == 1 + assert payload['tableNames'] == ['demo_cli_test'] + assert payload['sql'] == GEN_CREATE_SQL + + +def test_gen_create_table_rejects_non_create_sql_in_text_output( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + 'DROP TABLE demo_cli_test;', + '--output=text', + ) + + assert completed.returncode == ARGUMENT_ERROR + assert completed.stdout == ( + 'FAIL FAILED\nmessage: 创建表结构失败\nerror: 建表语句不合法,仅允许 CREATE TABLE 语句\nenv: dev\n' + ) + + +def test_gen_create_table_rejects_non_create_sql_in_json_output( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + 'DROP TABLE demo_cli_test;', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == ARGUMENT_ERROR + assert payload == { + 'ok': False, + 'message': '创建表结构失败', + 'error': '建表语句不合法,仅允许 CREATE TABLE 语句', + 'env': 'dev', + } + + +def test_gen_create_table_rejects_conflicting_sql_inputs_in_text_output( + run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + completed = run_text_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + GEN_CREATE_SQL, + '--sql-file', + 'fake.sql', + '--output=text', + ) + + assert completed.returncode == ARGUMENT_ERROR + assert completed.stdout == ( + 'FAIL FAILED\nmessage: 创建表结构失败\nerror: 必须且只能传入 --sql 或 --sql-file 其中一种方式\nenv: dev\n' + ) + + +def test_gen_create_table_rejects_conflicting_sql_inputs_in_json_output( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], + parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict], +) -> None: + completed = run_cli_command( + 'gen', + 'create-table', + '--env=dev', + '--dry-run', + '--yes', + '--sql', + GEN_CREATE_SQL, + '--sql-file', + 'fake.sql', + '--output=json', + ) + payload = parse_json_stdout(completed) + + assert completed.returncode == ARGUMENT_ERROR + assert payload == { + 'ok': False, + 'message': '创建表结构失败', + 'error': '必须且只能传入 --sql 或 --sql-file 其中一种方式', + 'env': 'dev', + } diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_guards.py b/shierfeng-fastapi-backend/tests/cli/root/test_guards.py new file mode 100644 index 0000000..7759955 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_guards.py @@ -0,0 +1,69 @@ +import importlib +import sys +from pathlib import Path + +import pytest + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +sys.path.insert(0, str(BACKEND_DIR)) +cli_guards = importlib.import_module('cli.guards') +cli_guards = importlib.reload(cli_guards) + +DEFAULT_DANGEROUS_COMMAND_RULES = cli_guards.DEFAULT_DANGEROUS_COMMAND_RULES +DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY = cli_guards.DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY + + +def test_dangerous_command_rules_cover_expected_commands() -> None: + """ + 校验危险命令规则表已覆盖当前设计文档中约定的命令范围。 + + :return: None + """ + assert set(DEFAULT_DANGEROUS_COMMAND_RULES) == { + 'cache clear', + 'cache warmup', + 'db upgrade', + 'db init', + 'db downgrade', + 'db revision', + 'config set', + 'config sync-cache', + 'crypto rotate', + 'job run-once', + 'job pause', + 'job resume', + 'job sync', + 'gen import-table', + 'gen create-table', + 'gen export', + 'gen sync-db', + } + + +def test_dangerous_command_rules_expose_risk_level_and_dry_run_metadata() -> None: + """ + 校验危险命令规则能够提供风险级别和 dry-run 能力元数据。 + + :return: None + """ + db_upgrade_rule = DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY.get_rule('db upgrade') + cache_warmup_rule = DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY.get_rule('cache warmup') + + assert db_upgrade_rule is not None + assert db_upgrade_rule.risk_level == 'high' + assert db_upgrade_rule.supports_dry_run is True + + assert cache_warmup_rule is not None + assert cache_warmup_rule.risk_level == 'normal' + assert cache_warmup_rule.supports_dry_run is False + + +def test_require_dangerous_command_rule_rejects_unknown_command() -> None: + """ + 校验未注册的危险命令名称会被显式拒绝。 + + :return: None + """ + with pytest.raises(ValueError, match='危险命令未注册保护规则'): + DEFAULT_DANGEROUS_COMMAND_RULE_REGISTRY.require_rule('unknown dangerous command') diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_json_output_suppression.py b/shierfeng-fastapi-backend/tests/cli/root/test_json_output_suppression.py new file mode 100644 index 0000000..2e9fcbe --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_json_output_suppression.py @@ -0,0 +1,18 @@ +import subprocess +from collections.abc import Callable + + +def test_config_doctor_json_stdout_is_not_polluted_by_sqlalchemy_logs( + run_cli_command: Callable[..., subprocess.CompletedProcess[str]], +) -> None: + """ + 校验 JSON 输出模式下不会混入 SQLAlchemy engine 日志。 + + :param run_cli_command: CLI 子进程执行器 + :return: None + """ + completed = run_cli_command('config', 'doctor', '--env=dev', '--output=json') + + assert 'sqlalchemy.engine.Engine' not in completed.stdout + assert 'SELECT DATABASE()' not in completed.stdout + assert completed.stdout.lstrip().startswith('{') diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_main.py b/shierfeng-fastapi-backend/tests/cli/root/test_main.py new file mode 100644 index 0000000..f68f8e7 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_main.py @@ -0,0 +1,13 @@ +import importlib + + +def test_cli_main_runner_reuses_single_project_runtime_locator() -> None: + """ + 校验 CLI 根运行器与导入期参数作用域共享同一个项目定位器实例。 + + :return: None + """ + cli_main = importlib.import_module('cli.main') + + assert cli_main.CLI_MAIN_RUNNER.project_runtime_locator is cli_main.PROJECT_RUNTIME_LOCATOR + assert cli_main.CLI_MAIN_RUNNER.import_argv_scope.project_runtime_locator is cli_main.PROJECT_RUNTIME_LOCATOR diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_output.py b/shierfeng-fastapi-backend/tests/cli/root/test_output.py new file mode 100644 index 0000000..c4e0ce1 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_output.py @@ -0,0 +1,181 @@ +import importlib +import re +import sys +from pathlib import Path + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +sys.path.insert(0, str(BACKEND_DIR)) +sys.modules.pop('cli.output', None) +sys.modules.pop('cli', None) + +cli_output = importlib.import_module('cli.output') +OUTPUT_RENDERER = cli_output.OutputRenderer() + +_ANSI_ESCAPE_PATTERN = re.compile(r'\x1b\[[0-9;]*m') + + +class _FakeStream: + """ + 模拟终端输出流。 + + :param is_tty: 是否模拟为 TTY + """ + + def __init__(self, *, is_tty: bool) -> None: + self._is_tty = is_tty + + def isatty(self) -> bool: + """ + 返回是否为 TTY。 + + :return: 是否为 TTY + """ + return self._is_tty + + +def _strip_ansi(text: str) -> str: + """ + 移除 ANSI 转义序列,便于断言文本可视结果。 + + :param text: 原始带样式文本 + :return: 去除 ANSI 后的文本 + """ + return _ANSI_ESCAPE_PATTERN.sub('', text) + + +def test_decorate_text_output_promotes_success_header_with_emoji_icon() -> None: + """ + 校验成功结果头在 emoji 模式下会被提升为统一状态头。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + + rendered = OUTPUT_RENDERER.decorate_text_output('ok: true\nenv: dev') + + assert rendered == '✅ OK SUCCESS\nenv: dev' + + +def test_decorate_text_output_promotes_failure_header_with_emoji_icon() -> None: + """ + 校验失败结果头在 emoji 模式下会被提升为统一状态头。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + + rendered = OUTPUT_RENDERER.decorate_text_output('ok: false\nerror: boom') + + assert rendered == '❌ FAIL FAILED\nerror: boom' + + +def test_colorize_text_output_renders_inline_status_segments_with_emoji_icon() -> None: + """ + 校验文本着色后会为 message、hint、error 等字段附加状态标签。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + OUTPUT_RENDERER.set_color_mode('always') + decorated = OUTPUT_RENDERER.decorate_text_output('ok: false\nmessage: retry later\nhint: use --yes\nerror: boom') + + rendered = OUTPUT_RENDERER.colorize_text_output(decorated, _FakeStream(is_tty=True)) + + assert '\x1b[' in rendered + assert _strip_ansi(rendered) == ( + '❌ FAIL FAILED\nmessage: 💬 INFO retry later\nhint: 💡 HINT use --yes\nerror: 🚨 ERROR boom' + ) + + +def test_colorize_text_output_supports_warning_and_info_field_aliases() -> None: + """ + 校验 `warning` 与 `info` 字段也会使用统一状态图标渲染。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + OUTPUT_RENDERER.set_color_mode('always') + decorated = OUTPUT_RENDERER.decorate_text_output('ok: true\nwarning: rotate key soon\ninfo: cache refreshed') + + rendered = OUTPUT_RENDERER.colorize_text_output(decorated, _FakeStream(is_tty=True)) + + assert _strip_ansi(rendered) == ('✅ OK SUCCESS\nwarning: 💡 HINT rotate key soon\ninfo: 💬 INFO cache refreshed') + + +def test_colorize_text_output_styles_status_segments_inside_list_items() -> None: + """ + 校验列表项中的带标签状态片段也会应用统一视觉规则。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + OUTPUT_RENDERER.set_color_mode('always') + rendered = OUTPUT_RENDERER.colorize_text_output( + 'results:\n - users: true | exported\n - roles: false | error: lock timeout', + _FakeStream(is_tty=True), + ) + + assert _strip_ansi(rendered) == ( + 'results:\n - users: ✅ OK | exported\n - roles: ❌ FAIL | 🚨 ERROR lock timeout' + ) + + +def test_colorize_text_output_supports_ascii_icon_mode() -> None: + """ + 校验 ascii 图标模式会渲染为纯 ASCII 状态标签。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('ascii') + OUTPUT_RENDERER.set_color_mode('always') + decorated = OUTPUT_RENDERER.decorate_text_output('ok: true\nhint: use --yes') + + rendered = OUTPUT_RENDERER.colorize_text_output(decorated, _FakeStream(is_tty=True)) + + assert _strip_ansi(rendered) == '[OK] SUCCESS\nhint: [HINT] use --yes' + + +def test_colorize_text_output_skips_ansi_when_color_mode_is_never() -> None: + """ + 校验关闭颜色后不会输出 ANSI 转义序列。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + OUTPUT_RENDERER.set_color_mode('never') + decorated = OUTPUT_RENDERER.decorate_text_output('ok: false\nhint: use --yes') + + rendered = OUTPUT_RENDERER.colorize_text_output(decorated, _FakeStream(is_tty=True)) + + assert rendered == '❌ FAIL FAILED\nhint: use --yes' + assert '\x1b[' not in rendered + + +def test_render_error_text_uses_status_token_in_emoji_mode() -> None: + """ + 校验标准错误输出在 emoji 模式下使用统一错误图标。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('emoji') + OUTPUT_RENDERER.set_color_mode('never') + + rendered = OUTPUT_RENDERER.render_error_text('boom', 23, _FakeStream(is_tty=True)) + + assert rendered == '🚨 ERROR[23]: boom' + + +def test_render_error_text_supports_ascii_mode_with_color() -> None: + """ + 校验标准错误输出在 ascii 模式下仍保持统一错误前缀与颜色。 + + :return: None + """ + OUTPUT_RENDERER.set_icon_mode('ascii') + OUTPUT_RENDERER.set_color_mode('always') + + rendered = OUTPUT_RENDERER.render_error_text('boom', 23, _FakeStream(is_tty=True)) + + assert '\x1b[' in rendered + assert _strip_ansi(rendered) == '[ERROR][23]: boom' diff --git a/shierfeng-fastapi-backend/tests/cli/root/test_utils.py b/shierfeng-fastapi-backend/tests/cli/root/test_utils.py new file mode 100644 index 0000000..0f39f0c --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/root/test_utils.py @@ -0,0 +1,142 @@ +import importlib +import sys +from pathlib import Path +from types import SimpleNamespace + +from pytest import MonkeyPatch + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +sys.path.insert(0, str(BACKEND_DIR)) +sys.modules.pop('cli.utils', None) +cli_utils = importlib.import_module('cli.utils') + + +def test_run_nested_cli_command_extracts_json_from_noisy_stdout(monkeypatch: MonkeyPatch) -> None: + """ + 校验内部 CLI 调用可从带噪声的标准输出中提取 JSON 负载。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + def _fake_subprocess_run(*args: object, **kwargs: object) -> SimpleNamespace: + del args, kwargs + return SimpleNamespace( + stdout='debug line before json\n{"ok": true, "message": "success"}\ndebug line after json\n', + stderr='', + returncode=0, + ) + + monkeypatch.setattr(cli_utils.subprocess, 'run', _fake_subprocess_run) + + result = cli_utils.NESTED_CLI_SUPPORT.run('app', 'env', '--output=json', parse_json=True) + + assert result.payload == {'ok': True, 'message': 'success'} + + +def test_run_nested_cli_command_extracts_first_json_object_from_mixed_stdout( + monkeypatch: MonkeyPatch, +) -> None: + """ + 校验内部 CLI 调用可从混杂文本中提取首个合法 JSON 对象。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + def _fake_subprocess_run(*args: object, **kwargs: object) -> SimpleNamespace: + del args, kwargs + return SimpleNamespace( + stdout='preface\ntrace {not-json}\n{"ok": true, "message": "job done"}\ntrailer\n', + stderr='', + returncode=0, + ) + + monkeypatch.setattr(cli_utils.subprocess, 'run', _fake_subprocess_run) + + result = cli_utils.NESTED_CLI_SUPPORT.run('job', 'run-once', '1', '--output=json', parse_json=True) + + assert result.payload == {'ok': True, 'message': 'job done'} + + +def test_run_nested_cli_command_falls_back_to_text_payload_when_json_missing( + monkeypatch: MonkeyPatch, +) -> None: + """ + 校验内部 CLI 未返回 JSON 时会回退为文本结果负载。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + def _fake_subprocess_run(*args: object, **kwargs: object) -> SimpleNamespace: + del args, kwargs + return SimpleNamespace( + stdout='任务已提交到调度器', + stderr='', + returncode=0, + ) + + monkeypatch.setattr(cli_utils.subprocess, 'run', _fake_subprocess_run) + + result = cli_utils.NESTED_CLI_SUPPORT.run('job', 'run-once', '1', '--output=json', parse_json=True) + + assert result.payload is not None + assert result.payload.get('ok') is True + assert result.payload.get('message') == '任务已提交到调度器' + assert result.payload.get('fallback') == 'non_json_output' + + +def test_run_nested_cli_command_uses_backend_dir_and_pythonpath(monkeypatch: MonkeyPatch) -> None: + """ + 校验内部 CLI 调用会固定后端工作目录并注入项目路径。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + recorded_kwargs: dict[str, object] = {} + + def _fake_subprocess_run(*args: object, **kwargs: object) -> SimpleNamespace: + del args + recorded_kwargs.update(kwargs) + return SimpleNamespace(stdout='{}', stderr='', returncode=0) + + monkeypatch.setattr(cli_utils.subprocess, 'run', _fake_subprocess_run) + + result = cli_utils.NESTED_CLI_SUPPORT.run('app', 'env', parse_json=False) + + assert result.returncode == 0 + assert recorded_kwargs['cwd'] == str(BACKEND_DIR) + process_env = recorded_kwargs['env'] + assert isinstance(process_env, dict) + assert str(BACKEND_DIR) in process_env.get('PYTHONPATH', '') + + +def test_run_nested_cli_command_live_uses_backend_dir_without_capturing_output(monkeypatch: MonkeyPatch) -> None: + """ + 校验交互式内部 CLI 调用会复用后端工作目录并直接占用当前终端。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + recorded_kwargs: dict[str, object] = {} + recorded_args: tuple[object, ...] = () + + def _fake_subprocess_run(*args: object, **kwargs: object) -> SimpleNamespace: + nonlocal recorded_args + recorded_args = args + recorded_kwargs.update(kwargs) + return SimpleNamespace(returncode=0) + + monkeypatch.setattr(cli_utils.subprocess, 'run', _fake_subprocess_run) + + completed = cli_utils.NESTED_CLI_SUPPORT.run_live('wizard', 'cache-clear', '--output=text') + + assert completed.returncode == 0 + assert recorded_args + assert recorded_kwargs['cwd'] == str(BACKEND_DIR) + process_env = recorded_kwargs['env'] + assert isinstance(process_env, dict) + assert str(BACKEND_DIR) in process_env.get('PYTHONPATH', '') + assert 'capture_output' not in recorded_kwargs diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_app_runtime.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_app_runtime.py new file mode 100644 index 0000000..21bbada --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_app_runtime.py @@ -0,0 +1,151 @@ +from types import SimpleNamespace + +from pytest import MonkeyPatch + +from cli.runtime.app import AppRuntimeService +from cli.runtime.app.gateway import AppInfrastructureGateway +from cli.runtime.app.support import AppSnapshotSupport +from cli.runtime.base import RuntimeEnvironmentService + +REDIS_PORT = 6379 + + +class FakeRuntimeEnvironment(RuntimeEnvironmentService): + """ + 模拟运行时环境服务。 + """ + + @staticmethod + def get_backend_dir() -> str: + """ + 返回固定后端目录。 + + :return: 固定目录 + """ + return '/tmp/shierfeng-backend' + + @staticmethod + def get_python_executable() -> str: + """ + 返回固定 Python 可执行文件。 + + :return: Python 可执行文件路径 + """ + return '/usr/bin/python3' + + +def test_app_snapshot_support_builds_config_snapshot() -> None: + """ + 校验应用快照支持对象会构建应用配置快照。 + + :return: None + """ + gateway = AppInfrastructureGateway() + support = AppSnapshotSupport(gateway, FakeRuntimeEnvironment()) + + fake_env_module = SimpleNamespace( + AppConfig=SimpleNamespace( + app_env='dev', + app_name='shierfeng', + app_host='127.0.0.1', + app_port=8080, + app_root_path='/api', + app_reload=True, + app_workers=1, + app_disable_swagger=False, + app_disable_redoc=False, + ), + DataBaseConfig=SimpleNamespace( + db_type='mysql', + db_host='127.0.0.1', + db_port=3306, + db_database='shierfeng', + ), + RedisConfig=SimpleNamespace(redis_host='127.0.0.1', redis_port=REDIS_PORT), + LogConfig=SimpleNamespace(loguru_level='INFO'), + TransportCryptoConfig=SimpleNamespace( + transport_crypto_enabled=True, + transport_crypto_mode='strict', + ), + ) + + def _fake_get_env_module() -> SimpleNamespace: + return fake_env_module + + object.__setattr__(gateway, 'get_env_module', _fake_get_env_module) + + payload = support.build_app_config_snapshot() + + assert payload['env'] == 'dev' + assert payload['dbType'] == 'mysql' + assert payload['redisPort'] == REDIS_PORT + assert payload['transportCryptoMode'] == 'strict' + + +def test_app_snapshot_support_builds_env_snapshot(monkeypatch: MonkeyPatch) -> None: + """ + 校验应用快照支持对象会构建环境解析快照。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + gateway = AppInfrastructureGateway() + support = AppSnapshotSupport(gateway, FakeRuntimeEnvironment()) + fake_env_module = SimpleNamespace( + AppConfig=SimpleNamespace(app_env='prod'), + ) + + def _fake_get_env_module() -> SimpleNamespace: + return fake_env_module + + object.__setattr__(gateway, 'get_env_module', _fake_get_env_module) + monkeypatch.setenv('APP_ENV', 'test') + + payload = support.build_app_env_snapshot() + + assert payload == { + 'cliEnv': 'test', + 'configEnv': 'prod', + 'appEnv': 'test', + 'envFile': '.env.test', + 'envFilePath': '/tmp/shierfeng-backend/.env.test', + 'envFileExists': False, + 'backendDir': '/tmp/shierfeng-backend', + 'pythonExecutable': '/usr/bin/python3', + } + + +def test_app_runtime_service_builds_app_instance() -> None: + """ + 校验应用运行时 facade 会通过基础设施网关构建应用实例。 + + :return: None + """ + gateway = AppInfrastructureGateway() + service = AppRuntimeService( + runtime_environment=FakeRuntimeEnvironment(), + infrastructure_gateway=gateway, + ) + + class FakeServerModule: + """ + 模拟 server 模块。 + """ + + @staticmethod + def create_app() -> dict[str, str]: + """ + 返回模拟应用实例。 + + :return: 模拟应用实例 + """ + return {'app': 'ok'} + + def _fake_get_server_module() -> FakeServerModule: + return FakeServerModule() + + object.__setattr__(gateway, 'get_server_module', _fake_get_server_module) + + payload = service.build_app_instance() + + assert payload == {'app': 'ok'} diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_base.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_base.py new file mode 100644 index 0000000..7050476 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_base.py @@ -0,0 +1,44 @@ +from pathlib import Path + +from cli.core.app_builder import ProjectRuntimeLocator +from cli.runtime.base import RUNTIME_ENVIRONMENT +from cli.utils import NestedCliProjectLocator + + +def test_backend_project_dir_detection_uses_consistent_rule(tmp_path: Path) -> None: + """ + 校验不同入口的后端目录判定规则保持一致。 + + :param tmp_path: pytest 临时目录 + :return: None + """ + (tmp_path / 'app.py').write_text('', encoding='utf-8') + (tmp_path / 'config').mkdir() + (tmp_path / 'config' / 'env.py').write_text('', encoding='utf-8') + (tmp_path / 'cli').mkdir() + + project_runtime_locator = ProjectRuntimeLocator() + nested_cli_project_locator = NestedCliProjectLocator() + + assert RUNTIME_ENVIRONMENT.is_backend_project_dir(tmp_path) is True + assert project_runtime_locator.is_backend_project_dir(tmp_path) is True + assert nested_cli_project_locator.is_backend_project_dir(tmp_path) is True + + +def test_backend_project_dir_detection_rejects_directory_without_cli_package(tmp_path: Path) -> None: + """ + 校验缺少 cli 目录时不会被误判为后端项目根目录。 + + :param tmp_path: pytest 临时目录 + :return: None + """ + (tmp_path / 'app.py').write_text('', encoding='utf-8') + (tmp_path / 'config').mkdir() + (tmp_path / 'config' / 'env.py').write_text('', encoding='utf-8') + + project_runtime_locator = ProjectRuntimeLocator() + nested_cli_project_locator = NestedCliProjectLocator() + + assert RUNTIME_ENVIRONMENT.is_backend_project_dir(tmp_path) is False + assert project_runtime_locator.is_backend_project_dir(tmp_path) is False + assert nested_cli_project_locator.is_backend_project_dir(tmp_path) is False diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_cache.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_cache.py new file mode 100644 index 0000000..0c5e396 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_cache.py @@ -0,0 +1,164 @@ +import pytest + +from cli.runtime.cache import CacheRuntimeService +from cli.runtime.cache.gateway import REDIS_TTL_KEY_NOT_FOUND, CacheInfrastructureGateway +from cli.runtime.cache.support import CacheDomainSupport + +EXPECTED_MATCHED_KEY_COUNT = 2 + + +def test_cache_domain_support_extracts_scoped_keys() -> None: + """ + 校验缓存领域支持对象会提取指定缓存名前缀下的相对键名。 + + :return: None + """ + support = CacheDomainSupport(CacheInfrastructureGateway()) + + key_items = support.extract_cache_key_items( + 'sys_config', + ['sys_config:site_name', 'sys_config:logo', 'login_tokens:user:1'], + ) + + assert key_items == ['logo', 'site_name'] + + +def test_cache_domain_support_builds_missing_cache_result() -> None: + """ + 校验缓存领域支持对象会生成统一的缓存不存在结果。 + + :return: None + """ + support = CacheDomainSupport(CacheInfrastructureGateway()) + + payload = support.build_missing_cache_result('sys_config', 'site_name') + + assert payload['ok'] is False + assert payload['fullCacheKey'] == 'sys_config:site_name' + assert payload['message'] == '缓存不存在:sys_config:site_name' + + +@pytest.mark.asyncio +async def test_cache_runtime_service_ttl_returns_missing_result() -> None: + """ + 校验缓存运行时在 TTL 返回不存在标记时会输出统一缺失结果。 + + :return: None + """ + + class FakeRedis: + """ + 模拟 Redis 客户端。 + """ + + @staticmethod + async def ttl(full_cache_key: str) -> int: + """ + 返回 Redis 键不存在标记。 + + :param full_cache_key: 完整缓存键名 + :return: Redis TTL 特殊值 + """ + assert full_cache_key == 'sys_config:site_name' + return REDIS_TTL_KEY_NOT_FOUND + + @staticmethod + async def close() -> None: + """ + 关闭客户端。 + + :return: None + """ + + class FakeRedisUtil: + """ + 模拟 Redis 工具类。 + """ + + @staticmethod + async def create_redis_pool(*, log_enabled: bool = False) -> FakeRedis: + """ + 返回模拟 Redis 客户端。 + + :param log_enabled: 是否启用日志 + :return: 模拟 Redis 客户端 + """ + del log_enabled + return FakeRedis() + + gateway = CacheInfrastructureGateway() + service = CacheRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_redis_util() -> FakeRedisUtil: + return FakeRedisUtil() + + object.__setattr__(gateway, 'get_redis_util', _fake_get_redis_util) + + payload = await service.get_cache_ttl('sys_config', 'site_name') + + assert payload['ok'] is False + assert payload['fullCacheKey'] == 'sys_config:site_name' + + +@pytest.mark.asyncio +async def test_cache_runtime_service_clear_cache_dry_run_reports_scope() -> None: + """ + 校验缓存运行时 dry-run 清理会返回匹配键与清理范围。 + + :return: None + """ + + class FakeRedis: + """ + 模拟 Redis 客户端。 + """ + + @staticmethod + async def keys(pattern: str) -> list[str]: + """ + 返回匹配键列表。 + + :param pattern: 匹配模式 + :return: 匹配结果 + """ + assert pattern == 'sys_config:*' + return ['sys_config:site_name', 'sys_config:logo'] + + @staticmethod + async def close() -> None: + """ + 关闭客户端。 + + :return: None + """ + + class FakeRedisUtil: + """ + 模拟 Redis 工具类。 + """ + + @staticmethod + async def create_redis_pool(*, log_enabled: bool = False) -> FakeRedis: + """ + 返回模拟 Redis 客户端。 + + :param log_enabled: 是否启用日志 + :return: 模拟 Redis 客户端 + """ + del log_enabled + return FakeRedis() + + gateway = CacheInfrastructureGateway() + service = CacheRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_redis_util() -> FakeRedisUtil: + return FakeRedisUtil() + + object.__setattr__(gateway, 'get_redis_util', _fake_get_redis_util) + + payload = await service.clear_cache(cache_name='sys_config', dry_run=True) + + assert payload['ok'] is True + assert payload['matchedCount'] == EXPECTED_MATCHED_KEY_COUNT + assert payload['scope'] == {'mode': 'cacheName', 'cacheName': 'sys_config'} + assert payload['message'] == '缓存清理演练完成,未执行实际删除' diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_config.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_config.py new file mode 100644 index 0000000..47a7b2f --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_config.py @@ -0,0 +1,210 @@ +import pytest + +from cli.exit_codes import RUNTIME_ERROR +from cli.runtime.config import ConfigRuntimeService +from cli.runtime.config.gateway import ConfigInfrastructureGateway +from cli.runtime.config.support import ConfigDomainSupport + +MISSING_CONFIG_KEY = 'sys.demo.key' + + +def test_config_domain_support_builds_missing_config_result() -> None: + """ + 校验参数配置领域支持对象会生成统一的缺失结果。 + + :return: None + """ + support = ConfigDomainSupport(ConfigInfrastructureGateway()) + + payload = support.build_missing_config_result(MISSING_CONFIG_KEY, 'cache') + + assert payload == { + 'ok': False, + 'message': f'参数缓存不存在:{MISSING_CONFIG_KEY}', + 'source': 'cache', + 'exit_code': RUNTIME_ERROR, + } + + +def test_config_domain_support_serializes_cache_payload_with_sanitizer() -> None: + """ + 校验参数配置领域支持对象会对缓存配置做脱敏序列化。 + + :return: None + """ + + class FakeSanitizer: + """ + 模拟脱敏工具。 + """ + + @staticmethod + def sanitize_data(payload: dict[str, str]) -> dict[str, str]: + """ + 返回带标记的脱敏结果。 + + :param payload: 原始载荷 + :return: 脱敏结果 + """ + return {**payload, 'sanitized': 'yes'} + + gateway = ConfigInfrastructureGateway() + support = ConfigDomainSupport(gateway) + + def _fake_get_log_sanitizer() -> FakeSanitizer: + return FakeSanitizer() + + object.__setattr__(gateway, 'get_log_sanitizer', _fake_get_log_sanitizer) + + payload = support.serialize_cache_payload(MISSING_CONFIG_KEY, 'demo-value') + + assert payload == { + 'configKey': MISSING_CONFIG_KEY, + 'configValue': 'demo-value', + 'sanitized': 'yes', + } + + +def test_config_runtime_service_builds_cli_config_model_from_orm_record() -> None: + """ + 校验 CLI 会将 ORM 配置记录显式映射为可序列化的配置模型。 + + :return: None + """ + + class FakeOrmConfigRecord: + """ + 模拟 ORM 配置记录。 + """ + + config_id = 2 + config_name = '用户管理-账号初始密码' + config_key = 'sys.user.initPassword' + config_value = '123456' + config_type = 'Y' + create_by = 'admin' + create_time = None + update_by = '' + update_time = None + remark = '初始化密码 123456' + + class FakeConfigModel: + """ + 模拟 VO 配置模型。 + """ + + def __init__(self, **kwargs: object) -> None: + self.kwargs = kwargs + + class FakeConfigVoModule: + """ + 模拟配置 VO 模块。 + """ + + ConfigModel = FakeConfigModel + + model = ConfigRuntimeService.build_cli_config_model(FakeConfigVoModule, FakeOrmConfigRecord()) + + assert isinstance(model, FakeConfigModel) + assert model.kwargs == { + 'configId': 2, + 'configName': '用户管理-账号初始密码', + 'configKey': 'sys.user.initPassword', + 'configValue': '123456', + 'configType': 'Y', + 'createBy': 'admin', + 'createTime': None, + 'updateBy': '', + 'updateTime': None, + 'remark': '初始化密码 123456', + } + + +@pytest.mark.asyncio +async def test_config_runtime_service_returns_missing_db_config_result() -> None: + """ + 校验参数配置运行时在数据库中未找到配置时会返回统一结果。 + + :return: None + """ + + class FakeSession: + """ + 模拟异步会话。 + """ + + async def __aenter__(self) -> 'FakeSession': + return self + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: object, + ) -> None: + del exc_type, exc, tb + + class FakeSessionFactory: + """ + 模拟异步会话工厂。 + """ + + def __call__(self) -> FakeSession: + return FakeSession() + + class FakeConfigModel: + """ + 模拟配置模型。 + """ + + def __init__(self, **kwargs: str) -> None: + self.kwargs = kwargs + + class FakeConfigVoModule: + """ + 模拟配置 VO 模块。 + """ + + ConfigModel = FakeConfigModel + + class FakeConfigDao: + """ + 模拟配置 DAO。 + """ + + @staticmethod + async def get_config_detail_by_info(session: FakeSession, config_model: FakeConfigModel) -> None: + """ + 返回空结果。 + + :param session: 数据库会话 + :param config_model: 配置模型 + :return: None + """ + assert isinstance(session, FakeSession) + assert config_model.kwargs == {'configKey': MISSING_CONFIG_KEY} + + gateway = ConfigInfrastructureGateway() + service = ConfigRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_async_session_local() -> FakeSessionFactory: + return FakeSessionFactory() + + def _fake_get_config_dao() -> FakeConfigDao: + return FakeConfigDao() + + def _fake_get_config_vo_module() -> FakeConfigVoModule: + return FakeConfigVoModule() + + object.__setattr__(gateway, 'get_async_session_local', _fake_get_async_session_local) + object.__setattr__(gateway, 'get_config_dao', _fake_get_config_dao) + object.__setattr__(gateway, 'get_config_vo_module', _fake_get_config_vo_module) + + payload = await service.get_config(MISSING_CONFIG_KEY, source='db') + + assert payload == { + 'ok': False, + 'message': f'参数配置不存在:{MISSING_CONFIG_KEY}', + 'source': 'db', + 'exit_code': RUNTIME_ERROR, + } diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_crypto.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_crypto.py new file mode 100644 index 0000000..b68b82f --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_crypto.py @@ -0,0 +1,149 @@ +import json +from types import SimpleNamespace + +from cli.exit_codes import ARGUMENT_ERROR +from cli.runtime.crypto import CryptoRuntimeService +from cli.runtime.crypto.gateway import CryptoInfrastructureGateway +from cli.runtime.crypto.support import CryptoDomainSupport + +INVALID_RSA_KEY_SIZE = 1024 +VALID_RSA_KEY_SIZE = 2048 + + +def test_crypto_domain_support_rejects_invalid_rsa_key_size() -> None: + """ + 校验传输加密领域支持对象会拒绝非法 RSA 密钥长度。 + + :return: None + """ + support = CryptoDomainSupport(CryptoInfrastructureGateway()) + + try: + support.validate_rsa_key_size(INVALID_RSA_KEY_SIZE) + except ValueError as exc: + assert 'RSA 密钥长度必须大于等于 2048' in str(exc) + else: + raise AssertionError('expected ValueError for invalid RSA key size') + + +def test_crypto_domain_support_rejects_non_list_legacy_key_pairs() -> None: + """ + 校验传输加密领域支持对象会拒绝非数组格式的历史密钥配置。 + + :return: None + """ + gateway = CryptoInfrastructureGateway() + support = CryptoDomainSupport(gateway) + + def _fake_transport_crypto_config() -> SimpleNamespace: + return SimpleNamespace(transport_crypto_legacy_key_pairs='{"kid": "legacy"}') + + object.__setattr__(gateway, 'get_transport_crypto_config', _fake_transport_crypto_config) + + try: + support.load_existing_legacy_key_pairs() + except ValueError as exc: + assert 'TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS 必须为 JSON 数组' in str(exc) + else: + raise AssertionError('expected ValueError for invalid legacy key pairs payload') + + +def test_crypto_runtime_service_keygen_returns_argument_error_for_invalid_size() -> None: + """ + 校验传输加密运行时在非法密钥长度下返回参数错误结果。 + + :return: None + """ + service = CryptoRuntimeService() + + payload = service.generate_crypto_key_pair('kid-20260511', INVALID_RSA_KEY_SIZE) + + assert payload['ok'] is False + assert payload['exit_code'] == ARGUMENT_ERROR + assert payload['message'] == '生成传输加密密钥失败' + + +def test_crypto_runtime_service_rotation_rejects_same_kid() -> None: + """ + 校验传输加密运行时会拒绝与当前版本相同的新密钥版本。 + + :return: None + """ + gateway = CryptoInfrastructureGateway() + service = CryptoRuntimeService(infrastructure_gateway=gateway) + + provider = SimpleNamespace( + validate_runtime_configuration=lambda: None, + get_current_key_pair=lambda: SimpleNamespace( + kid='kid-current', + private_key_pem='PRIVATE-CURRENT', + public_key_pem='PUBLIC-CURRENT', + ), + ) + + object.__setattr__(gateway, 'get_transport_key_provider', lambda: provider) + + payload = service.build_rotation_payload('kid-current', VALID_RSA_KEY_SIZE) + + assert payload['ok'] is False + assert payload['exit_code'] == ARGUMENT_ERROR + assert payload['message'] == '生成密钥轮换方案失败' + assert payload['error'] == '新密钥版本不能与当前版本相同' + + +def test_crypto_runtime_service_rotation_builds_merged_payload() -> None: + """ + 校验传输加密运行时会生成包含历史密钥合并结果的轮换辅助数据。 + + :return: None + """ + gateway = CryptoInfrastructureGateway() + domain_support = CryptoDomainSupport(gateway) + service = CryptoRuntimeService( + infrastructure_gateway=gateway, + domain_support=domain_support, + ) + provider = SimpleNamespace( + validate_runtime_configuration=lambda: None, + get_current_key_pair=lambda: SimpleNamespace( + kid='kid-current', + private_key_pem='PRIVATE-CURRENT', + public_key_pem='PUBLIC-CURRENT', + ), + ) + + object.__setattr__(gateway, 'get_transport_key_provider', lambda: provider) + object.__setattr__( + domain_support, + 'generate_rsa_key_pair', + lambda key_size: ('PRIVATE-NEXT', 'PUBLIC-NEXT'), + ) + object.__setattr__( + domain_support, + 'load_existing_legacy_key_pairs', + lambda: [ + {'kid': 'kid-legacy', 'privateKey': 'PRIVATE-LEGACY', 'publicKey': 'PUBLIC-LEGACY'}, + {'kid': 'kid-next', 'privateKey': 'STALE-PRIVATE', 'publicKey': 'STALE-PUBLIC'}, + ], + ) + + payload = service.build_rotation_payload('kid-next', VALID_RSA_KEY_SIZE) + + assert payload['ok'] is True + assert payload['currentKid'] == 'kid-current' + assert payload['nextKid'] == 'kid-next' + assert payload['nextKeyPair']['privateKey'] == 'PRIVATE-NEXT' + assert payload['nextKeyPair']['publicKey'] == 'PUBLIC-NEXT' + assert payload['envPatch']['TRANSPORT_CRYPTO_KID'] == 'kid-next' + assert payload['envPatch']['TRANSPORT_CRYPTO_PRIVATE_KEY'] == 'PRIVATE-NEXT' + assert payload['envPatch']['TRANSPORT_CRYPTO_PUBLIC_KEY'] == 'PUBLIC-NEXT' + + legacy_key_pairs = payload['legacyKeyPairs'] + legacy_by_kid = {item['kid']: item for item in legacy_key_pairs} + assert 'kid-next' not in legacy_by_kid + assert legacy_by_kid['kid-current']['privateKey'] == 'PRIVATE-CURRENT' + assert legacy_by_kid['kid-legacy']['publicKey'] == 'PUBLIC-LEGACY' + + serialized_legacy = json.loads(payload['envPatch']['TRANSPORT_CRYPTO_LEGACY_KEY_PAIRS']) + serialized_by_kid = {item['kid']: item for item in serialized_legacy} + assert serialized_by_kid['kid-current']['publicKey'] == 'PUBLIC-CURRENT' diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_db.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_db.py new file mode 100644 index 0000000..4536198 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_db.py @@ -0,0 +1,144 @@ +from pathlib import Path + +import pytest + +from cli.runtime.base import RuntimeEnvironmentService +from cli.runtime.db import DatabaseRuntimeService +from cli.runtime.db.gateway import DatabaseInfrastructureGateway +from cli.runtime.db.support import DatabaseRevisionSupport + + +class FakeRuntimeEnvironment(RuntimeEnvironmentService): + """ + 模拟运行时环境服务。 + """ + + @staticmethod + def get_backend_dir() -> str: + """ + 返回固定后端目录。 + + :return: 固定目录 + """ + return '/tmp/shierfeng-backend' + + +def test_database_revision_support_serializes_revision() -> None: + """ + 校验数据库迁移版本支持对象会序列化 Alembic revision。 + + :return: None + """ + + class FakeRevision: + """ + 模拟 Alembic revision 对象。 + """ + + revision = '202605110001' + down_revision = ('202605100001',) + branch_labels = {'main'} + dependencies = None + doc = ' demo revision ' + path = Path('/tmp/revision.py') + + support = DatabaseRevisionSupport(DatabaseInfrastructureGateway(), FakeRuntimeEnvironment()) + + payload = support.serialize_revision(FakeRevision()) + + assert payload == { + 'revision': '202605110001', + 'downRevisions': ['202605100001'], + 'branchLabels': ['main'], + 'dependsOn': [], + 'doc': 'demo revision', + 'path': '/tmp/revision.py', + } + + +def test_database_runtime_service_upgrade_dry_run_returns_command_payload() -> None: + """ + 校验数据库运行时 dry-run 升级会返回命令预览结果。 + + :return: None + """ + service = DatabaseRuntimeService(runtime_environment=FakeRuntimeEnvironment()) + + payload = service.upgrade_database('head', dry_run=True) + + assert payload['ok'] is True + assert payload['dryRun'] is True + assert payload['cwd'] == '/tmp/shierfeng-backend' + assert payload['command'] == ['alembic', '-c', '/tmp/shierfeng-backend/alembic.ini', 'upgrade', 'head'] + + +@pytest.mark.asyncio +async def test_database_runtime_service_ping_database_returns_failure() -> None: + """ + 校验数据库运行时在连接异常时会返回失败结果。 + + :return: None + """ + + class FakeConnection: + """ + 模拟数据库连接对象。 + """ + + async def __aenter__(self) -> 'FakeConnection': + raise RuntimeError('db boom') + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: object, + ) -> None: + del exc_type, exc, tb + + class FakeEngine: + """ + 模拟数据库引擎。 + """ + + @staticmethod + def connect() -> FakeConnection: + """ + 返回模拟连接对象。 + + :return: 模拟连接对象 + """ + return FakeConnection() + + @staticmethod + async def dispose() -> None: + """ + 释放引擎资源。 + + :return: None + """ + + gateway = DatabaseInfrastructureGateway() + service = DatabaseRuntimeService( + runtime_environment=FakeRuntimeEnvironment(), + infrastructure_gateway=gateway, + ) + + def _fake_get_async_db_engine_factory() -> object: + def _factory(*, echo: bool = False) -> FakeEngine: + del echo + return FakeEngine() + + return _factory + + def _fake_get_sqlalchemy_text() -> object: + return lambda sql: sql + + object.__setattr__(gateway, 'get_async_db_engine_factory', _fake_get_async_db_engine_factory) + object.__setattr__(gateway, 'get_sqlalchemy_text', _fake_get_sqlalchemy_text) + + payload = await service.ping_database() + + assert payload['ok'] is False + assert payload['message'] == '数据库连接失败' + assert 'db boom' in payload['error'] diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_dev.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_dev.py new file mode 100644 index 0000000..ab33362 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_dev.py @@ -0,0 +1,126 @@ +from cli.exit_codes import DEPENDENCY_ERROR +from cli.runtime.base import RuntimeEnvironmentService +from cli.runtime.dev import DevelopmentRuntimeService +from cli.runtime.dev.gateway import DevelopmentProcessGateway +from cli.runtime.dev.support import DevelopmentCommandSupport, DevelopmentToolingSupport + + +class FakeRuntimeEnvironment(RuntimeEnvironmentService): + """ + 模拟运行时环境服务。 + """ + + @staticmethod + def get_backend_dir() -> str: + """ + 返回固定后端目录。 + + :return: 固定目录 + """ + return '/tmp/shierfeng-backend' + + @staticmethod + def get_python_executable() -> str: + """ + 返回固定 Python 可执行文件。 + + :return: Python 可执行文件路径 + """ + return '/usr/bin/python3' + + +def test_development_runtime_service_returns_dependency_error_when_pytest_missing() -> None: + """ + 校验开发运行时在 pytest 缺失时会返回依赖错误结果。 + + :return: None + """ + + class FakeToolingSupport(DevelopmentToolingSupport): + """ + 模拟开发工具支持对象。 + """ + + @staticmethod + def is_pytest_available() -> bool: + """ + 返回 pytest 不可用状态。 + + :return: False + """ + return False + + service = DevelopmentRuntimeService( + runtime_environment=FakeRuntimeEnvironment(), + tooling_support=FakeToolingSupport(), + ) + + payload = service.run_tests(['tests/cli']) + + assert payload == { + 'ok': False, + 'message': 'pytest 未安装,无法执行 dev test', + 'hint': '请在当前环境安装 pytest 后重试', + 'exit_code': DEPENDENCY_ERROR, + } + + +def test_development_runtime_service_run_lint_uses_command_support() -> None: + """ + 校验开发运行时会通过命令支持对象串联 format/check 执行流程。 + + :return: None + """ + + class FakeCommandSupport(DevelopmentCommandSupport): + """ + 模拟开发命令支持对象。 + """ + + def __init__(self) -> None: + self.recorded_commands: list[list[str]] = [] + + def build_format_command(self, normalized_targets: list[str], *, check_only: bool) -> list[str]: + assert normalized_targets == ['tests/cli'] + assert check_only is True + return ['format-command'] + + def build_check_command( + self, + normalized_targets: list[str], + *, + check_only: bool, + fix: bool, + unsafe_fixes: bool, + ) -> list[str]: + assert normalized_targets == ['tests/cli'] + assert check_only is True + assert fix is False + assert unsafe_fixes is False + return ['check-command'] + + class FakeProcessGateway(DevelopmentProcessGateway): + """ + 模拟开发子进程执行网关。 + """ + + def __init__(self) -> None: + self.recorded_commands: list[list[str]] = [] + + def run_command(self, command: list[str]) -> dict[str, object]: + self.recorded_commands.append(command) + return {'ok': True, 'command': command, 'returnCode': 0} + + command_support = FakeCommandSupport() + process_gateway = FakeProcessGateway() + service = DevelopmentRuntimeService( + runtime_environment=FakeRuntimeEnvironment(), + command_support=command_support, + process_gateway=process_gateway, + ) + + payload = service.run_lint(['tests/cli'], check_only=True) + + assert payload['ok'] is True + assert payload['targets'] == ['tests/cli'] + assert process_gateway.recorded_commands == [['format-command'], ['check-command']] diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_gen.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_gen.py new file mode 100644 index 0000000..b012568 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_gen.py @@ -0,0 +1,98 @@ +from pathlib import Path +from types import SimpleNamespace + +import pytest + +from cli.exit_codes import ARGUMENT_ERROR +from cli.runtime.gen import GenRuntimeService +from cli.runtime.gen.gateway import GenInfrastructureGateway +from cli.runtime.gen.support import GenDomainSupport + +REDIS_UNUSED = 'unused' + + +def test_gen_domain_support_resolves_sql_text_from_argument() -> None: + """ + 校验代码生成领域支持对象会优先使用直接传入的 SQL 文本。 + + :return: None + """ + support = GenDomainSupport(GenInfrastructureGateway()) + + payload = support.resolve_sql_text(' CREATE TABLE demo(id bigint); ', '') + + assert payload == 'CREATE TABLE demo(id bigint);' + + +def test_gen_domain_support_resolve_sql_text_rejects_invalid_inputs(tmp_path: Path) -> None: + """ + 校验代码生成领域支持对象会拒绝无效 SQL 输入组合。 + + :param tmp_path: pytest 临时目录 + :return: None + """ + support = GenDomainSupport(GenInfrastructureGateway()) + sql_file = tmp_path / 'demo.sql' + sql_file.write_text('select 1', encoding='utf-8') + + try: + support.resolve_sql_text('select 1', str(sql_file)) + except ValueError as exc: + assert '必须且只能传入 --sql 或 --sql-file 其中一种方式' in str(exc) + else: + raise AssertionError('expected ValueError for conflicting SQL inputs') + + +def test_gen_domain_support_writes_export_zip(tmp_path: Path) -> None: + """ + 校验代码生成领域支持对象会写出导出压缩包。 + + :param tmp_path: pytest 临时目录 + :return: None + """ + support = GenDomainSupport(GenInfrastructureGateway()) + target_file = tmp_path / 'exports' / 'gen.zip' + + output_path = support.write_export_zip(str(target_file), b'zip-content') + + assert output_path == str(target_file.resolve()) + assert target_file.read_bytes() == b'zip-content' + + +@pytest.mark.asyncio +async def test_gen_runtime_service_export_code_dry_run_returns_preview_payload() -> None: + """ + 校验代码生成运行时在 dry-run 导出时会返回结构化预览结果。 + + :return: None + """ + gateway = GenInfrastructureGateway() + service = GenRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_gen_config() -> SimpleNamespace: + return SimpleNamespace(allow_overwrite=True, GEN_PATH='/tmp/gen') + + object.__setattr__(gateway, 'get_gen_config', _fake_get_gen_config) + + payload = await service.export_code(['sys_user', 'sys_role'], mode='zip', dry_run=True) + + assert payload['ok'] is True + assert payload['dryRun'] is True + assert payload['tableNames'] == ['sys_user', 'sys_role'] + assert payload['outputFile'].endswith('gen_code_sys_user_sys_role.zip') + + +@pytest.mark.asyncio +async def test_gen_runtime_service_import_tables_requires_at_least_one_table() -> None: + """ + 校验代码生成运行时在未传入表名时会返回参数错误。 + + :return: None + """ + service = GenRuntimeService() + + payload = await service.import_tables([]) + + assert payload['ok'] is False + assert payload['exit_code'] == ARGUMENT_ERROR + assert payload['message'] == '至少需要传入一个表名' diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_job.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_job.py new file mode 100644 index 0000000..cee0f4e --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_job.py @@ -0,0 +1,174 @@ +import pytest + +from cli.runtime.job import JobRuntimeService +from cli.runtime.job.gateway import JobInfrastructureGateway +from cli.runtime.job.support import JobDomainSupport, JobSchedulerSupport + +MISSING_JOB_ID = 99 + + +def test_job_domain_support_builds_operation_metadata() -> None: + """ + 校验任务领域支持对象会返回统一的任务操作元数据。 + + :return: None + """ + support = JobDomainSupport(JobInfrastructureGateway()) + + payload = support.build_job_operation_metadata('pause') + + assert payload == { + 'operationLabel': '暂停任务', + 'successMessage': '定时任务已暂停', + } + + +def test_job_domain_support_serializes_model_dump_items() -> None: + """ + 校验任务领域支持对象会序列化带 `model_dump` 的任务项。 + + :return: None + """ + + class FakeJobModel: + """ + 模拟任务模型。 + """ + + @staticmethod + def model_dump(*, by_alias: bool = False, exclude_none: bool = False) -> dict[str, object]: + """ + 返回模拟序列化结果。 + + :param by_alias: 是否按别名输出 + :param exclude_none: 是否排除空值 + :return: 模拟序列化结果 + """ + assert by_alias is True + assert exclude_none is True + return {'jobId': 1, 'jobName': 'sync-job'} + + support = JobDomainSupport(JobInfrastructureGateway()) + + payload = support.serialize_job_item(FakeJobModel()) + + assert payload == {'jobId': 1, 'jobName': 'sync-job'} + + +@pytest.mark.asyncio +async def test_job_scheduler_support_closes_scheduler_and_redis() -> None: + """ + 校验任务调度支持对象会关闭调度器和 Redis 资源。 + + :return: None + """ + close_events: list[str] = [] + + class FakeRedis: + """ + 模拟 Redis 客户端。 + """ + + @staticmethod + async def close() -> None: + """ + 记录 Redis 关闭事件。 + + :return: None + """ + close_events.append('redis') + + class FakeSchedulerUtil: + """ + 模拟调度器工具。 + """ + + @staticmethod + async def close_system_scheduler() -> None: + """ + 记录调度器关闭事件。 + + :return: None + """ + close_events.append('scheduler') + + gateway = JobInfrastructureGateway() + support = JobSchedulerSupport(gateway) + + def _fake_get_scheduler_util() -> FakeSchedulerUtil: + return FakeSchedulerUtil() + + object.__setattr__(gateway, 'get_scheduler_util', _fake_get_scheduler_util) + + await support.close_scheduler_context(FakeRedis()) + + assert close_events == ['scheduler', 'redis'] + + +@pytest.mark.asyncio +async def test_job_runtime_service_reports_missing_job_detail() -> None: + """ + 校验任务运行时在任务详情不存在时会返回统一结果。 + + :return: None + """ + + class FakeSession: + """ + 模拟异步会话。 + """ + + async def __aenter__(self) -> 'FakeSession': + return self + + async def __aexit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: object, + ) -> None: + del exc_type, exc, tb + + class FakeSessionFactory: + """ + 模拟异步会话工厂。 + """ + + def __call__(self) -> FakeSession: + return FakeSession() + + class FakeJobService: + """ + 模拟任务服务。 + """ + + @staticmethod + async def job_detail_services(session: FakeSession, job_id: int) -> dict[str, object]: + """ + 返回不存在任务的空结果。 + + :param session: 数据库会话 + :param job_id: 任务 ID + :return: 空结果 + """ + assert isinstance(session, FakeSession) + assert job_id == MISSING_JOB_ID + return {} + + gateway = JobInfrastructureGateway() + service = JobRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_async_session_local() -> FakeSessionFactory: + return FakeSessionFactory() + + def _fake_get_job_service() -> FakeJobService: + return FakeJobService() + + object.__setattr__(gateway, 'get_async_session_local', _fake_get_async_session_local) + object.__setattr__(gateway, 'get_job_service', _fake_get_job_service) + + payload = await service.get_job_detail(MISSING_JOB_ID) + + assert payload['ok'] is False + assert payload['jobId'] == MISSING_JOB_ID + assert payload['message'] == f'定时任务不存在:{MISSING_JOB_ID}' diff --git a/shierfeng-fastapi-backend/tests/cli/runtime/test_ops.py b/shierfeng-fastapi-backend/tests/cli/runtime/test_ops.py new file mode 100644 index 0000000..6cc56c7 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/runtime/test_ops.py @@ -0,0 +1,167 @@ +import socket +from types import SimpleNamespace + +import pytest + +from cli.runtime.ops import OperationsRuntimeService +from cli.runtime.ops.gateway import OperationsInfrastructureGateway +from cli.runtime.ops.support import OperationsDependencyInspector, OperationsServerInfoSupport + + +def test_operations_dependency_inspector_reports_missing_required(monkeypatch: pytest.MonkeyPatch) -> None: + """ + 校验运维依赖检查器会报告缺失的必需依赖。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + inspector = OperationsDependencyInspector() + monkeypatch.setattr( + inspector, + 'read_package_version', + lambda distribution_name: None if distribution_name == 'fastapi' else '1.0.0', + ) + + payload = inspector.inspect() + + assert payload['ok'] is False + assert payload['missingRequired'] == ['fastapi'] + assert payload['packages']['python']['installed'] is True + + +def test_operations_server_info_support_resolves_non_loopback_ip(monkeypatch: pytest.MonkeyPatch) -> None: + """ + 校验服务器信息支持对象会在主机名解析失败时回退到网卡地址。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + + class FakePsutil: + """ + 模拟 psutil 模块。 + """ + + @staticmethod + def net_if_addrs() -> dict[str, list[SimpleNamespace]]: + """ + 返回模拟网卡地址。 + + :return: 模拟网卡地址映射 + """ + return { + 'en0': [ + SimpleNamespace(family=socket.AF_INET, address='127.0.0.1'), + SimpleNamespace(family=socket.AF_INET, address='192.168.1.8'), + ] + } + + gateway = OperationsInfrastructureGateway() + support = OperationsServerInfoSupport(gateway) + + def _fake_get_psutil_module() -> FakePsutil: + return FakePsutil() + + def _fake_gethostbyname(hostname: str) -> str: + del hostname + raise OSError('boom') + + monkeypatch.setattr(gateway, 'get_psutil_module', _fake_get_psutil_module) + monkeypatch.setattr(socket, 'gethostbyname', _fake_gethostbyname) + + resolved_ip = support.resolve_server_ip('demo-host') + + assert resolved_ip == '192.168.1.8' + + +@pytest.mark.asyncio +async def test_operations_runtime_service_sync_jobs_closes_resources_on_success() -> None: + """ + 校验运维运行时在同步调度成功后会关闭调度器和 Redis 资源。 + + :return: None + """ + close_events: list[str] = [] + + class FakeRedis: + """ + 模拟 Redis 客户端。 + """ + + @staticmethod + async def close() -> None: + """ + 记录关闭事件。 + + :return: None + """ + close_events.append('redis') + + class FakeRedisUtil: + """ + 模拟 Redis 工具。 + """ + + @staticmethod + async def create_redis_pool(*, log_enabled: bool = False) -> FakeRedis: + """ + 返回模拟 Redis 客户端。 + + :param log_enabled: 是否启用日志 + :return: 模拟 Redis 客户端 + """ + del log_enabled + return FakeRedis() + + class FakeSchedulerUtil: + """ + 模拟调度器工具。 + """ + + _is_leader = True + + @staticmethod + async def init_system_scheduler(redis: FakeRedis) -> None: + """ + 初始化调度器。 + + :param redis: Redis 客户端 + :return: None + """ + assert isinstance(redis, FakeRedis) + + @staticmethod + async def request_scheduler_sync() -> None: + """ + 发送调度同步请求。 + + :return: None + """ + + @staticmethod + async def close_system_scheduler() -> None: + """ + 记录调度器关闭事件。 + + :return: None + """ + close_events.append('scheduler') + + gateway = OperationsInfrastructureGateway() + service = OperationsRuntimeService(infrastructure_gateway=gateway) + + def _fake_get_redis_util() -> FakeRedisUtil: + return FakeRedisUtil() + + def _fake_get_scheduler_util() -> FakeSchedulerUtil: + return FakeSchedulerUtil() + + object.__setattr__(gateway, 'get_redis_util', _fake_get_redis_util) + object.__setattr__(gateway, 'get_scheduler_util', _fake_get_scheduler_util) + + payload = await service.sync_jobs() + + assert payload['ok'] is True + assert payload['schedulerSyncRequested'] is True + assert payload['isLeader'] is True + assert close_events == ['scheduler', 'redis'] diff --git a/shierfeng-fastapi-backend/tests/cli/tui/actions/test_action_execution.py b/shierfeng-fastapi-backend/tests/cli/tui/actions/test_action_execution.py new file mode 100644 index 0000000..a32b61a --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/actions/test_action_execution.py @@ -0,0 +1,579 @@ +import importlib +import sys +from pathlib import Path +from types import SimpleNamespace + +from pytest import MonkeyPatch + +BACKEND_DIR = Path(__file__).resolve().parents[4] + +sys.path.insert(0, str(BACKEND_DIR)) +sys.modules.pop('cli.tui.capabilities', None) +sys.modules.pop('cli.tui.actions', None) +sys.modules.pop('cli.wizard.flows.gen_import', None) +sys.modules.pop('cli', None) + +capabilities_module = importlib.import_module('cli.tui.capabilities') +actions_module = importlib.import_module('cli.tui.actions') +action_assembly_module = importlib.import_module('cli.tui.actions.assembly') +action_bootstrap_module = importlib.import_module('cli.tui.actions.bootstrap') +action_execution_module = importlib.import_module('cli.tui.actions.execution') +adapters_module = importlib.import_module('cli.tui.adapters') + + +def test_capabilities_registry_describes_supported_views() -> None: + """ + 校验 TUI 能力注册表会集中描述页面支持的动作能力。 + + :return: None + """ + cache_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_browser_capabilities('cache') + gen_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_browser_capabilities('gen') + app_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_detail_capabilities('app') + database_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_detail_capabilities('database') + ops_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_detail_capabilities('ops') + crypto_capabilities = capabilities_module.TUI_CAPABILITY_REGISTRY.get_detail_capabilities('crypto') + + assert [capability.slot for capability in cache_capabilities] == ['global', 'utility'] + assert [capability.kind for capability in cache_capabilities] == ['wizard_entry', 'low_risk_action'] + assert [capability.hint_label for capability in cache_capabilities] == ['清理向导', '执行缓存预热'] + assert [capability.slot for capability in gen_capabilities] == ['primary', 'secondary', 'global', 'utility'] + assert [capability.kind for capability in gen_capabilities] == [ + 'wizard_entry', + 'wizard_entry', + 'preview', + 'low_risk_action', + ] + assert [capability.hint_label for capability in gen_capabilities] == [ + '导出向导', + '导入向导', + '导出预演', + '同步表结构', + ] + assert [capability.slot for capability in app_capabilities] == ['primary', 'global', 'utility'] + assert [capability.kind for capability in app_capabilities] == ['wizard_entry', 'wizard_entry', 'command_hint'] + assert [capability.hint_label for capability in app_capabilities] == ['直接启动', '打开启动向导', '安装补全'] + assert [capability.slot for capability in database_capabilities] == ['global', 'utility'] + assert [capability.kind for capability in database_capabilities] == ['wizard_entry', 'preview'] + assert [capability.hint_label for capability in database_capabilities] == ['打开升级向导', '初始化预演'] + assert [capability.slot for capability in ops_capabilities] == ['primary', 'secondary', 'global'] + assert [capability.kind for capability in ops_capabilities] == [ + 'low_risk_action', + 'low_risk_action', + 'wizard_entry', + ] + assert [capability.hint_label for capability in ops_capabilities] == [ + '数据库探活', + 'Redis 探活', + '打开生产巡检向导', + ] + assert [capability.slot for capability in crypto_capabilities] == ['primary', 'global'] + assert [capability.kind for capability in crypto_capabilities] == ['wizard_entry', 'preview'] + assert [capability.hint_label for capability in crypto_capabilities] == ['密钥生成', '执行轮换预演'] + + +def test_action_registry_resolves_browser_action_for_job_record() -> None: + """ + 校验任务页会解析出执行一次、暂停/恢复和同步动作。 + + :return: None + """ + record = adapters_module.BrowserRecordSnapshot( + key='job:101', + title='同步任务', + status='warn', + summary='暂停 · Cron 0/30 * * * * ?', + metadata_lines=[], + detail_sections=[], + ) + + primary_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='jobs', + slot='primary', + record=record, + env='dev', + ) + secondary_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='jobs', + slot='secondary', + record=record, + env='dev', + ) + global_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='jobs', + slot='global', + record=record, + env='dev', + ) + + assert primary_action is not None + assert primary_action.command_args == ('job', 'run-once', '101') + assert secondary_action is not None + assert secondary_action.command_args == ('job', 'resume', '101') + assert global_action is not None + assert global_action.command_args == ('job', 'sync') + + +def test_action_registry_resolves_browser_action_for_cache_and_gen_entries() -> None: + """ + 校验缓存页和代码生成页会解析出外部向导动作。 + + :return: None + """ + cache_record = adapters_module.BrowserRecordSnapshot( + key='cache:sys_config', + title='sys_config', + status='ok', + summary='系统参数缓存', + metadata_lines=[], + detail_sections=[], + ) + gen_record = adapters_module.BrowserRecordSnapshot( + key='gen:201', + title='sys_user', + status='ok', + summary='生成类 SysUser · 模块 system', + metadata_lines=[], + detail_sections=[], + ) + + cache_global_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='cache', + slot='global', + record=cache_record, + env='dev', + ) + cache_utility_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='cache', + slot='utility', + record=cache_record, + env='dev', + ) + gen_primary_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='gen', + slot='primary', + record=gen_record, + env='dev', + ) + gen_secondary_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='gen', + slot='secondary', + record=gen_record, + env='dev', + ) + gen_utility_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='gen', + slot='utility', + record=gen_record, + env='dev', + ) + gen_global_action = actions_module.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='gen', + slot='global', + record=gen_record, + env='dev', + ) + + assert cache_global_action is not None + assert cache_global_action.execution_mode == 'external' + assert cache_global_action.command_args == ( + 'wizard', + 'cache-clear', + '--output=text', + '--default-env=dev', + '--default-mode=cache-name', + '--default-cache-name=sys_config', + '--default-dry-run', + ) + assert cache_utility_action is not None + assert cache_utility_action.execution_mode == 'nested_json' + assert gen_primary_action is not None + assert gen_primary_action.execution_mode == 'external' + assert gen_primary_action.command_args == ( + 'wizard', + 'gen-export', + '--output=text', + '--default-env=dev', + '--default-table-names=sys_user', + '--default-mode=zip', + '--default-dry-run', + ) + assert gen_primary_action.refresh_view is False + assert gen_secondary_action is not None + assert gen_secondary_action.execution_mode == 'external' + assert gen_secondary_action.command_args == ( + 'wizard', + 'gen-import', + '--output=text', + '--default-env=dev', + '--default-table-names=sys_user', + '--default-dry-run', + ) + assert gen_secondary_action.refresh_view is False + assert gen_global_action is not None + assert gen_global_action.execution_mode == 'nested_json' + assert gen_global_action.command_args == ('gen', 'export', 'sys_user', '--dry-run', '--mode=zip') + assert gen_utility_action is not None + assert gen_utility_action.execution_mode == 'nested_json' + assert gen_utility_action.command_args == ('gen', 'sync-db', 'sys_user') + + +def test_action_template_factories_build_expected_job_and_gen_templates() -> None: + """ + 校验领域动作模板工厂会生成符合预期的命令参数。 + + :return: None + """ + job_record = adapters_module.BrowserRecordSnapshot( + key='job:88', + title='通知任务', + status='ok', + summary='运行中 · Cron 0 0/5 * * * ?', + metadata_lines=[], + detail_sections=[], + ) + gen_record = adapters_module.BrowserRecordSnapshot( + key='gen:301', + title='sys_notice', + status='ok', + summary='生成类 SysNotice · 模块 system', + metadata_lines=[], + detail_sections=[], + ) + + run_once_template = action_bootstrap_module._JOB_ACTION_TEMPLATE_FACTORY.create_run_once_template() + toggle_template = action_bootstrap_module._JOB_ACTION_TEMPLATE_FACTORY.create_toggle_template() + export_template = action_bootstrap_module._GEN_ACTION_TEMPLATE_FACTORY.create_export_wizard_template() + + assert run_once_template.command_builder(job_record, 'dev') == ('job', 'run-once', '88') + assert toggle_template.command_builder(job_record, 'dev') == ('job', 'pause', '88') + assert toggle_template.label_builder is not None + assert toggle_template.label_builder(job_record, 'dev') == '暂停任务' + assert export_template.command_builder(gen_record, 'dev') == ( + 'wizard', + 'gen-export', + '--output=text', + '--default-env=dev', + '--default-table-names=sys_notice', + '--default-mode=zip', + '--default-dry-run', + ) + + +def test_action_registry_builder_assembles_expected_slots() -> None: + """ + 校验动作注册表构建器会装配浏览页与详情页动作槽位。 + + :return: None + """ + registry = action_assembly_module.TuiActionRegistryBuilder( + jobs=action_bootstrap_module._JOB_ACTION_TEMPLATE_FACTORY, + cache=action_bootstrap_module._CACHE_ACTION_TEMPLATE_FACTORY, + gen=action_bootstrap_module._GEN_ACTION_TEMPLATE_FACTORY, + static=action_bootstrap_module._STATIC_ACTION_TEMPLATE_FACTORY, + spec_factory=action_bootstrap_module._ACTION_SPEC_FACTORY, + ).build() + + assert sorted(registry.browser_resolvers) == ['cache', 'configs', 'gen', 'jobs'] + assert sorted(registry.detail_resolvers) == ['app', 'crypto', 'database', 'ops'] + assert sorted(registry.browser_resolvers['gen'].slot_templates) == ['global', 'primary', 'secondary', 'utility'] + assert sorted(registry.detail_resolvers['ops'].slot_templates) == ['global', 'primary', 'secondary'] + + +def test_action_registry_resolves_detail_action_for_database_and_ops_wizard_entries() -> None: + """ + 校验详情页会解析出数据库升级和生产巡检向导动作。 + + :return: None + """ + database_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='database', + slot='global', + env='dev', + ) + database_utility_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='database', + slot='utility', + env='dev', + ) + app_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='app', + slot='global', + env='dev', + ) + app_primary_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='app', + slot='primary', + env='dev', + ) + app_utility_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='app', + slot='utility', + env='dev', + ) + ops_primary_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='ops', + slot='primary', + env='dev', + ) + ops_secondary_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='ops', + slot='secondary', + env='dev', + ) + ops_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='ops', + slot='global', + env='dev', + ) + crypto_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='crypto', + slot='global', + env='dev', + ) + crypto_primary_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='crypto', + slot='primary', + env='dev', + ) + unknown_action = actions_module.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='dashboard', + slot='global', + env='dev', + ) + + assert app_primary_action is not None + assert app_primary_action.execution_mode == 'external' + assert app_primary_action.command_args == ('app', 'run', '--env=dev') + assert app_primary_action.refresh_view is False + assert app_action is not None + assert app_action.execution_mode == 'external' + assert app_action.command_args == ('wizard', 'app-run') + assert app_action.refresh_view is False + assert app_utility_action is not None + assert app_utility_action.execution_mode == 'external' + assert app_utility_action.command_args == ('completion', 'install', '--activate') + assert app_utility_action.refresh_view is False + assert database_action is not None + assert database_action.execution_mode == 'external' + assert database_action.command_args == ( + 'wizard', + 'db-upgrade', + '--output=text', + '--default-env=dev', + '--default-revision=head', + '--default-dry-run', + ) + assert database_utility_action is not None + assert database_utility_action.execution_mode == 'nested_json' + assert database_utility_action.command_args == ('db', 'init', '--dry-run') + assert ops_primary_action is not None + assert ops_primary_action.execution_mode == 'nested_json' + assert ops_primary_action.command_args == ('ops', 'ping-db') + assert ops_secondary_action is not None + assert ops_secondary_action.execution_mode == 'nested_json' + assert ops_secondary_action.command_args == ('ops', 'ping-redis') + assert ops_action is not None + assert ops_action.execution_mode == 'external' + assert ops_action.command_args == ( + 'wizard', + 'prod-check', + '--output=text', + '--default-env=dev', + '--default-include-config', + ) + assert crypto_primary_action is not None + assert crypto_primary_action.execution_mode == 'external' + assert crypto_primary_action.command_args == ('crypto', 'keygen', '--env=dev', '--output=text') + assert crypto_primary_action.refresh_view is False + assert crypto_action is not None + assert crypto_action.execution_mode == 'nested_json' + assert crypto_action.command_args == ('crypto', 'rotate', '--dry-run') + assert unknown_action is None + + +def test_action_execution_service_execute_appends_env_output_and_yes(monkeypatch: MonkeyPatch) -> None: + """ + 校验 TUI 动作执行时会复用 CLI JSON 输出并自动附带确认参数。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + calls: list[tuple[str, ...]] = [] + + def _fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + assert parse_json is True + calls.append(arguments) + return SimpleNamespace(payload={'ok': True, 'message': '参数缓存刷新成功'}) + + monkeypatch.setattr(action_execution_module.NESTED_CLI_SUPPORT, 'run', _fake_run_nested_cli_command) + spec = actions_module.TuiActionSpec( + action_id='config-sync-cache', + label='刷新参数缓存', + command_args=('config', 'sync-cache'), + preview_title='刷新参数缓存', + preview_lines=['line a'], + ) + + result = actions_module.TUI_ACTION_EXECUTION_SERVICE.execute(spec, 'dev') + + assert result.ok is True + assert calls == [('config', 'sync-cache', '--env=dev', '--output=json', '--yes')] + + +def test_action_execution_service_execute_skips_yes_for_readonly_action(monkeypatch: MonkeyPatch) -> None: + """ + 校验只读动作执行时不会错误追加 `--yes`。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + calls: list[tuple[str, ...]] = [] + + def _fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + assert parse_json is True + calls.append(arguments) + return SimpleNamespace(payload={'ok': True, 'message': '数据库连接成功'}) + + monkeypatch.setattr(action_execution_module.NESTED_CLI_SUPPORT, 'run', _fake_run_nested_cli_command) + spec = actions_module.TuiActionSpec( + action_id='ops-ping-db', + label='数据库探活', + command_args=('ops', 'ping-db'), + preview_title='数据库探活', + preview_lines=['line a'], + append_yes=False, + ) + + result = actions_module.TUI_ACTION_EXECUTION_SERVICE.execute(spec, 'dev') + + assert result.ok is True + assert calls == [('ops', 'ping-db', '--env=dev', '--output=json')] + + +def test_action_execution_service_execute_external_uses_live_nested_command(monkeypatch: MonkeyPatch) -> None: + """ + 校验外部交互动作会通过 live nested CLI helper 执行。 + + :param monkeypatch: pytest monkeypatch 工具 + :return: None + """ + calls: list[tuple[str, ...]] = [] + + def _fake_run_nested_cli_command_live(*arguments: str) -> SimpleNamespace: + calls.append(arguments) + return SimpleNamespace(returncode=0) + + monkeypatch.setattr(action_execution_module.NESTED_CLI_SUPPORT, 'run_live', _fake_run_nested_cli_command_live) + spec = actions_module.TuiActionSpec( + action_id='wizard-cache-clear', + label='打开缓存清理向导', + command_args=('wizard', 'cache-clear', '--output=text'), + preview_title='打开缓存清理向导', + preview_lines=['line a'], + execution_mode='external', + ) + + result = actions_module.TUI_ACTION_EXECUTION_SERVICE.execute_external(spec) + + assert result.ok is True + assert result.message == '外部交互命令已执行完成' + assert calls == [('wizard', 'cache-clear', '--output=text')] + + +def test_action_presentation_service_build_browser_action_hint_matches_supported_views() -> None: + """ + 校验浏览页动作提示会按页面输出不同文案。 + + :return: None + """ + assert '[X]' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('jobs') + assert '[Y]' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('configs') + assert '[W]' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('cache') + assert '[Y] 清理向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('cache') + assert '[X] 导出向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('gen') + assert '[Z] 导入向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('gen') + assert '[Y] 导出预演' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('gen') + assert '[W] 同步表结构' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('gen') + assert '失败聚合' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('jobs') + assert '浏览键' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_browser_action_hint('jobs') + + +def test_action_presentation_service_build_detail_action_hint_matches_supported_views() -> None: + """ + 校验详情页动作提示会按页面输出不同文案。 + + :return: None + """ + assert '[X] 直接启动' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('app') + assert '[Y] 打开启动向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('app') + assert '[W] 安装补全' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('app') + assert '[Y] 打开升级向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('database') + assert '[X] 数据库探活' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('ops') + assert '[Z] Redis 探活' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('ops') + assert '[Y] 打开生产巡检向导' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('ops') + assert '[X] 密钥生成' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('crypto') + assert '[Y] 执行轮换预演' in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('crypto') + assert ( + '环境映射、应用配置、启动前检查、补全诊断和路由状态,再决定是安装补全、直接启动应用还是进入启动向导' + in actions_module.TUI_ACTION_PRESENTATION_SERVICE.build_detail_action_hint('app') + ) + + +def test_action_execution_service_build_result_lines_surfaces_common_payload_fields() -> None: + """ + 校验动作结果详情会提取常见结果字段。 + + :return: None + """ + spec = actions_module.TuiActionSpec( + action_id='job-run-once', + label='执行一次任务', + command_args=('job', 'run-once', '1'), + preview_title='执行一次任务', + preview_lines=['line a'], + ) + result = actions_module.TuiActionResult( + spec=spec, + payload={ + 'ok': True, + 'message': '执行完成', + 'serviceMessage': '调度器已触发', + 'hint': '可继续刷新页面确认状态', + 'jobId': 1, + }, + ) + + lines = actions_module.TUI_ACTION_EXECUTION_SERVICE.build_result_lines(result) + + assert any('结果: 成功' in line for line in lines) + assert any('服务反馈: 调度器已触发' in line for line in lines) + assert any('摘要: 执行完成' in line for line in lines) + assert any('建议: 可继续刷新页面确认状态' in line for line in lines) + assert any('任务 ID: 1' in line for line in lines) + + +def test_action_execution_service_build_result_lines_surfaces_external_exit_code() -> None: + """ + 校验外部交互动作结果会展示退出码。 + + :return: None + """ + spec = actions_module.TuiActionSpec( + action_id='wizard-gen-export', + label='打开导出向导', + command_args=('wizard', 'gen-export', '--output=text'), + preview_title='打开导出向导', + preview_lines=['line a'], + execution_mode='external', + ) + result = actions_module.TuiActionResult( + spec=spec, + external_exit_code=1, + external_message='外部交互命令执行失败,退出码 1', + ) + + lines = actions_module.TUI_ACTION_EXECUTION_SERVICE.build_result_lines(result) + + assert any('结果: 失败' in line for line in lines) + assert any('退出码: 1' in line for line in lines) diff --git a/shierfeng-fastapi-backend/tests/cli/tui/adapters/conftest.py b/shierfeng-fastapi-backend/tests/cli/tui/adapters/conftest.py new file mode 100644 index 0000000..0bc8ca7 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/adapters/conftest.py @@ -0,0 +1,87 @@ +import asyncio +import importlib +import sys +from collections.abc import Callable +from pathlib import Path +from types import ModuleType + +import pytest + +BACKEND_DIR = Path(__file__).resolve().parents[4] + +sys.path.insert(0, str(BACKEND_DIR)) + + +def _load_adapter_module(module_name: str) -> ModuleType: + sys.modules.pop(module_name, None) + sys.modules.pop('cli', None) + return importlib.import_module(module_name) + + +@pytest.fixture +def app_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.app') + + +@pytest.fixture +def cache_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.cache') + + +@pytest.fixture +def crypto_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.crypto') + + +@pytest.fixture +def database_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.database') + + +@pytest.fixture +def jobs_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.jobs') + + +@pytest.fixture +def gen_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.gen') + + +@pytest.fixture +def configs_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.configs') + + +@pytest.fixture +def ops_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.ops') + + +@pytest.fixture +def health_adapter() -> ModuleType: + return _load_adapter_module('cli.tui.adapters.health') + + +@pytest.fixture +def load_adapter_module() -> Callable[[str], ModuleType]: + return _load_adapter_module + + +@pytest.fixture(autouse=True) +def dispose_async_db_engine_after_test() -> None: + """ + 在每个 TUI adapter 测试结束后尝试释放全局异步数据库连接池。 + + 这些适配器测试会按需导入运行时模块;若其中某些路径触发真实数据库访问, + 模块级 `async_engine` 可能在测试进程结束前仍持有连接,从而在 GC 阶段产生 + SQLAlchemy 未归还连接告警。这里统一在测试后主动 `dispose()`,将清理职责收口 + 到测试夹具而非业务代码。 + + :return: None + """ + yield + database_module = sys.modules.get('config.database') + async_engine = getattr(database_module, 'async_engine', None) if database_module is not None else None + if async_engine is not None: + asyncio.run(async_engine.dispose()) diff --git a/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_app_ops_snapshots.py b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_app_ops_snapshots.py new file mode 100644 index 0000000..00af911 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_app_ops_snapshots.py @@ -0,0 +1,345 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_collect_app_page_snapshot_builds_env_config_and_route_sections( + monkeypatch: MonkeyPatch, + app_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace( + payload={ + 'ok': True, + 'runtime': { + 'cliEnv': 'dev', + 'configEnv': 'dev', + 'appEnv': 'dev', + 'envFile': '.env.dev', + 'envFileExists': True, + 'backendDir': '/srv/backend', + 'pythonExecutable': '/opt/conda/envs/shierfeng-fastapi/bin/python', + }, + } + ) + if arguments[0:2] == ('app', 'config'): + return SimpleNamespace( + payload={ + 'ok': True, + 'config': { + 'name': 'ShiErFeng', + 'host': '127.0.0.1', + 'port': 8000, + 'rootPath': '/', + 'workers': 2, + 'reload': True, + 'disableSwagger': False, + 'disableRedoc': True, + 'logLevel': 'INFO', + 'dbType': 'mysql', + 'dbHost': '127.0.0.1', + 'dbPort': 3306, + 'dbDatabase': 'shierfeng', + 'redisHost': '127.0.0.1', + 'redisPort': 6379, + 'transportCryptoEnabled': True, + 'transportCryptoMode': 'strict', + }, + } + ) + if arguments[0:2] == ('app', 'routes'): + return SimpleNamespace( + payload={ + 'ok': True, + 'count': 3, + 'routes': [], + 'groupedRoutes': {'system': [{}, {}], 'monitor': [{}]}, + } + ) + if arguments[0:2] == ('app', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'env': 'dev', + 'database': {'ok': True, 'message': '数据库连接成功'}, + 'redis': {'ok': True, 'message': 'Redis连接成功'}, + 'crypto': {'ok': True, 'message': '传输加密配置有效'}, + } + ) + if arguments[0:2] == ('completion', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': 'completion 诊断信息已生成', + 'activeShell': 'bash', + 'projectDir': '/srv/backend', + 'envChoices': ['dev', 'prod'], + 'completeEnvVar': '_SHIERFENG_COMPLETE', + 'recommendedInstallCommand': 'shierfeng completion install --shell=bash --activate', + 'shells': { + 'bash': { + 'supported': True, + 'detected': True, + 'targetFile': '/tmp/shierfeng.bash', + 'targetFileExists': True, + 'rcFile': '/Users/demo/.bashrc', + 'rcFileExists': True, + 'autoDiscovery': False, + 'sourceCommand': 'source /tmp/shierfeng.bash', + 'recommendedInstallCommand': 'shierfeng completion install --shell=bash --activate', + }, + 'zsh': {'supported': True, 'detected': False, 'autoDiscovery': False}, + 'fish': {'supported': True, 'detected': False, 'autoDiscovery': True}, + 'powershell': { + 'supported': True, + 'detected': False, + 'autoDiscovery': False, + 'sourceCommand': '. "/tmp/shierfeng.ps1"', + 'recommendedInstallCommand': 'shierfeng completion install --shell=powershell --activate', + }, + }, + } + ) + if arguments[0:2] == ('completion', 'show'): + return SimpleNamespace( + returncode=0, + stdout='_SHIERFENG_COMPLETE=bash_complete\n_shierfeng_completion() {\n COMPREPLY=()\n}\n', + stderr='', + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'count': 3, + 'routes': [ + { + 'path': '/system/user/list', + 'methods': ['GET'], + 'summary': '查询用户列表', + } + ], + 'groupedRoutes': { + 'system': [{}, {}], + 'monitor': [{}], + }, + } + ) + + monkeypatch.setattr(app_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = app_adapter.APP_DETAIL_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '应用' + assert ( + snapshot.subtitle + == '聚焦:环境映射 / 配置摘要 / 启动前检查 | 当前已加载 3 条注册路由,可继续查看环境映射、配置摘要、启动前检查、补全诊断与路由状态' + ) + assert [section.title for section in snapshot.sections] == [ + '总览判断', + '环境解析', + '应用配置', + '依赖配置', + '启动前检查', + '补全诊断', + '补全脚本预览', + '补全安装入口', + '路由摘要', + '启动入口', + ] + assert snapshot.search is not None + assert snapshot.search.placeholder == '按分区或内容搜索' + assert any('CLI 环境: dev' in line for line in snapshot.sections[0].lines) + assert any('CLI 目标环境: dev' in line for line in snapshot.sections[1].lines) + assert any('监听地址: 127.0.0.1:8000' in line for line in snapshot.sections[2].lines) + assert any('传输加密: 开启' in line for line in snapshot.sections[3].lines) + assert any('数据库: 正常' in line for line in snapshot.sections[4].lines) + assert any('活动 Shell: bash' in line for line in snapshot.sections[5].lines) + assert any('source /tmp/shierfeng.bash' in line for line in snapshot.sections[5].lines) + assert any('Shell: bash' in line for line in snapshot.sections[6].lines) + assert any('_SHIERFENG_COMPLETE=bash_complete' in line for line in snapshot.sections[6].lines) + assert any('completion install --activate --output=text' in line for line in snapshot.sections[7].lines) + assert any('system · 2 条' in line for line in snapshot.sections[8].lines) + assert any('app run --env=dev' in line for line in snapshot.sections[9].lines) + + +def test_collect_app_page_snapshot_applies_query_filter( + monkeypatch: MonkeyPatch, + app_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace(payload={'ok': True, 'runtime': {'cliEnv': 'dev', 'configEnv': 'dev'}}) + if arguments[0:2] == ('app', 'config'): + return SimpleNamespace( + payload={ + 'ok': True, + 'config': { + 'name': 'ShiErFeng', + 'host': '127.0.0.1', + 'port': 8000, + 'rootPath': '/', + 'workers': 2, + 'reload': True, + 'disableSwagger': False, + 'disableRedoc': True, + 'logLevel': 'INFO', + 'dbType': 'mysql', + 'dbHost': '127.0.0.1', + 'dbPort': 3306, + 'dbDatabase': 'shierfeng', + 'redisHost': '127.0.0.1', + 'redisPort': 6379, + 'transportCryptoEnabled': True, + 'transportCryptoMode': 'strict', + }, + } + ) + if arguments[0:2] == ('completion', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': 'completion 诊断信息已生成', + 'activeShell': 'bash', + 'projectDir': '/srv/backend', + 'envChoices': ['dev'], + 'completeEnvVar': '_SHIERFENG_COMPLETE', + 'recommendedInstallCommand': 'shierfeng completion install --shell=bash --activate', + 'shells': {'bash': {'supported': True, 'detected': True, 'autoDiscovery': False}}, + } + ) + return SimpleNamespace(payload={'ok': True, 'count': 1, 'routes': [], 'groupedRoutes': {}}) + + monkeypatch.setattr(app_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = app_adapter.APP_DETAIL_ADAPTER.collect_snapshot('dev', query='路由') + + assert [section.title for section in snapshot.sections] == ['总览判断', '路由摘要'] + assert snapshot.search is not None + assert snapshot.search.query == '路由' + + +def test_collect_ops_page_snapshot_builds_health_dependency_and_server_sections( + monkeypatch: MonkeyPatch, + ops_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('ops', 'health'): + return SimpleNamespace( + payload={ + 'ok': True, + 'env': 'dev', + 'database': {'ok': True, 'message': '数据库连接成功'}, + 'redis': {'ok': True, 'message': 'Redis连接成功'}, + } + ) + if arguments[0:2] == ('ops', 'ping-db'): + return SimpleNamespace(payload={'ok': True, 'message': '数据库连接成功'}) + if arguments[0:2] == ('ops', 'ping-redis'): + return SimpleNamespace(payload={'ok': True, 'message': 'Redis连接成功'}) + if arguments[0:2] == ('ops', 'deps'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': '核心运行依赖已安装', + 'missingRequired': [], + 'packages': { + 'python': {'installed': True, 'version': '3.10.0'}, + 'fastapi': {'installed': True, 'version': '0.111.0'}, + 'sqlalchemy': {'installed': True, 'version': '2.0.0'}, + 'redis': {'installed': True, 'version': '5.0.0'}, + 'typer': {'installed': True, 'version': '0.12.0'}, + 'alembic': {'installed': True, 'version': '1.13.0'}, + }, + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'server': { + 'sys': { + 'computerName': 'shierfeng-node', + 'computerIp': '10.0.0.8', + 'osName': 'Linux', + 'osArch': 'x86_64', + }, + 'cpu': {'cpuNum': 8, 'used': 21.5}, + 'mem': {'total': '16 GB', 'usage': 48.2}, + 'py': {'version': '3.10.0', 'runTime': '2天4小时', 'used': '256 MB', 'total': '1 GB'}, + 'sysFiles': [ + { + 'dirName': '/', + 'used': '120 GB', + 'total': '256 GB', + 'usage': '46%', + 'free': '136 GB', + } + ], + }, + } + ) + + monkeypatch.setattr(ops_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = ops_adapter.OPS_DETAIL_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '运维' + assert ( + snapshot.subtitle + == '聚焦:数据库连通性 / Redis 连通性 / 依赖版本 | 基础探活和依赖状态正常,可继续查看服务器资源与磁盘样本' + ) + assert [section.title for section in snapshot.sections] == [ + '总览判断', + '健康检查', + '数据库探活', + 'Redis 探活', + '依赖版本', + '服务器摘要', + '磁盘样本', + '生产巡检入口', + ] + assert any('探活状态: 正常' in line for line in snapshot.sections[0].lines) + assert any('数据库: 正常' in line for line in snapshot.sections[1].lines) + assert any('数据库连接: 正常' in line for line in snapshot.sections[2].lines) + assert any('Redis 连接: 正常' in line for line in snapshot.sections[3].lines) + assert any('fastapi · 已安装' in line for line in snapshot.sections[4].lines) + assert any('主机名: shierfeng-node' in line for line in snapshot.sections[5].lines) + assert any('使用率 46%' in line for line in snapshot.sections[6].lines) + assert any('wizard prod-check' in line for line in snapshot.sections[7].lines) + assert snapshot.search is not None + assert snapshot.search.placeholder == '按分区或内容搜索' + + +def test_collect_ops_page_snapshot_surfaces_health_risk_subtitle( + monkeypatch: MonkeyPatch, + ops_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('ops', 'health'): + return SimpleNamespace( + payload={ + 'ok': False, + 'env': 'dev', + 'database': {'ok': False, 'message': '数据库连接失败'}, + 'redis': {'ok': True, 'message': 'Redis连接成功'}, + } + ) + if arguments[0:2] == ('ops', 'ping-db'): + return SimpleNamespace(payload={'ok': False, 'message': '数据库连接失败'}) + if arguments[0:2] == ('ops', 'ping-redis'): + return SimpleNamespace(payload={'ok': True, 'message': 'Redis连接成功'}) + if arguments[0:2] == ('ops', 'deps'): + return SimpleNamespace(payload={'ok': True, 'missingRequired': [], 'packages': {}, 'message': '依赖正常'}) + return SimpleNamespace(payload={'ok': True, 'server': {'sys': {}, 'cpu': {}, 'mem': {}, 'py': {}}}) + + monkeypatch.setattr(ops_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = ops_adapter.OPS_DETAIL_ADAPTER.collect_snapshot('dev') + + assert ( + snapshot.subtitle + == '聚焦:数据库连通性 / Redis 连通性 / 依赖版本 | 运维探活存在异常,优先核对数据库/Redis 连通性与依赖版本' + ) diff --git a/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_cache_db_crypto_snapshots.py b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_cache_db_crypto_snapshots.py new file mode 100644 index 0000000..42dee79 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_cache_db_crypto_snapshots.py @@ -0,0 +1,346 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_collect_cache_page_snapshot_builds_cache_browser_records( + monkeypatch: MonkeyPatch, + cache_adapter: ModuleType, +) -> None: + calls: list[tuple[str, ...]] = [] + + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + calls.append(arguments) + if arguments[0:2] == ('cache', 'stats'): + return SimpleNamespace( + payload={ + 'ok': True, + 'dbSize': 128, + 'info': { + 'redis_version': '7.0', + 'connected_clients': 12, + 'used_memory_human': '16M', + }, + 'commandStats': [{'name': 'get', 'value': 88}], + 'cacheNames': [{'cacheName': 'sys_config', 'remark': '系统参数缓存'}], + } + ) + if arguments[0:2] == ('cache', 'keys'): + return SimpleNamespace( + payload={ + 'ok': True, + 'cacheName': 'sys_config', + 'count': 2, + 'keys': ['site_name', 'site_logo'], + } + ) + if arguments[0:2] == ('cache', 'get'): + return SimpleNamespace( + payload={ + 'ok': True, + 'cacheName': 'sys_config', + 'cacheKey': arguments[3], + 'cacheValue': 'hello-world', + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'cacheName': 'sys_config', + 'cacheKey': arguments[3], + 'ttlSeconds': 3600, + 'persistent': False, + 'expires': True, + } + ) + + monkeypatch.setattr(cache_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = cache_adapter.CACHE_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '缓存' + assert ( + snapshot.subtitle + == '聚焦:Redis 键数 / 连接数 / 缓存名前缀 | 缓存基线正常,当前已加载 1 个缓存名,Redis 键数 128,连接数 12,可继续查看键列表、键值样本和 TTL' + ) + assert len(snapshot.records) == 1 + assert snapshot.records[0].title == 'sys_config' + detail_sections = snapshot.records[0].resolve_detail_sections() + assert [section.title for section in detail_sections] == [ + '键摘要', + '键列表', + '键详情 · site_name', + '键详情 · site_logo', + ] + assert any('site_name' in line for line in detail_sections[1].lines) + assert any('TTL: 3600 秒' in line for line in detail_sections[2].lines) + assert any('hello-world' in line for line in detail_sections[2].lines) + assert any('TTL: 3600 秒' in line for line in detail_sections[3].lines) + assert snapshot.shared_sections[0].title == '总览判断' + assert any('已登记缓存名: 1 个' in line for line in snapshot.shared_sections[0].lines) + assert any('当前匹配: 1 个' in line for line in snapshot.shared_sections[0].lines) + assert snapshot.shared_sections[1].title == 'Redis 摘要' + assert snapshot.shared_sections[2].title == '命令统计' + assert snapshot.shared_sections[3].title == '缓存清理入口' + assert any('wizard cache-clear' in line for line in snapshot.shared_sections[3].lines) + assert any(call[0:2] == ('cache', 'get') for call in calls) + assert any(call[0:2] == ('cache', 'ttl') for call in calls) + + +def test_cache_browser_adapter_collect_snapshot_exposes_search_context( + monkeypatch: MonkeyPatch, + cache_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('cache', 'stats'): + return SimpleNamespace( + payload={ + 'ok': True, + 'dbSize': 8, + 'info': { + 'redis_version': '7.0', + 'connected_clients': 2, + 'used_memory_human': '1M', + }, + 'commandStats': [], + 'cacheNames': [{'cacheName': 'sys_config', 'remark': '系统参数缓存'}], + } + ) + return SimpleNamespace(payload={'ok': False, 'message': 'unexpected'}) + + monkeypatch.setattr(cache_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = cache_adapter.CACHE_BROWSER_ADAPTER.collect_snapshot('dev', query='sys') + + assert snapshot.title == '缓存' + assert snapshot.search is not None + assert snapshot.search.query == 'sys' + assert snapshot.records + assert snapshot.records[0].title == 'sys_config' + + +def test_collect_database_page_snapshot_builds_check_heads_and_history_sections( + monkeypatch: MonkeyPatch, + database_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace(payload={'ok': True, 'currentRevision': '202604300001'}) + if arguments[0:2] == ('db', 'check'): + return SimpleNamespace(payload={'ok': True, 'message': '数据库连接成功'}) + if arguments[0:2] == ('db', 'heads'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': '已读取 Alembic heads', + 'count': 1, + 'items': [ + { + 'revision': '202604300001', + 'downRevisions': ['202604290001'], + 'branchLabels': ['main'], + 'dependsOn': [], + 'doc': 'create user table', + 'path': '/srv/backend/alembic/versions/202604300001_create_user.py', + } + ], + } + ) + if arguments[0:2] == ('db', 'history'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': '已读取 Alembic 历史版本', + 'count': 2, + 'totalCount': 2, + 'limit': 8, + 'items': [ + { + 'revision': '202604300001', + 'downRevisions': ['202604290001'], + 'branchLabels': ['main'], + 'dependsOn': [], + 'doc': 'create user table', + 'path': '/srv/backend/alembic/versions/202604300001_create_user.py', + }, + { + 'revision': '202604290001', + 'downRevisions': [], + 'branchLabels': [], + 'dependsOn': [], + 'doc': 'init schema', + 'path': '/srv/backend/alembic/versions/202604290001_init_schema.py', + }, + ], + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'config': { + 'dbType': 'mysql', + 'dbHost': '127.0.0.1', + 'dbPort': 3306, + 'dbDatabase': 'shierfeng', + }, + } + ) + + monkeypatch.setattr(database_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = database_adapter.DATABASE_DETAIL_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '数据库' + assert ( + snapshot.subtitle + == '聚焦:迁移版本 / 连接状态 / Heads | 数据库基线正常,当前 revision 202604300001,可继续查看连接、heads 和历史版本' + ) + assert [section.title for section in snapshot.sections] == [ + '总览判断', + '迁移版本', + '连接信息', + '连通性检查', + 'Heads 状态', + '历史版本', + '初始化预演入口', + '升级入口', + ] + assert any('当前 revision: 202604300001' in line for line in snapshot.sections[0].lines) + assert any('迁移版本: 202604300001' in line for line in snapshot.sections[1].lines) + assert any('连接地址: 127.0.0.1:3306' in line for line in snapshot.sections[2].lines) + assert any('数据库连接: 正常' in line for line in snapshot.sections[3].lines) + assert any('Heads 数量: 1' in line for line in snapshot.sections[4].lines) + assert any('Head 01 · 202604300001' in line for line in snapshot.sections[4].lines) + assert any('总版本数: 2' in line for line in snapshot.sections[5].lines) + assert any('版本 02 · 202604290001' in line for line in snapshot.sections[5].lines) + assert any('db init --dry-run --output=text' in line for line in snapshot.sections[6].lines) + assert any('wizard db-upgrade' in line for line in snapshot.sections[7].lines) + assert snapshot.search is not None + assert snapshot.search.placeholder == '按 revision 搜索' + + +def test_collect_database_page_snapshot_surfaces_failed_heads( + monkeypatch: MonkeyPatch, + database_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace(payload={'ok': True, 'currentRevision': '202604300001'}) + if arguments[0:2] == ('db', 'check'): + return SimpleNamespace(payload={'ok': True, 'message': '数据库连接成功'}) + if arguments[0:2] == ('db', 'heads'): + return SimpleNamespace(payload={'ok': False, 'message': '读取 Alembic heads 失败', 'error': 'broken graph'}) + if arguments[0:2] == ('db', 'history'): + return SimpleNamespace(payload={'ok': True, 'count': 0, 'totalCount': 0, 'limit': 8, 'items': []}) + return SimpleNamespace( + payload={ + 'ok': True, + 'config': { + 'dbType': 'mysql', + 'dbHost': '127.0.0.1', + 'dbPort': 3306, + 'dbDatabase': 'shierfeng', + }, + } + ) + + monkeypatch.setattr(database_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = database_adapter.DATABASE_DETAIL_ADAPTER.collect_snapshot('dev') + + assert snapshot.subtitle == '聚焦:迁移版本 / 连接状态 / Heads | 数据库存在迁移分叉风险,优先确认 heads 和历史版本' + assert snapshot.sections[0].title == '总览判断' + assert snapshot.sections[0].status == 'warn' + assert snapshot.sections[4].title == 'Heads 状态' + assert snapshot.sections[4].status == 'fail' + assert any('读取 Alembic heads 失败' in line for line in snapshot.sections[4].lines) + + +def test_collect_database_page_snapshot_applies_query_filter( + monkeypatch: MonkeyPatch, + database_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace(payload={'ok': True, 'currentRevision': '202604300001'}) + if arguments[0:2] == ('db', 'check'): + return SimpleNamespace(payload={'ok': True, 'message': '数据库连接成功'}) + if arguments[0:2] == ('db', 'heads'): + return SimpleNamespace(payload={'ok': True, 'count': 1, 'items': []}) + if arguments[0:2] == ('db', 'history'): + return SimpleNamespace(payload={'ok': True, 'count': 0, 'totalCount': 0, 'limit': 8, 'items': []}) + return SimpleNamespace( + payload={ + 'ok': True, + 'config': {'dbType': 'mysql', 'dbHost': '127.0.0.1', 'dbPort': 3306, 'dbDatabase': 'shierfeng'}, + } + ) + + monkeypatch.setattr(database_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = database_adapter.DATABASE_DETAIL_ADAPTER.collect_snapshot('dev', query='历史') + + assert [section.title for section in snapshot.sections] == ['历史版本'] + assert snapshot.search is not None + assert snapshot.search.query == '历史' + + +def test_collect_crypto_page_snapshot_builds_validate_and_public_key_sections( + monkeypatch: MonkeyPatch, + crypto_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('crypto', 'validate'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': '传输加密配置校验通过', + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'publicKey': { + 'kid': 'default', + 'alg': 'RSA-OAEP', + 'envelopeVersion': 'v1', + 'expireAt': '2099-12-31T23:59:59', + 'supportedKids': ['default', 'legacy-a'], + 'publicKey': '-----BEGIN PUBLIC KEY-----\nAAA\nBBB\n-----END PUBLIC KEY-----', + }, + } + ) + + monkeypatch.setattr(crypto_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = crypto_adapter.CRYPTO_DETAIL_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '传输加密' + assert ( + snapshot.subtitle + == '聚焦:运行校验 / 公钥身份 / 兼容版本 | 当前 KID default,兼容版本 2 个,可继续查看公钥身份、兼容版本与轮换预演入口' + ) + assert [section.title for section in snapshot.sections] == [ + '总览判断', + '运行校验', + '公钥身份', + '兼容版本', + '公钥预览', + '密钥生成入口', + '轮换预演入口', + ] + assert any('运行校验: 通过' in line for line in snapshot.sections[0].lines) + assert any('状态: 通过' in line for line in snapshot.sections[1].lines) + assert any('KID: default' in line for line in snapshot.sections[2].lines) + assert any('支持版本: legacy-a' in line for line in snapshot.sections[3].lines) + assert any('BEGIN PUBLIC KEY' in line for line in snapshot.sections[4].lines) + assert any('crypto keygen' in line for line in snapshot.sections[5].lines) + assert any('crypto rotate' in line for line in snapshot.sections[6].lines) + assert snapshot.search is not None + assert snapshot.search.placeholder == '按分区或内容搜索' diff --git a/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_configs_dashboard_snapshots.py b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_configs_dashboard_snapshots.py new file mode 100644 index 0000000..9d8fb04 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_configs_dashboard_snapshots.py @@ -0,0 +1,494 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_collect_dashboard_snapshot_adds_risk_heat_panel( + monkeypatch: MonkeyPatch, + health_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace( + payload={ + 'ok': True, + 'runtime': { + 'cliEnv': 'dev', + 'configEnv': 'dev', + 'envFile': '.env.dev', + 'envFileExists': True, + }, + } + ) + if arguments[0:2] == ('app', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': False, + 'database': {'ok': False, 'message': '数据库连接失败'}, + 'redis': {'ok': True, 'message': 'Redis 正常'}, + 'crypto': {'ok': True, 'message': '加密组件正常'}, + } + ) + if arguments[0:2] == ('app', 'routes'): + return SimpleNamespace( + payload={ + 'ok': True, + 'count': 3, + 'routes': [], + 'groupedRoutes': {'system': [{}, {}], 'monitor': [{}]}, + } + ) + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace( + payload={ + 'ok': False, + 'currentRevision': '-', + 'message': 'revision unavailable', + } + ) + if arguments[0:2] == ('ops', 'deps'): + return SimpleNamespace( + payload={ + 'ok': True, + 'message': '核心运行依赖已安装', + 'missingRequired': [], + 'packages': { + 'python': {'installed': True, 'version': '3.10.0'}, + 'fastapi': {'installed': True, 'version': '0.111.0'}, + 'sqlalchemy': {'installed': True, 'version': '2.0.0'}, + 'redis': {'installed': True, 'version': '5.0.0'}, + }, + } + ) + if arguments[0:2] == ('ops', 'server-info'): + return SimpleNamespace( + payload={ + 'ok': True, + 'server': { + 'sys': {'computerName': 'shierfeng-node', 'computerIp': '10.0.0.8'}, + 'cpu': {'used': 18.2}, + 'mem': {'usage': 42.5}, + }, + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'dbSize': 128, + 'info': {'redis_version': '7.0', 'connected_clients': 12}, + 'cacheNames': ['sys_config'], + } + ) + + monkeypatch.setattr(health_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = health_adapter.DASHBOARD_ADAPTER.collect_snapshot('dev') + + assert any(panel.title == '总览判断' for panel in snapshot.panels) + assert any(panel.title == '建议摘要' for panel in snapshot.panels) + assert any(panel.title == '风险摘要' for panel in snapshot.panels) + assert any(panel.title == '依赖版本' for panel in snapshot.panels) + assert any(panel.title == '服务器摘要' for panel in snapshot.panels) + app_panel = next(panel for panel in snapshot.panels if panel.title == '应用摘要') + conclusion_panel = next(panel for panel in snapshot.panels if panel.title == '总览判断') + entry_panel = next(panel for panel in snapshot.panels if panel.title == '建议摘要') + assert any('当前环境: dev | CLI 目标环境: dev' in line for line in app_panel.lines) + assert any('注册路由: 3 条 | 标签分组: 2 个' in line for line in app_panel.lines) + assert conclusion_panel.status == 'fail' + assert any('数据库存在异常' in line for line in conclusion_panel.lines) + assert any('优先进入数据库页面' in line for line in conclusion_panel.lines) + assert entry_panel.status == 'fail' + assert any('[B] 数据库' in line for line in entry_panel.lines) + assert any('[O] 运维' in line for line in entry_panel.lines) + assert any('聚焦:迁移版本 / 连接状态 / Heads' in line for line in entry_panel.lines) + assert any('聚焦:数据库连通性 / Redis 连通性 / 依赖版本' in line for line in entry_panel.lines) + heat_panel = next(panel for panel in snapshot.panels if panel.title == '风险摘要') + assert heat_panel.status == 'fail' + assert any('HOT-01' in line for line in heat_panel.lines) + assert any(metric.title == '依赖通过率' and '[' in metric.value for metric in snapshot.metrics) + + +def test_dashboard_adapter_collect_snapshot_exposes_metrics( + monkeypatch: MonkeyPatch, + health_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace(payload={'ok': True, 'runtime': {'cliEnv': 'dev', 'configEnv': 'dev'}}) + if arguments[0:2] == ('app', 'routes'): + return SimpleNamespace(payload={'ok': True, 'count': 2, 'routes': [], 'groupedRoutes': {}}) + if arguments[0:2] == ('app', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'database': {'ok': True, 'message': '数据库正常'}, + 'redis': {'ok': True, 'message': 'Redis 正常'}, + 'crypto': {'ok': True, 'message': '加密正常'}, + } + ) + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace(payload={'ok': True, 'currentRevision': '202604300001'}) + if arguments[0:2] == ('ops', 'deps'): + return SimpleNamespace(payload={'ok': True, 'missingRequired': [], 'packages': {}}) + if arguments[0:2] == ('ops', 'server-info'): + return SimpleNamespace(payload={'ok': True, 'server': {'sys': {}, 'cpu': {}, 'mem': {}}}) + return SimpleNamespace(payload={'ok': True, 'dbSize': 27, 'info': {}, 'cacheNames': []}) + + monkeypatch.setattr(health_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = health_adapter.DASHBOARD_ADAPTER.collect_snapshot('dev') + + assert snapshot.env == 'dev' + assert snapshot.metrics + assert any(metric.title == '依赖通过率' for metric in snapshot.metrics) + assert any(panel.title == '总览判断' for panel in snapshot.panels) + + +def test_collect_dashboard_snapshot_uses_focus_hints_for_healthy_business_entry( + monkeypatch: MonkeyPatch, + health_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace(payload={'ok': True, 'runtime': {'cliEnv': 'dev', 'configEnv': 'dev'}}) + if arguments[0:2] == ('app', 'routes'): + return SimpleNamespace( + payload={'ok': True, 'count': 4, 'routes': [], 'groupedRoutes': {'system': [{}, {}]}} + ) + if arguments[0:2] == ('app', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'database': {'ok': True, 'message': '数据库正常'}, + 'redis': {'ok': True, 'message': 'Redis 正常'}, + 'crypto': {'ok': True, 'message': '加密组件正常'}, + } + ) + if arguments[0:2] == ('db', 'current'): + return SimpleNamespace(payload={'ok': True, 'currentRevision': '202604300001'}) + if arguments[0:2] == ('ops', 'deps'): + return SimpleNamespace(payload={'ok': True, 'missingRequired': [], 'packages': {}, 'message': '依赖正常'}) + if arguments[0:2] == ('ops', 'server-info'): + return SimpleNamespace(payload={'ok': True, 'server': {'sys': {}, 'cpu': {}, 'mem': {}}}) + return SimpleNamespace( + payload={ + 'ok': True, + 'dbSize': 27, + 'info': {'redis_version': '7.2.6', 'connected_clients': 1}, + 'cacheNames': [], + } + ) + + monkeypatch.setattr(health_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = health_adapter.DASHBOARD_ADAPTER.collect_snapshot('dev') + + entry_panel = next(panel for panel in snapshot.panels if panel.title == '建议摘要') + + assert entry_panel.status == 'ok' + assert any('聚焦:失败聚合 / 暂停任务 / 执行轨迹' in line for line in entry_panel.lines) + assert any('聚焦:高风险配置 / 值不一致 / 缓存漂移' in line for line in entry_panel.lines) + assert any('生成前校验' in line and '代码预览' in line for line in entry_panel.lines) + + +def test_collect_configs_page_snapshot_surfaces_failure_message( + monkeypatch: MonkeyPatch, + configs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del arguments, parse_json + return SimpleNamespace( + payload={ + 'ok': False, + 'message': '读取参数配置诊断信息失败', + 'error': 'database unavailable', + } + ) + + monkeypatch.setattr(configs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '参数配置' + assert snapshot.records[0].status == 'fail' + assert snapshot.shared_sections[0].title == '总览判断' + assert snapshot.shared_sections[1].title == '配置巡检' + assert any('读取参数配置诊断信息失败' in line for line in snapshot.shared_sections[1].lines) + assert any('database unavailable' in line for line in snapshot.shared_sections[1].lines) + + +def test_configs_browser_adapter_collect_snapshot_exposes_search_context( + monkeypatch: MonkeyPatch, + configs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('config', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'databaseCount': 1, + 'cacheCount': 1, + 'missingInCacheCount': 0, + 'orphanInCacheCount': 0, + 'mismatchCount': 0, + 'missingInCache': [], + 'orphanInCache': [], + 'mismatchKeys': [], + } + ) + if arguments[0:2] == ('config', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configType': 'Y', + 'configValue': 'ShiErFeng', + } + ] + }, + } + ) + return SimpleNamespace(payload={'ok': False, 'message': 'unexpected'}) + + monkeypatch.setattr(configs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev', query='site') + + assert snapshot.title == '参数配置' + assert snapshot.search is not None + assert snapshot.search.query == 'site' + assert snapshot.records + assert snapshot.records[0].title == 'site_name' + + +def test_collect_configs_page_snapshot_builds_browser_records( + monkeypatch: MonkeyPatch, + configs_adapter: ModuleType, +) -> None: + calls: list[tuple[str, ...]] = [] + + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + calls.append(arguments) + if arguments[0:2] == ('config', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'databaseCount': 3, + 'cacheCount': 3, + 'missingInCacheCount': 0, + 'orphanInCacheCount': 0, + 'mismatchCount': 1, + 'mismatchKeys': ['site_name'], + } + ) + if arguments[0:2] == ('config', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configType': 'Y', + 'configValue': 'ShiErFeng', + } + ] + }, + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'key': 'site_name', + 'source': 'both', + 'inSync': False, + 'database': { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configValue': 'ShiErFeng', + 'configType': 'Y', + 'remark': '数据库值', + }, + 'cache': { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configValue': 'ShiErFeng-Cache', + 'configType': 'Y', + 'remark': '缓存值', + }, + } + ) + + monkeypatch.setattr(configs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '参数配置' + assert ( + snapshot.subtitle + == '聚焦:高风险配置 / 值不一致 / 缓存漂移 | 当前筛选:全部,已匹配 1 项配置,值不一致 1 项,缓存漂移 0 项' + ) + assert snapshot.active_filter_key == 'all' + assert [option.key for option in snapshot.filters] == ['all', 'risky', 'mismatch', 'cache-drift'] + assert len(snapshot.records) == 1 + assert snapshot.records[0].title == 'site_name' + assert snapshot.records[0].status == 'fail' + detail_sections = snapshot.records[0].resolve_detail_sections() + assert [section.title for section in detail_sections] == ['同步状态', '数据库配置', '缓存配置'] + assert any('数据库与缓存一致: 否' in line for line in detail_sections[0].lines) + assert any('键值: ShiErFeng' in line for line in detail_sections[1].lines) + assert any('键值: ShiErFeng-Cache' in line for line in detail_sections[2].lines) + assert snapshot.shared_sections[0].title == '总览判断' + assert any('值不一致: 1 项' in line for line in snapshot.shared_sections[0].lines) + assert snapshot.shared_sections[1].title == '配置巡检' + assert snapshot.shared_sections[2].title == '高风险配置' + assert snapshot.shared_sections[3].title == '异常样本' + assert snapshot.shared_sections[4].title == '配置变更入口' + assert any('config set site_name ShiErFeng --output=text' in line for line in snapshot.shared_sections[4].lines) + assert any(call[0:2] == ('config', 'get') for call in calls) + + +def test_collect_configs_page_snapshot_sorts_and_filters_risky_records( + monkeypatch: MonkeyPatch, + configs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('config', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'databaseCount': 3, + 'cacheCount': 3, + 'missingInCacheCount': 1, + 'orphanInCacheCount': 1, + 'mismatchCount': 1, + 'missingInCache': ['upload_mode'], + 'orphanInCache': ['legacy_toggle'], + 'mismatchKeys': ['site_name'], + } + ) + if arguments[0:2] == ('config', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'configId': 2, + 'configKey': 'upload_mode', + 'configName': '上传模式', + 'configType': 'N', + 'configValue': 'local', + }, + { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configType': 'Y', + 'configValue': 'ShiErFeng', + }, + { + 'configId': 3, + 'configKey': 'normal_timeout', + 'configName': '会话超时', + 'configType': 'N', + 'configValue': '30m', + }, + ] + }, + } + ) + return SimpleNamespace(payload={'ok': True, 'key': '-', 'source': 'both', 'inSync': True}) + + monkeypatch.setattr(configs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + all_snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev') + risky_snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev', filter_key='risky') + mismatch_snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev', filter_key='mismatch') + cache_drift_snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev', filter_key='cache-drift') + + assert [record.title for record in all_snapshot.records] == [ + 'site_name', + 'upload_mode', + 'legacy_toggle', + 'normal_timeout', + ] + assert [record.status for record in all_snapshot.records] == ['fail', 'warn', 'warn', 'ok'] + assert any('[值不一致] site_name' in line for line in all_snapshot.shared_sections[2].lines) + assert any('[缓存缺失] upload_mode' in line for line in all_snapshot.shared_sections[2].lines) + assert any('[缓存孤立] legacy_toggle' in line for line in all_snapshot.shared_sections[2].lines) + + assert risky_snapshot.active_filter_key == 'risky' + assert [record.title for record in risky_snapshot.records] == ['site_name', 'upload_mode', 'legacy_toggle'] + assert [record.title for record in mismatch_snapshot.records] == ['site_name'] + assert [record.title for record in cache_drift_snapshot.records] == ['upload_mode', 'legacy_toggle'] + + +def test_collect_configs_page_snapshot_applies_query_filter( + monkeypatch: MonkeyPatch, + configs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('config', 'doctor'): + return SimpleNamespace( + payload={ + 'ok': True, + 'databaseCount': 2, + 'cacheCount': 2, + 'missingInCacheCount': 0, + 'orphanInCacheCount': 0, + 'mismatchCount': 0, + 'missingInCache': [], + 'orphanInCache': [], + 'mismatchKeys': [], + } + ) + if arguments[0:2] == ('config', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'configId': 1, + 'configKey': 'site_name', + 'configName': '站点名称', + 'configType': 'Y', + 'configValue': 'ShiErFeng', + }, + { + 'configId': 2, + 'configKey': 'upload_mode', + 'configName': '上传模式', + 'configType': 'N', + 'configValue': 'local', + }, + ] + }, + } + ) + return SimpleNamespace(payload={'ok': True, 'key': '-', 'source': 'both', 'inSync': True}) + + monkeypatch.setattr(configs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = configs_adapter.CONFIGS_BROWSER_ADAPTER.collect_snapshot('dev', query='site') + + assert [record.title for record in snapshot.records] == ['site_name'] + assert snapshot.search is not None + assert snapshot.search.query == 'site' diff --git a/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_jobs_gen_snapshots.py b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_jobs_gen_snapshots.py new file mode 100644 index 0000000..6e16a64 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/adapters/test_jobs_gen_snapshots.py @@ -0,0 +1,439 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_collect_jobs_page_snapshot_links_first_job_detail_and_logs( + monkeypatch: MonkeyPatch, + jobs_adapter: ModuleType, +) -> None: + calls: list[tuple[str, ...]] = [] + + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + calls.append(arguments) + if arguments[0:2] == ('job', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobId': 101, + 'jobName': '同步任务', + 'status': '0', + 'cronExpression': '0/30 * * * * ?', + } + ] + }, + } + ) + if arguments[0:2] == ('job', 'detail'): + return SimpleNamespace( + payload={ + 'ok': True, + 'job': { + 'jobId': 101, + 'jobName': '同步任务', + 'jobGroup': 'DEFAULT', + 'status': '0', + 'cronExpression': '0/30 * * * * ?', + 'invokeTarget': 'demo.sync', + }, + } + ) + if arguments[0:2] == ('job', 'logs') and '--status=1' in arguments: + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobLogId': 2, + 'jobName': '同步任务', + 'status': '1', + 'jobMessage': '执行失败', + 'exceptionInfo': 'traceback...', + 'createTime': '2026-04-30 10:01:00', + } + ] + }, + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobLogId': 1, + 'jobName': '同步任务', + 'status': '0', + 'jobMessage': '执行成功', + 'createTime': '2026-04-30 10:00:00', + } + ] + }, + } + ) + + monkeypatch.setattr(jobs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = jobs_adapter.JOBS_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '任务' + assert ( + snapshot.subtitle + == '聚焦:失败聚合 / 暂停任务 / 执行轨迹 | 当前筛选:全部,已匹配 1 条任务,失败任务 1 个,暂停任务 0 个' + ) + assert len(snapshot.records) == 1 + assert snapshot.records[0].title == '同步任务' + assert snapshot.shared_sections[0].title == '总览判断' + assert any('存在失败任务' in line for line in snapshot.shared_sections[0].lines) + assert any('失败任务: 1 个' in line for line in snapshot.shared_sections[0].lines) + assert snapshot.shared_sections[1].title == '失败聚合' + assert any('失败日志: 1 条' in line for line in snapshot.shared_sections[1].lines) + assert any('同步任务 · 1 次' in line for line in snapshot.shared_sections[1].lines) + detail_sections = snapshot.records[0].resolve_detail_sections() + assert [section.title for section in detail_sections] == [ + '任务摘要', + '调度配置', + '执行摘要', + '最近执行记录', + '失败执行记录', + ] + assert any('成功率信号:' in line for line in detail_sections[2].lines) + assert any('最近一次执行:' in line for line in detail_sections[2].lines) + assert any('执行轨道:' in line for line in detail_sections[2].lines) + assert any('轨道窗口:' in line for line in detail_sections[2].lines) + assert any('2026-04-30 10:00:00' in line for line in detail_sections[3].lines) + assert any('o 状态: 成功' in line for line in detail_sections[3].lines) + assert any('轨道: ├─采集 ├─执行 └─落盘' in line for line in detail_sections[3].lines) + assert any('轨迹: ●─●─◎' in line for line in detail_sections[3].lines) + assert any('异常: traceback...' in line for line in detail_sections[4].lines) + assert any(call[0:2] == ('job', 'detail') for call in calls) + assert any(call[0:2] == ('job', 'logs') and '--job-name=同步任务' in call for call in calls) + assert any(call[0:2] == ('job', 'logs') and '--status=1' in call for call in calls) + + +def test_collect_jobs_page_snapshot_applies_failed_filter( + monkeypatch: MonkeyPatch, + jobs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('job', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobId': 101, + 'jobName': '失败任务', + 'status': '0', + 'cronExpression': '0/30 * * * * ?', + }, + { + 'jobId': 102, + 'jobName': '暂停任务', + 'status': '1', + 'cronExpression': '0/45 * * * * ?', + }, + { + 'jobId': 103, + 'jobName': '正常任务', + 'status': '0', + 'cronExpression': '0/50 * * * * ?', + }, + ] + }, + } + ) + if arguments[0:2] == ('job', 'logs') and '--status=1' in arguments: + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobLogId': 2, + 'jobName': '失败任务', + 'status': '1', + 'jobMessage': '执行失败', + 'createTime': '2026-04-30 10:01:00', + } + ] + }, + } + ) + return SimpleNamespace(payload={'ok': True, 'page': {'rows': []}}) + + monkeypatch.setattr(jobs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = jobs_adapter.JOBS_BROWSER_ADAPTER.collect_snapshot('dev', filter_key='failed') + + assert snapshot.active_filter_key == 'failed' + assert [option.key for option in snapshot.filters] == ['all', 'failed', 'paused', 'ok'] + assert len(snapshot.records) == 1 + assert snapshot.records[0].title == '失败任务' + assert '当前筛选:失败' in snapshot.subtitle + assert snapshot.shared_sections[0].title == '总览判断' + assert any('当前筛选: 失败' in line for line in snapshot.shared_sections[0].lines) + assert snapshot.shared_sections[1].title == '失败聚合' + assert any('涉及任务: 1 个' in line for line in snapshot.shared_sections[1].lines) + assert snapshot.search is not None + assert snapshot.search.placeholder == '按任务名搜索' + + +def test_collect_jobs_page_snapshot_applies_query_filter( + monkeypatch: MonkeyPatch, + jobs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('job', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'jobId': 1, + 'jobName': 'sync-user', + 'jobGroup': 'default', + 'status': '0', + 'cronExpression': '*', + }, + { + 'jobId': 2, + 'jobName': 'clean-cache', + 'jobGroup': 'ops', + 'status': '0', + 'cronExpression': '*', + }, + ] + }, + } + ) + return SimpleNamespace(payload={'ok': True, 'page': {'rows': []}}) + + monkeypatch.setattr(jobs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = jobs_adapter.JOBS_BROWSER_ADAPTER.collect_snapshot('dev', query='sync') + + assert [record.title for record in snapshot.records] == ['sync-user'] + assert snapshot.search is not None + assert snapshot.search.query == 'sync' + + +def test_collect_jobs_page_snapshot_surfaces_failure_message( + monkeypatch: MonkeyPatch, + jobs_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del arguments, parse_json + return SimpleNamespace( + payload={ + 'ok': False, + 'message': '读取定时任务列表失败', + 'error': 'database unavailable', + } + ) + + monkeypatch.setattr(jobs_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = jobs_adapter.JOBS_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.subtitle.startswith('任务数据不可用:') + assert snapshot.records[0].status == 'fail' + assert any('读取定时任务列表失败' in line for line in snapshot.records[0].detail_sections[0].lines) + + +def test_collect_gen_page_snapshot_links_first_table_detail( + monkeypatch: MonkeyPatch, + gen_adapter: ModuleType, +) -> None: + calls: list[tuple[str, ...]] = [] + + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + calls.append(arguments) + if arguments[0:2] == ('gen', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'tableId': 201, + 'tableName': 'sys_user', + 'className': 'SysUser', + 'moduleName': 'system', + } + ] + }, + } + ) + if arguments[0:2] == ('gen', 'detail'): + return SimpleNamespace( + payload={ + 'ok': True, + 'tableId': 201, + 'tableName': 'sys_user', + 'columnCount': 12, + 'detail': { + 'info': { + 'className': 'SysUser', + 'moduleName': 'system', + 'businessName': 'user', + 'functionName': '用户管理', + }, + 'rows': [ + { + 'columnName': 'user_id', + 'columnType': 'bigint', + 'isPk': '1', + 'isRequired': '1', + 'queryType': 'EQ', + } + ], + }, + } + ) + if arguments[0:2] == ('gen', 'preview'): + return SimpleNamespace( + payload={ + 'ok': True, + 'tableId': 201, + 'templateCount': 2, + 'preview': { + 'api.py.vm': 'def list_users():\n return []', + 'index.vue.vm': '', + }, + } + ) + if arguments[0:2] == ('gen', 'export'): + return SimpleNamespace( + payload={ + 'ok': True, + 'env': 'dev', + 'mode': 'zip', + 'dryRun': True, + 'message': '代码导出预演完成', + 'tableNames': ['sys_user'], + 'results': [ + { + 'tableName': 'sys_user', + 'ok': True, + 'message': '已生成 6 份模板预演结果', + } + ], + } + ) + if arguments[0:2] == ('gen', 'db-list') and '--table-name=sys_user' in arguments: + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'tableName': 'sys_user', + 'tableComment': '用户表', + } + ] + }, + } + ) + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'tableName': 'sys_role', + 'tableComment': '角色表', + } + ] + }, + } + ) + + monkeypatch.setattr(gen_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = gen_adapter.GEN_BROWSER_ADAPTER.collect_snapshot('dev') + + assert snapshot.title == '代码生成' + assert ( + snapshot.subtitle + == '聚焦:生成前校验 / 同步预检查 / 代码预览 | 当前已匹配 1 张业务表,可导入物理表 1 张,可继续查看表定义、预检查和代码预览' + ) + assert len(snapshot.records) == 1 + assert snapshot.records[0].title == 'sys_user' + detail_sections = snapshot.records[0].resolve_detail_sections() + assert [section.title for section in detail_sections] == [ + '业务表摘要', + '生成配置', + '字段摘要', + '生成前校验', + '同步预检查', + '字段列表', + '代码预览', + '导出预览', + '导出入口', + ] + assert any('模板预览: 2 份' in line for line in detail_sections[3].lines) + assert any('数据库物理表: sys_user' in line for line in detail_sections[4].lines) + assert any('模板数量: 2' in line for line in detail_sections[6].lines) + assert any('api.py.vm' in line for line in detail_sections[6].lines) + assert any('代码导出预演完成' in line for line in detail_sections[7].lines) + assert any('wizard gen-export' in line for line in detail_sections[8].lines) + assert snapshot.shared_sections[0].title == '总览判断' + assert any('可导入物理表: 1 张' in line for line in snapshot.shared_sections[0].lines) + assert any('代码预览 / 导出预览 / 导入入口 / 建表入口' in line for line in snapshot.shared_sections[0].lines) + assert snapshot.shared_sections[1].title == '可导入数据表' + assert snapshot.shared_sections[2].title == '导入入口' + assert any( + 'gen import-table sys_role --dry-run --output=text' in line for line in snapshot.shared_sections[2].lines + ) + assert snapshot.shared_sections[3].title == '建表入口' + assert any('gen create-table --dry-run --sql' in line for line in snapshot.shared_sections[3].lines) + assert any(call[0:2] == ('gen', 'detail') for call in calls) + assert any(call[0:2] == ('gen', 'preview') for call in calls) + assert any(call[0:2] == ('gen', 'export') and '--dry-run' in call for call in calls) + assert any(call[0:2] == ('gen', 'db-list') and '--table-name=sys_user' in call for call in calls) + + +def test_gen_browser_adapter_collect_snapshot_exposes_search_context( + monkeypatch: MonkeyPatch, + gen_adapter: ModuleType, +) -> None: + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('gen', 'list'): + return SimpleNamespace( + payload={ + 'ok': True, + 'page': { + 'rows': [ + { + 'tableId': 201, + 'tableName': 'sys_user', + 'className': 'SysUser', + 'moduleName': 'system', + } + ] + }, + } + ) + return SimpleNamespace(payload={'ok': True, 'page': {'rows': []}}) + + monkeypatch.setattr(gen_adapter.NESTED_CLI_SUPPORT, 'run', fake_run_nested_cli_command) + + snapshot = gen_adapter.GEN_BROWSER_ADAPTER.collect_snapshot('dev', query='sys') + + assert snapshot.title == '代码生成' + assert snapshot.search is not None + assert snapshot.search.query == 'sys' + assert snapshot.records + assert snapshot.records[0].title == 'sys_user' diff --git a/shierfeng-fastapi-backend/tests/cli/tui/conftest.py b/shierfeng-fastapi-backend/tests/cli/tui/conftest.py new file mode 100644 index 0000000..16c69b4 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/conftest.py @@ -0,0 +1,64 @@ +import importlib +import sys +from pathlib import Path +from types import SimpleNamespace + +import pytest + +BACKEND_DIR = Path(__file__).resolve().parents[3] + + +def _ensure_backend_on_path() -> None: + if str(BACKEND_DIR) not in sys.path: + sys.path.insert(0, str(BACKEND_DIR)) + + +@pytest.fixture +def tui_base_modules() -> SimpleNamespace: + _ensure_backend_on_path() + sys.modules.pop('cli.main', None) + sys.modules.pop('cli.tui.commands', None) + sys.modules.pop('cli', None) + + dependency_error = importlib.import_module('cli.exit_codes').DEPENDENCY_ERROR + cli_main = importlib.import_module('cli.main') + cli_tui_commands = importlib.import_module('cli.tui.commands') + + return SimpleNamespace( + BACKEND_DIR=BACKEND_DIR, + DEPENDENCY_ERROR=dependency_error, + cli_main=cli_main, + cli_tui_commands=cli_tui_commands, + ) + + +@pytest.fixture +def tui_modules(tui_base_modules: SimpleNamespace) -> SimpleNamespace: + pytest.importorskip('textual') + _ensure_backend_on_path() + for module_name in ( + 'cli.tui.app', + 'cli.tui.screens.browser', + 'cli.tui.copy', + 'cli.tui.screens.dashboard', + 'cli.tui.screens.detail', + 'cli.tui.screens.interactions', + 'cli.tui.adapters', + 'cli.tui.search', + 'cli.tui.widgets', + 'cli', + ): + sys.modules.pop(module_name, None) + + return SimpleNamespace( + **tui_base_modules.__dict__, + cli_tui_app=importlib.import_module('cli.tui.app'), + cli_tui_browser=importlib.import_module('cli.tui.screens.browser'), + cli_tui_copy=importlib.import_module('cli.tui.copy'), + cli_tui_dashboard=importlib.import_module('cli.tui.screens.dashboard'), + cli_tui_detail=importlib.import_module('cli.tui.screens.detail'), + cli_tui_interactions=importlib.import_module('cli.tui.screens.interactions'), + cli_tui_adapters=importlib.import_module('cli.tui.adapters'), + cli_tui_search=importlib.import_module('cli.tui.search'), + cli_tui_widgets=importlib.import_module('cli.tui.widgets'), + ) diff --git a/shierfeng-fastapi-backend/tests/cli/tui/test_tui_browser_screen.py b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_browser_screen.py new file mode 100644 index 0000000..a0e0258 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_browser_screen.py @@ -0,0 +1,575 @@ +from types import SimpleNamespace +from typing import Any + +import pytest +from pytest import MonkeyPatch + + +def test_browser_screen_builds_sections_from_selected_record(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='Jobs', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='Job A', + status='ok', + summary='summary a', + metadata_lines=[], + detail_sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='Job Detail', + status='ok', + lines=['detail a'], + ) + ], + ) + ], + shared_sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='Recent Logs', status='warn', lines=['log a']) + ], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + sections = screen._get_sections_for_record(0) + + assert [section.title for section in sections] == ['Job Detail', 'Recent Logs'] + + +def test_browser_screen_resolves_job_actions(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='Jobs', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='Job A', + status='ok', + summary='正常 · Cron 0/30 * * * * ?', + metadata_lines=[], + detail_sections=[], + ) + ], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + primary_action = screen._resolve_action('primary') + secondary_action = screen._resolve_action('secondary') + global_action = screen._resolve_action('global') + + assert primary_action is not None + assert primary_action.command_args == ('job', 'run-once', '1') + assert secondary_action is not None + assert secondary_action.command_args == ('job', 'pause', '1') + assert global_action is not None + assert global_action.command_args == ('job', 'sync') + + +def test_browser_screen_builds_action_panel_with_feedback(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='Jobs', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='Job A', + status='ok', + summary='正常 · Cron 0/30 * * * * ?', + metadata_lines=[], + detail_sections=[], + ) + ], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + screen._action_feedback_lines = ['动作名称: 执行一次任务', '结果: 成功'] + + lines = screen._build_record_action_lines(snapshot.records[0]) + + assert any('动作键 [X] · 执行一次任务' in line for line in lines) + assert any('浏览操作' in line for line in lines) + assert any('最近动作反馈' in line for line in lines) + assert any('结果: 成功' in line for line in lines) + + +@pytest.mark.asyncio +async def test_browser_screen_execute_external_action_suspends_app( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='代码生成', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='gen:201', + title='sys_user', + status='ok', + summary='生成类 SysUser · 模块 system', + metadata_lines=[], + detail_sections=[], + ) + ], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='gen', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + action = tui_modules.cli_tui_browser.TUI_ACTION_REGISTRY.resolve_browser_action( + view_key='gen', + slot='primary', + record=snapshot.records[0], + env='dev', + ) + assert action is not None + + recorded_suspend: list[str] = [] + + class DummySuspend: + def __enter__(self) -> None: + recorded_suspend.append('enter') + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: Any, + ) -> None: + del exc_type, exc, tb + recorded_suspend.append('exit') + + def build_suspend() -> DummySuspend: + return DummySuspend() + + def refresh_current_view() -> None: + pass + + fake_app = SimpleNamespace( + suspend=build_suspend, + action_refresh_current_view=refresh_current_view, + ) + monkeypatch.setattr(tui_modules.cli_tui_browser.BrowserScreen, 'app', property(lambda self: fake_app)) + monkeypatch.setattr( + tui_modules.cli_tui_interactions, + 'TUI_ACTION_EXECUTION_SERVICE', + SimpleNamespace( + execute_external=lambda spec: tui_modules.cli_tui_browser.TuiActionResult( + spec=spec, + external_exit_code=0, + external_message='外部交互命令已执行完成', + ), + build_result_lines=lambda result: [], + ), + ) + monkeypatch.setattr(screen, 'notify', lambda *args, **kwargs: None) + + async def fake_render_record_detail(*, eager: bool = False) -> None: + del eager + + monkeypatch.setattr(screen, '_render_record_detail', fake_render_record_detail) + + await screen._execute_action(action) + + assert recorded_suspend == ['enter', 'exit'] + + +def test_browser_screen_filter_shortcut_remembers_and_refreshes( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='Job A', + status='ok', + summary='正常 · Cron 0/30 * * * * ?', + metadata_lines=[], + detail_sections=[], + ) + ], + shared_sections=[], + filters=list(tui_modules.cli_tui_search.JOB_FILTER_OPTIONS), + active_filter_key='all', + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_filters: list[tuple[str, str]] = [] + refresh_calls: list[str] = [] + fake_app = SimpleNamespace( + remember_browser_filter=lambda view_key, filter_key: recorded_filters.append((view_key, filter_key)), + action_refresh_current_view=lambda: refresh_calls.append('refresh'), + ) + monkeypatch.setattr(tui_modules.cli_tui_browser.BrowserScreen, 'app', property(lambda self: fake_app)) + + screen.action_apply_filter_2() + + assert recorded_filters == [('jobs', 'failed')] + assert refresh_calls == ['refresh'] + + +@pytest.mark.asyncio +async def test_browser_screen_detail_loader_failure_falls_back_to_failure_section( + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='任务一', + status='warn', + summary='摘要', + metadata_lines=[], + detail_sections=[], + detail_loader=lambda: (_ for _ in ()).throw(RuntimeError('boom')), + ) + ], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + rendered_calls: list[bool] = [] + + async def fake_render_record_detail(*, eager: bool = False) -> None: + del eager + rendered_calls.append(True) + + screen._render_record_detail = fake_render_record_detail # type: ignore[method-assign] + screen._record_detail_request_id = 1 + + await screen._load_record_detail_async(0, 1) + + cached_sections = snapshot.records[0]._cached_detail_sections + + assert rendered_calls == [True] + assert cached_sections is not None + assert len(cached_sections) == 1 + assert cached_sections[0].status == 'fail' + assert cached_sections[0].title == '任务详情加载失败' + assert any('boom' in line for line in cached_sections[0].lines) + + +def test_browser_screen_search_submit_remembers_and_refreshes( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=list(tui_modules.cli_tui_search.JOB_FILTER_OPTIONS), + active_filter_key='all', + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按任务名搜索', + query='', + suggestions=['sync-user'], + ), + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_queries: list[tuple[str, str]] = [] + refresh_calls: list[str] = [] + fake_app = SimpleNamespace( + remember_browser_query=lambda view_key, query: recorded_queries.append((view_key, query)), + action_refresh_current_view=lambda: refresh_calls.append('refresh'), + ) + monkeypatch.setattr(tui_modules.cli_tui_browser.BrowserScreen, 'app', property(lambda self: fake_app)) + + screen._handle_search_submitted('sync') + + assert recorded_queries == [('jobs', 'sync')] + assert refresh_calls == ['refresh'] + + +def test_browser_screen_support_builds_summary_actions_and_fallbacks( + tui_modules: SimpleNamespace, +) -> None: + support = tui_modules.cli_tui_browser.BrowserScreenSupport() + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='Job A', + status='ok', + summary='正常 · Cron 0/30 * * * * ?', + metadata_lines=[], + detail_sections=[], + ) + ], + shared_sections=[], + filters=list(tui_modules.cli_tui_search.JOB_FILTER_OPTIONS), + active_filter_key='all', + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按任务名搜索', + query='sync', + suggestions=['sync-user'], + ), + ) + + summary = support.build_summary_text(snapshot, 'jobs') + filter_bar = support.build_filter_bar_text(snapshot) + action = support.resolve_action(active_view='jobs', slot='primary', record=snapshot.records[0], env='dev') + action_lines = support.build_record_action_lines( + active_view='jobs', + record=snapshot.records[0], + env='dev', + feedback_lines=['结果: 成功'], + ) + empty_record = support.build_empty_record() + loading_section = support.build_loading_section() + failure_sections = support.build_detail_load_failure_sections(RuntimeError('boom'), '任务详情') + empty_section = support.build_empty_section() + + assert '当前页共 1 条记录' in summary + assert '当前搜索 · sync' in filter_bar + assert action is not None + assert action.command_args == ('job', 'run-once', '1') + assert any('结果: 成功' in line for line in action_lines) + assert empty_record.title == tui_modules.cli_tui_copy.TUI_COPY.build_browser_empty_record_copy('title') + assert loading_section.title == tui_modules.cli_tui_copy.TUI_COPY.build_browser_loading_copy('title') + assert failure_sections[0].status == 'fail' + assert failure_sections[0].title == '任务详情加载失败' + assert empty_section.title == tui_modules.cli_tui_copy.TUI_COPY.build_detail_empty_section_copy('title') + + +def test_browser_screen_focus_service_moves_and_scrolls_between_focus_targets( + tui_modules: SimpleNamespace, +) -> None: + focus_service = tui_modules.cli_tui_browser.BrowserScreenFocusService() + focused: list[str] = [] + sidebar = SimpleNamespace(focus=lambda: focused.append('sidebar')) + navigator = SimpleNamespace(focus=lambda: focused.append('records')) + sections = SimpleNamespace(focus=lambda: focused.append('sections')) + summary = SimpleNamespace(focus=lambda: focused.append('summary')) + detail = SimpleNamespace(focus=lambda: focused.append('detail')) + workspace_main = object() + fake_app = SimpleNamespace(focused=None) + fake_screen = SimpleNamespace( + app=fake_app, + query_one=lambda selector, widget_type=None: { + tui_modules.cli_tui_widgets.WorkspaceSidebar: sidebar, + tui_modules.cli_tui_widgets.RecordNavigator: navigator, + tui_modules.cli_tui_widgets.SectionNavigator: sections, + tui_modules.cli_tui_widgets.RecordSummaryView: summary, + tui_modules.cli_tui_widgets.SectionDetailView: detail, + '#workspace-main': workspace_main, + }[selector], + ) + + focus_service.move_focus(fake_screen, 1) + fake_app.focused = navigator + focus_service.move_focus(fake_screen, 1) + fake_app.focused = object() + scroll_target = focus_service.get_scroll_target(fake_screen) + + assert focused == ['sidebar', 'sections'] + assert scroll_target is workspace_main + + +def test_browser_screen_clear_search_remembers_empty_and_refreshes( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=list(tui_modules.cli_tui_search.JOB_FILTER_OPTIONS), + active_filter_key='all', + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按任务名搜索', + query='sync', + suggestions=['sync-user'], + ), + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_queries: list[tuple[str, str]] = [] + refresh_calls: list[str] = [] + fake_app = SimpleNamespace( + remember_browser_query=lambda view_key, query: recorded_queries.append((view_key, query)), + action_refresh_current_view=lambda: refresh_calls.append('refresh'), + ) + monkeypatch.setattr(tui_modules.cli_tui_browser.BrowserScreen, 'app', property(lambda self: fake_app)) + + screen.action_clear_search() + + assert recorded_queries == [('jobs', '')] + assert refresh_calls == ['refresh'] + + +def test_browser_screen_unmount_cancels_background_tasks(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='缓存', + subtitle='subtitle', + records=[], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='cache', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + cancelled: list[str] = [] + + class DummyTask: + def __init__(self, name: str) -> None: + self.name = name + + def done(self) -> bool: + return False + + def cancel(self) -> None: + cancelled.append(self.name) + + screen._record_detail_task = DummyTask('detail') # type: ignore[assignment] + screen._action_task = DummyTask('action') # type: ignore[assignment] + request_id = screen._record_detail_request_id + + screen.on_unmount() + + assert cancelled == ['detail', 'action'] + assert screen._record_detail_request_id == request_id + 1 + + +def test_browser_screen_failure_sections_use_current_snapshot_title(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='缓存', + subtitle='subtitle', + records=[], + shared_sections=[], + ) + screen = tui_modules.cli_tui_browser.BrowserScreen( + snapshot, + env='dev', + active_view='cache', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + sections = screen._build_detail_load_failure_sections(RuntimeError('boom')) + + assert sections[0].title == '缓存详情加载失败' + + +@pytest.mark.asyncio +async def test_browser_screen_scrolls_in_small_viewport(tui_modules: SimpleNamespace) -> None: + thin_scrollbar_size = 1 + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.action_show_dashboard = lambda: None # type: ignore[method-assign] + app.current_view = 'jobs' + snapshot = tui_modules.cli_tui_adapters.BrowserPageSnapshot( + title='任务', + subtitle='超长浏览', + records=[ + tui_modules.cli_tui_adapters.BrowserRecordSnapshot( + key='job:1', + title='任务一', + status='warn', + summary='摘要很长 摘要很长 摘要很长', + metadata_lines=[f'字段{i}: 值很长 值很长 值很长' for i in range(1, 18)], + detail_sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='明细分区', + status='warn', + lines=[f'明细{i}: 说明很长 说明很长 说明很长' for i in range(1, 30)], + ) + ], + ) + for _ in range(6) + ], + shared_sections=[], + ) + screen = app.screen_factory.build( + snapshot=snapshot, + env=app.env, + active_view=app.current_view, + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + action_feedback_lines=app.get_action_feedback_lines(app.current_view), + ) + + async with app.run_test(size=(80, 24)) as pilot: + app.screen_navigator.show(screen) + await pilot.pause() + await pilot.pause() + + main = app.screen.query_one('#workspace-main') + browser_body = app.screen.query_one('#browser-body') + browser_detail_pane = app.screen.query_one('#browser-detail-pane') + record_navigator = app.screen.query_one(tui_modules.cli_tui_widgets.RecordNavigator) + record_summary = app.screen.query_one(tui_modules.cli_tui_widgets.RecordSummaryView) + section_detail = app.screen.query_one(tui_modules.cli_tui_widgets.SectionDetailView) + + assert main.styles.scrollbar_size_vertical == thin_scrollbar_size + assert main.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert main.virtual_size.height > main.size.height + assert browser_body.styles.scrollbar_size_vertical == thin_scrollbar_size + assert browser_body.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert browser_body.virtual_size.width > browser_body.size.width + assert browser_detail_pane.styles.scrollbar_size_vertical == thin_scrollbar_size + assert browser_detail_pane.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert browser_detail_pane.virtual_size.height > browser_detail_pane.size.height + assert record_navigator.styles.scrollbar_size_vertical == thin_scrollbar_size + assert record_navigator.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert record_summary.styles.scrollbar_size_vertical == thin_scrollbar_size + assert record_summary.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert section_detail.styles.scrollbar_size_vertical == thin_scrollbar_size + assert section_detail.styles.scrollbar_size_horizontal == thin_scrollbar_size diff --git a/shierfeng-fastapi-backend/tests/cli/tui/test_tui_command_app.py b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_command_app.py new file mode 100644 index 0000000..a0ca574 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_command_app.py @@ -0,0 +1,490 @@ +import importlib +from types import SimpleNamespace +from typing import Any + +import pytest +import typer +from pytest import MonkeyPatch +from typer.testing import CliRunner + + +def test_tui_command_returns_dependency_error_when_textual_missing( + monkeypatch: MonkeyPatch, + tui_base_modules: SimpleNamespace, +) -> None: + runner = CliRunner() + monkeypatch.chdir(tui_base_modules.BACKEND_DIR) + + def raise_missing_textual(module_name: str) -> Any: + if module_name == 'cli.tui.app': + raise ModuleNotFoundError("No module named 'textual'", name='textual') + return importlib.import_module(module_name) + + monkeypatch.setattr(tui_base_modules.cli_tui_commands, 'import_module', raise_missing_textual) + isolated_cli = typer.Typer() + tui_base_modules.cli_tui_commands.TUI_COMMAND_REGISTRATION.register(isolated_cli) + + result = runner.invoke(isolated_cli, ['tui', '--env=dev']) + + assert result.exit_code == tui_base_modules.DEPENDENCY_ERROR + assert '当前环境未安装 TUI 可选依赖' in result.stdout + assert 'pip install -r requirements.txt' in result.stdout + + +def test_tui_app_mount_pushes_first_workspace_screen( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + recorded_calls: list[tuple[str, object]] = [] + + class FakeDashboardScreen: + def __init__( + self, + snapshot: object, + env: str, + active_view: str, + navigation_items: list[object], + refreshed_at: str, + ) -> None: + self.snapshot = snapshot + self.env = env + self.active_view = active_view + self.navigation_items = navigation_items + self.refreshed_at = refreshed_at + + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'dashboard', + lambda env: tui_modules.cli_tui_app.DashboardSnapshot(env=env, panels=[]), + ) + monkeypatch.setattr(tui_modules.cli_tui_app, 'DashboardScreen', FakeDashboardScreen) + + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + monkeypatch.setattr(app, 'push_screen', lambda screen: recorded_calls.append(('push', screen))) + monkeypatch.setattr(app, 'switch_screen', lambda screen: recorded_calls.append(('switch', screen))) + + app.on_mount() + + assert recorded_calls + assert recorded_calls[0][0] == 'push' + assert isinstance(recorded_calls[0][1], FakeDashboardScreen) + assert recorded_calls[0][1].env == 'dev' + assert recorded_calls[0][1].active_view == 'dashboard' + assert recorded_calls[0][1].navigation_items + assert recorded_calls[0][1].refreshed_at + assert app.current_view == 'dashboard' + assert app.screen_navigator.initialized is True + + +def test_open_view_switches_to_expected_action(tui_modules: SimpleNamespace) -> None: + calls: list[str] = [] + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + + def fake_show_view(view_key: str) -> None: + calls.append(tui_modules.cli_tui_app.TUI_VIEW_REGISTRY.resolve_view_key(view_key)) + + app.show_view = fake_show_view # type: ignore[method-assign] + + app.open_view('jobs') + app.open_view('app') + app.open_view('ops') + app.open_view('crypto') + app.open_view('unknown') + + assert calls == ['jobs', 'app', 'ops', 'crypto', 'dashboard'] + + +def test_workspace_header_render_includes_particle_line(tui_modules: SimpleNamespace) -> None: + header = tui_modules.cli_tui_widgets.WorkspaceHeader('dev', 'dashboard') + + rendered = header.render() + rendered_text = rendered.plain + + assert rendered.__class__.__name__ == 'Text' + assert 'ShiErFeng 控制台' in rendered_text + assert '环境 DEV · 页面 总览' in rendered_text + assert any(symbol in rendered_text for symbol in ('█', '▓', '▒', '░', '·', '─')) + + +def test_workspace_header_centers_title_using_runtime_width(tui_modules: SimpleNamespace) -> None: + header = tui_modules.cli_tui_widgets.WorkspaceHeader('dev', 'dashboard') + header.styles.width = 140 + + first_line = header.render().plain.splitlines()[0] + + assert first_line.startswith(' ') + assert 'ShiErFeng 控制台' in first_line + + +def test_workspace_header_keeps_title_alignment_stable_across_frames( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + header = tui_modules.cli_tui_widgets.WorkspaceHeader('dev', 'dashboard') + monotonic_values = iter([10.0, 10.0, 11.0, 11.0]) + workspace_module = importlib.import_module('cli.tui.widgets.workspace') + monkeypatch.setattr(workspace_module, 'monotonic', lambda: next(monotonic_values)) + + first_line_a = header.render().plain.splitlines()[0] + first_line_b = header.render().plain.splitlines()[0] + + assert first_line_a.index('ShiErFeng 控制台') == first_line_b.index('ShiErFeng 控制台') + + +def test_workspace_hero_pulses_border_with_expected_palette( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + hero = tui_modules.cli_tui_widgets.WorkspaceHero( + title='标题', + subtitle='副标题', + env='dev', + active_view='dashboard', + summary='摘要', + refreshed_at='2026-05-12 12:00:00', + ) + workspace_module = importlib.import_module('cli.tui.widgets.workspace') + monkeypatch.setattr(workspace_module, 'monotonic', lambda: 10.0) + original_border_text = str(hero.styles.border) + + hero._pulse_border() + + border_text = str(hero.styles.border) + + assert 'double' in border_text + assert border_text != original_border_text + + +def test_workspace_hero_render_uses_rich_text_for_title_glow(tui_modules: SimpleNamespace) -> None: + hero = tui_modules.cli_tui_widgets.WorkspaceHero( + title='标题', + subtitle='副标题', + env='dev', + active_view='dashboard', + summary='摘要', + refreshed_at='2026-05-12 12:00:00', + ) + + rendered = hero._build_render_text() + + assert rendered.__class__.__name__ == 'Text' + assert '标题' in rendered.plain + assert '副标题' in rendered.plain + assert '运行摘要 · 摘要' in rendered.plain + + +def test_tui_app_runner_runs_created_application(tui_modules: SimpleNamespace) -> None: + recorded_envs: list[str] = [] + recorded_runs: list[str] = [] + + class FakeApp: + def __init__(self, env: str) -> None: + recorded_envs.append(env) + + def run(self) -> None: + recorded_runs.append('run') + + runner = tui_modules.cli_tui_app.TuiAppRunner(FakeApp) + + runner.run('dev') + + assert recorded_envs == ['dev'] + assert recorded_runs == ['run'] + + +def test_tui_app_show_jobs_uses_remembered_filter( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + recorded_filter_keys: list[tuple[str, str]] = [] + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.remember_browser_filter('jobs', 'failed') + app.remember_browser_query('jobs', 'sync') + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'jobs', + lambda env, filter_key='all', query='': ( + recorded_filter_keys.append((filter_key, query)) + or tui_modules.cli_tui_app.BrowserPageSnapshot( + title='任务', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=[], + active_filter_key=filter_key, + search=None, + ) + ), + ) + monkeypatch.setattr(app.screen_navigator, 'show', lambda screen: None) + app.action_show_jobs() + + assert recorded_filter_keys == [('failed', 'sync')] + + +def test_tui_app_show_configs_uses_remembered_filter( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + recorded_filter_keys: list[tuple[str, str]] = [] + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.remember_browser_filter('configs', 'cache-drift') + app.remember_browser_query('configs', 'site') + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'configs', + lambda env, filter_key='all', query='': ( + recorded_filter_keys.append((filter_key, query)) + or tui_modules.cli_tui_app.BrowserPageSnapshot( + title='参数配置', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=[], + active_filter_key=filter_key, + search=None, + ) + ), + ) + monkeypatch.setattr(app.screen_navigator, 'show', lambda screen: None) + app.action_show_configs() + + assert recorded_filter_keys == [('cache-drift', 'site')] + + +def test_tui_app_show_cache_and_gen_use_remembered_query( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + cache_queries: list[str] = [] + gen_queries: list[str] = [] + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.remember_browser_query('cache', 'sys') + app.remember_browser_query('gen', 'user') + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'cache', + lambda env, query='': ( + cache_queries.append(query) + or tui_modules.cli_tui_app.BrowserPageSnapshot( + title='缓存', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=[], + active_filter_key=None, + search=None, + ) + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'gen', + lambda env, query='': ( + gen_queries.append(query) + or tui_modules.cli_tui_app.BrowserPageSnapshot( + title='代码生成', + subtitle='subtitle', + records=[], + shared_sections=[], + filters=[], + active_filter_key=None, + search=None, + ) + ), + ) + monkeypatch.setattr(app.screen_navigator, 'show', lambda screen: None) + app.action_show_cache() + app.action_show_gen() + + assert cache_queries == ['sys'] + assert gen_queries == ['user'] + + +def test_tui_app_detail_views_use_remembered_query( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + database_queries: list[str] = [] + app_queries: list[str] = [] + ops_queries: list[str] = [] + crypto_queries: list[str] = [] + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.remember_browser_query('database', 'head') + app.remember_browser_query('app', 'route') + app.remember_browser_query('ops', 'disk') + app.remember_browser_query('crypto', 'kid') + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'database', + lambda env, query='': ( + database_queries.append(query) + or tui_modules.cli_tui_app.DetailPageSnapshot(title='数据库', subtitle='subtitle', sections=[]) + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'app', + lambda env, query='': ( + app_queries.append(query) + or tui_modules.cli_tui_app.DetailPageSnapshot(title='应用', subtitle='subtitle', sections=[]) + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'ops', + lambda env, query='': ( + ops_queries.append(query) + or tui_modules.cli_tui_app.DetailPageSnapshot(title='运维', subtitle='subtitle', sections=[]) + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'crypto', + lambda env, query='': ( + crypto_queries.append(query) + or tui_modules.cli_tui_app.DetailPageSnapshot(title='传输加密', subtitle='subtitle', sections=[]) + ), + ) + monkeypatch.setattr(app.screen_navigator, 'show', lambda screen: None) + app.action_show_database() + app.action_show_app() + app.action_show_ops() + app.action_show_crypto() + + assert database_queries == ['head'] + assert app_queries == ['route'] + assert ops_queries == ['disk'] + assert crypto_queries == ['kid'] + + +@pytest.mark.asyncio +async def test_tui_app_open_view_updates_screen_across_multiple_switches( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'dashboard', + lambda env: tui_modules.cli_tui_app.DashboardSnapshot(env=env, panels=[]), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'app', + lambda env, query='': tui_modules.cli_tui_app.DetailPageSnapshot( + title='应用详情', + subtitle=query or 'app-subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='应用分区', + status='ok', + lines=['app-line'], + ) + ], + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'ops', + lambda env, query='': tui_modules.cli_tui_app.DetailPageSnapshot( + title='运维详情', + subtitle=query or 'ops-subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='运维分区', + status='warn', + lines=['ops-line'], + ) + ], + ), + ) + + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + async with app.run_test(size=(120, 40)) as pilot: + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DashboardScreen' + assert app.current_view == 'dashboard' + + app.open_view('app') + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DetailScreen' + assert app.current_view == 'app' + assert app.screen.snapshot.title == '应用详情' + + app.open_view('ops') + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DetailScreen' + assert app.current_view == 'ops' + assert app.screen.snapshot.title == '运维详情' + + +@pytest.mark.asyncio +async def test_tui_sidebar_highlight_updates_screen_across_multiple_switches( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'dashboard', + lambda env: tui_modules.cli_tui_app.DashboardSnapshot(env=env, panels=[]), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'app', + lambda env, query='': tui_modules.cli_tui_app.DetailPageSnapshot( + title='应用详情', + subtitle='app-subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='应用分区', + status='ok', + lines=['app-line'], + ) + ], + ), + ) + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, + 'ops', + lambda env, query='': tui_modules.cli_tui_app.DetailPageSnapshot( + title='运维详情', + subtitle='ops-subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='运维分区', + status='warn', + lines=['ops-line'], + ) + ], + ), + ) + + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + async with app.run_test(size=(120, 40)) as pilot: + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DashboardScreen' + assert app.current_view == 'dashboard' + + await pilot.press('down') + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DetailScreen' + assert app.current_view == 'app' + assert app.screen.snapshot.title == '应用详情' + + await pilot.press('down') + await pilot.pause() + await pilot.pause() + + assert type(app.screen).__name__ == 'DetailScreen' + assert app.current_view == 'ops' + assert app.screen.snapshot.title == '运维详情' diff --git a/shierfeng-fastapi-backend/tests/cli/tui/test_tui_dashboard_search.py b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_dashboard_search.py new file mode 100644 index 0000000..118bfb6 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_dashboard_search.py @@ -0,0 +1,192 @@ +from types import SimpleNamespace + +import pytest + + +def test_build_filter_bar_text_includes_search_context(tui_modules: SimpleNamespace) -> None: + text = tui_modules.cli_tui_search.TUI_SEARCH_SERVICE.build_filter_bar_text( + tui_modules.cli_tui_search.JOB_FILTER_OPTIONS, + 'failed', + search_query='sync', + search_placeholder='按任务名搜索', + search_suggestions=['sync-job', 'sync-user'], + ) + + assert '当前筛选 · 失败' in text + assert '搜索器 · [/] 按任务名搜索' in text + assert '当前搜索 · sync | [Backspace] 清空' in text + assert '候选建议 · sync-job sync-user' in text + + +def test_tui_search_service_builds_filter_context_and_section_filtering( + tui_modules: SimpleNamespace, +) -> None: + service = tui_modules.cli_tui_search.TuiSearchService( + tui_modules.cli_tui_search.TuiSearchSuggestionProviderRegistry( + providers={ + 'jobs': tui_modules.cli_tui_search.SearchSuggestionProviderSpec( + '按任务名搜索', + lambda incomplete: ['sync-user', 'sync-role', 'cleanup'], + ), + 'app': tui_modules.cli_tui_search.SearchSuggestionProviderSpec('按分区或内容搜索'), + } + ) + ) + + option = service.resolve_filter_option(tui_modules.cli_tui_search.JOB_FILTER_OPTIONS, 'failed') + filter_bar = service.build_filter_bar_text( + tui_modules.cli_tui_search.JOB_FILTER_OPTIONS, + 'failed', + search_query='sync', + search_placeholder='按任务名搜索', + search_suggestions=['sync-user', 'sync-role'], + ) + search_context = service.resolve_search_context('jobs', 'sync') + default_context = service.resolve_search_context('app', '总览', default_suggestions=['总览判断', '应用配置']) + sections = service.filter_detail_sections( + [ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='总览判断', status='ok', lines=['应用正常']), + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='路由摘要', status='warn', lines=['同步任务接口']), + ], + '同步', + ) + + assert option is not None + assert option.key == 'failed' + assert '当前筛选 · 失败' in filter_bar + assert search_context is not None + assert search_context.placeholder == '按任务名搜索' + assert search_context.suggestions[:2] == ['sync-user', 'sync-role'] + assert default_context is not None + assert default_context.suggestions == ['总览判断'] + assert [section.title for section in sections] == ['路由摘要'] + + +def test_tui_search_service_skips_provider_when_query_is_empty( + tui_modules: SimpleNamespace, +) -> None: + provider_calls: list[str] = [] + + def record_provider(incomplete: str) -> list[str]: + provider_calls.append(incomplete) + return ['site_name'] + + service = tui_modules.cli_tui_search.TuiSearchService( + tui_modules.cli_tui_search.TuiSearchSuggestionProviderRegistry( + providers={ + 'configs': tui_modules.cli_tui_search.SearchSuggestionProviderSpec( + '按配置键搜索', + record_provider, + ) + } + ) + ) + + search_context = service.resolve_search_context('configs', '') + + assert search_context is not None + assert search_context.placeholder == '按配置键搜索' + assert search_context.suggestions == [] + assert provider_calls == [] + + +def test_search_highlight_helper_wraps_matches(tui_modules: SimpleNamespace) -> None: + highlighted = tui_modules.cli_tui_search.TUI_SEARCH_HIGHLIGHTER.highlight('sync-user job', 'sync') + + assert highlighted == '【sync】-user job' + + +def test_dashboard_screen_support_builds_summary_signal_and_status_track( + tui_modules: SimpleNamespace, +) -> None: + support = tui_modules.cli_tui_dashboard.DashboardScreenSupport() + snapshot = tui_modules.cli_tui_app.DashboardSnapshot( + env='dev', + metrics=[], + panels=[ + tui_modules.cli_tui_adapters.DashboardPanelSnapshot(title='应用', status='ok', lines=['ok']), + tui_modules.cli_tui_adapters.DashboardPanelSnapshot(title='任务', status='warn', lines=['warn']), + tui_modules.cli_tui_adapters.DashboardPanelSnapshot(title='数据库', status='fail', lines=['fail']), + ], + ) + + summary = support.build_summary_text(snapshot) + status_track = support.build_status_track(snapshot) + signal_lines = support.build_signal_lines(snapshot) + + assert '共 3 个面板' in summary + assert status_track == 'o!x' + assert any('失败 01' in line for line in signal_lines) + + +def test_dashboard_screen_focus_service_moves_and_scrolls_between_focus_targets( + tui_modules: SimpleNamespace, +) -> None: + focus_service = tui_modules.cli_tui_dashboard.DashboardScreenFocusService() + focused: list[str] = [] + sidebar = SimpleNamespace(focus=lambda: focused.append('sidebar')) + workspace_main = SimpleNamespace(focus=lambda: focused.append('main')) + fake_app = SimpleNamespace(focused=None) + fake_screen = SimpleNamespace( + app=fake_app, + query_one=lambda selector, widget_type=None: { + tui_modules.cli_tui_widgets.WorkspaceSidebar: sidebar, + '#workspace-main': workspace_main, + }[selector], + ) + + focus_service.move_focus(fake_screen, 1) + fake_app.focused = sidebar + focus_service.move_focus(fake_screen, 1) + fake_app.focused = object() + scroll_target = focus_service.get_scroll_target(fake_screen) + + assert focused == ['sidebar', 'main'] + assert scroll_target is workspace_main + + +@pytest.mark.asyncio +async def test_dashboard_grid_expands_to_fit_status_panels( + monkeypatch: pytest.MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + expected_dashboard_panel_count = 8 + min_expanded_dashboard_grid_height = 20 + snapshot = tui_modules.cli_tui_app.DashboardSnapshot( + env='dev', + metrics=[], + panels=[ + tui_modules.cli_tui_adapters.DashboardPanelSnapshot( + title=f'面板 {index + 1}', + status='ok' if index % 2 == 0 else 'warn', + lines=[ + '## 巡检摘要', + f'当前面板: {index + 1}', + '状态说明: 这里需要展示多行内容', + '', + '## 建议动作', + '进入对应分区继续查看详情', + ], + ) + for index in range(8) + ], + ) + + monkeypatch.setitem( + tui_modules.cli_tui_app.TUI_SNAPSHOT_COLLECTOR_REGISTRY.collectors, 'dashboard', lambda env: snapshot + ) + + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + async with app.run_test(size=(160, 60)) as pilot: + await pilot.pause() + await pilot.pause() + + grid = app.screen.query_one('#dashboard-grid') + panels = list( + app.screen.query(tui_modules.cli_tui_widgets.StatusPanel).results(tui_modules.cli_tui_widgets.StatusPanel) + ) + + assert len(panels) == expected_dashboard_panel_count + assert grid.virtual_size.height > min_expanded_dashboard_grid_height + assert all(panel.content_size.height > 0 for panel in panels) + assert len({panel.region.height for panel in panels}) == 1 diff --git a/shierfeng-fastapi-backend/tests/cli/tui/test_tui_detail_screen.py b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_detail_screen.py new file mode 100644 index 0000000..533d607 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/tui/test_tui_detail_screen.py @@ -0,0 +1,394 @@ +from types import SimpleNamespace +from typing import Any + +import pytest +from pytest import MonkeyPatch + + +def test_detail_screen_updates_section_detail_view(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='Jobs', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='Section A', status='ok', lines=['line a']), + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='Section B', status='warn', lines=['line b']), + ], + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='jobs', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_sections: list[object] = [] + + class FakeSectionDetailView: + def show_section(self, section: object, query: str = '') -> None: + del query + recorded_sections.append(section) + + screen.query_one = lambda widget_type: FakeSectionDetailView() # type: ignore[method-assign] + + screen._update_selected_section(1) + + assert screen.selected_section_index == 1 + assert recorded_sections + assert recorded_sections[0].title == 'Section B' + + +def test_detail_screen_search_submit_remembers_and_refreshes( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='数据库', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='历史版本', status='ok', lines=['line a']), + ], + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按 revision 搜索', + query='', + suggestions=['head', 'base'], + ), + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='database', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_queries: list[tuple[str, str]] = [] + refresh_calls: list[str] = [] + fake_app = SimpleNamespace( + remember_browser_query=lambda view_key, query: recorded_queries.append((view_key, query)), + action_refresh_current_view=lambda: refresh_calls.append('refresh'), + ) + monkeypatch.setattr(tui_modules.cli_tui_detail.DetailScreen, 'app', property(lambda self: fake_app)) + + screen._handle_search_submitted('head') + + assert recorded_queries == [('database', 'head')] + assert refresh_calls == ['refresh'] + + +def test_detail_screen_clear_search_remembers_empty_and_refreshes( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='数据库', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='历史版本', status='ok', lines=['line a']), + ], + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按 revision 搜索', + query='head', + suggestions=['head', 'base'], + ), + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='database', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + recorded_queries: list[tuple[str, str]] = [] + refresh_calls: list[str] = [] + fake_app = SimpleNamespace( + remember_browser_query=lambda view_key, query: recorded_queries.append((view_key, query)), + action_refresh_current_view=lambda: refresh_calls.append('refresh'), + ) + monkeypatch.setattr(tui_modules.cli_tui_detail.DetailScreen, 'app', property(lambda self: fake_app)) + + screen.action_clear_search() + + assert recorded_queries == [('database', '')] + assert refresh_calls == ['refresh'] + + +@pytest.mark.asyncio +async def test_detail_screen_execute_external_action_suspends_app( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='数据库', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='迁移版本', status='ok', lines=['line a']), + ], + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='database', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + action = tui_modules.cli_tui_detail.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='database', + slot='global', + env='dev', + ) + assert action is not None + + recorded_suspend: list[str] = [] + + class DummySuspend: + def __enter__(self) -> None: + recorded_suspend.append('enter') + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: Any, + ) -> None: + del exc_type, exc, tb + recorded_suspend.append('exit') + + def build_suspend() -> DummySuspend: + return DummySuspend() + + def refresh_current_view() -> None: + pass + + fake_app = SimpleNamespace( + suspend=build_suspend, + action_refresh_current_view=refresh_current_view, + ) + monkeypatch.setattr(tui_modules.cli_tui_detail.DetailScreen, 'app', property(lambda self: fake_app)) + monkeypatch.setattr( + tui_modules.cli_tui_interactions, + 'TUI_ACTION_EXECUTION_SERVICE', + SimpleNamespace( + execute_external=lambda spec: tui_modules.cli_tui_detail.TuiActionResult( + spec=spec, + external_exit_code=0, + external_message='外部交互命令已执行完成', + ), + build_result_lines=lambda result: [], + ), + ) + monkeypatch.setattr(screen, 'notify', lambda *args, **kwargs: None) + + await screen._execute_action(action) + + assert recorded_suspend == ['enter', 'exit'] + + +@pytest.mark.asyncio +async def test_detail_screen_execute_nested_json_action_without_suspend( + monkeypatch: MonkeyPatch, + tui_modules: SimpleNamespace, +) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='传输加密', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='运行校验', status='ok', lines=['line a']), + ], + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='crypto', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + action = tui_modules.cli_tui_detail.TUI_ACTION_REGISTRY.resolve_detail_action( + view_key='crypto', + slot='global', + env='dev', + ) + assert action is not None + assert action.execution_mode == 'nested_json' + + suspend_calls: list[str] = [] + execute_calls: list[tuple[object, str]] = [] + + class DummySuspend: + def __enter__(self) -> None: + suspend_calls.append('enter') + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc: BaseException | None, + tb: Any, + ) -> None: + del exc_type, exc, tb + suspend_calls.append('exit') + + def build_suspend() -> DummySuspend: + return DummySuspend() + + def refresh_current_view() -> None: + pass + + fake_app = SimpleNamespace( + suspend=build_suspend, + action_refresh_current_view=refresh_current_view, + ) + monkeypatch.setattr(tui_modules.cli_tui_detail.DetailScreen, 'app', property(lambda self: fake_app)) + monkeypatch.setattr( + tui_modules.cli_tui_interactions, + 'TUI_ACTION_EXECUTION_SERVICE', + SimpleNamespace( + execute=lambda spec, env: ( + execute_calls.append((spec, env)) + or tui_modules.cli_tui_detail.TuiActionResult( + spec=spec, + payload={'ok': True, 'message': '轮换预演完成'}, + ) + ), + build_result_lines=lambda result: [], + ), + ) + monkeypatch.setattr(screen, 'notify', lambda *args, **kwargs: None) + + await screen._execute_action(action) + + assert suspend_calls == [] + assert execute_calls == [(action, 'dev')] + + +def test_detail_screen_support_builds_summary_actions_and_fallbacks( + tui_modules: SimpleNamespace, +) -> None: + support = tui_modules.cli_tui_detail.DetailScreenSupport() + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='数据库', + subtitle='subtitle', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='迁移版本', status='ok', lines=['line a']), + tui_modules.cli_tui_adapters.DetailSectionSnapshot(title='Heads 状态', status='warn', lines=['line b']), + ], + search=tui_modules.cli_tui_search.PageSearchContext( + placeholder='按 revision 搜索', + query='head', + suggestions=['head'], + ), + ) + + summary = support.build_summary_text(snapshot, 'database') + query = support.current_search_query(snapshot) + action = support.resolve_action(active_view='database', slot='global', env='dev') + empty_section = support.build_empty_section() + + assert '2 个分区' in summary + assert query == 'head' + assert action is not None + assert action.command_args[:2] == ('wizard', 'db-upgrade') + assert empty_section.title == tui_modules.cli_tui_copy.TUI_COPY.build_detail_empty_section_copy('title') + + +def test_detail_screen_focus_service_moves_and_scrolls_between_focus_targets( + tui_modules: SimpleNamespace, +) -> None: + focus_service = tui_modules.cli_tui_detail.DetailScreenFocusService() + focused: list[str] = [] + sidebar = SimpleNamespace(focus=lambda: focused.append('sidebar')) + sections = SimpleNamespace(focus=lambda: focused.append('sections')) + detail = SimpleNamespace(focus=lambda: focused.append('detail')) + workspace_main = object() + fake_app = SimpleNamespace(focused=None) + fake_screen = SimpleNamespace( + app=fake_app, + query_one=lambda selector, widget_type=None: { + tui_modules.cli_tui_widgets.WorkspaceSidebar: sidebar, + tui_modules.cli_tui_widgets.SectionNavigator: sections, + tui_modules.cli_tui_widgets.SectionDetailView: detail, + '#workspace-main': workspace_main, + }[selector], + ) + + focus_service.move_focus(fake_screen, 1) + fake_app.focused = sections + focus_service.move_focus(fake_screen, 1) + fake_app.focused = object() + scroll_target = focus_service.get_scroll_target(fake_screen) + + assert focused == ['sidebar', 'detail'] + assert scroll_target is workspace_main + + +def test_detail_screen_unmount_cancels_action_task(tui_modules: SimpleNamespace) -> None: + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='数据库', + subtitle='subtitle', + sections=[], + ) + screen = tui_modules.cli_tui_detail.DetailScreen( + snapshot, + env='dev', + active_view='database', + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + refreshed_at='2026-04-30 10:00:00', + ) + + cancelled: list[str] = [] + + class DummyTask: + def done(self) -> bool: + return False + + def cancel(self) -> None: + cancelled.append('action') + + screen._action_task = DummyTask() # type: ignore[assignment] + + screen.on_unmount() + + assert cancelled == ['action'] + + +@pytest.mark.asyncio +async def test_detail_screen_scrolls_in_small_viewport(tui_modules: SimpleNamespace) -> None: + thin_scrollbar_size = 1 + app = tui_modules.cli_tui_app.ShierfengTuiApp('dev') + app.action_show_dashboard = lambda: None # type: ignore[method-assign] + app.current_view = 'app' + snapshot = tui_modules.cli_tui_app.DetailPageSnapshot( + title='应用', + subtitle='超长详情', + sections=[ + tui_modules.cli_tui_adapters.DetailSectionSnapshot( + title='配置总览', + status='warn', + lines=[f'第{i:02d}行 内容很长 内容很长 内容很长 内容很长' for i in range(1, 40)], + ) + ], + ) + screen = app.screen_factory.build( + snapshot=snapshot, + env=app.env, + active_view=app.current_view, + navigation_items=tui_modules.cli_tui_app.NAVIGATION_ITEMS, + action_feedback_lines=app.get_action_feedback_lines(app.current_view), + ) + + async with app.run_test(size=(80, 24)) as pilot: + app.screen_navigator.show(screen) + await pilot.pause() + await pilot.pause() + + main = app.screen.query_one('#workspace-main') + detail_body = app.screen.query_one('#detail-body') + detail_view = app.screen.query_one(tui_modules.cli_tui_widgets.SectionDetailView) + + assert main.styles.scrollbar_size_vertical == thin_scrollbar_size + assert main.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert main.virtual_size.height > main.size.height + assert detail_body.styles.scrollbar_size_vertical == thin_scrollbar_size + assert detail_body.styles.scrollbar_size_horizontal == thin_scrollbar_size + assert detail_view.styles.scrollbar_size_vertical == thin_scrollbar_size + assert detail_view.styles.scrollbar_size_horizontal == thin_scrollbar_size diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/conftest.py b/shierfeng-fastapi-backend/tests/cli/wizard/conftest.py new file mode 100644 index 0000000..29f10f8 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/conftest.py @@ -0,0 +1,68 @@ +import importlib +import sys +from collections.abc import Callable +from pathlib import Path +from types import ModuleType + +import pytest + +BACKEND_DIR = Path(__file__).resolve().parents[3] + +if str(BACKEND_DIR) not in sys.path: + sys.path.insert(0, str(BACKEND_DIR)) + + +def _load_module(module_name: str) -> ModuleType: + sys.modules.pop(module_name, None) + sys.modules.pop('cli', None) + return importlib.import_module(module_name) + + +@pytest.fixture +def backend_dir() -> Path: + return BACKEND_DIR + + +@pytest.fixture +def load_module() -> Callable[[str], ModuleType]: + return _load_module + + +@pytest.fixture +def cli_main(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.main') + + +@pytest.fixture +def app_run_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.app_run') + + +@pytest.fixture +def cache_clear_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.cache_clear') + + +@pytest.fixture +def db_upgrade_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.db_upgrade') + + +@pytest.fixture +def gen_export_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.gen_export') + + +@pytest.fixture +def gen_import_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.gen_import') + + +@pytest.fixture +def prod_check_flow(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.wizard.flows.prod_check') + + +@pytest.fixture +def exit_codes(load_module: Callable[[str], ModuleType]) -> ModuleType: + return load_module('cli.exit_codes') diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_app_run.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_app_run.py new file mode 100644 index 0000000..53552f7 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_app_run.py @@ -0,0 +1,33 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_app_run_wizard_execs_nested_cli_after_confirmation( + monkeypatch: MonkeyPatch, + app_run_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['dev', False, True]) + monkeypatch.setattr( + app_run_flow.AppRunWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': next(answers), + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + app_run_flow.AppRunWizardFlow.context_factory, + 'build_readonly', + lambda env, output: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + app_run_flow.AppRunWizardFlow, + 'nested_live_command_runner', + lambda *arguments: captured.update({'arguments': arguments}), + ) + + app_run_flow.run_app_run_wizard() + + assert captured['arguments'] == ('app', 'run', '--env=dev') diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_cache_clear.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_cache_clear.py new file mode 100644 index 0000000..24897be --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_cache_clear.py @@ -0,0 +1,88 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_cache_clear_wizard_cancels_when_confirmation_rejected( + monkeypatch: MonkeyPatch, + cache_clear_flow: ModuleType, + exit_codes: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['dev', 'cache-name', 'sys_config', True, False]) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': next(answers), + prompt_choice=lambda prompt_text, choices, default_value: next(answers), + prompt_required_text=lambda prompt_text, default_value='': next(answers), + prompt_optional_text=lambda prompt_text, default_value='': '', + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: captured.update({'ctx': ctx, 'result': result}), + ) + + cache_clear_flow.run_cache_clear_wizard('text') + + assert captured['ctx'].env == 'dev' + assert captured['result'].exit_code == exit_codes.GUARD_REJECTED + assert captured['result'].data['message'] == '已取消向导执行:wizard cache-clear' + + +def test_cache_clear_wizard_accepts_default_context_values( + monkeypatch: MonkeyPatch, + cache_clear_flow: ModuleType, +) -> None: + captured_defaults: dict[str, object] = {} + captured_confirm_defaults: list[tuple[str, bool]] = [] + answers = iter(['dev', 'cache-name', 'sys_config', True, False]) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': captured_defaults.update({'env': default_env}) or next(answers), + prompt_choice=lambda prompt_text, choices, default_value: ( + captured_defaults.update({'mode': default_value}) or next(answers) + ), + prompt_required_text=lambda prompt_text, default_value='': ( + captured_defaults.update({'cache_name': default_value}) or next(answers) + ), + prompt_optional_text=lambda prompt_text, default_value='': '', + prompt_confirm=lambda prompt_text, default_value=False: ( + captured_confirm_defaults.append((prompt_text, default_value)) or next(answers) + ), + ), + ) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + cache_clear_flow.CacheClearWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: None, + ) + + cache_clear_flow.run_cache_clear_wizard( + 'text', + default_env='dev', + default_mode='cache-name', + default_cache_name='sys_config', + default_dry_run=True, + ) + + assert captured_defaults['env'] == 'dev' + assert captured_defaults['mode'] == 'cache-name' + assert captured_defaults['cache_name'] == 'sys_config' + assert captured_confirm_defaults[0][1] is True diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_commands.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_commands.py new file mode 100644 index 0000000..8fe0ca3 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_commands.py @@ -0,0 +1,24 @@ +from pathlib import Path +from types import ModuleType + +from pytest import MonkeyPatch +from typer.testing import CliRunner + + +def test_wizard_help_lists_supported_subcommands( + monkeypatch: MonkeyPatch, + backend_dir: Path, + cli_main: ModuleType, +) -> None: + runner = CliRunner() + monkeypatch.chdir(backend_dir) + + result = runner.invoke(cli_main.CLI_APPLICATION_BUILDER.build(), ['wizard', '--help']) + + assert result.exit_code == 0 + assert 'app-run' in result.stdout + assert 'db-upgrade' in result.stdout + assert 'cache-clear' in result.stdout + assert 'gen-export' in result.stdout + assert 'gen-import' in result.stdout + assert 'prod-check' in result.stdout diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_db_upgrade.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_db_upgrade.py new file mode 100644 index 0000000..17e108e --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_db_upgrade.py @@ -0,0 +1,99 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_db_upgrade_wizard_executes_nested_cli_with_confirmed_inputs( + monkeypatch: MonkeyPatch, + db_upgrade_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': 'dev', + prompt_required_text=lambda prompt_text, default_value='': 'head', + prompt_confirm=lambda prompt_text, default_value=False: True, + ), + ) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace( + env=env, + output=output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ), + ) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow, + 'nested_command_runner', + lambda *arguments, parse_json=False: SimpleNamespace( + returncode=0, + payload={'ok': True, 'message': '数据库已升级到 head', 'dryRun': True}, + ), + ) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow.execution_service, + 'complete_payload', + lambda ctx, payload, default_exit_code=0: captured.update( + { + 'ctx': ctx, + 'payload': payload, + 'default_exit_code': default_exit_code, + } + ), + ) + + db_upgrade_flow.run_db_upgrade_wizard('json') + + assert captured['ctx'].env == 'dev' + assert captured['ctx'].output == 'json' + assert captured['ctx'].dry_run is True + assert captured['payload'] == {'ok': True, 'message': '数据库已升级到 head', 'dryRun': True} + + +def test_db_upgrade_wizard_accepts_default_context_values( + monkeypatch: MonkeyPatch, + db_upgrade_flow: ModuleType, +) -> None: + captured_defaults: dict[str, object] = {} + captured_confirm_defaults: list[tuple[str, bool]] = [] + confirm_answers = iter([True, False]) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': captured_defaults.update({'env': default_env}) or 'dev', + prompt_required_text=lambda prompt_text, default_value='': ( + captured_defaults.update({'revision': default_value}) or 'head' + ), + prompt_confirm=lambda prompt_text, default_value=False: ( + captured_confirm_defaults.append((prompt_text, default_value)) or next(confirm_answers) + ), + ), + ) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + db_upgrade_flow.DbUpgradeWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: None, + ) + + db_upgrade_flow.run_db_upgrade_wizard( + 'text', + default_env='dev', + default_revision='head', + default_dry_run=True, + ) + + assert captured_defaults['env'] == 'dev' + assert captured_defaults['revision'] == 'head' + assert captured_confirm_defaults[0][1] is True diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_export.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_export.py new file mode 100644 index 0000000..bfd2793 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_export.py @@ -0,0 +1,120 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_gen_export_wizard_executes_nested_cli_with_selected_tables( + monkeypatch: MonkeyPatch, + gen_export_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['dev', 'sys_user,sys_role', 'zip', 'build/demo.zip', True, True]) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': next(answers), + prompt_required_text=lambda prompt_text, default_value='': next(answers), + prompt_choice=lambda prompt_text, choices, default_value: next(answers), + prompt_optional_text=lambda prompt_text, default_value='': next(answers), + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace( + env=env, + output=output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ), + ) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow, + 'nested_command_runner', + lambda *arguments, parse_json=False: SimpleNamespace( + returncode=0, + payload={ + 'ok': True, + 'message': '代码导出演练完成,未执行实际导出', + 'dryRun': True, + 'mode': 'zip', + 'tableNames': ['sys_user', 'sys_role'], + 'outputFile': '/tmp/demo.zip', + }, + ), + ) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow.execution_service, + 'complete_payload', + lambda ctx, payload, default_exit_code=0: captured.update( + { + 'ctx': ctx, + 'payload': payload, + 'default_exit_code': default_exit_code, + } + ), + ) + + gen_export_flow.run_gen_export_wizard('json') + + assert captured['ctx'].env == 'dev' + assert captured['ctx'].output == 'json' + assert captured['ctx'].dry_run is True + assert captured['payload']['tableNames'] == ['sys_user', 'sys_role'] + assert captured['payload']['mode'] == 'zip' + + +def test_gen_export_wizard_accepts_default_context_values( + monkeypatch: MonkeyPatch, + gen_export_flow: ModuleType, +) -> None: + captured_defaults: dict[str, object] = {} + captured_confirm_defaults: list[tuple[str, bool]] = [] + answers = iter(['dev', 'sys_user', 'zip', 'build/demo.zip', True, False]) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': captured_defaults.update({'env': default_env}) or next(answers), + prompt_required_text=lambda prompt_text, default_value='': ( + captured_defaults.update({'table_names': default_value}) or next(answers) + ), + prompt_choice=lambda prompt_text, choices, default_value: ( + captured_defaults.update({'mode': default_value}) or next(answers) + ), + prompt_optional_text=lambda prompt_text, default_value='': ( + captured_defaults.update({'output_file': default_value}) or next(answers) + ), + prompt_confirm=lambda prompt_text, default_value=False: ( + captured_confirm_defaults.append((prompt_text, default_value)) or next(answers) + ), + ), + ) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + gen_export_flow.GenExportWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: None, + ) + + gen_export_flow.run_gen_export_wizard( + 'text', + default_env='dev', + default_table_names='sys_user', + default_mode='zip', + default_output_file='build/demo.zip', + default_dry_run=True, + ) + + assert captured_defaults['env'] == 'dev' + assert captured_defaults['table_names'] == 'sys_user' + assert captured_defaults['mode'] == 'zip' + assert captured_defaults['output_file'] == 'build/demo.zip' + assert captured_confirm_defaults[0][1] is True diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_import.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_import.py new file mode 100644 index 0000000..76336af --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_gen_import.py @@ -0,0 +1,164 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_gen_import_wizard_executes_nested_cli_with_selected_tables( + monkeypatch: MonkeyPatch, + gen_import_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['dev', 'sys_user,sys_role', True, True]) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': next(answers), + prompt_required_text=lambda prompt_text, default_value='': next(answers), + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace( + env=env, + output=output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow, + 'nested_command_runner', + lambda *arguments, parse_json=False: SimpleNamespace( + returncode=0, + payload={ + 'ok': True, + 'message': '物理表导入预演完成,未执行实际导入', + 'dryRun': True, + 'tableNames': ['sys_user', 'sys_role'], + }, + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.execution_service, + 'complete_payload', + lambda ctx, payload, default_exit_code=0: captured.update( + { + 'ctx': ctx, + 'payload': payload, + 'default_exit_code': default_exit_code, + } + ), + ) + + gen_import_flow.run_gen_import_wizard('json') + + assert captured['ctx'].env == 'dev' + assert captured['ctx'].output == 'json' + assert captured['ctx'].dry_run is True + assert captured['payload']['tableNames'] == ['sys_user', 'sys_role'] + + +def test_gen_import_wizard_accepts_default_context_values( + monkeypatch: MonkeyPatch, + gen_import_flow: ModuleType, +) -> None: + captured_defaults: dict[str, object] = {} + captured_confirm_defaults: list[tuple[str, bool]] = [] + answers = iter(['dev', 'sys_user', True, False]) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': captured_defaults.update({'env': default_env}) or next(answers), + prompt_required_text=lambda prompt_text, default_value='': ( + captured_defaults.update({'table_names': default_value}) or next(answers) + ), + prompt_confirm=lambda prompt_text, default_value=False: ( + captured_confirm_defaults.append((prompt_text, default_value)) or next(answers) + ), + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: None, + ) + + gen_import_flow.run_gen_import_wizard( + 'text', + default_env='dev', + default_table_names='sys_user', + default_dry_run=True, + ) + + assert captured_defaults['env'] == 'dev' + assert captured_defaults['table_names'] == 'sys_user' + assert captured_confirm_defaults[0][1] is True + + +def test_gen_import_wizard_falls_back_to_failure_payload_when_nested_result_has_no_dict_payload( + monkeypatch: MonkeyPatch, + gen_import_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['dev', 'sys_notice', True, True]) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='dev': next(answers), + prompt_required_text=lambda prompt_text, default_value='': next(answers), + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.context_factory, + 'build_regular', + lambda env, output, allow_prod, yes, dry_run: SimpleNamespace( + env=env, + output=output, + allow_prod=allow_prod, + yes=yes, + dry_run=dry_run, + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow, + 'nested_command_runner', + lambda *arguments, parse_json=False: SimpleNamespace( + returncode=0, + stdout='OK SUCCESS\nmessage: 导入表结构演练完成,未执行实际写入', + stderr='', + payload=[], + ), + ) + monkeypatch.setattr( + gen_import_flow.GenImportWizardFlow.execution_service, + 'complete_payload', + lambda ctx, payload, default_exit_code=0: captured.update( + { + 'ctx': ctx, + 'payload': payload, + 'default_exit_code': default_exit_code, + } + ), + ) + + gen_import_flow.run_gen_import_wizard('text') + + assert captured['ctx'].env == 'dev' + assert captured['payload'] == { + 'ok': False, + 'message': '代码生成导入向导执行失败', + 'error': 'OK SUCCESS\nmessage: 导入表结构演练完成,未执行实际写入', + 'exit_code': 0, + } diff --git a/shierfeng-fastapi-backend/tests/cli/wizard/test_prod_check.py b/shierfeng-fastapi-backend/tests/cli/wizard/test_prod_check.py new file mode 100644 index 0000000..c956a4c --- /dev/null +++ b/shierfeng-fastapi-backend/tests/cli/wizard/test_prod_check.py @@ -0,0 +1,110 @@ +from types import ModuleType, SimpleNamespace + +from pytest import MonkeyPatch + + +def test_prod_check_wizard_aggregates_nested_cli_payloads( + monkeypatch: MonkeyPatch, + prod_check_flow: ModuleType, +) -> None: + captured: dict[str, object] = {} + answers = iter(['prod', True, True]) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='prod': next(answers), + prompt_confirm=lambda prompt_text, default_value=False: next(answers), + ), + ) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow.context_factory, + 'build_readonly', + lambda env, output: SimpleNamespace(env=env, output=output), + ) + + def fake_run_nested_cli_command(*arguments: str, parse_json: bool = False) -> SimpleNamespace: + del parse_json + if arguments[0:2] == ('app', 'env'): + return SimpleNamespace( + payload={ + 'ok': True, + 'runtime': { + 'cliEnv': 'prod', + 'configEnv': 'prod', + 'envFile': '.env.prod', + 'envFileExists': True, + }, + } + ) + if arguments[0:2] == ('app', 'doctor'): + return SimpleNamespace(payload={'ok': True, 'message': '应用启动前检查通过'}) + return SimpleNamespace( + payload={ + 'ok': True, + 'config': { + 'name': 'demo', + 'host': '0.0.0.0', + 'port': 9099, + 'dbType': 'mysql', + 'redisHost': '127.0.0.1', + 'redisPort': 6379, + }, + } + ) + + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow, + 'nested_command_runner', + fake_run_nested_cli_command, + ) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow.execution_service, + 'complete_payload', + lambda ctx, payload, default_exit_code=0: captured.update({'ctx': ctx, 'payload': payload}), + ) + + prod_check_flow.run_prod_check_wizard('json') + + assert captured['ctx'].env == 'prod' + assert captured['payload']['ok'] is True + assert captured['payload']['doctor']['message'] == '应用启动前检查通过' + assert captured['payload']['runtime']['cliEnv'] == 'prod' + assert captured['payload']['config']['name'] == 'demo' + + +def test_prod_check_wizard_accepts_default_context_values( + monkeypatch: MonkeyPatch, + prod_check_flow: ModuleType, +) -> None: + captured_defaults: dict[str, object] = {} + confirm_answers = iter([True, False]) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow, + 'prompt_service', + SimpleNamespace( + prompt_env=lambda default_env='prod': captured_defaults.update({'env': default_env}) or 'prod', + prompt_confirm=lambda prompt_text, default_value=False: ( + captured_defaults.update({'include_config': default_value}) or next(confirm_answers) + ), + ), + ) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow.context_factory, + 'build_readonly', + lambda env, output: SimpleNamespace(env=env, output=output), + ) + monkeypatch.setattr( + prod_check_flow.ProdCheckWizardFlow.execution_service, + 'complete_result', + lambda ctx, result: None, + ) + + prod_check_flow.run_prod_check_wizard( + 'text', + default_env='prod', + default_include_config=True, + ) + + assert captured_defaults['env'] == 'prod' + assert captured_defaults['include_config'] is True diff --git a/shierfeng-fastapi-backend/tests/test_log_sanitize_util.py b/shierfeng-fastapi-backend/tests/test_log_sanitize_util.py new file mode 100644 index 0000000..d773264 --- /dev/null +++ b/shierfeng-fastapi-backend/tests/test_log_sanitize_util.py @@ -0,0 +1,865 @@ +import asyncio +import json +import os +import sys +from collections.abc import Iterator +from datetime import datetime +from types import SimpleNamespace +from unittest.mock import patch + +import pytest +from fastapi import Request +from loguru import logger as _logger + +sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) + +from common.annotation.log_annotation import Log, RequestLogFieldRoot, ResponseLogFieldRoot +from common.enums import BusinessType +from config.env import LogConfig +from utils.log_util import LoggerInitializer, LogSanitizer, _build_text_assignment_patterns, _build_text_key_pattern + + +@pytest.fixture(autouse=True) +def enable_log_mask_for_tests() -> Iterator[None]: + with patch.object(LogConfig, 'log_mask_enabled', True): + yield + + +def test_sanitize_nested_log_payload() -> None: + payload = { + 'jsonBody': { + 'password': 'plain-password', + 'apiKey': 'sk-123456', + 'systemPrompt': 'top secret prompt', + 'phonenumber': '13812345678', + 'email': 'admin@example.com', + 'ipaddr': '192.168.1.10', + } + } + + sanitized = LogSanitizer.sanitize_data(payload) + + assert sanitized['jsonBody']['password'] == '******' + assert sanitized['jsonBody']['apiKey'] == '******' + assert sanitized['jsonBody']['systemPrompt'] == '******' + assert sanitized['jsonBody']['phonenumber'] == '138****5678' + assert sanitized['jsonBody']['email'] == 'a***n@example.com' + assert sanitized['jsonBody']['ipaddr'] == '192.168.1.10' + + +def test_ip_masking_can_be_enabled_by_partial_mask_field_configuration() -> None: + payload = { + 'jsonBody': { + 'ipaddr': '192.168.1.10', + 'login_ip': '192.168.1.11', + } + } + + with patch.object( + LogSanitizer, + '_PARTIAL_MASK_FIELDS', + LogSanitizer._PARTIAL_MASK_FIELDS | {'ip', 'ipaddr', 'operip', 'loginip'}, + ): + sanitized = LogSanitizer.sanitize_data(payload) + + assert sanitized['jsonBody']['ipaddr'] == '192.168.1.*' + assert sanitized['jsonBody']['login_ip'] == '192.168.1.*' + + +def test_sanitize_config_value_by_config_key() -> None: + payload = { + 'configKey': 'sys.transport.privateKey', + 'configValue': '-----BEGIN PRIVATE KEY-----abc', + } + + sanitized = LogSanitizer.sanitize_data(payload) + + assert sanitized['configValue'] == '******' + + +def test_sanitize_text_message() -> None: + text = 'Authorization=Bearer abc.def password=123456 api_key=sk-test' + expected_mask_count = 3 + + sanitized = LogSanitizer.sanitize_text(text) + + assert 'abc.def' not in sanitized + assert '123456' not in sanitized + assert 'sk-test' not in sanitized + assert sanitized.count('******') >= expected_mask_count + + +def test_sanitize_text_masks_configured_secret_fields() -> None: + text = ( + 'secret_key=my-secret private_key="-----BEGIN PRIVATE KEY-----abc" ' + "credential='cred-123' credentials=cred-list" + ) + expected_mask_count = 4 + + sanitized = LogSanitizer.sanitize_text(text) + + assert 'my-secret' not in sanitized + assert '-----BEGIN PRIVATE KEY-----abc' not in sanitized + assert 'cred-123' not in sanitized + assert 'cred-list' not in sanitized + assert sanitized.count('******') >= expected_mask_count + + +def test_sanitize_text_key_pattern_does_not_cross_lines() -> None: + text = 'header\nprivate\n key=value\nfooter' + + sanitized = LogSanitizer.sanitize_text(text) + + assert sanitized == text + + +def test_sanitize_stringified_json_preserves_newlines_after_masking() -> None: + text = '{\n "password": "123456",\n "userName": "admin"\n}' + + sanitized = LogSanitizer.sanitize_data({'operParam': text}) + + assert sanitized['operParam'] == '{\n "password": "******",\n "userName": "admin"\n}' + + +def test_sanitize_text_masks_configured_partial_fields() -> None: + text = 'email=admin@example.com phonenumber=13812345678 mobile="13812345679"' + + sanitized = LogSanitizer.sanitize_text(text) + + assert 'admin@example.com' not in sanitized + assert '13812345678' not in sanitized + assert '13812345679' not in sanitized + assert 'a***n@example.com' in sanitized + assert '138****5678' in sanitized + assert '138****5679' in sanitized + + +def test_sanitize_text_can_enable_ip_masking_by_partial_mask_field_configuration() -> None: + text = 'login_ip=192.168.1.10 ipaddr="192.168.1.11"' + ip_fields = LogSanitizer._PARTIAL_MASK_FIELDS | {'ip', 'ipaddr', 'operip', 'loginip'} + ip_key_pattern = '|'.join( + sorted( + { + _build_text_key_pattern(field_name) + for field_name in (*LogSanitizer._TEXT_PARTIAL_FIELDS, 'ip', 'ipaddr', 'oper_ip', 'login_ip') + }, + key=len, + reverse=True, + ) + ) + + with ( + patch.object(LogSanitizer, '_PARTIAL_MASK_FIELDS', ip_fields), + patch.object(LogSanitizer, '_PARTIAL_KV_PATTERNS', _build_text_assignment_patterns(ip_key_pattern)), + ): + sanitized = LogSanitizer.sanitize_text(text) + + assert '192.168.1.10' not in sanitized + assert '192.168.1.11' not in sanitized + assert '192.168.1.*' in sanitized + + +def test_sanitize_text_masks_python_repr_like_payload() -> None: + text = "ValueError({'secret_key': 'abc', 'password': '123456', 'api_key': 'sk-123'})" + expected_mask_count = 3 + + sanitized = LogSanitizer.sanitize_text(text) + + assert 'abc' not in sanitized + assert '123456' not in sanitized + assert 'sk-123' not in sanitized + assert sanitized.count('******') >= expected_mask_count + + +def test_sanitize_text_masks_alphanumeric_verification_code() -> None: + text = '短信验证码为A1B2' + + sanitized = LogSanitizer.sanitize_text(text) + + assert 'A1B2' not in sanitized + assert '******' in sanitized + + +def test_sanitize_text_returns_original_when_mask_disabled() -> None: + text = 'Authorization=Bearer abc.def password=123456 api_key=sk-test' + + with patch.object(LogConfig, 'log_mask_enabled', False): + sanitized = LogSanitizer.sanitize_text(text) + + assert sanitized == text + + +def test_build_json_payload_sanitizes_exception_and_extra() -> None: + initializer = LoggerInitializer() + try: + raise ValueError('token=abc.def') + except ValueError as exc: + exception = SimpleNamespace( + type=type(exc), + value=exc, + traceback=exc.__traceback__, + ) + record = { + 'time': datetime(2026, 4, 20, 12, 0, 0), + 'level': SimpleNamespace(name='ERROR'), + 'message': 'password=123456', + 'name': 'test_logger', + 'module': 'test_module', + 'function': 'test_function', + 'line': 1, + 'extra': {'authorization': 'Bearer abc.def', 'trace_id': 'trace-1'}, + 'exception': exception, + } + + initializer._patch_record(record) + initializer._filter(record) + payload = initializer._build_json_payload(record) + + assert '123456' not in payload['message'] + assert 'abc.def' not in payload['exception']['value'] + assert 'abc.def' not in payload['exception']['traceback'] + assert 'ValueError' in payload['exception']['traceback'] + assert payload['extra']['authorization'] == '******' + + +def test_json_log_formatter_emits_valid_json_record() -> None: + initializer = LoggerInitializer() + outputs = [] + test_logger = _logger.patch(initializer._patch_record) + test_logger.remove() + test_logger.add( + lambda message: outputs.append(str(message)), + format=initializer._json_log_formatter, + filter=initializer._filter, + ) + + test_logger.info('hello password=123456') + + assert len(outputs) == 1 + payload = json.loads(outputs[0]) + assert payload['message'] == 'hello password=******' + assert payload['level'] == 'INFO' + + +def test_json_log_formatter_does_not_leak_internal_payload_between_handlers() -> None: + initializer = LoggerInitializer() + first_outputs = [] + second_outputs = [] + test_logger = _logger.patch(initializer._patch_record) + test_logger.remove() + test_logger.add( + lambda message: first_outputs.append(str(message)), + format=initializer._json_log_formatter, + filter=initializer._filter, + ) + test_logger.add( + lambda message: second_outputs.append(str(message)), + format=initializer._json_log_formatter, + filter=initializer._filter, + ) + + test_logger.info('hello') + + assert 'json_payload' not in json.loads(first_outputs[0])['extra'] + assert 'json_payload' not in json.loads(second_outputs[0])['extra'] + + +def test_plain_log_formatter_sanitizes_exception_traceback() -> None: + initializer = LoggerInitializer() + outputs = [] + test_logger = _logger.patch(initializer._patch_record) + test_logger.remove() + test_logger.add( + lambda message: outputs.append(str(message)), + format=initializer._plain_log_formatter, + filter=initializer._filter, + backtrace=False, + diagnose=False, + ) + + try: + raise ValueError('password=123456 token=abc.def') + except ValueError: + test_logger.exception('boom password=123456') + + output = outputs[0] + + assert '123456' not in output + assert 'abc.def' not in output + assert 'ValueError' in output + assert '******' in output + + +def test_plain_log_formatter_separates_consecutive_records() -> None: + initializer = LoggerInitializer() + outputs = [] + expected_output_count = 2 + test_logger = _logger.patch(initializer._patch_record) + test_logger.remove() + test_logger.add( + lambda message: outputs.append(str(message)), + format=initializer._plain_log_formatter, + filter=initializer._filter, + ) + + test_logger.info('first') + test_logger.info('second') + + assert len(outputs) == expected_output_count + assert outputs[0].endswith('\n') + assert 'first\n' in ''.join(outputs) + + +def test_get_request_params_returns_structured_payload() -> None: + async def receive() -> dict: + return { + 'type': 'http.request', + 'body': b'{"password":"plain-password","phonenumber":"13812345678"}', + 'more_body': False, + } + + request = Request( + { + 'type': 'http', + 'method': 'POST', + 'path': '/test', + 'headers': [(b'content-type', b'application/json')], + 'path_params': {}, + 'query_string': b'page=1', + }, + receive=receive, + ) + + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + params = asyncio.run(log_decorator._get_request_params(request)) + + assert params['query_params']['page'] == '1' + assert params['json_body']['password'] == 'plain-password' + + +def test_get_request_params_falls_back_to_raw_body_when_json_invalid() -> None: + async def receive() -> dict: + return { + 'type': 'http.request', + 'body': b'{bad json', + 'more_body': False, + } + + request = Request( + { + 'type': 'http', + 'method': 'POST', + 'path': '/test', + 'headers': [(b'content-type', b'application/json')], + 'path_params': {}, + 'query_string': b'', + }, + receive=receive, + ) + + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + params = asyncio.run(log_decorator._get_request_params(request)) + + assert params['raw_body'] == '{bad json' + mock_warning.assert_called_once() + assert '解析失败' in mock_warning.call_args.args[0] + + +def test_get_request_params_decodes_non_utf8_body_without_raising() -> None: + async def receive() -> dict: + return { + 'type': 'http.request', + 'body': b'\xff\xfeabc', + 'more_body': False, + } + + request = Request( + { + 'type': 'http', + 'method': 'POST', + 'path': '/test', + 'headers': [(b'content-type', b'text/plain')], + 'path_params': {}, + 'query_string': b'', + }, + receive=receive, + ) + + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + params = asyncio.run(log_decorator._get_request_params(request)) + + assert params['raw_body'].endswith('abc') + assert '\ufffd' in params['raw_body'] + + +def test_log_handles_missing_user_agent_without_error() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER, log_type='login') + + assert log_decorator._get_oper_type(None) == 0 + + login_log = log_decorator._get_login_log( + None, + oper_ip='127.0.0.1', + oper_location='内网IP', + oper_time=datetime(2026, 4, 20, 12, 0, 0), + origin_kwargs={}, + ) + + assert login_log['ipaddr'] == '127.0.0.1' + assert login_log['loginLocation'] == '内网IP' + assert login_log['browser'] == 'Other' + assert login_log['os'] == 'Other' + + +def test_build_log_text_with_summary_mode() -> None: + log_decorator = Log( + title='测试日志', + business_type=BusinessType.OTHER, + request_log_mode='summary', + ) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'query_params': {'page': '1'}, + 'json_body': {'password': 'plain-password', 'modelName': 'demo-model'}, + } + ), + mode='summary', + include_fields=(), + exclude_fields=(), + payload_kind='request', + ) + log_payload = json.loads(log_text) + + assert log_payload['mode'] == 'summary' + assert log_payload['query_param_keys'] == ['page'] + assert log_payload['json_body_keys'] == ['password', 'modelName'] + + +def test_build_log_text_with_include_mode() -> None: + log_decorator = Log( + title='测试日志', + business_type=BusinessType.OTHER, + response_log_mode='include', + response_include_fields=('data.token', 'data.userName'), + ) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'code': 200, + 'msg': 'success', + 'data': {'token': 'abc.def', 'userName': 'admin', 'extra': 'ignored'}, + } + ), + mode='include', + include_fields=('data.token', 'data.userName'), + exclude_fields=(), + payload_kind='response', + ) + log_payload = json.loads(log_text) + + assert log_payload['mode'] == 'include' + assert log_payload['selected']['data.token'] == '******' + assert log_payload['selected']['data.userName'] == 'admin' + assert 'data.extra' not in log_payload['selected'] + + +def test_include_fields_support_snake_case_matching_camel_case_payload() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'json_body': { + 'modelCode': 'deepseek-chat', + 'supportReasoning': 'Y', + } + } + ), + mode='include', + include_fields=('json_body.model_code', 'json_body.support_reasoning'), + exclude_fields=(), + payload_kind='request', + ) + log_payload = json.loads(log_text) + + assert log_payload['selected']['json_body.model_code'] == 'deepseek-chat' + assert log_payload['selected']['json_body.support_reasoning'] == 'Y' + + +def test_include_fields_support_camel_case_matching_snake_case_payload() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'data': { + 'user_name': 'admin', + 'login_ip': '192.168.1.10', + } + } + ), + mode='include', + include_fields=('data.userName', 'data.loginIp'), + exclude_fields=(), + payload_kind='response', + ) + log_payload = json.loads(log_text) + + assert log_payload['selected']['data.userName'] == 'admin' + assert log_payload['selected']['data.loginIp'] == '192.168.1.10' + + +def test_request_field_helper_builds_canonical_path() -> None: + assert RequestLogFieldRoot.JSON_BODY.field('model_code') == 'json_body.model_code' + assert ResponseLogFieldRoot.DATA.field('userName') == 'data.userName' + + +def test_code_field_masking_only_applies_to_login_like_verification_code() -> None: + login_payload = { + 'uuid': 'captcha-session', + 'code': 'A1B2', + 'msg': 'login', + } + business_payload = { + 'code': '200', + 'msg': 'ok', + } + + sanitized_login_payload = LogSanitizer.sanitize_data(login_payload) + sanitized_business_payload = LogSanitizer.sanitize_data(business_payload) + + assert sanitized_login_payload['code'] == '******' + assert sanitized_business_payload['code'] == '200' + + +def test_build_log_text_with_exclude_mode() -> None: + log_decorator = Log( + title='测试日志', + business_type=BusinessType.OTHER, + request_log_mode='exclude', + request_exclude_fields=('json_body.api_key',), + ) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'json_body': { + 'modelCode': 'deepseek-chat', + 'apiKey': 'sk-test', + 'baseUrl': 'https://api.example.com', + } + } + ), + mode='exclude', + include_fields=(), + exclude_fields=('json_body.api_key',), + payload_kind='request', + ) + log_payload = json.loads(log_text) + + assert 'apiKey' not in log_payload['json_body'] + assert log_payload['json_body']['modelCode'] == 'deepseek-chat' + assert log_payload['json_body']['baseUrl'] == 'https://api.example.com' + + +def test_exclude_fields_support_snake_case_matching_camel_case_payload() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'data': { + 'apiKey': '******', + 'baseUrl': 'https://api.example.com', + } + } + ), + mode='exclude', + include_fields=(), + exclude_fields=('data.api_key',), + payload_kind='response', + ) + log_payload = json.loads(log_text) + + assert 'apiKey' not in log_payload['data'] + assert log_payload['data']['baseUrl'] == 'https://api.example.com' + + +def test_exclude_fields_remove_multiple_list_indexes_without_shift() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'rows': [ + {'id': 1}, + {'id': 2}, + {'id': 3}, + ] + } + ), + mode='exclude', + include_fields=(), + exclude_fields=('rows.0', 'rows.1'), + payload_kind='response', + ) + log_payload = json.loads(log_text) + + assert log_payload['rows'] == [{'id': 3}] + + +def test_collect_field_path_warnings_for_invalid_root() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + warnings = log_decorator._collect_field_path_warnings( + mode='include', + include_fields=('body.modelCode',), + exclude_fields=(), + payload_kind='request', + ) + + assert len(warnings) == 1 + assert 'body.modelCode' in warnings[0] + assert 'json_body' in warnings[0] + + +def test_collect_field_path_warnings_accepts_normalized_root() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + warnings = log_decorator._collect_field_path_warnings( + mode='include', + include_fields=('jsonBody.modelCode',), + exclude_fields=(), + payload_kind='request', + ) + + assert warnings == [] + + +def test_collect_field_path_warnings_for_missing_include_fields() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + warnings = log_decorator._collect_field_path_warnings( + mode='include', + include_fields=(), + exclude_fields=(), + payload_kind='response', + ) + + assert len(warnings) == 1 + assert 'include模式' in warnings[0] + assert 'data' in warnings[0] + + +def test_collect_field_path_warnings_for_missing_exclude_fields() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + warnings = log_decorator._collect_field_path_warnings( + mode='exclude', + include_fields=(), + exclude_fields=(), + payload_kind='request', + ) + + assert len(warnings) == 1 + assert 'exclude模式' in warnings[0] + assert 'json_body' in warnings[0] + + +def test_log_warns_when_include_fields_do_not_match_mode() -> None: + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + Log( + title='测试日志', + business_type=BusinessType.OTHER, + request_log_mode='summary', + request_include_fields=('json_body.modelCode',), + ) + + mock_warning.assert_called_once() + assert '不会生效' in mock_warning.call_args.args[0] + + +def test_request_include_fields_invalid_root_raises_value_error() -> None: + try: + Log( + title='测试日志', + business_type=BusinessType.OTHER, + request_log_mode='include', + request_include_fields=('body.modelCode',), + ) + except ValueError as exc: + assert 'body.modelCode' in str(exc) + else: + raise AssertionError('expected ValueError for invalid request include root') + + +def test_request_exclude_fields_invalid_root_raises_value_error() -> None: + try: + Log( + title='测试日志', + business_type=BusinessType.OTHER, + request_log_mode='exclude', + request_exclude_fields=('body.apiKey',), + ) + except ValueError as exc: + assert 'body.apiKey' in str(exc) + else: + raise AssertionError('expected ValueError for invalid request exclude root') + + +def test_build_log_text_warns_for_missing_include_field() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'json_body': { + 'modelCode': 'deepseek-chat', + } + } + ), + mode='include', + include_fields=('json_body.modleCode',), + exclude_fields=(), + payload_kind='request', + ) + + log_payload = json.loads(log_text) + + assert log_payload['selected'] == {} + mock_warning.assert_called_once() + assert '未命中' in mock_warning.call_args.args[0] + assert 'modleCode' in mock_warning.call_args.args[0] + + +def test_missing_include_field_warning_only_emitted_once() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + payload = LogSanitizer.sanitize_data({'data': {'userName': 'admin'}}) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + log_decorator._build_log_text( + payload, + mode='include', + include_fields=('data.userNmae',), + exclude_fields=(), + payload_kind='response', + ) + log_decorator._build_log_text( + payload, + mode='include', + include_fields=('data.userNmae',), + exclude_fields=(), + payload_kind='response', + ) + + mock_warning.assert_called_once() + + +def test_include_fields_keep_explicit_none_value() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'data': { + 'userName': None, + } + } + ), + mode='include', + include_fields=('data.userName',), + exclude_fields=(), + payload_kind='response', + ) + + log_payload = json.loads(log_text) + + assert 'data.userName' in log_payload['selected'] + assert log_payload['selected']['data.userName'] is None + mock_warning.assert_not_called() + + +def test_include_field_warning_reports_ambiguous_normalized_match() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'data': { + 'user_name': 'admin', + 'userName': 'root', + } + } + ), + mode='include', + include_fields=('data.username',), + exclude_fields=(), + payload_kind='response', + ) + + log_payload = json.loads(log_text) + + assert log_payload['selected'] == {} + mock_warning.assert_called_once() + assert '命名冲突' in mock_warning.call_args.args[0] + assert 'user_name' in mock_warning.call_args.args[0] + assert 'userName' in mock_warning.call_args.args[0] + + +def test_build_log_text_warns_for_missing_exclude_field() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + with patch('common.annotation.log_annotation.logger.warning') as mock_warning: + log_text = log_decorator._build_log_text( + LogSanitizer.sanitize_data( + { + 'json_body': { + 'modelCode': 'deepseek-chat', + } + } + ), + mode='exclude', + include_fields=(), + exclude_fields=('json_body.apiKey',), + payload_kind='request', + ) + + log_payload = json.loads(log_text) + + assert log_payload['json_body']['modelCode'] == 'deepseek-chat' + mock_warning.assert_called_once() + assert '排除路径未命中' in mock_warning.call_args.args[0] + + +def test_build_summary_payload_supports_message_field_fallback() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + + summary_payload = log_decorator._build_summary_payload({'code': 200, 'message': '获取成功'}, 'response') + status, error_msg = log_decorator._get_status_and_error_msg({'code': 500, 'message': '获取失败'}) + + assert summary_payload['msg'] == '获取成功' + assert status == 1 + assert error_msg == '获取失败' + + +def test_log_decorator_truncates_oversized_json_result() -> None: + log_decorator = Log(title='测试日志', business_type=BusinessType.OTHER) + json_result = log_decorator._build_log_text( + {'code': 200, 'data': {'content': 'x' * 2100}}, + mode='full', + include_fields=(), + exclude_fields=(), + payload_kind='response', + ) + + limited_json_result = log_decorator._limit_log_text(json_result, log_decorator._json_result_len, '返回参数过长') + + assert limited_json_result == '返回参数过长' diff --git a/shierfeng-fastapi-backend/utils/ai_util.py b/shierfeng-fastapi-backend/utils/ai_util.py new file mode 100644 index 0000000..e9bd4c7 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/ai_util.py @@ -0,0 +1,172 @@ +from importlib import import_module +from typing import TYPE_CHECKING + +from config.database import async_engine +from config.env import DataBaseConfig + +if TYPE_CHECKING: + from agno.db.base import AsyncBaseDb + from agno.models.base import Model + +# 提供商名称 -> (模块路径, 类名) 的映射,延迟导入避免启动时加载所有AI SDK +_PROVIDER_REGISTRY: dict[str, tuple[str, str]] = { + 'AIMLAPI': ('agno.models.aimlapi', 'AIMLAPI'), + 'Anthropic': ('agno.models.anthropic', 'Claude'), + 'Cerebras': ('agno.models.cerebras', 'Cerebras'), + 'CerebrasOpenAI': ('agno.models.cerebras', 'CerebrasOpenAI'), + 'Cohere': ('agno.models.cohere', 'Cohere'), + 'CometAPI': ('agno.models.cometapi', 'CometAPI'), + 'DashScope': ('agno.models.dashscope', 'DashScope'), + 'DeepInfra': ('agno.models.deepinfra', 'DeepInfra'), + 'DeepSeek': ('agno.models.deepseek', 'DeepSeek'), + 'Fireworks': ('agno.models.fireworks', 'Fireworks'), + 'Google': ('agno.models.google', 'Gemini'), + 'Groq': ('agno.models.groq', 'Groq'), + 'HuggingFace': ('agno.models.huggingface', 'HuggingFace'), + 'LangDB': ('agno.models.langdb', 'LangDB'), + 'LiteLLM': ('agno.models.litellm', 'LiteLLM'), + 'LiteLLMOpenAI': ('agno.models.litellm', 'LiteLLMOpenAI'), + 'LlamaCpp': ('agno.models.llama_cpp', 'LlamaCpp'), + 'LMStudio': ('agno.models.lmstudio', 'LMStudio'), + 'Meta': ('agno.models.meta', 'Llama'), + 'Mistral': ('agno.models.mistral', 'MistralChat'), + 'N1N': ('agno.models.n1n', 'N1N'), + 'Nebius': ('agno.models.nebius', 'Nebius'), + 'Nexus': ('agno.models.nexus', 'Nexus'), + 'Nvidia': ('agno.models.nvidia', 'Nvidia'), + 'Ollama': ('agno.models.ollama', 'Ollama'), + 'OpenAI': ('agno.models.openai', 'OpenAIChat'), + 'OpenAIResponses': ('agno.models.openai.responses', 'OpenAIResponses'), + 'OpenRouter': ('agno.models.openrouter', 'OpenRouter'), + 'Perplexity': ('agno.models.perplexity', 'Perplexity'), + 'Portkey': ('agno.models.portkey', 'Portkey'), + 'Requesty': ('agno.models.requesty', 'Requesty'), + 'Sambanova': ('agno.models.sambanova', 'Sambanova'), + 'SiliconFlow': ('agno.models.siliconflow', 'Siliconflow'), + 'Together': ('agno.models.together', 'Together'), + 'Vercel': ('agno.models.vercel', 'V0'), + 'VLLM': ('agno.models.vllm', 'VLLM'), + 'xAI': ('agno.models.xai', 'xAI'), +} + +# 存储引擎名称 -> (模块路径, 类名) 的映射 +_STORAGE_ENGINE_REGISTRY: dict[str, tuple[str, str]] = { + 'mysql': ('agno.db.mysql', 'AsyncMySQLDb'), + 'postgresql': ('agno.db.postgres', 'AsyncPostgresDb'), +} + +# 已加载的提供商类缓存,避免重复import_module +_provider_class_cache: dict[str, 'type[Model]'] = {} +_storage_class_cache: dict[str, 'type[AsyncBaseDb]'] = {} + + +class AiUtil: + """ + AI工具类 + """ + + @classmethod + def _resolve_provider_class(cls, provider: str) -> 'type[Model] | None': + """ + 按需加载并缓存提供商模型类 + + :param provider: 提供商名称 + :return: 模型类,未找到返回None + """ + if provider in _provider_class_cache: + return _provider_class_cache[provider] + entry = _PROVIDER_REGISTRY.get(provider) + if entry is None: + return None + module_path, class_name = entry + provider_cls = getattr(import_module(module_path), class_name) + _provider_class_cache[provider] = provider_cls + return provider_cls + + @classmethod + def _resolve_storage_class(cls, db_type: str) -> 'type[AsyncBaseDb]': + """ + 按需加载并缓存存储引擎类 + + :param db_type: 数据库类型 + :return: 存储引擎类 + """ + if db_type in _storage_class_cache: + return _storage_class_cache[db_type] + entry = _STORAGE_ENGINE_REGISTRY.get(db_type) + if entry is None: + # 默认使用MySQL + entry = _STORAGE_ENGINE_REGISTRY['mysql'] + module_path, class_name = entry + storage_cls = getattr(import_module(module_path), class_name) + _storage_class_cache[db_type] = storage_cls + return storage_cls + + @classmethod + def get_storage_engine(cls) -> 'AsyncBaseDb': + """ + 获取存储引擎实例 + + :return: 存储引擎实例 + """ + storage_engine_class = cls._resolve_storage_class(DataBaseConfig.db_type) + + return storage_engine_class( + db_engine=async_engine, + db_schema=DataBaseConfig.db_database if DataBaseConfig.db_type == 'mysql' else 'public', + session_table='ai_sessions', + memory_table='ai_memories', + metrics_table='ai_metrics', + eval_table='ai_eval_runs', + knowledge_table='ai_knowledge', + culture_table='ai_culture', + traces_table='ai_traces', + spans_table='ai_spans', + versions_table='ai_schema_versions', + create_schema=False, + ) + + @classmethod + def get_model_from_factory( + cls, + provider: str, + model_code: str, + model_name: str | None = None, + api_key: str | None = None, + base_url: str | None = None, + temperature: float | None = None, + max_tokens: int | None = None, + **kwargs, + ) -> 'Model': + """ + 从工厂获取模型实例 + + :param provider: 提供商 + :param model_code: 模型编码 + :param model_name: 模型名称 + :param api_key: API密钥 + :param base_url: 基础URL + :param temperature: 温度 + :param max_tokens: 最大令牌数 + :return: 模型实例 + """ + params = { + 'id': model_code, + 'name': model_name, + 'base_url': base_url, + 'api_key': api_key, + 'temperature': temperature, + 'max_tokens': max_tokens, + **kwargs, + } + params = {k: v for k, v in params.items() if v is not None} + if provider == 'Ollama': + params['host'] = base_url + if provider == 'DashScope' and not base_url: + params['base_url'] = 'https://dashscope.aliyuncs.com/compatible-mode/v1' + model_class = cls._resolve_provider_class(provider) + if model_class is None: + # 未知提供商,回退到OpenAI + model_class = cls._resolve_provider_class('OpenAI') + + return model_class(**params) diff --git a/shierfeng-fastapi-backend/utils/api_annotation_util.py b/shierfeng-fastapi-backend/utils/api_annotation_util.py new file mode 100644 index 0000000..09c1454 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/api_annotation_util.py @@ -0,0 +1,102 @@ +import inspect +from collections.abc import Awaitable, Callable, Sequence +from typing import TypeVar + +from fastapi import Request +from redis import asyncio as aioredis +from typing_extensions import ParamSpec + +from common.enums import HttpMethod +from utils.log_util import logger + +P = ParamSpec('P') +R = TypeVar('R') + + +class ApiAnnotationUtil: + """ + 接口装饰器通用工具类 + """ + + @classmethod + def get_request(cls, func: Callable[P, Awaitable[R]], *args: P.args, **kwargs: P.kwargs) -> Request | None: + """ + 从被装饰函数的入参中提取Request对象 + + :param func: 被装饰的异步接口函数 + :param args: 位置参数 + :param kwargs: 关键字参数 + :return: Request对象,未找到时返回None + """ + signature = inspect.signature(func) + bound_arguments = signature.bind_partial(*args, **kwargs) + for argument in bound_arguments.arguments.values(): + if isinstance(argument, Request): + return argument + + return None + + @classmethod + def get_redis_client(cls, request: Request, skip_message: str) -> aioredis.Redis | None: + """ + 从应用状态中获取Redis连接 + + :param request: 当前请求对象 + :param skip_message: 未初始化Redis连接时的日志信息 + :return: Redis连接对象,未初始化时返回None + """ + redis = getattr(request.app.state, 'redis', None) + if redis is None: + logger.warning(skip_message) + + return redis + + @classmethod + def resolve_request_redis( + cls, + func: Callable[P, Awaitable[R]], + skip_message: str, + *args: P.args, + **kwargs: P.kwargs, + ) -> tuple[Request | None, aioredis.Redis | None]: + """ + 从被装饰函数入参中同时解析Request与Redis连接 + + :param func: 被装饰的异步接口函数 + :param skip_message: 未初始化Redis连接时的日志信息 + :param args: 位置参数 + :param kwargs: 关键字参数 + :return: Request对象与Redis连接对象组成的元组 + """ + request = cls.get_request(func, *args, **kwargs) + if request is None: + return None, None + + return request, cls.get_redis_client(request, skip_message) + + @classmethod + def normalize_http_methods( + cls, + methods: Sequence[HttpMethod] | None, + default_methods: Sequence[HttpMethod] | None = None, + ) -> tuple[str, ...]: + """ + 标准化HTTP请求方法配置 + + :param methods: 显式配置的HTTP请求方法 + :param default_methods: methods为空时使用的默认HTTP请求方法 + :return: 去重且标准化后的HTTP请求方法元组 + """ + target_methods = methods if methods is not None else default_methods + if not target_methods: + return () + + normalized_methods: list[str] = [] + for method in target_methods: + if not isinstance(method, HttpMethod): + raise TypeError('methods参数仅支持HttpMethod枚举') + normalized_method = method.value + if normalized_method not in normalized_methods: + normalized_methods.append(normalized_method) + + return tuple(normalized_methods) diff --git a/shierfeng-fastapi-backend/utils/api_response_header_util.py b/shierfeng-fastapi-backend/utils/api_response_header_util.py new file mode 100644 index 0000000..40824e3 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/api_response_header_util.py @@ -0,0 +1,25 @@ +from collections.abc import Mapping + +from fastapi import Request + + +class ApiResponseHeaderUtil: + """ + 接口响应头通用工具类 + """ + + @classmethod + def merge_headers(cls, request: Request, headers: Mapping[str, str] | None) -> None: + """ + 将响应头暂存到请求上下文中,供出站中间件统一追加 + + :param request: 当前请求对象 + :param headers: 需要追加的响应头 + :return: None + """ + if not headers: + return + + api_response_headers = dict(getattr(request.state, 'api_response_headers', {})) + api_response_headers.update(headers) + request.state.api_response_headers = api_response_headers diff --git a/shierfeng-fastapi-backend/utils/client_ip_util.py b/shierfeng-fastapi-backend/utils/client_ip_util.py new file mode 100644 index 0000000..34b7fdc --- /dev/null +++ b/shierfeng-fastapi-backend/utils/client_ip_util.py @@ -0,0 +1,60 @@ +from fastapi import Request + +from config.env import AppConfig + + +class ClientIPUtil: + """ + 客户端IP提取工具 + """ + + @classmethod + def get_client_ip(cls, request: Request) -> str: + """ + 获取客户端真实IP + + 仅当请求来源命中可信代理列表,且可信代理跳数大于0时,才会解析 + X-Forwarded-For / X-Real-IP 请求头;否则回退到直接连接来源地址。 + + :param request: 当前请求对象 + :return: 客户端IP + """ + remote_addr = request.client.host if request.client else 'unknown' + if AppConfig.app_trusted_proxy_hops <= 0: + return remote_addr + if not cls._should_trust_proxy_headers(remote_addr): + return remote_addr + + forwarded_for = request.headers.get('X-Forwarded-For', '') + if forwarded_for: + forwarded_chain = [item.strip() for item in forwarded_for.split(',') if item.strip()] + if forwarded_chain: + if len(forwarded_chain) > AppConfig.app_trusted_proxy_hops: + return forwarded_chain[-(AppConfig.app_trusted_proxy_hops + 1)] + return forwarded_chain[0] + + real_ip = request.headers.get('X-Real-IP', '').strip() + if real_ip: + return real_ip + + return remote_addr + + @classmethod + def _should_trust_proxy_headers(cls, remote_addr: str) -> bool: + """ + 判断当前连接来源是否属于可信代理 + + :param remote_addr: 与应用直接建立连接的来源IP + :return: 是否信任代理头 + """ + trusted_proxy_ips = cls._get_trusted_proxy_ips() + return '*' in trusted_proxy_ips or remote_addr in trusted_proxy_ips + + @classmethod + def _get_trusted_proxy_ips(cls) -> set[str]: + """ + 获取可信代理IP集合 + + :return: 可信代理IP集合 + """ + return {item.strip() for item in AppConfig.app_trusted_proxy_ips.split(',') if item.strip()} diff --git a/shierfeng-fastapi-backend/utils/common_util.py b/shierfeng-fastapi-backend/utils/common_util.py new file mode 100644 index 0000000..eb6ff35 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/common_util.py @@ -0,0 +1,403 @@ +import io +import os +import re +from collections.abc import Generator, Sequence +from typing import Any, Literal, overload + +import pandas as pd +from openpyxl import Workbook +from openpyxl.styles import Alignment, PatternFill +from openpyxl.utils import get_column_letter +from openpyxl.worksheet.datavalidation import DataValidation +from sqlalchemy.engine.row import Row +from sqlalchemy.orm.collections import InstrumentedList +from sqlalchemy.sql.expression import TextClause, null + +from config.database import Base +from config.env import CachePathConfig +from utils.log_util import logger + + +def worship() -> None: + logger.info(r""" +//////////////////////////////////////////////////////////////////// +// _ooOoo_ // +// o8888888o // +// 88" . "88 // +// (| ^_^ |) // +// O\ = /O // +// ____/`---'\____ // +// .' \\| |// `. // +// / \\||| : |||// \ // +// / _||||| -:- |||||- \ // +// | | \\\ - /// | | // +// | \_| ''\---/'' | | // +// \ .-\__ `-` ___/-. / // +// ___`. .' /--.--\ `. . ___ // +// ."" '< `.___\_<|>_/___.' >'"". // +// | | : `- \`.;`\ _ /`;.`/ - ` : | | // +// \ \ `-. \_ __\ /__ _/ .-` / / // +// ========`-.____`-.___\_____/___.-`____.-'======== // +// `=---=' // +// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ // +// 佛祖保佑 永不宕机 永无BUG // +//////////////////////////////////////////////////////////////////// + """) + + +class SqlalchemyUtil: + """ + sqlalchemy工具类 + """ + + @classmethod + def base_to_dict( + cls, obj: Base | dict, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> dict: + """ + 将sqlalchemy模型对象转换为字典 + + :param obj: sqlalchemy模型对象或普通字典 + :param transform_case: 转换得到的结果形式,可选的有'no_case'(不转换)、'snake_to_camel'(下划线转小驼峰)、'camel_to_snake'(小驼峰转下划线),默认为'no_case' + :return: 字典结果 + """ + if isinstance(obj, Base): + base_dict = obj.__dict__.copy() + base_dict.pop('_sa_instance_state', None) + for name, value in base_dict.items(): + if isinstance(value, InstrumentedList): + base_dict[name] = cls.serialize_result(value, 'snake_to_camel') + elif isinstance(obj, dict): + base_dict = obj.copy() + if transform_case == 'snake_to_camel': + return {CamelCaseUtil.snake_to_camel(k): v for k, v in base_dict.items()} + if transform_case == 'camel_to_snake': + return {SnakeCaseUtil.camel_to_snake(k): v for k, v in base_dict.items()} + + return base_dict + + @classmethod + @overload + def serialize_result( + cls, result: Base, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> dict[str, Any]: ... + + @classmethod + @overload + def serialize_result( + cls, result: dict, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> dict[Any, Any]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Row, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> dict[str, Any] | list[dict[Any, Any]]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Sequence[Base], transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> list[dict[str, Any]]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Sequence[dict], transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> list[dict[Any, Any]]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Sequence[Row], transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> list[dict[str, Any] | list[dict[Any, Any]]]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Sequence[Any], transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> list[Any]: ... + + @classmethod + @overload + def serialize_result( + cls, result: Any, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> Any: ... + + @classmethod + def serialize_result( + cls, result: Any, transform_case: Literal['no_case', 'snake_to_camel', 'camel_to_snake'] = 'no_case' + ) -> Any: + """ + 将sqlalchemy查询结果序列化 + + :param result: sqlalchemy查询结果 + :param transform_case: 转换得到的结果形式,可选的有'no_case'(不转换)、'snake_to_camel'(下划线转小驼峰)、'camel_to_snake'(小驼峰转下划线),默认为'no_case' + :return: 序列化结果 + """ + if isinstance(result, (Base, dict)): + return cls.base_to_dict(result, transform_case) + if isinstance(result, list): + return [cls.serialize_result(row, transform_case) for row in result] + if isinstance(result, Row): + if all(isinstance(row, Base) for row in result): + return [cls.base_to_dict(row, transform_case) for row in result] + if any(isinstance(row, Base) for row in result): + return [cls.serialize_result(row, transform_case) for row in result] + result_dict = result._asdict() + if transform_case == 'snake_to_camel': + return {CamelCaseUtil.snake_to_camel(k): v for k, v in result_dict.items()} + if transform_case == 'camel_to_snake': + return {SnakeCaseUtil.camel_to_snake(k): v for k, v in result_dict.items()} + return result_dict + return result + + @classmethod + def get_server_default_null(cls, dialect_name: str, need_explicit_null: bool = True) -> TextClause | None: + """ + 根据数据库方言动态返回值为null的server_default + + :param dialect_name: 数据库方言名称 + :param need_explicit_null: 是否需要显式DEFAULT NULL + :return: 不同数据库方言对应的null_server_default + """ + if need_explicit_null and dialect_name == 'postgresql': + return null() + return None + + +class CamelCaseUtil: + """ + 下划线形式(snake_case)转小驼峰形式(camelCase)工具方法 + """ + + @classmethod + def snake_to_camel(cls, snake_str: str) -> str: + """ + 下划线形式字符串(snake_case)转换为小驼峰形式字符串(camelCase) + + :param snake_str: 下划线形式字符串 + :return: 小驼峰形式字符串 + """ + # 分割字符串 + words = snake_str.split('_') + # 小驼峰命名,第一个词首字母小写,其余词首字母大写 + return words[0] + ''.join(word.capitalize() for word in words[1:]) + + @classmethod + @overload + def transform_result(cls, result: Base) -> dict[str, Any]: ... + + @classmethod + @overload + def transform_result(cls, result: dict) -> dict[Any, Any]: ... + + @classmethod + @overload + def transform_result(cls, result: Row) -> dict[str, Any] | list[dict[Any, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Base]) -> list[dict[str, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[dict]) -> list[dict[Any, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Row]) -> list[dict[str, Any] | list[dict[Any, Any]]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Any]) -> list[Any]: ... + + @classmethod + @overload + def transform_result(cls, result: Any) -> Any: ... + + @classmethod + def transform_result(cls, result: Any) -> Any: + """ + 针对不同类型将下划线形式(snake_case)批量转换为小驼峰形式(camelCase)方法 + + :param result: 输入数据 + :return: 小驼峰形式结果 + """ + return SqlalchemyUtil.serialize_result(result=result, transform_case='snake_to_camel') + + +class SnakeCaseUtil: + """ + 小驼峰形式(camelCase)转下划线形式(snake_case)工具方法 + """ + + @classmethod + def camel_to_snake(cls, camel_str: str) -> str: + """ + 小驼峰形式字符串(camelCase)转换为下划线形式字符串(snake_case) + + :param camel_str: 小驼峰形式字符串 + :return: 下划线形式字符串 + """ + # 在大写字母前添加一个下划线,然后将整个字符串转为小写 + words = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', camel_str) + return re.sub('([a-z0-9])([A-Z])', r'\1_\2', words).lower() + + @classmethod + @overload + def transform_result(cls, result: Base) -> dict[str, Any]: ... + + @classmethod + @overload + def transform_result(cls, result: dict) -> dict[Any, Any]: ... + + @classmethod + @overload + def transform_result(cls, result: Row) -> dict[str, Any] | list[dict[Any, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Base]) -> list[dict[str, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[dict]) -> list[dict[Any, Any]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Row]) -> list[dict[str, Any] | list[dict[Any, Any]]]: ... + + @classmethod + @overload + def transform_result(cls, result: Sequence[Any]) -> list[Any]: ... + + @classmethod + @overload + def transform_result(cls, result: Any) -> Any: ... + + @classmethod + def transform_result(cls, result: Any) -> Any: + """ + 针对不同类型将小驼峰形式(camelCase)批量转换为下划线形式(snake_case)方法 + + :param result: 输入数据 + :return: 下划线形式结果 + """ + return SqlalchemyUtil.serialize_result(result=result, transform_case='camel_to_snake') + + +def bytes2human(n: int, format_str: str = '%(value).1f%(symbol)s') -> str: + """Used by various scripts. See: + http://goo.gl/zeJZl + + >>> bytes2human(10000) + '9.8K' + >>> bytes2human(100001221) + '95.4M' + """ + symbols = ('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB') + prefix = {} + for i, s in enumerate(symbols[1:]): + prefix[s] = 1 << (i + 1) * 10 + for symbol in reversed(symbols[1:]): + if n >= prefix[symbol]: + value = float(n) / prefix[symbol] + return format_str % locals() + return format_str % {'symbol': symbols[0], 'value': n} + + +def bytes2file_response(bytes_info: bytes) -> Generator[bytes]: + yield bytes_info + + +def export_list2excel(list_data: list) -> bytes: + """ + 工具方法:将需要导出的list数据转化为对应excel的二进制数据 + + :param list_data: 数据列表 + :return: 字典信息对应excel的二进制数据 + """ + df = pd.DataFrame(list_data) + binary_data = io.BytesIO() + df.to_excel(binary_data, index=False, engine='openpyxl') + binary_data = binary_data.getvalue() + + return binary_data + + +def get_excel_template(header_list: list, selector_header_list: list, option_list: list[dict]) -> bytes: + """ + 工具方法:将需要导出的list数据转化为对应excel的二进制数据 + + :param header_list: 表头数据列表 + :param selector_header_list: 需要设置为选择器格式的表头数据列表 + :param option_list: 选择器格式的表头预设的选项列表 + :return: 模板excel的二进制数据 + """ + # 创建Excel工作簿 + wb = Workbook() + # 选择默认的活动工作表 + ws = wb.active + + # 设置表头文字 + headers = header_list + + # 设置表头背景样式为灰色,前景色为白色 + header_fill = PatternFill(start_color='ababab', end_color='ababab', fill_type='solid') + + # 将表头写入第一行 + for col_num, header in enumerate(headers, 1): + cell = ws.cell(row=1, column=col_num) + cell.value = header + cell.fill = header_fill + # 设置列宽度为16 + ws.column_dimensions[chr(64 + col_num)].width = 12 + # 设置水平居中对齐 + cell.alignment = Alignment(horizontal='center') + + # 设置选择器的预设选项 + options = option_list + + # 获取selector_header的字母索引 + for selector_header in selector_header_list: + column_selector_header_index = headers.index(selector_header) + 1 + + # 创建数据有效性规则 + header_option = [] + for option in options: + if option.get(selector_header): + header_option = option.get(selector_header) + dv = DataValidation(type='list', formula1=f'"{",".join(header_option)}"') + # 设置数据有效性规则的起始单元格和结束单元格 + dv.add( + f'{get_column_letter(column_selector_header_index)}2:{get_column_letter(column_selector_header_index)}1048576' + ) + # 添加数据有效性规则到工作表 + ws.add_data_validation(dv) + + # 保存Excel文件为字节类型的数据 + file = io.BytesIO() + wb.save(file) + file.seek(0) + + # 读取字节数据 + excel_data = file.getvalue() + + return excel_data + + +def get_filepath_from_url(url: str) -> str: + """ + 工具方法:根据请求参数获取文件路径 + + :param url: 请求参数中的url参数 + :return: 文件路径 + """ + file_info = url.split('?')[1].split('&') + task_id = file_info[0].split('=')[1] + file_name = file_info[1].split('=')[1] + task_path = file_info[2].split('=')[1] + filepath = os.path.join(CachePathConfig.PATH, task_path, task_id, file_name) + + return filepath diff --git a/shierfeng-fastapi-backend/utils/cron_util.py b/shierfeng-fastapi-backend/utils/cron_util.py new file mode 100644 index 0000000..045f4ea --- /dev/null +++ b/shierfeng-fastapi-backend/utils/cron_util.py @@ -0,0 +1,166 @@ +import re +from datetime import datetime + + +class CronUtil: + """ + Cron表达式工具类 + """ + + ONE_YEAR_LENGTH = 4 + MAX_YEAR = 2099 + CRON_EXPRESSION_LENGTH_MIN = 6 + CRON_EXPRESSION_LENGTH_MAX = 7 + + @classmethod + def __valid_range(cls, search_str: str, start_range: int, end_range: int) -> bool: + match = re.match(r'^(\d+)-(\d+)$', search_str) + if match: + start, end = int(match.group(1)), int(match.group(2)) + return start_range <= start < end <= end_range + return False + + @classmethod + def __valid_sum( + cls, search_str: str, start_range_a: int, start_range_b: int, end_range_a: int, end_range_b: int, sum_range: int + ) -> bool: + match = re.match(r'^(\d+)/(\d+)$', search_str) + if match: + start, end = int(match.group(1)), int(match.group(2)) + return ( + start_range_a <= start <= start_range_b + and end_range_a <= end <= end_range_b + and start + end <= sum_range + ) + return False + + @classmethod + def validate_second_or_minute(cls, second_or_minute: str) -> bool: + """ + 校验秒或分钟值是否正确 + + :param second_or_minute: 秒或分钟值 + :return: 校验结果 + """ + return bool( + second_or_minute == '*' + or ('-' in second_or_minute and cls.__valid_range(second_or_minute, 0, 59)) + or ('/' in second_or_minute and cls.__valid_sum(second_or_minute, 0, 58, 1, 59, 59)) + or re.match(r'^(?:[0-5]?\d|59)(?:,[0-5]?\d|59)*$', second_or_minute) + ) + + @classmethod + def validate_hour(cls, hour: str) -> bool: + """ + 校验小时值是否正确 + + :param hour: 小时值 + :return: 校验结果 + """ + return bool( + hour == '*' + or ('-' in hour and cls.__valid_range(hour, 0, 23)) + or ('/' in hour and cls.__valid_sum(hour, 0, 22, 1, 23, 23)) + or re.match(r'^(?:0|[1-9]|1\d|2[0-3])(?:,(?:0|[1-9]|1\d|2[0-3]))*$', hour) + ) + + @classmethod + def validate_day(cls, day: str) -> bool: + """ + 校验日值是否正确 + + :param day: 日值 + :return: 校验结果 + """ + return bool( + day in ['*', '?', 'L'] + or ('-' in day and cls.__valid_range(day, 1, 31)) + or ('/' in day and cls.__valid_sum(day, 1, 30, 1, 30, 31)) + or ('W' in day and re.match(r'^(?:[1-9]|1\d|2\d|3[01])W$', day)) + or re.match(r'^(?:0|[1-9]|1\d|2[0-9]|3[0-1])(?:,(?:0|[1-9]|1\d|2[0-9]|3[0-1]))*$', day) + ) + + @classmethod + def validate_month(cls, month: str) -> bool: + """ + 校验月值是否正确 + + :param month: 月值 + :return: 校验结果 + """ + return bool( + month == '*' + or ('-' in month and cls.__valid_range(month, 1, 12)) + or ('/' in month and cls.__valid_sum(month, 1, 11, 1, 11, 12)) + or re.match(r'^(?:0|[1-9]|1[0-2])(?:,(?:0|[1-9]|1[0-2]))*$', month) + ) + + @classmethod + def validate_week(cls, week: str) -> bool: + """ + 校验周值是否正确 + + :param week: 周值 + :return: 校验结果 + """ + return bool( + week in ['*', '?'] + or ('-' in week and cls.__valid_range(week, 1, 7)) + or ('#' in week and re.match(r'^[1-7]#[1-4]$', week)) + or ('L' in week and re.match(r'^[1-7]L$', week)) + or re.match(r'^[1-7](?:(,[1-7]))*$', week) + ) + + @classmethod + def validate_year(cls, year: str) -> bool: + """ + 校验年值是否正确 + + :param year: 年值 + :return: 校验结果 + """ + current_year = int(datetime.now().year) + future_years = [current_year + i for i in range(9)] + return bool( + year == '*' + or ('-' in year and cls.__valid_range(year, current_year, 2099)) + or ('/' in year and cls.__valid_sum(year, current_year, 2098, 1, 2099 - current_year, 2099)) + or ('#' in year and re.match(r'^[1-7]#[1-4]$', year)) + or ('L' in year and re.match(r'^[1-7]L$', year)) + or ( + (len(year) == cls.ONE_YEAR_LENGTH or ',' in year) + and all( + int(item) in future_years and current_year <= int(item) <= cls.MAX_YEAR for item in year.split(',') + ) + ) + ) + + @classmethod + def validate_cron_expression(cls, cron_expression: str) -> bool: + """ + 校验Cron表达式是否正确 + + :param cron_expression: Cron表达式 + :return: 校验结果 + """ + values = cron_expression.split() + if len(values) != cls.CRON_EXPRESSION_LENGTH_MIN and len(values) != cls.CRON_EXPRESSION_LENGTH_MAX: + return False + second_validation = cls.validate_second_or_minute(values[0]) + minute_validation = cls.validate_second_or_minute(values[1]) + hour_validation = cls.validate_hour(values[2]) + day_validation = cls.validate_day(values[3]) + month_validation = cls.validate_month(values[4]) + week_validation = cls.validate_week(values[5]) + validation = ( + second_validation + and minute_validation + and hour_validation + and day_validation + and month_validation + and week_validation + ) + if len(values) == cls.CRON_EXPRESSION_LENGTH_MIN: + return validation + year_validation = cls.validate_year(values[6]) + return validation and year_validation diff --git a/shierfeng-fastapi-backend/utils/crypto_util.py b/shierfeng-fastapi-backend/utils/crypto_util.py new file mode 100644 index 0000000..8dc1229 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/crypto_util.py @@ -0,0 +1,58 @@ +import base64 +import hashlib + +from cryptography.fernet import Fernet + +from config.env import JwtConfig +from exceptions.exception import ServiceException + + +class CryptoUtil: + """ + 加解密工具类 + """ + + _cipher_suite = None + + @classmethod + def _get_cipher_suite(cls) -> Fernet: + if cls._cipher_suite is None: + # 使用 JWT secret key 派生 Fernet key + # SHA256 hash (32 bytes) -> Base64 encoded (44 bytes) -> Fernet key + key = base64.urlsafe_b64encode(hashlib.sha256(JwtConfig.jwt_secret_key.encode()).digest()) + cls._cipher_suite = Fernet(key) + return cls._cipher_suite + + @classmethod + def encrypt(cls, data: str) -> str: + """ + 加密字符串 + + :param data: 明文 + :return: 密文 + """ + if not data: + return data + try: + cipher_suite = cls._get_cipher_suite() + encrypted_bytes = cipher_suite.encrypt(data.encode('utf-8')) + return encrypted_bytes.decode('utf-8') + except Exception as e: + raise ServiceException('加密失败') from e + + @classmethod + def decrypt(cls, token: str) -> str: + """ + 解密字符串 + + :param token: 密文 + :return: 明文 + """ + if not token: + return token + try: + cipher_suite = cls._get_cipher_suite() + decrypted_bytes = cipher_suite.decrypt(token.encode('utf-8')) + return decrypted_bytes.decode('utf-8') + except Exception as e: + raise ServiceException('解密失败') from e diff --git a/shierfeng-fastapi-backend/utils/dependency_util.py b/shierfeng-fastapi-backend/utils/dependency_util.py new file mode 100644 index 0000000..23ace9d --- /dev/null +++ b/shierfeng-fastapi-backend/utils/dependency_util.py @@ -0,0 +1,49 @@ +from fastapi import Request + +from common.context import RequestContext +from config.env import AppConfig +from exceptions.exception import PermissionException + + +class DependencyUtil: + """ + 依赖项工具类 + """ + + @classmethod + def check_exclude_routes(cls, request: Request, err_msg: str = '当前路由不在认证规则内,不可使用该依赖项') -> None: + """ + 检查路径和方法是否匹配排除路由模式 + + :param request: 请求对象 + :param err_msg: 错误信息 + :return: None + """ + # 获取当前请求路径和方法 + path = request.url.path + method = request.method.upper() + + # 从配置中获取APP_ROOT_PATH + app_root_path = AppConfig.app_root_path + + # 去掉APP_ROOT_PATH前缀 + if app_root_path and path.startswith(app_root_path): + path = path[len(app_root_path) :] + + # 获取编译后的排除路由模式列表 + exclude_patterns = RequestContext.get_current_exclude_patterns() + + # 检查当前路由是否在排除路由列表中 + if path and method and exclude_patterns: + for item in exclude_patterns: + pattern = item['pattern'] + exclude_methods = item['methods'] + ignore_paths = item['ignore_paths'] + + # 检查当前路径是否在忽略列表中 + if path in ignore_paths: + continue + + # 检查路径是否匹配,并且methods为空列表(匹配所有方法)或者当前方法在允许列表中 + if pattern.match(path) and (not exclude_methods or method in exclude_methods): + raise PermissionException(data='', message=err_msg) diff --git a/shierfeng-fastapi-backend/utils/excel_util.py b/shierfeng-fastapi-backend/utils/excel_util.py new file mode 100644 index 0000000..07168d1 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/excel_util.py @@ -0,0 +1,104 @@ +import io + +import pandas as pd +from openpyxl import Workbook +from openpyxl.styles import Alignment, PatternFill +from openpyxl.utils import get_column_letter +from openpyxl.worksheet.datavalidation import DataValidation + + +class ExcelUtil: + """ + Excel操作类 + """ + + @classmethod + def __mapping_list(cls, list_data: list, mapping_dict: dict) -> list[dict]: + """ + 工具方法:将list数据中的字段名映射为对应的中文字段名 + + :param list_data: 数据列表 + :param mapping_dict: 映射字典 + :return: 映射后的数据列表 + """ + mapping_data = [{mapping_dict.get(key): item.get(key) for key in mapping_dict} for item in list_data] + + return mapping_data + + @classmethod + def export_list2excel(cls, list_data: list, mapping_dict: dict) -> bytes: + """ + 工具方法:将需要导出的list数据转化为对应excel的二进制数据 + + :param list_data: 数据列表 + :param mapping_dict: 映射字典 + :return: list数据对应excel的二进制数据 + """ + mapping_data = cls.__mapping_list(list_data, mapping_dict) + df = pd.DataFrame(mapping_data) + binary_data = io.BytesIO() + df.to_excel(binary_data, index=False, engine='openpyxl') + binary_data = binary_data.getvalue() + + return binary_data + + @classmethod + def get_excel_template(cls, header_list: list, selector_header_list: list, option_list: list[dict]) -> bytes: + """ + 工具方法:将需要导出的list数据转化为对应excel的二进制数据 + + :param header_list: 表头数据列表 + :param selector_header_list: 需要设置为选择器格式的表头数据列表 + :param option_list: 选择器格式的表头预设的选项列表 + :return: 模板excel的二进制数据 + """ + # 创建Excel工作簿 + wb = Workbook() + # 选择默认的活动工作表 + ws = wb.active + + # 设置表头文字 + headers = header_list + + # 设置表头背景样式为灰色,前景色为白色 + header_fill = PatternFill(start_color='ababab', end_color='ababab', fill_type='solid') + + # 将表头写入第一行 + for col_num, header in enumerate(headers, 1): + cell = ws.cell(row=1, column=col_num) + cell.value = header + cell.fill = header_fill + # 设置列宽度为16 + ws.column_dimensions[chr(64 + col_num)].width = 12 + # 设置水平居中对齐 + cell.alignment = Alignment(horizontal='center') + + # 设置选择器的预设选项 + options = option_list + + # 获取selector_header的字母索引 + for selector_header in selector_header_list: + column_selector_header_index = headers.index(selector_header) + 1 + + # 创建数据有效性规则 + header_option = [] + for option in options: + if option.get(selector_header): + header_option = option.get(selector_header) + dv = DataValidation(type='list', formula1=f'"{",".join(header_option)}"') + # 设置数据有效性规则的起始单元格和结束单元格 + dv.add( + f'{get_column_letter(column_selector_header_index)}2:{get_column_letter(column_selector_header_index)}1048576' + ) + # 添加数据有效性规则到工作表 + ws.add_data_validation(dv) + + # 保存Excel文件为字节类型的数据 + file = io.BytesIO() + wb.save(file) + file.seek(0) + + # 读取字节数据 + excel_data = file.getvalue() + + return excel_data diff --git a/shierfeng-fastapi-backend/utils/gen_util.py b/shierfeng-fastapi-backend/utils/gen_util.py new file mode 100644 index 0000000..487137d --- /dev/null +++ b/shierfeng-fastapi-backend/utils/gen_util.py @@ -0,0 +1,226 @@ +import re +from datetime import datetime + +from common.constant import GenConstant +from config.env import GenConfig +from module_generator.entity.vo.gen_vo import GenTableColumnModel, GenTableModel +from utils.string_util import StringUtil + + +class GenUtils: + """代码生成器工具类""" + + TEXTAREA_COLUMN_LENGTH = 500 + + @classmethod + def init_table(cls, gen_table: GenTableModel, oper_name: str) -> None: + """ + 初始化表信息 + + param gen_table: 业务表对象 + param oper_name: 操作人 + :return: + """ + gen_table.class_name = cls.convert_class_name(gen_table.table_name) + gen_table.package_name = GenConfig.package_name + gen_table.module_name = cls.get_module_name(GenConfig.package_name) + gen_table.business_name = cls.get_business_name(gen_table.table_name) + gen_table.function_name = cls.replace_text(gen_table.table_comment) + gen_table.function_author = GenConfig.author + gen_table.create_by = oper_name + gen_table.create_time = datetime.now() + gen_table.update_by = oper_name + gen_table.update_time = datetime.now() + + @classmethod + def init_column_field(cls, column: GenTableColumnModel, table: GenTableModel) -> None: + """ + 初始化列属性字段 + + param column: 业务表字段对象 + param table: 业务表对象 + :return: + """ + data_type = cls.get_db_type(column.column_type) + column_name = column.column_name + column.table_id = table.table_id + column.create_by = table.create_by + # 设置Python字段名 + column.python_field = cls.to_camel_case(column_name) + # 设置默认类型 + column.python_type = StringUtil.get_mapping_value_by_key_ignore_case( + GenConstant.DB_TO_PYTHON_TYPE_MAPPING, data_type + ) + column.query_type = GenConstant.QUERY_EQ + + if cls.arrays_contains(GenConstant.COLUMNTYPE_STR, data_type) or cls.arrays_contains( + GenConstant.COLUMNTYPE_TEXT, data_type + ): + # 字符串长度超过500设置为文本域 + column_length = cls.get_column_length(column.column_type) + html_type = ( + GenConstant.HTML_TEXTAREA + if column_length >= cls.TEXTAREA_COLUMN_LENGTH + or cls.arrays_contains(GenConstant.COLUMNTYPE_TEXT, data_type) + else GenConstant.HTML_INPUT + ) + column.html_type = html_type + elif cls.arrays_contains(GenConstant.COLUMNTYPE_TIME, data_type): + column.html_type = GenConstant.HTML_DATETIME + elif cls.arrays_contains(GenConstant.COLUMNTYPE_NUMBER, data_type): + column.html_type = GenConstant.HTML_INPUT + + # 插入字段(默认所有字段都需要插入) + column.is_insert = GenConstant.REQUIRE + + # 编辑字段 + if not cls.arrays_contains(GenConstant.COLUMNNAME_NOT_EDIT, column_name) and not column.pk: + column.is_edit = GenConstant.REQUIRE + # 列表字段 + if not cls.arrays_contains(GenConstant.COLUMNNAME_NOT_LIST, column_name) and not column.pk: + column.is_list = GenConstant.REQUIRE + # 查询字段 + if not cls.arrays_contains(GenConstant.COLUMNNAME_NOT_QUERY, column_name) and not column.pk: + column.is_query = GenConstant.REQUIRE + + # 查询字段类型 + if column_name.lower().endswith('name'): + column.query_type = GenConstant.QUERY_LIKE + # 状态字段设置单选框 + if column_name.lower().endswith('status'): + column.html_type = GenConstant.HTML_RADIO + # 类型&性别字段设置下拉框 + elif column_name.lower().endswith('type') or column_name.lower().endswith('sex'): + column.html_type = GenConstant.HTML_SELECT + # 图片字段设置图片上传控件 + elif column_name.lower().endswith('image'): + column.html_type = GenConstant.HTML_IMAGE_UPLOAD + # 文件字段设置文件上传控件 + elif column_name.lower().endswith('file'): + column.html_type = GenConstant.HTML_FILE_UPLOAD + # 内容字段设置富文本控件 + elif column_name.lower().endswith('content'): + column.html_type = GenConstant.HTML_EDITOR + + column.create_by = table.create_by + column.create_time = datetime.now() + column.update_by = table.update_by + column.update_time = datetime.now() + + @classmethod + def arrays_contains(cls, arr: list[str], target_value: str) -> bool: + """ + 校验数组是否包含指定值 + + param arr: 数组 + param target_value: 需要校验的值 + :return: 校验结果 + """ + return target_value in arr + + @classmethod + def get_module_name(cls, package_name: str) -> str: + """ + 获取模块名 + + param package_name: 包名 + :return: 模块名 + """ + return package_name.rsplit('.', maxsplit=1)[-1] + + @classmethod + def get_business_name(cls, table_name: str) -> str: + """ + 获取业务名 + + param table_name: 业务表名 + :return: 业务名 + """ + return table_name.rsplit('_', maxsplit=1)[-1] + + @classmethod + def convert_class_name(cls, table_name: str) -> str: + """ + 表名转换成Python类名 + + param table_name: 业务表名 + :return: Python类名 + """ + auto_remove_pre = GenConfig.auto_remove_pre + table_prefix = GenConfig.table_prefix + if auto_remove_pre and table_prefix: + search_list = table_prefix.split(',') + table_name = cls.replace_first(table_name, search_list) + return StringUtil.convert_to_camel_case(table_name) + + @classmethod + def replace_first(cls, replacement: str, search_list: list[str]) -> str: + """ + 批量替换前缀 + + param replacement: 需要被替换的字符串 + param search_list: 可替换的字符串列表 + :return: 替换后的字符串 + """ + for search_string in search_list: + if replacement.startswith(search_string): + return replacement.replace(search_string, '', 1) + return replacement + + @classmethod + def replace_text(cls, text: str) -> str: + """ + 关键字替换 + + param text: 需要被替换的字符串 + :return: 替换后的字符串 + """ + return re.sub(r'(?:表|施尔丰)', '', text) + + @classmethod + def get_db_type(cls, column_type: str) -> str: + """ + 获取数据库类型字段 + + param column_type: 字段类型 + :return: 数据库类型 + """ + if '(' in column_type: + return column_type.split('(', maxsplit=1)[0] + return column_type + + @classmethod + def get_column_length(cls, column_type: str) -> int: + """ + 获取字段长度 + + param column_type: 字段类型 + :return: 字段长度 + """ + if '(' in column_type: + length = len(column_type.split('(')[1].split(')', maxsplit=1)[0]) + return length + return 0 + + @classmethod + def split_column_type(cls, column_type: str) -> list[str]: + """ + 拆分列类型 + + param column_type: 字段类型 + :return: 拆分结果 + """ + if '(' in column_type and ')' in column_type: + return column_type.split('(')[1].split(')', maxsplit=1)[0].split(',') + return [] + + @classmethod + def to_camel_case(cls, text: str) -> str: + """ + 将字符串转换为驼峰命名 + + param text: 需要转换的字符串 + :return: 驼峰命名 + """ + parts = text.split('_') + return parts[0] + ''.join(word.capitalize() for word in parts[1:]) diff --git a/shierfeng-fastapi-backend/utils/import_util.py b/shierfeng-fastapi-backend/utils/import_util.py new file mode 100644 index 0000000..c349e9c --- /dev/null +++ b/shierfeng-fastapi-backend/utils/import_util.py @@ -0,0 +1,123 @@ +import importlib +import inspect +import os +import sys +from functools import lru_cache +from pathlib import Path +from typing import Any + +from sqlalchemy import inspect as sa_inspect + +from config.database import Base + + +class ImportUtil: + @classmethod + def find_project_root(cls) -> Path: + """ + 查找项目根目录 + + :return: 项目根目录路径 + """ + current_dir = Path(__file__).resolve().parent + while current_dir != current_dir.parent: + if any(current_dir.joinpath(file).exists() for file in ['setup.py', 'pyproject.toml', 'requirements.txt']): + return current_dir + current_dir = current_dir.parent + return Path(__file__).resolve().parent + + @classmethod + def is_valid_model(cls, obj: Any, base_class: Base) -> bool: + """ + 验证是否为有效的SQLAlchemy模型类 + + :param obj: 待验证的对象 + :param base_class: SQLAlchemy的Base类 + :return: 验证结果 + """ + # 必须继承自Base且不是Base本身 + if not (inspect.isclass(obj) and issubclass(obj, base_class) and obj is not base_class): + return False + + # 必须有表名定义(排除抽象基类) + if not hasattr(obj, '__tablename__') or obj.__tablename__ is None: + return False + + # 必须有至少一个列定义 + try: + return len(sa_inspect(obj).columns) > 0 + except Exception: + return False + + @classmethod + @lru_cache(maxsize=256) + def find_models(cls, base_class: Base) -> list[Base]: + """ + 查找并过滤有效的模型类,避免重复和无效定义 + + :param base_class: SQLAlchemy的Base类,用于验证模型类 + :return: 有效模型类列表 + """ + models = [] + # 按类对象去重 + seen_models = set() + # 按表名去重(防止同表名冲突) + seen_tables = set() + project_root = cls.find_project_root() + + sys.path.append(str(project_root)) + print(f'⏰️ 开始在项目根目录 {project_root} 中查找模型...') + + # 排除目录扩展 + exclude_dirs = { + 'venv', + '.env', + '.git', + '__pycache__', + 'migrations', + 'alembic', + 'tests', + 'test', + 'docs', + 'examples', + 'scripts', + } + + for root, dirs, files in os.walk(project_root): + dirs[:] = [d for d in dirs if d not in exclude_dirs] + + for file in files: + if file.endswith('.py') and not file.startswith('__'): + relative_path = Path(root).relative_to(project_root) + module_parts = [*list(relative_path.parts), file[:-3]] + module_name = '.'.join(module_parts) + + try: + module = importlib.import_module(module_name) + + for _name, obj in inspect.getmembers(module, inspect.isclass): + # 验证模型有效性 + if not cls.is_valid_model(obj, base_class): + continue + + # 检查类对象重复 + if obj in seen_models: + continue + + # 检查表名重复 + table_name = obj.__tablename__ + if table_name in seen_tables: + continue + + seen_models.add(obj) + seen_tables.add(table_name) + models.append(obj) + print(f'✅️ 找到有效模型: {obj.__module__}.{obj.__name__} (表: {table_name})') + + except ImportError as e: + if 'cannot import name' not in str(e): + print(f'❗️ 警告: 无法导入模块 {module_name}: {e}') + except Exception as e: + print(f'❌️ 处理模块 {module_name} 时出错: {e}') + + return models diff --git a/shierfeng-fastapi-backend/utils/log_util.py b/shierfeng-fastapi-backend/utils/log_util.py new file mode 100644 index 0000000..299f2d9 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/log_util.py @@ -0,0 +1,675 @@ +import ast +import json +import logging +import os +import re +import sys +import traceback +from collections.abc import Mapping, Sequence +from typing import Any + +from loguru import logger as _logger +from loguru._logger import Logger + +from config.env import AppConfig, LogConfig +from middlewares.trace_middleware import TraceCtx +from utils.server_util import WorkerIdUtil + + +def _split_field_tokens(field_name: str) -> tuple[str, ...]: + """ + 拆分字段名为文本匹配用的 token + + :param field_name: 原始字段名 + :return: token 元组 + """ + separated_name = re.sub(r'([a-z0-9])([A-Z])', r'\1 \2', field_name) + normalized_name = re.sub(r'[^A-Za-z0-9]+', ' ', separated_name) + return tuple(token.lower() for token in normalized_name.split() if token) + + +def _build_text_key_pattern(field_name: str) -> str: + """ + 构建文本日志中的字段名匹配正则,自动兼容 snake_case / camelCase / kebab-case / dot.case + + :param field_name: 原始字段名 + :return: 正则片段 + """ + tokens = _split_field_tokens(field_name) + if not tokens: + return re.escape(field_name) + return r'[^\S\r\n._-]*[._-]*[^\S\r\n._-]*'.join(re.escape(token) for token in tokens) + + +def _build_text_assignment_patterns(key_pattern: str) -> list[re.Pattern[str]]: + """ + 构建文本日志中的键值对匹配正则 + + :param key_pattern: 字段名正则片段 + :return: 正则列表 + """ + if not key_pattern: + return [] + return [ + re.compile( + rf'(?P(?P[\'"]?)(?P(?:{key_pattern}))(?P=key_quote)\s*[:=]\s*)' + r'(?P[\'"])(?P.*?)(?P=quote)', + re.IGNORECASE, + ), + re.compile( + rf'(?P(?P[\'"]?)(?P(?:{key_pattern}))(?P=key_quote)\s*[:=]\s*)' + r'(?P[\'"]?)(?P[^\'"\s,;]+)(?P=quote)', + re.IGNORECASE, + ), + ] + + +class LogSanitizer: + """ + 日志脱敏工具 + """ + + _MASK = LogConfig.log_mask_placeholder + _PHONE_MIN_LENGTH = 7 + _PHONE_PREFIX_LENGTH = 3 + _PHONE_SUFFIX_LENGTH = 4 + _EMAIL_SHORT_LOCAL_LENGTH = 2 + _IPV4_PARTS = 4 + _IPV4_VISIBLE_PARTS = 3 + _IPV6_MASK_THRESHOLD = 2 + _IPV6_VISIBLE_PARTS = 2 + _SENSITIVE_FIELDS = { + re.sub(r'[^a-z0-9]', '', item.lower()) + for item in (field.strip() for field in LogConfig.log_mask_fields.split(',')) + if item + } + _TEXT_SENSITIVE_FIELDS = tuple(field.strip() for field in LogConfig.log_mask_fields.split(',') if field.strip()) + _TEXT_SENSITIVE_KEY_PATTERN = '|'.join( + sorted({_build_text_key_pattern(field_name) for field_name in _TEXT_SENSITIVE_FIELDS}, key=len, reverse=True) + ) + _PARTIAL_MASK_FIELDS = { + re.sub(r'[^a-z0-9]', '', item.lower()) + for item in (field.strip() for field in LogConfig.log_partial_mask_fields.split(',')) + if item + } + _TEXT_PARTIAL_FIELDS = tuple( + field.strip() for field in LogConfig.log_partial_mask_fields.split(',') if field.strip() + ) + _TEXT_PARTIAL_KEY_PATTERN = '|'.join( + sorted({_build_text_key_pattern(field_name) for field_name in _TEXT_PARTIAL_FIELDS}, key=len, reverse=True) + ) + _CONFIG_SECRET_PATTERNS = [ + re.compile(pattern.strip(), re.IGNORECASE) + for pattern in LogConfig.log_config_secret_patterns.split(',') + if pattern.strip() + ] + _KV_PATTERNS = [ + re.compile( + r'(?Pauthorization\s*[:=]\s*)(?P[\'"]?)(?Pbearer\s+[^\s\'",;]+|[^\s\'",;]+)(?P=quote)', + re.IGNORECASE, + ), + *_build_text_assignment_patterns(_TEXT_SENSITIVE_KEY_PATTERN), + re.compile(r'(?PBearer\s+)(?P[A-Za-z0-9\-._~+/]+=*)', re.IGNORECASE), + ] + _PARTIAL_KV_PATTERNS = _build_text_assignment_patterns(_TEXT_PARTIAL_KEY_PATTERN) + _LOGIN_CODE_PATTERN = re.compile(r'^[A-Za-z0-9]{4,8}$') + + @classmethod + def sanitize_data(cls, data: Any, field_name: str | None = None) -> Any: + """ + 对日志数据进行脱敏 + + :param data: 原始日志数据 + :param field_name: 当前字段名 + :return: 脱敏后的数据 + """ + if not LogConfig.log_mask_enabled: + return data + if data is None: + return None + if hasattr(data, 'model_dump'): + return cls.sanitize_data(data.model_dump(by_alias=True, exclude_none=True), field_name) + if isinstance(data, Mapping): + return cls._sanitize_mapping(data) + if isinstance(data, str): + return cls._sanitize_string(data, field_name) + if isinstance(data, bytes): + return f'' + if isinstance(data, Sequence) and not isinstance(data, (str, bytes, bytearray)): + return [cls.sanitize_data(item, field_name) for item in data] + return data + + @classmethod + def sanitize_text(cls, text: str) -> str: + """ + 对普通文本日志进行脱敏 + + :param text: 原始文本 + :return: 脱敏后的文本 + """ + if not LogConfig.log_mask_enabled: + return text + if not isinstance(text, str): + return text + sanitized_text = cls._sanitize_string(text) + return sanitized_text if isinstance(sanitized_text, str) else json.dumps(sanitized_text, ensure_ascii=False) + + @classmethod + def _sanitize_mapping(cls, data: Mapping[Any, Any]) -> dict[Any, Any]: + """ + 对字典类型数据进行脱敏 + + :param data: 字典数据 + :return: 脱敏后的字典 + """ + sanitized: dict[Any, Any] = {} + normalized_map = {cls._normalize_key(str(key)): value for key, value in data.items()} + + for key, value in data.items(): + key_str = str(key) + normalized_key = cls._normalize_key(key_str) + if cls._should_fully_mask_field(normalized_key, value, normalized_map): + sanitized[key] = cls._MASK + elif normalized_key in cls._PARTIAL_MASK_FIELDS and isinstance(value, str): + sanitized[key] = cls._mask_partial_value(value, normalized_key) + else: + sanitized[key] = cls.sanitize_data(value, key_str) + + config_key = normalized_map.get('configkey') + if isinstance(config_key, str) and cls._is_secret_config_key(config_key): + for key in data: + if cls._normalize_key(str(key)) == 'configvalue': + sanitized[key] = cls._MASK + + return sanitized + + @classmethod + def _sanitize_string(cls, value: str, field_name: str | None = None) -> Any: + """ + 对字符串数据进行脱敏 + + :param value: 字符串值 + :param field_name: 当前字段名 + :return: 脱敏后的字符串或结构化数据 + """ + normalized_field = cls._normalize_key(field_name or '') + if normalized_field in cls._SENSITIVE_FIELDS: + return cls._MASK + if normalized_field in cls._PARTIAL_MASK_FIELDS: + return cls._mask_partial_value(value, normalized_field) + + stripped_value = value.strip() + if stripped_value and stripped_value[0] in '{[': + try: + parsed_value = json.loads(value) + except (TypeError, ValueError, json.JSONDecodeError): + try: + parsed_value = ast.literal_eval(value) + except (SyntaxError, ValueError): + pass + else: + return cls._dump_sanitized_structured_text( + cls.sanitize_data(parsed_value, field_name), + original_text=value, + ) + else: + return cls._dump_sanitized_structured_text( + cls.sanitize_data(parsed_value, field_name), + original_text=value, + ) + + sanitized_text = value + for pattern in cls._KV_PATTERNS: + sanitized_text = pattern.sub(cls._replace_text_secret, sanitized_text) + for pattern in cls._PARTIAL_KV_PATTERNS: + sanitized_text = pattern.sub(cls._replace_text_partial_secret, sanitized_text) + + if '验证码' in sanitized_text: + sanitized_text = re.sub(r'(验证码(?:为|是)?\s*)([A-Za-z0-9]{4,8})', rf'\1{cls._MASK}', sanitized_text) + + return sanitized_text + + @classmethod + def _replace_text_secret(cls, match: re.Match[str]) -> str: + """ + 替换文本中的敏感值 + + :param match: 正则匹配对象 + :return: 脱敏后的文本 + """ + prefix = match.group('prefix') + quote = match.groupdict().get('quote', '') + if quote is None: + quote = '' + return f'{prefix}{quote}{cls._MASK}{quote}' + + @classmethod + def _replace_text_partial_secret(cls, match: re.Match[str]) -> str: + """ + 替换文本中的部分脱敏字段值 + + :param match: 正则匹配对象 + :return: 脱敏后的文本 + """ + prefix = match.group('prefix') + quote = match.groupdict().get('quote', '') + if quote is None: + quote = '' + normalized_key = cls._normalize_key(match.groupdict().get('key', '')) + masked_value = cls._mask_partial_value(match.group('value'), normalized_key) + return f'{prefix}{quote}{masked_value}{quote}' + + @staticmethod + def _dump_sanitized_structured_text(sanitized_value: Any, original_text: str) -> Any: + """ + 将脱敏后的结构化数据恢复为文本,并尽量保持原始换行风格 + + :param sanitized_value: 脱敏后的结构化数据 + :param original_text: 原始文本 + :return: 文本或原始值 + """ + if isinstance(sanitized_value, (dict, list)): + indent = 2 if '\n' in original_text or '\r' in original_text else None + return json.dumps(sanitized_value, ensure_ascii=False, indent=indent) + return sanitized_value + + @classmethod + def _should_fully_mask_field( + cls, normalized_key: str, value: Any, full_mapping: Mapping[str, Any] | None = None + ) -> bool: + """ + 判断字段是否需要全量脱敏 + + :param normalized_key: 标准化后的字段名 + :param value: 字段值 + :param full_mapping: 当前层级的完整字段映射 + :return: 是否需要全量脱敏 + """ + if normalized_key in cls._SENSITIVE_FIELDS: + return True + if normalized_key in {'captchacode', 'smscode'}: + return True + if normalized_key == 'code' and isinstance(value, str): + sibling_keys = set((full_mapping or {}).keys()) + if 'uuid' in sibling_keys and cls._LOGIN_CODE_PATTERN.fullmatch(value): + return True + return False + + @classmethod + def _is_secret_config_key(cls, config_key: str) -> bool: + """ + 判断参数键是否属于敏感配置 + + :param config_key: 参数键 + :return: 是否敏感 + """ + return any(pattern.search(config_key) for pattern in cls._CONFIG_SECRET_PATTERNS) + + @classmethod + def _mask_partial_value(cls, value: str, normalized_field: str) -> str: + """ + 对部分字段进行部分脱敏 + + :param value: 原始值 + :param normalized_field: 标准化后的字段名 + :return: 脱敏后的值 + """ + if normalized_field in {'phonenumber', 'phone', 'mobile'}: + return cls._mask_phone(value) + if normalized_field == 'email': + return cls._mask_email(value) + if normalized_field in {'ip', 'ipaddr', 'operip', 'loginip'}: + return cls._mask_ip(value) + return cls._MASK + + @staticmethod + def _normalize_key(field_name: str) -> str: + """ + 标准化字段名 + + :param field_name: 原始字段名 + :return: 标准化字段名 + """ + return re.sub(r'[^a-z0-9]', '', field_name.lower()) + + @classmethod + def _mask_phone(cls, value: str) -> str: + """ + 手机号脱敏 + + :param value: 原始手机号 + :return: 脱敏后的手机号 + """ + digits = re.sub(r'\D', '', value) + if len(digits) < cls._PHONE_MIN_LENGTH: + return cls._MASK + return f'{digits[: cls._PHONE_PREFIX_LENGTH]}****{digits[-cls._PHONE_SUFFIX_LENGTH :]}' + + @classmethod + def _mask_email(cls, value: str) -> str: + """ + 邮箱脱敏 + + :param value: 原始邮箱 + :return: 脱敏后的邮箱 + """ + if '@' not in value: + return cls._MASK + local_part, domain = value.split('@', 1) + masked_local = ( + f'{local_part[:1]}***' + if len(local_part) <= cls._EMAIL_SHORT_LOCAL_LENGTH + else f'{local_part[:1]}***{local_part[-1:]}' + ) + return f'{masked_local}@{domain}' + + @classmethod + def _mask_ip(cls, value: str) -> str: + """ + IP地址脱敏 + + :param value: 原始IP + :return: 脱敏后的IP + """ + if '.' in value: + parts = value.split('.') + if len(parts) == cls._IPV4_PARTS: + return '.'.join([*parts[: cls._IPV4_VISIBLE_PARTS], '*']) + if ':' in value: + parts = value.split(':') + if len(parts) > cls._IPV6_MASK_THRESHOLD: + return ':'.join([*parts[: cls._IPV6_VISIBLE_PARTS], '*', '*']) + return cls._MASK + + +class InterceptHandler(logging.Handler): + target_logger = _logger + + def emit(self, record: logging.LogRecord) -> None: + """ + 拦截标准 logging 记录并转发到 Loguru + + :param record: 原生 logging 日志记录 + :return: None + """ + try: + level = self.target_logger.level(record.levelname).name + except ValueError: + level = record.levelno + frame, depth = logging.currentframe(), 2 + while frame and frame.f_code.co_filename == logging.__file__: + frame = frame.f_back + depth += 1 + self.target_logger.opt(depth=depth, exception=record.exc_info).log(level, record.getMessage()) + + +class LoggerInitializer: + def __init__(self) -> None: + """ + 初始化日志基础配置与运行时标识 + + :return: None + """ + self.worker_id = WorkerIdUtil.get_worker_id(LogConfig.log_worker_id) + self.instance_id = LogConfig.log_instance_id + self.service_name = LogConfig.log_service_name or AppConfig.app_name + self._log_file_enabled = LogConfig.log_file_enabled + self._log_base_dir = LogConfig.log_file_base_dir + self._ensure_log_directory_exists() + + def _ensure_log_directory_exists(self) -> None: + """ + 确保日志目录存在 + + :return: None + """ + if not self._log_file_enabled: + return + if self._log_base_dir and not os.path.exists(self._log_base_dir): + os.makedirs(self._log_base_dir, exist_ok=True) + + def _filter(self, record: dict) -> bool: + """ + 注入 Trace 上下文并控制启动阶段日志输出 + + :param record: Loguru 日志记录字典 + :return: 是否允许输出日志 + """ + record['extra']['trace_id'] = TraceCtx.get_trace_id() + record['extra']['request_id'] = TraceCtx.get_request_id() + record['extra']['span_id'] = TraceCtx.get_span_id() + record['extra']['path'] = TraceCtx.get_request_path() + record['extra']['method'] = TraceCtx.get_request_method() + record['extra']['worker_id'] = self.worker_id + record['extra']['instance_id'] = self.instance_id + record['extra']['service'] = self.service_name + startup_phase = record['extra'].get('startup_phase') + startup_log_enabled = record['extra'].get('startup_log_enabled') + record['extra'] = LogSanitizer.sanitize_data(record['extra']) + if startup_phase: + return bool(startup_log_enabled) + return True + + @staticmethod + def _get_exception_value_text(exception: Any) -> str | None: + """ + 获取脱敏后的异常值文本 + + :param exception: Loguru 异常对象 + :return: 脱敏后的异常值文本 + """ + if not exception or not exception.value: + return None + return LogSanitizer.sanitize_text(str(exception.value)) + + def _get_exception_traceback_text(self, exception: Any) -> str | None: + """ + 获取脱敏后的异常堆栈文本 + + :param exception: Loguru 异常对象 + :return: 脱敏后的异常堆栈文本 + """ + if not exception or not exception.traceback: + return None + if isinstance(exception.traceback, str): + traceback_text = exception.traceback + elif exception.type and exception.value: + traceback_text = ''.join(traceback.format_exception(exception.type, exception.value, exception.traceback)) + else: + traceback_text = str(exception.traceback) + return LogSanitizer.sanitize_text(traceback_text.rstrip()) + + def _build_plain_exception_suffix(self, record: dict) -> str: + """ + 构建普通文本日志使用的异常后缀 + + :param record: Loguru 日志记录字典 + :return: 异常后缀文本 + """ + exception_text = self._get_exception_traceback_text(record.get('exception')) + return f'\n{exception_text}' if exception_text else '' + + def _build_json_payload(self, record: dict) -> dict: + """ + 构建统一的 JSON 日志结构 + + :param record: Loguru 日志记录字典 + :return: JSON 日志结构 + """ + exception = None + if record['exception']: + exception = { + 'type': record['exception'].type.__name__ if record['exception'].type else None, + 'value': self._get_exception_value_text(record['exception']), + 'traceback': self._get_exception_traceback_text(record['exception']), + } + return { + 'timestamp': record['time'].isoformat(), + 'level': record['level'].name, + 'message': record['message'], + 'logger': record['name'], + 'trace_id': record['extra'].get('trace_id'), + 'request_id': record['extra'].get('request_id'), + 'span_id': record['extra'].get('span_id'), + 'worker_id': record['extra'].get('worker_id'), + 'instance_id': record['extra'].get('instance_id'), + 'service': record['extra'].get('service'), + 'method': record['extra'].get('method'), + 'path': record['extra'].get('path'), + 'module': record['module'], + 'function': record['function'], + 'line': record['line'], + 'exception': exception, + 'extra': {key: value for key, value in record['extra'].items() if key != 'json_payload'}, + } + + def _json_log_formatter(self, record: dict) -> str: + """ + 将 Loguru 日志记录格式化为 JSON 文本 + + :param record: Loguru 日志记录字典 + :return: JSON 格式文本 + """ + record['extra']['json_payload'] = json.dumps(self._build_json_payload(record), ensure_ascii=False, default=str) + return '{extra[json_payload]}\n' + + def _plain_log_formatter(self, record: dict) -> str: + """ + 将 Loguru 日志记录格式化为普通文本,并追加脱敏后的异常堆栈 + + :param record: Loguru 日志记录字典 + :return: 普通文本格式模板 + """ + record['extra']['sanitized_exception'] = self._build_plain_exception_suffix(record) + return ( + '{time:YYYY-MM-DD HH:mm:ss.SSS} | ' + '{extra[trace_id]} | ' + '{extra[span_id]} | ' + '{extra[request_id]} | ' + '{extra[worker_id]} | ' + '{level: <8} | ' + '{name}:{function}:{line} - ' + '{message}{extra[sanitized_exception]}\n' + ) + + def _patch_record(self, record: dict) -> dict: + """ + 在日志落地前统一脱敏 + + :param record: Loguru 日志记录字典 + :return: 脱敏后的日志记录字典 + """ + record['message'] = LogSanitizer.sanitize_text(record['message']) + return record + + def _info_file_filter(self, record: dict) -> bool: + """ + 仅输出 INFO 级别日志到 info 文件 + + :param record: Loguru 日志记录字典 + :return: 是否允许输出日志 + """ + return self._filter(record) and record['level'].name == 'INFO' + + def _error_file_filter(self, record: dict) -> bool: + """ + 输出 WARNING 及以上日志到 error 文件 + + :param record: Loguru 日志记录字典 + :return: 是否允许输出日志 + """ + return self._filter(record) and record['level'].no >= logging.WARNING + + def _configure_logging(self) -> None: + """ + 统一接管标准 logging 与第三方日志输出 + + :return: None + """ + logging.basicConfig(handlers=[InterceptHandler()], level=0, force=True) + for logger_name in ('uvicorn', 'uvicorn.error', 'uvicorn.access', 'fastapi'): + logging.getLogger(logger_name).handlers = [InterceptHandler()] + logging.getLogger(logger_name).propagate = False + for logger_name in ('LiteLLM', 'litellm'): + logging.getLogger(logger_name).setLevel(logging.WARNING) + + def init_log(self) -> Logger: + """ + 初始化 Loguru 输出与标准 logging 配置 + + :return: 已配置的 Loguru Logger 实例 + """ + configured_logger = _logger.patch(self._patch_record) + InterceptHandler.target_logger = configured_logger + configured_logger.remove() + info_log_path = os.path.join(self._log_base_dir, '{time:YYYY}', '{time:MM}', '{time:DD}', 'info.log') + error_log_path = os.path.join(self._log_base_dir, '{time:YYYY}', '{time:MM}', '{time:DD}', 'error.log') + if LogConfig.loguru_stdout: + if LogConfig.loguru_json: + configured_logger.add( + sys.stdout, + level=LogConfig.loguru_level, + enqueue=True, + filter=self._filter, + format=self._json_log_formatter, + ) + else: + configured_logger.add( + sys.stdout, + level=LogConfig.loguru_level, + enqueue=True, + filter=self._filter, + format=self._plain_log_formatter, + ) + if self._log_file_enabled: + if LogConfig.loguru_json: + configured_logger.add( + info_log_path, + level='INFO', + rotation=LogConfig.loguru_rotation, + retention=LogConfig.loguru_retention, + compression=LogConfig.loguru_compression, + enqueue=True, + filter=self._info_file_filter, + serialize=False, + format=self._json_log_formatter, + ) + configured_logger.add( + error_log_path, + level='WARNING', + rotation=LogConfig.loguru_rotation, + retention=LogConfig.loguru_retention, + compression=LogConfig.loguru_compression, + enqueue=True, + filter=self._error_file_filter, + serialize=False, + format=self._json_log_formatter, + ) + else: + configured_logger.add( + info_log_path, + level='INFO', + rotation=LogConfig.loguru_rotation, + retention=LogConfig.loguru_retention, + compression=LogConfig.loguru_compression, + enqueue=True, + filter=self._info_file_filter, + format=self._plain_log_formatter, + ) + configured_logger.add( + error_log_path, + level='WARNING', + rotation=LogConfig.loguru_rotation, + retention=LogConfig.loguru_retention, + compression=LogConfig.loguru_compression, + enqueue=True, + filter=self._error_file_filter, + format=self._plain_log_formatter, + ) + self._configure_logging() + return configured_logger + + +# 初始化日志处理器 +log_initializer = LoggerInitializer() +logger = log_initializer.init_log() diff --git a/shierfeng-fastapi-backend/utils/message_util.py b/shierfeng-fastapi-backend/utils/message_util.py new file mode 100644 index 0000000..b425d3b --- /dev/null +++ b/shierfeng-fastapi-backend/utils/message_util.py @@ -0,0 +1,5 @@ +from utils.log_util import logger + + +def message_service(sms_code: str) -> None: + logger.info(f'短信验证码为{sms_code}') diff --git a/shierfeng-fastapi-backend/utils/page_util.py b/shierfeng-fastapi-backend/utils/page_util.py new file mode 100644 index 0000000..3c50590 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/page_util.py @@ -0,0 +1,105 @@ +import math +from typing import Any + +from sqlalchemy import Row, Select, func, select +from sqlalchemy.ext.asyncio import AsyncSession + +from common.vo import PageModel +from utils.common_util import CamelCaseUtil + + +class PageUtil: + """ + 分页工具类 + """ + + @classmethod + def get_page_obj(cls, data_list: list, page_num: int, page_size: int) -> PageModel: + """ + 输入数据列表data_list和分页信息,返回分页数据列表结果 + + :param data_list: 原始数据列表 + :param page_num: 当前页码 + :param page_size: 当前页面数据量 + :return: 分页数据对象 + """ + # 计算起始索引和结束索引 + start = (page_num - 1) * page_size + end = page_num * page_size + + # 根据计算得到的起始索引和结束索引对数据列表进行切片 + paginated_data = data_list[start:end] + has_next = math.ceil(len(data_list) / page_size) > page_num + + result = PageModel[Any]( + rows=paginated_data, pageNum=page_num, pageSize=page_size, total=len(data_list), hasNext=has_next + ) + + return result + + @classmethod + async def paginate( + cls, db: AsyncSession, query: Select, page_num: int, page_size: int, is_page: bool = False + ) -> PageModel | list[dict[str, Any] | list[dict[Any, Any]]]: + """ + 输入查询语句和分页信息,返回分页数据列表结果 + + :param db: orm对象 + :param query: sqlalchemy查询语句 + :param page_num: 当前页码 + :param page_size: 当前页面数据量 + :param is_page: 是否开启分页 + :return: 分页数据对象 + """ + if is_page: + total = (await db.execute(select(func.count('*')).select_from(query.subquery()))).scalar() + query_result = await db.execute(query.offset((page_num - 1) * page_size).limit(page_size)) + paginated_data: list[Row] = [] + for row in query_result: + if row and len(row) == 1: + paginated_data.append(row[0]) + else: + paginated_data.append(row) + has_next = math.ceil(total / page_size) > page_num + result = PageModel[Any]( + rows=CamelCaseUtil.transform_result(paginated_data), + pageNum=page_num, + pageSize=page_size, + total=total, + hasNext=has_next, + ) + else: + query_result = await db.execute(query) + no_paginated_data: list[Row] = [] + for row in query_result: + if row and len(row) == 1: + no_paginated_data.append(row[0]) + else: + no_paginated_data.append(row) + result = CamelCaseUtil.transform_result(no_paginated_data) + + return result + + +def get_page_obj(data_list: list, page_num: int, page_size: int) -> PageModel: + """ + 输入数据列表data_list和分页信息,返回分页数据列表结果 + + :param data_list: 原始数据列表 + :param page_num: 当前页码 + :param page_size: 当前页面数据量 + :return: 分页数据对象 + """ + # 计算起始索引和结束索引 + start = (page_num - 1) * page_size + end = page_num * page_size + + # 根据计算得到的起始索引和结束索引对数据列表进行切片 + paginated_data = data_list[start:end] + has_next = math.ceil(len(data_list) / page_size) > page_num + + result = PageModel[Any]( + rows=paginated_data, pageNum=page_num, pageSize=page_size, total=len(data_list), hasNext=has_next + ) + + return result diff --git a/shierfeng-fastapi-backend/utils/pwd_util.py b/shierfeng-fastapi-backend/utils/pwd_util.py new file mode 100644 index 0000000..9fa592f --- /dev/null +++ b/shierfeng-fastapi-backend/utils/pwd_util.py @@ -0,0 +1,30 @@ +import bcrypt + + +class PwdUtil: + """ + 密码工具类 + """ + + @classmethod + def verify_password(cls, plain_password: str, hashed_password: str) -> bool: + """ + 工具方法:校验当前输入的密码与数据库存储的密码是否一致 + + :param plain_password: 当前输入的密码 + :param hashed_password: 数据库存储的密码 + :return: 校验结果 + """ + return ( + bcrypt.checkpw(plain_password.encode('utf-8'), hashed_password.encode('utf-8')) if hashed_password else None + ) + + @classmethod + def get_password_hash(cls, input_password: str) -> str: + """ + 工具方法:对当前输入的密码进行加密 + + :param input_password: 输入的密码 + :return: 加密成功的密码 + """ + return bcrypt.hashpw(input_password.encode('utf-8'), bcrypt.gensalt()).decode('utf-8') diff --git a/shierfeng-fastapi-backend/utils/response_util.py b/shierfeng-fastapi-backend/utils/response_util.py new file mode 100644 index 0000000..d281501 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/response_util.py @@ -0,0 +1,315 @@ +from collections.abc import Mapping +from datetime import datetime +from typing import Any + +from fastapi import status +from fastapi.encoders import jsonable_encoder +from fastapi.responses import JSONResponse, Response, StreamingResponse +from pydantic import BaseModel +from starlette.background import BackgroundTask + +from common.constant import HttpStatusConstant + + +class ResponseUtil: + """ + 响应工具类 + """ + + @classmethod + def success( + cls, + msg: str = '操作成功', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 成功响应方法 + + :param msg: 可选,自定义成功响应信息 + :param data: 可选,成功响应结果中属性为data的值 + :param rows: 可选,成功响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,成功响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,成功响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 成功响应结果 + """ + result = {'code': HttpStatusConstant.SUCCESS, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': True, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_200_OK, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def failure( + cls, + msg: str = '操作失败', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 失败响应方法 + + :param msg: 可选,自定义失败响应信息 + :param data: 可选,失败响应结果中属性为data的值 + :param rows: 可选,失败响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,失败响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,失败响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 失败响应结果 + """ + result = {'code': HttpStatusConstant.WARN, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': False, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_200_OK, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def unauthorized( + cls, + msg: str = '登录信息已过期,访问系统资源失败', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 未认证响应方法 + + :param msg: 可选,自定义未认证响应信息 + :param data: 可选,未认证响应结果中属性为data的值 + :param rows: 可选,未认证响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,未认证响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,未认证响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 未认证响应结果 + """ + result = {'code': HttpStatusConstant.UNAUTHORIZED, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': False, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_200_OK, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def forbidden( + cls, + msg: str = '该用户无此接口权限', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 未授权响应方法 + + :param msg: 可选,自定义未授权响应信息 + :param data: 可选,未授权响应结果中属性为data的值 + :param rows: 可选,未授权响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,未授权响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,未授权响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 未授权响应结果 + """ + result = {'code': HttpStatusConstant.FORBIDDEN, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': False, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_200_OK, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def error( + cls, + msg: str = '接口异常', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 错误响应方法 + + :param msg: 可选,自定义错误响应信息 + :param data: 可选,错误响应结果中属性为data的值 + :param rows: 可选,错误响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,错误响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,错误响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 错误响应结果 + """ + result = {'code': HttpStatusConstant.ERROR, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': False, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_200_OK, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def too_many_requests( + cls, + msg: str = '请求过于频繁,请稍后再试', + data: Any | None = None, + rows: Any | None = None, + dict_content: dict | None = None, + model_content: BaseModel | None = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 接口限流响应方法 + + :param msg: 可选,自定义限流响应信息 + :param data: 可选,限流响应结果中属性为data的值 + :param rows: 可选,限流响应结果中属性为rows的值 + :param dict_content: 可选,dict类型,限流响应结果中自定义属性的值 + :param model_content: 可选,BaseModel类型,限流响应结果中自定义属性的值 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 限流响应结果 + """ + result = {'code': HttpStatusConstant.TOO_MANY_REQUESTS, 'msg': msg} + + if data is not None: + result['data'] = data + if rows is not None: + result['rows'] = rows + if dict_content is not None: + result.update(dict_content) + if model_content is not None: + result.update(model_content.model_dump(by_alias=True)) + + result.update({'success': False, 'time': datetime.now()}) + + return JSONResponse( + status_code=status.HTTP_429_TOO_MANY_REQUESTS, + content=jsonable_encoder(result), + headers=headers, + media_type=media_type, + background=background, + ) + + @classmethod + def streaming( + cls, + *, + data: Any = None, + headers: Mapping[str, str] | None = None, + media_type: str | None = None, + background: BackgroundTask | None = None, + ) -> Response: + """ + 流式响应方法 + + :param data: 流式传输的内容 + :param headers: 可选,响应头信息 + :param media_type: 可选,响应结果媒体类型 + :param background: 可选,响应返回后执行的后台任务 + :return: 流式响应结果 + """ + return StreamingResponse( + status_code=status.HTTP_200_OK, content=data, headers=headers, media_type=media_type, background=background + ) diff --git a/shierfeng-fastapi-backend/utils/server_util.py b/shierfeng-fastapi-backend/utils/server_util.py new file mode 100644 index 0000000..98ae174 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/server_util.py @@ -0,0 +1,496 @@ +import asyncio +import ipaddress +import os +import socket +import uuid +from collections.abc import Callable + +import psutil +from fastapi import FastAPI, Request, applications +from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html, get_swagger_ui_oauth2_redirect_html +from fastapi.openapi.utils import get_openapi +from fastapi.responses import HTMLResponse, JSONResponse +from redis import asyncio as aioredis + +from config.env import AppConfig + + +class APIDocsUtil: + """ + API文档工具类 + """ + + # API文档URLs + _OPENAPI_URL = '/openapi.json' + _PROXY_OPENAPI_URL = '/proxy-openapi.json' + _DOCS_URL = '/docs' + _PROXY_DOCS_URL = '/proxy-docs' + _REDOC_URL = '/redoc' + _PROXY_REDOC_URL = '/proxy-redoc' + _OAUTH2_REDIRECT_URL = '/docs/oauth2-redirect' + _PROXY_OAUTH2_REDIRECT_URL = '/proxy-docs/oauth2-redirect' + + # 文档静态资源URLs + DEFAULT_REDOC_JS_URL = 'https://registry.npmmirror.com/redoc/2/files/bundles/redoc.standalone.js' + DEFAULT_REDOC_FAVICON_URL = 'https://fastapi.tiangolo.com/img/favicon.png' + DEFAULT_SWAGGER_JS_URL = 'https://registry.npmmirror.com/swagger-ui-dist/5/files/swagger-ui-bundle.js' + DEFAULT_SWAGGER_CSS_URL = 'https://registry.npmmirror.com/swagger-ui-dist/5/files/swagger-ui.css' + DEFAULT_SWAGGER_FAVICON_URL = 'https://fastapi.tiangolo.com/img/favicon.png' + + @classmethod + def proxy_openapi_url(cls) -> str: + """ + 代理OpenAPI文档URL + """ + return cls._PROXY_OPENAPI_URL if not AppConfig.app_disable_swagger and not AppConfig.app_disable_redoc else None + + @classmethod + def docs_url(cls) -> str: + """ + 文档URL + """ + return cls._DOCS_URL + + @classmethod + def proxy_docs_url(cls) -> str: + """ + 代理文档URL + """ + return cls._PROXY_DOCS_URL if not AppConfig.app_disable_swagger else None + + @classmethod + def redoc_url(cls) -> str: + """ + ReDoc文档URL + """ + return cls._REDOC_URL + + @classmethod + def proxy_redoc_url(cls) -> str: + """ + 代理ReDoc文档URL + """ + return cls._PROXY_REDOC_URL if not AppConfig.app_disable_redoc else None + + @classmethod + def proxy_oauth2_redirect_url(cls) -> str: + """ + 代理OAuth2重定向URL + """ + return cls._PROXY_OAUTH2_REDIRECT_URL if not AppConfig.app_disable_swagger else None + + @classmethod + def setup_docs_static_resources( + cls, + redoc_js_url: str = DEFAULT_REDOC_JS_URL, + redoc_favicon_url: str = DEFAULT_REDOC_FAVICON_URL, + swagger_js_url: str = DEFAULT_SWAGGER_JS_URL, + swagger_css_url: str = DEFAULT_SWAGGER_CSS_URL, + swagger_favicon_url: str = DEFAULT_SWAGGER_FAVICON_URL, + ) -> None: + """ + 配置文档静态资源 + + :param redoc_js_url: 用于加载ReDoc JavaScript的URL + :param redoc_favicon_url: ReDoc要使用的favicon的URL + :param swagger_js_url: 用于加载Swagger UI JavaScript的URL + :param swagger_css_url: 用于加载Swagger UI CSS的URL + :param swagger_favicon_url: Swagger UI要使用的favicon的URL + :return: + """ + + def redoc_monkey_patch(*args, **kwargs) -> HTMLResponse: + return get_redoc_html( + *args, + **kwargs, + redoc_js_url=redoc_js_url, + redoc_favicon_url=redoc_favicon_url, + ) + + def swagger_ui_monkey_patch(*args, **kwargs) -> HTMLResponse: + return get_swagger_ui_html( + *args, + **kwargs, + swagger_js_url=swagger_js_url, + swagger_css_url=swagger_css_url, + swagger_favicon_url=swagger_favicon_url, + ) + + applications.get_redoc_html = redoc_monkey_patch + applications.get_swagger_ui_html = swagger_ui_monkey_patch + + @classmethod + def custom_api_docs_router( + cls, + app: FastAPI, + redoc_js_url: str = DEFAULT_REDOC_JS_URL, + redoc_favicon_url: str = DEFAULT_REDOC_FAVICON_URL, + swagger_js_url: str = DEFAULT_SWAGGER_JS_URL, + swagger_css_url: str = DEFAULT_SWAGGER_CSS_URL, + swagger_favicon_url: str = DEFAULT_SWAGGER_FAVICON_URL, + ) -> None: + """ + 自定义API文档路由 + + :param app: FastAPI对象 + :param redoc_js_url: 用于加载ReDoc JavaScript的URL + :param redoc_favicon_url: ReDoc要使用的favicon的URL + :param swagger_js_url: 用于加载Swagger UI JavaScript的URL + :param swagger_css_url: 用于加载Swagger UI CSS的URL + :param swagger_favicon_url: Swagger UI要使用的favicon的URL + :return: + """ + + async def custom_openapi(request: Request) -> JSONResponse: + return await cls._custom_openapi(app) + + async def custom_redoc(request: Request) -> HTMLResponse: + return await cls._custom_redoc(app, redoc_js_url, redoc_favicon_url) + + async def custom_swagger(request: Request) -> HTMLResponse: + return await cls._custom_swagger(app, swagger_js_url, swagger_css_url, swagger_favicon_url) + + async def custom_swagger_ui_redirect(request: Request) -> HTMLResponse: + return await cls._custom_swagger_ui_redirect(app, swagger_favicon_url) + + # 注册路由 + app.add_route(cls._OPENAPI_URL, custom_openapi, include_in_schema=False) + cls._register_docs_routes(app, custom_swagger, custom_swagger_ui_redirect, custom_redoc) + + @classmethod + async def _custom_openapi(cls, app: FastAPI) -> JSONResponse: + """ + 自定义 OpenAPI 路由处理函数 + + :param app: FastAPI对象 + :return: openapi的json响应 + """ + openapi_schema = get_openapi( + title=app.title, + version=app.version, + openapi_version=app.openapi_version, + summary=app.summary, + description=app.description, + terms_of_service=app.terms_of_service, + contact=app.contact, + license_info=app.license_info, + routes=app.routes, + webhooks=app.webhooks.routes, + tags=app.openapi_tags, + separate_input_output_schemas=app.separate_input_output_schemas, + external_docs=app.openapi_external_docs, + ) + return JSONResponse(openapi_schema) + + @classmethod + async def _custom_redoc( + cls, + app: FastAPI, + redoc_js_url: str, + redoc_favicon_url: str, + ) -> HTMLResponse: + """ + 自定义 ReDoc 路由处理函数 + + :param app: FastAPI对象 + :param redoc_js_url: 用于加载ReDoc JavaScript的URL + :param redoc_favicon_url: ReDoc要使用的favicon的URL + :return: ReDoc HTML响应 + """ + if not AppConfig.app_disable_redoc: + return get_redoc_html( + openapi_url=cls._OPENAPI_URL, + title=f'{app.title} - ReDoc', + redoc_js_url=redoc_js_url, + redoc_favicon_url=redoc_favicon_url, + ) + return cls._get_disabled_html_content( + f'{app.title} - ReDoc', + 'ReDoc', + redoc_favicon_url, + ) + + @classmethod + async def _custom_swagger( + cls, + app: FastAPI, + swagger_js_url: str, + swagger_css_url: str, + swagger_favicon_url: str, + ) -> HTMLResponse: + """ + 自定义 Swagger UI 路由处理函数 + + :param app: FastAPI对象 + :param swagger_js_url: 用于加载Swagger UI JavaScript的URL + :param swagger_css_url: 用于加载Swagger UI CSS的URL + :param swagger_favicon_url: Swagger UI要使用的favicon的URL + :return: Swagger UI HTML响应 + """ + if not AppConfig.app_disable_swagger: + return get_swagger_ui_html( + openapi_url=cls._OPENAPI_URL, + title=f'{app.title} - Swagger UI', + swagger_js_url=swagger_js_url, + swagger_css_url=swagger_css_url, + swagger_favicon_url=swagger_favicon_url, + oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url, + init_oauth=app.swagger_ui_init_oauth, + swagger_ui_parameters=app.swagger_ui_parameters, + ) + return cls._get_disabled_html_content( + f'{app.title} - Swagger UI', + 'Swagger UI', + swagger_favicon_url, + ) + + @classmethod + async def _custom_swagger_ui_redirect( + cls, + app: FastAPI, + swagger_favicon_url: str, + ) -> HTMLResponse: + """ + 自定义 Swagger UI OAuth2 重定向路由处理函数 + + :param app: FastAPI对象 + :param swagger_favicon_url: Swagger UI要使用的favicon的URL + :return: Swagger UI OAuth2重定向HTML响应 + """ + if not AppConfig.app_disable_swagger: + return get_swagger_ui_oauth2_redirect_html() + return cls._get_disabled_html_content( + f'{app.title} - Swagger UI OAuth2 Redirect', + 'Swagger UI OAuth2 Redirect', + swagger_favicon_url, + ) + + @staticmethod + def _get_disabled_html_content(title: str, name: str, favicon_url: str) -> HTMLResponse: + """ + 生成禁用文档的HTML内容 + + :param title: 页面标题 + :param name: 文档名称 + :param favicon_url: 图标地址 + :return: 禁用文档HTML响应 + """ + html = f""" + + + + {title} + + + + + + + + + +

{name} has been disabled. Please enable it first.

+ + + """ + return HTMLResponse(html) + + @classmethod + def _register_docs_routes( + cls, app: FastAPI, swagger_handler: Callable, redirect_handler: Callable, redoc_handler: Callable + ) -> None: + """ + 注册文档路由 + + :param app: FastAPI对象 + :param swagger_handler: Swagger UI 路由处理函数 + :param redirect_handler: Swagger UI OAuth2 重定向路由处理函数 + :param redoc_handler: ReDoc 路由处理函数 + :return: + """ + swagger_urls: list[str] = ( + [cls._DOCS_URL] if not AppConfig.app_disable_swagger else [cls._DOCS_URL, cls._PROXY_DOCS_URL] + ) + swagger_redirect_urls: list[str] = ( + [cls._OAUTH2_REDIRECT_URL] + if not AppConfig.app_disable_swagger + else [cls._OAUTH2_REDIRECT_URL, cls._PROXY_OAUTH2_REDIRECT_URL] + ) + redoc_urls: list[str] = ( + [cls._REDOC_URL] if not AppConfig.app_disable_redoc else [cls._REDOC_URL, cls._PROXY_REDOC_URL] + ) + + for url in swagger_urls: + app.add_route(url, swagger_handler, include_in_schema=False) + for url in swagger_redirect_urls: + app.add_route(url, redirect_handler, include_in_schema=False) + for url in redoc_urls: + app.add_route(url, redoc_handler, include_in_schema=False) + + +class StartupUtil: + """ + 启动门禁工具类 + """ + + @classmethod + async def acquire_startup_log_gate( + cls, redis: aioredis.Redis, lock_key: str, worker_id: str, lock_expire_seconds: int + ) -> bool: + """ + 获取启动日志门禁 + + :param redis: Redis连接对象 + :param lock_key: 分布式锁key + :param worker_id: 当前worker标识 + :param lock_expire_seconds: 锁过期时间 + :return: 是否获得启动日志输出权 + """ + acquired = await redis.set(lock_key, worker_id, nx=True, ex=lock_expire_seconds) + if acquired: + return True + current_holder = await redis.get(lock_key) + return current_holder == worker_id + + @classmethod + def start_lock_renewal( + cls, + redis: aioredis.Redis, + lock_key: str, + worker_id: str, + lock_expire_seconds: int, + interval_seconds: int, + on_lock_lost: Callable[[], None] | None = None, + ) -> asyncio.Task: + """ + 启动分布式锁续期任务 + + :param redis: Redis连接对象 + :param lock_key: 分布式锁key + :param worker_id: 当前worker标识 + :param lock_expire_seconds: 锁过期时间 + :param interval_seconds: 续期间隔时间 + :param on_lock_lost: 失去锁时的回调 + :return: 异步任务对象 + """ + + async def _loop() -> None: + while True: + try: + current_holder = await redis.get(lock_key) + if current_holder == worker_id: + await redis.expire(lock_key, lock_expire_seconds) + await asyncio.sleep(interval_seconds) + continue + if on_lock_lost: + on_lock_lost() + break + except Exception: + await asyncio.sleep(interval_seconds) + + return asyncio.create_task(_loop()) + + +class WorkerIdUtil: + """ + Worker标识生成工具类 + """ + + _worker_id: str | None = None + + @classmethod + def get_worker_id(cls, configured_worker_id: str | None) -> str: + """ + 获取当前worker标识 + + :param configured_worker_id: 配置的worker标识 + :return: 当前worker标识 + """ + if cls._worker_id: + return cls._worker_id + worker_id = configured_worker_id + if not worker_id or worker_id.lower() == 'auto': + worker_id = f'{os.getpid()}-{uuid.uuid4().hex[:6]}' + cls._worker_id = worker_id + return worker_id + + +class IPUtil: + """ + IP工具类 + """ + + _PREFERRED_DNS_HOSTS: tuple[str, str] = ('223.5.5.5', '8.8.8.8') + _DNS_CONNECT_TIMEOUT = 1 + + @classmethod + def get_local_ip(cls) -> str: + """ + 获取本机Local IP + """ + try: + for snics in psutil.net_if_addrs().values(): + for snic in snics: + if snic.family == socket.AF_INET and snic.address.startswith('127.'): + return snic.address + except Exception: + pass + + return '127.0.0.1' + + @classmethod + def get_network_ips(cls) -> list[str]: + """ + 获取本机Network IP列表 + """ + network_ips = [] + try: + # 获取网卡状态 + stats = psutil.net_if_stats() + for name, snics in psutil.net_if_addrs().items(): + # 过滤掉状态为DOWN的网卡 + if name in stats and not stats[name].isup: + continue + + for snic in snics: + if snic.family == socket.AF_INET: + try: + ip_obj = ipaddress.ip_address(snic.address) + if ip_obj.is_loopback or ip_obj.is_link_local: + continue + network_ips.append(snic.address) + except ValueError: + continue + except Exception: + pass + + # 优先显示首选出站IP + preferred_ip = None + for dns_host in cls._PREFERRED_DNS_HOSTS: + try: + with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s: + s.settimeout(cls._DNS_CONNECT_TIMEOUT) + s.connect((dns_host, 80)) + preferred_ip = s.getsockname()[0] + break + except Exception: + continue + + if preferred_ip: + if preferred_ip in network_ips: + network_ips.remove(preferred_ip) + network_ips.insert(0, preferred_ip) + + if not network_ips: + network_ips = ['127.0.0.1'] + + return network_ips diff --git a/shierfeng-fastapi-backend/utils/string_util.py b/shierfeng-fastapi-backend/utils/string_util.py new file mode 100644 index 0000000..55f3d8f --- /dev/null +++ b/shierfeng-fastapi-backend/utils/string_util.py @@ -0,0 +1,165 @@ +from common.constant import CommonConstant + + +class StringUtil: + """ + 字符串工具类 + """ + + @classmethod + def is_blank(cls, string: str | None) -> bool: + """ + 校验字符串是否为''或全空格 + + :param string: 需要校验的字符串 + :return: 校验结果 + """ + if string is None: + return False + str_len = len(string) + if str_len == 0: + return True + return all(string[i] == ' ' for i in range(str_len)) + + @classmethod + def is_empty(cls, string: str) -> bool: + """ + 校验字符串是否为''或None + + :param string: 需要校验的字符串 + :return: 校验结果 + """ + return string is None or len(string) == 0 + + @classmethod + def is_not_empty(cls, string: str) -> bool: + """ + 校验字符串是否不是''和None + + :param string: 需要校验的字符串 + :return: 校验结果 + """ + return not cls.is_empty(string) + + @classmethod + def is_http(cls, link: str) -> bool: + """ + 判断是否为http(s)://开头 + + :param link: 链接 + :return: 是否为http(s)://开头 + """ + return link.startswith((CommonConstant.HTTP, CommonConstant.HTTPS)) + + @classmethod + def contains_ignore_case(cls, search_str: str, compare_str: str) -> bool: + """ + 查找指定字符串是否包含指定字符串同时忽略大小写 + + :param search_str: 查找的字符串 + :param compare_str: 比对的字符串 + :return: 查找结果 + """ + if compare_str and search_str: + return compare_str.lower() in search_str.lower() + return False + + @classmethod + def contains_any_ignore_case(cls, search_str: str, compare_str_list: list[str]) -> bool: + """ + 查找指定字符串是否包含指定字符串列表中的任意一个字符串同时忽略大小写 + + :param search_str: 查找的字符串 + :param compare_str_list: 比对的字符串列表 + :return: 查找结果 + """ + if search_str and compare_str_list: + return any(cls.contains_ignore_case(search_str, compare_str) for compare_str in compare_str_list) + return False + + @classmethod + def equals_ignore_case(cls, search_str: str, compare_str: str) -> bool: + """ + 比较两个字符串是否相等同时忽略大小写 + + :param search_str: 查找的字符串 + :param compare_str: 比对的字符串 + :return: 比较结果 + """ + if search_str and compare_str: + return search_str.lower() == compare_str.lower() + return False + + @classmethod + def equals_any_ignore_case(cls, search_str: str, compare_str_list: list[str]) -> bool: + """ + 比较指定字符串是否与指定字符串列表中的任意一个字符串相等同时忽略大小写 + + :param search_str: 查找的字符串 + :param compare_str_list: 比对的字符串列表 + :return: 比较结果 + """ + if search_str and compare_str_list: + return any(cls.equals_ignore_case(search_str, compare_str) for compare_str in compare_str_list) + return False + + @classmethod + def startswith_case(cls, search_str: str, compare_str: str) -> bool: + """ + 查找指定字符串是否以指定字符串开头 + + :param search_str: 查找的字符串 + :param compare_str: 比对的字符串 + :return: 查找结果 + """ + if compare_str and search_str: + return search_str.startswith(compare_str) + return False + + @classmethod + def startswith_any_case(cls, search_str: str, compare_str_list: list[str]) -> bool: + """ + 查找指定字符串是否以指定字符串列表中的任意一个字符串开头 + + :param search_str: 查找的字符串 + :param compare_str_list: 比对的字符串列表 + :return: 查找结果 + """ + if search_str and compare_str_list: + return any(cls.startswith_case(search_str, compare_str) for compare_str in compare_str_list) + return False + + @classmethod + def convert_to_camel_case(cls, name: str) -> str: + """ + 将下划线大写方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空,则返回空字符串 + + :param name: 转换前的下划线大写方式命名的字符串 + :return: 转换后的驼峰式命名的字符串 + """ + if not name: + return '' + if '_' not in name: + return name[0].upper() + name[1:] + parts = name.split('_') + result = [] + for part in parts: + if not part: + continue + result.append(part[0].upper() + part[1:].lower()) + return ''.join(result) + + @classmethod + def get_mapping_value_by_key_ignore_case(cls, mapping: dict[str, str], key: str) -> str: + """ + 根据忽略大小写的键获取字典中的对应的值 + + param mapping: 字典 + param key: 字典的键 + :return: 字典键对应的值 + """ + for k, v in mapping.items(): + if key.lower() == k.lower(): + return v + + return '' diff --git a/shierfeng-fastapi-backend/utils/template_util.py b/shierfeng-fastapi-backend/utils/template_util.py new file mode 100644 index 0000000..89cc412 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/template_util.py @@ -0,0 +1,473 @@ +import json +import os +from datetime import datetime +from typing import Any + +from jinja2 import Environment, FileSystemLoader + +from common.constant import GenConstant +from config.env import DataBaseConfig +from exceptions.exception import ServiceWarning +from module_generator.entity.vo.gen_vo import GenTableColumnModel, GenTableModel +from utils.common_util import CamelCaseUtil, SnakeCaseUtil +from utils.string_util import StringUtil + + +class TemplateInitializer: + """ + 模板引擎初始化类 + """ + + @classmethod + def init_jinja2(cls) -> Environment: + """ + 初始化 Jinja2 模板引擎 + + :return: Jinja2 环境对象 + """ + try: + template_dir = os.path.join(os.getcwd(), 'module_generator', 'templates') + env = Environment( + loader=FileSystemLoader(template_dir), + keep_trailing_newline=True, + trim_blocks=True, + lstrip_blocks=True, + ) + env.filters.update( + { + 'camel_to_snake': SnakeCaseUtil.camel_to_snake, + 'snake_to_camel': CamelCaseUtil.snake_to_camel, + 'get_sqlalchemy_type': TemplateUtils.get_sqlalchemy_type, + } + ) + return env + except Exception as e: + raise RuntimeError(f'初始化Jinja2模板引擎失败: {e}') from e + + +class TemplateUtils: + """ + 模板工具类 + """ + + # 项目路径 + FRONTEND_PROJECT_PATH = 'frontend' + BACKEND_PROJECT_PATH = 'backend' + DEFAULT_PARENT_MENU_ID = '3' + + @classmethod + def prepare_context(cls, gen_table: GenTableModel) -> dict[str, Any]: + """ + 准备模板变量 + + :param gen_table: 生成表的配置信息 + :return: 模板上下文字典 + """ + if not gen_table.options: + raise ServiceWarning(message='请先完善生成配置信息') + class_name = gen_table.class_name + module_name = gen_table.module_name + business_name = gen_table.business_name + package_name = gen_table.package_name + tpl_category = gen_table.tpl_category + function_name = gen_table.function_name + + context = { + 'tplCategory': tpl_category, + 'tableName': gen_table.table_name, + 'tableComment': gen_table.table_comment, + 'functionName': function_name if StringUtil.is_not_empty(function_name) else '【请填写功能名称】', + 'ClassName': class_name, + 'className': class_name.lower(), + 'moduleName': module_name, + 'BusinessName': business_name.capitalize(), + 'businessName': business_name, + 'basePackage': cls.get_package_prefix(package_name), + 'packageName': package_name, + 'author': gen_table.function_author, + 'datetime': datetime.now().strftime('%Y-%m-%d %H:%M:%S'), + 'pkColumn': gen_table.pk_column, + 'doImportList': cls.get_do_import_list(gen_table), + 'voImportList': cls.get_vo_import_list(gen_table), + 'permissionPrefix': cls.get_permission_prefix(module_name, business_name), + 'columns': gen_table.columns, + 'table': gen_table, + 'dicts': cls.get_dicts(gen_table), + 'dbType': DataBaseConfig.db_type, + 'column_not_add_show': GenConstant.COLUMNNAME_NOT_ADD_SHOW, + 'column_not_edit_show': GenConstant.COLUMNNAME_NOT_EDIT_SHOW, + } + + # 设置菜单、树形结构、子表的上下文 + cls.set_menu_context(context, gen_table) + if tpl_category == GenConstant.TPL_TREE: + cls.set_tree_context(context, gen_table) + if tpl_category == GenConstant.TPL_SUB: + cls.set_sub_context(context, gen_table) + + return context + + @classmethod + def set_menu_context(cls, context: dict, gen_table: GenTableModel) -> None: + """ + 设置菜单上下文 + + :param context: 模板上下文字典 + :param gen_table: 生成表的配置信息 + :return: 新的模板上下文字典 + """ + options = gen_table.options + params_obj = json.loads(options) + context['parentMenuId'] = cls.get_parent_menu_id(params_obj) + + @classmethod + def set_tree_context(cls, context: dict, gen_table: GenTableModel) -> None: + """ + 设置树形结构上下文 + + :param context: 模板上下文字典 + :param gen_table: 生成表的配置信息 + :return: 新的模板上下文字典 + """ + options = gen_table.options + params_obj = json.loads(options) + context['treeCode'] = cls.get_tree_code(params_obj) + context['treeParentCode'] = cls.get_tree_parent_code(params_obj) + context['treeName'] = cls.get_tree_name(params_obj) + context['expandColumn'] = cls.get_expand_column(gen_table) + + @classmethod + def set_sub_context(cls, context: dict, gen_table: GenTableModel) -> None: + """ + 设置子表上下文 + + :param context: 模板上下文字典 + :param gen_table: 生成表的配置信息 + :return: 新的模板上下文字典 + """ + sub_table = gen_table.sub_table + sub_table_name = gen_table.sub_table_name + sub_table_fk_name = gen_table.sub_table_fk_name + sub_class_name = sub_table.class_name + sub_table_fk_class_name = StringUtil.convert_to_camel_case(sub_table_fk_name) + context['subTable'] = sub_table + context['subTableName'] = sub_table_name + context['subTableFkName'] = sub_table_fk_name + context['subTableFkClassName'] = sub_table_fk_class_name + context['subTableFkclassName'] = sub_table_fk_class_name.lower() + context['subClassName'] = sub_class_name + context['subclassName'] = sub_class_name.lower() + + @classmethod + def get_template_list(cls, tpl_category: str, tpl_web_type: str) -> list[str]: + """ + 获取模板列表 + + :param tpl_category: 生成模板类型 + :param tpl_web_type: 前端类型 + :return: 模板列表 + """ + use_web_type = 'vue' + if tpl_web_type == 'element-plus': + use_web_type = 'vue/v3' + templates = [ + 'python/controller.py.jinja2', + 'python/dao.py.jinja2', + 'python/do.py.jinja2', + 'python/service.py.jinja2', + 'python/vo.py.jinja2', + 'sql/sql.jinja2', + 'js/api.js.jinja2', + ] + if tpl_category == GenConstant.TPL_CRUD: + templates.append(f'{use_web_type}/index.vue.jinja2') + elif tpl_category == GenConstant.TPL_TREE: + templates.append(f'{use_web_type}/index-tree.vue.jinja2') + elif tpl_category == GenConstant.TPL_SUB: + templates.append(f'{use_web_type}/index.vue.jinja2') + # templates.append('python/sub-domain.python.jinja2') + return templates + + @classmethod + def get_file_name(cls, template: list[str], gen_table: GenTableModel) -> str: + """ + 根据模板生成文件名 + + :param template: 模板列表 + :param gen_table: 生成表的配置信息 + :return: 模板生成文件名 + """ + package_name = gen_table.package_name + module_name = gen_table.module_name + business_name = gen_table.business_name + + vue_path = cls.FRONTEND_PROJECT_PATH + python_path = f'{cls.BACKEND_PROJECT_PATH}/{package_name.replace(".", "/")}' + + if 'controller.py.jinja2' in template: + return f'{python_path}/controller/{business_name}_controller.py' + if 'dao.py.jinja2' in template: + return f'{python_path}/dao/{business_name}_dao.py' + if 'do.py.jinja2' in template: + return f'{python_path}/entity/do/{business_name}_do.py' + if 'service.py.jinja2' in template: + return f'{python_path}/service/{business_name}_service.py' + if 'vo.py.jinja2' in template: + return f'{python_path}/entity/vo/{business_name}_vo.py' + if 'sql.jinja2' in template: + return f'{cls.BACKEND_PROJECT_PATH}/sql/{business_name}_menu.sql' + if 'api.js.jinja2' in template: + return f'{vue_path}/api/{module_name}/{business_name}.js' + if 'index.vue.jinja2' in template or 'index-tree.vue.jinja2' in template: + return f'{vue_path}/views/{module_name}/{business_name}/index.vue' + return '' + + @classmethod + def get_package_prefix(cls, package_name: str) -> str: + """ + 获取包前缀 + + :param package_name: 包名 + :return: 包前缀 + """ + return package_name[: package_name.rfind('.')] + + @classmethod + def get_vo_import_list(cls, gen_table: GenTableModel) -> list[str]: + """ + 获取vo模板导入包列表 + + :param gen_table: 生成表的配置信息 + :return: 导入包列表 + """ + columns = gen_table.columns or [] + import_list = set() + for column in columns: + if column.python_type in GenConstant.TYPE_DATE: + import_list.add(f'from datetime import {column.python_type}') + elif column.python_type == GenConstant.TYPE_DECIMAL: + import_list.add('from decimal import Decimal') + if gen_table.sub: + sub_columns = gen_table.sub_table.columns or [] + for sub_column in sub_columns: + if sub_column.python_type in GenConstant.TYPE_DATE: + import_list.add(f'from datetime import {sub_column.python_type}') + elif sub_column.python_type == GenConstant.TYPE_DECIMAL: + import_list.add('from decimal import Decimal') + return cls.merge_same_imports(list(import_list), 'from datetime import') + + @classmethod + def get_do_import_list(cls, gen_table: GenTableModel) -> list[str]: + """ + 获取do模板导入包列表 + + :param gen_table: 生成表的配置信息 + :return: 导入包列表 + """ + columns = gen_table.columns or [] + import_list = set() + import_list.add('from sqlalchemy import Column') + for column in columns: + data_type = cls.get_db_type(column.column_type) + if data_type in GenConstant.COLUMNTYPE_GEOMETRY: + import_list.add('from geoalchemy2 import Geometry') + import_list.add( + f'from sqlalchemy import {StringUtil.get_mapping_value_by_key_ignore_case(GenConstant.DB_TO_SQLALCHEMY_TYPE_MAPPING, data_type)}' + ) + if gen_table.sub: + import_list.add('from sqlalchemy import ForeignKey') + sub_columns = gen_table.sub_table.columns or [] + for sub_column in sub_columns: + data_type = cls.get_db_type(sub_column.column_type) + import_list.add( + f'from sqlalchemy import {StringUtil.get_mapping_value_by_key_ignore_case(GenConstant.DB_TO_SQLALCHEMY_TYPE_MAPPING, data_type)}' + ) + return cls.merge_same_imports(list(import_list), 'from sqlalchemy import') + + @classmethod + def get_db_type(cls, column_type: str) -> str: + """ + 获取数据库类型字段 + + param column_type: 字段类型 + :return: 数据库类型 + """ + if '(' in column_type: + return column_type.split('(', maxsplit=1)[0] + return column_type + + @classmethod + def merge_same_imports(cls, imports: list[str], import_start: str) -> list[str]: + """ + 合并相同的导入语句 + + :param imports: 导入语句列表 + :param import_start: 导入语句的起始字符串 + :return: 合并后的导入语句列表 + """ + merged_imports = [] + _imports = [] + for import_stmt in imports: + if import_stmt.startswith(import_start): + imported_items = import_stmt.split('import')[1].strip() + _imports.extend(imported_items.split(', ')) + else: + merged_imports.append(import_stmt) + + if _imports: + merged_datetime_import = f'{import_start} {", ".join(_imports)}' + merged_imports.append(merged_datetime_import) + + return merged_imports + + @classmethod + def get_dicts(cls, gen_table: GenTableModel) -> str: + """ + 获取字典列表 + + :param gen_table: 生成表的配置信息 + :return: 字典列表 + """ + columns = gen_table.columns or [] + dicts = set() + cls.add_dicts(dicts, columns) + if gen_table.sub_table is not None: + cls.add_dicts(dicts, gen_table.sub_table.columns) + return ', '.join(dicts) + + @classmethod + def add_dicts(cls, dicts: set[str], columns: list[GenTableColumnModel]) -> None: + """ + 添加字典列表 + + :param dicts: 字典列表 + :param columns: 字段列表 + :return: 新的字典列表 + """ + for column in columns: + if ( + not column.super_column + and StringUtil.is_not_empty(column.dict_type) + and StringUtil.equals_any_ignore_case( + column.html_type, [GenConstant.HTML_SELECT, GenConstant.HTML_RADIO, GenConstant.HTML_CHECKBOX] + ) + ): + dicts.add(f"'{column.dict_type}'") + + @classmethod + def get_permission_prefix(cls, module_name: str, business_name: str) -> str: + """ + 获取权限前缀 + + :param module_name: 模块名 + :param business_name: 业务名 + :return: 权限前缀 + """ + return f'{module_name}:{business_name}' + + @classmethod + def get_parent_menu_id(cls, params_obj: dict) -> str: + """ + 获取上级菜单ID + + :param params_obj: 菜单参数字典 + :return: 上级菜单ID + """ + if params_obj and params_obj.get(GenConstant.PARENT_MENU_ID): + return params_obj.get(GenConstant.PARENT_MENU_ID) + return cls.DEFAULT_PARENT_MENU_ID + + @classmethod + def get_tree_code(cls, params_obj: dict) -> str: + """ + 获取树编码 + + :param params_obj: 菜单参数字典 + :return: 树编码 + """ + if GenConstant.TREE_CODE in params_obj: + return cls.to_camel_case(params_obj.get(GenConstant.TREE_CODE)) + return '' + + @classmethod + def get_tree_parent_code(cls, params_obj: dict) -> str: + """ + 获取树父编码 + + :param params_obj: 菜单参数字典 + :return: 树父编码 + """ + if GenConstant.TREE_PARENT_CODE in params_obj: + return cls.to_camel_case(params_obj.get(GenConstant.TREE_PARENT_CODE)) + return '' + + @classmethod + def get_tree_name(cls, params_obj: dict) -> str: + """ + 获取树名称 + + :param params_obj: 菜单参数字典 + :return: 树名称 + """ + if GenConstant.TREE_NAME in params_obj: + return cls.to_camel_case(params_obj.get(GenConstant.TREE_NAME)) + return '' + + @classmethod + def get_expand_column(cls, gen_table: GenTableModel) -> int: + """ + 获取展开列 + + :param gen_table: 生成表的配置信息 + :return: 展开列 + """ + options = gen_table.options + params_obj = json.loads(options) + tree_name = params_obj.get(GenConstant.TREE_NAME) + num = 0 + for column in gen_table.columns or []: + if column.list: + num += 1 + if column.column_name == tree_name: + break + return num + + @classmethod + def to_camel_case(cls, text: str) -> str: + """ + 将字符串转换为驼峰命名 + + :param text: 待转换的字符串 + :return: 转换后的驼峰命名字符串 + """ + parts = text.split('_') + return parts[0] + ''.join(word.capitalize() for word in parts[1:]) + + @classmethod + def get_sqlalchemy_type(cls, column_type: str) -> str: + """ + 获取SQLAlchemy类型 + + :param column_type: 列类型 + :return: SQLAlchemy类型 + """ + if '(' in column_type: + column_type_list = column_type.split('(') + if column_type_list[0] in GenConstant.COLUMNTYPE_STR: + sqlalchemy_type = ( + StringUtil.get_mapping_value_by_key_ignore_case( + GenConstant.DB_TO_SQLALCHEMY_TYPE_MAPPING, column_type_list[0] + ) + + '(' + + column_type_list[1] + ) + else: + sqlalchemy_type = StringUtil.get_mapping_value_by_key_ignore_case( + GenConstant.DB_TO_SQLALCHEMY_TYPE_MAPPING, column_type_list[0] + ) + else: + sqlalchemy_type = StringUtil.get_mapping_value_by_key_ignore_case( + GenConstant.DB_TO_SQLALCHEMY_TYPE_MAPPING, column_type + ) + + return sqlalchemy_type diff --git a/shierfeng-fastapi-backend/utils/time_format_util.py b/shierfeng-fastapi-backend/utils/time_format_util.py new file mode 100644 index 0000000..e2bf150 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/time_format_util.py @@ -0,0 +1,142 @@ +from copy import deepcopy +from datetime import date, datetime +from typing import Any + +from dateutil.parser import parse + + +def object_format_datetime(obj: Any) -> Any: + """ + :param obj: 输入一个对象 + :return:对目标对象所有datetime类型的属性格式化 + """ + for attr in dir(obj): + value = getattr(obj, attr) + if isinstance(value, datetime): + setattr(obj, attr, value.strftime('%Y-%m-%d %H:%M:%S')) + return obj + + +def list_format_datetime(lst: list[Any]) -> list[Any]: + """ + :param lst: 输入一个嵌套对象的列表 + :return: 对目标列表中所有对象的datetime类型的属性格式化 + """ + for obj in lst: + for attr in dir(obj): + value = getattr(obj, attr) + if isinstance(value, datetime): + setattr(obj, attr, value.strftime('%Y-%m-%d %H:%M:%S')) + return lst + + +def format_datetime_dict_list(dicts: list[dict]) -> list[dict]: + """ + 递归遍历嵌套字典,并将 datetime 值转换为字符串格式 + + :param dicts: 输入一个嵌套字典的列表 + :return: 对目标列表中所有字典的datetime类型的属性格式化 + """ + result = [] + + for item in dicts: + new_item = {} + for k, v in item.items(): + if isinstance(v, dict): + # 递归遍历子字典 + new_item[k] = format_datetime_dict_list([v])[0] + elif isinstance(v, datetime): + # 如果值是 datetime 类型,则格式化为字符串 + new_item[k] = v.strftime('%Y-%m-%d %H:%M:%S') + else: + # 否则保留原始值 + new_item[k] = v + result.append(new_item) + + return result + + +class TimeFormatUtil: + """ + 时间格式化工具类 + """ + + @classmethod + def format_time(cls, time_info: str | datetime, fmt: str = '%Y-%m-%d %H:%M:%S') -> str: + """ + 格式化时间字符串或datetime对象为指定格式 + + :param time_info: 时间字符串或datetime对象 + :param fmt: 格式化格式,默认为'%Y-%m-%d %H:%M:%S' + :return: 格式化后的时间字符串 + """ + if isinstance(time_info, datetime): + format_date = time_info.strftime(fmt) + else: + try: + date = parse(time_info) + format_date = date.strftime(fmt) + except Exception: + format_date = time_info + + return format_date + + @classmethod + def parse_date(cls, time_str: str) -> date | str: + """ + 解析时间字符串提取日期部分 + + :param time_str: 时间字符串 + :return: 日期部分 + """ + try: + dt = parse(time_str) + return dt.date() + except Exception: + return time_str + + @classmethod + def format_time_dict(cls, time_dict: dict, fmt: str = '%Y-%m-%d %H:%M:%S') -> dict: + """ + 格式化时间字典 + + :param time_dict: 时间字典 + :param fmt: 格式化格式,默认为'%Y-%m-%d %H:%M:%S' + :return: 格式化后的时间字典 + """ + copy_time_dict = deepcopy(time_dict) + for k, v in copy_time_dict.items(): + if isinstance(v, (str, datetime)): + copy_time_dict[k] = cls.format_time(v, fmt) + elif isinstance(v, dict): + copy_time_dict[k] = cls.format_time_dict(v, fmt) + elif isinstance(v, list): + copy_time_dict[k] = cls.format_time_list(v, fmt) + else: + copy_time_dict[k] = v + + return copy_time_dict + + @classmethod + def format_time_list(cls, time_list: list, fmt: str = '%Y-%m-%d %H:%M:%S') -> list: + """ + 格式化时间列表 + + :param time_list: 时间列表 + :param fmt: 格式化格式,默认为'%Y-%m-%d %H:%M:%S' + :return: 格式化后的时间列表 + """ + format_time_list = [] + for item in time_list: + if isinstance(item, (str, datetime)): + format_item = cls.format_time(item, fmt) + elif isinstance(item, dict): + format_item = cls.format_time_dict(item, fmt) + elif isinstance(item, list): + format_item = cls.format_time_list(item, fmt) + else: + format_item = item + + format_time_list.append(format_item) + + return format_time_list diff --git a/shierfeng-fastapi-backend/utils/transport_crypto_util.py b/shierfeng-fastapi-backend/utils/transport_crypto_util.py new file mode 100644 index 0000000..7b53197 --- /dev/null +++ b/shierfeng-fastapi-backend/utils/transport_crypto_util.py @@ -0,0 +1,1284 @@ +import base64 +import json +import os +import time +from collections import Counter, defaultdict, deque +from dataclasses import dataclass +from datetime import datetime +from threading import Lock +from typing import Any + +from cryptography.hazmat.primitives import hashes, serialization +from cryptography.hazmat.primitives.asymmetric import padding +from cryptography.hazmat.primitives.ciphers.aead import AESGCM +from fastapi import FastAPI, Request +from redis import asyncio as aioredis + +from config.env import AppConfig, TransportCryptoConfig +from utils.log_util import logger + + +# 通用编码辅助 +def _urlsafe_b64encode(data: bytes) -> str: + """ + 将字节串编码为URL安全的Base64字符串 + + :param data: 原始字节串 + :return: URL安全的Base64字符串 + """ + return base64.urlsafe_b64encode(data).decode('utf-8').rstrip('=') + + +def _urlsafe_b64decode(data: str) -> bytes: + """ + 将URL安全的Base64字符串解码为字节串 + + :param data: URL安全的Base64字符串 + :return: 解码后的字节串 + """ + padding_length = (-len(data)) % 4 + return base64.urlsafe_b64decode(f'{data}{"=" * padding_length}'.encode()) + + +@dataclass(frozen=True) +class TransportKeyPair: + """ + 传输层密钥对载体 + + kid: 密钥版本标识 + private_key_pem: PEM格式私钥 + public_key_pem: PEM格式公钥 + """ + + kid: str + private_key_pem: str + public_key_pem: str + + +# 传输层数据载体 +@dataclass(frozen=True) +class DecryptedTransportEnvelope: + """ + 请求信封解密结果 + + kid: 请求使用的密钥版本标识 + nonce: 请求随机数 + timestamp: 请求时间戳 + aes_key: 当前请求协商出的AES会话密钥 + aad: 通过校验后的AAD上下文 + plaintext: 解密得到的原始请求载荷 + """ + + kid: str + nonce: str + timestamp: int + aes_key: bytes + aad: dict[str, str] + plaintext: bytes + + +# 传输层密钥管理 +class TransportKeyProvider: + """ + 传输层密钥提供者 + """ + + _lock = Lock() + _key_pairs: dict[str, TransportKeyPair] | None = None + _MIN_RSA_KEY_SIZE = 2048 + _RSA_KEY_SIZE_STEP = 256 + + @classmethod + def validate_runtime_configuration(cls) -> None: + """ + 校验传输层加解密运行配置,确保启用时显式配置密钥对 + + :return: None + """ + if not TransportCryptoConfig.transport_crypto_enabled or TransportCryptoConfig.transport_crypto_mode == 'off': + return + + configured_private_key = cls._normalize_pem(TransportCryptoConfig.transport_crypto_private_key) + configured_public_key = cls._normalize_pem(TransportCryptoConfig.transport_crypto_public_key) + rsa_key_size = TransportCryptoConfig.transport_crypto_rsa_key_size + + if rsa_key_size < cls._MIN_RSA_KEY_SIZE or rsa_key_size % cls._RSA_KEY_SIZE_STEP != 0: + raise ValueError('TRANSPORT_CRYPTO_RSA_KEY_SIZE必须大于等于2048,且为256的整数倍') + + if not configured_private_key or not configured_public_key: + raise ValueError( + '启用传输层加解密时,必须显式配置TRANSPORT_CRYPTO_PUBLIC_KEY和TRANSPORT_CRYPTO_PRIVATE_KEY' + ) + + private_key = serialization.load_pem_private_key(configured_private_key.encode('utf-8'), password=None) + derived_public_key = ( + private_key.public_key() + .public_bytes( + encoding=serialization.Encoding.PEM, + format=serialization.PublicFormat.SubjectPublicKeyInfo, + ) + .decode('utf-8') + ) + if cls._normalize_pem(derived_public_key) != configured_public_key: + raise ValueError('TRANSPORT_CRYPTO_PUBLIC_KEY与TRANSPORT_CRYPTO_PRIVATE_KEY不匹配') + + if TransportCryptoConfig.transport_crypto_legacy_key_pairs: + cls._build_legacy_key_pairs() + + @classmethod + def get_current_key_pair(cls) -> TransportKeyPair: + """ + 获取当前启用的密钥对 + + :return: 当前启用的密钥对 + """ + if cls._key_pairs is None: + with cls._lock: + if cls._key_pairs is None: + cls._key_pairs = cls._build_key_pairs() + + return cls._key_pairs[TransportCryptoConfig.transport_crypto_kid] + + @classmethod + def get_current_kid(cls) -> str: + """ + 获取当前启用的密钥标识 + + :return: 当前启用的密钥标识 + """ + return cls.get_current_key_pair().kid + + @classmethod + def get_public_key_pem(cls, kid: str | None = None) -> str: + """ + 获取公钥PEM + + :param kid: 密钥版本标识,未传入时默认使用当前版本 + :return: PEM格式公钥字符串 + """ + return cls.get_key_pair(kid).public_key_pem + + @classmethod + def get_private_key_pem(cls, kid: str | None = None) -> str: + """ + 获取私钥PEM + + :param kid: 密钥版本标识,未传入时默认使用当前版本 + :return: PEM格式私钥字符串 + """ + return cls.get_key_pair(kid).private_key_pem + + @classmethod + def get_key_pair(cls, kid: str | None = None) -> TransportKeyPair: + """ + 根据kid获取密钥对,未传入时返回当前密钥对 + + :param kid: 密钥版本标识,未传入时默认使用当前版本 + :return: 匹配到的密钥对 + """ + target_kid = kid or cls.get_current_kid() + if cls._key_pairs is None: + with cls._lock: + if cls._key_pairs is None: + cls._key_pairs = cls._build_key_pairs() + key_pair = cls._key_pairs.get(target_kid) + if key_pair is None: + raise ValueError('密钥版本不存在') + return key_pair + + @classmethod + def get_supported_kids(cls) -> tuple[str, ...]: + """ + 获取当前支持解密的全部密钥版本 + + :return: 当前支持解密的密钥版本元组 + """ + if cls._key_pairs is None: + cls.get_current_key_pair() + return tuple(cls._key_pairs.keys()) + + @classmethod + def _build_key_pairs(cls) -> dict[str, TransportKeyPair]: + """ + 构建当前进程可用的全部密钥对映射 + + :return: 以kid为键的密钥对映射 + """ + configured_private_key = cls._normalize_pem(TransportCryptoConfig.transport_crypto_private_key) + configured_public_key = cls._normalize_pem(TransportCryptoConfig.transport_crypto_public_key) + kid = TransportCryptoConfig.transport_crypto_kid + + if not configured_private_key or not configured_public_key: + raise ValueError( + '启用传输层加解密时,必须显式配置TRANSPORT_CRYPTO_PUBLIC_KEY和TRANSPORT_CRYPTO_PRIVATE_KEY' + ) + + key_pairs = { + kid: TransportKeyPair(kid=kid, private_key_pem=configured_private_key, public_key_pem=configured_public_key) + } + key_pairs.update(cls._build_legacy_key_pairs()) + return key_pairs + + @classmethod + def _build_legacy_key_pairs(cls) -> dict[str, TransportKeyPair]: + """ + 构建历史密钥对映射,用于密钥轮换窗口内的兼容解密 + + :return: 以kid为键的历史密钥对映射 + """ + legacy_key_pairs: dict[str, TransportKeyPair] = {} + configured_legacy_key_pairs = TransportCryptoConfig.transport_crypto_legacy_key_pairs + if not configured_legacy_key_pairs: + return legacy_key_pairs + + try: + parsed_key_pairs = json.loads(configured_legacy_key_pairs) + except json.JSONDecodeError as exc: + raise ValueError('传输层历史密钥配置不是合法JSON') from exc + + if not isinstance(parsed_key_pairs, list): + raise ValueError('传输层历史密钥配置必须是JSON数组') + + for item in parsed_key_pairs: + if not isinstance(item, dict): + raise ValueError('传输层历史密钥项必须是JSON对象') + item_kid = item.get('kid') + private_key_pem = cls._normalize_pem(item.get('privateKey') or item.get('private_key') or '') + public_key_pem = cls._normalize_pem(item.get('publicKey') or item.get('public_key') or '') + if not item_kid or not private_key_pem: + raise ValueError('传输层历史密钥项必须包含kid和privateKey') + if not public_key_pem: + private_key = serialization.load_pem_private_key(private_key_pem.encode('utf-8'), password=None) + public_key_pem = ( + private_key.public_key() + .public_bytes( + encoding=serialization.Encoding.PEM, + format=serialization.PublicFormat.SubjectPublicKeyInfo, + ) + .decode('utf-8') + ) + legacy_key_pairs[str(item_kid)] = TransportKeyPair( + kid=str(item_kid), + private_key_pem=private_key_pem, + public_key_pem=public_key_pem, + ) + + return legacy_key_pairs + + @staticmethod + def _normalize_pem(pem_value: str) -> str: + """ + 兼容环境变量中的换行转义 + + :param pem_value: 原始PEM字符串 + :return: 标准化后的PEM字符串 + """ + return pem_value.replace('\\n', '\n').strip() if pem_value else '' + + +# 传输层安全校验 +class TransportSecurityUtil: + """ + 传输层安全校验工具 + """ + + @classmethod + def validate_timestamp(cls, timestamp: int) -> None: + """ + 校验请求时间窗 + + :param timestamp: 请求信封中的时间戳 + :return: None + """ + now_timestamp = int(time.time()) + if abs(now_timestamp - timestamp) > TransportCryptoConfig.transport_crypto_clock_skew_seconds: + logger.warning( + '传输层加密请求时间窗校验失败,request_ts={}, now_ts={}, allowed_skew={}', + timestamp, + now_timestamp, + TransportCryptoConfig.transport_crypto_clock_skew_seconds, + ) + raise ValueError('加密请求已过期,请刷新页面后重试') + + @classmethod + async def validate_replay(cls, request: Request, kid: str, nonce: str) -> None: + """ + 使用Redis进行防重放校验 + + :param request: 当前请求对象 + :param kid: 当前密钥版本标识 + :param nonce: 当前请求随机数 + :return: None + """ + redis = getattr(request.app.state, 'redis', None) + if redis is None: + if cls._should_fail_closed_when_replay_check_unavailable(request): + logger.error('Redis未初始化,当前请求要求严格防重放校验,已拒绝请求') + raise ValueError('服务端防重放校验不可用,请稍后重试') + logger.warning('Redis未初始化,已跳过传输层防重放校验') + return + + replay_key = f'transport:replay:{kid}:{nonce}' + try: + is_success = await redis.set( + replay_key, '1', ex=TransportCryptoConfig.transport_crypto_replay_ttl_seconds, nx=True + ) + except Exception as exc: + if cls._should_fail_closed_when_replay_check_unavailable(request): + logger.error('Redis防重放校验执行失败,当前请求要求严格校验,error={}', exc) + raise ValueError('服务端防重放校验不可用,请稍后重试') from exc + logger.warning('Redis防重放校验执行失败,已跳过当前请求的防重放校验,error={}', exc) + return + if not is_success: + logger.warning('传输层加密请求检测到重放,kid={}, nonce={}', kid, nonce) + raise ValueError('检测到重复请求,请勿重放加密报文') + + @classmethod + def _should_fail_closed_when_replay_check_unavailable(cls, request: Request) -> bool: + """ + 判断当前请求在防重放能力不可用时是否需要直接拒绝 + + :param request: 当前请求对象 + :return: 是否需要失败关闭 + """ + if TransportCryptoConfig.transport_crypto_mode == 'required': + return True + current_path = cls._normalize_path(str(request.scope.get('path', ''))) + return cls._is_required_path(current_path) + + @staticmethod + def _normalize_path(path: str) -> str: + """ + 标准化请求路径,剥离应用根路径前缀 + + :param path: 原始请求路径 + :return: 标准化后的业务路径 + """ + app_root_path = AppConfig.app_root_path + if app_root_path and path.startswith(app_root_path): + normalized_path = path[len(app_root_path) :] + return normalized_path or '/' + return path or '/' + + @staticmethod + def _is_required_path(path: str) -> bool: + """ + 判断当前路径是否命中强制加密路径配置 + + :param path: 当前请求路径 + :return: 是否命中强制加密路径 + """ + required_paths = [ + required_path.strip() + for required_path in TransportCryptoConfig.transport_crypto_required_paths.split(',') + if required_path.strip() + ] + if not required_paths: + return False + return any(path == required_path or path.startswith(f'{required_path}/') for required_path in required_paths) + + +# 传输层加解密核心能力 +class TransportCryptoUtil: + """ + 传输层加解密工具 + """ + + _ENVELOPE_VERSION = '1' + _RESPONSE_ENVELOPE_ALGORITHM = 'AES_256_GCM' + _REQUIRED_ENVELOPE_FIELDS = ('kid', 'ts', 'nonce', 'ek', 'iv', 'ct', 'aad') + + @classmethod + def get_response_envelope_algorithm(cls) -> str: + """ + 获取响应信封算法标识 + + :return: 响应信封算法标识 + """ + return cls._RESPONSE_ENVELOPE_ALGORITHM + + @classmethod + def decrypt_envelope( + cls, + envelope: dict[str, Any], + expected_method: str, + expected_path: str, + ) -> DecryptedTransportEnvelope: + """ + 解密请求信封 + + :param envelope: 请求加密信封 + :param expected_method: 当前请求预期HTTP方法 + :param expected_path: 当前请求预期路径 + :return: 解密后的请求信封对象 + """ + cls._validate_envelope(envelope) + kid = str(envelope['kid']) + aad = cls._extract_and_validate_aad(envelope, expected_method, expected_path) + aes_key = cls.decrypt_request_key(envelope) + iv = _urlsafe_b64decode(str(envelope['iv'])) + ciphertext = _urlsafe_b64decode(str(envelope['ct'])) + plaintext = AESGCM(aes_key).decrypt(iv, ciphertext, cls._build_aad_bytes(aad)) + + return DecryptedTransportEnvelope( + kid=kid, + nonce=str(envelope['nonce']), + timestamp=int(envelope['ts']), + aes_key=aes_key, + aad=aad, + plaintext=plaintext, + ) + + @classmethod + def decrypt_request_key(cls, envelope: dict[str, Any]) -> bytes: + """ + 仅解出请求中的AES会话密钥,用于异常场景构造加密错误响应 + + :param envelope: 请求加密信封 + :return: 请求协商出的AES会话密钥 + """ + kid = str(envelope['kid']) + private_key_pem = TransportKeyProvider.get_private_key_pem(kid) + private_key = serialization.load_pem_private_key(private_key_pem.encode('utf-8'), password=None) + encrypted_key = _urlsafe_b64decode(str(envelope['ek'])) + return private_key.decrypt( + encrypted_key, + padding.OAEP(mgf=padding.MGF1(algorithm=hashes.SHA256()), algorithm=hashes.SHA256(), label=None), + ) + + @classmethod + def encrypt_response_body( + cls, + aes_key: bytes, + payload: bytes, + kid: str, + method: str, + path: str, + ) -> bytes: + """ + 使用请求协商出的AES密钥加密响应体 + + :param aes_key: 请求协商出的AES会话密钥 + :param payload: 需要加密的响应体字节串 + :param kid: 当前使用的密钥版本标识 + :param method: 当前HTTP请求方法 + :param path: 当前HTTP请求路径 + :return: 加密后的响应体字节串 + """ + iv = os.urandom(12) + aad = {'method': method.upper(), 'path': path, 'direction': 'response'} + ciphertext = AESGCM(aes_key).encrypt(iv, payload, cls._build_aad_bytes(aad)) + encrypted_payload = { + 'v': cls._ENVELOPE_VERSION, + 'kid': kid, + 'alg': cls._RESPONSE_ENVELOPE_ALGORITHM, + 'aad': aad, + 'iv': _urlsafe_b64encode(iv), + 'ct': _urlsafe_b64encode(ciphertext), + } + return json.dumps(encrypted_payload, ensure_ascii=False).encode('utf-8') + + @classmethod + def decode_query_envelope(cls, encrypted_query: str) -> dict[str, Any]: + """ + 解码查询参数中的加密信封 + + :param encrypted_query: 查询参数中的加密信封字符串 + :return: 解码后的信封字典 + """ + decoded_query = _urlsafe_b64decode(encrypted_query).decode('utf-8') + return json.loads(decoded_query) + + @classmethod + def build_public_key_payload(cls) -> dict[str, Any]: + """ + 构建公钥下发载荷 + + :return: 公钥下发载荷字典 + """ + return { + 'kid': TransportKeyProvider.get_current_kid(), + 'envelopeVersion': cls._ENVELOPE_VERSION, + 'alg': TransportCryptoConfig.transport_crypto_algorithm, + 'publicKey': TransportKeyProvider.get_public_key_pem(), + 'supportedKids': TransportKeyProvider.get_supported_kids(), + 'expireAt': int(time.time()) + TransportCryptoConfig.transport_crypto_public_key_ttl_seconds, + } + + @classmethod + def build_frontend_config_payload(cls) -> dict[str, Any]: + """ + 构建前端传输层加解密运行配置载荷 + + :return: 前端传输层加解密运行配置载荷字典 + """ + transport_crypto_active = ( + TransportCryptoConfig.transport_crypto_enabled and TransportCryptoConfig.transport_crypto_mode != 'off' + ) + return { + 'transportCryptoEnabled': TransportCryptoConfig.transport_crypto_enabled, + 'transportCryptoMode': TransportCryptoConfig.transport_crypto_mode, + 'transportCryptoActive': transport_crypto_active, + 'envelopeVersion': cls._ENVELOPE_VERSION, + 'publicKeyUrl': '/transport/crypto/public-key', + 'requestEnvelopeAlgorithm': TransportCryptoConfig.transport_crypto_algorithm, + 'responseEnvelopeAlgorithm': cls.get_response_envelope_algorithm(), + 'enabledPaths': cls._split_paths(TransportCryptoConfig.transport_crypto_enabled_paths), + 'requiredPaths': cls._split_paths(TransportCryptoConfig.transport_crypto_required_paths), + 'excludePaths': cls._split_paths(TransportCryptoConfig.transport_crypto_exclude_paths), + 'maxEncryptedGetUrlLength': TransportCryptoConfig.transport_crypto_max_get_url_length, + 'configExpireAt': int(time.time()) + TransportCryptoConfig.transport_crypto_frontend_config_ttl_seconds, + } + + @classmethod + def _validate_envelope(cls, envelope: dict[str, Any]) -> None: + """ + 校验请求加密信封的结构、协议版本与算法是否有效 + + :param envelope: 请求加密信封 + :return: None + """ + if not isinstance(envelope, dict): + raise ValueError('加密请求信封格式不合法') + + missing_fields = [field_name for field_name in cls._REQUIRED_ENVELOPE_FIELDS if not envelope.get(field_name)] + if missing_fields: + raise ValueError(f'加密请求缺少必要字段: {",".join(missing_fields)}') + + if str(envelope.get('v', '')) != cls._ENVELOPE_VERSION: + raise ValueError('加密请求协议版本不受支持') + + if str(envelope.get('alg', '')) != TransportCryptoConfig.transport_crypto_algorithm: + raise ValueError('加密请求算法不受支持') + + @classmethod + def _extract_and_validate_aad( + cls, + envelope: dict[str, Any], + expected_method: str, + expected_path: str, + ) -> dict[str, str]: + """ + 提取并校验请求AAD,确保密文与当前接口绑定 + + :param envelope: 请求加密信封 + :param expected_method: 当前请求预期HTTP方法 + :param expected_path: 当前请求预期路径 + :return: 归一化后的AAD字典 + """ + aad = envelope.get('aad') + if not isinstance(aad, dict): + raise ValueError('加密请求缺少合法的aad') + + method = str(aad.get('method', '')).upper() + path = str(aad.get('path', '')) + if method != expected_method.upper() or path != expected_path: + raise ValueError('加密请求的method/path与当前接口不匹配') + + return {'method': method, 'path': path} + + @staticmethod + def _build_aad_bytes(aad: dict[str, str]) -> bytes: + """ + 将AAD字典序列化为AES-GCM additionalData所需字节串 + + :param aad: AAD字典 + :return: 序列化后的AAD字节串 + """ + return json.dumps(aad, ensure_ascii=False, separators=(',', ':')).encode('utf-8') + + @staticmethod + def _split_paths(path_value: str) -> list[str]: + """ + 将逗号分隔的路径配置拆分为列表 + + :param path_value: 原始路径配置 + :return: 路径列表 + """ + return [path.strip() for path in path_value.split(',') if path.strip()] + + +# 传输层监控读写与聚合 +class TransportCryptoMonitorUtil: + """ + 传输层加解密监控工具 + """ + + _REDIS_KEY_PREFIX = 'transport:monitor' + _META_STARTED_AT_KEY = f'{_REDIS_KEY_PREFIX}:started_at' + _COUNTERS_KEY = f'{_REDIS_KEY_PREFIX}:counters' + _FAILURE_REASONS_KEY = f'{_REDIS_KEY_PREFIX}:failure_reasons' + _KIDS_KEY = f'{_REDIS_KEY_PREFIX}:kids' + _RECENT_FAILURES_KEY = f'{_REDIS_KEY_PREFIX}:recent_failures' + _RECENT_FAILURE_LIMIT = 20 + _REDIS_WARNING_INTERVAL_SECONDS = 60 + _lock = Lock() + _started_at = datetime.now() + _counters: Counter[str] = Counter() + _failure_reasons: Counter[str] = Counter() + _kid_counters: defaultdict[str, Counter[str]] = defaultdict(Counter) + _recent_failures: deque[dict[str, Any]] = deque(maxlen=_RECENT_FAILURE_LIMIT) + _last_redis_warning_at = 0.0 + + # 对外暴露的监控记录与查询入口 + @classmethod + async def record_plain_request(cls, app: FastAPI | None = None) -> None: + """ + 记录明文请求 + + :param app: FastAPI应用对象 + :return: None + """ + if await cls._write_redis_counters( + app, + counter_updates={ + 'requests_total': 1, + 'plain_requests_total': 1, + }, + ): + return + cls._record_plain_request_local() + + @classmethod + async def record_encrypted_request(cls, app: FastAPI | None = None, kid: str | None = None) -> None: + """ + 记录加密请求 + + :param app: FastAPI应用对象 + :param kid: 当前请求使用的密钥版本 + :return: None + """ + if await cls._write_redis_counters( + app, + counter_updates={ + 'requests_total': 1, + 'encrypted_requests_total': 1, + }, + kid=kid, + kid_counter_updates={'encrypted_requests_total': 1}, + ): + return + cls._record_encrypted_request_local(kid) + + @classmethod + async def record_required_rejected(cls, app: FastAPI | None = None, method: str = '', path: str = '') -> None: + """ + 记录强制加密接口被明文访问的拒绝事件 + + :param app: FastAPI应用对象 + :param method: 请求方法 + :param path: 请求路径 + :return: None + """ + if await cls._write_redis_failure( + app, + method=method, + path=path, + reason='required_missing', + include_decrypt_failure=False, + ): + return + cls._record_failure_local(method, path, 'required_missing', include_decrypt_failure=False) + + @classmethod + async def record_decrypt_success(cls, app: FastAPI | None = None, kid: str | None = None) -> None: + """ + 记录请求解密成功事件 + + :param app: FastAPI应用对象 + :param kid: 当前请求使用的密钥版本 + :return: None + """ + if await cls._write_redis_counters( + app, + counter_updates={'decrypt_success_total': 1}, + kid=kid, + kid_counter_updates={'decrypt_success_total': 1}, + ): + return + cls._record_decrypt_success_local(kid) + + @classmethod + async def record_decrypt_failure( + cls, + app: FastAPI | None = None, + method: str = '', + path: str = '', + reason: str = '', + kid: str | None = None, + ) -> None: + """ + 记录请求解密失败事件 + + :param app: FastAPI应用对象 + :param method: 请求方法 + :param path: 请求路径 + :param reason: 失败原因分类 + :param kid: 当前请求使用的密钥版本 + :return: None + """ + if await cls._write_redis_failure(app, method=method, path=path, reason=reason, kid=kid): + return + cls._record_failure_local(method, path, reason, kid=kid) + + @classmethod + async def record_plain_response(cls, app: FastAPI | None = None) -> None: + """ + 记录明文响应 + + :param app: FastAPI应用对象 + :return: None + """ + if await cls._write_redis_counters(app, counter_updates={'plain_responses_total': 1}): + return + cls._record_plain_response_local() + + @classmethod + async def record_encrypted_response( + cls, + app: FastAPI | None = None, + kid: str | None = None, + is_error: bool = False, + ) -> None: + """ + 记录加密响应 + + :param app: FastAPI应用对象 + :param kid: 当前响应使用的密钥版本 + :param is_error: 是否为错误响应 + :return: None + """ + counter_updates = {'encrypted_responses_total': 1} + if is_error: + counter_updates['encrypted_error_responses_total'] = 1 + if await cls._write_redis_counters( + app, + counter_updates=counter_updates, + kid=kid, + kid_counter_updates={'encrypted_responses_total': 1}, + ): + return + cls._record_encrypted_response_local(kid, is_error) + + @classmethod + async def get_snapshot(cls, app: FastAPI | None = None) -> dict[str, Any]: + """ + 获取传输层加解密监控快照 + + :param app: FastAPI应用对象 + :return: 监控快照字典 + """ + redis_snapshot = await cls._get_redis_snapshot(app) + local_snapshot = cls._get_local_snapshot_parts() + snapshot_parts = cls._merge_snapshot_parts(redis_snapshot, local_snapshot) + return cls._build_snapshot(snapshot_parts) + + # Redis 聚合写入与读取 + @classmethod + async def _write_redis_counters( + cls, + app: FastAPI | None, + counter_updates: dict[str, int], + kid: str | None = None, + kid_counter_updates: dict[str, int] | None = None, + ) -> bool: + """ + 将监控计数写入Redis + + :param app: FastAPI应用对象 + :param counter_updates: 全局计数增量 + :param kid: 当前密钥版本 + :param kid_counter_updates: 按密钥版本统计的增量 + :return: 是否写入成功 + """ + redis = cls._get_redis_client(app) + if redis is None: + return False + try: + async with redis.pipeline(transaction=False) as pipe: + pipe.set(cls._META_STARTED_AT_KEY, cls._started_at.isoformat(), nx=True) + for counter_name, delta in counter_updates.items(): + pipe.hincrby(cls._COUNTERS_KEY, counter_name, delta) + if kid and kid_counter_updates: + pipe.sadd(cls._KIDS_KEY, kid) + kid_counter_key = cls._build_kid_counter_key(kid) + for counter_name, delta in kid_counter_updates.items(): + pipe.hincrby(kid_counter_key, counter_name, delta) + await pipe.execute() + return True + except Exception as exc: + cls._log_redis_warning('write_counters', exc) + return False + + @classmethod + async def _write_redis_failure( + cls, + app: FastAPI | None, + method: str, + path: str, + reason: str, + kid: str | None = None, + include_decrypt_failure: bool = True, + ) -> bool: + """ + 将失败事件写入Redis + + :param app: FastAPI应用对象 + :param method: 请求方法 + :param path: 请求路径 + :param reason: 失败原因分类 + :param kid: 当前请求使用的密钥版本 + :param include_decrypt_failure: 是否计入解密失败次数 + :return: 是否写入成功 + """ + redis = cls._get_redis_client(app) + if redis is None: + return False + try: + recent_failure = json.dumps( + { + 'time': datetime.now().isoformat(), + 'method': method, + 'path': path, + 'reason': reason, + 'kid': kid, + }, + ensure_ascii=False, + ) + async with redis.pipeline(transaction=False) as pipe: + pipe.set(cls._META_STARTED_AT_KEY, cls._started_at.isoformat(), nx=True) + if include_decrypt_failure: + pipe.hincrby(cls._COUNTERS_KEY, 'decrypt_failure_total', 1) + if reason == 'required_missing': + pipe.hincrby(cls._COUNTERS_KEY, 'required_rejected_total', 1) + pipe.hincrby(cls._FAILURE_REASONS_KEY, reason, 1) + pipe.lpush(cls._RECENT_FAILURES_KEY, recent_failure) + pipe.ltrim(cls._RECENT_FAILURES_KEY, 0, cls._RECENT_FAILURE_LIMIT - 1) + if kid: + pipe.sadd(cls._KIDS_KEY, kid) + pipe.hincrby(cls._build_kid_counter_key(kid), 'decrypt_failure_total', 1) + await pipe.execute() + return True + except Exception as exc: + cls._log_redis_warning('write_failure', exc) + return False + + @classmethod + async def _get_redis_snapshot(cls, app: FastAPI | None) -> dict[str, Any]: + """ + 从Redis中读取监控快照 + + :param app: FastAPI应用对象 + :return: Redis监控快照字典 + """ + redis = cls._get_redis_client(app) + if redis is None: + return { + 'monitor_scope': 'process-local-fallback', + 'started_at': cls._started_at, + 'counters': {}, + 'failure_reasons': {}, + 'kid_stats': [], + 'recent_failures': [], + } + try: + async with redis.pipeline(transaction=False) as pipe: + pipe.set(cls._META_STARTED_AT_KEY, cls._started_at.isoformat(), nx=True) + pipe.get(cls._META_STARTED_AT_KEY) + pipe.hgetall(cls._COUNTERS_KEY) + pipe.hgetall(cls._FAILURE_REASONS_KEY) + pipe.lrange(cls._RECENT_FAILURES_KEY, 0, cls._RECENT_FAILURE_LIMIT - 1) + pipe.smembers(cls._KIDS_KEY) + _, started_at_raw, counters_raw, failure_reasons_raw, recent_failures_raw, kids = await pipe.execute() + kid_stats = await cls._get_redis_kid_stats(redis, sorted(kids)) + return { + 'monitor_scope': 'redis-aggregated', + 'started_at': cls._parse_datetime(started_at_raw) or cls._started_at, + 'counters': cls._to_int_mapping(counters_raw), + 'failure_reasons': cls._to_int_mapping(failure_reasons_raw), + 'kid_stats': kid_stats, + 'recent_failures': cls._parse_recent_failures(recent_failures_raw), + } + except Exception as exc: + cls._log_redis_warning('read_snapshot', exc) + return { + 'monitor_scope': 'process-local-fallback', + 'started_at': cls._started_at, + 'counters': {}, + 'failure_reasons': {}, + 'kid_stats': [], + 'recent_failures': [], + } + + @classmethod + async def _get_redis_kid_stats(cls, redis: aioredis.Redis, kids: list[str]) -> list[dict[str, Any]]: + """ + 获取Redis中的按密钥版本聚合统计 + + :param redis: Redis客户端 + :param kids: 密钥版本列表 + :return: 按密钥版本统计列表 + """ + if not kids: + return [] + async with redis.pipeline(transaction=False) as pipe: + for kid in kids: + pipe.hgetall(cls._build_kid_counter_key(kid)) + kid_counter_rows = await pipe.execute() + return [ + { + 'kid': kid, + 'encryptedRequests': cls._to_int_mapping(kid_counter).get('encrypted_requests_total', 0), + 'decryptSuccess': cls._to_int_mapping(kid_counter).get('decrypt_success_total', 0), + 'decryptFailure': cls._to_int_mapping(kid_counter).get('decrypt_failure_total', 0), + 'encryptedResponses': cls._to_int_mapping(kid_counter).get('encrypted_responses_total', 0), + } + for kid, kid_counter in zip(kids, kid_counter_rows, strict=False) + ] + + # 进程内回退统计 + @classmethod + def _record_plain_request_local(cls) -> None: + """ + 在本地内存中记录明文请求 + + :return: None + """ + with cls._lock: + cls._counters['requests_total'] += 1 + cls._counters['plain_requests_total'] += 1 + + @classmethod + def _record_encrypted_request_local(cls, kid: str | None = None) -> None: + """ + 在本地内存中记录加密请求 + + :param kid: 当前请求使用的密钥版本 + :return: None + """ + with cls._lock: + cls._counters['requests_total'] += 1 + cls._counters['encrypted_requests_total'] += 1 + cls._increase_kid_counter_local(kid, 'encrypted_requests_total') + + @classmethod + def _record_decrypt_success_local(cls, kid: str | None = None) -> None: + """ + 在本地内存中记录解密成功事件 + + :param kid: 当前请求使用的密钥版本 + :return: None + """ + with cls._lock: + cls._counters['decrypt_success_total'] += 1 + cls._increase_kid_counter_local(kid, 'decrypt_success_total') + + @classmethod + def _record_plain_response_local(cls) -> None: + """ + 在本地内存中记录明文响应 + + :return: None + """ + with cls._lock: + cls._counters['plain_responses_total'] += 1 + + @classmethod + def _record_encrypted_response_local(cls, kid: str | None = None, is_error: bool = False) -> None: + """ + 在本地内存中记录加密响应 + + :param kid: 当前响应使用的密钥版本 + :param is_error: 是否为错误响应 + :return: None + """ + with cls._lock: + cls._counters['encrypted_responses_total'] += 1 + if is_error: + cls._counters['encrypted_error_responses_total'] += 1 + cls._increase_kid_counter_local(kid, 'encrypted_responses_total') + + @classmethod + def _record_failure_local( + cls, + method: str, + path: str, + reason: str, + kid: str | None = None, + include_decrypt_failure: bool = True, + ) -> None: + """ + 在本地内存中记录失败事件 + + :param method: 请求方法 + :param path: 请求路径 + :param reason: 失败原因分类 + :param kid: 当前请求使用的密钥版本 + :param include_decrypt_failure: 是否计入解密失败次数 + :return: None + """ + with cls._lock: + if include_decrypt_failure: + cls._counters['decrypt_failure_total'] += 1 + if reason == 'required_missing': + cls._counters['required_rejected_total'] += 1 + cls._failure_reasons[reason] += 1 + cls._increase_kid_counter_local(kid, 'decrypt_failure_total') + cls._recent_failures.appendleft( + { + 'time': datetime.now(), + 'method': method, + 'path': path, + 'reason': reason, + 'kid': kid, + } + ) + + @classmethod + def _get_local_snapshot_parts(cls) -> dict[str, Any]: + """ + 获取本地内存中的监控快照片段 + + :return: 本地监控快照片段 + """ + with cls._lock: + return { + 'monitor_scope': 'process-local-fallback', + 'started_at': cls._started_at, + 'counters': dict(cls._counters), + 'failure_reasons': dict(cls._failure_reasons), + 'kid_stats': [ + { + 'kid': kid, + 'encryptedRequests': kid_counter.get('encrypted_requests_total', 0), + 'decryptSuccess': kid_counter.get('decrypt_success_total', 0), + 'decryptFailure': kid_counter.get('decrypt_failure_total', 0), + 'encryptedResponses': kid_counter.get('encrypted_responses_total', 0), + } + for kid, kid_counter in sorted(cls._kid_counters.items(), key=lambda item: item[0]) + ], + 'recent_failures': list(cls._recent_failures), + } + + @classmethod + def _merge_snapshot_parts(cls, redis_snapshot: dict[str, Any], local_snapshot: dict[str, Any]) -> dict[str, Any]: + """ + 合并Redis统计与本地回退统计 + + :param redis_snapshot: Redis监控快照片段 + :param local_snapshot: 本地监控快照片段 + :return: 合并后的监控快照片段 + """ + merged_counters = Counter(redis_snapshot['counters']) + merged_counters.update(local_snapshot['counters']) + + merged_failure_reasons = Counter(redis_snapshot['failure_reasons']) + merged_failure_reasons.update(local_snapshot['failure_reasons']) + + merged_kid_stats: dict[str, dict[str, Any]] = {} + for kid_stat in redis_snapshot['kid_stats'] + local_snapshot['kid_stats']: + kid = kid_stat.get('kid') + if not kid: + continue + merged_kid_stat = merged_kid_stats.setdefault( + kid, + { + 'kid': kid, + 'encryptedRequests': 0, + 'decryptSuccess': 0, + 'decryptFailure': 0, + 'encryptedResponses': 0, + }, + ) + merged_kid_stat['encryptedRequests'] += int(kid_stat.get('encryptedRequests', 0) or 0) + merged_kid_stat['decryptSuccess'] += int(kid_stat.get('decryptSuccess', 0) or 0) + merged_kid_stat['decryptFailure'] += int(kid_stat.get('decryptFailure', 0) or 0) + merged_kid_stat['encryptedResponses'] += int(kid_stat.get('encryptedResponses', 0) or 0) + + combined_failures = redis_snapshot['recent_failures'] + local_snapshot['recent_failures'] + combined_failures.sort( + key=lambda item: cls._coerce_datetime_for_sort(item.get('time')), + reverse=True, + ) + + monitor_scope = redis_snapshot['monitor_scope'] + if monitor_scope == 'redis-aggregated' and cls._has_local_fallback_data(local_snapshot): + monitor_scope = 'redis-aggregated+local-fallback' + + return { + 'monitor_scope': monitor_scope, + 'started_at': min(redis_snapshot['started_at'], local_snapshot['started_at']), + 'counters': dict(merged_counters), + 'failure_reasons': dict(merged_failure_reasons), + 'kid_stats': sorted(merged_kid_stats.values(), key=lambda item: item['kid']), + 'recent_failures': combined_failures[: cls._RECENT_FAILURE_LIMIT], + } + + # 快照构建与通用辅助 + @classmethod + def _build_snapshot(cls, snapshot_parts: dict[str, Any]) -> dict[str, Any]: + """ + 基于监控片段构建最终快照 + + :param snapshot_parts: 监控快照片段 + :return: 最终监控快照 + """ + try: + current_kid = TransportKeyProvider.get_current_kid() + supported_kids = TransportKeyProvider.get_supported_kids() + except Exception: + current_kid = '' + supported_kids = [] + + counters = snapshot_parts['counters'] + return { + 'monitorScope': snapshot_parts['monitor_scope'], + 'startedAt': snapshot_parts['started_at'], + 'appEnv': AppConfig.app_env, + 'transportCryptoEnabled': TransportCryptoConfig.transport_crypto_enabled, + 'transportCryptoMode': TransportCryptoConfig.transport_crypto_mode, + 'currentKid': current_kid, + 'supportedKids': supported_kids, + 'enabledPaths': TransportCryptoUtil._split_paths(TransportCryptoConfig.transport_crypto_enabled_paths), + 'requiredPaths': TransportCryptoUtil._split_paths(TransportCryptoConfig.transport_crypto_required_paths), + 'excludePaths': TransportCryptoUtil._split_paths(TransportCryptoConfig.transport_crypto_exclude_paths), + 'requestsTotal': counters.get('requests_total', 0), + 'plainRequestsTotal': counters.get('plain_requests_total', 0), + 'encryptedRequestsTotal': counters.get('encrypted_requests_total', 0), + 'requiredRejectedTotal': counters.get('required_rejected_total', 0), + 'decryptSuccessTotal': counters.get('decrypt_success_total', 0), + 'decryptFailureTotal': counters.get('decrypt_failure_total', 0), + 'plainResponsesTotal': counters.get('plain_responses_total', 0), + 'encryptedResponsesTotal': counters.get('encrypted_responses_total', 0), + 'encryptedErrorResponsesTotal': counters.get('encrypted_error_responses_total', 0), + 'failureReasons': snapshot_parts['failure_reasons'], + 'kidStats': snapshot_parts['kid_stats'], + 'recentFailures': snapshot_parts['recent_failures'], + } + + @classmethod + def _get_redis_client(cls, app: FastAPI | None) -> aioredis.Redis | None: + """ + 获取当前应用中的Redis客户端 + + :param app: FastAPI应用对象 + :return: Redis客户端,不存在时返回None + """ + if app is None: + return None + return getattr(app.state, 'redis', None) + + @classmethod + def _increase_kid_counter_local(cls, kid: str | None, counter_name: str) -> None: + """ + 在本地内存中按密钥版本累加统计值 + + :param kid: 当前密钥版本 + :param counter_name: 统计项名称 + :return: None + """ + if not kid: + return + cls._kid_counters[kid][counter_name] += 1 + + @classmethod + def _log_redis_warning(cls, action: str, exc: Exception) -> None: + """ + 记录Redis监控降级日志,并限制日志频率 + + :param action: 当前执行动作 + :param exc: 异常对象 + :return: None + """ + now = time.monotonic() + with cls._lock: + if now - cls._last_redis_warning_at < cls._REDIS_WARNING_INTERVAL_SECONDS: + return + cls._last_redis_warning_at = now + logger.warning('传输层加解密监控Redis操作失败,已回退为进程内统计,action={}, error={}', action, exc) + + @classmethod + def _has_local_fallback_data(cls, local_snapshot: dict[str, Any]) -> bool: + """ + 判断本地回退统计中是否存在有效数据 + + :param local_snapshot: 本地监控快照片段 + :return: 是否存在有效数据 + """ + if local_snapshot['counters']: + return True + if local_snapshot['failure_reasons']: + return True + if local_snapshot['kid_stats']: + return True + return bool(local_snapshot['recent_failures']) + + @classmethod + def _build_kid_counter_key(cls, kid: str) -> str: + """ + 构建按密钥版本统计的Redis键名 + + :param kid: 密钥版本 + :return: Redis键名 + """ + return f'{cls._REDIS_KEY_PREFIX}:kid:{kid}:counters' + + @classmethod + def _parse_recent_failures(cls, recent_failures: list[str]) -> list[dict[str, Any]]: + """ + 解析Redis中的最近失败记录 + + :param recent_failures: Redis中存储的失败记录列表 + :return: 失败记录对象列表 + """ + parsed_failures: list[dict[str, Any]] = [] + for recent_failure in recent_failures: + try: + recent_failure_item = json.loads(recent_failure) + except json.JSONDecodeError: + continue + if not isinstance(recent_failure_item, dict): + continue + recent_failure_item['time'] = cls._parse_datetime(recent_failure_item.get('time')) + parsed_failures.append(recent_failure_item) + return parsed_failures + + @staticmethod + def _to_int_mapping(mapping: dict[str, Any]) -> dict[str, int]: + """ + 将Redis返回的字符串字典转换为整数字典 + + :param mapping: Redis原始字典 + :return: 转换后的整数字典 + """ + return {str(key): int(value) for key, value in mapping.items()} + + @staticmethod + def _parse_datetime(value: Any) -> datetime | None: + """ + 将字符串时间解析为datetime对象 + + :param value: 原始时间值 + :return: datetime对象,解析失败时返回None + """ + if isinstance(value, datetime): + return value + if not value or not isinstance(value, str): + return None + try: + return datetime.fromisoformat(value) + except ValueError: + return None + + @classmethod + def _coerce_datetime_for_sort(cls, value: Any) -> datetime: + """ + 将任意时间值转换为可排序的datetime对象 + + :param value: 原始时间值 + :return: datetime对象 + """ + parsed_datetime = cls._parse_datetime(value) + if parsed_datetime: + return parsed_datetime + return datetime.min diff --git a/shierfeng-fastapi-backend/utils/upload_util.py b/shierfeng-fastapi-backend/utils/upload_util.py new file mode 100644 index 0000000..b751dde --- /dev/null +++ b/shierfeng-fastapi-backend/utils/upload_util.py @@ -0,0 +1,108 @@ +import os +import random +from collections.abc import AsyncGenerator +from datetime import datetime + +import aiofiles +from fastapi import UploadFile + +from config.env import UploadConfig + + +class UploadUtil: + """ + 上传工具类 + """ + + @classmethod + def generate_random_number(cls) -> str: + """ + 生成3位数字构成的字符串 + + :return: 3位数字构成的字符串 + """ + random_number = random.randint(1, 999) + + return f'{random_number:03}' + + @classmethod + def check_file_exists(cls, filepath: str) -> bool: + """ + 检查文件是否存在 + + :param filepath: 文件路径 + :return: 校验结果 + """ + return os.path.exists(filepath) + + @classmethod + def check_file_extension(cls, file: UploadFile) -> bool: + """ + 检查文件后缀是否合法 + + :param file: 文件对象 + :return: 校验结果 + """ + file_extension = file.filename.rsplit('.', 1)[-1] + + return file_extension in UploadConfig.DEFAULT_ALLOWED_EXTENSION + + @classmethod + def check_file_timestamp(cls, filename: str) -> bool: + """ + 校验文件时间戳是否合法 + + :param filename: 文件名称 + :return: 校验结果 + """ + timestamp = ( + filename.rsplit('.', 1)[0].rsplit('_', maxsplit=1)[-1].split(UploadConfig.UPLOAD_MACHINE, maxsplit=1)[0] + ) + try: + datetime.strptime(timestamp, '%Y%m%d%H%M%S') + return True + except ValueError: + return False + + @classmethod + def check_file_machine(cls, filename: str) -> bool: + """ + 校验文件机器码是否合法 + + :param filename: 文件名称 + :return: 校验结果 + """ + return filename.rsplit('.', 1)[0][-4] == UploadConfig.UPLOAD_MACHINE + + @classmethod + def check_file_random_code(cls, filename: str) -> bool: + """ + 校验文件随机码是否合法 + + :param filename: 文件名称 + :return: 校验结果 + """ + valid_code_list = [f'{i:03}' for i in range(1, 999)] + + return filename.rsplit('.', 1)[0][-3:] in valid_code_list + + @classmethod + async def generate_file(cls, filepath: str) -> AsyncGenerator[bytes, None]: + """ + 根据文件生成二进制数据 + + :param filepath: 文件路径 + :yield: 二进制数据 + """ + async with aiofiles.open(filepath, 'rb') as response_file: + async for chunk in response_file: + yield chunk + + @classmethod + def delete_file(cls, filepath: str) -> None: + """ + 根据文件路径删除对应文件 + + :param filepath: 文件路径 + """ + os.remove(filepath) diff --git a/shierfeng-fastapi-frontend/.env.development b/shierfeng-fastapi-frontend/.env.development new file mode 100644 index 0000000..a086d04 --- /dev/null +++ b/shierfeng-fastapi-frontend/.env.development @@ -0,0 +1,8 @@ +# 页面标题 +VITE_APP_TITLE = vfadmin管理系统 + +# 开发环境配置 +VITE_APP_ENV = 'development' + +# vfadmin管理系统/开发环境 +VITE_APP_BASE_API = '/dev-api' diff --git a/shierfeng-fastapi-frontend/.env.docker b/shierfeng-fastapi-frontend/.env.docker new file mode 100644 index 0000000..8487fb4 --- /dev/null +++ b/shierfeng-fastapi-frontend/.env.docker @@ -0,0 +1,11 @@ +# 页面标题 +VITE_APP_TITLE = vfadmin管理系统 + +# 生产环境配置 +VITE_APP_ENV = 'docker' + +# vfadmin管理系统/生产环境 +VITE_APP_BASE_API = '/docker-api' + +# 是否在打包时开启压缩,支持 gzip 和 brotli +VITE_BUILD_COMPRESS = gzip \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/.env.production b/shierfeng-fastapi-frontend/.env.production new file mode 100644 index 0000000..ac80031 --- /dev/null +++ b/shierfeng-fastapi-frontend/.env.production @@ -0,0 +1,11 @@ +# 页面标题 +VITE_APP_TITLE = vfadmin管理系统 + +# 生产环境配置 +VITE_APP_ENV = 'production' + +# vfadmin管理系统/生产环境 +VITE_APP_BASE_API = '/prod-api' + +# 是否在打包时开启压缩,支持 gzip 和 brotli +VITE_BUILD_COMPRESS = gzip \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/.env.staging b/shierfeng-fastapi-frontend/.env.staging new file mode 100644 index 0000000..c3fcf1a --- /dev/null +++ b/shierfeng-fastapi-frontend/.env.staging @@ -0,0 +1,11 @@ +# 页面标题 +VITE_APP_TITLE = vfadmin管理系统 + +# 生产环境配置 +VITE_APP_ENV = 'staging' + +# vfadmin管理系统/生产环境 +VITE_APP_BASE_API = '/stage-api' + +# 是否在打包时开启压缩,支持 gzip 和 brotli +VITE_BUILD_COMPRESS = gzip \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/.gitignore b/shierfeng-fastapi-frontend/.gitignore new file mode 100644 index 0000000..78a752d --- /dev/null +++ b/shierfeng-fastapi-frontend/.gitignore @@ -0,0 +1,23 @@ +.DS_Store +node_modules/ +dist/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +**/*.log + +tests/**/coverage/ +tests/e2e/reports +selenium-debug.log + +# Editor directories and files +.idea +.vscode +*.suo +*.ntvs* +*.njsproj +*.sln +*.local + +package-lock.json +yarn.lock diff --git a/shierfeng-fastapi-frontend/Dockerfile b/shierfeng-fastapi-frontend/Dockerfile new file mode 100644 index 0000000..4235ee5 --- /dev/null +++ b/shierfeng-fastapi-frontend/Dockerfile @@ -0,0 +1,28 @@ +# 构建阶段 +FROM node:18-slim AS builder +WORKDIR /app + +# 复制源代码 +COPY . . + +# 设置npm镜像源 +RUN npm config set registry https://registry.npmmirror.com + +# 安装依赖 +RUN npm install + +# 执行docker构建命令 +RUN npm run build:docker + +# 运行阶段 +FROM nginx:latest +WORKDIR /usr/share/nginx/html + +# 复制构建产物 +COPY --from=builder /app/dist . + +# 暴露端口 +EXPOSE 80 + +# 启动nginx +CMD ["nginx", "-g", "daemon off;"] \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/LICENSE b/shierfeng-fastapi-frontend/LICENSE new file mode 100644 index 0000000..8564f29 --- /dev/null +++ b/shierfeng-fastapi-frontend/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2018 RuoYi + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/bin/build.bat b/shierfeng-fastapi-frontend/bin/build.bat new file mode 100644 index 0000000..ecbb454 --- /dev/null +++ b/shierfeng-fastapi-frontend/bin/build.bat @@ -0,0 +1,12 @@ +@echo off +echo. +echo [Ϣ] Weḅdistļ +echo. + +%~d0 +cd %~dp0 + +cd .. +yarn build:prod + +pause \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/bin/nginx.dockermy.conf b/shierfeng-fastapi-frontend/bin/nginx.dockermy.conf new file mode 100644 index 0000000..adae1dc --- /dev/null +++ b/shierfeng-fastapi-frontend/bin/nginx.dockermy.conf @@ -0,0 +1,24 @@ +server { + listen 80; + server_name localhost; + + location / { + root /usr/share/nginx/html; + index index.html index.htm; + try_files $uri $uri/ /index.html; + } + + # API代理配置(MySQL版本) + location /docker-api/ { + proxy_pass http://shierfeng-backend-my:9099/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + + error_page 500 502 503 504 /50x.html; + location = /50x.html { + root /usr/share/nginx/html; + } +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/bin/nginx.dockerpg.conf b/shierfeng-fastapi-frontend/bin/nginx.dockerpg.conf new file mode 100644 index 0000000..6b4c14b --- /dev/null +++ b/shierfeng-fastapi-frontend/bin/nginx.dockerpg.conf @@ -0,0 +1,24 @@ +server { + listen 80; + server_name localhost; + + location / { + root /usr/share/nginx/html; + index index.html index.htm; + try_files $uri $uri/ /index.html; + } + + # API代理配置(PostgreSQL版本) + location /docker-api/ { + proxy_pass http://shierfeng-backend-pg:9099/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + + error_page 500 502 503 504 /50x.html; + location = /50x.html { + root /usr/share/nginx/html; + } +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/bin/package.bat b/shierfeng-fastapi-frontend/bin/package.bat new file mode 100644 index 0000000..f5b24e0 --- /dev/null +++ b/shierfeng-fastapi-frontend/bin/package.bat @@ -0,0 +1,12 @@ +@echo off +echo. +echo [Ϣ] װWeḅnode_modulesļ +echo. + +%~d0 +cd %~dp0 + +cd .. +yarn --registry=https://registry.npmmirror.com + +pause \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/bin/run-web.bat b/shierfeng-fastapi-frontend/bin/run-web.bat new file mode 100644 index 0000000..d2fe397 --- /dev/null +++ b/shierfeng-fastapi-frontend/bin/run-web.bat @@ -0,0 +1,12 @@ +@echo off +echo. +echo [Ϣ] ʹ Vite Web ̡ +echo. + +%~d0 +cd %~dp0 + +cd .. +yarn dev + +pause \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/html/ie.html b/shierfeng-fastapi-frontend/html/ie.html new file mode 100644 index 0000000..052ffcd --- /dev/null +++ b/shierfeng-fastapi-frontend/html/ie.html @@ -0,0 +1,46 @@ + + + + + + 请升级您的浏览器 + + + + + + +

请升级您的浏览器,以便我们更好的为您提供服务!

+

您正在使用 Internet Explorer 的早期版本(IE11以下版本或使用该内核的浏览器)。这意味着在升级浏览器前,您将无法访问此网站。

+
+

请注意:微软公司对Windows XP 及 Internet Explorer 早期版本的支持已经结束

+

自 2016 年 1 月 12 日起,Microsoft 不再为 IE 11 以下版本提供相应支持和更新。没有关键的浏览器安全更新,您的电脑可能易受有害病毒、间谍软件和其他恶意软件的攻击,它们可以窃取或损害您的业务数据和信息。请参阅 微软对 Internet Explorer 早期版本的支持将于 2016 年 1 月 12 日结束的说明

+
+

您可以选择更先进的浏览器

+

推荐使用以下浏览器的最新版本。如果您的电脑已有以下浏览器的最新版本则直接使用该浏览器访问即可。

+ +
+ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/index.html b/shierfeng-fastapi-frontend/index.html new file mode 100644 index 0000000..17457d3 --- /dev/null +++ b/shierfeng-fastapi-frontend/index.html @@ -0,0 +1,215 @@ + + + + + + + + + + %VITE_APP_TITLE% + + + + + +
+
+
+
+
+
正在加载系统资源,请耐心等待
+
+
+ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/package.json b/shierfeng-fastapi-frontend/package.json new file mode 100644 index 0000000..c2e7c5d --- /dev/null +++ b/shierfeng-fastapi-frontend/package.json @@ -0,0 +1,65 @@ +{ + "name": "vfadmin", + "version": "1.9.0", + "description": "vfadmin管理系统", + "author": "insistence", + "license": "MIT", + "type": "module", + "scripts": { + "dev": "vite", + "build:prod": "vite build", + "build:docker": "vite build --mode docker", + "build:stage": "vite build --mode staging", + "preview": "vite preview" + }, + "repository": { + "type": "git", + "url": "https://git.yujiangrubber.cn/niuniu/ShiErFeng.git" + }, + "dependencies": { + "@ant-design/icons-vue": "^7.0.1", + "@antv/g2plot": "^2.4.31", + "@antv/infographic": "^0.2.13", + "@element-plus/icons-vue": "2.3.2", + "@vueup/vue-quill": "1.2.0", + "@vueuse/core": "14.1.0", + "ant-design-vue": "^4.1.1", + "axios": "1.13.5", + "clipboard": "2.0.11", + "echarts": "5.6.0", + "element-plus": "2.13.1", + "file-saver": "2.0.5", + "fuse.js": "7.1.0", + "js-beautify": "1.15.4", + "js-cookie": "3.0.5", + "jsencrypt": "3.3.2", + "katex": ">=0.16.27", + "markstream-vue": ">=0.0.7-beta.6", + "mermaid": ">=11.12.2", + "nprogress": "0.2.0", + "pinia": "3.0.4", + "shiki": "^3.21.0", + "splitpanes": "4.0.4", + "stream-markdown": ">=0.0.14", + "stream-monaco": ">=0.0.17", + "uuid": "13.0.0", + "vue": "3.5.26", + "vue-cropper": "1.1.1", + "vue-router": "4.6.4", + "vuedraggable": "4.1.0" + }, + "devDependencies": { + "@vitejs/plugin-vue": "5.2.4", + "less": "^4.2.0", + "sass-embedded": "1.97.2", + "unplugin-auto-import": "0.18.6", + "unplugin-vue-setup-extend-plus": "1.0.1", + "vite": "6.4.1", + "vite-plugin-compression": "0.5.1", + "vite-plugin-monaco-editor-esm": "2.0.2", + "vite-plugin-svg-icons": "2.0.1" + }, + "overrides": { + "quill": "2.0.2" + } +} diff --git a/shierfeng-fastapi-frontend/public/favicon.ico b/shierfeng-fastapi-frontend/public/favicon.ico new file mode 100644 index 0000000..e263760 Binary files /dev/null and b/shierfeng-fastapi-frontend/public/favicon.ico differ diff --git a/shierfeng-fastapi-frontend/src/App.vue b/shierfeng-fastapi-frontend/src/App.vue new file mode 100644 index 0000000..31839f2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/App.vue @@ -0,0 +1,15 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/api/ai/chat.js b/shierfeng-fastapi-frontend/src/api/ai/chat.js new file mode 100644 index 0000000..ac47b39 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/ai/chat.js @@ -0,0 +1,53 @@ +import request from "@/utils/request"; + +// 获取会话列表 +export function listChatSession() { + return request({ + url: "/ai/chat/session/list", + method: "get", + }); +} + +// 删除会话 +export function delChatSession(sessionId) { + return request({ + url: "/ai/chat/session/" + sessionId, + method: "delete", + }); +} + +// 获取会话详情 +export function getChatSession(sessionId) { + return request({ + url: "/ai/chat/session/" + sessionId, + method: "get", + }); +} + +// 获取用户对话配置 +export function getUserChatConfig() { + return request({ + url: "/ai/chat/config", + method: "get", + }); +} + +// 保存用户对话配置 +export function saveUserChatConfig(data) { + return request({ + url: "/ai/chat/config", + method: "put", + data: data, + }); +} + +// 取消对话 +export function cancelChatRun(runId) { + return request({ + url: "/ai/chat/cancel", + method: "post", + data: { + runId: runId, + }, + }); +} diff --git a/shierfeng-fastapi-frontend/src/api/ai/model.js b/shierfeng-fastapi-frontend/src/api/ai/model.js new file mode 100644 index 0000000..1d98442 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/ai/model.js @@ -0,0 +1,52 @@ +import request from "@/utils/request"; + +// 查询AI模型列表 +export function listModel(query) { + return request({ + url: "/ai/model/list", + method: "get", + params: query, + }); +} + +// 查询所有AI模型列表 +export function listModelAll() { + return request({ + url: "/ai/model/all", + method: "get", + }); +} + +// 查询AI模型详细 +export function getModel(modelId) { + return request({ + url: "/ai/model/" + modelId, + method: "get", + }); +} + +// 新增AI模型 +export function addModel(data) { + return request({ + url: "/ai/model", + method: "post", + data: data, + }); +} + +// 修改AI模型 +export function updateModel(data) { + return request({ + url: "/ai/model", + method: "put", + data: data, + }); +} + +// 删除AI模型 +export function delModel(modelId) { + return request({ + url: "/ai/model/" + modelId, + method: "delete", + }); +} diff --git a/shierfeng-fastapi-frontend/src/api/login.js b/shierfeng-fastapi-frontend/src/api/login.js new file mode 100644 index 0000000..83d7d61 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/login.js @@ -0,0 +1,61 @@ +import request from '@/utils/request' + +// 登录方法 +export function login(username, password, code, uuid) { + const data = { + username, + password, + code, + uuid + } + return request({ + url: '/login', + headers: { + isToken: false, + repeatSubmit: false, + 'Content-Type': 'application/x-www-form-urlencoded' + }, + method: 'post', + data: data + }) +} + +// 注册方法 +export function register(data) { + return request({ + url: '/register', + headers: { + isToken: false + }, + method: 'post', + data: data + }) +} + +// 获取用户详细信息 +export function getInfo() { + return request({ + url: '/getInfo', + method: 'get' + }) +} + +// 退出方法 +export function logout() { + return request({ + url: '/logout', + method: 'post' + }) +} + +// 获取验证码 +export function getCodeImg() { + return request({ + url: '/captchaImage', + headers: { + isToken: false + }, + method: 'get', + timeout: 20000 + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/menu.js b/shierfeng-fastapi-frontend/src/api/menu.js new file mode 100644 index 0000000..faef101 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/menu.js @@ -0,0 +1,9 @@ +import request from '@/utils/request' + +// 获取路由 +export const getRouters = () => { + return request({ + url: '/getRouters', + method: 'get' + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/monitor/cache.js b/shierfeng-fastapi-frontend/src/api/monitor/cache.js new file mode 100644 index 0000000..72c5f6a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/cache.js @@ -0,0 +1,57 @@ +import request from '@/utils/request' + +// 查询缓存详细 +export function getCache() { + return request({ + url: '/monitor/cache', + method: 'get' + }) +} + +// 查询缓存名称列表 +export function listCacheName() { + return request({ + url: '/monitor/cache/getNames', + method: 'get' + }) +} + +// 查询缓存键名列表 +export function listCacheKey(cacheName) { + return request({ + url: '/monitor/cache/getKeys/' + cacheName, + method: 'get' + }) +} + +// 查询缓存内容 +export function getCacheValue(cacheName, cacheKey) { + return request({ + url: '/monitor/cache/getValue/' + cacheName + '/' + cacheKey, + method: 'get' + }) +} + +// 清理指定名称缓存 +export function clearCacheName(cacheName) { + return request({ + url: '/monitor/cache/clearCacheName/' + cacheName, + method: 'delete' + }) +} + +// 清理指定键名缓存 +export function clearCacheKey(cacheKey) { + return request({ + url: '/monitor/cache/clearCacheKey/' + cacheKey, + method: 'delete' + }) +} + +// 清理全部缓存 +export function clearCacheAll() { + return request({ + url: '/monitor/cache/clearCacheAll', + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/monitor/job.js b/shierfeng-fastapi-frontend/src/api/monitor/job.js new file mode 100644 index 0000000..3815569 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/job.js @@ -0,0 +1,71 @@ +import request from '@/utils/request' + +// 查询定时任务调度列表 +export function listJob(query) { + return request({ + url: '/monitor/job/list', + method: 'get', + params: query + }) +} + +// 查询定时任务调度详细 +export function getJob(jobId) { + return request({ + url: '/monitor/job/' + jobId, + method: 'get' + }) +} + +// 新增定时任务调度 +export function addJob(data) { + return request({ + url: '/monitor/job', + method: 'post', + data: data + }) +} + +// 修改定时任务调度 +export function updateJob(data) { + return request({ + url: '/monitor/job', + method: 'put', + data: data + }) +} + +// 删除定时任务调度 +export function delJob(jobId) { + return request({ + url: '/monitor/job/' + jobId, + method: 'delete' + }) +} + +// 任务状态修改 +export function changeJobStatus(jobId, status) { + const data = { + jobId, + status + } + return request({ + url: '/monitor/job/changeStatus', + method: 'put', + data: data + }) +} + + +// 定时任务立即执行一次 +export function runJob(jobId, jobGroup) { + const data = { + jobId, + jobGroup + } + return request({ + url: '/monitor/job/run', + method: 'put', + data: data + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/monitor/jobLog.js b/shierfeng-fastapi-frontend/src/api/monitor/jobLog.js new file mode 100644 index 0000000..6e0be61 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/jobLog.js @@ -0,0 +1,26 @@ +import request from '@/utils/request' + +// 查询调度日志列表 +export function listJobLog(query) { + return request({ + url: '/monitor/jobLog/list', + method: 'get', + params: query + }) +} + +// 删除调度日志 +export function delJobLog(jobLogId) { + return request({ + url: '/monitor/jobLog/' + jobLogId, + method: 'delete' + }) +} + +// 清空调度日志 +export function cleanJobLog() { + return request({ + url: '/monitor/jobLog/clean', + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/monitor/logininfor.js b/shierfeng-fastapi-frontend/src/api/monitor/logininfor.js new file mode 100644 index 0000000..4d112b7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/logininfor.js @@ -0,0 +1,34 @@ +import request from '@/utils/request' + +// 查询登录日志列表 +export function list(query) { + return request({ + url: '/monitor/logininfor/list', + method: 'get', + params: query + }) +} + +// 删除登录日志 +export function delLogininfor(infoId) { + return request({ + url: '/monitor/logininfor/' + infoId, + method: 'delete' + }) +} + +// 解锁用户登录状态 +export function unlockLogininfor(userName) { + return request({ + url: '/monitor/logininfor/unlock/' + userName, + method: 'get' + }) +} + +// 清空登录日志 +export function cleanLogininfor() { + return request({ + url: '/monitor/logininfor/clean', + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/monitor/online.js b/shierfeng-fastapi-frontend/src/api/monitor/online.js new file mode 100644 index 0000000..bd22137 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/online.js @@ -0,0 +1,18 @@ +import request from '@/utils/request' + +// 查询在线用户列表 +export function list(query) { + return request({ + url: '/monitor/online/list', + method: 'get', + params: query + }) +} + +// 强退用户 +export function forceLogout(tokenId) { + return request({ + url: '/monitor/online/' + tokenId, + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/monitor/operlog.js b/shierfeng-fastapi-frontend/src/api/monitor/operlog.js new file mode 100644 index 0000000..a04bca8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/operlog.js @@ -0,0 +1,26 @@ +import request from '@/utils/request' + +// 查询操作日志列表 +export function list(query) { + return request({ + url: '/monitor/operlog/list', + method: 'get', + params: query + }) +} + +// 删除操作日志 +export function delOperlog(operId) { + return request({ + url: '/monitor/operlog/' + operId, + method: 'delete' + }) +} + +// 清空操作日志 +export function cleanOperlog() { + return request({ + url: '/monitor/operlog/clean', + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/monitor/server.js b/shierfeng-fastapi-frontend/src/api/monitor/server.js new file mode 100644 index 0000000..e1f9ca2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/server.js @@ -0,0 +1,9 @@ +import request from '@/utils/request' + +// 获取服务信息 +export function getServer() { + return request({ + url: '/monitor/server', + method: 'get' + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/monitor/transportCrypto.js b/shierfeng-fastapi-frontend/src/api/monitor/transportCrypto.js new file mode 100644 index 0000000..6636bc0 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/monitor/transportCrypto.js @@ -0,0 +1,9 @@ +import request from '@/utils/request' + +// 获取传输加密监控信息 +export function getTransportCryptoMonitor() { + return request({ + url: '/transport/crypto/monitor', + method: 'get' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/config.js b/shierfeng-fastapi-frontend/src/api/system/config.js new file mode 100644 index 0000000..a404d82 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/config.js @@ -0,0 +1,60 @@ +import request from '@/utils/request' + +// 查询参数列表 +export function listConfig(query) { + return request({ + url: '/system/config/list', + method: 'get', + params: query + }) +} + +// 查询参数详细 +export function getConfig(configId) { + return request({ + url: '/system/config/' + configId, + method: 'get' + }) +} + +// 根据参数键名查询参数值 +export function getConfigKey(configKey) { + return request({ + url: '/system/config/configKey/' + configKey, + method: 'get' + }) +} + +// 新增参数配置 +export function addConfig(data) { + return request({ + url: '/system/config', + method: 'post', + data: data + }) +} + +// 修改参数配置 +export function updateConfig(data) { + return request({ + url: '/system/config', + method: 'put', + data: data + }) +} + +// 删除参数配置 +export function delConfig(configId) { + return request({ + url: '/system/config/' + configId, + method: 'delete' + }) +} + +// 刷新参数缓存 +export function refreshCache() { + return request({ + url: '/system/config/refreshCache', + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/dept.js b/shierfeng-fastapi-frontend/src/api/system/dept.js new file mode 100644 index 0000000..fc943cd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/dept.js @@ -0,0 +1,52 @@ +import request from '@/utils/request' + +// 查询部门列表 +export function listDept(query) { + return request({ + url: '/system/dept/list', + method: 'get', + params: query + }) +} + +// 查询部门列表(排除节点) +export function listDeptExcludeChild(deptId) { + return request({ + url: '/system/dept/list/exclude/' + deptId, + method: 'get' + }) +} + +// 查询部门详细 +export function getDept(deptId) { + return request({ + url: '/system/dept/' + deptId, + method: 'get' + }) +} + +// 新增部门 +export function addDept(data) { + return request({ + url: '/system/dept', + method: 'post', + data: data + }) +} + +// 修改部门 +export function updateDept(data) { + return request({ + url: '/system/dept', + method: 'put', + data: data + }) +} + +// 删除部门 +export function delDept(deptId) { + return request({ + url: '/system/dept/' + deptId, + method: 'delete' + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/system/dict/data.js b/shierfeng-fastapi-frontend/src/api/system/dict/data.js new file mode 100644 index 0000000..6c9eb79 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/dict/data.js @@ -0,0 +1,52 @@ +import request from '@/utils/request' + +// 查询字典数据列表 +export function listData(query) { + return request({ + url: '/system/dict/data/list', + method: 'get', + params: query + }) +} + +// 查询字典数据详细 +export function getData(dictCode) { + return request({ + url: '/system/dict/data/' + dictCode, + method: 'get' + }) +} + +// 根据字典类型查询字典数据信息 +export function getDicts(dictType) { + return request({ + url: '/system/dict/data/type/' + dictType, + method: 'get' + }) +} + +// 新增字典数据 +export function addData(data) { + return request({ + url: '/system/dict/data', + method: 'post', + data: data + }) +} + +// 修改字典数据 +export function updateData(data) { + return request({ + url: '/system/dict/data', + method: 'put', + data: data + }) +} + +// 删除字典数据 +export function delData(dictCode) { + return request({ + url: '/system/dict/data/' + dictCode, + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/dict/type.js b/shierfeng-fastapi-frontend/src/api/system/dict/type.js new file mode 100644 index 0000000..a0254ba --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/dict/type.js @@ -0,0 +1,60 @@ +import request from '@/utils/request' + +// 查询字典类型列表 +export function listType(query) { + return request({ + url: '/system/dict/type/list', + method: 'get', + params: query + }) +} + +// 查询字典类型详细 +export function getType(dictId) { + return request({ + url: '/system/dict/type/' + dictId, + method: 'get' + }) +} + +// 新增字典类型 +export function addType(data) { + return request({ + url: '/system/dict/type', + method: 'post', + data: data + }) +} + +// 修改字典类型 +export function updateType(data) { + return request({ + url: '/system/dict/type', + method: 'put', + data: data + }) +} + +// 删除字典类型 +export function delType(dictId) { + return request({ + url: '/system/dict/type/' + dictId, + method: 'delete' + }) +} + +// 刷新字典缓存 +export function refreshCache() { + return request({ + url: '/system/dict/type/refreshCache', + method: 'delete' + }) +} + +// 获取字典选择框列表 +export function optionselect() { + return request({ + url: '/system/dict/type/optionselect', + method: 'get' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/menu.js b/shierfeng-fastapi-frontend/src/api/system/menu.js new file mode 100644 index 0000000..f6415c6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/menu.js @@ -0,0 +1,60 @@ +import request from '@/utils/request' + +// 查询菜单列表 +export function listMenu(query) { + return request({ + url: '/system/menu/list', + method: 'get', + params: query + }) +} + +// 查询菜单详细 +export function getMenu(menuId) { + return request({ + url: '/system/menu/' + menuId, + method: 'get' + }) +} + +// 查询菜单下拉树结构 +export function treeselect() { + return request({ + url: '/system/menu/treeselect', + method: 'get' + }) +} + +// 根据角色ID查询菜单下拉树结构 +export function roleMenuTreeselect(roleId) { + return request({ + url: '/system/menu/roleMenuTreeselect/' + roleId, + method: 'get' + }) +} + +// 新增菜单 +export function addMenu(data) { + return request({ + url: '/system/menu', + method: 'post', + data: data + }) +} + +// 修改菜单 +export function updateMenu(data) { + return request({ + url: '/system/menu', + method: 'put', + data: data + }) +} + +// 删除菜单 +export function delMenu(menuId) { + return request({ + url: '/system/menu/' + menuId, + method: 'delete' + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/system/notice.js b/shierfeng-fastapi-frontend/src/api/system/notice.js new file mode 100644 index 0000000..c274ea5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/notice.js @@ -0,0 +1,44 @@ +import request from '@/utils/request' + +// 查询公告列表 +export function listNotice(query) { + return request({ + url: '/system/notice/list', + method: 'get', + params: query + }) +} + +// 查询公告详细 +export function getNotice(noticeId) { + return request({ + url: '/system/notice/' + noticeId, + method: 'get' + }) +} + +// 新增公告 +export function addNotice(data) { + return request({ + url: '/system/notice', + method: 'post', + data: data + }) +} + +// 修改公告 +export function updateNotice(data) { + return request({ + url: '/system/notice', + method: 'put', + data: data + }) +} + +// 删除公告 +export function delNotice(noticeId) { + return request({ + url: '/system/notice/' + noticeId, + method: 'delete' + }) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/api/system/post.js b/shierfeng-fastapi-frontend/src/api/system/post.js new file mode 100644 index 0000000..1a8e9ca --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/post.js @@ -0,0 +1,44 @@ +import request from '@/utils/request' + +// 查询岗位列表 +export function listPost(query) { + return request({ + url: '/system/post/list', + method: 'get', + params: query + }) +} + +// 查询岗位详细 +export function getPost(postId) { + return request({ + url: '/system/post/' + postId, + method: 'get' + }) +} + +// 新增岗位 +export function addPost(data) { + return request({ + url: '/system/post', + method: 'post', + data: data + }) +} + +// 修改岗位 +export function updatePost(data) { + return request({ + url: '/system/post', + method: 'put', + data: data + }) +} + +// 删除岗位 +export function delPost(postId) { + return request({ + url: '/system/post/' + postId, + method: 'delete' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/role.js b/shierfeng-fastapi-frontend/src/api/system/role.js new file mode 100644 index 0000000..f13e6f4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/role.js @@ -0,0 +1,119 @@ +import request from '@/utils/request' + +// 查询角色列表 +export function listRole(query) { + return request({ + url: '/system/role/list', + method: 'get', + params: query + }) +} + +// 查询角色详细 +export function getRole(roleId) { + return request({ + url: '/system/role/' + roleId, + method: 'get' + }) +} + +// 新增角色 +export function addRole(data) { + return request({ + url: '/system/role', + method: 'post', + data: data + }) +} + +// 修改角色 +export function updateRole(data) { + return request({ + url: '/system/role', + method: 'put', + data: data + }) +} + +// 角色数据权限 +export function dataScope(data) { + return request({ + url: '/system/role/dataScope', + method: 'put', + data: data + }) +} + +// 角色状态修改 +export function changeRoleStatus(roleId, status) { + const data = { + roleId, + status + } + return request({ + url: '/system/role/changeStatus', + method: 'put', + data: data + }) +} + +// 删除角色 +export function delRole(roleId) { + return request({ + url: '/system/role/' + roleId, + method: 'delete' + }) +} + +// 查询角色已授权用户列表 +export function allocatedUserList(query) { + return request({ + url: '/system/role/authUser/allocatedList', + method: 'get', + params: query + }) +} + +// 查询角色未授权用户列表 +export function unallocatedUserList(query) { + return request({ + url: '/system/role/authUser/unallocatedList', + method: 'get', + params: query + }) +} + +// 取消用户授权角色 +export function authUserCancel(data) { + return request({ + url: '/system/role/authUser/cancel', + method: 'put', + data: data + }) +} + +// 批量取消用户授权角色 +export function authUserCancelAll(data) { + return request({ + url: '/system/role/authUser/cancelAll', + method: 'put', + params: data + }) +} + +// 授权用户选择 +export function authUserSelectAll(data) { + return request({ + url: '/system/role/authUser/selectAll', + method: 'put', + params: data + }) +} + +// 根据角色ID查询部门树结构 +export function deptTreeSelect(roleId) { + return request({ + url: '/system/role/deptTree/' + roleId, + method: 'get' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/system/user.js b/shierfeng-fastapi-frontend/src/api/system/user.js new file mode 100644 index 0000000..e63875d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/system/user.js @@ -0,0 +1,136 @@ +import request from '@/utils/request' +import { parseStrEmpty } from "@/utils/shierfeng"; + +// 查询用户列表 +export function listUser(query) { + return request({ + url: '/system/user/list', + method: 'get', + params: query + }) +} + +// 查询用户详细 +export function getUser(userId) { + return request({ + url: '/system/user/' + parseStrEmpty(userId), + method: 'get' + }) +} + +// 新增用户 +export function addUser(data) { + return request({ + url: '/system/user', + method: 'post', + data: data + }) +} + +// 修改用户 +export function updateUser(data) { + return request({ + url: '/system/user', + method: 'put', + data: data + }) +} + +// 删除用户 +export function delUser(userId) { + return request({ + url: '/system/user/' + userId, + method: 'delete' + }) +} + +// 用户密码重置 +export function resetUserPwd(userId, password) { + const data = { + userId, + password + } + return request({ + url: '/system/user/resetPwd', + method: 'put', + data: data + }) +} + +// 用户状态修改 +export function changeUserStatus(userId, status) { + const data = { + userId, + status + } + return request({ + url: '/system/user/changeStatus', + method: 'put', + data: data + }) +} + +// 查询用户个人信息 +export function getUserProfile() { + return request({ + url: '/system/user/profile', + method: 'get' + }) +} + +// 修改用户个人信息 +export function updateUserProfile(data) { + return request({ + url: '/system/user/profile', + method: 'put', + data: data + }) +} + +// 用户密码重置 +export function updateUserPwd(oldPassword, newPassword) { + const data = { + oldPassword, + newPassword + } + return request({ + url: '/system/user/profile/updatePwd', + method: 'put', + data: data + }) +} + +// 用户头像上传 +export function uploadAvatar(data) { + return request({ + url: '/system/user/profile/avatar', + method: 'post', + headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, + data: data + }) +} + +// 查询授权角色 +export function getAuthRole(userId) { + return request({ + url: '/system/user/authRole/' + userId, + method: 'get' + }) +} + +// 保存授权角色 +export function updateAuthRole(data) { + return request({ + url: '/system/user/authRole', + method: 'put', + params: data + }) +} + +// 查询部门下拉树结构 +export function deptTreeSelect() { + return request({ + url: '/system/user/deptTree', + method: 'get' + }) +} diff --git a/shierfeng-fastapi-frontend/src/api/tool/gen.js b/shierfeng-fastapi-frontend/src/api/tool/gen.js new file mode 100644 index 0000000..2075677 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/api/tool/gen.js @@ -0,0 +1,85 @@ +import request from '@/utils/request' + +// 查询生成表数据 +export function listTable(query) { + return request({ + url: '/tool/gen/list', + method: 'get', + params: query + }) +} +// 查询db数据库列表 +export function listDbTable(query) { + return request({ + url: '/tool/gen/db/list', + method: 'get', + params: query + }) +} + +// 查询表详细信息 +export function getGenTable(tableId) { + return request({ + url: '/tool/gen/' + tableId, + method: 'get' + }) +} + +// 修改代码生成信息 +export function updateGenTable(data) { + return request({ + url: '/tool/gen', + method: 'put', + data: data + }) +} + +// 导入表 +export function importTable(data) { + return request({ + url: '/tool/gen/importTable', + method: 'post', + params: data + }) +} + +// 创建表 +export function createTable(data) { + return request({ + url: '/tool/gen/createTable', + method: 'post', + params: data + }) +} + +// 预览生成代码 +export function previewTable(tableId) { + return request({ + url: '/tool/gen/preview/' + tableId, + method: 'get' + }) +} + +// 删除表数据 +export function delTable(tableId) { + return request({ + url: '/tool/gen/' + tableId, + method: 'delete' + }) +} + +// 生成代码(自定义路径) +export function genCode(tableName) { + return request({ + url: '/tool/gen/genCode/' + tableName, + method: 'get' + }) +} + +// 同步数据库 +export function synchDb(tableName) { + return request({ + url: '/tool/gen/synchDb/' + tableName, + method: 'get' + }) +} diff --git a/shierfeng-fastapi-frontend/src/assets/401_images/401.gif b/shierfeng-fastapi-frontend/src/assets/401_images/401.gif new file mode 100644 index 0000000..cd6e0d9 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/401_images/401.gif differ diff --git a/shierfeng-fastapi-frontend/src/assets/404_images/404.png b/shierfeng-fastapi-frontend/src/assets/404_images/404.png new file mode 100644 index 0000000..3d8e230 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/404_images/404.png differ diff --git a/shierfeng-fastapi-frontend/src/assets/404_images/404_cloud.png b/shierfeng-fastapi-frontend/src/assets/404_images/404_cloud.png new file mode 100644 index 0000000..c6281d0 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/404_images/404_cloud.png differ diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/404.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/404.svg new file mode 100644 index 0000000..6df5019 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/404.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-chat.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-chat.svg new file mode 100644 index 0000000..1d712a9 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-chat.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-manage.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-manage.svg new file mode 100644 index 0000000..e6a6921 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-manage.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-model.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-model.svg new file mode 100644 index 0000000..5d3b2b9 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/ai-model.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/bug.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/bug.svg new file mode 100644 index 0000000..05a150d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/bug.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/build.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/build.svg new file mode 100644 index 0000000..97c4688 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/build.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/button.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/button.svg new file mode 100644 index 0000000..904fddc --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/button.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/cascader.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/cascader.svg new file mode 100644 index 0000000..e256024 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/cascader.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/chart.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/chart.svg new file mode 100644 index 0000000..27728fb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/chart.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/checkbox.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/checkbox.svg new file mode 100644 index 0000000..013fd3a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/checkbox.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/clipboard.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/clipboard.svg new file mode 100644 index 0000000..90923ff --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/clipboard.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/code.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/code.svg new file mode 100644 index 0000000..5f9c5ab --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/code.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/color.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/color.svg new file mode 100644 index 0000000..44a81aa --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/color.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/component.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/component.svg new file mode 100644 index 0000000..29c3458 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/component.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/dashboard.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/dashboard.svg new file mode 100644 index 0000000..5317d37 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/dashboard.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/date-range.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/date-range.svg new file mode 100644 index 0000000..fda571e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/date-range.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/date.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/date.svg new file mode 100644 index 0000000..52dc73e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/date.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/deepthink.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/deepthink.svg new file mode 100644 index 0000000..638e13e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/deepthink.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/dict.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/dict.svg new file mode 100644 index 0000000..4849377 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/dict.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/documentation.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/documentation.svg new file mode 100644 index 0000000..7043122 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/documentation.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/download.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/download.svg new file mode 100644 index 0000000..c896951 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/download.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/drag.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/drag.svg new file mode 100644 index 0000000..4185d3c --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/drag.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/druid.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/druid.svg new file mode 100644 index 0000000..a2b4b4e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/druid.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/edit.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/edit.svg new file mode 100644 index 0000000..d26101f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/edit.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/education.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/education.svg new file mode 100644 index 0000000..7bfb01d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/education.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/email.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/email.svg new file mode 100644 index 0000000..74d25e2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/email.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/enter.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/enter.svg new file mode 100644 index 0000000..f7cabf2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/enter.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/example.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/example.svg new file mode 100644 index 0000000..46f42b5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/example.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/excel.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/excel.svg new file mode 100644 index 0000000..74d97b8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/excel.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/exit-fullscreen.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/exit-fullscreen.svg new file mode 100644 index 0000000..485c128 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/exit-fullscreen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/eye-open.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/eye-open.svg new file mode 100644 index 0000000..88dcc98 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/eye-open.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/eye.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/eye.svg new file mode 100644 index 0000000..16ed2d8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/eye.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/form.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/form.svg new file mode 100644 index 0000000..dcbaa18 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/form.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/fullscreen.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/fullscreen.svg new file mode 100644 index 0000000..0e86b6f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/fullscreen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/github.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/github.svg new file mode 100644 index 0000000..db0a0d4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/guide.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/guide.svg new file mode 100644 index 0000000..b271001 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/guide.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/icon.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/icon.svg new file mode 100644 index 0000000..82be8ee --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/input.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/input.svg new file mode 100644 index 0000000..ab91381 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/input.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/international.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/international.svg new file mode 100644 index 0000000..e9b56ee --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/international.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/job.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/job.svg new file mode 100644 index 0000000..2a93a25 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/job.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/language.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/language.svg new file mode 100644 index 0000000..0082b57 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/language.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/link.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/link.svg new file mode 100644 index 0000000..48197ba --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/link.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/list.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/list.svg new file mode 100644 index 0000000..20259ed --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/list.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/lock.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/lock.svg new file mode 100644 index 0000000..74fee54 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/lock.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/log.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/log.svg new file mode 100644 index 0000000..d879d33 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/log.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/logininfor.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/logininfor.svg new file mode 100644 index 0000000..267f844 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/logininfor.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/message.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/message.svg new file mode 100644 index 0000000..14ca817 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/message.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/money.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/money.svg new file mode 100644 index 0000000..c1580de --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/money.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/monitor.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/monitor.svg new file mode 100644 index 0000000..bc308cb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/monitor.svg @@ -0,0 +1,2 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/moon.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/moon.svg new file mode 100755 index 0000000..ec72d77 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/moon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/more-up.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/more-up.svg new file mode 100644 index 0000000..d30ac11 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/more-up.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/nested.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/nested.svg new file mode 100644 index 0000000..06713a8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/nested.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/number.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/number.svg new file mode 100644 index 0000000..ad5ce9a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/number.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/online.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/online.svg new file mode 100644 index 0000000..330a202 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/online.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/password.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/password.svg new file mode 100644 index 0000000..6c64def --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/password.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/pdf.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/pdf.svg new file mode 100644 index 0000000..957aa0c --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/pdf.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/people.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/people.svg new file mode 100644 index 0000000..2bd54ae --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/people.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/peoples.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/peoples.svg new file mode 100644 index 0000000..aab852e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/peoples.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/phone.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/phone.svg new file mode 100644 index 0000000..ab8e8c4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/phone.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/post.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/post.svg new file mode 100644 index 0000000..2922c61 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/post.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/qq.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/qq.svg new file mode 100644 index 0000000..ee13d4e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/qq.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/question.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/question.svg new file mode 100644 index 0000000..cf75bd4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/question.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/radio.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/radio.svg new file mode 100644 index 0000000..0cde345 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/radio.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/rate.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/rate.svg new file mode 100644 index 0000000..aa3b14d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/rate.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/redis-list.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/redis-list.svg new file mode 100644 index 0000000..98a15b2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/redis-list.svg @@ -0,0 +1,2 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/redis.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/redis.svg new file mode 100644 index 0000000..2f1d62d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/redis.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/row.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/row.svg new file mode 100644 index 0000000..0780992 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/row.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/search.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/search.svg new file mode 100644 index 0000000..84233dd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/search.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/select.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/select.svg new file mode 100644 index 0000000..d628382 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/select.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/server.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/server.svg new file mode 100644 index 0000000..eb287e3 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/server.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/shopping.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/shopping.svg new file mode 100644 index 0000000..87513e7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/shopping.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/size.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/size.svg new file mode 100644 index 0000000..1a409f5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/size.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/skill.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/skill.svg new file mode 100644 index 0000000..a3b7312 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/skill.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/slider.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/slider.svg new file mode 100644 index 0000000..fbe4f39 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/slider.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/star.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/star.svg new file mode 100644 index 0000000..6cf86e6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/star.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/sunny.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/sunny.svg new file mode 100755 index 0000000..cc628bf --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/sunny.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/swagger.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/swagger.svg new file mode 100644 index 0000000..05d4e7b --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/swagger.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/switch.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/switch.svg new file mode 100644 index 0000000..0ba61e3 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/switch.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/system.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/system.svg new file mode 100644 index 0000000..5992593 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/system.svg @@ -0,0 +1,2 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/tab.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/tab.svg new file mode 100644 index 0000000..b4b48e4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/tab.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/table.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/table.svg new file mode 100644 index 0000000..0e3dc9d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/table.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/textarea.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/textarea.svg new file mode 100644 index 0000000..2709f29 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/textarea.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/theme.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/theme.svg new file mode 100644 index 0000000..5982a2f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/theme.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/time-range.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/time-range.svg new file mode 100644 index 0000000..13c1202 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/time-range.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/time.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/time.svg new file mode 100644 index 0000000..b376e32 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/time.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/tool.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/tool.svg new file mode 100644 index 0000000..48e0e35 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/tool.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/tree-table.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/tree-table.svg new file mode 100644 index 0000000..8aafdb8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/tree-table.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/tree.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/tree.svg new file mode 100644 index 0000000..dd4b7dd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/tree.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/upload.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/upload.svg new file mode 100644 index 0000000..bae49c0 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/upload.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/user.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/user.svg new file mode 100644 index 0000000..0ba0716 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/user.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/validCode.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/validCode.svg new file mode 100644 index 0000000..cfb1021 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/validCode.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/wechat.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/wechat.svg new file mode 100644 index 0000000..c586e55 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/wechat.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/icons/svg/zip.svg b/shierfeng-fastapi-frontend/src/assets/icons/svg/zip.svg new file mode 100644 index 0000000..f806fc4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/icons/svg/zip.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/images/dark.svg b/shierfeng-fastapi-frontend/src/assets/images/dark.svg new file mode 100644 index 0000000..f646bd7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/images/dark.svg @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/images/light.svg b/shierfeng-fastapi-frontend/src/assets/images/light.svg new file mode 100644 index 0000000..ab7cc08 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/images/light.svg @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/images/login-background.jpg b/shierfeng-fastapi-frontend/src/assets/images/login-background.jpg new file mode 100644 index 0000000..8a89eb8 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/images/login-background.jpg differ diff --git a/shierfeng-fastapi-frontend/src/assets/images/profile.jpg b/shierfeng-fastapi-frontend/src/assets/images/profile.jpg new file mode 100644 index 0000000..94efdf3 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/images/profile.jpg differ diff --git a/shierfeng-fastapi-frontend/src/assets/logo/logo.png b/shierfeng-fastapi-frontend/src/assets/logo/logo.png new file mode 100644 index 0000000..e263760 Binary files /dev/null and b/shierfeng-fastapi-frontend/src/assets/logo/logo.png differ diff --git a/shierfeng-fastapi-frontend/src/assets/styles/btn.scss b/shierfeng-fastapi-frontend/src/assets/styles/btn.scss new file mode 100644 index 0000000..fee3ee1 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/btn.scss @@ -0,0 +1,99 @@ +@use './variables.module.scss' as *; + +@mixin colorBtn($color) { + background: $color; + + &:hover { + color: $color; + + &:before, + &:after { + background: $color; + } + } +} + +.blue-btn { + @include colorBtn($blue) +} + +.light-blue-btn { + @include colorBtn($light-blue) +} + +.red-btn { + @include colorBtn($red) +} + +.pink-btn { + @include colorBtn($pink) +} + +.green-btn { + @include colorBtn($green) +} + +.tiffany-btn { + @include colorBtn($tiffany) +} + +.yellow-btn { + @include colorBtn($yellow) +} + +.pan-btn { + font-size: 14px; + color: #fff; + padding: 14px 36px; + border-radius: 8px; + border: none; + outline: none; + transition: 600ms ease all; + position: relative; + display: inline-block; + + &:hover { + background: #fff; + + &:before, + &:after { + width: 100%; + transition: 600ms ease all; + } + } + + &:before, + &:after { + content: ''; + position: absolute; + top: 0; + right: 0; + height: 2px; + width: 0; + transition: 400ms ease all; + } + + &::after { + right: inherit; + top: inherit; + left: 0; + bottom: 0; + } +} + +.custom-button { + display: inline-block; + line-height: 1; + white-space: nowrap; + cursor: pointer; + background: #fff; + color: #fff; + -webkit-appearance: none; + text-align: center; + box-sizing: border-box; + outline: 0; + margin: 0; + padding: 10px 15px; + font-size: 14px; + border-radius: 4px; +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/element-ui.scss b/shierfeng-fastapi-frontend/src/assets/styles/element-ui.scss new file mode 100644 index 0000000..0f175f2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/element-ui.scss @@ -0,0 +1,96 @@ +// cover some element-ui styles + +.el-breadcrumb__inner, +.el-breadcrumb__inner a { + font-weight: 400 !important; +} + +.el-upload { + input[type="file"] { + display: none !important; + } +} + +.el-upload__input { + display: none; +} + +.cell { + .el-tag { + margin-right: 0px; + } +} + +.small-padding { + .cell { + padding-left: 5px; + padding-right: 5px; + } +} + +.fixed-width { + .el-button--mini { + padding: 7px 10px; + width: 60px; + } +} + +.status-col { + .cell { + padding: 0 10px; + text-align: center; + + .el-tag { + margin-right: 0px; + } + } +} + +// to fixed https://github.com/ElemeFE/element/issues/2461 +.el-dialog { + transform: none; + left: 0; + position: relative; + margin: 0 auto; +} + +// refine element ui upload +.upload-container { + .el-upload { + width: 100%; + + .el-upload-dragger { + width: 100%; + height: 200px; + } + } +} + +// dropdown +.el-dropdown-menu { + a { + display: block + } +} + +// fix date-picker ui bug in filter-item +.el-range-editor.el-input__inner { + display: inline-flex !important; +} + +// to fix el-date-picker css style +.el-range-separator { + box-sizing: content-box; +} + +.el-menu--collapse + > div + > .el-submenu + > .el-submenu__title + .el-submenu__icon-arrow { + display: none; +} + +.el-dropdown .el-dropdown-link{ + color: var(--el-color-primary) !important; +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/assets/styles/index.scss b/shierfeng-fastapi-frontend/src/assets/styles/index.scss new file mode 100644 index 0000000..075ee09 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/index.scss @@ -0,0 +1,179 @@ +@use './mixin.scss'; +@use './transition.scss'; +@use './element-ui.scss'; +@use './sidebar.scss'; +@use './btn.scss'; +@use './shierfeng.scss'; + +body { + height: 100%; + margin: 0; + -moz-osx-font-smoothing: grayscale; + -webkit-font-smoothing: antialiased; + text-rendering: optimizeLegibility; + font-family: Helvetica Neue, Helvetica, PingFang SC, Hiragino Sans GB, Microsoft YaHei, Arial, sans-serif; +} + +label { + font-weight: 700; +} + +html { + height: 100%; + box-sizing: border-box; +} + +#app { + height: 100%; +} + +*, +*:before, +*:after { + box-sizing: inherit; +} + +.no-padding { + padding: 0px !important; +} + +.padding-content { + padding: 4px 0; +} + +a:focus, +a:active { + outline: none; +} + +a, +a:focus, +a:hover { + cursor: pointer; + color: inherit; + text-decoration: none; +} + +div:focus { + outline: none; +} + +.fr { + float: right; +} + +.fl { + float: left; +} + +.pr-5 { + padding-right: 5px; +} + +.pl-5 { + padding-left: 5px; +} + +.block { + display: block; +} + +.pointer { + cursor: pointer; +} + +.inlineBlock { + display: block; +} + +.clearfix { + &:after { + visibility: hidden; + display: block; + font-size: 0; + content: " "; + clear: both; + height: 0; + } +} + +aside { + background: #eef1f6; + padding: 8px 24px; + margin-bottom: 20px; + border-radius: 2px; + display: block; + line-height: 32px; + font-size: 16px; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; + color: #2c3e50; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + + a { + color: #337ab7; + cursor: pointer; + + &:hover { + color: rgb(32, 160, 255); + } + } +} + +//main-container全局样式 +.app-container { + padding: 20px; +} + +.components-container { + margin: 30px 50px; + position: relative; +} + +.text-center { + text-align: center +} + +.sub-navbar { + height: 50px; + line-height: 50px; + position: relative; + width: 100%; + text-align: right; + padding-right: 20px; + transition: 600ms ease position; + background: linear-gradient(90deg, rgba(32, 182, 249, 1) 0%, rgba(32, 182, 249, 1) 0%, rgba(33, 120, 241, 1) 100%, rgba(33, 120, 241, 1) 100%); + + .subtitle { + font-size: 20px; + color: #fff; + } + + &.draft { + background: #d0d0d0; + } + + &.deleted { + background: #d0d0d0; + } +} + +.link-type, +.link-type:focus { + color: #337ab7; + cursor: pointer; + + &:hover { + color: rgb(32, 160, 255); + } +} + +.filter-container { + padding-bottom: 10px; + + .filter-item { + display: inline-block; + vertical-align: middle; + margin-bottom: 10px; + } +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/mixin.scss b/shierfeng-fastapi-frontend/src/assets/styles/mixin.scss new file mode 100644 index 0000000..06fa061 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/mixin.scss @@ -0,0 +1,66 @@ +@mixin clearfix { + &:after { + content: ""; + display: table; + clear: both; + } +} + +@mixin scrollBar { + &::-webkit-scrollbar-track-piece { + background: #d3dce6; + } + + &::-webkit-scrollbar { + width: 6px; + } + + &::-webkit-scrollbar-thumb { + background: #99a9bf; + border-radius: 20px; + } +} + +@mixin relative { + position: relative; + width: 100%; + height: 100%; +} + +@mixin pct($pct) { + width: #{$pct}; + position: relative; + margin: 0 auto; +} + +@mixin triangle($width, $height, $color, $direction) { + $width: $width/2; + $color-border-style: $height solid $color; + $transparent-border-style: $width solid transparent; + height: 0; + width: 0; + + @if $direction==up { + border-bottom: $color-border-style; + border-left: $transparent-border-style; + border-right: $transparent-border-style; + } + + @else if $direction==right { + border-left: $color-border-style; + border-top: $transparent-border-style; + border-bottom: $transparent-border-style; + } + + @else if $direction==down { + border-top: $color-border-style; + border-left: $transparent-border-style; + border-right: $transparent-border-style; + } + + @else if $direction==left { + border-right: $color-border-style; + border-top: $transparent-border-style; + border-bottom: $transparent-border-style; + } +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/shierfeng.scss b/shierfeng-fastapi-frontend/src/assets/styles/shierfeng.scss new file mode 100755 index 0000000..a83c67d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/shierfeng.scss @@ -0,0 +1,308 @@ +/** + * 通用css样式布局处理 + * Copyright (c) 2019 ruoyi + */ + + /** 基础通用 **/ +.pt5 { + padding-top: 5px; +} +.pr5 { + padding-right: 5px; +} +.pb5 { + padding-bottom: 5px; +} +.mt5 { + margin-top: 5px; +} +.mr5 { + margin-right: 5px; +} +.mb5 { + margin-bottom: 5px; +} +.mb8 { + margin-bottom: 8px; +} +.ml5 { + margin-left: 5px; +} +.mt10 { + margin-top: 10px; +} +.mr10 { + margin-right: 10px; +} +.mb10 { + margin-bottom: 10px; +} +.ml10 { + margin-left: 10px; +} +.mt20 { + margin-top: 20px; +} +.mr20 { + margin-right: 20px; +} +.mb20 { + margin-bottom: 20px; +} +.ml20 { + margin-left: 20px; +} + +.h1, .h2, .h3, .h4, .h5, .h6, h1, h2, h3, h4, h5, h6 { + font-family: inherit; + font-weight: 500; + line-height: 1.1; + color: inherit; +} + +.el-form--inline { + .el-form-item { + .el-input, .el-cascader, .el-select, .el-autocomplete { + width: 200px; + } + } +} + +.el-form .el-form-item__label { + font-weight: 700; +} +.el-dialog:not(.is-fullscreen) { + margin-top: 6vh !important; +} + +.el-dialog.scrollbar .el-dialog__body { + overflow: auto; + overflow-x: hidden; + max-height: 70vh; + padding: 10px 20px 0; +} + +.el-table { + .el-table__header-wrapper, .el-table__fixed-header-wrapper { + th { + word-break: break-word; + background-color: #f8f8f9 !important; + color: #515a6e; + height: 40px !important; + font-size: 13px; + } + } + .el-table__body-wrapper { + .el-button [class*="el-icon-"] + span { + margin-left: 1px; + } + } +} + +/** 表单布局 **/ +.form-header { + font-size:15px; + color:#6379bb; + border-bottom:1px solid #ddd; + margin:8px 10px 25px 10px; + padding-bottom:5px +} + +/** 表格布局 **/ +.pagination-container { + display: flex; + justify-content: flex-end; + margin-top: 20px; + background-color: transparent !important; +} + +/* 弹窗中的分页器 */ +.el-dialog .pagination-container { + position: static !important; + margin: 10px 0 0 0; + padding: 0 !important; + + .el-pagination { + position: static; + } +} + +/* 移动端适配 */ +@media (max-width: 768px) { + .pagination-container { + .el-pagination { + > .el-pagination__jump { + display: none !important; + } + > .el-pagination__sizes { + display: none !important; + } + } + } +} + +/* tree border */ +.tree-border { + margin-top: 5px; + border: 1px solid var(--el-border-color-light, #e5e6e7); + background: var(--el-bg-color, #FFFFFF) none; + border-radius:4px; + width: 100%; +} + +.el-table .fixed-width .el-button--small { + padding-left: 0; + padding-right: 0; + width: inherit; +} + +/* horizontal el menu */ +.el-menu--horizontal .el-menu-item .svg-icon + span, +.el-menu--horizontal .el-sub-menu__title .svg-icon + span { + margin-left: 3px; +} + +.el-menu--horizontal .el-menu--popup { + min-width: 120px !important; +} + +/** 表格更多操作下拉样式 */ +.el-table .el-dropdown-link { + cursor: pointer; + color: #409EFF; + margin-left: 10px; +} + +.el-table .el-dropdown, .el-icon-arrow-down { + font-size: 12px; +} + +.el-tree-node__content > .el-checkbox { + margin-right: 8px; +} + +.list-group-striped > .list-group-item { + border-left: 0; + border-right: 0; + border-radius: 0; + padding-left: 0; + padding-right: 0; +} + +.list-group { + padding-left: 0px; + list-style: none; +} + +.list-group-item { + border-bottom: 1px solid #e7eaec; + border-top: 1px solid #e7eaec; + margin-bottom: -1px; + padding: 11px 0px; + font-size: 13px; +} + +.pull-right { + float: right !important; +} + +.el-card__header { + padding: 14px 15px 7px !important; + min-height: 40px; +} + +.el-card__body { + padding: 15px 20px 20px 20px !important; +} + +.card-box { + margin-bottom: 10px; +} + +/* button color */ +.el-button--cyan.is-active, +.el-button--cyan:active { + background: #20B2AA; + border-color: #20B2AA; + color: #FFFFFF; +} + +.el-button--cyan:focus, +.el-button--cyan:hover { + background: #48D1CC; + border-color: #48D1CC; + color: #FFFFFF; +} + +.el-button--cyan { + background-color: #20B2AA; + border-color: #20B2AA; + color: #FFFFFF; +} + +/* text color */ +.text-navy { + color: #1ab394; +} + +.text-primary { + color: inherit; +} + +.text-success { + color: #1c84c6; +} + +.text-info { + color: #23c6c8; +} + +.text-warning { + color: #f8ac59; +} + +.text-danger { + color: #ed5565; +} + +.text-muted { + color: #888888; +} + +/* image */ +.img-circle { + border-radius: 50%; +} + +.img-lg { + width: 120px; + height: 120px; +} + +.avatar-upload-preview { + position: absolute; + top: 50%; + transform: translate(50%, -50%); + width: 200px; + height: 200px; + border-radius: 50%; + box-shadow: 0 0 4px #ccc; + overflow: hidden; +} + +/* 拖拽列样式 */ +.sortable-ghost{ + opacity: .8; + color: #fff!important; + background: #42b983!important; +} + +/* 表格右侧工具栏样式 */ +.top-right-btn { + margin-left: auto; +} + +/* 分割面板样式 */ +.splitpanes.default-theme .splitpanes__pane { + background-color: var(--splitpanes-default-bg) !important; +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/sidebar.scss b/shierfeng-fastapi-frontend/src/assets/styles/sidebar.scss new file mode 100755 index 0000000..5ee4ac8 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/sidebar.scss @@ -0,0 +1,238 @@ +@use './variables.module.scss' as vars; + +#app { + + .main-container { + min-height: 100%; + transition: margin-left .28s; + margin-left: vars.$base-sidebar-width; + position: relative; + } + + .sidebarHide { + margin-left: 0!important; + } + + .sidebar-container { + transition: width 0.28s; + width: vars.$base-sidebar-width !important; + height: 100%; + position: fixed; + font-size: 0px; + top: 0; + bottom: 0; + left: 0; + z-index: 1001; + overflow: hidden; + -webkit-box-shadow: 2px 0 6px rgba(0,21,41,.35); + box-shadow: 0px 0px 8px 0px rgba(0, 0, 0, 0.1); + + // reset element-ui css + .horizontal-collapse-transition { + transition: 0s width ease-in-out, 0s padding-left ease-in-out, 0s padding-right ease-in-out; + } + + .scrollbar-wrapper { + overflow-x: hidden !important; + } + + .el-scrollbar__bar.is-vertical { + right: 0px; + } + + .el-scrollbar { + height: 100%; + } + + &.has-logo { + .el-scrollbar { + height: calc(100% - 50px); + } + } + + .is-horizontal { + display: none; + } + + a { + display: inline-block; + width: 100%; + overflow: hidden; + } + + .svg-icon { + margin-right: 10px !important; + } + + .el-menu { + border: none; + height: 100%; + width: 100% !important; + } + + .el-menu-item, .menu-title { + overflow: hidden !important; + text-overflow: ellipsis !important; + white-space: nowrap !important; + } + + .el-menu-item .el-menu-tooltip__trigger { + display: inline-block !important; + } + + // menu hover + .sub-menu-title-noDropdown, + .el-sub-menu__title { + &:hover { + background-color: rgba(0, 0, 0, 0.06) !important; + } + } + + & .theme-dark .is-active > .el-sub-menu__title { + color: vars.$base-menu-color-active !important; + } + + & .nest-menu .el-sub-menu>.el-sub-menu__title, + & .el-sub-menu .el-menu-item { + min-width: vars.$base-sidebar-width !important; + + &:hover { + background-color: rgba(0, 0, 0, 0.06) !important; + } + } + + & .theme-dark .nest-menu .el-sub-menu>.el-sub-menu__title, + & .theme-dark .el-sub-menu .el-menu-item { + background-color: vars.$base-sub-menu-background; + + &:hover { + background-color: vars.$base-sub-menu-hover !important; + } + } + } + + .hideSidebar { + .sidebar-container { + width: 54px !important; + } + + .main-container { + margin-left: 54px; + } + + .sub-menu-title-noDropdown { + padding: 0 !important; + position: relative; + + .el-tooltip { + padding: 0 !important; + + .svg-icon { + margin-left: 20px; + } + } + } + + .el-sub-menu { + overflow: hidden; + + &>.el-sub-menu__title { + padding: 0 !important; + + .svg-icon { + margin-left: 20px; + } + + } + } + + .el-menu--collapse { + .el-sub-menu { + &>.el-sub-menu__title { + &>span { + height: 0; + width: 0; + overflow: hidden; + visibility: hidden; + display: inline-block; + } + &>i { + height: 0; + width: 0; + overflow: hidden; + visibility: hidden; + display: inline-block; + } + } + } + } + } + + .el-menu--collapse .el-menu .el-sub-menu { + min-width: vars.$base-sidebar-width !important; + } + + // mobile responsive + .mobile { + .main-container { + margin-left: 0px; + } + + .sidebar-container { + transition: transform .28s; + width: vars.$base-sidebar-width !important; + } + + &.hideSidebar { + .sidebar-container { + pointer-events: none; + transition-duration: 0.3s; + transform: translate3d(-(vars.$base-sidebar-width), 0, 0); + } + } + } + + .withoutAnimation { + + .main-container, + .sidebar-container { + transition: none; + } + } +} + +// when menu collapsed +.el-menu--vertical { + &>.el-menu { + .svg-icon { + margin-right: 16px; + } + } + + .nest-menu .el-sub-menu>.el-sub-menu__title, + .el-menu-item { + &:hover { + // you can use $sub-menuHover + background-color: rgba(0, 0, 0, 0.06) !important; + } + } + + // the scroll bar appears when the sub-menu is too long + >.el-menu--popup { + max-height: 100vh; + overflow-y: auto; + + &::-webkit-scrollbar-track-piece { + background: #d3dce6; + } + + &::-webkit-scrollbar { + width: 6px; + } + + &::-webkit-scrollbar-thumb { + background: #99a9bf; + border-radius: 20px; + } + } +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/transition.scss b/shierfeng-fastapi-frontend/src/assets/styles/transition.scss new file mode 100644 index 0000000..1f74a7e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/transition.scss @@ -0,0 +1,80 @@ +// global transition css + +/* fade */ +.fade-enter-active, +.fade-leave-active { + transition: opacity 0.28s; +} + +.fade-enter-from, +.fade-leave-active { + opacity: 0; +} + +/* fade-transform */ +.fade-transform--move, +.fade-transform-leave-active, +.fade-transform-enter-active { + transition: all .5s; +} + +.fade-transform-enter-from { + opacity: 0; + transform: translateX(-30px); +} + +.fade-transform-leave-to { + opacity: 0; + transform: translateX(30px); +} + +/* breadcrumb transition */ +.breadcrumb-enter-active, +.breadcrumb-leave-active { + transition: all .5s; +} + +.breadcrumb-enter-from, +.breadcrumb-leave-active { + opacity: 0; + transform: translateX(20px); +} + +.breadcrumb-move { + transition: all .5s; +} + +.breadcrumb-leave-active { + position: absolute; +} + +/* 黑暗模式下过渡效果 */ +::view-transition-new(root), ::view-transition-old(root) { + animation: none !important; + backface-visibility: hidden; + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; +} + +.dark::view-transition-old(root) { + z-index: 2147483646; + background: var(--bg-color-dark); +} + +.dark::view-transition-new(root) { + z-index: 1; + background: var(--bg-color); +} + +::view-transition-old(root) { + z-index: 1; + background: var(--bg-color); +} + +::view-transition-new(root) { + z-index: 2147483646; + background: var(--bg-color-dark); +} diff --git a/shierfeng-fastapi-frontend/src/assets/styles/variables.module.scss b/shierfeng-fastapi-frontend/src/assets/styles/variables.module.scss new file mode 100755 index 0000000..b038f96 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/assets/styles/variables.module.scss @@ -0,0 +1,271 @@ +// base color +$blue: #324157; +$light-blue: #333c46; +$red: #C03639; +$pink: #E65D6E; +$green: #30B08F; +$tiffany: #4AB7BD; +$yellow: #FEC171; +$panGreen: #30B08F; + +// 默认主题变量 +$menuText: #bfcbd9; +$menuActiveText: #409eff; +$menuBg: #304156; +$menuHover: #263445; + +// 浅色主题theme-light +$menuLightBg: #ffffff; +$menuLightHover: #f0f1f5; +$menuLightText: #303133; +$menuLightActiveText: #409EFF; + +// 基础变量 +$base-sidebar-width: 200px; +$sideBarWidth: 200px; + +// 菜单暗色变量 +$base-menu-color: #bfcbd9; +$base-menu-color-active: #f4f4f5; +$base-menu-background: #304156; +$base-sub-menu-background: #1f2d3d; +$base-sub-menu-hover: #001528; + +// 组件变量 +$--color-primary: #409EFF; +$--color-success: #67C23A; +$--color-warning: #E6A23C; +$--color-danger: #F56C6C; +$--color-info: #909399; + +:export { + menuText: $menuText; + menuActiveText: $menuActiveText; + menuBg: $menuBg; + menuHover: $menuHover; + menuLightBg: $menuLightBg; + menuLightHover: $menuLightHover; + menuLightText: $menuLightText; + menuLightActiveText: $menuLightActiveText; + sideBarWidth: $sideBarWidth; + // 导出基础颜色 + blue: $blue; + lightBlue: $light-blue; + red: $red; + pink: $pink; + green: $green; + tiffany: $tiffany; + yellow: $yellow; + panGreen: $panGreen; + // 导出组件颜色 + colorPrimary: $--color-primary; + colorSuccess: $--color-success; + colorWarning: $--color-warning; + colorDanger: $--color-danger; + colorInfo: $--color-info; +} + +// CSS变量定义 +:root { + /* 亮色模式变量 */ + --sidebar-bg: #{$menuBg}; + --sidebar-text: #{$menuText}; + --menu-hover: #{$menuHover}; + + --navbar-bg: #ffffff; + --navbar-text: #303133; + + /* splitpanes default-theme 变量 */ + --splitpanes-default-bg: #ffffff; + +} + +// 暗黑模式变量 +html.dark { + /* 默认通用 */ + --el-bg-color: #141414; + --el-bg-color-overlay: #1d1e1f; + --el-text-color-primary: #ffffff; + --el-text-color-regular: #d0d0d0; + --el-border-color: #434343; + --el-border-color-light: #434343; + + /* primary */ + --primary-bg: #18212b; + + /* 侧边栏 */ + --sidebar-bg: #141414; + --sidebar-text: #ffffff; + --menu-hover: #2d2d2d; + --menu-active-text: #{$menuActiveText}; + + /* 顶部导航栏 */ + --navbar-bg: #141414; + --navbar-text: #ffffff; + --navbar-hover: #141414; + + /* 标签栏 */ + --tags-bg: #141414; + --tags-item-bg: #1d1e1f; + --tags-item-border: #303030; + --tags-item-text: #d0d0d0; + --tags-item-hover: #2d2d2d; + --tags-close-hover: #64666a; + + /* splitpanes 组件暗黑模式变量 */ + --splitpanes-bg: #141414; + --splitpanes-border: #303030; + --splitpanes-splitter-bg: #1d1e1f; + --splitpanes-splitter-hover-bg: #2d2d2d; + + /* blockquote 暗黑模式变量 */ + --blockquote-bg: #1d1e1f; + --blockquote-border: #303030; + --blockquote-text: #d0d0d0; + + /* Cron 时间表达式 模式变量 */ + --cron-border: #303030; + + /* splitpanes default-theme 暗黑模式变量 */ + --splitpanes-default-bg: #141414; + + /* 侧边栏菜单覆盖 */ + .sidebar-container { + .el-menu-item:not(.is-active), .menu-title { + color: var(--el-text-color-regular); + } + & .theme-dark .nest-menu .el-sub-menu>.el-sub-menu__title, + & .theme-dark .el-sub-menu .el-menu-item { + background-color: var(--el-bg-color) !important; + } + } + + .topmenu-container { + .el-menu-item, + .el-sub-menu .el-sub-menu__title { + color: var(--el-text-color-regular) !important; + } + } + + .topbar-menu.el-menu--horizontal > .el-sub-menu .el-sub-menu__title{ + color: var(--el-text-color-regular) !important; + } + + /* 顶部栏栏菜单覆盖 */ + .el-menu--horizontal { + .el-menu-item, .el-sub-menu { + &:not(.is-disabled) { + &:hover, + &:focus { + background-color: var(--navbar-hover) !important; + .el-sub-menu__title { + background-color: var(--navbar-hover) !important; + } + } + } + } + } + + /* 分割窗格覆盖 */ + .splitpanes { + background-color: var(--splitpanes-bg); + + .splitpanes__pane { + background-color: var(--splitpanes-bg); + border-color: var(--splitpanes-border); + } + + .splitpanes__splitter { + background-color: var(--splitpanes-splitter-bg); + border-color: var(--splitpanes-border); + + &:hover { + background-color: var(--splitpanes-splitter-hover-bg); + } + + &:before, + &:after { + background-color: var(--splitpanes-border); + } + } + } + + /* 按钮样式覆盖 */ + .el-button--primary.is-plain { + background-color: var(--primary-bg); + border: 1px solid var(--el-color-primary-light-2); + color: var(--el-color-primary-light-2); + + &:hover { + background-color: var(--el-button-hover-bg-color); + border-color: var(--el-button-hover-border-color); + color: var(--el-button-hover-text-color); + } + + &.is-disabled { + background-color: var(--link-active-bg-color); + border-color: var(--el-color-primary-light-3); + color: var(--el-color-primary-light-3); + opacity: 0.5; + } + } + + /* primary tag 样式覆盖 */ + .el-tag--primary { + background-color: var(--primary-bg); + border: 1px solid var(--el-border-color-light); + color: var(--el-color-primary); + } + + /* 表格样式覆盖 */ + .el-table { + --el-table-header-bg-color: var(--el-bg-color-overlay) !important; + --el-table-header-text-color: var(--el-text-color-regular) !important; + --el-table-border-color: var(--el-border-color-light) !important; + --el-table-row-hover-bg-color: var(--el-bg-color-overlay) !important; + + .el-table__header-wrapper, .el-table__fixed-header-wrapper { + th { + background-color: var(--el-bg-color-overlay, #f8f8f9) !important; + color: var(--el-text-color-regular, #515a6e); + } + } + } + + /* 树组件高亮样式覆盖 */ + .el-tree { + .el-tree-node.is-current > .el-tree-node__content { + background-color: var(--el-bg-color-overlay) !important; + color: var(--el-color-primary); + } + + .el-tree-node__content:hover { + background-color: var(--el-bg-color-overlay); + } + } + + /* 下拉菜单样式覆盖 */ + .el-dropdown-menu__item:not(.is-disabled):focus, .el-dropdown-menu__item:not(.is-disabled):hover{ + background-color: var(--navbar-hover) !important; + } + + /* blockquote样式覆盖 */ + blockquote { + background-color: var(--blockquote-bg) !important; + border-left-color: var(--blockquote-border) !important; + color: var(--blockquote-text) !important; + } + + /* 时间表达式标题样式覆盖 */ + .popup-result .title { + background: var(--cron-border); + } + + /* 底部版权样式覆盖 */ + .copyright { + background-color: var(--el-bg-color) !important; + color: var(--el-text-color-regular) !important; + border-top: 1px solid var(--el-bg-color) !important; + } +} + diff --git a/shierfeng-fastapi-frontend/src/components/Breadcrumb/index.vue b/shierfeng-fastapi-frontend/src/components/Breadcrumb/index.vue new file mode 100644 index 0000000..059076f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Breadcrumb/index.vue @@ -0,0 +1,97 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/day.vue b/shierfeng-fastapi-frontend/src/components/Crontab/day.vue new file mode 100644 index 0000000..39263f5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/day.vue @@ -0,0 +1,174 @@ + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/hour.vue b/shierfeng-fastapi-frontend/src/components/Crontab/hour.vue new file mode 100644 index 0000000..8e7c21c --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/hour.vue @@ -0,0 +1,133 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/index.vue b/shierfeng-fastapi-frontend/src/components/Crontab/index.vue new file mode 100644 index 0000000..cbb41ab --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/index.vue @@ -0,0 +1,313 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/min.vue b/shierfeng-fastapi-frontend/src/components/Crontab/min.vue new file mode 100644 index 0000000..65f0946 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/min.vue @@ -0,0 +1,126 @@ + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/month.vue b/shierfeng-fastapi-frontend/src/components/Crontab/month.vue new file mode 100644 index 0000000..e561ba4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/month.vue @@ -0,0 +1,141 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/result.vue b/shierfeng-fastapi-frontend/src/components/Crontab/result.vue new file mode 100644 index 0000000..5a812ee --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/result.vue @@ -0,0 +1,540 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/second.vue b/shierfeng-fastapi-frontend/src/components/Crontab/second.vue new file mode 100644 index 0000000..15e47a0 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/second.vue @@ -0,0 +1,128 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/week.vue b/shierfeng-fastapi-frontend/src/components/Crontab/week.vue new file mode 100644 index 0000000..e59da22 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/week.vue @@ -0,0 +1,197 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Crontab/year.vue b/shierfeng-fastapi-frontend/src/components/Crontab/year.vue new file mode 100644 index 0000000..14758ba --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Crontab/year.vue @@ -0,0 +1,143 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/DictTag/index.vue b/shierfeng-fastapi-frontend/src/components/DictTag/index.vue new file mode 100644 index 0000000..41858f6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/DictTag/index.vue @@ -0,0 +1,87 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/Editor/index.vue b/shierfeng-fastapi-frontend/src/components/Editor/index.vue new file mode 100644 index 0000000..c5e2185 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Editor/index.vue @@ -0,0 +1,276 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/FileUpload/index.vue b/shierfeng-fastapi-frontend/src/components/FileUpload/index.vue new file mode 100644 index 0000000..0cfe4dc --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/FileUpload/index.vue @@ -0,0 +1,257 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/Hamburger/index.vue b/shierfeng-fastapi-frontend/src/components/Hamburger/index.vue new file mode 100644 index 0000000..02d58e9 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Hamburger/index.vue @@ -0,0 +1,42 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/HeaderSearch/index.vue b/shierfeng-fastapi-frontend/src/components/HeaderSearch/index.vue new file mode 100644 index 0000000..f364a6d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/HeaderSearch/index.vue @@ -0,0 +1,252 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/IconSelect/index.vue b/shierfeng-fastapi-frontend/src/components/IconSelect/index.vue new file mode 100644 index 0000000..517a4af --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/IconSelect/index.vue @@ -0,0 +1,111 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/IconSelect/requireIcons.js b/shierfeng-fastapi-frontend/src/components/IconSelect/requireIcons.js new file mode 100644 index 0000000..ac22fd7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/IconSelect/requireIcons.js @@ -0,0 +1,8 @@ +let icons = [] +const modules = import.meta.glob('./../../assets/icons/svg/*.svg'); +for (const path in modules) { + const p = path.split('assets/icons/svg/')[1].split('.svg')[0]; + icons.push(p); +} + +export default icons \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/ImagePreview/index.vue b/shierfeng-fastapi-frontend/src/components/ImagePreview/index.vue new file mode 100644 index 0000000..7e3d2b6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/ImagePreview/index.vue @@ -0,0 +1,92 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/ImageUpload/index.vue b/shierfeng-fastapi-frontend/src/components/ImageUpload/index.vue new file mode 100644 index 0000000..d984a09 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/ImageUpload/index.vue @@ -0,0 +1,258 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/Pagination/index.vue b/shierfeng-fastapi-frontend/src/components/Pagination/index.vue new file mode 100644 index 0000000..11d4caf --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Pagination/index.vue @@ -0,0 +1,104 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/ParentView/index.vue b/shierfeng-fastapi-frontend/src/components/ParentView/index.vue new file mode 100644 index 0000000..7bf6148 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/ParentView/index.vue @@ -0,0 +1,3 @@ + diff --git a/shierfeng-fastapi-frontend/src/components/RightToolbar/index.vue b/shierfeng-fastapi-frontend/src/components/RightToolbar/index.vue new file mode 100644 index 0000000..32fc644 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/RightToolbar/index.vue @@ -0,0 +1,181 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/Screenfull/index.vue b/shierfeng-fastapi-frontend/src/components/Screenfull/index.vue new file mode 100644 index 0000000..7ad28ea --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/Screenfull/index.vue @@ -0,0 +1,22 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/ShiErFeng/Doc/index.vue b/shierfeng-fastapi-frontend/src/components/ShiErFeng/Doc/index.vue new file mode 100644 index 0000000..27a9c65 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/ShiErFeng/Doc/index.vue @@ -0,0 +1,13 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/components/ShiErFeng/Git/index.vue b/shierfeng-fastapi-frontend/src/components/ShiErFeng/Git/index.vue new file mode 100644 index 0000000..199c987 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/ShiErFeng/Git/index.vue @@ -0,0 +1,13 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/components/SizeSelect/index.vue b/shierfeng-fastapi-frontend/src/components/SizeSelect/index.vue new file mode 100644 index 0000000..4c2e7e9 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/SizeSelect/index.vue @@ -0,0 +1,45 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/components/SvgIcon/index.vue b/shierfeng-fastapi-frontend/src/components/SvgIcon/index.vue new file mode 100644 index 0000000..8c101f6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/SvgIcon/index.vue @@ -0,0 +1,53 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/SvgIcon/svgicon.js b/shierfeng-fastapi-frontend/src/components/SvgIcon/svgicon.js new file mode 100644 index 0000000..4431719 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/SvgIcon/svgicon.js @@ -0,0 +1,10 @@ +import * as components from '@element-plus/icons-vue' + +export default { + install: (app) => { + for (const key in components) { + const componentConfig = components[key]; + app.component(componentConfig.name, componentConfig); + } + }, +}; diff --git a/shierfeng-fastapi-frontend/src/components/TopNav/index.vue b/shierfeng-fastapi-frontend/src/components/TopNav/index.vue new file mode 100644 index 0000000..40f424d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/TopNav/index.vue @@ -0,0 +1,214 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/components/iFrame/index.vue b/shierfeng-fastapi-frontend/src/components/iFrame/index.vue new file mode 100644 index 0000000..091b1a2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/components/iFrame/index.vue @@ -0,0 +1,31 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/layout/components/Navbar.vue b/shierfeng-fastapi-frontend/src/layout/components/Navbar.vue new file mode 100644 index 0000000..c7dd3a7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Navbar.vue @@ -0,0 +1,292 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/layout/components/Settings/index.vue b/shierfeng-fastapi-frontend/src/layout/components/Settings/index.vue new file mode 100644 index 0000000..0c802dd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Settings/index.vue @@ -0,0 +1,315 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Link.vue b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Link.vue new file mode 100644 index 0000000..8011431 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Link.vue @@ -0,0 +1,40 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Logo.vue b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Logo.vue new file mode 100644 index 0000000..e69b75a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/Logo.vue @@ -0,0 +1,102 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/layout/components/Sidebar/SidebarItem.vue b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/SidebarItem.vue new file mode 100644 index 0000000..66fed4a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/SidebarItem.vue @@ -0,0 +1,100 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/layout/components/Sidebar/index.vue b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/index.vue new file mode 100644 index 0000000..f0fdf88 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/Sidebar/index.vue @@ -0,0 +1,104 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/layout/components/TagsView/ScrollPane.vue b/shierfeng-fastapi-frontend/src/layout/components/TagsView/ScrollPane.vue new file mode 100644 index 0000000..516b5d2 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/TagsView/ScrollPane.vue @@ -0,0 +1,105 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/layout/components/TagsView/index.vue b/shierfeng-fastapi-frontend/src/layout/components/TagsView/index.vue new file mode 100644 index 0000000..68c605b --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/TagsView/index.vue @@ -0,0 +1,350 @@ + + + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/layout/components/TopBar/index.vue b/shierfeng-fastapi-frontend/src/layout/components/TopBar/index.vue new file mode 100644 index 0000000..1a2d2f7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/TopBar/index.vue @@ -0,0 +1,99 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/layout/components/index.js b/shierfeng-fastapi-frontend/src/layout/components/index.js new file mode 100644 index 0000000..fd57731 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/components/index.js @@ -0,0 +1,4 @@ +export { default as AppMain } from './AppMain' +export { default as Navbar } from './Navbar' +export { default as Settings } from './Settings' +export { default as TagsView } from './TagsView/index.vue' diff --git a/shierfeng-fastapi-frontend/src/layout/index.vue b/shierfeng-fastapi-frontend/src/layout/index.vue new file mode 100644 index 0000000..c9a7e61 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/layout/index.vue @@ -0,0 +1,117 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/main.js b/shierfeng-fastapi-frontend/src/main.js new file mode 100644 index 0000000..aee437f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/main.js @@ -0,0 +1,84 @@ +import { createApp } from 'vue' + +import Cookies from 'js-cookie' + +import ElementPlus from 'element-plus' +import 'element-plus/dist/index.css' +import 'element-plus/theme-chalk/dark/css-vars.css' +import locale from 'element-plus/es/locale/lang/zh-cn' + +import '@/assets/styles/index.scss' // global css + +import App from './App' +import store from './store' +import router from './router' +import directive from './directive' // directive + +// 注册指令 +import plugins from './plugins' // plugins +import { download } from '@/utils/request' + +// svg图标 +import 'virtual:svg-icons-register' +import SvgIcon from '@/components/SvgIcon' +import elementIcons from '@/components/SvgIcon/svgicon' + +import './permission' // permission control + +import { useDict } from '@/utils/dict' +import { getConfigKey } from "@/api/system/config" +import { parseTime, resetForm, addDateRange, handleTree, selectDictLabel, selectDictLabels } from '@/utils/shierfeng' + +// 分页组件 +import Pagination from '@/components/Pagination' +// 自定义表格工具组件 +import RightToolbar from '@/components/RightToolbar' +// 富文本组件 +import Editor from "@/components/Editor" +// 文件上传组件 +import FileUpload from "@/components/FileUpload" +// 图片上传组件 +import ImageUpload from "@/components/ImageUpload" +// 图片预览组件 +import ImagePreview from "@/components/ImagePreview" +// 字典标签组件 +import DictTag from '@/components/DictTag' + +const app = createApp(App) + +// 全局方法挂载 +app.config.globalProperties.useDict = useDict +app.config.globalProperties.download = download +app.config.globalProperties.parseTime = parseTime +app.config.globalProperties.resetForm = resetForm +app.config.globalProperties.handleTree = handleTree +app.config.globalProperties.addDateRange = addDateRange +app.config.globalProperties.getConfigKey = getConfigKey +app.config.globalProperties.selectDictLabel = selectDictLabel +app.config.globalProperties.selectDictLabels = selectDictLabels + +// 全局组件挂载 +app.component('DictTag', DictTag) +app.component('Pagination', Pagination) +app.component('FileUpload', FileUpload) +app.component('ImageUpload', ImageUpload) +app.component('ImagePreview', ImagePreview) +app.component('RightToolbar', RightToolbar) +app.component('Editor', Editor) + +app.use(router) +app.use(store) +app.use(plugins) +app.use(elementIcons) +app.component('svg-icon', SvgIcon) + +directive(app) + +// 使用element-plus 并且设置全局的大小 +app.use(ElementPlus, { + locale: locale, + // 支持 large、default、small + size: Cookies.get('size') || 'default' +}) + +app.mount('#app') diff --git a/shierfeng-fastapi-frontend/src/permission.js b/shierfeng-fastapi-frontend/src/permission.js new file mode 100644 index 0000000..7e3b5bf --- /dev/null +++ b/shierfeng-fastapi-frontend/src/permission.js @@ -0,0 +1,69 @@ +import router from './router' +import { ElMessage } from 'element-plus' +import NProgress from 'nprogress' +import 'nprogress/nprogress.css' +import { getToken } from '@/utils/auth' +import { isHttp, isPathMatch } from '@/utils/validate' +import { isRelogin } from '@/utils/request' +import useUserStore from '@/store/modules/user' +import useSettingsStore from '@/store/modules/settings' +import usePermissionStore from '@/store/modules/permission' + +NProgress.configure({ showSpinner: false }) + +const whiteList = ['/login', '/register'] + +const isWhiteList = (path) => { + return whiteList.some(pattern => isPathMatch(pattern, path)) +} + +router.beforeEach((to, from, next) => { + NProgress.start() + if (getToken()) { + to.meta.title && useSettingsStore().setTitle(to.meta.title) + /* has token*/ + if (to.path === '/login') { + next({ path: '/' }) + NProgress.done() + } else if (isWhiteList(to.path)) { + next() + } else { + if (useUserStore().roles.length === 0) { + isRelogin.show = true + // 判断当前用户是否已拉取完user_info信息 + useUserStore().getInfo().then(() => { + isRelogin.show = false + usePermissionStore().generateRoutes().then(accessRoutes => { + // 根据roles权限生成可访问的路由表 + accessRoutes.forEach(route => { + if (!isHttp(route.path)) { + router.addRoute(route) // 动态添加可访问路由表 + } + }) + next({ ...to, replace: true }) // hack方法 确保addRoutes已完成 + }) + }).catch(err => { + useUserStore().logOut().then(() => { + ElMessage.error(err) + next({ path: '/' }) + }) + }) + } else { + next() + } + } + } else { + // 没有token + if (isWhiteList(to.path)) { + // 在免登录白名单,直接进入 + next() + } else { + next(`/login?redirect=${to.fullPath}`) // 否则全部重定向到登录页 + NProgress.done() + } + } +}) + +router.afterEach(() => { + NProgress.done() +}) diff --git a/shierfeng-fastapi-frontend/src/plugins/auth.js b/shierfeng-fastapi-frontend/src/plugins/auth.js new file mode 100644 index 0000000..5e8c28d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/auth.js @@ -0,0 +1,60 @@ +import useUserStore from '@/store/modules/user' + +function authPermission(permission) { + const all_permission = "*:*:*"; + const permissions = useUserStore().permissions + if (permission && permission.length > 0) { + return permissions.some(v => { + return all_permission === v || v === permission + }) + } else { + return false + } +} + +function authRole(role) { + const super_admin = "admin"; + const roles = useUserStore().roles + if (role && role.length > 0) { + return roles.some(v => { + return super_admin === v || v === role + }) + } else { + return false + } +} + +export default { + // 验证用户是否具备某权限 + hasPermi(permission) { + return authPermission(permission); + }, + // 验证用户是否含有指定权限,只需包含其中一个 + hasPermiOr(permissions) { + return permissions.some(item => { + return authPermission(item) + }) + }, + // 验证用户是否含有指定权限,必须全部拥有 + hasPermiAnd(permissions) { + return permissions.every(item => { + return authPermission(item) + }) + }, + // 验证用户是否具备某角色 + hasRole(role) { + return authRole(role); + }, + // 验证用户是否含有指定角色,只需包含其中一个 + hasRoleOr(roles) { + return roles.some(item => { + return authRole(item) + }) + }, + // 验证用户是否含有指定角色,必须全部拥有 + hasRoleAnd(roles) { + return roles.every(item => { + return authRole(item) + }) + } +} diff --git a/shierfeng-fastapi-frontend/src/plugins/cache.js b/shierfeng-fastapi-frontend/src/plugins/cache.js new file mode 100644 index 0000000..b67d453 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/cache.js @@ -0,0 +1,79 @@ +const sessionCache = { + set (key, value) { + if (!sessionStorage) { + return + } + if (key != null && value != null) { + sessionStorage.setItem(key, value) + } + }, + get (key) { + if (!sessionStorage) { + return null + } + if (key == null) { + return null + } + return sessionStorage.getItem(key) + }, + setJSON (key, jsonValue) { + if (jsonValue != null) { + this.set(key, JSON.stringify(jsonValue)) + } + }, + getJSON (key) { + const value = this.get(key) + if (value != null) { + return JSON.parse(value) + } + return null + }, + remove (key) { + sessionStorage.removeItem(key); + } +} +const localCache = { + set (key, value) { + if (!localStorage) { + return + } + if (key != null && value != null) { + localStorage.setItem(key, value) + } + }, + get (key) { + if (!localStorage) { + return null + } + if (key == null) { + return null + } + return localStorage.getItem(key) + }, + setJSON (key, jsonValue) { + if (jsonValue != null) { + this.set(key, JSON.stringify(jsonValue)) + } + }, + getJSON (key) { + const value = this.get(key) + if (value != null) { + return JSON.parse(value) + } + return null + }, + remove (key) { + localStorage.removeItem(key); + } +} + +export default { + /** + * 会话级缓存 + */ + session: sessionCache, + /** + * 本地缓存 + */ + local: localCache +} diff --git a/shierfeng-fastapi-frontend/src/plugins/download.js b/shierfeng-fastapi-frontend/src/plugins/download.js new file mode 100644 index 0000000..547641b --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/download.js @@ -0,0 +1,79 @@ +import axios from 'axios' +import { ElLoading, ElMessage } from 'element-plus' +import { saveAs } from 'file-saver' +import { getToken } from '@/utils/auth' +import errorCode from '@/utils/errorCode' +import { blobValidate } from '@/utils/shierfeng' + +const baseURL = import.meta.env.VITE_APP_BASE_API +let downloadLoadingInstance; + +export default { + name(name, isDelete = true) { + var url = baseURL + "/common/download?fileName=" + encodeURIComponent(name) + "&delete=" + isDelete + axios({ + method: 'get', + url: url, + responseType: 'blob', + headers: { 'Authorization': 'Bearer ' + getToken() } + }).then((res) => { + const isBlob = blobValidate(res.data); + if (isBlob) { + const blob = new Blob([res.data]) + this.saveAs(blob, decodeURIComponent(res.headers['download-filename'])) + } else { + this.printErrMsg(res.data); + } + }) + }, + resource(resource) { + var url = baseURL + "/common/download/resource?resource=" + encodeURIComponent(resource); + axios({ + method: 'get', + url: url, + responseType: 'blob', + headers: { 'Authorization': 'Bearer ' + getToken() } + }).then((res) => { + const isBlob = blobValidate(res.data); + if (isBlob) { + const blob = new Blob([res.data]) + this.saveAs(blob, decodeURIComponent(res.headers['download-filename'])) + } else { + this.printErrMsg(res.data); + } + }) + }, + zip(url, name) { + var url = baseURL + url + downloadLoadingInstance = ElLoading.service({ text: "正在下载数据,请稍候", background: "rgba(0, 0, 0, 0.7)", }) + axios({ + method: 'get', + url: url, + responseType: 'blob', + headers: { 'Authorization': 'Bearer ' + getToken() } + }).then((res) => { + const isBlob = blobValidate(res.data); + if (isBlob) { + const blob = new Blob([res.data], { type: 'application/zip' }) + this.saveAs(blob, name) + } else { + this.printErrMsg(res.data); + } + downloadLoadingInstance.close(); + }).catch((r) => { + console.error(r) + ElMessage.error('下载文件出现错误,请联系管理员!') + downloadLoadingInstance.close(); + }) + }, + saveAs(text, name, opts) { + saveAs(text, name, opts); + }, + async printErrMsg(data) { + const resText = await data.text(); + const rspObj = JSON.parse(resText); + const errMsg = errorCode[rspObj.code] || rspObj.msg || errorCode['default'] + ElMessage.error(errMsg); + } +} + diff --git a/shierfeng-fastapi-frontend/src/plugins/index.js b/shierfeng-fastapi-frontend/src/plugins/index.js new file mode 100644 index 0000000..47d1b41 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/index.js @@ -0,0 +1,18 @@ +import tab from './tab' +import auth from './auth' +import cache from './cache' +import modal from './modal' +import download from './download' + +export default function installPlugins(app){ + // 页签操作 + app.config.globalProperties.$tab = tab + // 认证对象 + app.config.globalProperties.$auth = auth + // 缓存对象 + app.config.globalProperties.$cache = cache + // 模态框对象 + app.config.globalProperties.$modal = modal + // 下载文件 + app.config.globalProperties.$download = download +} diff --git a/shierfeng-fastapi-frontend/src/plugins/modal.js b/shierfeng-fastapi-frontend/src/plugins/modal.js new file mode 100644 index 0000000..b59e14d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/modal.js @@ -0,0 +1,82 @@ +import { ElMessage, ElMessageBox, ElNotification, ElLoading } from 'element-plus' + +let loadingInstance; + +export default { + // 消息提示 + msg(content) { + ElMessage.info(content) + }, + // 错误消息 + msgError(content) { + ElMessage.error(content) + }, + // 成功消息 + msgSuccess(content) { + ElMessage.success(content) + }, + // 警告消息 + msgWarning(content) { + ElMessage.warning(content) + }, + // 弹出提示 + alert(content) { + ElMessageBox.alert(content, "系统提示") + }, + // 错误提示 + alertError(content) { + ElMessageBox.alert(content, "系统提示", { type: 'error' }) + }, + // 成功提示 + alertSuccess(content) { + ElMessageBox.alert(content, "系统提示", { type: 'success' }) + }, + // 警告提示 + alertWarning(content) { + ElMessageBox.alert(content, "系统提示", { type: 'warning' }) + }, + // 通知提示 + notify(content) { + ElNotification.info(content) + }, + // 错误通知 + notifyError(content) { + ElNotification.error(content); + }, + // 成功通知 + notifySuccess(content) { + ElNotification.success(content) + }, + // 警告通知 + notifyWarning(content) { + ElNotification.warning(content) + }, + // 确认窗体 + confirm(content) { + return ElMessageBox.confirm(content, "系统提示", { + confirmButtonText: '确定', + cancelButtonText: '取消', + type: "warning", + }) + }, + // 提交内容 + prompt(content) { + return ElMessageBox.prompt(content, "系统提示", { + confirmButtonText: '确定', + cancelButtonText: '取消', + type: "warning", + }) + }, + // 打开遮罩层 + loading(content) { + loadingInstance = ElLoading.service({ + lock: true, + text: content, + background: "rgba(0, 0, 0, 0.7)", + }) + }, + // 关闭遮罩层 + closeLoading() { + loadingInstance.close(); + } +} diff --git a/shierfeng-fastapi-frontend/src/plugins/tab.js b/shierfeng-fastapi-frontend/src/plugins/tab.js new file mode 100644 index 0000000..f95aee6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/plugins/tab.js @@ -0,0 +1,71 @@ +import useTagsViewStore from '@/store/modules/tagsView' +import router from '@/router' + +export default { + // 刷新当前tab页签 + refreshPage(obj) { + const { path, query, matched } = router.currentRoute.value; + if (obj === undefined) { + matched.forEach((m) => { + if (m.components && m.components.default && m.components.default.name) { + if (!['Layout', 'ParentView'].includes(m.components.default.name)) { + obj = { name: m.components.default.name, path: path, query: query }; + } + } + }); + } + return useTagsViewStore().delCachedView(obj).then(() => { + const { path, query } = obj + router.replace({ + path: '/redirect' + path, + query: query + }) + }) + }, + // 关闭当前tab页签,打开新页签 + closeOpenPage(obj) { + useTagsViewStore().delView(router.currentRoute.value); + if (obj !== undefined) { + return router.push(obj); + } + }, + // 关闭指定tab页签 + closePage(obj) { + if (obj === undefined) { + return useTagsViewStore().delView(router.currentRoute.value).then(({ visitedViews }) => { + const latestView = visitedViews.slice(-1)[0] + if (latestView) { + return router.push(latestView.fullPath) + } + return router.push('/'); + }); + } + return useTagsViewStore().delView(obj); + }, + // 关闭所有tab页签 + closeAllPage() { + return useTagsViewStore().delAllViews(); + }, + // 关闭左侧tab页签 + closeLeftPage(obj) { + return useTagsViewStore().delLeftTags(obj || router.currentRoute.value); + }, + // 关闭右侧tab页签 + closeRightPage(obj) { + return useTagsViewStore().delRightTags(obj || router.currentRoute.value); + }, + // 关闭其他tab页签 + closeOtherPage(obj) { + return useTagsViewStore().delOthersViews(obj || router.currentRoute.value); + }, + // 打开tab页签 + openPage(title, url, params) { + const obj = { path: url, meta: { title: title } } + useTagsViewStore().addView(obj) + return router.push({ path: url, query: params }) + }, + // 修改tab页签 + updatePage(obj) { + return useTagsViewStore().updateVisitedView(obj); + } +} diff --git a/shierfeng-fastapi-frontend/src/router/index.js b/shierfeng-fastapi-frontend/src/router/index.js new file mode 100644 index 0000000..f31c43f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/router/index.js @@ -0,0 +1,174 @@ +import { createWebHistory, createRouter } from 'vue-router' +/* Layout */ +import Layout from '@/layout' + +/** + * Note: 路由配置项 + * + * hidden: true // 当设置 true 的时候该路由不会再侧边栏出现 如401,login等页面,或者如一些编辑页面/edit/1 + * alwaysShow: true // 当你一个路由下面的 children 声明的路由大于1个时,自动会变成嵌套的模式--如组件页面 + * // 只有一个时,会将那个子路由当做根路由显示在侧边栏--如引导页面 + * // 若你想不管路由下面的 children 声明的个数都显示你的根路由 + * // 你可以设置 alwaysShow: true,这样它就会忽略之前定义的规则,一直显示根路由 + * redirect: noRedirect // 当设置 noRedirect 的时候该路由在面包屑导航中不可被点击 + * name:'router-name' // 设定路由的名字,一定要填写不然使用时会出现各种问题 + * query: '{"id": 1, "name": "ry"}' // 访问路由的默认传递参数 + * roles: ['admin', 'common'] // 访问路由的角色权限 + * permissions: ['a:a:a', 'b:b:b'] // 访问路由的菜单权限 + * meta : { + noCache: true // 如果设置为true,则不会被 缓存(默认 false) + title: 'title' // 设置该路由在侧边栏和面包屑中展示的名字 + icon: 'svg-name' // 设置该路由的图标,对应路径src/assets/icons/svg + breadcrumb: false // 如果设置为false,则不会在breadcrumb面包屑中显示 + activeMenu: '/system/user' // 当路由设置了该属性,则会高亮相对应的侧边栏。 + } + */ + +// 公共路由 +export const constantRoutes = [ + { + path: '/redirect', + component: Layout, + hidden: true, + children: [ + { + path: '/redirect/:path(.*)', + component: () => import('@/views/redirect/index.vue') + } + ] + }, + { + path: '/login', + component: () => import('@/views/login'), + hidden: true + }, + { + path: '/register', + component: () => import('@/views/register'), + hidden: true + }, + { + path: "/:pathMatch(.*)*", + component: () => import('@/views/error/404'), + hidden: true + }, + { + path: '/401', + component: () => import('@/views/error/401'), + hidden: true + }, + { + path: '', + component: Layout, + redirect: '/index', + children: [ + { + path: '/index', + component: () => import('@/views/dashboard/index'), + name: 'Index', + meta: { title: '首页', icon: 'dashboard', affix: true } + } + ] + }, + { + path: '/user', + component: Layout, + hidden: true, + redirect: 'noredirect', + children: [ + { + path: 'profile/:activeTab?', + component: () => import('@/views/system/user/profile/index'), + name: 'Profile', + meta: { title: '个人中心', icon: 'user' } + } + ] + } +] + +// 动态路由,基于用户权限动态去加载 +export const dynamicRoutes = [ + { + path: '/system/user-auth', + component: Layout, + hidden: true, + permissions: ['system:user:edit'], + children: [ + { + path: 'role/:userId(\\d+)', + component: () => import('@/views/system/user/authRole'), + name: 'AuthRole', + meta: { title: '分配角色', activeMenu: '/system/user' } + } + ] + }, + { + path: '/system/role-auth', + component: Layout, + hidden: true, + permissions: ['system:role:edit'], + children: [ + { + path: 'user/:roleId(\\d+)', + component: () => import('@/views/system/role/authUser'), + name: 'AuthUser', + meta: { title: '分配用户', activeMenu: '/system/role' } + } + ] + }, + { + path: '/system/dict-data', + component: Layout, + hidden: true, + permissions: ['system:dict:list'], + children: [ + { + path: 'index/:dictId(\\d+)', + component: () => import('@/views/system/dict/data'), + name: 'Data', + meta: { title: '字典数据', activeMenu: '/system/dict' } + } + ] + }, + { + path: '/monitor/job-log', + component: Layout, + hidden: true, + permissions: ['monitor:job:list'], + children: [ + { + path: 'index/:jobId(\\d+)', + component: () => import('@/views/monitor/job/log'), + name: 'JobLog', + meta: { title: '调度日志', activeMenu: '/monitor/job' } + } + ] + }, + { + path: '/tool/gen-edit', + component: Layout, + hidden: true, + permissions: ['tool:gen:edit'], + children: [ + { + path: 'index/:tableId(\\d+)', + component: () => import('@/views/tool/gen/editTable'), + name: 'GenEdit', + meta: { title: '修改生成配置', activeMenu: '/tool/gen' } + } + ] + } +] + +const router = createRouter({ + history: createWebHistory(), + routes: constantRoutes, + scrollBehavior(to, from, savedPosition) { + if (savedPosition) { + return savedPosition + } + return { top: 0 } + }, +}); + +export default router; diff --git a/shierfeng-fastapi-frontend/src/settings.js b/shierfeng-fastapi-frontend/src/settings.js new file mode 100644 index 0000000..1b573dd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/settings.js @@ -0,0 +1,56 @@ +export default { + /** + * 网页标题 + */ + title: import.meta.env.VITE_APP_TITLE, + + /** + * 侧边栏主题 深色主题theme-dark,浅色主题theme-light + */ + sideTheme: 'theme-dark', + + /** + * 是否系统布局配置 + */ + showSettings: true, + + /** + * 菜单导航模式 1、纯左侧 2、混合(左侧+顶部) 3、纯顶部 + */ + navType: 1, + + /** + * 是否显示 tagsView + */ + tagsView: true, + + /** + * 显示页签图标 + */ + tagsIcon: false, + + /** + * 是否固定头部 + */ + fixedHeader: true, + + /** + * 是否显示logo + */ + sidebarLogo: true, + + /** + * 是否显示动态标题 + */ + dynamicTitle: false, + + /** + * 是否显示底部版权 + */ + footerVisible: false, + + /** + * 底部版权文本内容 + */ + footerContent: 'Copyright © 2024-2026 insistence.tech All Rights Reserved.' +} diff --git a/shierfeng-fastapi-frontend/src/store/index.js b/shierfeng-fastapi-frontend/src/store/index.js new file mode 100644 index 0000000..f10f389 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/index.js @@ -0,0 +1,3 @@ +const store = createPinia() + +export default store \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/store/modules/app.js b/shierfeng-fastapi-frontend/src/store/modules/app.js new file mode 100644 index 0000000..0b57159 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/app.js @@ -0,0 +1,46 @@ +import Cookies from 'js-cookie' + +const useAppStore = defineStore( + 'app', + { + state: () => ({ + sidebar: { + opened: Cookies.get('sidebarStatus') ? !!+Cookies.get('sidebarStatus') : true, + withoutAnimation: false, + hide: false + }, + device: 'desktop', + size: Cookies.get('size') || 'default' + }), + actions: { + toggleSideBar(withoutAnimation) { + if (this.sidebar.hide) { + return false; + } + this.sidebar.opened = !this.sidebar.opened + this.sidebar.withoutAnimation = withoutAnimation + if (this.sidebar.opened) { + Cookies.set('sidebarStatus', 1) + } else { + Cookies.set('sidebarStatus', 0) + } + }, + closeSideBar({ withoutAnimation }) { + Cookies.set('sidebarStatus', 0) + this.sidebar.opened = false + this.sidebar.withoutAnimation = withoutAnimation + }, + toggleDevice(device) { + this.device = device + }, + setSize(size) { + this.size = size; + Cookies.set('size', size) + }, + toggleSideBarHide(status) { + this.sidebar.hide = status + } + } + }) + +export default useAppStore diff --git a/shierfeng-fastapi-frontend/src/store/modules/dict.js b/shierfeng-fastapi-frontend/src/store/modules/dict.js new file mode 100644 index 0000000..27fc308 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/dict.js @@ -0,0 +1,57 @@ +const useDictStore = defineStore( + 'dict', + { + state: () => ({ + dict: new Array() + }), + actions: { + // 获取字典 + getDict(_key) { + if (_key == null && _key == "") { + return null; + } + try { + for (let i = 0; i < this.dict.length; i++) { + if (this.dict[i].key == _key) { + return this.dict[i].value; + } + } + } catch (e) { + return null; + } + }, + // 设置字典 + setDict(_key, value) { + if (_key !== null && _key !== "") { + this.dict.push({ + key: _key, + value: value + }); + } + }, + // 删除字典 + removeDict(_key) { + var bln = false; + try { + for (let i = 0; i < this.dict.length; i++) { + if (this.dict[i].key == _key) { + this.dict.splice(i, 1); + return true; + } + } + } catch (e) { + bln = false; + } + return bln; + }, + // 清空字典 + cleanDict() { + this.dict = new Array(); + }, + // 初始字典 + initDict() { + } + } + }) + +export default useDictStore diff --git a/shierfeng-fastapi-frontend/src/store/modules/permission.js b/shierfeng-fastapi-frontend/src/store/modules/permission.js new file mode 100644 index 0000000..496a995 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/permission.js @@ -0,0 +1,127 @@ +import auth from '@/plugins/auth' +import router, { constantRoutes, dynamicRoutes } from '@/router' +import { getRouters } from '@/api/menu' +import Layout from '@/layout/index' +import ParentView from '@/components/ParentView' +import InnerLink from '@/layout/components/InnerLink' + +// 匹配views里面所有的.vue文件 +const modules = import.meta.glob('./../../views/**/*.vue') + +const usePermissionStore = defineStore( + 'permission', + { + state: () => ({ + routes: [], + addRoutes: [], + defaultRoutes: [], + topbarRouters: [], + sidebarRouters: [] + }), + actions: { + setRoutes(routes) { + this.addRoutes = routes + this.routes = constantRoutes.concat(routes) + }, + setDefaultRoutes(routes) { + this.defaultRoutes = constantRoutes.concat(routes) + }, + setTopbarRoutes(routes) { + this.topbarRouters = routes + }, + setSidebarRouters(routes) { + this.sidebarRouters = routes + }, + generateRoutes(roles) { + return new Promise(resolve => { + // 向后端请求路由数据 + getRouters().then(res => { + const sdata = JSON.parse(JSON.stringify(res.data)) + const rdata = JSON.parse(JSON.stringify(res.data)) + const defaultData = JSON.parse(JSON.stringify(res.data)) + const sidebarRoutes = filterAsyncRouter(sdata) + const rewriteRoutes = filterAsyncRouter(rdata, false, true) + const defaultRoutes = filterAsyncRouter(defaultData) + const asyncRoutes = filterDynamicRoutes(dynamicRoutes) + asyncRoutes.forEach(route => { router.addRoute(route) }) + this.setRoutes(rewriteRoutes) + this.setSidebarRouters(constantRoutes.concat(sidebarRoutes)) + this.setDefaultRoutes(sidebarRoutes) + this.setTopbarRoutes(defaultRoutes) + resolve(rewriteRoutes) + }) + }) + } + } + }) + +// 遍历后台传来的路由字符串,转换为组件对象 +function filterAsyncRouter(asyncRouterMap, lastRouter = false, type = false) { + return asyncRouterMap.filter(route => { + if (type && route.children) { + route.children = filterChildren(route.children) + } + if (route.component) { + // Layout ParentView 组件特殊处理 + if (route.component === 'Layout') { + route.component = Layout + } else if (route.component === 'ParentView') { + route.component = ParentView + } else if (route.component === 'InnerLink') { + route.component = InnerLink + } else { + route.component = loadView(route.component) + } + } + if (route.children != null && route.children && route.children.length) { + route.children = filterAsyncRouter(route.children, route, type) + } else { + delete route['children'] + delete route['redirect'] + } + return true + }) +} + +function filterChildren(childrenMap, lastRouter = false) { + var children = [] + childrenMap.forEach(el => { + el.path = lastRouter ? lastRouter.path + '/' + el.path : el.path + if (el.children && el.children.length && el.component === 'ParentView') { + children = children.concat(filterChildren(el.children, el)) + } else { + children.push(el) + } + }) + return children +} + +// 动态路由遍历,验证是否具备权限 +export function filterDynamicRoutes(routes) { + const res = [] + routes.forEach(route => { + if (route.permissions) { + if (auth.hasPermiOr(route.permissions)) { + res.push(route) + } + } else if (route.roles) { + if (auth.hasRoleOr(route.roles)) { + res.push(route) + } + } + }) + return res +} + +export const loadView = (view) => { + let res; + for (const path in modules) { + const dir = path.split('views/')[1].split('.vue')[0]; + if (dir === view) { + res = () => modules[path](); + } + } + return res +} + +export default usePermissionStore diff --git a/shierfeng-fastapi-frontend/src/store/modules/settings.js b/shierfeng-fastapi-frontend/src/store/modules/settings.js new file mode 100644 index 0000000..eba4df7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/settings.js @@ -0,0 +1,51 @@ +import defaultSettings from '@/settings' +import { useDark, useToggle } from '@vueuse/core' +import { useDynamicTitle } from '@/utils/dynamicTitle' + +const isDark = useDark() +const toggleDark = useToggle(isDark) + +const { sideTheme, showSettings, navType, tagsView, tagsIcon, fixedHeader, sidebarLogo, dynamicTitle, footerVisible, footerContent } = defaultSettings + +const storageSetting = JSON.parse(localStorage.getItem('layout-setting')) || '' + +const useSettingsStore = defineStore( + 'settings', + { + state: () => ({ + title: '', + theme: storageSetting.theme || '#409EFF', + sideTheme: storageSetting.sideTheme || sideTheme, + showSettings: showSettings, + navType: storageSetting.navType === undefined ? navType : storageSetting.navType, + tagsView: storageSetting.tagsView === undefined ? tagsView : storageSetting.tagsView, + tagsIcon: storageSetting.tagsIcon === undefined ? tagsIcon : storageSetting.tagsIcon, + fixedHeader: storageSetting.fixedHeader === undefined ? fixedHeader : storageSetting.fixedHeader, + sidebarLogo: storageSetting.sidebarLogo === undefined ? sidebarLogo : storageSetting.sidebarLogo, + dynamicTitle: storageSetting.dynamicTitle === undefined ? dynamicTitle : storageSetting.dynamicTitle, + footerVisible: storageSetting.footerVisible === undefined ? footerVisible : storageSetting.footerVisible, + footerContent: footerContent, + isDark: isDark.value + }), + actions: { + // 修改布局设置 + changeSetting(data) { + const { key, value } = data + if (this.hasOwnProperty(key)) { + this[key] = value + } + }, + // 设置网页标题 + setTitle(title) { + this.title = title + useDynamicTitle() + }, + // 切换暗黑模式 + toggleTheme() { + this.isDark = !this.isDark + toggleDark() + } + } + }) + +export default useSettingsStore diff --git a/shierfeng-fastapi-frontend/src/store/modules/tagsView.js b/shierfeng-fastapi-frontend/src/store/modules/tagsView.js new file mode 100644 index 0000000..9d07f33 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/tagsView.js @@ -0,0 +1,182 @@ +const useTagsViewStore = defineStore( + 'tags-view', + { + state: () => ({ + visitedViews: [], + cachedViews: [], + iframeViews: [] + }), + actions: { + addView(view) { + this.addVisitedView(view) + this.addCachedView(view) + }, + addIframeView(view) { + if (this.iframeViews.some(v => v.path === view.path)) return + this.iframeViews.push( + Object.assign({}, view, { + title: view.meta.title || 'no-name' + }) + ) + }, + addVisitedView(view) { + if (this.visitedViews.some(v => v.path === view.path)) return + this.visitedViews.push( + Object.assign({}, view, { + title: view.meta.title || 'no-name' + }) + ) + }, + addCachedView(view) { + if (this.cachedViews.includes(view.name)) return + if (!view.meta.noCache) { + this.cachedViews.push(view.name) + } + }, + delView(view) { + return new Promise(resolve => { + this.delVisitedView(view) + this.delCachedView(view) + resolve({ + visitedViews: [...this.visitedViews], + cachedViews: [...this.cachedViews] + }) + }) + }, + delVisitedView(view) { + return new Promise(resolve => { + for (const [i, v] of this.visitedViews.entries()) { + if (v.path === view.path) { + this.visitedViews.splice(i, 1) + break + } + } + this.iframeViews = this.iframeViews.filter(item => item.path !== view.path) + resolve([...this.visitedViews]) + }) + }, + delIframeView(view) { + return new Promise(resolve => { + this.iframeViews = this.iframeViews.filter(item => item.path !== view.path) + resolve([...this.iframeViews]) + }) + }, + delCachedView(view) { + return new Promise(resolve => { + const index = this.cachedViews.indexOf(view.name) + index > -1 && this.cachedViews.splice(index, 1) + resolve([...this.cachedViews]) + }) + }, + delOthersViews(view) { + return new Promise(resolve => { + this.delOthersVisitedViews(view) + this.delOthersCachedViews(view) + resolve({ + visitedViews: [...this.visitedViews], + cachedViews: [...this.cachedViews] + }) + }) + }, + delOthersVisitedViews(view) { + return new Promise(resolve => { + this.visitedViews = this.visitedViews.filter(v => { + return v.meta.affix || v.path === view.path + }) + this.iframeViews = this.iframeViews.filter(item => item.path === view.path) + resolve([...this.visitedViews]) + }) + }, + delOthersCachedViews(view) { + return new Promise(resolve => { + const index = this.cachedViews.indexOf(view.name) + if (index > -1) { + this.cachedViews = this.cachedViews.slice(index, index + 1) + } else { + this.cachedViews = [] + } + resolve([...this.cachedViews]) + }) + }, + delAllViews(view) { + return new Promise(resolve => { + this.delAllVisitedViews(view) + this.delAllCachedViews(view) + resolve({ + visitedViews: [...this.visitedViews], + cachedViews: [...this.cachedViews] + }) + }) + }, + delAllVisitedViews(view) { + return new Promise(resolve => { + const affixTags = this.visitedViews.filter(tag => tag.meta.affix) + this.visitedViews = affixTags + this.iframeViews = [] + resolve([...this.visitedViews]) + }) + }, + delAllCachedViews(view) { + return new Promise(resolve => { + this.cachedViews = [] + resolve([...this.cachedViews]) + }) + }, + updateVisitedView(view) { + for (let v of this.visitedViews) { + if (v.path === view.path) { + v = Object.assign(v, view) + break + } + } + }, + delRightTags(view) { + return new Promise(resolve => { + const index = this.visitedViews.findIndex(v => v.path === view.path) + if (index === -1) { + return + } + this.visitedViews = this.visitedViews.filter((item, idx) => { + if (idx <= index || (item.meta && item.meta.affix)) { + return true + } + const i = this.cachedViews.indexOf(item.name) + if (i > -1) { + this.cachedViews.splice(i, 1) + } + if(item.meta.link) { + const fi = this.iframeViews.findIndex(v => v.path === item.path) + this.iframeViews.splice(fi, 1) + } + return false + }) + resolve([...this.visitedViews]) + }) + }, + delLeftTags(view) { + return new Promise(resolve => { + const index = this.visitedViews.findIndex(v => v.path === view.path) + if (index === -1) { + return + } + this.visitedViews = this.visitedViews.filter((item, idx) => { + if (idx >= index || (item.meta && item.meta.affix)) { + return true + } + const i = this.cachedViews.indexOf(item.name) + if (i > -1) { + this.cachedViews.splice(i, 1) + } + if(item.meta.link) { + const fi = this.iframeViews.findIndex(v => v.path === item.path) + this.iframeViews.splice(fi, 1) + } + return false + }) + resolve([...this.visitedViews]) + }) + } + } + }) + +export default useTagsViewStore diff --git a/shierfeng-fastapi-frontend/src/store/modules/user.js b/shierfeng-fastapi-frontend/src/store/modules/user.js new file mode 100644 index 0000000..bba5dd6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/store/modules/user.js @@ -0,0 +1,91 @@ +import router from '@/router' +import { ElMessageBox } from 'element-plus' +import { login, logout, getInfo } from '@/api/login' +import { getToken, setToken, removeToken } from '@/utils/auth' +import { isHttp, isEmpty } from "@/utils/validate" +import defAva from '@/assets/images/profile.jpg' + +const useUserStore = defineStore( + 'user', + { + state: () => ({ + token: getToken(), + id: '', + name: '', + nickName: '', + avatar: '', + roles: [], + permissions: [] + }), + actions: { + // 登录 + login(userInfo) { + const username = userInfo.username.trim() + const password = userInfo.password + const code = userInfo.code + const uuid = userInfo.uuid + return new Promise((resolve, reject) => { + login(username, password, code, uuid).then(res => { + setToken(res.token) + this.token = res.token + resolve() + }).catch(error => { + reject(error) + }) + }) + }, + // 获取用户信息 + getInfo() { + return new Promise((resolve, reject) => { + getInfo().then(res => { + const user = res.user + let avatar = user.avatar || "" + if (!isHttp(avatar)) { + avatar = (isEmpty(avatar)) ? defAva : import.meta.env.VITE_APP_BASE_API + avatar + } + if (res.roles && res.roles.length > 0) { // 验证返回的roles是否是一个非空数组 + this.roles = res.roles + this.permissions = res.permissions + } else { + this.roles = ['ROLE_DEFAULT'] + } + this.id = user.userId + this.name = user.userName + this.nickName = user.nickName + this.avatar = avatar + /* 初始密码提示 */ + if(res.isDefaultModifyPwd) { + ElMessageBox.confirm('您的密码还是初始密码,请修改密码!', '安全提示', { confirmButtonText: '确定', cancelButtonText: '取消', type: 'warning' }).then(() => { + router.push({ name: 'Profile', params: { activeTab: 'resetPwd' } }) + }).catch(() => {}) + } + /* 过期密码提示 */ + if(!res.isDefaultModifyPwd && res.isPasswordExpired) { + ElMessageBox.confirm('您的密码已过期,请尽快修改密码!', '安全提示', { confirmButtonText: '确定', cancelButtonText: '取消', type: 'warning' }).then(() => { + router.push({ name: 'Profile', params: { activeTab: 'resetPwd' } }) + }).catch(() => {}) + } + resolve(res) + }).catch(error => { + reject(error) + }) + }) + }, + // 退出系统 + logOut() { + return new Promise((resolve, reject) => { + logout(this.token).then(() => { + this.token = '' + this.roles = [] + this.permissions = [] + removeToken() + resolve() + }).catch(error => { + reject(error) + }) + }) + } + } + }) + +export default useUserStore diff --git a/shierfeng-fastapi-frontend/src/utils/auth.js b/shierfeng-fastapi-frontend/src/utils/auth.js new file mode 100644 index 0000000..08a43d6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/auth.js @@ -0,0 +1,15 @@ +import Cookies from 'js-cookie' + +const TokenKey = 'Admin-Token' + +export function getToken() { + return Cookies.get(TokenKey) +} + +export function setToken(token) { + return Cookies.set(TokenKey, token) +} + +export function removeToken() { + return Cookies.remove(TokenKey) +} diff --git a/shierfeng-fastapi-frontend/src/utils/dict.js b/shierfeng-fastapi-frontend/src/utils/dict.js new file mode 100644 index 0000000..9648f14 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/dict.js @@ -0,0 +1,24 @@ +import useDictStore from '@/store/modules/dict' +import { getDicts } from '@/api/system/dict/data' + +/** + * 获取字典数据 + */ +export function useDict(...args) { + const res = ref({}); + return (() => { + args.forEach((dictType, index) => { + res.value[dictType] = []; + const dicts = useDictStore().getDict(dictType); + if (dicts) { + res.value[dictType] = dicts; + } else { + getDicts(dictType).then(resp => { + res.value[dictType] = resp.data.map(p => ({ label: p.dictLabel, value: p.dictValue, elTagType: p.listClass, elTagClass: p.cssClass })) + useDictStore().setDict(dictType, res.value[dictType]); + }) + } + }) + return toRefs(res.value); + })() +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/dynamicTitle.js b/shierfeng-fastapi-frontend/src/utils/dynamicTitle.js new file mode 100644 index 0000000..7e6ab55 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/dynamicTitle.js @@ -0,0 +1,14 @@ +import defaultSettings from '@/settings' +import useSettingsStore from '@/store/modules/settings' + +/** + * 动态修改标题 + */ +export function useDynamicTitle() { + const settingsStore = useSettingsStore(); + if (settingsStore.dynamicTitle) { + document.title = settingsStore.title + ' - ' + defaultSettings.title; + } else { + document.title = defaultSettings.title; + } +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/errorCode.js b/shierfeng-fastapi-frontend/src/utils/errorCode.js new file mode 100644 index 0000000..d2111ee --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/errorCode.js @@ -0,0 +1,6 @@ +export default { + '401': '认证失败,无法访问系统资源', + '403': '当前操作没有权限', + '404': '访问资源不存在', + 'default': '系统未知错误,请反馈给管理员' +} diff --git a/shierfeng-fastapi-frontend/src/utils/generator/config.js b/shierfeng-fastapi-frontend/src/utils/generator/config.js new file mode 100755 index 0000000..449715f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/config.js @@ -0,0 +1,452 @@ +export const formConf = { + formRef: 'formRef', + formModel: 'formData', + size: 'default', + labelPosition: 'right', + labelWidth: 100, + formRules: 'rules', + gutter: 15, + disabled: false, + span: 24, + formBtns: true, +} + +export const inputComponents = [ + { + label: '单行文本', + tag: 'el-input', + tagIcon: 'input', + type: 'text', + placeholder: '请输入', + defaultValue: undefined, + span: 24, + labelWidth: null, + style: { width: '100%' }, + clearable: true, + prepend: '', + append: '', + 'prefix-icon': '', + 'suffix-icon': '', + maxlength: null, + 'show-word-limit': false, + readonly: false, + disabled: false, + required: true, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/input', + }, + { + label: '多行文本', + tag: 'el-input', + tagIcon: 'textarea', + type: 'textarea', + placeholder: '请输入', + defaultValue: undefined, + span: 24, + labelWidth: null, + autosize: { + minRows: 4, + maxRows: 4, + }, + style: { width: '100%' }, + maxlength: null, + 'show-word-limit': false, + readonly: false, + disabled: false, + required: true, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/input', + }, + { + label: '密码', + tag: 'el-input', + tagIcon: 'password', + type: 'password', + placeholder: '请输入', + defaultValue: undefined, + span: 24, + 'show-password': true, + labelWidth: null, + style: { width: '100%' }, + clearable: true, + prepend: '', + append: '', + 'prefix-icon': '', + 'suffix-icon': '', + maxlength: null, + 'show-word-limit': false, + readonly: false, + disabled: false, + required: true, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/input', + }, + { + label: '计数器', + tag: 'el-input-number', + tagIcon: 'number', + placeholder: '', + defaultValue: undefined, + span: 24, + labelWidth: null, + min: undefined, + max: undefined, + step: undefined, + 'step-strictly': false, + precision: undefined, + 'controls-position': '', + disabled: false, + required: true, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/input-number', + }, +] + +export const selectComponents = [ + { + label: '下拉选择', + tag: 'el-select', + tagIcon: 'select', + placeholder: '请选择', + defaultValue: undefined, + span: 24, + labelWidth: null, + style: { width: '100%' }, + clearable: true, + disabled: false, + required: true, + filterable: false, + multiple: false, + options: [ + { + label: '选项一', + value: 1, + }, + { + label: '选项二', + value: 2, + }, + ], + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/select', + }, + { + label: '级联选择', + tag: 'el-cascader', + tagIcon: 'cascader', + placeholder: '请选择', + defaultValue: [], + span: 24, + labelWidth: null, + style: { width: '100%' }, + props: { + props: { + multiple: false, + }, + }, + 'show-all-levels': true, + disabled: false, + clearable: true, + filterable: false, + required: true, + options: [ + { + id: 1, + value: 1, + label: '选项1', + children: [ + { + id: 2, + value: 2, + label: '选项1-1', + }, + ], + }, + ], + dataType: 'dynamic', + labelKey: 'label', + valueKey: 'value', + childrenKey: 'children', + separator: '/', + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/cascader', + }, + { + label: '单选框组', + tag: 'el-radio-group', + tagIcon: 'radio', + defaultValue: 0, + span: 24, + labelWidth: null, + style: {}, + optionType: 'default', + border: false, + size: 'default', + disabled: false, + required: true, + options: [ + { + label: '选项一', + value: 1, + }, + { + label: '选项二', + value: 2, + }, + ], + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/radio', + }, + { + label: '多选框组', + tag: 'el-checkbox-group', + tagIcon: 'checkbox', + defaultValue: [], + span: 24, + labelWidth: null, + style: {}, + optionType: 'default', + border: false, + size: 'default', + disabled: false, + required: true, + options: [ + { + label: '选项一', + value: 1, + }, + { + label: '选项二', + value: 2, + }, + ], + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/checkbox', + }, + { + label: '开关', + tag: 'el-switch', + tagIcon: 'switch', + defaultValue: false, + span: 24, + labelWidth: null, + style: {}, + disabled: false, + required: true, + 'active-text': '', + 'inactive-text': '', + 'active-color': null, + 'inactive-color': null, + 'active-value': true, + 'inactive-value': false, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/switch', + }, + { + label: '滑块', + tag: 'el-slider', + tagIcon: 'slider', + defaultValue: null, + span: 24, + labelWidth: null, + disabled: false, + required: true, + min: 0, + max: 100, + step: 1, + 'show-stops': false, + range: false, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/slider', + }, + { + label: '时间选择', + tag: 'el-time-picker', + tagIcon: 'time', + placeholder: '请选择', + defaultValue: '', + span: 24, + labelWidth: null, + style: { width: '100%' }, + disabled: false, + clearable: true, + required: true, + format: 'HH:mm:ss', + 'value-format': 'HH:mm:ss', + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/time-picker', + }, + { + label: '时间范围', + tag: 'el-time-picker', + tagIcon: 'time-range', + defaultValue: null, + span: 24, + labelWidth: null, + style: { width: '100%' }, + disabled: false, + clearable: true, + required: true, + 'is-range': true, + 'range-separator': '至', + 'start-placeholder': '开始时间', + 'end-placeholder': '结束时间', + format: 'HH:mm:ss', + 'value-format': 'HH:mm:ss', + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/time-picker', + }, + { + label: '日期选择', + tag: 'el-date-picker', + tagIcon: 'date', + placeholder: '请选择', + defaultValue: null, + type: 'date', + span: 24, + labelWidth: null, + style: { width: '100%' }, + disabled: false, + clearable: true, + required: true, + format: 'YYYY-MM-DD', + 'value-format': 'YYYY-MM-DD', + readonly: false, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/date-picker', + }, + { + label: '日期范围', + tag: 'el-date-picker', + tagIcon: 'date-range', + defaultValue: null, + span: 24, + labelWidth: null, + style: { width: '100%' }, + type: 'daterange', + 'range-separator': '至', + 'start-placeholder': '开始日期', + 'end-placeholder': '结束日期', + disabled: false, + clearable: true, + required: true, + format: 'YYYY-MM-DD', + 'value-format': 'YYYY-MM-DD', + readonly: false, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/date-picker', + }, + { + label: '评分', + tag: 'el-rate', + tagIcon: 'rate', + defaultValue: 0, + span: 24, + labelWidth: null, + style: {}, + max: 5, + 'allow-half': false, + 'show-text': false, + 'show-score': false, + disabled: false, + required: true, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/rate', + }, + { + label: '颜色选择', + tag: 'el-color-picker', + tagIcon: 'color', + defaultValue: null, + labelWidth: null, + 'show-alpha': false, + 'color-format': '', + disabled: false, + required: true, + size: 'default', + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/color-picker', + }, + { + label: '上传', + tag: 'el-upload', + tagIcon: 'upload', + action: 'https://jsonplaceholder.typicode.com/posts/', + defaultValue: null, + labelWidth: null, + disabled: false, + required: true, + accept: '', + name: 'file', + 'auto-upload': true, + showTip: false, + buttonText: '点击上传', + fileSize: 2, + sizeUnit: 'MB', + 'list-type': 'text', + multiple: false, + regList: [], + changeTag: true, + document: 'https://element-plus.org/zh-CN/component/upload', + tip: '只能上传不超过 2MB 的文件', + style: { width: '100%' }, + }, +] + +export const layoutComponents = [ + { + layout: 'rowFormItem', + tagIcon: 'row', + type: 'default', + justify: 'start', + align: 'top', + label: '行容器', + layoutTree: true, + children: [], + document: 'https://element-plus.org/zh-CN/component/layout', + }, + { + layout: 'colFormItem', + label: '按钮', + changeTag: true, + labelWidth: null, + tag: 'el-button', + tagIcon: 'button', + span: 24, + default: '主要按钮', + type: 'primary', + icon: 'Search', + size: 'default', + disabled: false, + document: 'https://element-plus.org/zh-CN/component/button', + }, +] + +// 组件rule的触发方式,无触发方式的组件不生成rule +export const trigger = { + 'el-input': 'blur', + 'el-input-number': 'blur', + 'el-select': 'change', + 'el-radio-group': 'change', + 'el-checkbox-group': 'change', + 'el-cascader': 'change', + 'el-time-picker': 'change', + 'el-date-picker': 'change', + 'el-rate': 'change', +} diff --git a/shierfeng-fastapi-frontend/src/utils/generator/css.js b/shierfeng-fastapi-frontend/src/utils/generator/css.js new file mode 100755 index 0000000..c1c62e6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/css.js @@ -0,0 +1,18 @@ +const styles = { + 'el-rate': '.el-rate{display: inline-block; vertical-align: text-top;}', + 'el-upload': '.el-upload__tip{line-height: 1.2;}' +} + +function addCss(cssList, el) { + const css = styles[el.tag] + css && cssList.indexOf(css) === -1 && cssList.push(css) + if (el.children) { + el.children.forEach(el2 => addCss(cssList, el2)) + } +} + +export function makeUpCss(conf) { + const cssList = [] + conf.fields.forEach(el => addCss(cssList, el)) + return cssList.join('\n') +} diff --git a/shierfeng-fastapi-frontend/src/utils/generator/drawingDefault.js b/shierfeng-fastapi-frontend/src/utils/generator/drawingDefault.js new file mode 100755 index 0000000..7d5a29d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/drawingDefault.js @@ -0,0 +1,37 @@ +export const drawingDefaultValue = [] + +export function initDrawingDefaultValue() { + if (drawingDefaultValue.length === 0) { + drawingDefaultValue.push({ + layout: 'colFormItem', + tagIcon: 'input', + label: '手机号', + vModel: 'mobile', + formId: 6, + tag: 'el-input', + placeholder: '请输入手机号', + defaultValue: '', + span: 24, + style: {width: '100%'}, + clearable: true, + prepend: '', + append: '', + 'prefix-icon': 'Cellphone', + 'suffix-icon': '', + maxlength: 11, + 'show-word-limit': true, + readonly: false, + disabled: false, + required: true, + changeTag: true, + regList: [{ + pattern: '/^1(3|4|5|7|8|9)\\d{9}$/', + message: '手机号格式错误' + }] + }) + } +} + +export function cleanDrawingDefaultValue() { + drawingDefaultValue.splice(0, drawingDefaultValue.length) +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/generator/html.js b/shierfeng-fastapi-frontend/src/utils/generator/html.js new file mode 100755 index 0000000..4b29841 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/html.js @@ -0,0 +1,359 @@ +/* eslint-disable max-len */ +import { trigger } from './config' + +let confGlobal +let someSpanIsNot24 + +export function dialogWrapper(str) { + return ` + ${str} + + ` +} + +export function vueTemplate(str) { + return `` +} + +export function vueScript(str) { + return `` +} + +export function cssStyle(cssStr) { + return `` +} + +function buildFormTemplate(conf, child, type) { + let labelPosition = '' + if (conf.labelPosition !== 'right') { + labelPosition = `label-position="${conf.labelPosition}"` + } + const disabled = conf.disabled ? `:disabled="${conf.disabled}"` : '' + let str = ` + ${child} + ${buildFromBtns(conf, type)} + ` + if (someSpanIsNot24) { + str = ` + ${str} + ` + } + return str +} + +function buildFromBtns(conf, type) { + let str = '' + if (conf.formBtns && type === 'file') { + str = ` + 提交 + 重置 + ` + if (someSpanIsNot24) { + str = ` + ${str} + ` + } + } + return str +} + +// span不为24的用el-col包裹 +function colWrapper(element, str) { + if (someSpanIsNot24 || element.span !== 24) { + return ` + ${str} + ` + } + return str +} + +const layouts = { + colFormItem(element) { + let labelWidth = '' + if (element.labelWidth && element.labelWidth !== confGlobal.labelWidth) { + labelWidth = `label-width="${element.labelWidth}px"` + } + const required = !trigger[element.tag] && element.required ? 'required' : '' + const tagDom = tags[element.tag] ? tags[element.tag](element) : null + let str = ` + ${tagDom} + ` + str = colWrapper(element, str) + return str + }, + rowFormItem(element) { + const type = element.type === 'default' ? '' : `type="${element.type}"` + const justify = element.type === 'default' ? '' : `justify="${element.justify}"` + const align = element.type === 'default' ? '' : `align="${element.align}"` + const gutter = element.gutter ? `gutter="${element.gutter}"` : '' + const children = element.children.map(el => layouts[el.layout](el)) + let str = ` + ${children.join('\n')} + ` + str = colWrapper(element, str) + return str + } +} + +const tags = { + 'el-button': el => { + const { + tag, disabled + } = attrBuilder(el) + const type = el.type ? `type="${el.type}"` : '' + const icon = el.icon ? `icon="${el.icon}"` : '' + const size = el.size ? `size="${el.size}"` : '' + let child = buildElButtonChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${type} ${icon} ${size} ${disabled}>${child}` + }, + 'el-input': el => { + const { + disabled, vModel, clearable, placeholder, width + } = attrBuilder(el) + const maxlength = el.maxlength ? `:maxlength="${el.maxlength}"` : '' + const showWordLimit = el['show-word-limit'] ? 'show-word-limit' : '' + const readonly = el.readonly ? 'readonly' : '' + const prefixIcon = el['prefix-icon'] ? `prefix-icon='${el['prefix-icon']}'` : '' + const suffixIcon = el['suffix-icon'] ? `suffix-icon='${el['suffix-icon']}'` : '' + const showPassword = el['show-password'] ? 'show-password' : '' + const type = el.type ? `type="${el.type}"` : '' + const autosize = el.autosize && el.autosize.minRows + ? `:autosize="{minRows: ${el.autosize.minRows}, maxRows: ${el.autosize.maxRows}}"` + : '' + let child = buildElInputChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${vModel} ${type} ${placeholder} ${maxlength} ${showWordLimit} ${readonly} ${disabled} ${clearable} ${prefixIcon} ${suffixIcon} ${showPassword} ${autosize} ${width}>${child}` + }, + 'el-input-number': el => { + const { disabled, vModel, placeholder } = attrBuilder(el) + const controlsPosition = el['controls-position'] ? `controls-position=${el['controls-position']}` : '' + const min = el.min ? `:min='${el.min}'` : '' + const max = el.max ? `:max='${el.max}'` : '' + const step = el.step ? `:step='${el.step}'` : '' + const stepStrictly = el['step-strictly'] ? 'step-strictly' : '' + const precision = el.precision ? `:precision='${el.precision}'` : '' + + return `<${el.tag} ${vModel} ${placeholder} ${step} ${stepStrictly} ${precision} ${controlsPosition} ${min} ${max} ${disabled}>` + }, + 'el-select': el => { + const { + disabled, vModel, clearable, placeholder, width + } = attrBuilder(el) + const filterable = el.filterable ? 'filterable' : '' + const multiple = el.multiple ? 'multiple' : '' + let child = buildElSelectChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${vModel} ${placeholder} ${disabled} ${multiple} ${filterable} ${clearable} ${width}>${child}` + }, + 'el-radio-group': el => { + const { disabled, vModel } = attrBuilder(el) + const size = `size="${el.size}"` + let child = buildElRadioGroupChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${vModel} ${size} ${disabled}>${child}` + }, + 'el-checkbox-group': el => { + const { disabled, vModel } = attrBuilder(el) + const size = `size="${el.size}"` + const min = el.min ? `:min="${el.min}"` : '' + const max = el.max ? `:max="${el.max}"` : '' + let child = buildElCheckboxGroupChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${vModel} ${min} ${max} ${size} ${disabled}>${child}` + }, + 'el-switch': el => { + const { disabled, vModel } = attrBuilder(el) + const activeText = el['active-text'] ? `active-text="${el['active-text']}"` : '' + const inactiveText = el['inactive-text'] ? `inactive-text="${el['inactive-text']}"` : '' + const activeColor = el['active-color'] ? `active-color="${el['active-color']}"` : '' + const inactiveColor = el['inactive-color'] ? `inactive-color="${el['inactive-color']}"` : '' + const activeValue = el['active-value'] !== true ? `:active-value='${JSON.stringify(el['active-value'])}'` : '' + const inactiveValue = el['inactive-value'] !== false ? `:inactive-value='${JSON.stringify(el['inactive-value'])}'` : '' + + return `<${el.tag} ${vModel} ${activeText} ${inactiveText} ${activeColor} ${inactiveColor} ${activeValue} ${inactiveValue} ${disabled}>` + }, + 'el-cascader': el => { + const { + disabled, vModel, clearable, placeholder, width + } = attrBuilder(el) + const options = el.options ? `:options="${el.vModel}Options"` : '' + const props = el.props ? `:props="${el.vModel}Props"` : '' + const showAllLevels = el['show-all-levels'] ? '' : ':show-all-levels="false"' + const filterable = el.filterable ? 'filterable' : '' + const separator = el.separator === '/' ? '' : `separator="${el.separator}"` + + return `<${el.tag} ${vModel} ${options} ${props} ${width} ${showAllLevels} ${placeholder} ${separator} ${filterable} ${clearable} ${disabled}>` + }, + 'el-slider': el => { + const { disabled, vModel } = attrBuilder(el) + const min = el.min ? `:min='${el.min}'` : '' + const max = el.max ? `:max='${el.max}'` : '' + const step = el.step ? `:step='${el.step}'` : '' + const range = el.range ? 'range' : '' + const showStops = el['show-stops'] ? `:show-stops="${el['show-stops']}"` : '' + + return `<${el.tag} ${min} ${max} ${step} ${vModel} ${range} ${showStops} ${disabled}>` + }, + 'el-time-picker': el => { + const { + disabled, vModel, clearable, placeholder, width + } = attrBuilder(el) + const startPlaceholder = el['start-placeholder'] ? `start-placeholder="${el['start-placeholder']}"` : '' + const endPlaceholder = el['end-placeholder'] ? `end-placeholder="${el['end-placeholder']}"` : '' + const rangeSeparator = el['range-separator'] ? `range-separator="${el['range-separator']}"` : '' + const isRange = el['is-range'] ? 'is-range' : '' + const format = el.format ? `format="${el.format}"` : '' + const valueFormat = el['value-format'] ? `value-format="${el['value-format']}"` : '' + const pickerOptions = el['picker-options'] ? `:picker-options='${JSON.stringify(el['picker-options'])}'` : '' + + return `<${el.tag} ${vModel} ${isRange} ${format} ${valueFormat} ${pickerOptions} ${width} ${placeholder} ${startPlaceholder} ${endPlaceholder} ${rangeSeparator} ${clearable} ${disabled}>` + }, + 'el-date-picker': el => { + const { + disabled, vModel, clearable, placeholder, width + } = attrBuilder(el) + const startPlaceholder = el['start-placeholder'] ? `start-placeholder="${el['start-placeholder']}"` : '' + const endPlaceholder = el['end-placeholder'] ? `end-placeholder="${el['end-placeholder']}"` : '' + const rangeSeparator = el['range-separator'] ? `range-separator="${el['range-separator']}"` : '' + const format = el.format ? `format="${el.format}"` : '' + const valueFormat = el['value-format'] ? `value-format="${el['value-format']}"` : '' + const type = el.type === 'date' ? '' : `type="${el.type}"` + const readonly = el.readonly ? 'readonly' : '' + + return `<${el.tag} ${type} ${vModel} ${format} ${valueFormat} ${width} ${placeholder} ${startPlaceholder} ${endPlaceholder} ${rangeSeparator} ${clearable} ${readonly} ${disabled}>` + }, + 'el-rate': el => { + const { disabled, vModel } = attrBuilder(el) + const max = el.max ? `:max='${el.max}'` : '' + const allowHalf = el['allow-half'] ? 'allow-half' : '' + const showText = el['show-text'] ? 'show-text' : '' + const showScore = el['show-score'] ? 'show-score' : '' + + return `<${el.tag} ${vModel} ${allowHalf} ${showText} ${showScore} ${disabled}>` + }, + 'el-color-picker': el => { + const { disabled, vModel } = attrBuilder(el) + const size = `size="${el.size}"` + const showAlpha = el['show-alpha'] ? 'show-alpha' : '' + const colorFormat = el['color-format'] ? `color-format="${el['color-format']}"` : '' + + return `<${el.tag} ${vModel} ${size} ${showAlpha} ${colorFormat} ${disabled}>` + }, + 'el-upload': el => { + const disabled = el.disabled ? ':disabled=\'true\'' : '' + const action = el.action ? `:action="${el.vModel}Action"` : '' + const multiple = el.multiple ? 'multiple' : '' + const listType = el['list-type'] !== 'text' ? `list-type="${el['list-type']}"` : '' + const accept = el.accept ? `accept="${el.accept}"` : '' + const name = el.name !== 'file' ? `name="${el.name}"` : '' + const autoUpload = el['auto-upload'] === false ? ':auto-upload="false"' : '' + const beforeUpload = `:before-upload="${el.vModel}BeforeUpload"` + const fileList = `:file-list="${el.vModel}fileList"` + const ref = `ref="${el.vModel}"` + let child = buildElUploadChild(el) + + if (child) child = `\n${child}\n` // 换行 + return `<${el.tag} ${ref} ${fileList} ${action} ${autoUpload} ${multiple} ${beforeUpload} ${listType} ${accept} ${name} ${disabled}>${child}` + } +} + +function attrBuilder(el) { + return { + vModel: `v-model="${confGlobal.formModel}.${el.vModel}"`, + clearable: el.clearable ? 'clearable' : '', + placeholder: el.placeholder ? `placeholder="${el.placeholder}"` : '', + width: el.style && el.style.width ? ':style="{width: \'100%\'}"' : '', + disabled: el.disabled ? ':disabled=\'true\'' : '' + } +} + +// el-buttin 子级 +function buildElButtonChild(conf) { + const children = [] + if (conf.default) { + children.push(conf.default) + } + return children.join('\n') +} + +// el-input innerHTML +function buildElInputChild(conf) { + const children = [] + if (conf.prepend) { + children.push(``) + } + if (conf.append) { + children.push(``) + } + return children.join('\n') +} + +function buildElSelectChild(conf) { + const children = [] + if (conf.options && conf.options.length) { + children.push(``) + } + return children.join('\n') +} + +function buildElRadioGroupChild(conf) { + const children = [] + if (conf.options && conf.options.length) { + const tag = conf.optionType === 'button' ? 'el-radio-button' : 'el-radio' + const border = conf.border ? 'border' : '' + children.push(`<${tag} v-for="(item, index) in ${conf.vModel}Options" :key="index" :value="item.value" :disabled="item.disabled" ${border}>{{item.label}}`) + } + return children.join('\n') +} + +function buildElCheckboxGroupChild(conf) { + const children = [] + if (conf.options && conf.options.length) { + const tag = conf.optionType === 'button' ? 'el-checkbox-button' : 'el-checkbox' + const border = conf.border ? 'border' : '' + children.push(`<${tag} v-for="(item, index) in ${conf.vModel}Options" :key="index" :label="item.value" :value="item.label" :disabled="item.disabled" ${border} />`) + } + return children.join('\n') +} + +function buildElUploadChild(conf) { + const list = [] + if (conf['list-type'] === 'picture-card') list.push('') + else list.push(`${conf.buttonText}`) + if (conf.showTip) list.push(`
只能上传不超过 ${conf.fileSize}${conf.sizeUnit} 的${conf.accept}文件
`) + return list.join('\n') +} + +export function makeUpHtml(conf, type) { + const htmlList = [] + confGlobal = conf + someSpanIsNot24 = conf.fields.some(item => item.span !== 24) + conf.fields.forEach(el => { + htmlList.push(layouts[el.layout](el)) + }) + const htmlStr = htmlList.join('\n') + + let temp = buildFormTemplate(conf, htmlStr, type) + if (type === 'dialog') { + temp = dialogWrapper(temp) + } + confGlobal = null + return temp +} diff --git a/shierfeng-fastapi-frontend/src/utils/generator/icon.json b/shierfeng-fastapi-frontend/src/utils/generator/icon.json new file mode 100755 index 0000000..2d9999a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/icon.json @@ -0,0 +1 @@ +["platform-eleme","eleme","delete-solid","delete","s-tools","setting","user-solid","user","phone","phone-outline","more","more-outline","star-on","star-off","s-goods","goods","warning","warning-outline","question","info","remove","circle-plus","success","error","zoom-in","zoom-out","remove-outline","circle-plus-outline","circle-check","circle-close","s-help","help","minus","plus","check","close","picture","picture-outline","picture-outline-round","upload","upload2","download","camera-solid","camera","video-camera-solid","video-camera","message-solid","bell","s-cooperation","s-order","s-platform","s-fold","s-unfold","s-operation","s-promotion","s-home","s-release","s-ticket","s-management","s-open","s-shop","s-marketing","s-flag","s-comment","s-finance","s-claim","s-custom","s-opportunity","s-data","s-check","s-grid","menu","share","d-caret","caret-left","caret-right","caret-bottom","caret-top","bottom-left","bottom-right","back","right","bottom","top","top-left","top-right","arrow-left","arrow-right","arrow-down","arrow-up","d-arrow-left","d-arrow-right","video-pause","video-play","refresh","refresh-right","refresh-left","finished","sort","sort-up","sort-down","rank","loading","view","c-scale-to-original","date","edit","edit-outline","folder","folder-opened","folder-add","folder-remove","folder-delete","folder-checked","tickets","document-remove","document-delete","document-copy","document-checked","document","document-add","printer","paperclip","takeaway-box","search","monitor","attract","mobile","scissors","umbrella","headset","brush","mouse","coordinate","magic-stick","reading","data-line","data-board","pie-chart","data-analysis","collection-tag","film","suitcase","suitcase-1","receiving","collection","files","notebook-1","notebook-2","toilet-paper","office-building","school","table-lamp","house","no-smoking","smoking","shopping-cart-full","shopping-cart-1","shopping-cart-2","shopping-bag-1","shopping-bag-2","sold-out","sell","present","box","bank-card","money","coin","wallet","discount","price-tag","news","guide","male","female","thumb","cpu","link","connection","open","turn-off","set-up","chat-round","chat-line-round","chat-square","chat-dot-round","chat-dot-square","chat-line-square","message","postcard","position","turn-off-microphone","microphone","close-notification","bangzhu","time","odometer","crop","aim","switch-button","full-screen","copy-document","mic","stopwatch","medal-1","medal","trophy","trophy-1","first-aid-kit","discover","place","location","location-outline","location-information","add-location","delete-location","map-location","alarm-clock","timer","watch-1","watch","lock","unlock","key","service","mobile-phone","bicycle","truck","ship","basketball","football","soccer","baseball","wind-power","light-rain","lightning","heavy-rain","sunrise","sunrise-1","sunset","sunny","cloudy","partly-cloudy","cloudy-and-sunny","moon","moon-night","dish","dish-1","food","chicken","fork-spoon","knife-fork","burger","tableware","sugar","dessert","ice-cream","hot-water","water-cup","coffee-cup","cold-drink","goblet","goblet-full","goblet-square","goblet-square-full","refrigerator","grape","watermelon","cherry","apple","pear","orange","coffee","ice-tea","ice-drink","milk-tea","potato-strips","lollipop","ice-cream-square","ice-cream-round"] \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/generator/js.js b/shierfeng-fastapi-frontend/src/utils/generator/js.js new file mode 100755 index 0000000..dc38bfe --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/js.js @@ -0,0 +1,370 @@ +import { titleCase } from '@/utils/index' +import { trigger } from './config' +// 文件大小设置 +const units = { + KB: '1024', + MB: '1024 / 1024', + GB: '1024 / 1024 / 1024', +} +/** + * @name: 生成js需要的数据 + * @description: 生成js需要的数据 + * @param {*} conf + * @param {*} type 弹窗或表单 + * @return {*} + */ +export function makeUpJs(conf, type) { + conf = JSON.parse(JSON.stringify(conf)) + const dataList = [] + const ruleList = [] + const optionsList = [] + const propsList = [] + const methodList = [] + const uploadVarList = [] + + conf.fields.forEach((el) => { + buildAttributes( + el, + dataList, + ruleList, + optionsList, + methodList, + propsList, + uploadVarList + ) + }) + + const script = buildexport( + conf, + type, + dataList.join('\n'), + ruleList.join('\n'), + optionsList.join('\n'), + uploadVarList.join('\n'), + propsList.join('\n'), + methodList.join('\n') + ) + + return script +} +/** + * @name: 生成参数 + * @description: 生成参数,包括表单数据表单验证数据,多选选项数据,上传数据等 + * @return {*} + */ +function buildAttributes( + el, + dataList, + ruleList, + optionsList, + methodList, + propsList, + uploadVarList +){ + buildData(el, dataList) + buildRules(el, ruleList) + + if (el.options && el.options.length) { + buildOptions(el, optionsList) + if (el.dataType === 'dynamic') { + const model = `${el.vModel}Options` + const options = titleCase(model) + buildOptionMethod(`get${options}`, model, methodList) + } + } + + if (el.props && el.props.props) { + buildProps(el, propsList) + } + + if (el.action && el.tag === 'el-upload') { + uploadVarList.push( + ` + // 上传请求路径 + const ${el.vModel}Action = ref('${el.action}') + // 上传文件列表 + const ${el.vModel}fileList = ref([])` + ) + methodList.push(buildBeforeUpload(el)) + if (!el['auto-upload']) { + methodList.push(buildSubmitUpload(el)) + } + } + + if (el.children) { + el.children.forEach((el2) => { + buildAttributes( + el2, + dataList, + ruleList, + optionsList, + methodList, + propsList, + uploadVarList + ) + }) + } +} +/** + * @name: 生成表单数据formData + * @description: 生成表单数据formData + * @param {*} conf + * @param {*} dataList 数据列表 + * @return {*} + */ +function buildData(conf, dataList) { + if (conf.vModel === undefined) return + let defaultValue + if (typeof conf.defaultValue === 'string' && !conf.multiple) { + defaultValue = `'${conf.defaultValue}'` + } else { + defaultValue = `${JSON.stringify(conf.defaultValue)}` + } + dataList.push(`${conf.vModel}: ${defaultValue},`) +} +/** + * @name: 生成表单验证数据rule + * @description: 生成表单验证数据rule + * @param {*} conf + * @param {*} ruleList 验证数据列表 + * @return {*} + */ +function buildRules(conf, ruleList) { + if (conf.vModel === undefined) return + const rules = [] + if (trigger[conf.tag]) { + if (conf.required) { + const type = Array.isArray(conf.defaultValue) ? "type: 'array'," : '' + let message = Array.isArray(conf.defaultValue) + ? `请至少选择一个${conf.vModel}` + : conf.placeholder + if (message === undefined) message = `${conf.label}不能为空` + rules.push( + `{ required: true, ${type} message: '${message}', trigger: '${ + trigger[conf.tag] + }' }` + ) + } + if (conf.regList && Array.isArray(conf.regList)) { + conf.regList.forEach((item) => { + if (item.pattern) { + rules.push( + `{ pattern: new RegExp(${item.pattern}), message: '${ + item.message + }', trigger: '${trigger[conf.tag]}' }` + ) + } + }) + } + ruleList.push(`${conf.vModel}: [${rules.join(',')}],`) + } +} +/** + * @name: 生成选项数据 + * @description: 生成选项数据,单选多选下拉等 + * @param {*} conf + * @param {*} optionsList 选项数据列表 + * @return {*} + */ +function buildOptions(conf, optionsList) { + if (conf.vModel === undefined) return + if (conf.dataType === 'dynamic') { + conf.options = [] + } + const str = `const ${conf.vModel}Options = ref(${JSON.stringify(conf.options)})` + optionsList.push(str) +} +/** + * @name: 生成方法 + * @description: 生成方法 + * @param {*} methodName 方法名 + * @param {*} model + * @param {*} methodList 方法列表 + * @return {*} + */ +function buildOptionMethod(methodName, model, methodList) { + const str = `function ${methodName}() { + // TODO 发起请求获取数据 + ${model}.value + }` + methodList.push(str) +} +/** + * @name: 生成表单组件需要的props设置 + * @description: 生成表单组件需要的props设置,如;级联组件 + * @param {*} conf + * @param {*} propsList + * @return {*} + */ +function buildProps(conf, propsList) { + if (conf.dataType === 'dynamic') { + conf.valueKey !== 'value' && (conf.props.props.value = conf.valueKey) + conf.labelKey !== 'label' && (conf.props.props.label = conf.labelKey) + conf.childrenKey !== 'children' && + (conf.props.props.children = conf.childrenKey) + } + const str = ` + // props设置 + const ${conf.vModel}Props = ref(${JSON.stringify(conf.props.props)})` + propsList.push(str) +} +/** + * @name: 生成上传组件的相关内容 + * @description: 生成上传组件的相关内容 + * @param {*} conf + * @return {*} + */ +function buildBeforeUpload(conf) { + const unitNum = units[conf.sizeUnit] + let rightSizeCode = '' + let acceptCode = '' + const returnList = [] + if (conf.fileSize) { + rightSizeCode = `let isRightSize = file.size / ${unitNum} < ${conf.fileSize} + if(!isRightSize){ + proxy.$modal.msgError('文件大小超过 ${conf.fileSize}${conf.sizeUnit}') + }` + returnList.push('isRightSize') + } + if (conf.accept) { + acceptCode = `let isAccept = new RegExp('${conf.accept}').test(file.type) + if(!isAccept){ + proxy.$modal.msgError('应该选择${conf.accept}类型的文件') + }` + returnList.push('isAccept') + } + const str = ` + /** + * @name: 上传之前的文件判断 + * @description: 上传之前的文件判断,判断文件大小文件类型等 + * @param {*} file + * @return {*} + */ + function ${conf.vModel}BeforeUpload(file) { + ${rightSizeCode} + ${acceptCode} + return ${returnList.join('&&')} + }` + return returnList.length ? str : '' +} +/** + * @name: 生成提交表单方法 + * @description: 生成提交表单方法 + * @param {Object} conf vModel 表单ref + * @return {*} + */ +function buildSubmitUpload(conf) { + const str = `function submitUpload() { + this.$refs['${conf.vModel}'].submit() + }` + return str +} +/** + * @name: 组装js代码 + * @description: 组装js代码方法 + * @return {*} + */ +function buildexport( + conf, + type, + data, + rules, + selectOptions, + uploadVar, + props, + methods +) { + let str = ` + const { proxy } = getCurrentInstance() + const ${conf.formRef} = ref() + const data = reactive({ + ${conf.formModel}: { + ${data} + }, + ${conf.formRules}: { + ${rules} + } + }) + + const {${conf.formModel}, ${conf.formRules}} = toRefs(data) + + ${selectOptions} + + ${uploadVar} + + ${props} + + ${methods} + ` + + if(type === 'dialog') { + str += ` + // 弹窗设置 + const dialogVisible = defineModel() + // 弹窗确认回调 + const emit = defineEmits(['confirm']) + /** + * @name: 弹窗打开后执行 + * @description: 弹窗打开后执行方法 + * @return {*} + */ + function onOpen(){ + + } + /** + * @name: 弹窗关闭时执行 + * @description: 弹窗关闭方法,重置表单 + * @return {*} + */ + function onClose(){ + ${conf.formRef}.value.resetFields() + } + /** + * @name: 弹窗取消 + * @description: 弹窗取消方法 + * @return {*} + */ + function close(){ + dialogVisible.value = false + } + /** + * @name: 弹窗表单提交 + * @description: 弹窗表单提交方法 + * @return {*} + */ + function handelConfirm(){ + ${conf.formRef}.value.validate((valid) => { + if (!valid) return + // TODO 提交表单 + + close() + // 回调父级组件 + emit('confirm') + }) + } + ` + } else { + str += ` + /** + * @name: 表单提交 + * @description: 表单提交方法 + * @return {*} + */ + function submitForm() { + ${conf.formRef}.value.validate((valid) => { + if (!valid) return + // TODO 提交表单 + }) + } + /** + * @name: 表单重置 + * @description: 表单重置方法 + * @return {*} + */ + function resetForm() { + ${conf.formRef}.value.resetFields() + } + ` + } + return str +} diff --git a/shierfeng-fastapi-frontend/src/utils/generator/render.js b/shierfeng-fastapi-frontend/src/utils/generator/render.js new file mode 100755 index 0000000..d6d4414 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/generator/render.js @@ -0,0 +1,156 @@ +import { defineComponent, h } from 'vue' +import { makeMap } from '@/utils/index' + +const isAttr = makeMap( + 'accept,accept-charset,accesskey,action,align,alt,async,autocomplete,' + + 'autofocus,autoplay,autosave,bgcolor,border,buffered,challenge,charset,' + + 'checked,cite,class,code,codebase,color,cols,colspan,content,http-equiv,' + + 'name,contenteditable,contextmenu,controls,coords,data,datetime,default,' + + 'defer,dir,dirname,disabled,download,draggable,dropzone,enctype,method,for,' + + 'form,formaction,headers,height,hidden,high,href,hreflang,http-equiv,' + + 'icon,id,ismap,itemprop,keytype,kind,label,lang,language,list,loop,low,' + + 'manifest,max,maxlength,media,method,GET,POST,min,multiple,email,file,' + + 'muted,name,novalidate,open,optimum,pattern,ping,placeholder,poster,' + + 'preload,radiogroup,readonly,rel,required,reversed,rows,rowspan,sandbox,' + + 'scope,scoped,seamless,selected,shape,size,type,text,password,sizes,span,' + + 'spellcheck,src,srcdoc,srclang,srcset,start,step,style,summary,tabindex,' + + 'target,title,type,usemap,value,width,wrap' + 'prefix-icon' +) +const isNotProps = makeMap( + 'layout,prepend,regList,tag,document,changeTag,defaultValue' +) + +function useVModel(props, emit) { + return { + modelValue: props.defaultValue, + 'onUpdate:modelValue': (val) => emit('update:modelValue', val), + } +} +const componentChild = { + 'el-button': { + default(h, conf, key) { + return conf[key] + }, + }, + 'el-select': { + options(h, conf, key) { + return conf.options.map(item => h(resolveComponent('el-option'), { + label: item.label, + value: item.value, + })) + } + }, + 'el-radio-group': { + options(h, conf, key) { + return conf.optionType === 'button' ? conf.options.map(item => h(resolveComponent('el-checkbox-button'), { + label: item.value, + }, () => item.label)) : conf.options.map(item => h(resolveComponent('el-radio'), { + label: item.value, + border: conf.border, + }, () => item.label)) + } + }, + 'el-checkbox-group': { + options(h, conf, key) { + return conf.optionType === 'button' ? conf.options.map(item => h(resolveComponent('el-checkbox-button'), { + label: item.value, + }, () => item.label)) : conf.options.map(item => h(resolveComponent('el-checkbox'), { + label: item.value, + border: conf.border, + }, () => item.label)) + } + }, + 'el-upload': { + 'list-type': (h, conf, key) => { + const option = {} + // if (conf.showTip) { + // tip = h('div', { + // class: "el-upload__tip" + // }, () => '只能上传不超过' + conf.fileSize + conf.sizeUnit + '的' + conf.accept + '文件') + // } + if (conf['list-type'] === 'picture-card') { + return h(resolveComponent('el-icon'), option, () => h(resolveComponent('Plus'))) + } else { + // option.size = "small" + option.type = "primary" + option.icon = "Upload" + return h(resolveComponent('el-button'), option, () => conf.buttonText) + } + }, + + } +} +const componentSlot = { + 'el-upload': { + 'tip': (h, conf, key) => { + if (conf.showTip) { + return () => h('div', { + class: "el-upload__tip" + }, '只能上传不超过' + conf.fileSize + conf.sizeUnit + '的' + conf.accept + '文件') + } + }, + } +} +export default defineComponent({ + + // 使用 render 函数 + render() { + const dataObject = { + attrs: {}, + props: {}, + on: {}, + style: {} + } + const confClone = JSON.parse(JSON.stringify(this.conf)) + const children = [] + const slot = {} + const childObjs = componentChild[confClone.tag] + if (childObjs) { + Object.keys(childObjs).forEach(key => { + const childFunc = childObjs[key] + if (confClone[key]) { + children.push(childFunc(h, confClone, key)) + } + }) + } + const slotObjs = componentSlot[confClone.tag] + if (slotObjs) { + Object.keys(slotObjs).forEach(key => { + const childFunc = slotObjs[key] + if (confClone[key]) { + slot[key] = childFunc(h, confClone, key) + } + }) + } + Object.keys(confClone).forEach(key => { + const val = confClone[key] + if (dataObject[key]) { + dataObject[key] = val + } else if (isAttr(key)) { + dataObject.attrs[key] = val + } else if (!isNotProps(key)) { + dataObject.props[key] = val + } + }) + if(children.length > 0){ + slot.default = () => children + } + + return h(resolveComponent(this.conf.tag), + { + modelValue: this.$attrs.modelValue, + ...dataObject.props, + ...dataObject.attrs, + style: { + ...dataObject.style + }, + } + , slot ?? null) + }, + props: { + conf: { + type: Object, + required: true, + }, + } +}) \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/index.js b/shierfeng-fastapi-frontend/src/utils/index.js new file mode 100644 index 0000000..4f9eb9f --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/index.js @@ -0,0 +1,390 @@ +import { parseTime } from './shierfeng' + +/** + * 表格时间格式化 + */ +export function formatDate(cellValue) { + if (cellValue == null || cellValue == "") return ""; + var date = new Date(cellValue) + var year = date.getFullYear() + var month = date.getMonth() + 1 < 10 ? '0' + (date.getMonth() + 1) : date.getMonth() + 1 + var day = date.getDate() < 10 ? '0' + date.getDate() : date.getDate() + var hours = date.getHours() < 10 ? '0' + date.getHours() : date.getHours() + var minutes = date.getMinutes() < 10 ? '0' + date.getMinutes() : date.getMinutes() + var seconds = date.getSeconds() < 10 ? '0' + date.getSeconds() : date.getSeconds() + return year + '-' + month + '-' + day + ' ' + hours + ':' + minutes + ':' + seconds +} + +/** + * @param {number} time + * @param {string} option + * @returns {string} + */ +export function formatTime(time, option) { + if (('' + time).length === 10) { + time = parseInt(time) * 1000 + } else { + time = +time + } + const d = new Date(time) + const now = Date.now() + + const diff = (now - d) / 1000 + + if (diff < 30) { + return '刚刚' + } else if (diff < 3600) { + // less 1 hour + return Math.ceil(diff / 60) + '分钟前' + } else if (diff < 3600 * 24) { + return Math.ceil(diff / 3600) + '小时前' + } else if (diff < 3600 * 24 * 2) { + return '1天前' + } + if (option) { + return parseTime(time, option) + } else { + return ( + d.getMonth() + + 1 + + '月' + + d.getDate() + + '日' + + d.getHours() + + '时' + + d.getMinutes() + + '分' + ) + } +} + +/** + * @param {string} url + * @returns {Object} + */ +export function getQueryObject(url) { + url = url == null ? window.location.href : url + const search = url.substring(url.lastIndexOf('?') + 1) + const obj = {} + const reg = /([^?&=]+)=([^?&=]*)/g + search.replace(reg, (rs, $1, $2) => { + const name = decodeURIComponent($1) + let val = decodeURIComponent($2) + val = String(val) + obj[name] = val + return rs + }) + return obj +} + +/** + * @param {string} input value + * @returns {number} output value + */ +export function byteLength(str) { + // returns the byte length of an utf8 string + let s = str.length + for (var i = str.length - 1; i >= 0; i--) { + const code = str.charCodeAt(i) + if (code > 0x7f && code <= 0x7ff) s++ + else if (code > 0x7ff && code <= 0xffff) s += 2 + if (code >= 0xDC00 && code <= 0xDFFF) i-- + } + return s +} + +/** + * @param {Array} actual + * @returns {Array} + */ +export function cleanArray(actual) { + const newArray = [] + for (let i = 0; i < actual.length; i++) { + if (actual[i]) { + newArray.push(actual[i]) + } + } + return newArray +} + +/** + * @param {Object} json + * @returns {Array} + */ +export function param(json) { + if (!json) return '' + return cleanArray( + Object.keys(json).map(key => { + if (json[key] === undefined) return '' + return encodeURIComponent(key) + '=' + encodeURIComponent(json[key]) + }) + ).join('&') +} + +/** + * @param {string} url + * @returns {Object} + */ +export function param2Obj(url) { + const search = decodeURIComponent(url.split('?')[1]).replace(/\+/g, ' ') + if (!search) { + return {} + } + const obj = {} + const searchArr = search.split('&') + searchArr.forEach(v => { + const index = v.indexOf('=') + if (index !== -1) { + const name = v.substring(0, index) + const val = v.substring(index + 1, v.length) + obj[name] = val + } + }) + return obj +} + +/** + * @param {string} val + * @returns {string} + */ +export function html2Text(val) { + const div = document.createElement('div') + div.innerHTML = val + return div.textContent || div.innerText +} + +/** + * Merges two objects, giving the last one precedence + * @param {Object} target + * @param {(Object|Array)} source + * @returns {Object} + */ +export function objectMerge(target, source) { + if (typeof target !== 'object') { + target = {} + } + if (Array.isArray(source)) { + return source.slice() + } + Object.keys(source).forEach(property => { + const sourceProperty = source[property] + if (typeof sourceProperty === 'object') { + target[property] = objectMerge(target[property], sourceProperty) + } else { + target[property] = sourceProperty + } + }) + return target +} + +/** + * @param {HTMLElement} element + * @param {string} className + */ +export function toggleClass(element, className) { + if (!element || !className) { + return + } + let classString = element.className + const nameIndex = classString.indexOf(className) + if (nameIndex === -1) { + classString += '' + className + } else { + classString = + classString.substr(0, nameIndex) + + classString.substr(nameIndex + className.length) + } + element.className = classString +} + +/** + * @param {string} type + * @returns {Date} + */ +export function getTime(type) { + if (type === 'start') { + return new Date().getTime() - 3600 * 1000 * 24 * 90 + } else { + return new Date(new Date().toDateString()) + } +} + +/** + * @param {Function} func + * @param {number} wait + * @param {boolean} immediate + * @return {*} + */ +export function debounce(func, wait, immediate) { + let timeout, args, context, timestamp, result + + const later = function() { + // 据上一次触发时间间隔 + const last = +new Date() - timestamp + + // 上次被包装函数被调用时间间隔 last 小于设定时间间隔 wait + if (last < wait && last > 0) { + timeout = setTimeout(later, wait - last) + } else { + timeout = null + // 如果设定为immediate===true,因为开始边界已经调用过了此处无需调用 + if (!immediate) { + result = func.apply(context, args) + if (!timeout) context = args = null + } + } + } + + return function(...args) { + context = this + timestamp = +new Date() + const callNow = immediate && !timeout + // 如果延时不存在,重新设定延时 + if (!timeout) timeout = setTimeout(later, wait) + if (callNow) { + result = func.apply(context, args) + context = args = null + } + + return result + } +} + +/** + * This is just a simple version of deep copy + * Has a lot of edge cases bug + * If you want to use a perfect deep copy, use lodash's _.cloneDeep + * @param {Object} source + * @returns {Object} + */ +export function deepClone(source) { + if (!source && typeof source !== 'object') { + throw new Error('error arguments', 'deepClone') + } + const targetObj = source.constructor === Array ? [] : {} + Object.keys(source).forEach(keys => { + if (source[keys] && typeof source[keys] === 'object') { + targetObj[keys] = deepClone(source[keys]) + } else { + targetObj[keys] = source[keys] + } + }) + return targetObj +} + +/** + * @param {Array} arr + * @returns {Array} + */ +export function uniqueArr(arr) { + return Array.from(new Set(arr)) +} + +/** + * @returns {string} + */ +export function createUniqueString() { + const timestamp = +new Date() + '' + const randomNum = parseInt((1 + Math.random()) * 65536) + '' + return (+(randomNum + timestamp)).toString(32) +} + +/** + * Check if an element has a class + * @param {HTMLElement} elm + * @param {string} cls + * @returns {boolean} + */ +export function hasClass(ele, cls) { + return !!ele.className.match(new RegExp('(\\s|^)' + cls + '(\\s|$)')) +} + +/** + * Add class to element + * @param {HTMLElement} elm + * @param {string} cls + */ +export function addClass(ele, cls) { + if (!hasClass(ele, cls)) ele.className += ' ' + cls +} + +/** + * Remove class from element + * @param {HTMLElement} elm + * @param {string} cls + */ +export function removeClass(ele, cls) { + if (hasClass(ele, cls)) { + const reg = new RegExp('(\\s|^)' + cls + '(\\s|$)') + ele.className = ele.className.replace(reg, ' ') + } +} + +export function makeMap(str, expectsLowerCase) { + const map = Object.create(null) + const list = str.split(',') + for (let i = 0; i < list.length; i++) { + map[list[i]] = true + } + return expectsLowerCase + ? val => map[val.toLowerCase()] + : val => map[val] +} + +export const exportDefault = 'export default ' + +export const beautifierConf = { + html: { + indent_size: '2', + indent_char: ' ', + max_preserve_newlines: '-1', + preserve_newlines: false, + keep_array_indentation: false, + break_chained_methods: false, + indent_scripts: 'separate', + brace_style: 'end-expand', + space_before_conditional: true, + unescape_strings: false, + jslint_happy: false, + end_with_newline: true, + wrap_line_length: '110', + indent_inner_html: true, + comma_first: false, + e4x: true, + indent_empty_lines: true + }, + js: { + indent_size: '2', + indent_char: ' ', + max_preserve_newlines: '-1', + preserve_newlines: false, + keep_array_indentation: false, + break_chained_methods: false, + indent_scripts: 'normal', + brace_style: 'end-expand', + space_before_conditional: true, + unescape_strings: false, + jslint_happy: true, + end_with_newline: true, + wrap_line_length: '110', + indent_inner_html: true, + comma_first: false, + e4x: true, + indent_empty_lines: true + } +} + +// 首字母大小 +export function titleCase(str) { + return str.replace(/( |^)[a-z]/g, L => L.toUpperCase()) +} + +// 下划转驼峰 +export function camelCase(str) { + return str.replace(/_[a-z]/g, str1 => str1.substr(-1).toUpperCase()) +} + +export function isNumberStr(str) { + return /^[+-]?(0|([1-9]\d*))(\.\d+)?$/g.test(str) +} + diff --git a/shierfeng-fastapi-frontend/src/utils/jsencrypt.js b/shierfeng-fastapi-frontend/src/utils/jsencrypt.js new file mode 100644 index 0000000..78d9523 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/jsencrypt.js @@ -0,0 +1,30 @@ +import JSEncrypt from 'jsencrypt/bin/jsencrypt.min' + +// 密钥对生成 http://web.chacuo.net/netrsakeypair + +const publicKey = 'MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAKoR8mX0rGKLqzcWmOzbfj64K8ZIgOdH\n' + + 'nzkXSOVOZbFu/TJhZ7rFAN+eaGkl3C4buccQd/EjEsj9ir7ijT7h96MCAwEAAQ==' + +const privateKey = 'MIIBVAIBADANBgkqhkiG9w0BAQEFAASCAT4wggE6AgEAAkEAqhHyZfSsYourNxaY\n' + + '7Nt+PrgrxkiA50efORdI5U5lsW79MmFnusUA355oaSXcLhu5xxB38SMSyP2KvuKN\n' + + 'PuH3owIDAQABAkAfoiLyL+Z4lf4Myxk6xUDgLaWGximj20CUf+5BKKnlrK+Ed8gA\n' + + 'kM0HqoTt2UZwA5E2MzS4EI2gjfQhz5X28uqxAiEA3wNFxfrCZlSZHb0gn2zDpWow\n' + + 'cSxQAgiCstxGUoOqlW8CIQDDOerGKH5OmCJ4Z21v+F25WaHYPxCFMvwxpcw99Ecv\n' + + 'DQIgIdhDTIqD2jfYjPTY8Jj3EDGPbH2HHuffvflECt3Ek60CIQCFRlCkHpi7hthh\n' + + 'YhovyloRYsM+IS9h/0BzlEAuO0ktMQIgSPT3aFAgJYwKpqRYKlLDVcflZFCKY7u3\n' + + 'UP8iWi1Qw0Y=' + +// 加密 +export function encrypt(txt) { + const encryptor = new JSEncrypt() + encryptor.setPublicKey(publicKey) // 设置公钥 + return encryptor.encrypt(txt) // 对数据进行加密 +} + +// 解密 +export function decrypt(txt) { + const encryptor = new JSEncrypt() + encryptor.setPrivateKey(privateKey) // 设置私钥 + return encryptor.decrypt(txt) // 对数据进行解密 +} + diff --git a/shierfeng-fastapi-frontend/src/utils/permission.js b/shierfeng-fastapi-frontend/src/utils/permission.js new file mode 100644 index 0000000..93fee87 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/permission.js @@ -0,0 +1,51 @@ +import useUserStore from '@/store/modules/user' + +/** + * 字符权限校验 + * @param {Array} value 校验值 + * @returns {Boolean} + */ +export function checkPermi(value) { + if (value && value instanceof Array && value.length > 0) { + const permissions = useUserStore().permissions + const permissionDatas = value + const all_permission = "*:*:*"; + + const hasPermission = permissions.some(permission => { + return all_permission === permission || permissionDatas.includes(permission) + }) + + if (!hasPermission) { + return false + } + return true + } else { + console.error(`need roles! Like checkPermi="['system:user:add','system:user:edit']"`) + return false + } +} + +/** + * 角色权限校验 + * @param {Array} value 校验值 + * @returns {Boolean} + */ +export function checkRole(value) { + if (value && value instanceof Array && value.length > 0) { + const roles = useUserStore().roles + const permissionRoles = value + const super_admin = "admin"; + + const hasRole = roles.some(role => { + return super_admin === role || permissionRoles.includes(role) + }) + + if (!hasRole) { + return false + } + return true + } else { + console.error(`need roles! Like checkRole="['admin','editor']"`) + return false + } +} \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/utils/request.js b/shierfeng-fastapi-frontend/src/utils/request.js new file mode 100644 index 0000000..c53d1fb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/request.js @@ -0,0 +1,206 @@ +import axios from 'axios' +import { ElNotification , ElMessageBox, ElMessage, ElLoading } from 'element-plus' +import { getToken } from '@/utils/auth' +import errorCode from '@/utils/errorCode' +import { tansParams, blobValidate } from '@/utils/shierfeng' +import cache from '@/plugins/cache' +import { saveAs } from 'file-saver' +import useUserStore from '@/store/modules/user' +import { + decryptTransportErrorResponse, + decryptTransportResponse, + encryptTransportRequest, + invalidateTransportKeyMeta, + resetTransportRequestConfig, + shouldRetryTransportWithFreshKey +} from '@/utils/transportCrypto' + +let downloadLoadingInstance; +// 是否显示重新登录 +export let isRelogin = { show: false }; + +axios.defaults.headers['Content-Type'] = 'application/json;charset=utf-8' +// 创建axios实例 +const service = axios.create({ + // axios中请求配置有baseURL选项,表示请求URL公共部分 + baseURL: import.meta.env.VITE_APP_BASE_API, + // 超时 + timeout: 10000 +}) + +/** + * 统一处理请求发送前的公共逻辑。 + * + * @param {Object} config Axios 请求配置 + * @returns {Promise} 最终发送的请求配置 + */ +// request拦截器 +service.interceptors.request.use(async config => { + // 是否需要设置 token + const isToken = (config.headers || {}).isToken === false + // 是否需要防止数据重复提交 + const isRepeatSubmit = (config.headers || {}).repeatSubmit === false + // 间隔时间(ms),小于此时间视为重复提交 + const interval = (config.headers || {}).interval || 1000 + if (getToken() && !isToken) { + config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改 + } + if (!isRepeatSubmit && (config.method === 'post' || config.method === 'put')) { + const requestObj = { + url: config.url, + data: typeof config.data === 'object' ? JSON.stringify(config.data) : config.data, + time: new Date().getTime() + } + const requestSize = Object.keys(JSON.stringify(requestObj)).length; // 请求数据大小 + const limitSize = 5 * 1024 * 1024; // 限制存放数据5M + if (requestSize >= limitSize) { + console.warn(`[${config.url}]: ` + '请求数据大小超出允许的5M限制,无法进行防重复提交验证。') + return config; + } + const sessionObj = cache.session.getJSON('sessionObj') + if (sessionObj === undefined || sessionObj === null || sessionObj === '') { + cache.session.setJSON('sessionObj', requestObj) + } else { + const s_url = sessionObj.url; // 请求地址 + const s_data = sessionObj.data; // 请求数据 + const s_time = sessionObj.time; // 请求时间 + if (s_data === requestObj.data && requestObj.time - s_time < interval && s_url === requestObj.url) { + const message = '数据正在处理,请勿重复提交'; + console.warn(`[${s_url}]: ` + message) + return Promise.reject(new Error(message)) + } else { + cache.session.setJSON('sessionObj', requestObj) + } + } + } + // 在参数拼接前完成传输层加密,避免明文查询串提前写入 URL。 + config = await encryptTransportRequest(config) + // get请求映射params参数 + if (config.method === 'get' && config.params) { + let url = config.url + '?' + tansParams(config.params); + url = url.slice(0, -1); + config.params = {}; + config.url = url; + } + return config +}, error => { + console.log(error) + return Promise.reject(error) +}) + +/** + * 统一处理响应成功场景下的解密与业务状态码判断。 + * + * @param {Object} res Axios 响应对象 + * @returns {Promise} 业务响应数据 + */ +// 响应拦截器 +service.interceptors.response.use(async res => { + // 响应若命中了传输层加密,这里先还原为原始业务 JSON。 + res = await decryptTransportResponse(res) + // 未设置状态码则默认成功状态 + const code = res.data.code || 200; + // 获取错误信息 + const msg = errorCode[code] || res.data.msg || errorCode['default'] + // 二进制数据则直接返回 + if (res.request.responseType === 'blob' || res.request.responseType === 'arraybuffer') { + return res.data + } + if (code === 401) { + if (!isRelogin.show) { + isRelogin.show = true; + ElMessageBox.confirm('登录状态已过期,您可以继续留在该页面,或者重新登录', '系统提示', { confirmButtonText: '重新登录', cancelButtonText: '取消', type: 'warning' }).then(() => { + isRelogin.show = false; + useUserStore().logOut().then(() => { + location.href = '/index'; + }) + }).catch(() => { + isRelogin.show = false; + }); + } + return Promise.reject('无效的会话,或者会话已过期,请重新登录。') + } else if (code === 500) { + ElMessage({ message: msg, type: 'error' }) + return Promise.reject(new Error(msg)) + } else if (code === 601) { + ElMessage({ message: msg, type: 'warning' }) + return Promise.reject(new Error(msg)) + } else if (code !== 200) { + ElNotification.error({ title: msg }) + return Promise.reject('error') + } else { + return Promise.resolve(res.data) + } + }, + async error => { + // 错误响应也可能是加密信封,先尝试解密再进入统一错误提示流程。 + error = await decryptTransportErrorResponse(error) + // 若后端提示密钥失效,则清空本地公钥缓存并基于原始请求重试一次。 + if (shouldRetryTransportWithFreshKey(error) && error.config && !error.config.__transportRetried) { + invalidateTransportKeyMeta() + error.config.__transportRetried = true + error.config.headers = error.config.headers || {} + error.config.headers.repeatSubmit = false + resetTransportRequestConfig(error.config) + return service.request(error.config) + } + console.log('err' + error) + const response = error.response + const responseStatus = response?.status + const responseCode = response?.data?.code + const responseMsg = response?.data?.msg + if (responseMsg) { + const messageType = responseStatus === 429 || responseCode === 429 ? 'warning' : 'error' + ElMessage({ message: responseMsg, type: messageType, duration: 5 * 1000 }) + return Promise.reject(new Error(responseMsg)) + } + let { message } = error; + if (message == "Network Error") { + message = "后端接口连接异常"; + } else if (message.includes("timeout")) { + message = "系统接口请求超时"; + } else if (message.includes("Request failed with status code")) { + message = "系统接口" + message.slice(-3) + "异常"; + } + ElMessage({ message: message, type: 'error', duration: 5 * 1000 }) + return Promise.reject(error) + } +) + +/** + * 通用文件下载方法。 + * + * @param {string} url 下载接口地址 + * @param {*} params 请求参数 + * @param {string} filename 下载文件名 + * @param {Object} config 额外请求配置 + * @returns {Promise} + */ +// 通用下载方法 +export function download(url, params, filename, config) { + downloadLoadingInstance = ElLoading.service({ text: "正在下载数据,请稍候", background: "rgba(0, 0, 0, 0.7)", }) + return service.post(url, params, { + transformRequest: [(params) => { return tansParams(params) }], + headers: { 'Content-Type': 'application/x-www-form-urlencoded', encrypt: false, encryptResponse: false }, + responseType: 'blob', + ...config + }).then(async (data) => { + const isBlob = blobValidate(data); + if (isBlob) { + const blob = new Blob([data]) + saveAs(blob, filename) + } else { + const resText = await data.text(); + const rspObj = JSON.parse(resText); + const errMsg = errorCode[rspObj.code] || rspObj.msg || errorCode['default'] + ElMessage.error(errMsg); + } + downloadLoadingInstance.close(); + }).catch((r) => { + console.error(r) + ElMessage.error('下载文件出现错误,请联系管理员!') + downloadLoadingInstance.close(); + }) +} + +export default service diff --git a/shierfeng-fastapi-frontend/src/utils/scroll-to.js b/shierfeng-fastapi-frontend/src/utils/scroll-to.js new file mode 100644 index 0000000..c5d8e04 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/scroll-to.js @@ -0,0 +1,58 @@ +Math.easeInOutQuad = function(t, b, c, d) { + t /= d / 2 + if (t < 1) { + return c / 2 * t * t + b + } + t-- + return -c / 2 * (t * (t - 2) - 1) + b +} + +// requestAnimationFrame for Smart Animating http://goo.gl/sx5sts +var requestAnimFrame = (function() { + return window.requestAnimationFrame || window.webkitRequestAnimationFrame || window.mozRequestAnimationFrame || function(callback) { window.setTimeout(callback, 1000 / 60) } +})() + +/** + * Because it's so fucking difficult to detect the scrolling element, just move them all + * @param {number} amount + */ +function move(amount) { + document.documentElement.scrollTop = amount + document.body.parentNode.scrollTop = amount + document.body.scrollTop = amount +} + +function position() { + return document.documentElement.scrollTop || document.body.parentNode.scrollTop || document.body.scrollTop +} + +/** + * @param {number} to + * @param {number} duration + * @param {Function} callback + */ +export function scrollTo(to, duration, callback) { + const start = position() + const change = to - start + const increment = 20 + let currentTime = 0 + duration = (typeof (duration) === 'undefined') ? 500 : duration + var animateScroll = function() { + // increment the time + currentTime += increment + // find the value with the quadratic in-out easing function + var val = Math.easeInOutQuad(currentTime, start, change, duration) + // move the document.body + move(val) + // do the animation unless its over + if (currentTime < duration) { + requestAnimFrame(animateScroll) + } else { + if (callback && typeof (callback) === 'function') { + // the animation is done so lets callback + callback() + } + } + } + animateScroll() +} diff --git a/shierfeng-fastapi-frontend/src/utils/shierfeng.js b/shierfeng-fastapi-frontend/src/utils/shierfeng.js new file mode 100644 index 0000000..2103742 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/shierfeng.js @@ -0,0 +1,245 @@ + + +/** + * 通用js方法封装处理 + * Copyright (c) 2019 ruoyi + */ + +// 日期格式化 +export function parseTime(time, pattern) { + if (arguments.length === 0 || !time) { + return null + } + const format = pattern || '{y}-{m}-{d} {h}:{i}:{s}' + let date + if (typeof time === 'object') { + date = time + } else { + if ((typeof time === 'string') && (/^[0-9]+$/.test(time))) { + time = parseInt(time) + } else if (typeof time === 'string') { + time = time.replace(new RegExp(/-/gm), '/').replace('T', ' ').replace(new RegExp(/\.[\d]{3}/gm), ''); + } + if ((typeof time === 'number') && (time.toString().length === 10)) { + time = time * 1000 + } + date = new Date(time) + } + const formatObj = { + y: date.getFullYear(), + m: date.getMonth() + 1, + d: date.getDate(), + h: date.getHours(), + i: date.getMinutes(), + s: date.getSeconds(), + a: date.getDay() + } + const time_str = format.replace(/{(y|m|d|h|i|s|a)+}/g, (result, key) => { + let value = formatObj[key] + // Note: getDay() returns 0 on Sunday + if (key === 'a') { return ['日', '一', '二', '三', '四', '五', '六'][value] } + if (result.length > 0 && value < 10) { + value = '0' + value + } + return value || 0 + }) + return time_str +} + +// 表单重置 +export function resetForm(refName) { + if (this.$refs[refName]) { + this.$refs[refName].resetFields(); + } +} + +// 添加日期范围 +export function addDateRange(params, dateRange, propName) { + let search = params; + dateRange = Array.isArray(dateRange) ? dateRange : []; + if (typeof (propName) === 'undefined') { + search['beginTime'] = dateRange[0]; + search['endTime'] = dateRange[1]; + } else { + search['begin' + propName] = dateRange[0]; + search['end' + propName] = dateRange[1]; + } + return search; +} + +// 回显数据字典 +export function selectDictLabel(datas, value) { + if (value === undefined) { + return ""; + } + var actions = []; + Object.keys(datas).some((key) => { + if (datas[key].value == ('' + value)) { + actions.push(datas[key].label); + return true; + } + }) + if (actions.length === 0) { + actions.push(value); + } + return actions.join(''); +} + +// 回显数据字典(字符串数组) +export function selectDictLabels(datas, value, separator) { + if (value === undefined || value.length ===0) { + return ""; + } + if (Array.isArray(value)) { + value = value.join(","); + } + var actions = []; + var currentSeparator = undefined === separator ? "," : separator; + var temp = value.split(currentSeparator); + Object.keys(value.split(currentSeparator)).some((val) => { + var match = false; + Object.keys(datas).some((key) => { + if (datas[key].value == ('' + temp[val])) { + actions.push(datas[key].label + currentSeparator); + match = true; + } + }) + if (!match) { + actions.push(temp[val] + currentSeparator); + } + }) + return actions.join('').substring(0, actions.join('').length - 1); +} + +// 字符串格式化(%s ) +export function sprintf(str) { + var args = arguments, flag = true, i = 1; + str = str.replace(/%s/g, function () { + var arg = args[i++]; + if (typeof arg === 'undefined') { + flag = false; + return ''; + } + return arg; + }); + return flag ? str : ''; +} + +// 转换字符串,undefined,null等转化为"" +export function parseStrEmpty(str) { + if (!str || str == "undefined" || str == "null") { + return ""; + } + return str; +} + +// 数据合并 +export function mergeRecursive(source, target) { + for (var p in target) { + try { + if (target[p].constructor == Object) { + source[p] = mergeRecursive(source[p], target[p]); + } else { + source[p] = target[p]; + } + } catch (e) { + source[p] = target[p]; + } + } + return source; +}; + +/** + * 构造树型结构数据 + * @param {*} data 数据源 + * @param {*} id id字段 默认 'id' + * @param {*} parentId 父节点字段 默认 'parentId' + * @param {*} children 孩子节点字段 默认 'children' + */ +export function handleTree(data, id, parentId, children) { + let config = { + id: id || 'id', + parentId: parentId || 'parentId', + childrenList: children || 'children' + }; + + var childrenListMap = {}; + var nodeIds = {}; + var tree = []; + + for (let d of data) { + let parentId = d[config.parentId]; + if (childrenListMap[parentId] == null) { + childrenListMap[parentId] = []; + } + nodeIds[d[config.id]] = d; + childrenListMap[parentId].push(d); + } + + for (let d of data) { + let parentId = d[config.parentId]; + if (nodeIds[parentId] == null) { + tree.push(d); + } + } + + for (let t of tree) { + adaptToChildrenList(t); + } + + function adaptToChildrenList(o) { + if (childrenListMap[o[config.id]] !== null) { + o[config.childrenList] = childrenListMap[o[config.id]]; + } + if (o[config.childrenList]) { + for (let c of o[config.childrenList]) { + adaptToChildrenList(c); + } + } + } + return tree; +} + +/** +* 参数处理 +* @param {*} params 参数 +*/ +export function tansParams(params) { + let result = '' + for (const propName of Object.keys(params)) { + const value = params[propName]; + var part = encodeURIComponent(propName) + "="; + if (value !== null && value !== "" && typeof (value) !== "undefined") { + if (typeof value === 'object') { + for (const key of Object.keys(value)) { + if (value[key] !== null && value[key] !== "" && typeof (value[key]) !== 'undefined') { + let params = propName + '[' + key + ']'; + var subPart = encodeURIComponent(params) + "="; + result += subPart + encodeURIComponent(value[key]) + "&"; + } + } + } else { + result += part + encodeURIComponent(value) + "&"; + } + } + } + return result +} + + +// 返回项目路径 +export function getNormalPath(p) { + if (p.length === 0 || !p || p == 'undefined') { + return p + }; + let res = p.replace('//', '/') + if (res[res.length - 1] === '/') { + return res.slice(0, res.length - 1) + } + return res; +} + +// 验证是否为blob格式 +export function blobValidate(data) { + return data.type !== 'application/json' +} diff --git a/shierfeng-fastapi-frontend/src/utils/theme.js b/shierfeng-fastapi-frontend/src/utils/theme.js new file mode 100644 index 0000000..f4badc6 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/theme.js @@ -0,0 +1,49 @@ +// 处理主题样式 +export function handleThemeStyle(theme) { + document.documentElement.style.setProperty('--el-color-primary', theme) + for (let i = 1; i <= 9; i++) { + document.documentElement.style.setProperty(`--el-color-primary-light-${i}`, `${getLightColor(theme, i / 10)}`) + } + for (let i = 1; i <= 9; i++) { + document.documentElement.style.setProperty(`--el-color-primary-dark-${i}`, `${getDarkColor(theme, i / 10)}`) + } +} + +// hex颜色转rgb颜色 +export function hexToRgb(str) { + str = str.replace('#', '') + let hexs = str.match(/../g) + for (let i = 0; i < 3; i++) { + hexs[i] = parseInt(hexs[i], 16) + } + return hexs +} + +// rgb颜色转Hex颜色 +export function rgbToHex(r, g, b) { + let hexs = [r.toString(16), g.toString(16), b.toString(16)] + for (let i = 0; i < 3; i++) { + if (hexs[i].length == 1) { + hexs[i] = `0${hexs[i]}` + } + } + return `#${hexs.join('')}` +} + +// 变浅颜色值 +export function getLightColor(color, level) { + let rgb = hexToRgb(color) + for (let i = 0; i < 3; i++) { + rgb[i] = Math.floor((255 - rgb[i]) * level + rgb[i]) + } + return rgbToHex(rgb[0], rgb[1], rgb[2]) +} + +// 变深颜色值 +export function getDarkColor(color, level) { + let rgb = hexToRgb(color) + for (let i = 0; i < 3; i++) { + rgb[i] = Math.floor(rgb[i] * (1 - level)) + } + return rgbToHex(rgb[0], rgb[1], rgb[2]) +} diff --git a/shierfeng-fastapi-frontend/src/utils/transportCrypto.js b/shierfeng-fastapi-frontend/src/utils/transportCrypto.js new file mode 100644 index 0000000..db0e61c --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/transportCrypto.js @@ -0,0 +1,748 @@ +import axios from 'axios' + +import { + ensureTransportCryptoPolicyLoaded, + getTransportCryptoPolicy, + shouldEncryptQuery, + shouldEncryptRequest, + shouldEncryptResponse +} from '@/utils/transportCryptoPolicy' +import cache from '@/plugins/cache' + +const TRANSPORT_BASE_URL = import.meta.env.VITE_APP_BASE_API +const TRANSPORT_ENABLE_HEADER = 'X-Transport-Encrypt' +const TRANSPORT_KEY_ID_HEADER = 'X-Key-Id' +const ENCRYPTED_RESPONSE_HEADER = 'x-body-encrypted' +const DEFAULT_TRANSPORT_ENVELOPE_VERSION = '1' + +const transportClient = axios.create({ + baseURL: TRANSPORT_BASE_URL, + timeout: 10000 +}) + +let cachedKeyMeta = null +let inflightKeyMetaPromise = null +const KEY_REFRESH_BUFFER_MIN_SECONDS = 30 +const KEY_REFRESH_BUFFER_MAX_SECONDS = 300 +const TRANSPORT_KEY_META_CACHE_KEY = 'transportCryptoKeyMeta' +const TRANSPORT_RETRYABLE_ERROR_MESSAGES = new Set(['Decryption failed', '密钥版本不存在']) + +/** + * 获取当前浏览器的 Web Crypto 实例。 + * + * @returns {Crypto} 浏览器加密能力对象 + */ +function getBrowserCrypto() { + const browserCrypto = globalThis.crypto + if (!browserCrypto?.subtle) { + throw new Error('当前浏览器不支持 Web Crypto API') + } + return browserCrypto +} + +/** + * 从请求头对象中读取指定字段。 + * + * @param {Object|Headers} headers 请求头对象 + * @param {string} name 请求头名称 + * @returns {*} 请求头值 + */ +function getHeaderValue(headers, name) { + if (!headers) { + return undefined + } + if (typeof headers.get === 'function') { + return headers.get(name) + } + return headers[name] ?? headers[name.toLowerCase()] +} + +/** + * 为请求头对象设置指定字段。 + * + * @param {Object|Headers} headers 请求头对象 + * @param {string} name 请求头名称 + * @param {*} value 请求头值 + * @returns {void} + */ +function setHeaderValue(headers, name, value) { + if (!headers) { + return + } + if (typeof headers.set === 'function') { + headers.set(name, value) + return + } + headers[name] = value +} + +/** + * 将字节数组编码为 Base64URL 文本。 + * + * @param {Uint8Array} bytes 待编码字节数组 + * @returns {string} Base64URL 文本 + */ +function toBase64Url(bytes) { + let binary = '' + bytes.forEach(byte => { + binary += String.fromCharCode(byte) + }) + return btoa(binary).replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/g, '') +} + +/** + * 将 Base64URL 文本还原为字节数组。 + * + * @param {string} text Base64URL 文本 + * @returns {Uint8Array} 解码后的字节数组 + */ +function fromBase64Url(text) { + const normalizedText = text.replace(/-/g, '+').replace(/_/g, '/') + const paddingLength = (4 - (normalizedText.length % 4 || 4)) % 4 + const binary = atob(normalizedText + '='.repeat(paddingLength)) + return Uint8Array.from(binary, char => char.charCodeAt(0)) +} + +/** + * 将 PEM 公钥转换为 Web Crypto 可导入的 ArrayBuffer。 + * + * @param {string} pem PEM 格式公钥 + * @returns {ArrayBuffer} DER 二进制内容 + */ +function pemToArrayBuffer(pem) { + const normalizedPem = pem.replace(/-----BEGIN PUBLIC KEY-----/g, '').replace(/-----END PUBLIC KEY-----/g, '').replace(/\s+/g, '') + const binary = atob(normalizedPem) + return Uint8Array.from(binary, char => char.charCodeAt(0)).buffer +} + +/** + * 对查询参数信封进行 JSON 编码后再转为 Base64URL。 + * + * @param {Object} envelope 查询参数信封 + * @returns {string} 编码后的查询字符串片段 + */ +function encodeQueryEnvelope(envelope) { + const jsonText = JSON.stringify(envelope) + return toBase64Url(new TextEncoder().encode(jsonText)) +} + +/** + * 计算加密查询参数最终生成的 URL 长度。 + * + * @param {string} url 请求地址 + * @param {Object} params 查询参数 + * @returns {number} URL 长度 + */ +function buildQueryUrlLength(url = '', params = {}) { + const queryText = new URLSearchParams(params).toString() + if (!queryText) { + return String(url || '').length + } + const normalizedUrl = String(url || '') + const separator = normalizedUrl.includes('?') ? '&' : '?' + return `${normalizedUrl}${separator}${queryText}`.length +} + +/** + * 获取基础 API 地址对应的路径前缀。 + * + * @returns {string} 基础路径前缀 + */ +function getBaseApiPath() { + if (!TRANSPORT_BASE_URL) { + return '' + } + if (TRANSPORT_BASE_URL.startsWith('http://') || TRANSPORT_BASE_URL.startsWith('https://')) { + const baseApiPath = new URL(TRANSPORT_BASE_URL).pathname + return baseApiPath === '/' ? '' : baseApiPath + } + return TRANSPORT_BASE_URL +} + +/** + * 计算参与 AAD 校验的标准请求路径。 + * + * @param {string} url 请求地址 + * @returns {string} 标准化请求路径 + */ +function getRequestPath(url = '') { + const baseApiPath = getBaseApiPath() + const normalizedUrl = String(url || '') + + let pathname = normalizedUrl + if (normalizedUrl.startsWith('http://') || normalizedUrl.startsWith('https://')) { + pathname = new URL(normalizedUrl).pathname + } else { + pathname = normalizedUrl.split('?')[0] || '/' + } + + if (baseApiPath && pathname.startsWith(baseApiPath)) { + const normalizedPath = pathname.slice(baseApiPath.length) + return normalizedPath || '/' + } + return pathname || '/' +} + +/** + * 构建请求方向的 AAD 元数据。 + * + * @param {Object} config Axios 请求配置 + * @returns {Object} 请求 AAD + */ +function buildRequestAad(config) { + return { + method: (config.method || 'get').toUpperCase(), + path: getRequestPath(config.url) + } +} + +/** + * 构建响应方向的 AAD 元数据。 + * + * @param {Object} config Axios 请求配置 + * @returns {Object} 响应 AAD + */ +function buildResponseAad(config) { + return { + method: (config?.method || 'get').toUpperCase(), + path: getRequestPath(config?.url), + direction: 'response' + } +} + +/** + * 将空值载荷规范化为可序列化对象。 + * + * @param {*} payload 原始载荷 + * @returns {*} 规范化后的载荷 + */ +function normalizePlainPayload(payload) { + if (payload === undefined || payload === null) { + return {} + } + return payload +} + +/** + * 将请求载荷序列化为 JSON 文本。 + * + * @param {*} payload 原始载荷 + * @returns {string} JSON 文本 + */ +function stringifyPayload(payload) { + const normalizedPayload = normalizePlainPayload(payload) + return JSON.stringify(normalizedPayload) +} + +/** + * 克隆请求配置中的可变字段,避免重试时互相污染。 + * + * @param {*} value 待克隆值 + * @returns {*} 克隆结果 + */ +function cloneRequestValue(value) { + if (value === undefined || value === null) { + return value + } + if (typeof globalThis.structuredClone === 'function') { + return globalThis.structuredClone(value) + } + if (typeof value === 'object') { + return JSON.parse(JSON.stringify(value)) + } + return value +} + +/** + * 将信封字段转换为适合表单提交的字符串。 + * + * @param {*} value 字段值 + * @returns {string} 序列化文本 + */ +function stringifyEnvelopeField(value) { + if (value && typeof value === 'object') { + return JSON.stringify(value) + } + return String(value) +} + +/** + * 将加密信封编码为表单字符串。 + * + * @param {Object} envelope 信封对象 + * @returns {string} 表单编码文本 + */ +function encodeFormEnvelope(envelope) { + const formData = new URLSearchParams() + Object.entries(envelope).forEach(([key, value]) => { + formData.set(key, stringifyEnvelopeField(value)) + }) + return formData.toString() +} + +/** + * 将输入解析为 JSON 对象并校验结构。 + * + * @param {*} payload 原始数据 + * @param {string} errorMessage 校验失败提示 + * @returns {Object} 解析后的对象 + */ +function parseJsonObject(payload, errorMessage) { + const parsedPayload = typeof payload === 'string' ? JSON.parse(payload) : payload + if (!parsedPayload || typeof parsedPayload !== 'object' || Array.isArray(parsedPayload)) { + throw new Error(errorMessage) + } + return parsedPayload +} + +/** + * 校验公钥接口响应壳是否有效。 + * + * @param {Object} responsePayload 公钥接口原始响应 + * @returns {void} + */ +function validateTransportPublicKeyResponse(responsePayload) { + if (responsePayload?.code !== 200 || !responsePayload?.data || typeof responsePayload.data !== 'object') { + throw new Error(responsePayload?.msg || '获取传输层公钥失败') + } +} + +/** + * 校验公钥业务载荷是否满足当前协议要求。 + * + * @param {Object} payload 公钥业务载荷 + * @param {Object} transportPolicy 当前传输策略 + * @returns {void} + */ +function validateTransportPublicKeyPayload(payload, transportPolicy) { + if (!payload?.publicKey || !payload?.kid) { + throw new Error('获取传输层公钥失败') + } + if (String(payload.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION) !== transportPolicy.envelopeVersion) { + throw new Error('传输层公钥协议版本不受支持') + } + if (payload.alg !== transportPolicy.requestEnvelopeAlgorithm) { + throw new Error('传输层公钥算法不受支持') + } +} + +/** + * 校验响应信封与当前请求上下文是否一致。 + * + * @param {Object} envelope 响应信封 + * @param {Object} response Axios 响应对象 + * @param {Object} transportContext 请求加密上下文 + * @param {Object} transportPolicy 当前传输策略 + * @returns {void} + */ +function validateResponseEnvelope(envelope, response, transportContext, transportPolicy) { + const expectedAad = buildResponseAad(response.config) + const responseKid = getHeaderValue(response.headers, TRANSPORT_KEY_ID_HEADER) + const aad = envelope.aad + + if (String(envelope.v || '') !== transportPolicy.envelopeVersion) { + throw new Error('传输层响应协议版本不受支持') + } + if (String(envelope.alg || '') !== transportPolicy.responseEnvelopeAlgorithm) { + throw new Error('传输层响应算法不受支持') + } + if (String(envelope.kid || '') !== String(transportContext.kid)) { + throw new Error('传输层响应密钥版本不匹配') + } + if (responseKid && String(envelope.kid) !== String(responseKid)) { + throw new Error('传输层响应头与响应体密钥版本不一致') + } + if (!aad || typeof aad !== 'object' || Array.isArray(aad)) { + throw new Error('传输层响应AAD不合法') + } + if (String(aad.method || '').toUpperCase() !== expectedAad.method || String(aad.path || '') !== expectedAad.path) { + throw new Error('传输层响应的method/path与当前请求不匹配') + } + if (String(aad.direction || '') !== expectedAad.direction) { + throw new Error('传输层响应方向标识不合法') + } +} + +/** + * 记录原始请求快照,供密钥刷新重试时恢复。 + * + * @param {Object} config Axios 请求配置 + * @returns {void} + */ +function rememberOriginalRequestSnapshot(config) { + if (config.__transportOriginalSnapshot) { + return + } + config.__transportOriginalSnapshot = { + url: config.url, + params: cloneRequestValue(config.params), + data: cloneRequestValue(config.data), + contentType: getHeaderValue(config.headers, 'Content-Type') + } +} + +/** + * 获取当前 Unix 秒级时间戳。 + * + * @returns {number} 当前时间戳 + */ +function getNowTimestamp() { + return Math.floor(Date.now() / 1000) +} + +/** + * 根据公钥有效期计算本地提前刷新时间。 + * + * @param {number} expireAt 公钥失效时间 + * @param {number} fetchedAt 公钥获取时间 + * @returns {number} 建议刷新时间 + */ +function buildKeyRefreshAt(expireAt, fetchedAt = getNowTimestamp()) { + const normalizedExpireAt = Number(expireAt || 0) + const normalizedFetchedAt = Number(fetchedAt || 0) + const ttlSeconds = Math.max(normalizedExpireAt - normalizedFetchedAt, 0) + if (!normalizedExpireAt || !ttlSeconds) { + return 0 + } + const refreshBufferSeconds = Math.min( + KEY_REFRESH_BUFFER_MAX_SECONDS, + Math.max(KEY_REFRESH_BUFFER_MIN_SECONDS, Math.floor(ttlSeconds * 0.1)) + ) + return Math.max(normalizedFetchedAt, normalizedExpireAt - refreshBufferSeconds) +} + +/** + * 判断缓存中的公钥元数据是否仍可使用。 + * + * @param {Object} keyMeta 公钥元数据 + * @param {number} nowTimestamp 当前时间戳 + * @returns {boolean} 是否可继续使用 + */ +function isUsableKeyMeta(keyMeta, nowTimestamp = getNowTimestamp()) { + if (!keyMeta?.publicKeyPem || !keyMeta?.kid || !keyMeta?.expireAt) { + return false + } + const refreshAt = Number(keyMeta.refreshAt || buildKeyRefreshAt(keyMeta.expireAt, keyMeta.fetchedAt || nowTimestamp)) + return refreshAt > nowTimestamp +} + +/** + * 获取当前可用的后端公钥与密钥元信息。 + * + * @param {boolean} forceRefresh 是否强制刷新 + * @returns {Promise} 公钥元信息 + */ +async function getTransportKeyMeta(forceRefresh = false) { + const transportPolicy = await ensureTransportCryptoPolicyLoaded() + const nowTimestamp = getNowTimestamp() + if (!forceRefresh && !cachedKeyMeta) { + const persistedKeyMeta = cache.session.getJSON(TRANSPORT_KEY_META_CACHE_KEY) + if (isUsableKeyMeta(persistedKeyMeta, nowTimestamp)) { + const browserCrypto = getBrowserCrypto() + const cryptoKey = await browserCrypto.subtle.importKey( + 'spki', + pemToArrayBuffer(persistedKeyMeta.publicKeyPem), + { name: 'RSA-OAEP', hash: 'SHA-256' }, + false, + ['encrypt'] + ) + cachedKeyMeta = { + kid: persistedKeyMeta.kid, + alg: persistedKeyMeta.alg, + envelopeVersion: persistedKeyMeta.envelopeVersion || transportPolicy.envelopeVersion, + publicKey: cryptoKey, + publicKeyPem: persistedKeyMeta.publicKeyPem, + expireAt: persistedKeyMeta.expireAt, + fetchedAt: persistedKeyMeta.fetchedAt || nowTimestamp, + refreshAt: persistedKeyMeta.refreshAt || buildKeyRefreshAt(persistedKeyMeta.expireAt, persistedKeyMeta.fetchedAt || nowTimestamp) + } + } + } + if (!forceRefresh && isUsableKeyMeta(cachedKeyMeta, nowTimestamp)) { + return cachedKeyMeta + } + if (inflightKeyMetaPromise) { + return inflightKeyMetaPromise + } + inflightKeyMetaPromise = transportClient.get(transportPolicy.publicKeyUrl || '/transport/crypto/public-key').then(async response => { + const responsePayload = response.data || {} + const payload = responsePayload.data || {} + const fetchedAt = getNowTimestamp() + validateTransportPublicKeyResponse(responsePayload) + validateTransportPublicKeyPayload(payload, transportPolicy) + const browserCrypto = getBrowserCrypto() + const cryptoKey = await browserCrypto.subtle.importKey( + 'spki', + pemToArrayBuffer(payload.publicKey), + { name: 'RSA-OAEP', hash: 'SHA-256' }, + false, + ['encrypt'] + ) + cachedKeyMeta = { + kid: payload.kid, + alg: payload.alg, + envelopeVersion: String(payload.envelopeVersion || transportPolicy.envelopeVersion), + publicKey: cryptoKey, + publicKeyPem: payload.publicKey, + expireAt: payload.expireAt, + fetchedAt, + refreshAt: buildKeyRefreshAt(payload.expireAt, fetchedAt) + } + cache.session.setJSON(TRANSPORT_KEY_META_CACHE_KEY, { + kid: payload.kid, + alg: payload.alg, + envelopeVersion: String(payload.envelopeVersion || transportPolicy.envelopeVersion), + publicKeyPem: payload.publicKey, + expireAt: payload.expireAt, + fetchedAt, + refreshAt: buildKeyRefreshAt(payload.expireAt, fetchedAt) + }) + inflightKeyMetaPromise = null + return cachedKeyMeta + }).catch(error => { + inflightKeyMetaPromise = null + throw error + }) + return inflightKeyMetaPromise +} + +/** + * 为当前请求创建一次性的对称密钥上下文。 + * + * @returns {Promise} 请求级传输上下文 + */ +async function buildTransportContext() { + const browserCrypto = getBrowserCrypto() + const keyMeta = await getTransportKeyMeta() + const aesKey = await browserCrypto.subtle.generateKey({ name: 'AES-GCM', length: 256 }, true, ['encrypt', 'decrypt']) + const rawAesKey = new Uint8Array(await browserCrypto.subtle.exportKey('raw', aesKey)) + const encryptedAesKey = new Uint8Array( + await browserCrypto.subtle.encrypt({ name: 'RSA-OAEP' }, keyMeta.publicKey, rawAesKey) + ) + return { + kid: keyMeta.kid, + alg: keyMeta.alg, + envelopeVersion: keyMeta.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION, + aesKey, + ek: toBase64Url(encryptedAesKey) + } +} + +/** + * 使用 AES-GCM 对明文载荷执行信封加密。 + * + * @param {Object} context 请求级传输上下文 + * @param {string} plainText 明文内容 + * @param {Object} aad AAD 元数据 + * @returns {Promise} 加密信封 + */ +async function encryptPayloadText(context, plainText, aad) { + const browserCrypto = getBrowserCrypto() + const iv = browserCrypto.getRandomValues(new Uint8Array(12)) + const ciphertext = new Uint8Array( + await browserCrypto.subtle.encrypt( + { name: 'AES-GCM', iv, additionalData: new TextEncoder().encode(JSON.stringify(aad)) }, + context.aesKey, + new TextEncoder().encode(plainText) + ) + ) + return { + v: context.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION, + kid: context.kid, + alg: context.alg, + ts: Math.floor(Date.now() / 1000), + nonce: browserCrypto.randomUUID(), + ek: context.ek, + aad, + iv: toBase64Url(iv), + ct: toBase64Url(ciphertext) + } +} + +/** + * 使用请求上下文中的 AES 密钥解密响应信封。 + * + * @param {Object} envelope 响应信封 + * @param {Object} context 请求级传输上下文 + * @returns {Promise} 解密后的明文 + */ +async function decryptEnvelope(envelope, context) { + const browserCrypto = getBrowserCrypto() + const decryptedBytes = await browserCrypto.subtle.decrypt( + { + name: 'AES-GCM', + iv: fromBase64Url(envelope.iv), + additionalData: new TextEncoder().encode(JSON.stringify(envelope.aad || {})) + }, + context.aesKey, + fromBase64Url(envelope.ct) + ) + return new TextDecoder().decode(decryptedBytes) +} + +/** + * 复用同一次请求内的传输上下文,避免重复生成密钥。 + * + * @param {Object} config Axios 请求配置 + * @returns {Promise} 请求级传输上下文 + */ +function getOrCreateTransportContext(config) { + if (config.__transportCryptoContextPromise) { + return config.__transportCryptoContextPromise + } + config.__transportCryptoContextPromise = buildTransportContext() + return config.__transportCryptoContextPromise +} + +/** + * 对 Axios 请求配置执行传输层加密封装。 + * + * @param {Object} config Axios 请求配置 + * @returns {Promise} 加密后的请求配置 + */ +export async function encryptTransportRequest(config) { + const transportPolicy = await ensureTransportCryptoPolicyLoaded() + if (!shouldEncryptRequest(config, transportPolicy)) { + config.__transportCryptoEnabledForRequest = false + return config + } + + rememberOriginalRequestSnapshot(config) + const transportContext = await getOrCreateTransportContext(config) + const contentType = (getHeaderValue(config.headers, 'Content-Type') || 'application/json').toLowerCase() + const method = (config.method || 'get').toLowerCase() + const requestAad = buildRequestAad(config) + + if (shouldEncryptQuery(config, transportPolicy) && (config.params || method === 'get' || method === 'delete')) { + const queryEnvelope = await encryptPayloadText( + transportContext, + JSON.stringify(normalizePlainPayload(config.params)), + requestAad + ) + config.params = { __enc: encodeQueryEnvelope(queryEnvelope) } + if (buildQueryUrlLength(config.url, config.params) > Number(transportPolicy.maxEncryptedGetUrlLength || 4096)) { + throw new Error('当前GET/DELETE请求参数加密后长度超限,请改用POST请求或精简查询条件') + } + } + + if (method === 'post' || method === 'put' || method === 'patch' || method === 'delete') { + const plainText = stringifyPayload(config.data) + const bodyEnvelope = await encryptPayloadText(transportContext, plainText, requestAad) + if (contentType.includes('application/x-www-form-urlencoded')) { + config.data = encodeFormEnvelope(bodyEnvelope) + } else { + config.data = bodyEnvelope + setHeaderValue(config.headers, 'Content-Type', 'application/json;charset=utf-8') + } + } + + setHeaderValue(config.headers, TRANSPORT_ENABLE_HEADER, '1') + setHeaderValue(config.headers, TRANSPORT_KEY_ID_HEADER, transportContext.kid) + config.__transportCryptoContext = transportContext + config.__transportCryptoEnabledForRequest = true + return config +} + +/** + * 清空当前缓存的公钥元数据。 + * + * @returns {void} + */ +export function invalidateTransportKeyMeta() { + cachedKeyMeta = null + inflightKeyMetaPromise = null + cache.session.remove(TRANSPORT_KEY_META_CACHE_KEY) +} + +/** + * 将被加密改写过的请求恢复为原始形态。 + * + * @param {Object} config Axios 请求配置 + * @returns {Object} 恢复后的请求配置 + */ +export function resetTransportRequestConfig(config) { + const originalSnapshot = config?.__transportOriginalSnapshot + if (!config || !originalSnapshot) { + return config + } + + config.url = originalSnapshot.url + config.params = cloneRequestValue(originalSnapshot.params) + config.data = cloneRequestValue(originalSnapshot.data) + if (originalSnapshot.contentType) { + setHeaderValue(config.headers, 'Content-Type', originalSnapshot.contentType) + } + delete config.__transportCryptoContext + delete config.__transportCryptoContextPromise + delete config.__transportCryptoEnabledForRequest + return config +} + +/** + * 判断错误是否属于可通过刷新公钥重试的场景。 + * + * @param {Object} error 错误对象 + * @returns {boolean} 是否可刷新密钥重试 + */ +export function shouldRetryTransportWithFreshKey(error) { + const responseMsg = error?.response?.data?.msg + const errorMessage = error?.message + return TRANSPORT_RETRYABLE_ERROR_MESSAGES.has(responseMsg) || TRANSPORT_RETRYABLE_ERROR_MESSAGES.has(errorMessage) +} + +/** + * 解密成功响应中的传输层信封。 + * + * @param {Object} response Axios 响应对象 + * @returns {Promise} 解密后的响应对象 + */ +export async function decryptTransportResponse(response) { + if (getHeaderValue(response.headers, ENCRYPTED_RESPONSE_HEADER) !== '1') { + return response + } + if (!shouldEncryptResponse(response.config, getTransportCryptoPolicy())) { + return response + } + const transportPolicy = getTransportCryptoPolicy() + const transportContext = response.config.__transportCryptoContext + if (!transportContext) { + throw new Error('缺少响应解密上下文') + } + + const envelope = parseJsonObject(response.data, '传输层响应信封格式不合法') + validateResponseEnvelope(envelope, response, transportContext, transportPolicy) + const plaintext = await decryptEnvelope(envelope, transportContext) + response.data = JSON.parse(plaintext) + return response +} + +/** + * 尝试解密异常响应中的传输层信封。 + * + * @param {Object} error Axios 错误对象 + * @returns {Promise} 原始或已解密的错误对象 + */ +export async function decryptTransportErrorResponse(error) { + const response = error?.response + if (!response || getHeaderValue(response.headers, ENCRYPTED_RESPONSE_HEADER) !== '1') { + return error + } + if (!shouldEncryptResponse(response.config || {}, getTransportCryptoPolicy())) { + return error + } + const transportPolicy = getTransportCryptoPolicy() + const transportContext = response.config?.__transportCryptoContext + if (!transportContext) { + return error + } + + try { + const envelope = parseJsonObject(response.data, '传输层响应信封格式不合法') + validateResponseEnvelope(envelope, response, transportContext, transportPolicy) + const plaintext = await decryptEnvelope(envelope, transportContext) + response.data = JSON.parse(plaintext) + } catch (decryptError) { + console.error(decryptError) + } + return error +} diff --git a/shierfeng-fastapi-frontend/src/utils/transportCryptoPolicy.js b/shierfeng-fastapi-frontend/src/utils/transportCryptoPolicy.js new file mode 100644 index 0000000..b0b3783 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/transportCryptoPolicy.js @@ -0,0 +1,368 @@ +import axios from 'axios' + +import cache from '@/plugins/cache' + +const TRANSPORT_BASE_URL = import.meta.env.VITE_APP_BASE_API +const EXCLUDED_URL_PATTERNS = [ + '/transport/crypto/frontend-config', + '/transport/crypto/public-key', + '/common/download', + '/common/download/resource' +] +const TRANSPORT_FRONTEND_CONFIG_CACHE_KEY = 'transportCryptoFrontendConfig' +const TRANSPORT_FRONTEND_CONFIG_URL = '/transport/crypto/frontend-config' +const TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS = 60 +const DEFAULT_TRANSPORT_ENVELOPE_VERSION = '1' +const DEFAULT_REQUEST_ENVELOPE_ALGORITHM = 'RSA_OAEP_AES_256_GCM' +const DEFAULT_RESPONSE_ENVELOPE_ALGORITHM = 'AES_256_GCM' +const DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH = 4096 + +const transportPolicyClient = axios.create({ + baseURL: TRANSPORT_BASE_URL, + timeout: 10000 +}) + +let cachedTransportPolicy = null +let inflightTransportPolicyPromise = null + +/** + * 获取当前 Unix 秒级时间戳。 + * + * @returns {number} 当前时间戳 + */ +function getNowTimestamp() { + return Math.floor(Date.now() / 1000) +} + +/** + * 判断请求地址是否命中固定排除名单。 + * + * @param {string} url 请求地址 + * @returns {boolean} 是否命中排除规则 + */ +function matchExcludedUrl(url = '') { + return EXCLUDED_URL_PATTERNS.some(pattern => url.includes(pattern)) +} + +/** + * 判断路径是否匹配指定前缀集合。 + * + * @param {string} path 待匹配路径 + * @param {string[]} pathPatterns 路径前缀集合 + * @returns {boolean} 是否匹配成功 + */ +function matchPathPrefix(path = '', pathPatterns = []) { + return pathPatterns.some(pattern => path === pattern || path.startsWith(`${pattern}/`)) +} + +/** + * 读取请求头中的指定字段,兼容原生对象与 Headers 实例。 + * + * @param {Object|Headers} headers 请求头对象 + * @param {string} name 请求头名称 + * @returns {*} 请求头值 + */ +function getHeaderValue(headers, name) { + if (!headers) { + return undefined + } + if (typeof headers.get === 'function') { + return headers.get(name) + } + return headers[name] ?? headers[name.toLowerCase()] +} + +/** + * 解析基础 API 地址对应的路径前缀。 + * + * @returns {string} 基础路径前缀 + */ +function getBaseApiPath() { + if (!TRANSPORT_BASE_URL) { + return '' + } + if (TRANSPORT_BASE_URL.startsWith('http://') || TRANSPORT_BASE_URL.startsWith('https://')) { + const baseApiPath = new URL(TRANSPORT_BASE_URL).pathname + return baseApiPath === '/' ? '' : baseApiPath + } + return TRANSPORT_BASE_URL +} + +/** + * 计算用于策略匹配的标准请求路径。 + * + * @param {string} url 请求地址 + * @returns {string} 标准化请求路径 + */ +function getRequestPath(url = '') { + const baseApiPath = getBaseApiPath() + const normalizedUrl = String(url || '') + + let pathname = normalizedUrl + if (normalizedUrl.startsWith('http://') || normalizedUrl.startsWith('https://')) { + pathname = new URL(normalizedUrl).pathname + } else { + pathname = normalizedUrl.split('?')[0] || '/' + } + + if (baseApiPath && pathname.startsWith(baseApiPath)) { + const normalizedPath = pathname.slice(baseApiPath.length) + return normalizedPath || '/' + } + return pathname || '/' +} + +/** + * 标准化后端下发的路径数组。 + * + * @param {Array} paths 原始路径集合 + * @returns {string[]} 标准化后的路径列表 + */ +function normalizePaths(paths) { + if (!Array.isArray(paths)) { + return [] + } + return paths.map(path => String(path || '').trim()).filter(Boolean) +} + +/** + * 将后端配置响应转换为前端统一的策略对象。 + * + * @param {Object} payload 后端返回配置 + * @returns {Object} 标准化后的策略对象 + */ +function normalizeTransportPolicy(payload) { + return { + transportCryptoEnabled: Boolean(payload?.transportCryptoEnabled), + transportCryptoMode: String(payload?.transportCryptoMode || 'off'), + transportCryptoActive: Boolean(payload?.transportCryptoActive), + envelopeVersion: String(payload?.envelopeVersion || DEFAULT_TRANSPORT_ENVELOPE_VERSION), + publicKeyUrl: String(payload?.publicKeyUrl || '/transport/crypto/public-key'), + requestEnvelopeAlgorithm: String(payload?.requestEnvelopeAlgorithm || DEFAULT_REQUEST_ENVELOPE_ALGORITHM), + responseEnvelopeAlgorithm: String(payload?.responseEnvelopeAlgorithm || DEFAULT_RESPONSE_ENVELOPE_ALGORITHM), + enabledPaths: normalizePaths(payload?.enabledPaths), + requiredPaths: normalizePaths(payload?.requiredPaths), + excludePaths: normalizePaths(payload?.excludePaths), + maxEncryptedGetUrlLength: Number(payload?.maxEncryptedGetUrlLength || DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH), + configExpireAt: Number(payload?.configExpireAt || 0), + retryAt: Number(payload?.retryAt || payload?.configExpireAt || 0) + } +} + +/** + * 构建无法获取后端配置时的本地兜底策略。 + * + * @returns {Object} 明文回退策略 + */ +function buildFallbackTransportPolicy() { + const nowTimestamp = getNowTimestamp() + return { + transportCryptoEnabled: false, + transportCryptoMode: 'off', + transportCryptoActive: false, + envelopeVersion: DEFAULT_TRANSPORT_ENVELOPE_VERSION, + publicKeyUrl: '/transport/crypto/public-key', + requestEnvelopeAlgorithm: DEFAULT_REQUEST_ENVELOPE_ALGORITHM, + responseEnvelopeAlgorithm: DEFAULT_RESPONSE_ENVELOPE_ALGORITHM, + enabledPaths: [], + requiredPaths: [], + excludePaths: [...EXCLUDED_URL_PATTERNS], + maxEncryptedGetUrlLength: DEFAULT_TRANSPORT_MAX_GET_URL_LENGTH, + configExpireAt: nowTimestamp + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS, + retryAt: nowTimestamp + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS + } +} + +/** + * 基于旧策略构建短期可重试策略。 + * + * @param {Object} policy 旧的策略对象 + * @returns {Object} 可重试策略 + */ +function buildRetryableTransportPolicy(policy) { + const normalizedPolicy = normalizeTransportPolicy(policy) + const retryAt = getNowTimestamp() + TRANSPORT_FRONTEND_CONFIG_FALLBACK_TTL_SECONDS + return { + ...normalizedPolicy, + retryAt + } +} + +/** + * 判断策略是否仍处于可用期内。 + * + * @param {Object} policy 待校验策略 + * @returns {boolean} 是否可用 + */ +function isUsableTransportPolicy(policy) { + if (!policy) { + return false + } + if (!policy.publicKeyUrl) { + return false + } + if (!policy.retryAt) { + return false + } + return policy.retryAt > getNowTimestamp() +} + +/** + * 从会话缓存读取最近一次持久化策略。 + * + * @returns {Object|null} 缓存策略 + */ +function loadPersistedTransportPolicy() { + const persistedTransportPolicy = cache.session.getJSON(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY) + if (!persistedTransportPolicy) { + return null + } + return normalizeTransportPolicy(persistedTransportPolicy) +} + +/** + * 获取当前生效的传输加密策略。 + * + * @returns {Object} 当前策略对象 + */ +export function getTransportCryptoPolicy() { + return cachedTransportPolicy || buildFallbackTransportPolicy() +} + +/** + * 清空当前策略缓存与会话缓存。 + * + * @returns {void} + */ +export function invalidateTransportCryptoPolicy() { + cachedTransportPolicy = null + inflightTransportPolicyPromise = null + cache.session.remove(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY) +} + +/** + * 确保本地已加载一份可用的传输加密策略。 + * + * @param {boolean} forceRefresh 是否强制刷新策略 + * @returns {Promise} 当前可用策略 + */ +export async function ensureTransportCryptoPolicyLoaded(forceRefresh = false) { + if (!forceRefresh && !cachedTransportPolicy) { + const persistedTransportPolicy = loadPersistedTransportPolicy() + if (isUsableTransportPolicy(persistedTransportPolicy)) { + cachedTransportPolicy = persistedTransportPolicy + } + } + + if (!forceRefresh && isUsableTransportPolicy(cachedTransportPolicy)) { + return cachedTransportPolicy + } + + if (inflightTransportPolicyPromise) { + return inflightTransportPolicyPromise + } + + inflightTransportPolicyPromise = transportPolicyClient.get(TRANSPORT_FRONTEND_CONFIG_URL).then(response => { + const payload = normalizeTransportPolicy(response?.data?.data || {}) + cachedTransportPolicy = payload + cache.session.setJSON(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY, payload) + inflightTransportPolicyPromise = null + return cachedTransportPolicy + }).catch(error => { + const staleTransportPolicy = cachedTransportPolicy || loadPersistedTransportPolicy() + inflightTransportPolicyPromise = null + cachedTransportPolicy = staleTransportPolicy + ? buildRetryableTransportPolicy(staleTransportPolicy) + : buildFallbackTransportPolicy() + cache.session.setJSON(TRANSPORT_FRONTEND_CONFIG_CACHE_KEY, cachedTransportPolicy) + if (staleTransportPolicy) { + console.warn('加载传输加密前端配置失败,当前继续沿用最近一次后端策略', error) + } else { + console.warn('加载传输加密前端配置失败,当前回退为明文请求策略', error) + } + return cachedTransportPolicy + }) + + return inflightTransportPolicyPromise +} + +/** + * 判断当前请求是否需要执行请求加密。 + * + * @param {Object} config 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否需要加密 + */ +export function shouldEncryptRequest(config, transportPolicy = getTransportCryptoPolicy()) { + if (!transportPolicy.transportCryptoActive) { + return false + } + const requestPath = getRequestPath(config.url) + if (matchPathPrefix(requestPath, transportPolicy.excludePaths || [])) { + return false + } + if ((transportPolicy.enabledPaths || []).length && !matchPathPrefix(requestPath, transportPolicy.enabledPaths || [])) { + return false + } + if ((config.headers || {}).encrypt === false) { + return false + } + if (matchExcludedUrl(config.url)) { + return false + } + if (config.responseType === 'blob' || config.responseType === 'arraybuffer') { + return false + } + const contentType = getHeaderValue(config.headers, 'Content-Type') || '' + if (contentType.includes('multipart/form-data')) { + return false + } + return true +} + +/** + * 判断当前响应是否需要执行自动解密。 + * + * @param {Object} config 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否需要解密 + */ +export function shouldEncryptResponse(config, transportPolicy = getTransportCryptoPolicy()) { + const requestPath = getRequestPath(config.url) + if (matchPathPrefix(requestPath, transportPolicy.excludePaths || [])) { + return false + } + if ((transportPolicy.enabledPaths || []).length && !matchPathPrefix(requestPath, transportPolicy.enabledPaths || [])) { + return false + } + if ((config.headers || {}).encryptResponse === false) { + return false + } + if (matchExcludedUrl(config.url)) { + return false + } + if (config.responseType === 'blob' || config.responseType === 'arraybuffer') { + return false + } + if (config.__transportCryptoEnabledForRequest === true) { + return true + } + if (config.__transportCryptoEnabledForRequest === false) { + return false + } + return transportPolicy.transportCryptoActive +} + +/** + * 判断查询参数是否需要走加密信封流程。 + * + * @param {Object} config 请求配置 + * @param {Object} transportPolicy 传输加密策略 + * @returns {boolean} 是否启用查询参数加密 + */ +export function shouldEncryptQuery(config, transportPolicy = getTransportCryptoPolicy()) { + if ((config.headers || {}).encryptQuery === false) { + return false + } + return shouldEncryptRequest(config, transportPolicy) +} diff --git a/shierfeng-fastapi-frontend/src/utils/validate.js b/shierfeng-fastapi-frontend/src/utils/validate.js new file mode 100644 index 0000000..6a4c0c5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/utils/validate.js @@ -0,0 +1,114 @@ +/** + * 路径匹配器 + * @param {string} pattern + * @param {string} path + * @returns {Boolean} + */ +export function isPathMatch(pattern, path) { + const regexPattern = pattern.replace(/\//g, '\\/').replace(/\*\*/g, '.*').replace(/\*/g, '[^\\/]*') + const regex = new RegExp(`^${regexPattern}$`) + return regex.test(path) +} + +/** + * 判断value字符串是否为空 + * @param {string} value + * @returns {Boolean} + */ +export function isEmpty(value) { + if (value == null || value == "" || value == undefined || value == "undefined") { + return true + } + return false +} + +/** + * 判断url是否是http或https + * @param {string} url + * @returns {Boolean} + */ +export function isHttp(url) { + return url.indexOf('http://') !== -1 || url.indexOf('https://') !== -1 +} + +/** + * 判断path是否为外链 + * @param {string} path + * @returns {Boolean} + */ +export function isExternal(path) { + return /^(https?:|mailto:|tel:)/.test(path) +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validUsername(str) { + const valid_map = ['admin', 'editor'] + return valid_map.indexOf(str.trim()) >= 0 +} + +/** + * @param {string} url + * @returns {Boolean} + */ +export function validURL(url) { + const reg = /^(https?|ftp):\/\/([a-zA-Z0-9.-]+(:[a-zA-Z0-9.&%$-]+)*@)*((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|([a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]+\.(com|edu|gov|int|mil|net|org|biz|arpa|info|name|pro|aero|coop|museum|[a-zA-Z]{2}))(:[0-9]+)*(\/($|[a-zA-Z0-9.,?'\\+&%$#=~_-]+))*$/ + return reg.test(url) +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validLowerCase(str) { + const reg = /^[a-z]+$/ + return reg.test(str) +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validUpperCase(str) { + const reg = /^[A-Z]+$/ + return reg.test(str) +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function validAlphabets(str) { + const reg = /^[A-Za-z]+$/ + return reg.test(str) +} + +/** + * @param {string} email + * @returns {Boolean} + */ +export function validEmail(email) { + const reg = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/ + return reg.test(email) +} + +/** + * @param {string} str + * @returns {Boolean} + */ +export function isString(str) { + return typeof str === 'string' || str instanceof String +} + +/** + * @param {Array} arg + * @returns {Boolean} + */ +export function isArray(arg) { + if (typeof Array.isArray === 'undefined') { + return Object.prototype.toString.call(arg) === '[object Array]' + } + return Array.isArray(arg) +} diff --git a/shierfeng-fastapi-frontend/src/views/ai/chat/components/AiMessage.vue b/shierfeng-fastapi-frontend/src/views/ai/chat/components/AiMessage.vue new file mode 100644 index 0000000..b233d3b --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/ai/chat/components/AiMessage.vue @@ -0,0 +1,170 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/ai/chat/index.vue b/shierfeng-fastapi-frontend/src/views/ai/chat/index.vue new file mode 100644 index 0000000..7b44d26 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/ai/chat/index.vue @@ -0,0 +1,1338 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/ai/model/index.vue b/shierfeng-fastapi-frontend/src/views/ai/model/index.vue new file mode 100644 index 0000000..641fbfa --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/ai/model/index.vue @@ -0,0 +1,473 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/dashboard/editable-link-group.vue b/shierfeng-fastapi-frontend/src/views/dashboard/editable-link-group.vue new file mode 100644 index 0000000..2f116fb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/dashboard/editable-link-group.vue @@ -0,0 +1,68 @@ + + + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/dashboard/index.vue b/shierfeng-fastapi-frontend/src/views/dashboard/index.vue new file mode 100644 index 0000000..f6f4473 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/dashboard/index.vue @@ -0,0 +1,752 @@ + + + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/error/401.vue b/shierfeng-fastapi-frontend/src/views/error/401.vue new file mode 100644 index 0000000..1ba3792 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/error/401.vue @@ -0,0 +1,82 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/error/404.vue b/shierfeng-fastapi-frontend/src/views/error/404.vue new file mode 100644 index 0000000..f205303 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/error/404.vue @@ -0,0 +1,227 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/login.vue b/shierfeng-fastapi-frontend/src/views/login.vue new file mode 100644 index 0000000..52b0406 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/login.vue @@ -0,0 +1,244 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/cache/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/cache/index.vue new file mode 100644 index 0000000..8926445 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/cache/index.vue @@ -0,0 +1,132 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/cache/list.vue b/shierfeng-fastapi-frontend/src/views/monitor/cache/list.vue new file mode 100644 index 0000000..1696f3a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/cache/list.vue @@ -0,0 +1,246 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/druid/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/druid/index.vue new file mode 100644 index 0000000..91b7e38 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/druid/index.vue @@ -0,0 +1,14 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/job/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/job/index.vue new file mode 100644 index 0000000..c7c67fd --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/job/index.vue @@ -0,0 +1,530 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/job/log.vue b/shierfeng-fastapi-frontend/src/views/monitor/job/log.vue new file mode 100644 index 0000000..757e2db --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/job/log.vue @@ -0,0 +1,295 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/logininfor/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/logininfor/index.vue new file mode 100644 index 0000000..7480b5e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/logininfor/index.vue @@ -0,0 +1,225 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/online/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/online/index.vue new file mode 100644 index 0000000..eb17ebc --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/online/index.vue @@ -0,0 +1,106 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/operlog/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/operlog/index.vue new file mode 100644 index 0000000..0d55881 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/operlog/index.vue @@ -0,0 +1,301 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/server/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/server/index.vue new file mode 100644 index 0000000..ad9d42d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/server/index.vue @@ -0,0 +1,183 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/monitor/transportCrypto/index.vue b/shierfeng-fastapi-frontend/src/views/monitor/transportCrypto/index.vue new file mode 100644 index 0000000..c4e88a4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/monitor/transportCrypto/index.vue @@ -0,0 +1,1034 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/redirect/index.vue b/shierfeng-fastapi-frontend/src/views/redirect/index.vue new file mode 100644 index 0000000..a469960 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/redirect/index.vue @@ -0,0 +1,14 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/register.vue b/shierfeng-fastapi-frontend/src/views/register.vue new file mode 100644 index 0000000..455f6c3 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/register.vue @@ -0,0 +1,222 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/config/index.vue b/shierfeng-fastapi-frontend/src/views/system/config/index.vue new file mode 100644 index 0000000..f904e08 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/config/index.vue @@ -0,0 +1,310 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/dept/index.vue b/shierfeng-fastapi-frontend/src/views/system/dept/index.vue new file mode 100644 index 0000000..7a65d6d --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/dept/index.vue @@ -0,0 +1,274 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/dict/data.vue b/shierfeng-fastapi-frontend/src/views/system/dict/data.vue new file mode 100644 index 0000000..0d8a99a --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/dict/data.vue @@ -0,0 +1,350 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/dict/index.vue b/shierfeng-fastapi-frontend/src/views/system/dict/index.vue new file mode 100644 index 0000000..8c600f5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/dict/index.vue @@ -0,0 +1,312 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/menu/index.vue b/shierfeng-fastapi-frontend/src/views/system/menu/index.vue new file mode 100644 index 0000000..b0eb1fe --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/menu/index.vue @@ -0,0 +1,441 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/notice/index.vue b/shierfeng-fastapi-frontend/src/views/system/notice/index.vue new file mode 100644 index 0000000..dd6364e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/notice/index.vue @@ -0,0 +1,283 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/post/index.vue b/shierfeng-fastapi-frontend/src/views/system/post/index.vue new file mode 100644 index 0000000..53db828 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/post/index.vue @@ -0,0 +1,277 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/role/authUser.vue b/shierfeng-fastapi-frontend/src/views/system/role/authUser.vue new file mode 100644 index 0000000..66b5f5e --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/role/authUser.vue @@ -0,0 +1,172 @@ + + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/role/index.vue b/shierfeng-fastapi-frontend/src/views/system/role/index.vue new file mode 100644 index 0000000..99808ca --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/role/index.vue @@ -0,0 +1,559 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/role/selectUser.vue b/shierfeng-fastapi-frontend/src/views/system/role/selectUser.vue new file mode 100644 index 0000000..9269f5c --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/role/selectUser.vue @@ -0,0 +1,138 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/user/authRole.vue b/shierfeng-fastapi-frontend/src/views/system/user/authRole.vue new file mode 100644 index 0000000..93516b4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/authRole.vue @@ -0,0 +1,123 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/user/index.vue b/shierfeng-fastapi-frontend/src/views/system/user/index.vue new file mode 100644 index 0000000..d35dbdf --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/index.vue @@ -0,0 +1,901 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/user/profile/index.vue b/shierfeng-fastapi-frontend/src/views/system/user/profile/index.vue new file mode 100644 index 0000000..26f4bd4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/profile/index.vue @@ -0,0 +1,94 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/user/profile/resetPwd.vue b/shierfeng-fastapi-frontend/src/views/system/user/profile/resetPwd.vue new file mode 100644 index 0000000..96daef3 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/profile/resetPwd.vue @@ -0,0 +1,57 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/system/user/profile/userAvatar.vue b/shierfeng-fastapi-frontend/src/views/system/user/profile/userAvatar.vue new file mode 100644 index 0000000..3b39636 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/profile/userAvatar.vue @@ -0,0 +1,171 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/system/user/profile/userInfo.vue b/shierfeng-fastapi-frontend/src/views/system/user/profile/userInfo.vue new file mode 100644 index 0000000..2737fe1 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/system/user/profile/userInfo.vue @@ -0,0 +1,67 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/CodeTypeDialog.vue b/shierfeng-fastapi-frontend/src/views/tool/build/CodeTypeDialog.vue new file mode 100755 index 0000000..de0beb7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/CodeTypeDialog.vue @@ -0,0 +1,71 @@ + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/DraggableItem.vue b/shierfeng-fastapi-frontend/src/views/tool/build/DraggableItem.vue new file mode 100755 index 0000000..927aafb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/DraggableItem.vue @@ -0,0 +1,68 @@ + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/IconsDialog.vue b/shierfeng-fastapi-frontend/src/views/tool/build/IconsDialog.vue new file mode 100755 index 0000000..98d9c13 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/IconsDialog.vue @@ -0,0 +1,115 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/RightPanel.vue b/shierfeng-fastapi-frontend/src/views/tool/build/RightPanel.vue new file mode 100755 index 0000000..5fe80fb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/RightPanel.vue @@ -0,0 +1,906 @@ + + + + + \ No newline at end of file diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/TreeNodeDialog.vue b/shierfeng-fastapi-frontend/src/views/tool/build/TreeNodeDialog.vue new file mode 100755 index 0000000..372d3af --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/TreeNodeDialog.vue @@ -0,0 +1,93 @@ + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/build/index.vue b/shierfeng-fastapi-frontend/src/views/tool/build/index.vue new file mode 100755 index 0000000..64a9317 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/build/index.vue @@ -0,0 +1,660 @@ + + + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/basicInfoForm.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/basicInfoForm.vue new file mode 100644 index 0000000..39c8515 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/basicInfoForm.vue @@ -0,0 +1,48 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/createTable.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/createTable.vue new file mode 100644 index 0000000..00fdfdb --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/createTable.vue @@ -0,0 +1,46 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/editTable.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/editTable.vue new file mode 100644 index 0000000..06e4ba5 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/editTable.vue @@ -0,0 +1,220 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/genInfoForm.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/genInfoForm.vue new file mode 100644 index 0000000..c0ba7f7 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/genInfoForm.vue @@ -0,0 +1,306 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/importTable.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/importTable.vue new file mode 100644 index 0000000..d0115c4 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/importTable.vue @@ -0,0 +1,126 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/gen/index.vue b/shierfeng-fastapi-frontend/src/views/tool/gen/index.vue new file mode 100644 index 0000000..395c834 --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/gen/index.vue @@ -0,0 +1,313 @@ + + + diff --git a/shierfeng-fastapi-frontend/src/views/tool/swagger/index.vue b/shierfeng-fastapi-frontend/src/views/tool/swagger/index.vue new file mode 100644 index 0000000..d744aff --- /dev/null +++ b/shierfeng-fastapi-frontend/src/views/tool/swagger/index.vue @@ -0,0 +1,9 @@ + + + diff --git a/shierfeng-fastapi-frontend/vite.config.js b/shierfeng-fastapi-frontend/vite.config.js new file mode 100644 index 0000000..10ef100 --- /dev/null +++ b/shierfeng-fastapi-frontend/vite.config.js @@ -0,0 +1,73 @@ +import { defineConfig, loadEnv } from 'vite' +import path from 'path' +import createVitePlugins from './vite/plugins' + +// https://vitejs.dev/config/ +export default defineConfig(({ mode, command }) => { + const env = loadEnv(mode, process.cwd()) + const { VITE_APP_ENV } = env + return { + // 部署生产环境和开发环境下的URL。 + // 默认情况下,vite 会假设你的应用是被部署在一个域名的根路径上 + // 如果应用被部署在一个子路径上,需要用此选项指定子路径。例如部署在 https://example.com/admin/ 时,将 baseUrl 设置为 /admin/。 + base: VITE_APP_ENV === 'production' ? '/' : '/', + plugins: createVitePlugins(env, command === 'build'), + resolve: { + // https://cn.vitejs.dev/config/#resolve-alias + alias: { + // 设置路径 + '~': path.resolve(__dirname, './'), + // 设置别名 + '@': path.resolve(__dirname, './src') + }, + // https://cn.vitejs.dev/config/#resolve-extensions + extensions: ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json', '.vue'] + }, + // 打包配置 + build: { + // https://vite.dev/config/build-options.html + sourcemap: command === 'build' ? false : 'inline', + outDir: 'dist', + assetsDir: 'assets', + chunkSizeWarningLimit: 2000, + rollupOptions: { + output: { + chunkFileNames: 'static/js/[name]-[hash].js', + entryFileNames: 'static/js/[name]-[hash].js', + assetFileNames: 'static/[ext]/[name]-[hash].[ext]' + } + } + }, + // vite 相关配置 + server: { + port: 80, + host: true, + open: true, + proxy: { + // https://cn.vitejs.dev/config/#server-proxy + '/dev-api': { + target: 'http://127.0.0.1:9099', + changeOrigin: true, + rewrite: (p) => p.replace(/^\/dev-api/, '') + } + } + }, + //fix:error:stdin>:7356:1: warning: "@charset" must be the first rule in the file + css: { + postcss: { + plugins: [ + { + postcssPlugin: 'internal:charset-removal', + AtRule: { + charset: (atRule) => { + if (atRule.name === 'charset') { + atRule.remove(); + } + } + } + } + ] + } + } + } +}) diff --git a/shierfeng-fastapi-frontend/vite/plugins/auto-import.js b/shierfeng-fastapi-frontend/vite/plugins/auto-import.js new file mode 100644 index 0000000..a5d3576 --- /dev/null +++ b/shierfeng-fastapi-frontend/vite/plugins/auto-import.js @@ -0,0 +1,12 @@ +import autoImport from 'unplugin-auto-import/vite' + +export default function createAutoImport() { + return autoImport({ + imports: [ + 'vue', + 'vue-router', + 'pinia' + ], + dts: false + }) +} diff --git a/shierfeng-fastapi-frontend/vite/plugins/compression.js b/shierfeng-fastapi-frontend/vite/plugins/compression.js new file mode 100644 index 0000000..f473c57 --- /dev/null +++ b/shierfeng-fastapi-frontend/vite/plugins/compression.js @@ -0,0 +1,28 @@ +import compression from 'vite-plugin-compression' + +export default function createCompression(env) { + const { VITE_BUILD_COMPRESS } = env + const plugin = [] + if (VITE_BUILD_COMPRESS) { + const compressList = VITE_BUILD_COMPRESS.split(',') + if (compressList.includes('gzip')) { + // 开启 gzip 后,部署环境需同步启用静态文件解压支持。 + plugin.push( + compression({ + ext: '.gz', + deleteOriginFile: false + }) + ) + } + if (compressList.includes('brotli')) { + plugin.push( + compression({ + ext: '.br', + algorithm: 'brotliCompress', + deleteOriginFile: false + }) + ) + } + } + return plugin +} diff --git a/shierfeng-fastapi-frontend/vite/plugins/index.js b/shierfeng-fastapi-frontend/vite/plugins/index.js new file mode 100644 index 0000000..eb9e9dd --- /dev/null +++ b/shierfeng-fastapi-frontend/vite/plugins/index.js @@ -0,0 +1,43 @@ +import vue from '@vitejs/plugin-vue' +import monacoEditorEsmPlugin from 'vite-plugin-monaco-editor-esm' + +import createAutoImport from './auto-import' +import createSvgIcon from './svg-icon' +import createCompression from './compression' +import createSetupExtend from './setup-extend' + +const monacoWorkers = [ + { + label: 'editorWorkerService', + entry: 'monaco-editor/esm/vs/editor/editor.worker.js' + }, + { + label: 'css', + entry: 'monaco-editor/esm/vs/language/css/css.worker.js' + }, + { + label: 'html', + entry: 'monaco-editor/esm/vs/language/html/html.worker.js' + }, + { + label: 'json', + entry: 'monaco-editor/esm/vs/language/json/json.worker.js' + }, + { + label: 'typescript', + entry: 'monaco-editor/esm/vs/language/typescript/ts.worker.js' + } +] + +export default function createVitePlugins(viteEnv, isBuild = false) { + const vitePlugins = [vue()] + vitePlugins.push(createAutoImport()) + vitePlugins.push(createSetupExtend()) + vitePlugins.push(monacoEditorEsmPlugin({ + languageWorkers: [], + customWorkers: monacoWorkers + })) + vitePlugins.push(createSvgIcon(isBuild)) + isBuild && vitePlugins.push(...createCompression(viteEnv)) + return vitePlugins +} diff --git a/shierfeng-fastapi-frontend/vite/plugins/setup-extend.js b/shierfeng-fastapi-frontend/vite/plugins/setup-extend.js new file mode 100644 index 0000000..ed8342e --- /dev/null +++ b/shierfeng-fastapi-frontend/vite/plugins/setup-extend.js @@ -0,0 +1,5 @@ +import setupExtend from 'unplugin-vue-setup-extend-plus/vite' + +export default function createSetupExtend() { + return setupExtend({}) +} diff --git a/shierfeng-fastapi-frontend/vite/plugins/svg-icon.js b/shierfeng-fastapi-frontend/vite/plugins/svg-icon.js new file mode 100644 index 0000000..30a4140 --- /dev/null +++ b/shierfeng-fastapi-frontend/vite/plugins/svg-icon.js @@ -0,0 +1,10 @@ +import { createSvgIconsPlugin } from 'vite-plugin-svg-icons' +import path from 'path' + +export default function createSvgIcon(isBuild) { + return createSvgIconsPlugin({ + iconDirs: [path.resolve(process.cwd(), 'src/assets/icons/svg')], + symbolId: 'icon-[dir]-[name]', + svgoOptions: isBuild + }) +} diff --git a/shierfeng-fastapi-test/README.md b/shierfeng-fastapi-test/README.md new file mode 100644 index 0000000..63fc0e1 --- /dev/null +++ b/shierfeng-fastapi-test/README.md @@ -0,0 +1,115 @@ +# ShiErFeng 项目测试套件 + +这是一个为施尔丰项目创建的完整测试套件,使用 Playwright 进行端到端测试。测试环境已禁用验证码功能,以简化测试流程。 + +## 功能特性 + +- 使用默认方式手动启动前后端服务或`Docker Compose`自动启动项目前后端服务 +- 测试环境已禁用验证码功能 +- 验证登录流程和认证机制 +- 测试所有受保护的页面功能 +- 验证未登录用户访问受保护页面时的重定向行为 + +## 依赖安装 + +```bash +pip install -r requirements.txt +playwright install +``` + +## 使用方法 + +### 方式一:默认方法 + +#### 启动前端 + +```bash +cd shierfeng-fastapi-frontend +npm install +npm run dev +``` + +#### 启动后端 + +```bash +cd shierfeng-fastapi-backend +pip install -r requirements.txt +python app.py --env=dev +``` + +#### 运行测试 + +```bash +cd shierfeng-fastapi-test +pip install -r requirements.txt +python -m pytest -v +``` + +### 方式二:使用Docker + +#### 进入测试目录 + +```bash +cd shierfeng-fastapi-test +``` + +#### 启动 Docker 服务 + +```bash +# MySQL版本 +docker compose -f docker-compose.test.my.yml up -d --build +# PostgreSQL版本 +docker compose -f docker-compose.test.pg.yml up -d --build +``` + +#### 运行测试 + +```bash +pip install -r requirements.txt +python -m pytest -v +``` + +## 测试内容 + +### 登录测试 + +- 验证登录页面正常加载 +- 验证登录流程(测试环境已禁用验证码) +- 测试认证后的页面访问 + +### 页面访问和功能测试 + +- 仪表盘页面 +- 用户管理页面 +- 角色管理页面 +- 菜单管理页面 +- 部门管理页面 +- 岗位管理页面 +- 字典管理页面 +- 参数配置页面 +- 通知公告页面 +- 日志管理页面(操作日志、登录日志) +- 在线用户页面 +- 定时任务页面 +- 服务监控页面 +- 数据监控页面 +- 缓存监控页面 +- 缓存列表页面 +- 代码生成页面 +- 系统接口页面 + +### 认证测试 + +- 验证未登录用户访问受保护页面时被重定向到登录页 +- 验证登录后可以访问受保护页面 + +## 配置说明 + +使用 `docker-compose.test.my.yml`或`docker-compose.test.pg.yml`启动服务,默认前端端口为 `80`,后端端口为 `9099`。测试环境已禁用验证码功能。 + +## 注意事项 + +1. 确保系统已安装 Docker 和 Docker Compose +2. 确保端口 `80` 和 `9099` 未被占用 +3. 首次运行时 Docker 镜像构建可能需要几分钟时间 +4. 测试使用默认管理员账户:用户名 `admin`,密码 `admin123` diff --git a/shierfeng-fastapi-test/common/__init__.py b/shierfeng-fastapi-test/common/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-test/common/base_page_test.py b/shierfeng-fastapi-test/common/base_page_test.py new file mode 100644 index 0000000..0542a68 --- /dev/null +++ b/shierfeng-fastapi-test/common/base_page_test.py @@ -0,0 +1,87 @@ +import re + +from playwright.async_api._context_manager import PlaywrightContextManager + +from common.login_helper import LoginHelper + + +class BasePageTest: + browser = None + context = None + page = None + token = None + + async def setup(self, playwright: PlaywrightContextManager) -> None: + """初始化浏览器和登录""" + # 首先登录获取token + helper = LoginHelper() + self.token = helper.login(username='admin', password='admin123') + assert self.token is not None, '登录应该成功' + + # 启动浏览器 + self.browser = await playwright.chromium.launch(headless=True) + self.context = await self.browser.new_context() + # 设置认证token + await self.context.add_cookies( + [ + { + 'name': 'Admin-Token', + 'value': self.token, + 'domain': 'localhost', + 'path': '/', + 'httpOnly': False, + 'secure': False, + } + ] + ) + self.page = await self.context.new_page() + + async def teardown(self) -> None: + """清理资源""" + if self.context: + await self.context.close() + if self.browser: + await self.browser.close() + + async def goto_page(self, url: str) -> None: + """访问指定页面""" + await self.page.goto(url) + + async def wait_for_page_title(self, title_text: str, timeout: int = 10000) -> None: + """等待页面标题出现""" + await self.page.wait_for_selector(f'div:has-text("{title_text}")', timeout=timeout) + page_title = await self.page.inner_text(f'div:has-text("{title_text}")') + assert title_text in page_title + + async def wait_for_selector(self, selector: str, timeout: int = 10000) -> None: + """等待选择器出现""" + await self.page.wait_for_selector(selector, timeout=timeout) + + async def query_selector(self, selector: str) -> any: + """查询选择器元素""" + return await self.page.query_selector(selector) + + async def click_button(self, button_text: str) -> None: + """点击按钮""" + button = await self.page.wait_for_selector(f'text="{button_text}"', timeout=5000) + await button.click() + + async def fill_input(self, selector: str, value: str) -> None: + """填充输入框""" + await self.page.fill(selector, value) + + async def get_text_content(self, selector: str) -> str: + """获取元素文本内容""" + element = await self.page.query_selector(selector) + if element: + return await element.text_content() + return None + + async def get_table_total_rows(self) -> int: + """获取表格总行数""" + element = self.page.locator('span.el-pagination__total').first + text = await element.text_content() + + # 提取数字 + number = re.search(r'\d+', text).group() + return int(number) diff --git a/shierfeng-fastapi-test/common/config.py b/shierfeng-fastapi-test/common/config.py new file mode 100644 index 0000000..003ab28 --- /dev/null +++ b/shierfeng-fastapi-test/common/config.py @@ -0,0 +1,3 @@ +class Config: + frontend_url = 'http://localhost:80' + backend_url = 'http://localhost:9099' diff --git a/shierfeng-fastapi-test/common/login_helper.py b/shierfeng-fastapi-test/common/login_helper.py new file mode 100644 index 0000000..9a0b48b --- /dev/null +++ b/shierfeng-fastapi-test/common/login_helper.py @@ -0,0 +1,57 @@ +import requests + +from common.config import Config + + +class LoginHelper: + """ + 登录辅助类 + """ + + def __init__(self, base_url: str = Config.frontend_url) -> None: + self.base_url = base_url + self.session = requests.Session() + + def login(self, username: str = 'admin', password: str = 'admin123', max_retries: int = 3) -> str | None: + """ + 执行登录操作(在测试环境中,验证码已禁用) + """ + for _attempt in range(max_retries): + # 在测试环境中,验证码已禁用,所以直接登录 + login_data = {'username': username, 'password': password} + + headers = {'Content-Type': 'application/x-www-form-urlencoded', 'Referer': f'{self.base_url}/login'} + + response = self.session.post(f'{Config.backend_url}/login', data=login_data, headers=headers) + + http_ok = 200 + if response.status_code == http_ok: + result = response.json() + # 检查登录是否成功 - 可能是 code=200 或 success=true + if result.get('code') == http_ok or result.get('success'): + # 尝试从不同可能的位置获取token + token = result.get('token') # 直接在根级别 + if not token: + token = result.get('data', {}).get('token') # 在data对象内 + + if token: + print('登录成功') + return token + print(f'登录失败: 响应中未找到token - {result}') + else: + print(f'登录失败: {result.get("msg", "未知错误")}') + else: + print(f'登录请求失败: 状态码 {response.status_code}') + + print('登录失败,已达到最大重试次数') + return None + + +# 使用示例 +if __name__ == '__main__': + helper = LoginHelper() + token = helper.login() + if token: + print(f'获取到token: {token}') + else: + print('登录失败') diff --git a/shierfeng-fastapi-test/disable_captcha.sql b/shierfeng-fastapi-test/disable_captcha.sql new file mode 100644 index 0000000..9da9589 --- /dev/null +++ b/shierfeng-fastapi-test/disable_captcha.sql @@ -0,0 +1,4 @@ +-- 用于测试环境的SQL脚本,禁用验证码功能 + +-- 更新验证码配置为禁用状态 +UPDATE sys_config SET config_value = 'false' WHERE config_key = 'sys.account.captchaEnabled'; diff --git a/shierfeng-fastapi-test/docker-compose.test.my.yml b/shierfeng-fastapi-test/docker-compose.test.my.yml new file mode 100644 index 0000000..2fbd8a1 --- /dev/null +++ b/shierfeng-fastapi-test/docker-compose.test.my.yml @@ -0,0 +1,77 @@ +services: + # 前端服务 + shierfeng-frontend: + build: + context: ../shierfeng-fastapi-frontend + dockerfile: Dockerfile + image: shierfeng-frontend:latest + container_name: shierfeng-frontend-test + ports: + - "80:80" + volumes: + - ../shierfeng-fastapi-frontend/bin/nginx.dockermy.conf:/etc/nginx/conf.d/default.conf + depends_on: + - shierfeng-backend-my + networks: + - shierfeng-network-test + + # 后端服务(MySQL版本) + shierfeng-backend-my: + build: + context: ../shierfeng-fastapi-backend + dockerfile: Dockerfile.my + image: shierfeng-backend-my:latest + container_name: shierfeng-backend-my-test + ports: + - "9099:9099" + environment: + TRANSPORT_CRYPTO_ENABLED: "false" + TRANSPORT_CRYPTO_MODE: "off" + depends_on: + shierfeng-mysql: + condition: service_healthy + shierfeng-redis: + condition: service_healthy + networks: + - shierfeng-network-test + + # MySQL服务 + shierfeng-mysql: + image: mysql:8.0 + container_name: shierfeng-mysql-test + environment: + MYSQL_ROOT_PASSWORD: root + MYSQL_DATABASE: shierfeng-fastapi + ports: + - "13307:3306" + volumes: + - ../shierfeng-fastapi-backend/sql/shierfeng-fastapi.sql:/docker-entrypoint-initdb.d/01-shierfeng-fastapi.sql + - ./disable_captcha.sql:/docker-entrypoint-initdb.d/02-disable-captcha.sql + command: --character-set-server=utf8mb4 --collation-server=utf8mb4_general_ci --skip-character-set-client-handshake=1 + networks: + - shierfeng-network-test + healthcheck: + test: ["CMD", "bash", "-c", "mysqladmin ping -h localhost -u root -proot && mysql -h localhost -u root -proot -e 'SELECT 1'"] + interval: 5s + timeout: 10s + retries: 30 + + # Redis服务 + shierfeng-redis: + image: redis:latest + container_name: shierfeng-redis-test + ports: + - "16380:6379" + networks: + - shierfeng-network-test + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 5s + timeout: 10s + retries: 30 + +# 网络配置 +networks: + shierfeng-network-test: + name: shierfeng-network-test + driver: bridge \ No newline at end of file diff --git a/shierfeng-fastapi-test/docker-compose.test.pg.yml b/shierfeng-fastapi-test/docker-compose.test.pg.yml new file mode 100644 index 0000000..3a113c5 --- /dev/null +++ b/shierfeng-fastapi-test/docker-compose.test.pg.yml @@ -0,0 +1,77 @@ +services: + # 前端服务 + shierfeng-frontend: + build: + context: ../shierfeng-fastapi-frontend + dockerfile: Dockerfile + image: shierfeng-frontend:latest + container_name: shierfeng-frontend-test + ports: + - "80:80" + volumes: + - ../shierfeng-fastapi-frontend/bin/nginx.dockerpg.conf:/etc/nginx/conf.d/default.conf + depends_on: + - shierfeng-backend-pg + networks: + - shierfeng-network-test + + # 后端服务(PostgreSQL版本) + shierfeng-backend-pg: + build: + context: ../shierfeng-fastapi-backend + dockerfile: Dockerfile.pg + image: shierfeng-backend-pg:latest + container_name: shierfeng-backend-pg-test + ports: + - "9099:9099" + environment: + TRANSPORT_CRYPTO_ENABLED: "false" + TRANSPORT_CRYPTO_MODE: "off" + depends_on: + shierfeng-pg: + condition: service_healthy + shierfeng-redis: + condition: service_healthy + networks: + - shierfeng-network-test + + # PostgreSQL服务 + shierfeng-pg: + image: postgres:14 + container_name: shierfeng-pg-test + environment: + POSTGRES_PASSWORD: root + POSTGRES_DB: shierfeng-fastapi + POSTGRES_INITDB_ARGS: --encoding=UTF8 --lc-collate=C --lc-ctype=C + ports: + - "15433:5432" + volumes: + - ../shierfeng-fastapi-backend/sql/shierfeng-fastapi-pg.sql:/docker-entrypoint-initdb.d/01-shierfeng-fastapi-pg.sql + - ./disable_captcha.sql:/docker-entrypoint-initdb.d/02-disable-captcha.sql + networks: + - shierfeng-network-test + healthcheck: + test: ["CMD", "pg_isready", "-U", "postgres"] + interval: 5s + timeout: 10s + retries: 30 + + # Redis服务 + shierfeng-redis: + image: redis:latest + container_name: shierfeng-redis-test + ports: + - "16381:6379" + networks: + - shierfeng-network-test + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 5s + timeout: 10s + retries: 30 + +# 网络配置 +networks: + shierfeng-network-test: + name: shierfeng-network-test + driver: bridge \ No newline at end of file diff --git a/shierfeng-fastapi-test/monitor/__init__.py b/shierfeng-fastapi-test/monitor/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-test/monitor/test_cache_list.py b/shierfeng-fastapi-test/monitor/test_cache_list.py new file mode 100644 index 0000000..244a1fa --- /dev/null +++ b/shierfeng-fastapi-test/monitor/test_cache_list.py @@ -0,0 +1,81 @@ +import pytest +from playwright.async_api import async_playwright, expect + +from common.base_page_test import BasePageTest +from common.config import Config + + +class CacheListTest(BasePageTest): + """缓存列表测试类""" + + async def test_cache_list(self) -> None: + """测试缓存列表页面""" + await self.page.goto(Config.frontend_url + '/monitor/cacheList') + await self.page.wait_for_load_state('networkidle') + + # 1. 缓存列表 - 点击 sys_config + await self.page.wait_for_selector('text=缓存列表') + + # 等待 sys_config 出现并点击 + sys_config_row = self.page.locator('.el-card', has_text='缓存列表').locator('tr', has_text='sys_config') + await sys_config_row.wait_for() + await sys_config_row.click() + + # 2. 键名列表 - 点击 sys.account.captchaEnabled + await self.page.wait_for_selector('text=键名列表') + + # 等待 sys.account.captchaEnabled 出现并点击 + captcha_row = self.page.locator('.el-card', has_text='键名列表').locator( + 'tr', has_text='sys.account.captchaEnabled' + ) + await captcha_row.wait_for() + await captcha_row.click() + + # 3. 验证缓存内容为 false + await self.page.wait_for_selector('text=缓存内容') + + # 等待数据加载 + await self.page.wait_for_timeout(2000) + + # 获取内容 + # 缓存内容显示在一个 textarea 中 + content_area = self.page.locator('div.el-form-item', has_text='缓存内容:').locator('textarea') + + # 也可以尝试直接获取 .el-form-item__content 的文本,如果 textarea 不可交互 + if await content_area.count() > 0: + # 尝试等待内容不为空 + try: + await expect(content_area).not_to_be_empty(timeout=5000) + except TimeoutError: + pass + + value = await content_area.input_value() + print(f'Cache content value: {value}') + + # 如果为空,可能需要重新点击一下 + if not value: + print('Value is empty, trying to click key again') + await captcha_row.click() + await self.page.wait_for_timeout(2000) + value = await content_area.input_value() + print(f'Cache content value after retry: {value}') + + assert 'false' in value.lower(), f"Expected 'false' in cache content, got: {value}" + else: + # 如果不是 textarea,尝试获取文本 + content_div = self.page.locator('div.el-form-item', has_text='缓存内容:').locator('.el-form-item__content') + value = await content_div.text_content() + print(f'Cache content text: {value}') + assert 'false' in value.lower(), f"Expected 'false' in cache content, got: {value}" + + +@pytest.mark.asyncio +async def test_cache_list_page() -> None: + """测试缓存列表页面功能""" + async with async_playwright() as p: + test_instance = CacheListTest() + await test_instance.setup(p) + try: + await test_instance.test_cache_list() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/monitor/test_cache_monitor.py b/shierfeng-fastapi-test/monitor/test_cache_monitor.py new file mode 100644 index 0000000..1b550bb --- /dev/null +++ b/shierfeng-fastapi-test/monitor/test_cache_monitor.py @@ -0,0 +1,48 @@ +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class CacheMonitorTest(BasePageTest): + """缓存监控测试类""" + + async def test_cache_monitor(self) -> None: + """测试缓存监控页面""" + await self.page.goto(Config.frontend_url + '/monitor/cache') + await self.page.wait_for_load_state('networkidle') + + # 验证基本信息 + await self.page.wait_for_selector('text=基本信息') + await self.page.wait_for_selector('text=Redis版本') + await self.page.wait_for_selector('text=运行模式') + + # 验证命令统计 + await self.page.wait_for_selector('text=命令统计') + + # 验证内存信息 + await self.page.wait_for_selector('text=内存信息') + + # 验证端口为 6379 + port_row = self.page.locator('tr', has_text='端口') + try: + await port_row.wait_for(timeout=5000) + text = await port_row.text_content() + assert '6379' in text, f"Expected port '6379' in row, but got: {text}" + except Exception: + print("Warning: '端口' row not found, checking page content") + content = await self.page.content() + assert '6379' in content, "Port '6379' not found in page content" + + +@pytest.mark.asyncio +async def test_cache_monitor_page() -> None: + """测试缓存监控页面功能""" + async with async_playwright() as p: + test_instance = CacheMonitorTest() + await test_instance.setup(p) + try: + await test_instance.test_cache_monitor() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/monitor/test_job_management.py b/shierfeng-fastapi-test/monitor/test_job_management.py new file mode 100644 index 0000000..db16267 --- /dev/null +++ b/shierfeng-fastapi-test/monitor/test_job_management.py @@ -0,0 +1,185 @@ +from datetime import datetime + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class JobManagementTest(BasePageTest): + """定时任务管理测试""" + + def generate_job_data(self) -> dict: + """生成测试数据""" + timestamp = datetime.now().strftime('%H%M%S') + return { + 'job_name': f'测试任务_{timestamp}', + 'job_group': '默认', + 'job_executor': '进程池', + 'invoke_target': 'module_task.scheduler_test.job', # 必须为这个值 + 'cron_expression': '0/2 * * * * ?', # 每2秒执行一次 + 'new_invoke_target': 'module_task.scheduler_test.job', # 修改时也用这个 + 'job_name_edit': f'测试任务_{timestamp}_edit', + } + + async def create_job( + self, job_name: str, job_group: str, job_executor: str, invoke_target: str, cron_expression: str + ) -> None: + """创建定时任务""" + await self.page.get_by_role('button', name='新增').click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写表单 + await dialog.get_by_role('textbox', name='任务名称').fill(job_name) + + # 选择任务分组 + await dialog.locator("label:has-text('任务分组') + div .el-select").click() + await self.page.get_by_role('option', name=job_group).click() + + # 选择任务执行器 + await dialog.locator("label:has-text('任务执行器') + div .el-select").click() + await self.page.get_by_role('option', name=job_executor).click() + + # 填写调用方法 + await dialog.get_by_role('textbox', name='调用方法').fill(invoke_target) + + # 填写cron表达式 + await dialog.get_by_role('textbox', name='cron表达式').fill(cron_expression) + + # 策略:如果"失败"策略等有默认值,就不管了 + + await dialog.get_by_role('button', name='确 定').click() + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def search_job(self, job_name: str) -> None: + """搜索任务""" + # 我们可以限制在 form 里搜索 + form = self.page.locator('form').first + await form.get_by_role('textbox', name='任务名称').fill(job_name) + await self.page.get_by_role('button', name='搜索').click() + await self.page.wait_for_timeout(1000) # 等待搜索结果 + + async def edit_job(self, job_name: str, new_invoke_target: str) -> None: + """修改任务""" + await self.search_job(job_name) + + # 点击修改 (在操作列) + row = self.page.locator('tbody tr').first + # 操作列按钮顺序: 修改, 删除, 执行一次, 详细, 日志 + await row.locator('button').nth(0).click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改调用方法 + await dialog.get_by_role('textbox', name='调用方法').fill(new_invoke_target) + + await dialog.get_by_role('button', name='确 定').click() + await self.wait_for_selector("div:has-text('修改成功')", timeout=10000) + + async def toggle_job_status(self, job_name: str) -> None: + """切换任务状态""" + await self.search_job(job_name) + + row = self.page.locator('tbody tr').first + # 切换开关 + # 需要点击可见的 .el-switch 或 .el-switch__core + await row.locator('.el-switch').click() + + # 确认切换 + await self.page.get_by_role('button', name='确定').click() + await self.page.wait_for_timeout(1000) + await self.wait_for_selector("div:has-text('成功')", timeout=10000) + + async def run_job_once(self, job_name: str) -> None: + """执行一次任务""" + await self.search_job(job_name) + + row = self.page.locator('tbody tr').first + # 点击执行一次 (第3个按钮) + await row.locator('button').nth(2).click() + + # 确认执行 + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector("div:has-text('执行成功')", timeout=10000) + + async def view_job_log(self, job_name: str) -> None: + """查看调度日志""" + # 可以点击顶部的 "日志" 按钮,也可以点击行的 "调度日志" + # 我们点击行的 "调度日志" (icon="Operation") + await self.search_job(job_name) + row = self.page.locator('tbody tr').first + + log_btn = row.locator('button').nth(4) + await log_btn.click() + + # 等待跳转到日志页面 (实际上是 router push 到 /monitor/job-log) + # 检查 URL + await self.page.wait_for_url('**/monitor/job-log**') + + # 验证在日志页面 + await self.wait_for_selector('text=调度日志') + + # 关闭返回 (点击 "关闭" 按钮) + await self.page.get_by_role('button', name='关闭').click() + + # 等待返回任务列表 + await self.page.wait_for_url('**/monitor/job') + + async def delete_job(self, job_name: str) -> None: + """删除任务""" + await self.search_job(job_name) + + row = self.page.locator('tbody tr').first + # 点击删除 (第2个按钮) + await row.locator('button').nth(1).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector("div:has-text('删除成功')", timeout=10000) + + async def test_job_crud_operations(self) -> None: + """测试定时任务管理全流程""" + data = self.generate_job_data() + + # 1. 进入定时任务页面 + await self.goto_page(Config.frontend_url + '/monitor/job') + await self.wait_for_selector('text=任务名称') + + # 2. 创建任务 + await self.create_job( + data['job_name'], data['job_group'], data['job_executor'], data['invoke_target'], data['cron_expression'] + ) + + # 3. 修改任务 (修改调用方法) + await self.edit_job(data['job_name'], data['new_invoke_target']) + + # 4. 切换状态 (开启/关闭) + await self.toggle_job_status(data['job_name']) # 开启 + await self.page.wait_for_timeout(1000) + await self.toggle_job_status(data['job_name']) # 关闭 + + # 5. 执行一次 + await self.run_job_once(data['job_name']) + + # 6. 查看日志 + await self.view_job_log(data['job_name']) + + # 7. 删除任务 + await self.delete_job(data['job_name']) + + +@pytest.mark.asyncio +async def test_job_management_page() -> None: + """测试定时任务管理页面功能""" + async with async_playwright() as p: + test_instance = JobManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_job_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/monitor/test_online_user.py b/shierfeng-fastapi-test/monitor/test_online_user.py new file mode 100644 index 0000000..940f698 --- /dev/null +++ b/shierfeng-fastapi-test/monitor/test_online_user.py @@ -0,0 +1,73 @@ +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class OnlineUserTest(BasePageTest): + """在线用户测试类""" + + async def test_online_user_operations(self) -> None: + """测试在线用户强退""" + # 1. 模拟 niangao 用户登录以产生在线会话 + # 使用一个新的上下文来模拟另一个用户的登录 + niangao_context = await self.browser.new_context() + niangao_page = await niangao_context.new_page() + + # 登录 niangao + try: + await niangao_page.goto(Config.frontend_url + '/login') + await niangao_page.locator('div.el-form-item', has_text='账号').locator('input').fill('niangao') + await niangao_page.locator('div.el-form-item', has_text='密码').locator('input').fill('admin123') + await niangao_page.get_by_role('button', name='登 录').click() + # 等待登录成功 + await niangao_page.wait_for_url('**/index') + except Exception as e: + print(f'Niangao login failed: {e}. Trying admin123') + try: + await niangao_page.locator('div.el-form-item', has_text='密码').locator('input').fill('123456') + await niangao_page.get_by_role('button', name='登 录').click() + await niangao_page.wait_for_url('**/index') + except Exception as e2: + print(f'Niangao login failed again: {e2}') + + # 2. 切换回 admin (self.page) 进行操作 + await self.page.goto(Config.frontend_url + '/monitor/online') + await self.page.wait_for_load_state('networkidle') + + # 3. 搜索 niangao 用户 + await self.page.locator('div.el-form-item', has_text='用户名称').locator('input').fill('niangao') + await self.page.get_by_role('button', name='搜索').click() + await self.page.wait_for_timeout(1000) + + # 4. 强退操作 + # 检查是否有数据 + rows = self.page.locator('.el-table__body tr') + count = await rows.count() + if count > 0: + # 点击强退 + await rows.first.get_by_role('button', name='强退').click() + # 确认 + await self.page.get_by_role('button', name='确定').click() + # 验证 + await self.page.wait_for_selector('text=删除成功', timeout=3000) + + # 再次搜索确认消失 + await self.page.wait_for_timeout(1000) + await self.page.get_by_role('button', name='搜索').click() + + # 关闭 niangao 的上下文 + await niangao_context.close() + + +@pytest.mark.asyncio +async def test_online_user_page() -> None: + """测试在线用户页面功能""" + async with async_playwright() as p: + test_instance = OnlineUserTest() + await test_instance.setup(p) + try: + await test_instance.test_online_user_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/monitor/test_server_monitor.py b/shierfeng-fastapi-test/monitor/test_server_monitor.py new file mode 100644 index 0000000..0d89aa4 --- /dev/null +++ b/shierfeng-fastapi-test/monitor/test_server_monitor.py @@ -0,0 +1,46 @@ +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class ServerMonitorTest(BasePageTest): + """服务监控测试类""" + + async def test_server_monitor(self) -> None: + """测试服务监控页面""" + await self.page.goto(Config.frontend_url + '/monitor/server') + await self.page.wait_for_load_state('networkidle') + + # 验证主要板块存在 + await self.page.wait_for_selector('text=CPU') + await self.page.wait_for_selector('text=内存') + await self.page.wait_for_selector('text=服务器信息') + await self.page.wait_for_selector('text=Python解释器信息') + await self.page.wait_for_selector('text=磁盘状态') + + # 验证项目路径为 /app + # 尝试在表格行中查找 + project_path_row = self.page.locator('tr', has_text='项目路径') + try: + await project_path_row.wait_for(timeout=5000) + text = await project_path_row.text_content() + assert '/app' in text, f"Expected project path '/app' in row, but got: {text}" + except Exception: + # 如果没找到行,尝试全局搜索 + print("Warning: '项目路径' row not found, checking page content") + content = await self.page.content() + assert '/app' in content, "Project path '/app' not found in page content" + + +@pytest.mark.asyncio +async def test_server_monitor_page() -> None: + """测试服务监控页面功能""" + async with async_playwright() as p: + test_instance = ServerMonitorTest() + await test_instance.setup(p) + try: + await test_instance.test_server_monitor() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/requirements.txt b/shierfeng-fastapi-test/requirements.txt new file mode 100644 index 0000000..df7958d --- /dev/null +++ b/shierfeng-fastapi-test/requirements.txt @@ -0,0 +1,5 @@ +playwright +pytest +pytest-asyncio +pytest-playwright +ruff \ No newline at end of file diff --git a/shierfeng-fastapi-test/ruff.toml b/shierfeng-fastapi-test/ruff.toml new file mode 100644 index 0000000..23d788c --- /dev/null +++ b/shierfeng-fastapi-test/ruff.toml @@ -0,0 +1,68 @@ +line-length = 120 +show-fixes = true +target-version = "py310" +unsafe-fixes = true + +[lint] +select = [ + "FAST", # fastapi + "ANN", # flake8-annotations + "ASYNC", # flake8-async + "B", # flake8-bugbear + "A", # flake8-builtins + "COM", # flake8-commas + "C4", # flake8-comprehensions + "ISC", # flake8-implicit-str-concat + "ICN", # flake8-import-conventions + "PIE", # flake8-pie + "RSE", # flake8-raise + "RET", # flake8-return + "SIM", # flake8-simplify + "TC", # flake8-type-checking + "FLY", # flynt + "I", # isort + "N", # pep8-naming + "PERF", # perflint + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "PGH", # pygrep-hooks + "PL", # pylint + "UP", # pyupgrade + "RUF", # Ruff-specific rules +] +ignore = [ + "ANN002", # missing type annotation for *{name} + "ANN003", # missing type annotation for **{name} + "ANN401", # dynamically typed expressions (typing.Any) are disallowed in {name} + "B008", # do not perform function calls in argument defaults + "COM812", # trailing comma missing + "RET504", # unnecessary assignment to {name} before return statement + "SIM105", # use contextlib.suppress({exception}) instead of try-except-pass + "C901", # too complex + "N818", # exception name {name} should be named with an Error suffix + "E501", # line too long + "W191", # indentation contains tabs + "RUF001", # string contains ambiguous + "RUF002", # docstring contains ambiguous + "RUF003", # comment contains ambiguous + "RUF012", # mutable class attributes should be annotated with typing.ClassVar +] + +[lint.flake8-type-checking] +runtime-evaluated-base-classes = ["pydantic.BaseModel", "sqlalchemy.orm.DeclarativeBase"] + +[lint.isort] +known-third-party = ["alembic"] + +[lint.pylint] +max-args = 10 +max-returns = 10 + +[lint.pyupgrade] +# Preserve types, even if a file imports `from __future__ import annotations`. +keep-runtime-typing = true + +[format] +docstring-code-format = true +quote-style = "single" \ No newline at end of file diff --git a/shierfeng-fastapi-test/system/__init__.py b/shierfeng-fastapi-test/system/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-test/system/test_config_management.py b/shierfeng-fastapi-test/system/test_config_management.py new file mode 100644 index 0000000..e4e0563 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_config_management.py @@ -0,0 +1,165 @@ +import time + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class ConfigManagementTest(BasePageTest): + """参数设置测试类""" + + def generate_config_data(self) -> dict: + """生成测试数据""" + timestamp = int(time.time()) + return { + 'config_name': f'test_config_{timestamp}', + 'config_key': f'test_config_key_{timestamp}', + 'config_value': f'test_config_value_{timestamp}', + } + + async def create_config(self, config_name: str, config_key: str, config_value: str) -> None: + """创建参数配置""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写参数信息 + await dialog.get_by_role('textbox', name='参数名称').fill(config_name) + await dialog.get_by_role('textbox', name='参数键名').fill(config_key) + await dialog.get_by_role('textbox', name='参数键值').fill(config_value) + + # 等待一段时间确保输入完成 + await self.page.wait_for_timeout(500) + + # 选择参数状态 - 选择系统内置选项为N(否),避免后端限制删除 + # 在对话框中找到系统内置的单选按钮并选择 + await self.wait_for_selector('input[type="radio"]', timeout=5000) + # 点击系统内置'否'选项 + # 根据codegen脚本,使用更精确的定位器 + await self.page.locator('label:nth-child(2) > .el-radio__input > .el-radio__inner').click() + + # 等待一段时间确保选择完成 + await self.page.wait_for_timeout(500) + + # 点击确认按钮 + confirm_button = self.page.get_by_role('button', name='确 定').first + await confirm_button.click() + + # 等待一段时间确保请求发送 + await self.page.wait_for_timeout(1000) + + # 等待新增成功提示 + await self.wait_for_selector('div:has-text("新增成功")', timeout=10000) + + async def search_config(self, config_name: str, config_key: str = '') -> None: + """搜索参数配置""" + # 在查询表单中输入参数信息进行查询 + await self.page.get_by_role('textbox', name='参数名称').fill(config_name) + if config_key: + await self.page.get_by_role('textbox', name='参数键名').fill(config_key) + + # 点击搜索按钮 + await self.page.get_by_role('button', name='搜索').first.click() + + # 等待搜索结果加载 + await self.page.wait_for_timeout(1000) + + async def edit_config(self, updated_value: str) -> None: + """编辑参数配置""" + # 点击编辑按钮 + await self.page.locator('tbody').get_by_role('button', name='修改').nth(0).click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改参数键值 + await dialog.get_by_role('textbox', name='参数键值').fill(updated_value) + + # 确认 + await self.page.get_by_role('button', name='确 定').first.click() + + # 等待编辑成功提示 + await self.wait_for_selector('div:has-text("修改成功")', timeout=10000) + + async def delete_config(self) -> None: + """删除参数配置""" + # 点击删除按钮 + await self.page.locator('tbody').get_by_role('button', name='删除').nth(0).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').first.click() + + # 等待删除成功提示 + await self.wait_for_selector('div:has-text("删除成功")', timeout=10000) + + # 重置查询表单,确保能看到所有参数 + reset_button = self.page.get_by_role('button', name='重置') + await reset_button.click() + + # 等待列表刷新 + await self.page.wait_for_timeout(1000) + + async def test_config_crud_operations(self) -> None: + """测试参数设置的增删查改功能""" + # 访问参数设置页面 + await self.goto_page(Config.frontend_url + '/system/config') + + # 等待页面加载完成 + await self.wait_for_page_title('参数设置', timeout=10000) + await self.page.wait_for_timeout(1000) # 等待列表刷新 + + # 记录初始参数数量 + initial_config_count = await self.get_table_total_rows() + + # 生成测试数据 + data = self.generate_config_data() + + # 1.新增 + await self.create_config(data['config_name'], data['config_key'], data['config_value']) + + # 验证新增 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + new_config_count = await self.get_table_total_rows() + assert new_config_count > initial_config_count, '新增参数后数量应该增加' + + # 2.搜索 + await self.search_config(data['config_name'], data['config_key']) + + # 验证搜索 + search_result_count = await self.get_table_total_rows() + assert search_result_count >= 1, '搜索结果应该至少包含一个参数' + + # 3.编辑 + await self.edit_config(f'updated_config_value_{time.time()}') + + # 验证编辑 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + + # 重新搜索以验证修改结果 + await self.search_config(data['config_name']) + + # 4.删除 + await self.delete_config() + + # 验证删除 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + final_config_count = await self.get_table_total_rows() + assert final_config_count == initial_config_count, '删除参数后数量应该恢复到初始值' + + +@pytest.mark.asyncio +async def test_config_management_page() -> None: + """测试参数设置页面功能""" + async with async_playwright() as p: + test_instance = ConfigManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_config_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_dept_management.py b/shierfeng-fastapi-test/system/test_dept_management.py new file mode 100644 index 0000000..0083433 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_dept_management.py @@ -0,0 +1,135 @@ +import time + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class DeptManagementTest(BasePageTest): + """部门管理页面测试类""" + + def generate_dept_data(self) -> dict: + """生成测试数据""" + timestamp = int(time.time()) + return { + 'dept_name': f'测试部门_{timestamp}', + 'order_num': '3', + 'leader_name': '年糕', + } + + async def create_dept(self, dept_name: str, order_num: str) -> None: + """创建部门""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 上级部门 + # 使用 label 定位父级 form-item,再点击内部的 wrapper + await dialog.locator('div.el-form-item').filter(has_text='上级部门').locator('.el-select__wrapper').click() + # 选择 "集团总公司" (根节点) + # 使用 .el-popper 定位下拉框中的内容 + await self.page.locator('.el-popper:visible').get_by_text('集团总公司').click() + + # 填写部门名称 + await dialog.get_by_role('textbox', name='部门名称').fill(dept_name) + + # 填写显示排序 + # el-input-number 通常是一个 spinbutton 或者 input + await dialog.get_by_role('spinbutton', name='显示排序').fill(order_num) + + # 点击确定 + await self.page.get_by_role('button', name='确 定').click() + # 等待成功消息 + await self.wait_for_selector("div:has-text('成功')", timeout=10000) + + async def search_dept(self, dept_name: str) -> None: + """搜索部门""" + search_form = self.page.locator('form').first + await search_form.get_by_role('textbox', name='部门名称').fill(dept_name) + # 点击搜索按钮 + await self.page.get_by_role('button', name='搜索').first.click() + + # 等待加载 + await self.page.wait_for_timeout(1000) + + async def edit_dept(self, leader_name: str) -> None: + """编辑部门""" + # 点击修改按钮 (第一行) + # 树形表格结构可能不同,但通常也是在 tbody 的 row 中 + await self.page.locator('tbody').get_by_role('button', name='修改').nth(0).click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改负责人 + await dialog.get_by_role('textbox', name='负责人').fill(leader_name) + + # 确定 + await self.page.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("修改成功")', timeout=10000) + + async def delete_dept(self) -> None: + """删除部门""" + # 点击删除按钮 + await self.page.locator('tbody').get_by_role('button', name='删除').nth(0).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("删除成功")', timeout=10000) + + # 重置搜索 + await self.page.get_by_role('button', name='重置').click() + await self.page.wait_for_timeout(1000) + + async def test_dept_crud_operations(self) -> None: + """测试部门管理增删查改""" + # 访问页面 + await self.goto_page(Config.frontend_url + '/system/dept') + await self.wait_for_page_title('部门管理', timeout=10000) + + # 生成测试数据 + data = self.generate_dept_data() + + # 1. 新增 + await self.create_dept(data['dept_name'], data['order_num']) + + # 验证新增 + await self.search_dept(data['dept_name']) + # 树形表格,只要有行显示即可 + rows = await self.page.query_selector_all('.el-table__row') + assert len(rows) >= 1, '新增后搜索应有结果' + + # 2. 编辑 + await self.edit_dept(data['leader_name']) + + # 重新搜索以验证修改结果 + await self.search_dept(data['dept_name']) + + # 3. 删除 + await self.delete_dept() + + # 验证删除 + await self.search_dept(data['dept_name']) + rows_after = await self.page.query_selector_all('.el-table__row') + assert len(rows_after) == 0, '删除后搜索应无结果' + + +@pytest.mark.asyncio +async def test_dept_management_page() -> None: + """测试部门管理页面功能""" + async with async_playwright() as p: + test_instance = DeptManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_dept_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_dict_management.py b/shierfeng-fastapi-test/system/test_dict_management.py new file mode 100644 index 0000000..cf35556 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_dict_management.py @@ -0,0 +1,201 @@ +from datetime import datetime + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class DictManagementTest(BasePageTest): + """字典管理测试类""" + + def generate_dict_data(self) -> dict: + """生成测试数据""" + timestamp = datetime.now().strftime('%H%M%S') + return { + 'dict_name': f'测试字典_{timestamp}', + 'dict_type': f'test_dict_{timestamp}', + 'dict_data_label_1': '正常', + 'dict_data_value_1': '1', + 'dict_data_label_2': '异常', + 'dict_data_value_2': '2', + 'remark': f'备注_{timestamp}', + } + + async def create_dict_type(self, dict_name: str, dict_type: str) -> None: + """创建字典类型""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写表单 + await dialog.get_by_role('textbox', name='字典名称').fill(dict_name) + await dialog.get_by_role('textbox', name='字典类型').fill(dict_type) + + # 提交 + await dialog.get_by_role('button', name='确 定').click() + + # 验证成功 + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def search_dict_type(self, dict_name: str, dict_type: str) -> None: + """搜索字典类型""" + form = self.page.locator('form').first + await form.get_by_role('textbox', name='字典名称').fill(dict_name) + await form.get_by_role('textbox', name='字典类型').fill(dict_type) + # 点击搜索按钮 + await self.page.get_by_role('button', name='搜索').click() + await self.page.wait_for_timeout(1000) + + async def edit_dict_type(self, dict_name: str, remark: str) -> None: + """修改字典类型""" + await self.search_dict_type(dict_name, '') + + # 点击修改按钮 + row = self.page.locator('tbody tr').first + await row.get_by_role('button', name='修改').click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + await dialog.get_by_role('textbox', name='备注').fill(remark) + await dialog.get_by_role('button', name='确 定').click() + + await self.wait_for_selector("div:has-text('修改成功')", timeout=10000) + + async def manage_dict_data(self, dict_type: str, data: dict) -> None: + """管理字典数据""" + # 1. 进入字典数据页面 + # 点击字典类型链接 + row = self.page.locator('tbody tr').first + await row.get_by_role('link', name=dict_type).click() + + # 等待页面切换(Playwright在SPA中通常不需要处理多标签页,除非新开tab) + # 这里是 router-link,应该是页内跳转 + # 检查是否到了字典数据页面 + # 或者等待URL变化,或者等待特定元素 + # data.vue 有 "关闭" 按钮 + await self.wait_for_selector("button:has-text('关闭')", timeout=5000) + + # 2. 新增数据1 (正常) + await self.create_dict_data(data['dict_data_label_1'], data['dict_data_value_1'], '1', '主要(primary)') + + # 3. 新增数据2 (异常) + await self.create_dict_data(data['dict_data_label_2'], data['dict_data_value_2'], '2', '危险(danger)') + + # 4. 修改数据 + await self.edit_dict_data(data['dict_data_label_2'], '测试备注') + + # 5. 删除数据 + await self.delete_dict_data(data['dict_data_label_2']) + await self.delete_dict_data(data['dict_data_label_1']) + + # 6. 关闭页面 (返回字典类型) + await self.page.get_by_role('button', name='关闭', exact=True).click() + # 等待返回 + await self.wait_for_selector('text=字典名称') # 假设返回后能看到原来的页面元素 + + async def create_dict_data(self, label: str, value: str, sort: str, list_class: str) -> None: + """创建字典数据""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + await dialog.get_by_role('textbox', name='数据标签').fill(label) + await dialog.get_by_role('textbox', name='数据键值').fill(value) + await dialog.get_by_role('spinbutton', name='显示排序').fill(sort) + + # 选择回显样式 + # 点击下拉框触发器 + # el-select 的结构通常是 wrapper -> input (readonly) + # 我们可以点击 label 为 "回显样式" 的 form-item 下的 select + select_trigger = dialog.locator("label:has-text('回显样式') + div .el-select") + if await select_trigger.count() == 0: + # 尝试直接找 .el-select,可能布局不同 + select_trigger = dialog.locator('.el-select').filter(has_text='默认(default)').first + + # 如果还是找不到,尝试点击那个默认值文本 + if await select_trigger.count() == 0: + await dialog.get_by_text('默认(default)').click() + else: + await select_trigger.click() + + # 选择选项 (选项在 body 的 el-popper 中) + # 等待选项出现 + await self.page.get_by_role('option', name=list_class).click() + + await dialog.get_by_role('button', name='确 定').click() + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def edit_dict_data(self, label: str, remark: str) -> None: + """修改字典数据""" + # 点击修改按钮 + row = self.page.locator('tbody tr').filter(has_text=label).first + await row.get_by_role('button', name='修改').click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + await dialog.get_by_role('textbox', name='备注').fill(remark) + await dialog.get_by_role('button', name='确 定').click() + + await self.wait_for_selector("div:has-text('修改成功')", timeout=10000) + + async def delete_dict_data(self, label: str) -> None: + """删除字典数据""" + # 点击删除按钮 + row = self.page.locator('tbody tr').filter(has_text=label).first + await row.get_by_role('button', name='删除').click() + + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector("div:has-text('删除成功')", timeout=10000) + + async def delete_dict_type(self, dict_name: str) -> None: + """删除字典类型""" + await self.search_dict_type(dict_name, '') + + # 点击删除按钮 + row = self.page.locator('tbody tr').filter(has_text=dict_name).first + await row.get_by_role('button', name='删除').click() + + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector("div:has-text('删除成功')", timeout=10000) + + async def test_dict_crud_operations(self) -> None: + """测试字典管理全流程""" + data = self.generate_dict_data() + + # 1. 进入字典管理 + await self.goto_page(Config.frontend_url + '/system/dict') + # 等待页面加载 + await self.wait_for_selector('text=字典名称') # 页面标题或其他标识 + + # 2. 创建字典类型 + await self.create_dict_type(data['dict_name'], data['dict_type']) + + # 3. 搜索并修改 + await self.edit_dict_type(data['dict_name'], data['remark']) + + # 4. 管理字典数据 + await self.manage_dict_data(data['dict_type'], data) + + # 5. 删除字典类型 + await self.delete_dict_type(data['dict_name']) + + +@pytest.mark.asyncio +async def test_dict_management_page() -> None: + """测试字典管理页面功能""" + async with async_playwright() as p: + test_instance = DictManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_dict_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_log_management.py b/shierfeng-fastapi-test/system/test_log_management.py new file mode 100644 index 0000000..0b43df1 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_log_management.py @@ -0,0 +1,138 @@ +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class LogManagementTest(BasePageTest): + """日志管理测试类""" + + async def test_operlog_operations(self) -> None: + """测试操作日志查询、删除和清空""" + # 1. 导航到操作日志页面 + # 直接访问正确的路由 + await self.page.goto(Config.frontend_url + '/system/log/operlog') + await self.page.wait_for_load_state('networkidle') + + try: + await self.page.wait_for_selector('.app-container', timeout=10000) + except Exception: + # 如果首次加载失败,尝试刷新 + await self.page.reload() + await self.page.wait_for_selector('.app-container', timeout=10000) + + # 2. 查询操作 + # 输入操作人员 + await self.page.locator('div.el-form-item', has_text='操作人员').locator('input').fill('admin') + # 点击搜索按钮 + await self.page.get_by_role('button', name='搜索').click() + await self.page.wait_for_timeout(1000) # 等待搜索结果 + # 点击重置按钮 + await self.page.get_by_role('button', name='重置').click() + await self.page.wait_for_timeout(1000) # 等待重置结果 + + # 3. 删除操作 + # 检查是否有数据,如果有则进行删除测试 + rows = self.page.locator('.el-table__body tr') + count = await rows.count() + if count > 0: + # 选中第一条 + await rows.first.locator('.el-checkbox').click() + # 点击删除 + await self.page.get_by_role('button', name='删除').click() + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + # 等待删除完成提示 + try: + await self.page.wait_for_selector('text=删除成功', timeout=10000) + except Exception: + pass # 可能是 toast 提示,稍纵即逝 + + # 4. 清空操作 + # 点击清空 + await self.page.get_by_role('button', name='清空').click() + # 确认清空 + await self.page.get_by_role('button', name='确定').click() + + # 5. 验证清空后还有一条"清空"的操作日志 + await self.page.wait_for_timeout(1000) # 等待清空操作完成并刷新 + await self.page.get_by_role('button', name='搜索').click() # 刷新列表 + await self.page.wait_for_timeout(1000) + + # 验证列表不为空 (因为清空操作本身会产生一条日志) + rows_after_clean = self.page.locator('.el-table__body tr') + count_after_clean = await rows_after_clean.count() + assert count_after_clean > 0, '操作日志清空后应该至少有一条记录(清空操作本身)' + + # 可以在这里进一步验证第一条记录的类型是否为清空,但题目只要求不是空列表 + + async def test_logininfor_operations(self) -> None: + """测试登录日志查询、删除和清空""" + # 1. 导航到登录日志页面 + await self.page.goto(Config.frontend_url + '/system/log/logininfor') + await self.page.wait_for_load_state('networkidle') + + try: + await self.page.wait_for_selector('.app-container', timeout=10000) + except Exception: + # 如果失败,尝试刷新 + await self.page.reload() + await self.page.wait_for_selector('.app-container', timeout=10000) + + # 2. 查询操作 + # 输入用户名称 + await self.page.locator('div.el-form-item', has_text='用户名称').locator('input').fill('admin') + # 点击搜索 + await self.page.get_by_role('button', name='搜索').click() + await self.page.wait_for_timeout(1000) + # 点击重置 + await self.page.get_by_role('button', name='重置').click() + await self.page.wait_for_timeout(1000) + + # 3. 删除操作 + # 检查是否有数据 + rows = self.page.locator('.el-table__body tr') + count = await rows.count() + if count > 0: + # 选中第一条 + await rows.first.locator('.el-checkbox').click() + # 点击删除 + await self.page.get_by_role('button', name='删除').click() + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + # 等待删除成功 + try: + await self.page.wait_for_selector('text=删除成功', timeout=10000) + except Exception: + pass + + # 4. 清空操作 + # 点击清空 + await self.page.get_by_role('button', name='清空').click() + # 确认清空 + await self.page.get_by_role('button', name='确定').click() + + # 5. 验证清空后列表为空 + await self.page.wait_for_timeout(1000) + # 检查是否显示"暂无数据" + no_data = await self.page.get_by_text('暂无数据').is_visible() + if not no_data: + # 再次检查行数 + count_final = await self.page.locator('.el-table__body tr').count() + assert count_final == 0, '登录日志清空后应该没有数据' + + +@pytest.mark.asyncio +async def test_log_management_page() -> None: + """测试日志管理页面功能""" + async with async_playwright() as p: + test_instance = LogManagementTest() + await test_instance.setup(p) + try: + # 运行操作日志测试 + await test_instance.test_operlog_operations() + # 运行登录日志测试 + await test_instance.test_logininfor_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_menu_management.py b/shierfeng-fastapi-test/system/test_menu_management.py new file mode 100644 index 0000000..c42dfd8 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_menu_management.py @@ -0,0 +1,145 @@ +from datetime import datetime + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class MenuManagementTest(BasePageTest): + """菜单管理测试""" + + def generate_menu_data(self) -> dict: + """生成测试数据""" + timestamp = datetime.now().strftime('%H%M%S') + return { + 'dir_name': f'测试目录_{timestamp}', + 'menu_name': f'测试菜单_{timestamp}', + 'path_dir': f'test_dir_{timestamp}', + 'path_menu': f'test_menu_{timestamp}', + 'path_menu_new': f'test_menu_new_{timestamp}', + 'order_num': '10', + } + + async def create_directory(self, menu_name: str, path: str, order_num: str) -> None: + """创建目录""" + # 点击顶部新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + # 等待对话框出现 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写表单 + await dialog.get_by_role('spinbutton', name='显示排序').fill(order_num) + await dialog.get_by_role('textbox', name='菜单名称').fill(menu_name) + await dialog.get_by_role('textbox', name='路由地址').fill(path) + + # 提交 + await dialog.get_by_role('button', name='确 定').click() + + # 验证成功提示 + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def search_menu(self, menu_name: str) -> None: + """搜索菜单""" + # 填写搜索条件 + # 使用 first 匹配搜索表单(通常在顶部),避免匹配到隐藏对话框中的同名字段 + await self.page.locator('form').first.get_by_role('textbox', name='菜单名称').fill(menu_name) + await self.page.get_by_role('button', name='搜索').click() + + # 等待表格刷新(简单等待) + await self.page.wait_for_timeout(1000) + + async def create_sub_menu(self, parent_name: str, menu_name: str, path: str, order_num: str) -> None: + """在指定目录下创建子菜单""" + # 找到父级菜单行 + row = self.page.locator('tbody tr').filter(has_text=parent_name).first + + # 点击行内新增按钮 + await row.get_by_role('button', name='新增').click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 选择菜单类型为"菜单" + await dialog.locator('label').filter(has_text='菜单').first.click() + + # 填写表单 + await dialog.get_by_role('spinbutton', name='显示排序').fill(order_num) + await dialog.get_by_role('textbox', name='菜单名称').fill(menu_name) + await dialog.get_by_role('textbox', name='路由地址').fill(path) + + # 提交 + await dialog.get_by_role('button', name='确 定').click() + + # 验证成功 + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def edit_sub_menu(self, menu_name: str, new_path: str) -> None: + """修改子菜单""" + # 搜索子菜单 + await self.search_menu(menu_name) + + row = self.page.locator('tbody tr').filter(has_text=menu_name).first + await row.get_by_role('button', name='修改').click() + + await self.wait_for_selector('.el-dialog', timeout=5000) + dialog = self.page.locator('.el-dialog') + + await dialog.get_by_role('textbox', name='路由地址').fill(new_path) + await self.page.get_by_role('button', name='确 定').click() + + await self.wait_for_selector("div:has-text('修改成功')", timeout=10000) + + async def delete_menus(self, menu_names: list[str]) -> None: + """删除菜单(列表)""" + for name in menu_names: + await self.search_menu(name) + row = self.page.locator('tbody tr').filter(has_text=name).first + + # 点击删除 + await row.get_by_role('button', name='删除').click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + + await self.wait_for_selector("div:has-text('删除成功')", timeout=10000) + + async def test_menu_crud_operations(self) -> None: + """测试菜单增删改查流程""" + data = self.generate_menu_data() + + # 1. 进入菜单管理页面 + await self.goto_page(Config.frontend_url + '/system/menu') + await self.wait_for_page_title('菜单管理', timeout=10000) + + # 2. 新增目录 + await self.create_directory(data['dir_name'], data['path_dir'], data['order_num']) + + # 3. 搜索目录并新增子菜单 + await self.search_menu(data['dir_name']) + await self.create_sub_menu(data['dir_name'], data['menu_name'], data['path_menu'], '1') + + # 4. 修改子菜单 + await self.edit_sub_menu(data['menu_name'], data['path_menu_new']) + + # 5. 删除子菜单 + await self.delete_menus([data['menu_name']]) + + # 6. 删除目录 + await self.delete_menus([data['dir_name']]) + + +@pytest.mark.asyncio +async def test_menu_management_page() -> None: + """测试菜单管理页面功能""" + async with async_playwright() as p: + test_instance = MenuManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_menu_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_notice_management.py b/shierfeng-fastapi-test/system/test_notice_management.py new file mode 100644 index 0000000..d73a618 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_notice_management.py @@ -0,0 +1,165 @@ +import re +import time + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class NoticeManagementTest(BasePageTest): + """通知公告管理测试类""" + + def generate_notice_data(self) -> dict: + """生成测试数据""" + timestamp = int(time.time()) + return { + 'notice_title': f'test_notice_{timestamp}', + 'updated_title': f'updated_notice_{timestamp}', + } + + async def create_notice(self, notice_title: str, notice_type: int = 1, notice_content: str = '测试内容') -> None: + """创建通知公告""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').first.click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写公告信息 + await dialog.get_by_role('textbox', name='公告标题').fill(notice_title) + + # 选择公告类型 + # 根据codegen脚本,点击下拉框触发器 + await self.page.locator('div').filter(has_text=re.compile(r'^请选择$')).nth(4).click() + # 选择对应类型选项,1为通知,2为公告 + if notice_type == 1: + await self.page.get_by_role('option', name='通知').click() + else: + await self.page.get_by_role('option', name='公告').click() + + # 填写公告内容 + await self.page.locator('.ql-container').click() + await self.page.locator('.ql-editor').fill(notice_content) + + # 等待一段时间确保输入完成 + await self.page.wait_for_timeout(500) + + # 点击确认按钮 + await self.page.get_by_role('button', name='确 定').first.click() + + # 等待一段时间确保请求发送 + await self.page.wait_for_timeout(1000) + + # 等待新增成功提示 + await self.wait_for_selector('div:has-text("新增成功")', timeout=10000) + + async def search_notice(self, notice_title: str) -> None: + """搜索通知公告""" + # 在查询表单中输入公告标题进行查询 + await self.page.get_by_role('textbox', name='公告标题').fill(notice_title) + + # 点击搜索按钮 + await self.page.get_by_role('button', name='搜索').first.click() + + # 等待搜索结果加载 + await self.page.wait_for_timeout(1000) + + async def edit_notice(self, updated_title: str, updated_content: str = '更新的测试内容') -> None: + """编辑通知公告""" + # 点击编辑按钮 + await self.page.locator('tbody').get_by_role('button', name='修改').nth(0).click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改公告标题 + await dialog.get_by_role('textbox', name='公告标题').fill(updated_title) + + # 修改公告内容 + await self.page.locator('.ql-editor').fill(updated_content) + + # 点击确认按钮 + await self.page.get_by_role('button', name='确 定').first.click() + + # 等待编辑成功提示 + await self.wait_for_selector('div:has-text("修改成功")', timeout=10000) + + async def delete_notice(self) -> None: + """删除通知公告""" + # 点击删除按钮 + await self.page.locator('tbody').get_by_role('button', name='删除').nth(0).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').first.click() + + # 等待删除成功提示 + await self.wait_for_selector('div:has-text("删除成功")', timeout=10000) + + # 重置查询表单,确保能看到所有公告 + await self.page.get_by_role('button', name='重置').click() + + # 等待列表刷新 + await self.page.wait_for_timeout(1000) + + async def test_notice_crud_operations(self) -> None: + """测试通知公告的增删查改功能""" + # 访问通知公告页面 + await self.goto_page(Config.frontend_url + '/system/notice') + + # 等待页面加载完成 + await self.wait_for_page_title('通知公告', timeout=10000) + await self.page.wait_for_timeout(1000) # 等待列表刷新 + + # 记录初始公告数量 + initial_notice_count = await self.get_table_total_rows() + + # 生成测试数据 + data = self.generate_notice_data() + + # 创建公告 + await self.create_notice(data['notice_title']) + + # 验证公告已添加到列表中 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + new_notice_count = await self.get_table_total_rows() + assert new_notice_count > initial_notice_count, '新增公告后数量应该增加' + + # 搜索公告 + await self.search_notice(data['notice_title']) + + # 验证搜索结果中包含新增的公告 + search_result_count = await self.get_table_total_rows() + assert search_result_count >= 1, '搜索结果应该至少包含一个公告' + + # 编辑公告 + await self.edit_notice(data['updated_title']) + + # 验证编辑成功 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + + # 重新搜索以验证修改结果 + await self.search_notice(data['updated_title']) + + # 删除公告 + await self.delete_notice() + + # 验证公告已从列表中删除 + await self.page.wait_for_timeout(1000) # 等待列表刷新 + final_notice_count = await self.get_table_total_rows() + assert final_notice_count == initial_notice_count, '删除公告后数量应该恢复到初始值' + + +@pytest.mark.asyncio +async def test_notice_management_page() -> None: + """测试通知公告页面功能""" + async with async_playwright() as p: + test_instance = NoticeManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_notice_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_post_management.py b/shierfeng-fastapi-test/system/test_post_management.py new file mode 100644 index 0000000..f57b0f1 --- /dev/null +++ b/shierfeng-fastapi-test/system/test_post_management.py @@ -0,0 +1,136 @@ +from datetime import datetime + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class PostManagementTest(BasePageTest): + """岗位管理测试类""" + + def generate_post_data(self) -> dict: + """生成测试数据""" + timestamp = datetime.now().strftime('%H%M%S') + return { + 'post_name': f'测试岗位_{timestamp}', + 'post_code': f'test_{timestamp}', + 'post_sort': '10', + 'remark': f'测试备注_{timestamp}', + } + + async def test_post_crud_operations(self) -> None: + """测试岗位增删改查流程""" + # 1. 导航到岗位管理页面 + await self.navigate_to_post_management() + + # 生成测试数据 + data = self.generate_post_data() + + # 2. 新增岗位 + await self.create_post(data['post_name'], data['post_code'], data['post_sort']) + + # 3. 搜索岗位 + await self.search_post(data['post_name'], data['post_code']) + + # 4. 修改岗位 + await self.edit_post(data['post_name'], data['remark']) + + # 5. 删除岗位 + await self.delete_post(data['post_name']) + + async def navigate_to_post_management(self) -> None: + """导航到岗位管理""" + # 直接导航到岗位管理页面 + await self.goto_page(Config.frontend_url + '/system/post') + # 等待页面加载 + await self.wait_for_selector('.app-container') + + async def create_post(self, post_name: str, post_code: str, post_sort: str) -> None: + """新增岗位""" + await self.page.get_by_role('button', name='新增').click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写表单 + # 注意:Element Plus 表单必填项可能有 * 号,Label 匹配可能需要注意 + await dialog.get_by_role('textbox', name='岗位名称').fill(post_name) + await dialog.get_by_role('textbox', name='岗位编码').fill(post_code) + + # 岗位顺序是 input-number + # script.py 使用 spinbutton + await dialog.get_by_role('spinbutton', name='岗位顺序').fill(post_sort) + + await dialog.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector("div:has-text('新增成功')", timeout=10000) + + async def search_post(self, post_name: str, post_code: str) -> None: + """搜索岗位""" + # 填写搜索表单 + # 限定在搜索区域,防止定位到弹窗或其他地方(虽然此时没有弹窗) + search_form = self.page.locator('.el-form').first + + await search_form.get_by_role('textbox', name='岗位编码').fill(post_code) + await search_form.get_by_role('textbox', name='岗位名称').fill(post_name) + + await self.page.get_by_role('button', name='搜索').click() + + # 等待表格加载结果 + # 验证表格中包含刚创建的岗位 + await self.wait_for_selector(f"tbody tr:has-text('{post_name}')", timeout=10000) + + async def edit_post(self, post_name: str, remark: str) -> None: + """修改岗位""" + # 确保当前显示的是我们要修改的岗位 + await self.search_post(post_name, '') + + row = self.page.locator('tbody tr').first + # 点击修改按钮 + await row.get_by_role('button', name='修改').click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改备注 + await dialog.get_by_role('textbox', name='备注').fill(remark) + + await dialog.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector("div:has-text('修改成功')", timeout=10000) + + async def delete_post(self, post_name: str) -> None: + """删除岗位""" + # 确保当前显示的是我们要删除的岗位 + search_form = self.page.locator('.el-form').first + await search_form.get_by_role('textbox', name='岗位编码').clear() + await search_form.get_by_role('textbox', name='岗位名称').fill(post_name) + await self.page.get_by_role('button', name='搜索').click() + + await self.wait_for_selector(f"tbody tr:has-text('{post_name}')", timeout=10000) + + row = self.page.locator('tbody tr').first + # 点击删除按钮 + await row.get_by_role('button', name='删除').click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + + # 等待成功提示 + await self.wait_for_selector("div:has-text('删除成功')", timeout=10000) + + +@pytest.mark.asyncio +async def test_post_management_page() -> None: + """测试岗位管理页面功能""" + async with async_playwright() as p: + test_instance = PostManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_post_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_role_management.py b/shierfeng-fastapi-test/system/test_role_management.py new file mode 100644 index 0000000..00f064e --- /dev/null +++ b/shierfeng-fastapi-test/system/test_role_management.py @@ -0,0 +1,148 @@ +import time + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class RoleManagementTest(BasePageTest): + """角色管理测试类""" + + def generate_role_data(self) -> dict: + """生成测试数据""" + timestamp = int(time.time()) + return { + 'role_name': f'test_role_{timestamp}', + 'role_key': f'test_{timestamp}', + } + + async def create_role(self, role_name: str, role_key: str, role_sort: int = 3) -> None: + """创建角色""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写信息 + await dialog.get_by_role('textbox', name='角色名称').fill(role_name) + await dialog.get_by_role('textbox', name='权限字符').fill(role_key) + await dialog.get_by_role('spinbutton', name='角色顺序').fill(str(role_sort)) + + # 选择菜单权限 (点击第一个复选框) + await self.page.locator('.el-tree-node__content .el-checkbox').first.click() + + # 确定 + await self.page.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("新增成功")', timeout=10000) + + async def search_role(self, role_name: str, role_key: str) -> None: + """搜索角色""" + search_form = self.page.locator('form').first + await search_form.get_by_placeholder('请输入角色名称').fill(role_name) + await search_form.get_by_placeholder('请输入权限字符').fill(role_key) + await search_form.get_by_role('button', name='搜索').click() + + # 等待加载 + await self.page.wait_for_timeout(1000) + + async def edit_role(self, new_remark: str) -> None: + """编辑角色""" + # 点击修改按钮 (第一行) + # 按钮没有文字,只有图标,所以使用 nth(0) + row = self.page.locator('tbody tr').first + await row.get_by_role('button').nth(0).click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改备注 + await dialog.get_by_role('textbox', name='备注').fill(new_remark) + + # 确定 + await self.page.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("修改成功")', timeout=10000) + + async def change_role_status(self) -> None: + """修改角色状态""" + # 点击开关 (第一行) + # 使用 .el-switch__core 或者 role=switch + # script.py uses .el-switch__action, let's try .el-switch + switch = self.page.locator('.el-switch').first + await switch.click() + + # 确认对话框 + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector('div:has-text("成功")', timeout=5000) + + # 再次点击恢复 + await self.page.wait_for_timeout(1000) + await switch.click() + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector('div:has-text("成功")', timeout=5000) + + async def delete_role(self) -> None: + """删除角色""" + # 点击删除按钮 (第一行第二个按钮) + row = self.page.locator('tbody tr').first + await row.get_by_role('button').nth(1).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("删除成功")', timeout=10000) + + # 重置搜索 + await self.page.get_by_role('button', name='重置').click() + await self.page.wait_for_timeout(1000) + + async def test_role_crud_operations(self) -> None: + """测试角色管理CRUD""" + # 访问页面 + await self.goto_page(Config.frontend_url + '/system/role') + await self.wait_for_page_title('角色管理', timeout=10000) + + # 生成测试数据 + data = self.generate_role_data() + + # 1. 新增 + await self.create_role(data['role_name'], data['role_key']) + + # 验证新增结果 + await self.search_role(data['role_name'], data['role_key']) + rows = await self.get_table_total_rows() + assert rows >= 1, '新增后搜索应有结果' + + # 2. 修改状态 + await self.change_role_status() + + # 3. 编辑 + await self.edit_role('Updated remark') + + # 4. 删除 + await self.delete_role() + + # 验证删除结果 + await self.search_role(data['role_name'], data['role_key']) + rows_after = await self.get_table_total_rows() + assert rows_after == 0, '删除后搜索应无结果' + + +@pytest.mark.asyncio +async def test_role_management_page() -> None: + """测试角色管理页面功能""" + async with async_playwright() as p: + test_instance = RoleManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_role_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/system/test_user_management.py b/shierfeng-fastapi-test/system/test_user_management.py new file mode 100644 index 0000000..afe732b --- /dev/null +++ b/shierfeng-fastapi-test/system/test_user_management.py @@ -0,0 +1,170 @@ +import time + +import pytest +from playwright.async_api import async_playwright + +from common.base_page_test import BasePageTest +from common.config import Config + + +class UserManagementTest(BasePageTest): + """用户管理测试类""" + + def generate_user_data(self) -> dict: + """生成测试数据""" + timestamp = int(time.time()) + return { + 'user_name': f'test_{timestamp}', + 'nick_name': f'测试用户_{timestamp}', + 'phone': '13888888888', + } + + async def create_user(self, user_name: str, nick_name: str, phone: str) -> None: + """创建用户""" + # 点击新增按钮 + await self.page.get_by_role('button', name='新增').click() + + # 等待对话框 + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 填写基本信息 + await dialog.get_by_role('textbox', name='用户昵称').fill(nick_name) + + # 归属部门 + # 使用 label 定位父级 form-item,再点击内部的 wrapper + await dialog.locator('div.el-form-item').filter(has_text='归属部门').locator('.el-select__wrapper').click() + # 选择 "集团总公司" (根节点) + # 使用 .el-popper 定位下拉框中的内容 + await self.page.locator('.el-popper:visible').get_by_text('集团总公司').click() + + await dialog.get_by_role('textbox', name='用户名称').fill(user_name) + # 手机号码在搜索框也有,所以必须限定在 dialog 内 + # 注意:有些 label 可能不带 *,或者带 * 但 get_by_role 需要准确匹配 + # 这里使用 get_by_placeholder 或者 filter 来定位更稳妥,或者直接 scope 到 dialog + await dialog.locator('div.el-form-item').filter(has_text='手机号码').get_by_role('textbox').fill(phone) + await dialog.locator('div.el-form-item').filter(has_text='邮箱').get_by_role('textbox').fill('test@example.com') + await dialog.locator('div.el-form-item').filter(has_text='用户密码').get_by_role('textbox').fill('123456') + + # 用户性别 + # 定位 label 为 "用户性别" 的父级 form-item,然后找里面的 "请选择" 文本 + await dialog.locator('div.el-form-item').filter(has_text='用户性别').get_by_text('请选择').click() + await self.page.get_by_role('option', name='男').click() + + # 岗位 + await dialog.locator('div.el-form-item').filter(has_text='岗位').get_by_text('请选择').click() + await self.page.get_by_role('option', name='董事长').click() + + # 角色 + await dialog.locator('div.el-form-item').filter(has_text='角色').get_by_text('请选择').click() + await self.page.get_by_role('option', name='普通角色').click() + + await dialog.locator('div.el-form-item').filter(has_text='备注').get_by_role('textbox').fill('测试用户') + + # 点击确定 + await self.page.get_by_role('button', name='确 定').click() + # 等待成功消息 + await self.wait_for_selector("div:has-text('成功')", timeout=10000) + + async def search_user(self, user_name: str) -> None: + """搜索用户""" + search_form = self.page.locator('form').first + await search_form.get_by_role('textbox', name='用户名称').fill(user_name) + await search_form.get_by_role('button', name='搜索').click() + + # 等待加载 + await self.page.wait_for_timeout(1000) + + async def edit_user(self) -> None: + """编辑用户""" + # 点击修改按钮 (第一行) + row = self.page.locator('tbody tr').first + await row.get_by_role('button').nth(0).click() + + dialog = self.page.get_by_role('dialog') + await dialog.wait_for() + + # 修改性别为女 + await dialog.locator('div.el-form-item').filter(has_text='用户性别').locator('.el-select').click() + await self.page.get_by_role('option', name='女').click() + + # 确定 + await self.page.get_by_role('button', name='确 定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("修改成功")', timeout=10000) + + async def change_user_status(self) -> None: + """修改用户状态""" + # 点击开关 (第一行) + switch = self.page.locator('.el-switch').first + await switch.click() + + # 确认对话框 + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector('div:has-text("成功")', timeout=5000) + + # 再次点击恢复 + await self.page.wait_for_timeout(1000) + await switch.click() + await self.page.get_by_role('button', name='确定').click() + await self.wait_for_selector('div:has-text("成功")', timeout=5000) + + async def delete_user(self) -> None: + """删除用户""" + # 点击删除按钮 (第一行第二个按钮) + row = self.page.locator('tbody tr').first + await row.get_by_role('button').nth(1).click() + + # 确认删除 + await self.page.get_by_role('button', name='确定').click() + + # 等待成功提示 + await self.wait_for_selector('div:has-text("删除成功")', timeout=10000) + + # 重置搜索 + await self.page.get_by_role('button', name='重置').click() + await self.page.wait_for_timeout(1000) + + async def test_user_crud_operations(self) -> None: + """测试用户管理增删查改""" + # 访问页面 + await self.goto_page(Config.frontend_url + '/system/user') + await self.wait_for_page_title('用户管理', timeout=10000) + + # 生成测试数据 + data = self.generate_user_data() + + # 1. 新增 + await self.create_user(data['user_name'], data['nick_name'], data['phone']) + + # 验证新增结果 + await self.search_user(data['user_name']) + rows = await self.get_table_total_rows() + assert rows >= 1, '新增后搜索应有结果' + + # 2. 修改状态 + await self.change_user_status() + + # 3. 编辑 + await self.edit_user() + + # 4. 删除 + await self.delete_user() + + # 验证删除结果 + await self.search_user(data['user_name']) + rows_after = await self.get_table_total_rows() + assert rows_after == 0, '删除后搜索应无结果' + + +@pytest.mark.asyncio +async def test_user_management_page() -> None: + """测试用户管理页面功能""" + async with async_playwright() as p: + test_instance = UserManagementTest() + await test_instance.setup(p) + try: + await test_instance.test_user_crud_operations() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/test_login.py b/shierfeng-fastapi-test/test_login.py new file mode 100644 index 0000000..28b25d9 --- /dev/null +++ b/shierfeng-fastapi-test/test_login.py @@ -0,0 +1,202 @@ +import pytest +from playwright.async_api import async_playwright + +from common.config import Config +from common.login_helper import LoginHelper + + +@pytest.mark.asyncio +async def test_login_page_loads() -> None: + """测试登录页面是否能正常加载""" + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + page = await browser.new_page() + + # 访问登录页面 + await page.goto(Config.frontend_url + '/login') + + # 检查页面标题或特定元素是否存在 + title = await page.title() + assert 'vfadmin' in title + + # 检查登录表单元素是否存在 + username_input = await page.query_selector('input[placeholder="账号"]') + password_input = await page.query_selector('input[placeholder="密码"]') + + assert username_input is not None + assert password_input is not None + + await browser.close() + + +@pytest.mark.asyncio +async def test_captcha_generation() -> None: + """测试验证码是否正常生成(在测试环境中,验证码已禁用,但仍应能访问登录页面)""" + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + page = await browser.new_page() + + # 访问登录页面 + await page.goto(Config.frontend_url + '/login') + + # 在测试环境中验证码已禁用,但仍应能访问登录页面 + title = await page.title() + assert 'vfadmin' in title + + await browser.close() + + +def test_login_without_captcha() -> None: + """测试在禁用验证码的情况下登录流程""" + helper = LoginHelper() + + # 尝试登录(测试环境中验证码已禁用) + token = helper.login(username='admin', password='admin123') + + # 验证登录结果 + assert token is not None, '登录应该成功' + assert len(token) > 0, '应该返回有效的token' + + +@pytest.mark.asyncio +async def test_login_flow_with_playwright() -> None: + """使用Playwright测试完整的登录流程(测试环境中验证码已禁用)""" + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + page = await browser.new_page() + + # 访问登录页面 + await page.goto(Config.frontend_url + '/login') + + # 等待页面加载 + await page.wait_for_selector('input[placeholder="账号"]') + + # 输入用户名和密码 + await page.fill('input[placeholder="账号"]', 'admin') + await page.fill('input[placeholder="密码"]', 'admin123') + + # 在测试环境中验证码已禁用,所以不需要处理验证码 + # 直接点击登录按钮 + # 尝试多种可能的选择器 + try: + await page.click('button:has-text("登录")') + except Exception: + try: + await page.click('button[type="submit"]') + except Exception: + await page.click('button.el-button') + + # 等待页面跳转或检查登录结果 + try: + # 等待跳转到主页或检查登录成功消息 + await page.wait_for_url('**/index**', timeout=10000) + success = True + except Exception: + # 检查是否有错误消息 + error_message = await page.query_selector('.el-message') + if error_message: + error_text = await error_message.text_content() + print(f'登录失败: {error_text}') + success = False + else: + success = False + + assert success, '登录应该成功' + + await browser.close() + + +@pytest.mark.asyncio +async def test_protected_routes_require_auth() -> None: + """测试受保护的路由需要认证""" + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + page = await browser.new_page() + + # 直接访问受保护的页面(如用户管理) + await page.goto(Config.frontend_url + '/system/user') + + # 检查是否被重定向到登录页面 + current_url = page.url + + # 检查页面是否包含登录相关的元素(如账号密码输入框) + try: + has_username_input = await page.is_visible('input[placeholder*="账号" i], input[placeholder*="username" i]') + except Exception: + has_username_input = False + + try: + has_password_input = await page.is_visible('input[placeholder*="密码" i], input[placeholder*="password" i]') + except Exception: + has_password_input = False + + try: + has_login_button = await page.is_visible('button:has-text("登录"), button:has-text("Login"), .login-btn') + except Exception: + has_login_button = False + + # 检查URL是否包含login路径 + is_redirected_to_login = '/login' in current_url.lower() or '/#/login' in current_url + + # 断言:应该重定向到登录页面或页面包含登录相关元素 + assert is_redirected_to_login or has_username_input or has_password_input or has_login_button, ( + f'未登录用户访问受保护页面时,没有重定向到登录页。当前URL: {current_url}, 页面内容: {await page.content()}' + ) + + await browser.close() + + +@pytest.mark.asyncio +async def test_authenticated_access() -> None: + """测试认证后的访问""" + # 首先通过API登录获取token + helper = LoginHelper() + token = helper.login(username='admin', password='admin123') + + assert token is not None, '登录应该成功' + + # 使用Playwright测试带认证的访问 + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + context = await browser.new_context( + storage_state={ # 使用storage state来保持登录状态 + 'cookies': [ + { + 'name': 'Admin-Token', + 'value': token, + 'domain': 'localhost', + 'path': '/', + 'httpOnly': False, + 'secure': False, + 'sameSite': 'Lax', + } + ], + 'origins': [], + } + ) + page = await context.new_page() + + # 访问受保护的页面 + await page.goto(Config.frontend_url + '/system/user') + + # 检查是否能够访问受保护的页面(而不是被重定向到登录页) + current_url = page.url + assert '/login' not in current_url, '已登录用户应该能够访问受保护页面' + + # 检查页面是否包含用户管理相关的元素 + try: + # 等待页面加载 + await page.wait_for_selector('div:has-text("用户管理")', timeout=10000) + has_user_management = True + except Exception: + has_user_management = False + + # 或者检查是否有表格或其他用户管理组件 + table_element = await page.query_selector('el-table') + if not has_user_management and table_element: + has_user_management = True + + assert has_user_management, '应该能够访问用户管理页面' + + await context.close() + await browser.close() diff --git a/shierfeng-fastapi-test/test_pages.py b/shierfeng-fastapi-test/test_pages.py new file mode 100644 index 0000000..4172ef4 --- /dev/null +++ b/shierfeng-fastapi-test/test_pages.py @@ -0,0 +1,119 @@ +import pytest +from playwright.async_api import async_playwright + +from common.config import Config +from common.login_helper import LoginHelper + + +@pytest.mark.asyncio +async def test_dashboard_page() -> None: + """测试仪表盘页面""" + # 首先登录获取token + helper = LoginHelper() + token = helper.login(username='admin', password='admin123') + assert token is not None, '登录应该成功' + + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + context = await browser.new_context() + # 设置认证token + await context.add_cookies( + [ + { + 'name': 'Admin-Token', + 'value': token, + 'domain': 'localhost', + 'path': '/', + 'httpOnly': False, + 'secure': False, + } + ] + ) + page = await context.new_page() + + # 访问仪表盘页面 + await page.goto(Config.frontend_url + '/index') + + # 检查页面是否包含仪表盘相关元素 + await page.wait_for_selector('div:has-text("首页")', timeout=10000) + title = await page.inner_text('div:has-text("首页")') + assert '首页' in title + + await context.close() + await browser.close() + + +@pytest.mark.asyncio +async def test_druid_page() -> None: + """测试数据监控页面""" + # 首先登录获取token + helper = LoginHelper() + token = helper.login(username='admin', password='admin123') + assert token is not None, '登录应该成功' + + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + context = await browser.new_context() + # 设置认证token + await context.add_cookies( + [ + { + 'name': 'Admin-Token', + 'value': token, + 'domain': 'localhost', + 'path': '/', + 'httpOnly': False, + 'secure': False, + } + ] + ) + page = await context.new_page() + + # 访问数据库监控页面 + await page.goto(Config.frontend_url + '/monitor/druid') + + # 检查页面是否包含缓存监控相关元素 + await page.wait_for_selector('div:has-text("数据监控")', timeout=10000) + title = await page.inner_text('div:has-text("数据监控")') + assert '数据监控' in title + + await context.close() + await browser.close() + + +@pytest.mark.asyncio +async def test_build_page() -> None: + """测试表单构建页面""" + # 首先登录获取token + helper = LoginHelper() + token = helper.login(username='admin', password='admin123') + assert token is not None, '登录应该成功' + + async with async_playwright() as p: + browser = await p.chromium.launch(headless=True) + context = await browser.new_context() + # 设置认证token + await context.add_cookies( + [ + { + 'name': 'Admin-Token', + 'value': token, + 'domain': 'localhost', + 'path': '/', + 'httpOnly': False, + 'secure': False, + } + ] + ) + page = await context.new_page() + + # 访问数据库监控页面 + await page.goto(Config.frontend_url + '/tool/build') + + # 检查页面是否包含缓存监控相关元素 + await page.wait_for_selector('div:has-text("Form Generator")', timeout=10000) + title = await page.inner_text('div:has-text("Form Generator")') + assert '表单构建' in title + + await context.close() + await browser.close() diff --git a/shierfeng-fastapi-test/tool/__init__.py b/shierfeng-fastapi-test/tool/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/shierfeng-fastapi-test/tool/test_code_gen.py b/shierfeng-fastapi-test/tool/test_code_gen.py new file mode 100644 index 0000000..7678b8a --- /dev/null +++ b/shierfeng-fastapi-test/tool/test_code_gen.py @@ -0,0 +1,228 @@ +import re + +import pytest +from playwright.async_api import async_playwright, expect + +from common.base_page_test import BasePageTest +from common.config import Config + + +class GenTableTest(BasePageTest): + """代码生成业务测试""" + + async def test_gen_code_flow(self) -> None: + """测试代码生成全流程:导入 -> 编辑 -> 预览 -> 删除""" + table_name = 'sys_post' + + # 1. 导航到代码生成页面 + await self.navigate_to_gen_page() + + # 确保环境清理 (如果存在 sys_post 则先删除) + await self.ensure_table_not_exists(table_name) + + # 2. 导入表 + await self.import_table(table_name) + + # 3. 编辑表 + await self.edit_table(table_name, '测试生成') + + # 4. 预览代码 + await self.preview_code(table_name) + await self.page.wait_for_timeout(1000) + + # 5. 删除表 (清理环境) + await self.delete_table(table_name) + + async def navigate_to_gen_page(self) -> None: + """导航到代码生成页面""" + await self.goto_page(Config.frontend_url + '/tool/gen') + await self.wait_for_selector('.app-container') + + async def ensure_table_not_exists(self, table_name: str) -> None: + """确保表不存在 (如果存在则删除)""" + await self.delete_table(table_name, verify=False) + + async def search_table(self, table_name: str) -> None: + """搜索表""" + # 确保在主搜索表单中搜索 + search_form = self.page.locator('.el-form').first + await search_form.get_by_role('textbox', name='表名称').fill(table_name) + await search_form.get_by_role('button', name='搜索').click() + # 等待加载 + loading = self.page.locator('.el-loading-mask') + if await loading.count() > 0: + await expect(loading.first).to_be_hidden(timeout=10000) + await self.page.wait_for_timeout(300) + + async def import_table(self, table_name: str) -> None: + """导入表""" + await self.page.get_by_role('button', name='导入').click() + + dialog = self.page.locator("div[role='dialog'][aria-label='导入表']") + await dialog.wait_for() + + # 搜索要导入的表 + await dialog.get_by_placeholder('请输入表名称').fill(table_name) + await dialog.get_by_role('button', name='搜索').click() + + # 等待搜索结果 + await dialog.locator(f"tr:has-text('{table_name}')").wait_for() + + # 选中行 + row = dialog.locator('tr').filter(has=self.page.get_by_text(table_name, exact=True)) + + # 点击复选框 + checkbox = row.locator('.el-checkbox') + await checkbox.click() + + # 验证已选中 + # Element Plus checkbox 选中时,最外层 label.el-checkbox 会有 is-checked 类 + await expect(checkbox).to_have_class(re.compile(r'is-checked')) + + await self.page.wait_for_timeout(500) + + await dialog.get_by_role('button', name='确 定').click() + + # 检查是否有"请选择要导入的表"错误 + try: + await expect(self.page.get_by_text('请选择要导入的表')).to_be_visible(timeout=2000) + print("ERROR: Selection failed, '请选择要导入的表' appeared.") + except AssertionError: + pass + + # 等待一会,让弹窗自动关闭 + await self.page.wait_for_timeout(5000) + + # 如果弹窗还在,尝试关闭它以免阻塞后续操作 + if await dialog.is_visible(): + print('WARNING: Import dialog still visible after timeout. Forcing close.') + # Check for error messages + if await self.page.locator('.el-message--error').count() > 0: + msg = await self.page.locator('.el-message--error').all_inner_texts() + print(f'ERROR MESSAGE: {msg}') + + # 点击取消关闭弹窗 + await dialog.get_by_role('button', name='取 消').click() + await expect(dialog).to_be_hidden() + + # 手动刷新列表 + await self.page.get_by_role('button', name='搜索').click() + + # 验证导入成功 (搜索并在列表中看到) + # 使用 .app-container 限定在主页面表格,避免匹配到弹窗中的隐藏行 + await self.search_table(table_name) + row = self.page.locator('.app-container .el-table__body-wrapper tbody tr').filter( + has=self.page.get_by_text(table_name, exact=True) + ) + for _i in range(5): + try: + await expect(row.first).to_be_visible(timeout=3000) + break + except AssertionError: + await self.search_table(table_name) + await expect(row.first).to_be_visible(timeout=5000) + + async def edit_table(self, table_name: str, remark: str) -> None: + """编辑表""" + await self.search_table(table_name) + row = self.page.locator(f"tbody tr:has-text('{table_name}')") + + # 点击编辑 (操作列第2个按钮,索引1) + # 按钮顺序: 预览, 编辑, 删除, 同步, 生成 + await row.locator('button').nth(1).click() + + # 等待编辑页面 (tab页) + await self.page.wait_for_selector("div[role='tablist']") + + # 修改基本信息 -> 表描述 + # 确保在基本信息 Tab + await self.page.get_by_text('基本信息').click() + await self.page.get_by_role('textbox', name='表描述').fill(remark) + + # 提交 + await self.page.get_by_role('button', name='提交').click() + + # 验证回到列表 + await self.wait_for_selector('.app-container') + # 验证描述已更新 + await self.search_table(table_name) + await self.wait_for_selector(f"tbody tr:has-text('{remark}')") + + async def preview_code(self, table_name: str) -> None: + """预览代码""" + await self.search_table(table_name) + row = self.page.locator(f"tbody tr:has-text('{table_name}')") + + # 点击预览 (操作列第1个按钮,索引0) + await row.locator('button').nth(0).click() + + # 等待预览弹窗 + dialog = self.page.locator("div[role='dialog'][aria-label='代码预览']") + await dialog.wait_for() + + # 验证存在代码内容 + # pre 可能有多个(多tab),只检查可见的 + await dialog.locator('pre:visible').first.wait_for() + content = await dialog.locator('pre:visible').first.text_content() + assert 'class' in content or 'import' in content or 'package' in content + + # 关闭预览 (点击右上角关闭按钮) + await dialog.locator('.el-dialog__headerbtn').click() + + async def delete_table(self, table_name: str, verify: bool = True) -> None: + """删除表 (支持删除多条重复数据)""" + # 循环删除直到不存在 + for _i in range(5): + await self.search_table(table_name) + # 使用 strict matching + # 限制在 .app-container .el-table__body-wrapper 以避免固定列导致的重复 以及 避免匹配到弹窗中的行 + row = self.page.locator('.app-container .el-table__body-wrapper tbody tr').filter( + has=self.page.get_by_text(table_name, exact=True) + ) + + count = await row.count() + + if count == 0: + break + + # 针对第一行操作 + # 使用 force=True 确保点击,防止遮挡 + btns = row.first.locator('button') + await btns.nth(2).click(force=True) + + # 处理确认弹窗 + await self.page.get_by_role('button', name='确定').click() + + # 等待删除成功提示 + # 使用 specific selector 避免匹配到代码预览中的文本 + await expect(self.page.locator('.el-message__content').filter(has_text='删除成功')).to_be_visible( + timeout=5000 + ) + + # 等待提示消失,防止干扰下一次操作 + await expect(self.page.locator('.el-message__content').filter(has_text='删除成功')).to_be_hidden( + timeout=5000 + ) + + if verify: + # 验证删除成功 + # 重新搜索验证不存在 + await self.search_table(table_name) + # 使用 strict matching + row = self.page.locator('.app-container .el-table__body-wrapper tbody tr').filter( + has=self.page.get_by_text(table_name, exact=True) + ) + # 期望找不到或者 count为0 + await expect(row).to_have_count(0) + + +@pytest.mark.asyncio +async def test_gen_table_page() -> None: + """测试代码生成页面功能""" + async with async_playwright() as p: + test_instance = GenTableTest() + await test_instance.setup(p) + try: + await test_instance.test_gen_code_flow() + finally: + await test_instance.teardown() diff --git a/shierfeng-fastapi-test/tool/test_swagger.py b/shierfeng-fastapi-test/tool/test_swagger.py new file mode 100644 index 0000000..1a86d6b --- /dev/null +++ b/shierfeng-fastapi-test/tool/test_swagger.py @@ -0,0 +1,38 @@ +import pytest +from playwright.async_api import async_playwright, expect + +from common.base_page_test import BasePageTest +from common.config import Config + + +class SwaggerTest(BasePageTest): + async def check_swagger_interface(self) -> None: + """测试系统接口页面 (Swagger UI)""" + + # 1. 直接导航到系统接口页面 + await self.goto_page(Config.frontend_url + '/tool/swagger') + + # 2. 验证页面加载 + # 等待 iframe 出现 + iframe = self.page.locator('iframe') + await expect(iframe).to_be_visible() + + # 获取 iframe 内容框架 + frame = self.page.frame_locator('iframe') + + # 后端未禁用Swagger时,验证 iframe 内部的标题包含 "ShiErFeng-FastAPI" + # 当前生产环境已默认禁用Swagger,此处验证标题是否包含默认禁用提示 + h1_locator = frame.locator('h1') + await expect(h1_locator).to_contain_text('Swagger UI has been disabled. Please enable it first.', timeout=15000) + + +@pytest.mark.asyncio +async def test_swagger_page() -> None: + """测试系统接口页面功能""" + async with async_playwright() as p: + test_instance = SwaggerTest() + await test_instance.setup(p) + try: + await test_instance.check_swagger_interface() + finally: + await test_instance.teardown()