feat: 新增租户、客户和令牌模块及相关功能

refactor: 重构用户、角色、部门等模块的字段长度和校验逻辑

fix: 修复前端接口类型定义和字段显示问题

style: 优化代码格式和注释

perf: 提升数据库连接性能和查询效率

docs: 更新README和配置文档

test: 添加字段校验和数据库连接测试

chore: 更新依赖包和配置文件
This commit is contained in:
zhangtao
2025-12-21 23:14:02 +08:00
parent 33cf047c93
commit fb592d4f1b
71 changed files with 6274 additions and 209 deletions
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
@@ -0,0 +1,148 @@
# -*- coding: utf-8 -*-
from fastapi import APIRouter, Body, Depends, Path, UploadFile
from fastapi.responses import JSONResponse, StreamingResponse
import urllib.parse
from app.common.response import StreamResponse, SuccessResponse
from app.core.router_class import OperationLogRoute
from app.utils.common_util import bytes2file_response
from app.core.base_params import PaginationQueryParam
from app.core.dependencies import AuthPermission
from app.core.base_schema import BatchSetAvailable
from app.core.logger import log
from app.api.v1.module_system.auth.schema import AuthSchema
from .service import TokenService
from .schema import (
TokenCreateSchema,
TokenUpdateSchema,
TokenQueryParam
)
TokenRouter = APIRouter(route_class=OperationLogRoute, prefix="/token", tags=["令牌模块"])
@TokenRouter.get("/detail/{id}", summary="获取令牌详情", description="获取令牌详情")
async def get_obj_detail_controller(
id: int = Path(..., description="令牌ID"),
auth: AuthSchema = Depends(AuthPermission(["module_system:demo:query"]))
) -> JSONResponse:
"""
获取示例详情
参数:
- id (int): 示例ID
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含示例详情的JSON响应
"""
result_dict = await TokenService.detail_service(id=id, auth=auth)
log.info(f"获取令牌详情成功 {id}")
return SuccessResponse(data=result_dict, msg="获取令牌详情成功")
@TokenRouter.get("/list", summary="查询令牌列表", description="查询令牌列表")
async def get_obj_list_controller(
page: PaginationQueryParam = Depends(),
search: TokenQueryParam = Depends(),
auth: AuthSchema = Depends(AuthPermission(["module_system:token:query"]))
) -> JSONResponse:
"""
查询令牌列表
参数:
- page (PaginationQueryParam): 分页查询参数
- search (TokenQueryParam): 查询参数
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含令牌列表分页信息的JSON响应
"""
# 使用数据库分页而不是应用层分页
result_dict = await TokenService.page_service(
auth=auth,
page_no=page.page_no,
page_size=page.page_size,
search=search,
order_by=page.order_by
)
log.info("查询令牌列表成功")
return SuccessResponse(data=result_dict, msg="查询令牌列表成功")
@TokenRouter.post("/create", summary="创建令牌", description="创建令牌")
async def create_obj_controller(
data: TokenCreateSchema,
auth: AuthSchema = Depends(AuthPermission(["module_system:token:create"]))
) -> JSONResponse:
"""
创建令牌
参数:
- data (TokenCreateSchema): 令牌创建模型
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含创建令牌详情的JSON响应
"""
result_dict = await TokenService.create_service(auth=auth, data=data)
log.info(f"创建令牌成功: {result_dict.get('name')}")
return SuccessResponse(data=result_dict, msg="创建令牌成功")
@TokenRouter.put("/update/{id}", summary="修改令牌", description="修改令牌")
async def update_obj_controller(
data: TokenUpdateSchema,
id: int = Path(..., description="令牌ID"),
auth: AuthSchema = Depends(AuthPermission(["module_system:token:update"]))
) -> JSONResponse:
"""
修改令牌
参数:
- data (TokenUpdateSchema): 令牌更新模型
- id (int): 令牌ID
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含修改令牌详情的JSON响应
"""
result_dict = await TokenService.update_service(auth=auth, id=id, data=data)
log.info(f"修改令牌成功: {result_dict.get('name')}")
return SuccessResponse(data=result_dict, msg="修改令牌成功")
@TokenRouter.delete("/delete", summary="删除令牌", description="删除令牌")
async def delete_obj_controller(
ids: list[int] = Body(..., description="ID列表"),
auth: AuthSchema = Depends(AuthPermission(["module_system:token:delete"]))
) -> JSONResponse:
"""
删除令牌
参数:
- ids (list[int]): 令牌ID列表
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含删除令牌详情的JSON响应
"""
await TokenService.delete_service(auth=auth, ids=ids)
log.info(f"删除令牌成功: {ids}")
return SuccessResponse(msg="删除令牌成功")
@TokenRouter.patch("/available/setting", summary="批量修改令牌状态", description="批量修改令牌状态")
async def batch_set_available_obj_controller(
data: BatchSetAvailable,
auth: AuthSchema = Depends(AuthPermission(["module_system:token:patch"]))
) -> JSONResponse:
"""
批量修改令牌状态
参数:
- data (BatchSetAvailable): 批量修改令牌状态模型
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含批量修改令牌状态详情的JSON响应
"""
await TokenService.set_available_service(auth=auth, data=data)
log.info(f"批量修改令牌状态成功: {data.ids}")
return SuccessResponse(msg="批量修改令牌状态成功")
@@ -0,0 +1,124 @@
# -*- coding: utf-8 -*-
from collections.abc import Sequence
from app.core.base_crud import CRUDBase
from app.api.v1.module_system.auth.schema import AuthSchema
from .model import TokenModel
from .schema import TokenCreateSchema, TokenUpdateSchema, TokenOutSchema
class TokenCRUD(CRUDBase[TokenModel, TokenCreateSchema, TokenUpdateSchema]):
"""令牌数据层"""
def __init__(self, auth: AuthSchema) -> None:
"""
初始化CRUD数据层
参数:
- auth (AuthSchema): 认证信息模型
"""
super().__init__(model=TokenModel, auth=auth)
async def get_by_id_crud(self, id: int, preload: list[str] | None = None) -> TokenModel | None:
"""
详情
参数:
- id (int): 令牌ID
- preload (list[str] | None): 预加载关系,未提供时使用模型默认项
返回:
- TokenModel | None: 令牌模型实例或None
"""
return await self.get(id=id, preload=preload)
async def list_crud(self, search: dict | None = None, order_by: list[dict] | None = None, preload: list[str] | None = None) -> Sequence[TokenModel]:
"""
列表查询
参数:
- search (dict | None): 查询参数
- order_by (list[dict] | None): 排序参数
- preload (list[str] | None): 预加载关系,未提供时使用模型默认项
返回:
- Sequence[DemoModel]: 示例模型实例序列
"""
return await self.list(search=search, order_by=order_by, preload=preload)
async def create_crud(self, data: TokenCreateSchema) -> TokenModel | None:
"""
创建
参数:
- data (TokenCreateSchema): 令牌创建模型
返回:
- TokenModel | None: 令牌模型实例或None
"""
return await self.create(data=data)
async def update_crud(self, id: int, data: TokenUpdateSchema) -> TokenModel | None:
"""
更新
参数:
- id (int): 令牌ID
- data (TokenUpdateSchema): 令牌更新模型
返回:
- TokenModel | None: 令牌模型实例或None
"""
return await self.update(id=id, data=data)
async def delete_crud(self, ids: list[int]) -> None:
"""
批量删除
参数:
- ids (list[int]): 令牌ID列表
返回:
- None
"""
return await self.delete(ids=ids)
async def set_available_crud(self, ids: list[int], status: str) -> None:
"""
批量设置可用状态
参数:
- ids (list[int]): 令牌ID列表
- status (str): 可用状态
返回:
- None
"""
return await self.set(ids=ids, status=status)
async def page_crud(self, offset: int, limit: int, order_by: list[dict] | None = None, search: dict | None = None, preload: list | None = None) -> dict:
"""
分页查询
参数:
- offset (int): 偏移量
- limit (int): 每页数量
- order_by (list[dict] | None): 排序参数
- search (dict | None): 查询参数
- preload (list | None): 预加载关系,未提供时使用模型默认项
返回:
- dict: 分页数据
"""
order_by_list = order_by or [{'id': 'asc'}]
search_dict = search or {}
return await self.page(
offset=offset,
limit=limit,
order_by=order_by_list,
search=search_dict,
out_schema=TokenOutSchema,
preload=preload
)
@@ -0,0 +1,17 @@
# -*- coding: utf-8 -*-
from sqlalchemy import String
from sqlalchemy.orm import Mapped, mapped_column
from app.core.base_model import ModelMixin, UserMixin
class TokenModel(ModelMixin, UserMixin):
"""
令牌表
"""
__tablename__: str = 'sys_token'
__table_args__: dict[str, str] = ({'comment': '令牌表'})
__loader_options__: list[str] = ["created_by", "updated_by"]
name: Mapped[str | None] = mapped_column(String(64), nullable=True, default='', comment='名称')
@@ -0,0 +1,82 @@
# -*- coding: utf-8 -*-
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
from fastapi import Query
from app.core.base_schema import BaseSchema, UserBySchema
from app.core.validator import DateTimeStr
class TokenCreateSchema(BaseModel):
"""新增模型"""
name: str = Field(..., description='名称')
status: str = Field(default="0", description="是否启用(0:启用 1:禁用)")
description: str | None = Field(default=None, description="描述")
@field_validator('name')
@classmethod
def validate_name(cls, v: str) -> str:
"""验证名称字段的格式和内容"""
# 去除首尾空格
v = v.strip()
if not v:
raise ValueError('名称不能为空')
return v
@model_validator(mode='after')
def _after_validation(self):
"""
核心业务规则校验
"""
# 长度校验:名称最小长度
if len(self.name) < 2 or len(self.name) > 50:
raise ValueError('名称长度必须在2-50个字符之间')
# 格式校验:名称只能包含字母、数字、下划线和中划线
if not self.name.isalnum() and not all(c in '-_' for c in self.name):
raise ValueError('名称只能包含字母、数字、下划线和中划线')
if self.status not in ["0", "1"]:
raise ValueError('是否启用必须为0或1')
# 描述校验:描述最大长度
if self.description and len(self.description) > 255:
raise ValueError('描述长度不能超过255个字符')
return self
class TokenUpdateSchema(TokenCreateSchema):
"""更新模型"""
...
class TokenOutSchema(TokenCreateSchema, BaseSchema, UserBySchema):
"""响应模型"""
model_config = ConfigDict(from_attributes=True)
class TokenQueryParam:
"""令牌查询参数"""
def __init__(
self,
name: str | None = Query(None, description="名称"),
description: str | None = Query(None, description="描述"),
status: str | None = Query(None, description="是否启用"),
created_time: list[DateTimeStr] | None = Query(None, description="创建时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
updated_time: list[DateTimeStr] | None = Query(None, description="更新时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
created_id: int | None = Query(None, description="创建人"),
updated_id: int | None = Query(None, description="更新人")
) -> None:
# 模糊查询字段
self.name = ("like", name)
if description:
self.description = ("like", description)
# 精确查询字段
if status:
self.status = ("eq", status)
# 时间范围查询
if created_time and len(created_time) == 2:
self.created_time = ("between", (created_time[0], created_time[1]))
if updated_time and len(updated_time) == 2:
self.updated_time = ("between", (updated_time[0], updated_time[1]))
@@ -0,0 +1,312 @@
# -*- coding: utf-8 -*-
import io
from typing import Any
from fastapi import UploadFile
import pandas as pd
from app.core.base_schema import BatchSetAvailable
from app.core.exceptions import CustomException
from app.utils.excel_util import ExcelUtil
from app.core.logger import log
from app.api.v1.module_system.auth.schema import AuthSchema
from .schema import TokenCreateSchema, TokenUpdateSchema, TokenOutSchema, TokenQueryParam
from .crud import TokenCRUD
class TokenService:
"""
令牌管理模块服务层
"""
@classmethod
async def detail_service(cls, auth: AuthSchema, id: int) -> dict:
"""
详情
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 令牌ID
返回:
- dict: 令牌模型实例字典
"""
obj = await TokenCRUD(auth).get_by_id_crud(id=id)
if not obj:
raise CustomException(msg="该数据不存在")
return TokenOutSchema.model_validate(obj).model_dump()
@classmethod
async def list_service(cls, auth: AuthSchema, search: TokenQueryParam | None = None, order_by: list[dict[str, str]] | None = None) -> list[dict]:
"""
列表查询
参数:
- auth (AuthSchema): 认证信息模型
- search (TokenQueryParam | None): 查询参数
- order_by (list[dict[str, str]] | None): 排序参数
返回:
- list[dict]: 令牌模型实例字典列表
"""
search_dict = search.__dict__ if search else None
obj_list = await TokenCRUD(auth).list_crud(search=search_dict, order_by=order_by)
return [TokenOutSchema.model_validate(obj).model_dump() for obj in obj_list]
@classmethod
async def page_service(cls, auth: AuthSchema, page_no: int, page_size: int, search: TokenQueryParam | None = None, order_by: list[dict[str, str]] | None = None) -> dict:
"""
分页查询
参数:
- auth (AuthSchema): 认证信息模型
- page_no (int): 页码
- page_size (int): 每页数量
- search (TokenQueryParam | None): 查询参数
- order_by (list[dict[str, str]] | None): 排序参数
返回:
- dict: 分页数据
"""
search_dict = search.__dict__ if search else {}
order_by_list = order_by or [{'id': 'asc'}]
offset = (page_no - 1) * page_size
result = await TokenCRUD(auth).page_crud(
offset=offset,
limit=page_size,
order_by=order_by_list,
search=search_dict
)
return result
@classmethod
async def create_service(cls, auth: AuthSchema, data: TokenCreateSchema) -> dict:
"""
创建
参数:
- auth (AuthSchema): 认证信息模型
- data (TokenCreateSchema): 令牌创建模型
返回:
- dict: 令牌模型实例字典
"""
obj = await TokenCRUD(auth).get(name=data.name)
if obj:
raise CustomException(msg='创建失败,名称已存在')
obj = await TokenCRUD(auth).create_crud(data=data)
return TokenOutSchema.model_validate(obj).model_dump()
@classmethod
async def update_service(cls, auth: AuthSchema, id: int, data: TokenUpdateSchema) -> dict:
"""
更新
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 令牌ID
- data (TokenUpdateSchema): 令牌更新模型
返回:
- dict: 令牌模型实例字典
"""
# 检查数据是否存在
obj = await TokenCRUD(auth).get_by_id_crud(id=id)
if not obj:
raise CustomException(msg='更新失败,该数据不存在')
# 检查名称是否重复
exist_obj = await TokenCRUD(auth).get(name=data.name)
if exist_obj and exist_obj.id != id:
raise CustomException(msg='更新失败,名称重复')
obj = await TokenCRUD(auth).update_crud(id=id, data=data)
return TokenOutSchema.model_validate(obj).model_dump()
@classmethod
async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None:
"""
删除
参数:
- auth (AuthSchema): 认证信息模型
- ids (list[int]): 令牌ID列表
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg='删除失败,删除对象不能为空')
# 检查所有要删除的数据是否存在
for id in ids:
obj = await TokenCRUD(auth).get_by_id_crud(id=id)
if not obj:
raise CustomException(msg=f'删除失败,ID为{id}的数据不存在')
await TokenCRUD(auth).delete_crud(ids=ids)
@classmethod
async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None:
"""
批量设置状态
参数:
- auth (AuthSchema): 认证信息模型
- data (BatchSetAvailable): 批量设置状态模型
返回:
- None
"""
await TokenCRUD(auth).set_available_crud(ids=data.ids, status=data.status)
@classmethod
async def batch_export_service(cls, obj_list: list[dict[str, Any]]) -> bytes:
"""
批量导出
参数:
- obj_list (list[dict[str, Any]]): 令牌模型实例字典列表
返回:
- bytes: Excel文件字节流
"""
mapping_dict = {
'id': '编号',
'name': '名称',
'status': '状态',
'description': '备注',
'created_time': '创建时间',
'updated_time': '更新时间',
'created_id': '创建者',
}
# 复制数据并转换状态
data = obj_list.copy()
for item in data:
# 处理状态
item['status'] = '启用' if item.get('status') == '0' else '停用'
# 处理创建者
creator_info = item.get('created_id')
if isinstance(creator_info, dict):
item['created_id'] = creator_info.get('name', '未知')
else:
item['created_id'] = '未知'
return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict)
@classmethod
async def batch_import_service(cls, auth: AuthSchema, file: UploadFile, update_support: bool = False) -> str:
"""
批量导入
参数:
- auth (AuthSchema): 认证信息模型
- file (UploadFile): 上传的Excel文件
- update_support (bool): 是否支持更新存在数据
返回:
- str: 导入结果信息
"""
header_dict = {
'名称': 'name',
'状态': 'status',
'描述': 'description'
}
try:
# 读取Excel文件
contents = await file.read()
df = pd.read_excel(io.BytesIO(contents))
await file.close()
if df.empty:
raise CustomException(msg="导入文件为空")
# 检查表头是否完整
missing_headers = [header for header in header_dict.keys() if header not in df.columns]
if missing_headers:
raise CustomException(msg=f"导入文件缺少必要的列: {', '.join(missing_headers)}")
# 重命名列名
df.rename(columns=header_dict, inplace=True)
# 验证必填字段
required_fields = ['name', 'status']
errors = []
for field in required_fields:
missing_rows = df[df[field].isnull()].index.tolist()
if missing_rows:
field_name = [k for k,v in header_dict.items() if v == field][0]
rows_str = "、".join([str(i+1) for i in missing_rows])
errors.append(f"{field_name}不能为空,第{rows_str}行")
if errors:
raise CustomException(msg=f"导入失败,以下行缺少必要字段:\n{'; '.join(errors)}")
error_msgs = []
success_count = 0
count = 0
# 处理每一行数据
for index, row in df.iterrows():
count += 1
try:
# 数据转换前的类型检查
try:
status = True if row['status'] == '正常' else False
except ValueError:
error_msgs.append(f"第{count}行: 状态必须是'正常'或'停用'")
continue
# 构建用户数据
data = {
"name": str(row['name']),
"status": status,
"description": str(row['description']),
}
# 处理用户导入
exists_obj = await TokenCRUD(auth).get(name=data["name"])
if exists_obj:
if update_support:
await TokenCRUD(auth).update(id=exists_obj.id, data=data)
success_count += 1
else:
error_msgs.append(f"第{count}行: 对象 {data['name']} 已存在")
else:
await TokenCRUD(auth).create(data=data)
success_count += 1
except Exception as e:
error_msgs.append(f"第{count}行: {str(e)}")
continue
# 返回详细的导入结果
result = f"成功导入 {success_count} 条数据"
if error_msgs:
result += "\n错误信息:\n" + "\n".join(error_msgs)
return result
except Exception as e:
log.error(f"批量导入用户失败: {str(e)}")
raise CustomException(msg=f"导入失败: {str(e)}")
@classmethod
async def import_template_download_service(cls) -> bytes:
"""
下载导入模板
返回:
- bytes: Excel文件字节流
"""
header_list = ['名称', '状态', '描述']
selector_header_list = ['状态']
option_list = [{'状态': ['正常', '停用']}]
return ExcelUtil.get_excel_template(
header_list=header_list,
selector_header_list=selector_header_list,
option_list=option_list
)