{{ username }}，您好！
+请点击下方按钮重置密码（{{ expire_minutes }} 分钟内有效）：
+ 重置密码 +如果按钮无法点击，请复制以下链接到浏览器打开：
+ +如果非您本人操作，请忽略此邮件。
+这是一封测试邮件，SMTP 配置「{name}」连接成功！
发送时间：{time}
").format(name=config.name, time=datetime.now().strftime("%Y-%m-%d %H:%M:%S")) + subject = ("【FastapiAdmin】SMTP 连接测试") + body_html = ("这是一封测试邮件，SMTP 配置「{name}」连接成功！
" + "发送时间：{time}
").format(name=config.name, time=datetime.now().strftime("%Y-%m-%d %H:%M:%S")) try: await send_email( @@ -179,36 +104,20 @@ class EmailConfigService: class EmailTemplateService: - """ - 邮件模板服务 - """ - """邮件模板管理（仅超级管理员可操作）""" - @classmethod + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + @require_superadmin - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: EmailTemplateQueryParam | None = None, order_by: list | None = None, ) -> dict: - """ - 邮件模板分页查询 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页数量 - - search (EmailTemplateQueryParam | None): 查询参数 - - order_by (list | None): 排序参数 - - 返回: - - dict: 分页数据 - """ - return await EmailTemplateCRUD(auth).page( + return await EmailTemplateCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -216,99 +125,39 @@ class EmailTemplateService: out_schema=EmailTemplateOutSchema, ) - @classmethod @require_superadmin - async def detail_service(cls, auth: AuthSchema, id: int) -> EmailTemplateOutSchema: - """ - 邮件模板详情 + async def detail(self, id: int) -> EmailTemplateOutSchema: + return await EmailTemplateCRUD(self.auth).get_or_404(id=id, out_schema=EmailTemplateOutSchema, msg="邮件模板不存在") - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 邮件模板 ID - - 返回: - - EmailTemplateOutSchema: 邮件模板详情 - """ - return await EmailTemplateCRUD(auth).get_or_404(id=id, out_schema=EmailTemplateOutSchema, msg="邮件模板不存在") - - @classmethod @require_superadmin - async def create_service(cls, auth: AuthSchema, data: EmailTemplateCreateSchema) -> EmailTemplateOutSchema: - """ - 创建邮件模板 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (EmailTemplateCreateSchema): 邮件模板创建模型 - - 返回: - - EmailTemplateOutSchema: 新创建的邮件模板 - """ - existing = await EmailTemplateCRUD(auth).get_by_code(template_code=data.template_code) + async def create(self, data: EmailTemplateCreateSchema) -> EmailTemplateOutSchema: + existing = await EmailTemplateCRUD(self.auth).get_by_code(template_code=data.template_code) if existing: raise CustomException(msg=f"模板编码「{data.template_code}」已存在") - obj = await EmailTemplateCRUD(auth).create(data=data) + obj = await EmailTemplateCRUD(self.auth).create(data=data) return EmailTemplateOutSchema.model_validate(obj) - @classmethod @require_superadmin - async def update_service(cls, auth: AuthSchema, id: int, data: EmailTemplateUpdateSchema) -> EmailTemplateOutSchema: - """ - 更新邮件模板 - - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 邮件模板 ID - - data (EmailTemplateUpdateSchema): 邮件模板更新模型 - - 返回: - - EmailTemplateOutSchema: 更新后的邮件模板 - """ - _ = await EmailTemplateCRUD(auth).get_or_404(id=id, msg="邮件模板不存在") - - updated = await EmailTemplateCRUD(auth).update(id=id, data=data) + async def update(self, id: int, data: EmailTemplateUpdateSchema) -> EmailTemplateOutSchema: + _ = await EmailTemplateCRUD(self.auth).get_or_404(id=id, msg="邮件模板不存在") + updated = await EmailTemplateCRUD(self.auth).update(id=id, data=data) return EmailTemplateOutSchema.model_validate(updated) - @classmethod @require_superadmin - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除邮件模板 - - 参数: - - auth (AuthSchema): 认证信息模型 - - ids (list[int]): 邮件模板 ID 列表 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if not ids: raise CustomException(msg="删除对象不能为空") - await EmailTemplateCRUD(auth).delete(ids=ids) + await EmailTemplateCRUD(self.auth).delete(ids=ids) class EmailSendService: - """ - 邮件发送服务 - """ + """邮件发送服务 — 供其他模块调用""" + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - """ - 邮件发送服务 - """ - """ - 邮件发送服务 — 供其他模块调用。 - - 设计原则： - 1. 优先使用 is_default=True 的 SMTP 配置，无默认配置时降级为站内信（仅记录日志） - 2. 每次发送都写 platform_email_log - 3. 渲染失败/发送失败均记录 error_msg，不向调用方抛出异常（静默降级） - 4. 使用独立数据库会话：邮件发送失败不因调用方事务回滚而丢失日志 - """ - - @classmethod async def send_by_template( - cls, + self, *, to_email: str, template_code: str, @@ -318,25 +167,7 @@ class EmailSendService: tenant_id: int | None = None, config_id: int | None = None, ) -> bool: - """ - 通过模板发送邮件（核心方法，供内部调用）。 - - 参数: - - to_email (str): 收件人邮箱 - - template_code (str): 模板编码 - - variables (dict): 模板变量 - - biz_type (str): 业务类型 - - to_name (str | None): 收件人姓名 - - tenant_id (int | None): 租户 ID - - config_id (int | None): 指定 SMTP 配置 ID - - 返回: - - bool: True=发送成功，False=失败（已降级记录日志） - """ - # ① 获取模板（独立会话，不影响调用方事务） - async with async_db_session() as session: - auth = AuthSchema(db=session, check_data_scope=False) - template = await EmailTemplateCRUD(auth).get_active_by_code(template_code) + template = await EmailTemplateCRUD(self.auth).get_active_by_code(template_code) if not template: await EmailLogCRUD.create_log( @@ -351,7 +182,6 @@ class EmailSendService: ) return False - # ② 渲染主题 & 正文 try: rendered_subject = render_template(template.subject, variables) rendered_html = render_template(template.body_html, variables) @@ -369,13 +199,10 @@ class EmailSendService: ) return False - # ③ 获取 SMTP 配置（独立会话） - async with async_db_session() as session: - auth = AuthSchema(db=session, check_data_scope=False) - if config_id: - config = await EmailConfigCRUD(auth).get_active_by_id(config_id) - else: - config = await EmailConfigCRUD(auth).get_active_default() + if config_id: + config = await EmailConfigCRUD(self.auth).get_active_by_id(config_id) + else: + config = await EmailConfigCRUD(self.auth).get_active_default() if not config: await EmailLogCRUD.create_log( @@ -390,7 +217,6 @@ class EmailSendService: ) return False - # ④ 发送 try: await send_email( smtp_host=config.smtp_host, @@ -420,7 +246,6 @@ class EmailSendService: ) return False - # ⑤ 写成功日志 await EmailLogCRUD.create_log( config_id=config.id, template_code=template_code, @@ -434,19 +259,8 @@ class EmailSendService: return True - @classmethod - async def manual_send_service(cls, auth: AuthSchema, data: EmailSendSchema) -> dict: - """ - 超管手动触发发送（测试/补发用） - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (EmailSendSchema): 发送参数 - - 返回: - - dict: 发送结果 - """ - success = await cls.send_by_template( + async def manual_send(self, data: EmailSendSchema) -> dict: + success = await self.send_by_template( to_email=data.to_email, template_code=data.template_code, variables=data.variables, @@ -460,38 +274,19 @@ class EmailSendService: class EmailLogService: - """ - 邮件日志服务 - """ - - """ - 邮件日志服务 - """ """邮件日志查询""" - @classmethod - async def page_service( - cls, - auth: AuthSchema, + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def page( + self, page_no: int, page_size: int, search: EmailLogQueryParam | None = None, order_by: list | None = None, ) -> dict: - """ - 邮件发送日志分页查询 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页数量 - - search (EmailLogQueryParam | None): 查询参数 - - order_by (list | None): 排序参数 - - 返回: - - dict: 分页数据 - """ - return await EmailLogCRUD(auth).page( + return await EmailLogCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"created_time": "desc"}], diff --git a/backend/app/api/v1/module_platform/invoice/controller.py b/backend/app/api/v1/module_platform/invoice/controller.py index e1517bb7..4639bf2a 100644 --- a/backend/app/api/v1/module_platform/invoice/controller.py +++ b/backend/app/api/v1/module_platform/invoice/controller.py @@ -6,10 +6,8 @@ from fastapi.responses import JSONResponse from app.common.response import ResponseSchema, SuccessResponse from app.core.base_schema import AuthSchema, PageResultSchema from app.core.dependencies import AuthPermission -from app.core.exceptions import CustomException from app.core.router_class import OperationLogRoute -from .crud import InvoiceCRUD from .schema import ( InvoiceApplySchema, InvoiceIssueSchema, @@ -19,27 +17,16 @@ from .schema import ( ) from .service import InvoicePlatformService, InvoiceTenantService -TenantInvoiceRouter = APIRouter(prefix="/tenant/invoice", route_class=OperationLogRoute, tags=["发票管理"]) - +TenantInvoiceRouter = APIRouter(prefix="/tenant/invoice", route_class=OperationLogRoute, tags=["平台管理", "发票管理"]) @TenantInvoiceRouter.post("/apply", summary="申请开票", response_model=ResponseSchema[InvoiceOutSchema]) async def invoice_apply_controller( data: Annotated[InvoiceApplySchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["*:*:*"]))], ) -> JSONResponse: - """ - 申请开票 - - 参数: - - data (InvoiceApplySchema): 发票申请参数。 - - 返回: - - JSONResponse: 包含发票信息的 JSON 响应。 - """ result = await InvoiceTenantService.apply(auth, data, auth.tenant_id) return SuccessResponse(data=result, msg="发票申请成功") - @TenantInvoiceRouter.get("/list", summary="我的发票列表", response_model=ResponseSchema[PageResultSchema[InvoiceOutSchema]]) async def invoice_list_my_controller( auth: Annotated[AuthSchema, Depends(AuthPermission(["*:*:*"]))], @@ -48,18 +35,6 @@ async def invoice_list_my_controller( page_no: Annotated[int, Query(ge=1)] = 1, page_size: Annotated[int, Query(ge=1, le=100)] = 10, ) -> JSONResponse: - """ - 我的发票列表 - - 参数: - - invoice_type (str | None): 发票类型筛选。 - - status (int | None): 状态筛选。 - - page_no (int): 页码。 - - page_size (int): 每页条数。 - - 返回: - - JSONResponse: 包含分页发票列表的 JSON 响应。 - """ result = await InvoiceTenantService.list_my( auth, auth.tenant_id, @@ -67,35 +42,15 @@ async def invoice_list_my_controller( ) return SuccessResponse(data=result, msg="查询成功") - @TenantInvoiceRouter.get("/{id}/download", summary="下载发票PDF", response_model=ResponseSchema[dict]) async def invoice_download_controller( id: Annotated[int, Path(ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["*:*:*"]))], ) -> JSONResponse: - """ - 下载发票 PDF - - 参数: - - id (int): 发票 ID。 - - 返回: - - JSONResponse: 包含 PDF 下载地址的 JSON 响应。 - """ - crud = InvoiceCRUD(auth) - invoice = await crud.get_or_404(id=id, msg="发票不存在") - if hasattr(invoice, "tenant_id") and invoice.tenant_id != auth.tenant_id: - raise CustomException(msg="发票不存在") - if invoice.status != 1 or not invoice.pdf_url: - raise CustomException(msg="发票未开具或无PDF") - return SuccessResponse(msg="下载地址", data={"pdf_url": invoice.pdf_url}) - - -# ========== 平台端 API ========== - - -PlatformInvoiceRouter = APIRouter(prefix="/invoice", route_class=OperationLogRoute, tags=["发票管理"]) + pdf_url = await InvoiceTenantService.download(auth, id, auth.tenant_id) + return SuccessResponse(msg="下载地址", data={"pdf_url": pdf_url}) +PlatformInvoiceRouter = APIRouter(prefix="/invoice", route_class=OperationLogRoute, tags=["平台管理", "发票管理"]) @PlatformInvoiceRouter.get("/list", summary="全部发票列表", response_model=ResponseSchema[PageResultSchema[InvoiceOutSchema]]) async def invoice_list_all_controller( @@ -106,42 +61,18 @@ async def invoice_list_all_controller( page_no: Annotated[int, Query(ge=1)] = 1, page_size: Annotated[int, Query(ge=1, le=100)] = 10, ) -> JSONResponse: - """ - 全部发票列表（平台端） - - 参数: - - invoice_type (str | None): 发票类型筛选。 - - status (int | None): 状态筛选。 - - tenant_id (int | None): 租户 ID 筛选。 - - page_no (int): 页码。 - - page_size (int): 每页条数。 - - 返回: - - JSONResponse: 包含分页发票列表的 JSON 响应。 - """ result = await InvoicePlatformService.list_all( auth, InvoiceQueryParam(invoice_type=invoice_type, status=status, tenant_id=tenant_id, page_no=page_no, page_size=page_size), ) return SuccessResponse(data=result, msg="查询成功") - @PlatformInvoiceRouter.put("/issue/{id}", summary="开具发票", response_model=ResponseSchema[InvoiceOutSchema]) async def invoice_issue_controller( id: Annotated[int, Path(ge=1)], data: Annotated[InvoiceIssueSchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["*:*:*"]))], ) -> JSONResponse: - """ - 开具发票 - - 参数: - - id (int): 发票 ID。 - - data (InvoiceIssueSchema): 开票参数（PDF 链接等）。 - - 返回: - - JSONResponse: 包含发票信息的 JSON 响应。 - """ result = await InvoicePlatformService.issue( auth, id, @@ -150,22 +81,11 @@ async def invoice_issue_controller( ) return SuccessResponse(data=result, msg="发票开具成功") - @PlatformInvoiceRouter.put("/void/{id}", summary="作废发票", response_model=ResponseSchema[InvoiceOutSchema]) async def invoice_void_controller( id: Annotated[int, Path(ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["*:*:*"]))], data: Annotated[InvoiceVoidSchema, Body()] = InvoiceVoidSchema(), ) -> JSONResponse: - """ - 作废发票 - - 参数: - - id (int): 发票 ID。 - - data (InvoiceVoidSchema): 作废原因。 - - 返回: - - JSONResponse: 包含发票信息的 JSON 响应。 - """ result = await InvoicePlatformService.void(auth, id, data) return SuccessResponse(data=result, msg="发票已作废") diff --git a/backend/app/api/v1/module_platform/invoice/pdf_helper.py b/backend/app/api/v1/module_platform/invoice/pdf_helper.py index 54c846cd..c473b517 100644 --- a/backend/app/api/v1/module_platform/invoice/pdf_helper.py +++ b/backend/app/api/v1/module_platform/invoice/pdf_helper.py @@ -73,7 +73,7 @@ def _render_invoice_pdf(invoice: InvoiceOutSchema) -> str: output_dir = INVOICE_DIR / str(invoice.tenant_id) output_path = output_dir / f"{invoice.invoice_no}.pdf" generate_pdf_from_template( - template_name="invoice.html.j2", + template_name="invoice.jinja2", template_dir=TEMPLATE_DIR, variables=variables, output_path=output_path, diff --git a/backend/app/api/v1/module_platform/invoice/service.py b/backend/app/api/v1/module_platform/invoice/service.py index f516be38..61ede355 100644 --- a/backend/app/api/v1/module_platform/invoice/service.py +++ b/backend/app/api/v1/module_platform/invoice/service.py @@ -124,6 +124,17 @@ class InvoiceTenantService: ) + @classmethod + async def download(cls, auth: AuthSchema, invoice_id: int, tenant_id: int) -> str: + crud = InvoiceCRUD(auth) + invoice = await crud.get_or_404(id=invoice_id, msg="发票不存在") + if hasattr(invoice, "tenant_id") and invoice.tenant_id != tenant_id: + raise CustomException(msg="发票不存在") + if invoice.status != 1 or not invoice.pdf_url: + raise CustomException(msg="发票未开具或无PDF") + return invoice.pdf_url + + class InvoicePlatformService: """平台端发票服务""" diff --git a/backend/app/api/v1/module_platform/menu/controller.py b/backend/app/api/v1/module_platform/menu/controller.py index b8b3856d..7fe73575 100644 --- a/backend/app/api/v1/module_platform/menu/controller.py +++ b/backend/app/api/v1/module_platform/menu/controller.py @@ -13,7 +13,7 @@ from app.core.router_class import OperationLogRoute from .schema import MenuCreateSchema, MenuOutSchema, MenuQueryParam, MenuUpdateSchema from .service import MenuService -MenuRouter = APIRouter(route_class=OperationLogRoute, prefix="/menu", tags=["菜单管理"]) +MenuRouter = APIRouter(route_class=OperationLogRoute, prefix="/menu", tags=["平台管理", "菜单管理"]) _MENU_NS = "menu" @@ -28,18 +28,9 @@ async def get_menu_tree_controller( search: Annotated[MenuQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:query"]))], ) -> JSONResponse: - """ - 查询菜单树。 - - 参数: - - search (MenuQueryParam): 查询参数模型。 - - 返回: - - JSONResponse: 包含菜单树的 JSON 响应。 - """ order_by = [{"order": "asc"}] - result_dict_list = await MenuService.tree_service(search=search, auth=auth, order_by=order_by) - return SuccessResponse(data=result_dict_list, msg="查询菜单树成功") + result_dict_tree = await MenuService(auth).tree(search=search, order_by=order_by) + return SuccessResponse(data=result_dict_tree, msg="查询菜单树成功") @MenuRouter.get( @@ -51,16 +42,7 @@ async def get_obj_detail_controller( id: Annotated[int, Path(description="菜单ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:detail"]))], ) -> JSONResponse: - """ - 查询菜单详情。 - - 参数: - - id (int): 菜单ID。 - - 返回: - - JSONResponse: 包含菜单详情的 JSON 响应。 - """ - result_dict = await MenuService.detail_service(id=id, auth=auth) + result_dict = await MenuService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="查询菜单详情成功") @@ -73,16 +55,7 @@ async def create_obj_controller( data: MenuCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:create"]))], ) -> JSONResponse: - """ - 创建菜单。 - - 参数: - - data (MenuCreateSchema): 菜单创建模型。 - - 返回: - - JSONResponse: 包含创建菜单的 JSON 响应。 - """ - result_dict = await MenuService.create_service(data=data, auth=auth) + result_dict = await MenuService(auth).create(data=data) await FastAPICache.clear(namespace=_MENU_NS) return SuccessResponse(data=result_dict, msg="创建菜单成功") @@ -97,17 +70,7 @@ async def update_obj_controller( id: Annotated[int, Path(description="菜单ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:update"]))], ) -> JSONResponse: - """ - 修改菜单。 - - 参数: - - id (int): 菜单ID。 - - data (MenuUpdateSchema): 菜单更新模型。 - - 返回: - - JSONResponse: 包含修改菜单的 JSON 响应。 - """ - result_dict = await MenuService.update_service(id=id, data=data, auth=auth) + result_dict = await MenuService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_MENU_NS) return SuccessResponse(data=result_dict, msg="修改菜单成功") @@ -121,16 +84,7 @@ async def delete_obj_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:delete"]))], ) -> JSONResponse: - """ - 删除菜单。 - - 参数: - - ids (list[int]): 菜单ID列表。 - - 返回: - - JSONResponse: 包含删除菜单的 JSON 响应。 - """ - await MenuService.delete_service(ids=ids, auth=auth) + await MenuService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_MENU_NS) return SuccessResponse(msg="删除菜单成功") @@ -144,15 +98,6 @@ async def batch_set_available_obj_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:menu:patch"]))], ) -> JSONResponse: - """ - 批量修改菜单状态。 - - 参数: - - data (BatchSetAvailable): 批量修改菜单状态模型。 - - 返回: - - JSONResponse: 批量修改菜单状态的 JSON 响应。 - """ - await MenuService.set_available_service(data=data, auth=auth) + await MenuService(auth).set_available(data=data) await FastAPICache.clear(namespace=_MENU_NS) return SuccessResponse(msg="批量修改菜单状态成功") diff --git a/backend/app/api/v1/module_platform/menu/model.py b/backend/app/api/v1/module_platform/menu/model.py index 40127903..4756b71a 100644 --- a/backend/app/api/v1/module_platform/menu/model.py +++ b/backend/app/api/v1/module_platform/menu/model.py @@ -25,7 +25,7 @@ class MenuModel(ModelMixin): __table_args__: dict[str, str] = {"comment": "平台菜单表"} __tree_children_attr__: str = "children" __loader_options__: list[str] = ["roles", "children"] - __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.ROLE_BASED + __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.MENU_AUTH name: Mapped[str] = mapped_column(String(50), nullable=False, comment="菜单名称") type: Mapped[int] = mapped_column(Integer, nullable=False, default=2, comment="菜单类型(1:目录 2:菜单 3:按钮 4:链接)") diff --git a/backend/app/api/v1/module_platform/menu/service.py b/backend/app/api/v1/module_platform/menu/service.py index 39795b4b..d90be7a0 100644 --- a/backend/app/api/v1/module_platform/menu/service.py +++ b/backend/app/api/v1/module_platform/menu/service.py @@ -22,23 +22,19 @@ from .schema import ( class MenuService: - """ - 菜单管理服务（查询操作租户可见，写操作仅超级管理员可操作） - """ + """菜单管理服务（查询操作租户可见，写操作仅超级管理员可操作）""" - @classmethod - async def _validate_parent_child_type(cls, auth: AuthSchema, parent_id: int | None, child_type: int) -> None: - """ - 父子类型约束：目录下仅允许目录/菜单/外链；菜单下仅允许按钮；按钮与外链下不可挂子级。 - 无父级时仅允许目录、菜单、外链（与前端一致）。 - """ + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def _validate_parent_child_type(self, parent_id: int | None, child_type: int) -> None: if parent_id is None: if child_type is None: return if child_type not in (1, 2, 4): raise CustomException(msg="顶级菜单仅允许目录、菜单或外链类型") return - parent = await MenuCRUD(auth).get(id=parent_id) + parent = await MenuCRUD(self.auth).get(id=parent_id) if not parent: raise CustomException(msg="父级菜单不存在") pt = parent.type @@ -51,198 +47,113 @@ class MenuService: else: raise CustomException(msg="菜单或链接类型下不允许新增子菜单") - @classmethod - async def _validate_parent_child_client(cls, auth: AuthSchema, parent_id: int | None, client: str) -> None: - """子菜单终端须与父菜单一致。""" + async def _validate_parent_child_client(self, parent_id: int | None, client: str) -> None: if parent_id is None or client is None: return - parent = await MenuCRUD(auth).get(id=parent_id) + parent = await MenuCRUD(self.auth).get(id=parent_id) if not parent: return p_client = getattr(parent, "client", None) or "pc" if p_client != client: raise CustomException(msg="子菜单终端须与父菜单一致（均为 pc 或均为 app）") - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> MenuOutSchema: - """ - 获取菜单详情。 - - 参数: - - auth (AuthSchema): 认证对象。 - - id (int): 菜单ID。 - - 返回: - - MenuOutSchema: 菜单详情对象。 - """ - menu = await MenuCRUD(auth).get(id=id, preload=["roles"]) + async def detail(self, id: int) -> MenuOutSchema: + menu = await MenuCRUD(self.auth).get(id=id, preload=["roles"]) if not menu: raise CustomException(msg="菜单不存在") menu_out = MenuOutSchema.model_validate(menu) if menu.parent_id: - parent = await MenuCRUD(auth).get(id=menu.parent_id) + parent = await MenuCRUD(self.auth).get(id=menu.parent_id) if parent: menu_out.parent_name = parent.name return menu_out - @classmethod - async def tree_service( - cls, - auth: AuthSchema, + async def tree( + self, search: MenuQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[dict]: - """ - 获取菜单树形列表。 - - 参数: - - auth (AuthSchema): 认证对象。 - - search (MenuQueryParam | None): 查询参数对象。 - - order_by (list[dict] | None): 排序参数列表。 - - 返回: - - list[dict]: 菜单树形列表对象。 - """ - # 使用树形结构查询，预加载children关系 - menu_list = await MenuCRUD(auth).tree_list(search=vars(search) if search else None, order_by=order_by) - # 转换为字典列表（使用树形 Schema） + menu_list = await MenuCRUD(self.auth).tree_list(search=vars(search) if search else None, order_by=order_by) menu_dict_list = [MenuTreeOutSchema.model_validate(menu).model_dump() for menu in menu_list] - # 使用traversal_to_tree构建树形结构 return traversal_to_tree(menu_dict_list) - @classmethod @require_superadmin - async def create_service(cls, auth: AuthSchema, data: MenuCreateSchema) -> MenuOutSchema: - """ - 创建菜单。 - - 参数: - - auth (AuthSchema): 认证对象。 - - data (MenuCreateSchema): 创建参数对象。 - - 返回: - - MenuOutSchema: 创建的菜单对象。 - """ + async def create(self, data: MenuCreateSchema) -> MenuOutSchema: search: dict[str, Any] = {} if data.title is not None: search["title"] = data.title if data.parent_id is not None: search["parent_id"] = data.parent_id - menu = await MenuCRUD(auth).get(**search) + menu = await MenuCRUD(self.auth).get(**search) if menu: raise CustomException(msg="创建失败，该菜单已存在") - await cls._validate_parent_child_type(auth, data.parent_id, data.type) - await cls._validate_parent_child_client(auth, data.parent_id, data.client) + await self._validate_parent_child_type(data.parent_id, data.type) + await self._validate_parent_child_client(data.parent_id, data.client) - new_menu = await MenuCRUD(auth).create(data=data) + new_menu = await MenuCRUD(self.auth).create(data=data) return MenuOutSchema.model_validate(new_menu) - @classmethod @require_superadmin - async def update_service(cls, auth: AuthSchema, id: int, data: MenuUpdateSchema) -> MenuOutSchema: - """ - 更新菜单。 - - 参数: - - auth (AuthSchema): 认证对象。 - - id (int): 菜单ID。 - - data (MenuUpdateSchema): 更新参数对象。 - - 返回: - - MenuOutSchema: 更新的菜单对象。 - """ - _ = await MenuCRUD(auth).get_or_404(id=id, msg="更新失败，该菜单不存在") - await cls._validate_parent_child_type(auth, data.parent_id, data.type) - await cls._validate_parent_child_client(auth, data.parent_id, data.client) + async def update(self, id: int, data: MenuUpdateSchema) -> MenuOutSchema: + _ = await MenuCRUD(self.auth).get_or_404(id=id, msg="更新失败，该菜单不存在") + await self._validate_parent_child_type(data.parent_id, data.type) + await self._validate_parent_child_client(data.parent_id, data.client) if data.title is not None: search: dict[str, Any] = {"title": data.title} if data.parent_id is not None: search["parent_id"] = data.parent_id - exist_menu = await MenuCRUD(auth).get(**search) + exist_menu = await MenuCRUD(self.auth).get(**search) if exist_menu and exist_menu.id != id: raise CustomException(msg="更新失败，菜单标题重复") if data.parent_id: - parent_menu = await MenuCRUD(auth).get(id=data.parent_id) + parent_menu = await MenuCRUD(self.auth).get(id=data.parent_id) if not parent_menu: raise CustomException(msg="更新失败，父级菜单不存在") - new_menu = await MenuCRUD(auth).update(id=id, data=data) + new_menu = await MenuCRUD(self.auth).update(id=id, data=data) if data.status is not None: - await cls.set_available_service(auth=auth, data=BatchSetAvailable(ids=[id], status=data.status)) + await self.set_available(data=BatchSetAvailable(ids=[id], status=data.status)) menu_out = MenuOutSchema.model_validate(new_menu) if menu_out.parent_id: - parent = await MenuCRUD(auth).get(id=menu_out.parent_id) + parent = await MenuCRUD(self.auth).get(id=menu_out.parent_id) if parent: menu_out.parent_name = parent.name return menu_out - @classmethod @require_superadmin - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除菜单。 - - 参数: - - auth (AuthSchema): 认证对象。 - - ids (list[int]): 菜单ID列表。 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - # 获取所有菜单列表，用于构建树形关系 - all_menus = await MenuCRUD(auth).list() - - # 构建子菜单ID映射 + all_menus = await MenuCRUD(self.auth).list() child_id_map = get_child_id_map(model_list=all_menus) - # 收集所有需要删除的菜单ID，包括直接指定的ID和它们的所有子菜单ID delete_ids_set = set() - - for id in ids: - # 递归获取该ID的所有子菜单ID - all_descendants = get_child_recursion(id=id, id_map=child_id_map) + for mid in ids: + all_descendants = get_child_recursion(id=mid, id_map=child_id_map) delete_ids_set.update(all_descendants) - # 将集合转换为列表 delete_ids = list(delete_ids_set) + await MenuCRUD(self.auth).delete(ids=delete_ids) - # 执行批量删除操作 - await MenuCRUD(auth).delete(ids=delete_ids) - - @classmethod @require_superadmin - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: - """ - 递归获取所有父、子级菜单，然后批量修改菜单可用状态。 - - 参数: - - auth (AuthSchema): 认证对象。 - - data (BatchSetAvailable): 批量设置可用参数对象。 - - 返回: - - None - """ - menu_list = await MenuCRUD(auth).list() + async def set_available(self, data: BatchSetAvailable) -> None: + menu_list = await MenuCRUD(self.auth).list() total_ids = [] if data.status == 0: - # 激活，则需要把所有父级菜单都激活 id_map = get_parent_id_map(model_list=menu_list) for menu_id in data.ids: enable_ids = get_parent_recursion(id=menu_id, id_map=id_map) total_ids.extend(enable_ids) else: - # 禁止，则需要把所有子级菜单都禁止 id_map = get_child_id_map(model_list=menu_list) for menu_id in data.ids: disable_ids = get_child_recursion(id=menu_id, id_map=id_map) total_ids.extend(disable_ids) - await MenuCRUD(auth).set(ids=total_ids, status=data.status) + await MenuCRUD(self.auth).set(ids=total_ids, status=data.status) diff --git a/backend/app/api/v1/module_platform/order/controller.py b/backend/app/api/v1/module_platform/order/controller.py index fc116b6a..293dff06 100644 --- a/backend/app/api/v1/module_platform/order/controller.py +++ b/backend/app/api/v1/module_platform/order/controller.py @@ -28,16 +28,10 @@ from .schema import ( ) from .service import OrderService, PaymentService, RefundService -OrderRouter = APIRouter(route_class=OperationLogRoute, prefix="/order", tags=["订单管理"]) -PaymentRouter = APIRouter(route_class=OperationLogRoute, prefix="/payment", tags=["支付管理"]) -RefundRouter = APIRouter(route_class=OperationLogRoute, prefix="/refund", tags=["退款管理"]) -TenantOrderRouter = APIRouter(route_class=OperationLogRoute, prefix="/order", tags=["租户订单"]) - - -def _make_bare_auth(db: AsyncSession) -> AuthSchema: - """构造无用户上下文的 AuthSchema（支付回调等场景）""" - return AuthSchema(db=db, check_data_scope=False) - +OrderRouter = APIRouter(route_class=OperationLogRoute, prefix="/order", tags=["平台管理", "订单管理"]) +PaymentRouter = APIRouter(route_class=OperationLogRoute, prefix="/payment", tags=["平台管理", "支付管理"]) +RefundRouter = APIRouter(route_class=OperationLogRoute, prefix="/refund", tags=["平台管理", "退款管理"]) +TenantOrderRouter = APIRouter(route_class=OperationLogRoute, prefix="/order", tags=["平台管理", "租户订单"]) @OrderRouter.post( "/create", @@ -48,20 +42,9 @@ async def order_create_controller( data: Annotated[OrderCreateSchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:order:create"]))], ) -> JSONResponse: - """ - 创建订单 - - 参数: - - data (OrderCreateSchema): 订单创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ result = await OrderService.create_order(auth=auth, data=data) return SuccessResponse(data=result, msg="订单创建成功") - @OrderRouter.get( "/detail/{order_id}", summary="订单详情", @@ -71,22 +54,11 @@ async def order_detail_controller( order_id: Annotated[int, Path(ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:order:query"]))], ) -> JSONResponse: - """ - 订单详情 - - 参数: - - order_id (int): 订单 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ order = await OrderService.get_detail(auth=auth, order_id=order_id) if not order: raise HTTPException(status_code=404, detail="订单不存在") return SuccessResponse(data=order) - @OrderRouter.get( "/list", summary="订单列表", @@ -100,20 +72,6 @@ async def order_list_controller( page: Annotated[int, Query(ge=1)] = 1, page_size: Annotated[int, Query(ge=1, le=100)] = 20, ) -> JSONResponse: - """ - 订单列表 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - tenant_id (int | None): 租户 ID 筛选。 - - status (int | None): 状态筛选。 - - order_type (str | None): 订单类型筛选。 - - page (int): 页码。 - - page_size (int): 每页条数。 - - 返回: - - JSONResponse: 包含分页订单列表的 JSON 响应。 - """ params = OrderQueryParam(tenant_id=tenant_id, status=status, order_type=order_type) offset = (page - 1) * page_size items, total = await OrderService.get_list(auth=auth, params=params, offset=offset, limit=page_size) @@ -126,7 +84,6 @@ async def order_list_controller( ) return SuccessResponse(data=result) - @OrderRouter.post( "/cancel/{order_id}", summary="取消订单", @@ -136,20 +93,9 @@ async def order_cancel_controller( order_id: Annotated[int, Path(ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:order:update"]))], ) -> JSONResponse: - """ - 取消订单 - - 参数: - - order_id (int): 订单 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含取消结果的 JSON 响应。 - """ result = await OrderService.cancel_order(auth=auth, order_id=order_id) return SuccessResponse(data=result, msg=result["message"]) - @PaymentRouter.post( "/pay/{order_id}", summary="创建支付（获取支付 URL/二维码）", @@ -161,25 +107,10 @@ async def payment_create_controller( request: Request, method: Annotated[str, Query(description="支付渠道: alipay / wxpay(留空=自动)")] = "", ) -> JSONResponse: - """ - 创建支付 - - 调用支付网关生成支付 URL（H5 跳转）或二维码（Native 扫码）。 - - 参数: - - order_id (int): 订单 ID。 - - auth (AuthSchema): 认证信息模型。 - - request (Request): FastAPI 请求对象。 - - method (str): 支付渠道。 - - 返回: - - JSONResponse: 包含支付信息的 JSON 响应。 - """ base_url = str(request.base_url).rstrip("/") result = await PaymentService.create_payment(auth=auth, order_id=order_id, method=method, notify_base_url=base_url) return SuccessResponse(data=result, msg="支付信息已生成") - @PaymentRouter.get( "/status/{order_id}", summary="查询支付状态（供前端轮询）", @@ -189,21 +120,10 @@ async def payment_status_controller( order_id: Annotated[int, Path(ge=1)], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 查询支付状态（无需登录，前端轮询用） - - 参数: - - order_id (int): 订单 ID。 - - db (AsyncSession): 数据库会话。 - - 返回: - - JSONResponse: 包含支付状态的 JSON 响应。 - """ - auth = _make_bare_auth(db) + auth = AuthSchema(db=db, check_data_scope=False) result = await OrderService.check_payment_status(auth=auth, order_id=order_id) return SuccessResponse(data=result) - @PaymentRouter.post( "/callback/{method}", summary="支付回调（统一入口）", @@ -214,19 +134,8 @@ async def payment_callback_controller( data: Annotated[dict, Body()], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 接收支付网关的异步通知（无需认证） - - 参数: - - method (str): 支付渠道。 - - data (dict): 支付回调原始数据。 - - db (AsyncSession): 数据库会话。 - - 返回: - - JSONResponse: 包含处理结果的 JSON 响应。 - """ try: - auth = _make_bare_auth(db) + auth = AuthSchema(db=db, check_data_scope=False) result = await PaymentService.handle_callback(auth=auth, method=method, callback_data=data) logger.info(f"支付回调处理成功: {result}") return SuccessResponse(data=result) @@ -234,7 +143,6 @@ async def payment_callback_controller( logger.warning(f"支付回调处理失败: {e}") return SuccessResponse(data={"message": str(e)}, code=400) - @PaymentRouter.post( "/mock/callback", summary="Mock 支付回调（开发环境触发模拟支付）", @@ -244,21 +152,11 @@ async def payment_mock_callback_controller( order_id: Annotated[int, Body(ge=1, description="订单 ID")], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 开发环境下手动触发模拟支付成功回调 - - 参数: - - order_id (int): 订单 ID。 - - db (AsyncSession): 数据库会话。 - - 返回: - - JSONResponse: 包含模拟支付结果的 JSON 响应。 - """ - from app.core.payment import get_mock_gateway + from app.utils.payment import get_mock_gateway from .crud import OrderCRUD - auth = _make_bare_auth(db) + auth = AuthSchema(db=db, check_data_scope=False) order = await OrderCRUD(auth).get_by_id(order_id) if not order: raise HTTPException(status_code=404, detail="订单不存在") @@ -269,7 +167,6 @@ async def payment_mock_callback_controller( logger.info(f"Mock 支付回调触发: order_id={order_id}") return SuccessResponse(data=result, msg="模拟支付成功") - @PaymentRouter.get( "/record/list", summary="支付记录列表", @@ -280,17 +177,6 @@ async def payment_record_list_controller( page: Annotated[int, Query(ge=1)] = 1, page_size: Annotated[int, Query(ge=1, le=100)] = 20, ) -> JSONResponse: - """ - 支付记录列表 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - page (int): 页码。 - - page_size (int): 每页条数。 - - 返回: - - JSONResponse: 包含分页支付记录列表的 JSON 响应。 - """ offset = (page - 1) * page_size items, total = await PaymentService.get_records(auth=auth, offset=offset, limit=page_size) result = PageResultSchema( @@ -302,7 +188,6 @@ async def payment_record_list_controller( ) return SuccessResponse(data=result) - @RefundRouter.get( "/list", summary="退款审核列表", @@ -314,18 +199,6 @@ async def refund_list_controller( page: Annotated[int, Query(ge=1)] = 1, page_size: Annotated[int, Query(ge=1, le=100)] = 20, ) -> JSONResponse: - """ - 退款审核列表 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - status (int | None): 状态筛选。 - - page (int): 页码。 - - page_size (int): 每页条数。 - - 返回: - - JSONResponse: 包含分页退款列表的 JSON 响应。 - """ offset = (page - 1) * page_size items, total = await RefundService.get_list(auth=auth, status=status, offset=offset, limit=page_size) result = PageResultSchema( @@ -337,7 +210,6 @@ async def refund_list_controller( ) return SuccessResponse(data=result) - @RefundRouter.put( "/approve/{refund_id}", summary="批准退款", @@ -347,16 +219,6 @@ async def refund_approve_controller( refund_id: Annotated[int, Path(ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:order:update"]))], ) -> JSONResponse: - """ - 批准退款 - - 参数: - - refund_id (int): 退款申请 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含批准结果的 JSON 响应。 - """ result = await RefundService.approve( auth=auth, refund_id=refund_id, @@ -365,7 +227,6 @@ async def refund_approve_controller( ) return SuccessResponse(data=result, msg=result["message"]) - @RefundRouter.put( "/reject/{refund_id}", summary="驳回退款", @@ -376,17 +237,6 @@ async def refund_reject_controller( data: Annotated[RefundReviewSchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:order:update"]))], ) -> JSONResponse: - """ - 驳回退款 - - 参数: - - refund_id (int): 退款申请 ID。 - - data (RefundReviewSchema): 驳回原因。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含驳回结果的 JSON 响应。 - """ result = await RefundService.reject( auth=auth, refund_id=refund_id, @@ -396,7 +246,6 @@ async def refund_reject_controller( ) return SuccessResponse(data=result, msg=result["message"]) - @TenantOrderRouter.post( "/create", summary="租户端创建订单", @@ -406,22 +255,11 @@ async def tenant_order_create_controller( data: Annotated[OrderCreateSchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:create"]))], ) -> JSONResponse: - """ - 租户端创建订单 - - 参数: - - data (OrderCreateSchema): 订单创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ if data.tenant_id != auth.tenant_id: raise HTTPException(status_code=403, detail="无权操作") result = await OrderService.create_order(auth=auth, data=data) return SuccessResponse(data=result, msg="订单创建成功") - @TenantOrderRouter.post( "/refund/apply/{order_id}", summary="申请退款", @@ -432,16 +270,5 @@ async def tenant_refund_apply_controller( data: Annotated[RefundApplySchema, Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:refund"]))], ) -> JSONResponse: - """ - 租户端申请退款 - - 参数: - - order_id (int): 订单 ID。 - - data (RefundApplySchema): 退款申请参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含退款申请结果的 JSON 响应。 - """ result = await RefundService.apply(auth=auth, data=data, order_id=order_id) return SuccessResponse(data=result, msg="退款申请已提交") diff --git a/backend/app/api/v1/module_platform/order/crud.py b/backend/app/api/v1/module_platform/order/crud.py index 29bed975..b7710b11 100644 --- a/backend/app/api/v1/module_platform/order/crud.py +++ b/backend/app/api/v1/module_platform/order/crud.py @@ -1,6 +1,5 @@ """订单与支付 CRUD""" -from datetime import datetime from typing import Any from app.core.base_crud import CRUDBase @@ -52,20 +51,6 @@ class OrderCRUD(CRUDBase[OrderModel, OrderCreateInternalSchema, OrderUpdateInter .values(status=3) ) - @staticmethod - async def cancel_expired_orders() -> None: - """定时任务：取消超时未支付订单""" - from sqlalchemy import update as sa_update - - from app.core.database import async_db_session - from app.core.logger import logger - - now = datetime.now() - async with async_db_session() as session: - async with session.begin(): - result = await session.execute(sa_update(OrderModel).where(OrderModel.status == 0).where(OrderModel.expire_time < now).where(OrderModel.is_deleted.is_(False)).values(status=2)) - logger.info(f"超时订单取消: 已取消 {result.rowcount} 条订单") - class PaymentRecordCRUD(CRUDBase[PaymentRecordModel, PaymentRecordCreateSchema, Any]): """支付记录 CRUD""" diff --git a/backend/app/api/v1/module_platform/order/service.py b/backend/app/api/v1/module_platform/order/service.py index 8d370427..3dcf5a3b 100644 --- a/backend/app/api/v1/module_platform/order/service.py +++ b/backend/app/api/v1/module_platform/order/service.py @@ -8,7 +8,7 @@ from sqlalchemy import select from app.core.base_schema import AuthSchema from app.core.exceptions import CustomException from app.core.logger import logger -from app.core.payment import create_payment_gateway +from app.utils.payment import create_payment_gateway from .crud import OrderCRUD, PaymentRecordCRUD, RefundCRUD from .model import OrderModel @@ -186,15 +186,23 @@ class OrderService: pay_time=order.pay_time.isoformat() if order.pay_time else None, ) - @classmethod - async def cancel_expired_orders(cls) -> None: - """ - 定时任务：取消超时未支付的订单 + @staticmethod + async def cancel_expired_orders() -> None: + from sqlalchemy import update as sa_update - 返回: - - None - """ - await OrderCRUD.cancel_expired_orders() + from app.core.database import async_db_session + + now = datetime.now() + async with async_db_session() as session: + async with session.begin(): + result = await session.execute( + sa_update(OrderModel) + .where(OrderModel.status == 0) + .where(OrderModel.expire_time < now) + .where(OrderModel.is_deleted == False) # noqa: E712 + .values(status=2) + ) + logger.info(f"超时订单取消: 已取消 {result.rowcount} 条订单") class PaymentService: @@ -373,7 +381,7 @@ class PaymentService: await auth.db.flush() if tenant.contact_email: - await PaymentService._send_order_email(order, pkg, tenant) + await PaymentService._send_order_email(auth, order, pkg, tenant) @classmethod async def _activate_plugin(cls, auth: AuthSchema, order: OrderModel) -> None: @@ -422,7 +430,7 @@ class PaymentService: tenant = await auth.db.get(TenantModel, order.tenant_id) if tenant and tenant.contact_email: - await PaymentService._send_order_email(order, plugin, tenant, order_type_label="购买") + await PaymentService._send_order_email(auth, order, plugin, tenant, order_type_label="购买") @classmethod async def _check_downgrade_quota(cls, auth: AuthSchema, tenant_id: int, new_pkg: object) -> None: @@ -466,7 +474,7 @@ class PaymentService: raise CustomException(msg=f"降级失败：当前租户已有 {current} 个{label}，超过目标套餐限额 {limit}") @classmethod - async def _send_order_email(cls, order: "OrderModel", product: object, tenant: object, order_type_label: str = "") -> None: + async def _send_order_email(cls, auth: AuthSchema, order: "OrderModel", product: object, tenant: object, order_type_label: str = "") -> None: """ 发送购买确认邮件（失败静默降级） @@ -495,7 +503,7 @@ class PaymentService: product_name = getattr(product, "name", "") if product else "" amount_str = f"{order.amount / 100:.2f}" if order.amount else "0.00" - await EmailSendService.send_by_template( + await EmailSendService(auth).send_by_template( to_email=tenant.contact_email, to_name=tenant.contact_name or tenant.name, template_code="order_confirmation", diff --git a/backend/app/api/v1/module_platform/package/controller.py b/backend/app/api/v1/module_platform/package/controller.py index 995ed938..7d4d7103 100644 --- a/backend/app/api/v1/module_platform/package/controller.py +++ b/backend/app/api/v1/module_platform/package/controller.py @@ -21,11 +21,10 @@ from .schema import ( ) from .service import PackageService -PackageRouter = APIRouter(route_class=OperationLogRoute, prefix="/package", tags=["套餐管理"]) +PackageRouter = APIRouter(route_class=OperationLogRoute, prefix="/package", tags=["平台管理", "套餐管理"]) _PKG_NS = "package" - @PackageRouter.get( "/detail/{id}", summary="获取套餐详情", @@ -36,19 +35,9 @@ async def get_obj_detail_controller( id: Annotated[int, Path(description="套餐ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:query"]))], ) -> JSONResponse: - """ - 获取套餐详情 - - 参数: - - id (int): 套餐 ID。 - - 返回: - - JSONResponse: 包含套餐详情的 JSON 响应。 - """ - result_dict = await PackageService.detail_service(auth=auth, id=id) + result_dict = await PackageService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取套餐详情成功") - @PackageRouter.get( "/list", summary="获取套餐列表", @@ -59,18 +48,7 @@ async def get_obj_list_controller( search: Annotated[PackageQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:query"]))], ) -> JSONResponse: - """ - 获取套餐列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (PackageQueryParam): 查询筛选参数。 - - 返回: - - JSONResponse: 包含分页套餐列表的 JSON 响应。 - """ - result_dict = await PackageService.page_service( - auth=auth, + result_dict = await PackageService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -78,7 +56,6 @@ async def get_obj_list_controller( ) return SuccessResponse(data=result_dict, msg="查询成功") - @PackageRouter.post( "/create", summary="创建套餐", @@ -88,20 +65,10 @@ async def create_obj_controller( data: Annotated[PackageCreateSchema, Body(description="套餐信息")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:create"]))], ) -> JSONResponse: - """ - 创建套餐 - - 参数: - - data (PackageCreateSchema): 套餐创建参数。 - - 返回: - - JSONResponse: 包含创建后的套餐详情的 JSON 响应。 - """ - result_dict = await PackageService.create_service(auth=auth, data=data) + result_dict = await PackageService(auth).create(data=data) await FastAPICache.clear(namespace=_PKG_NS) return SuccessResponse(data=result_dict, msg="创建成功") - @PackageRouter.put( "/update/{id}", summary="更新套餐", @@ -112,21 +79,10 @@ async def update_obj_controller( data: Annotated[PackageUpdateSchema, Body(description="套餐信息")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:update"]))], ) -> JSONResponse: - """ - 更新套餐 - - 参数: - - id (int): 套餐 ID。 - - data (PackageUpdateSchema): 套餐更新参数。 - - 返回: - - JSONResponse: 包含更新后的套餐详情的 JSON 响应。 - """ - result_dict = await PackageService.update_service(auth=auth, id=id, data=data) + result_dict = await PackageService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_PKG_NS) return SuccessResponse(data=result_dict, msg="更新成功") - @PackageRouter.delete( "/delete", summary="删除套餐", @@ -136,20 +92,10 @@ async def delete_obj_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:delete"]))], ) -> JSONResponse: - """ - 删除套餐 - - 参数: - - ids (list[int]): 套餐 ID 列表。 - - 返回: - - JSONResponse: 删除结果。 - """ - await PackageService.delete_service(auth=auth, ids=ids) + await PackageService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_PKG_NS) return SuccessResponse(msg="删除成功") - @PackageRouter.patch( "/status/batch", summary="批量修改状态", @@ -159,21 +105,11 @@ async def set_available_controller( data: Annotated[BatchSetAvailable, Body(description="状态设置")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:update"]))], ) -> JSONResponse: - """ - 批量修改套餐状态 - - 参数: - - data (BatchSetAvailable): 批量状态设置参数。 - - 返回: - - JSONResponse: 操作结果。 - """ for id in data.ids: - await PackageService.update_service(auth=auth, id=id, data=PackageUpdateSchema(status=data.status)) + await PackageService(auth).update(id=id, data=PackageUpdateSchema(status=data.status)) await FastAPICache.clear(namespace=_PKG_NS) return SuccessResponse(msg="状态设置成功") - @PackageRouter.get( "/menus/{package_id}", summary="获取套餐菜单", @@ -183,19 +119,9 @@ async def get_menus_controller( package_id: Annotated[int, Path(description="套餐ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:query"]))], ) -> JSONResponse: - """ - 获取套餐关联菜单 - - 参数: - - package_id (int): 套餐 ID。 - - 返回: - - JSONResponse: 包含菜单 ID 列表的 JSON 响应。 - """ - result = await PackageService.get_menus_service(auth=auth, package_id=package_id) + result = await PackageService(auth).get_menus(package_id=package_id) return SuccessResponse(data=result, msg="获取成功") - @PackageRouter.post( "/menus/{package_id}/set", summary="设置套餐菜单", @@ -206,20 +132,9 @@ async def set_menus_controller( data: Annotated[PackageMenuSetSchema, Body(description="菜单列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:update"]))], ) -> JSONResponse: - """ - 设置套餐菜单权限 - - 参数: - - package_id (int): 套餐 ID。 - - data (PackageMenuSetSchema): 菜单 ID 列表。 - - 返回: - - JSONResponse: 操作结果。 - """ - await PackageService.set_menus_service(auth=auth, package_id=package_id, data=data) + await PackageService(auth).set_menus(package_id=package_id, data=data) return SuccessResponse(msg="设置成功") - @PackageRouter.get( "/plugins/{package_id}", summary="获取套餐插件", @@ -229,19 +144,9 @@ async def get_plugins_controller( package_id: Annotated[int, Path(description="套餐ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:query"]))], ) -> JSONResponse: - """ - 获取套餐关联插件 - - 参数: - - package_id (int): 套餐 ID。 - - 返回: - - JSONResponse: 包含插件 ID 列表的 JSON 响应。 - """ - result = await PackageService.get_plugins_service(auth=auth, package_id=package_id) + result = await PackageService(auth).get_plugins(package_id=package_id) return SuccessResponse(data=result, msg="获取成功") - @PackageRouter.post( "/plugins/{package_id}/set", summary="设置套餐插件", @@ -252,15 +157,5 @@ async def set_plugins_controller( data: Annotated[PackagePluginSetSchema, Body(description="插件列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_package:package:update"]))], ) -> JSONResponse: - """ - 设置套餐插件 - - 参数: - - package_id (int): 套餐 ID。 - - data (PackagePluginSetSchema): 插件 ID 列表。 - - 返回: - - JSONResponse: 操作结果。 - """ - await PackageService.set_plugins_service(auth=auth, package_id=package_id, data=data) + await PackageService(auth).set_plugins(package_id=package_id, data=data) return SuccessResponse(msg="设置成功") diff --git a/backend/app/api/v1/module_platform/package/service.py b/backend/app/api/v1/module_platform/package/service.py index 90df4c87..b4c387d4 100644 --- a/backend/app/api/v1/module_platform/package/service.py +++ b/backend/app/api/v1/module_platform/package/service.py @@ -20,49 +20,24 @@ from .schema import ( class PackageService: - """ - 套餐管理服务（仅超级管理员可操作） - """ + """套餐管理服务（仅超级管理员可操作）""" + + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - @classmethod @require_superadmin - async def detail_service(cls, auth: AuthSchema, id: int) -> PackageOutSchema: - """ - 套餐详情 + async def detail(self, id: int) -> PackageOutSchema: + return await PackageCRUD(self.auth).get_or_404(id=id, out_schema=PackageOutSchema, msg="该数据不存在") - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 套餐ID - - 返回: - - PackageOutSchema: 套餐详情 - """ - return await PackageCRUD(auth).get_or_404(id=id, out_schema=PackageOutSchema, msg="该数据不存在") - - @classmethod @require_superadmin - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: PackageQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> dict: - """ - 分页查询套餐 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页数量 - - search (PackageQueryParam | None): 查询参数 - - order_by (list[dict[str, str]] | None): 排序参数 - - 返回: - - dict: 分页数据 - """ - return await PackageCRUD(auth).page( + return await PackageCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"sort": "asc"}, {"id": "asc"}], @@ -70,184 +45,90 @@ class PackageService: out_schema=PackageOutSchema, ) - @classmethod @require_superadmin - async def create_service(cls, auth: AuthSchema, data: PackageCreateSchema) -> PackageOutSchema: - """ - 创建套餐 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (PackageCreateSchema): 套餐创建模型 - - 返回: - - PackageOutSchema: 套餐详情 - """ - if await PackageCRUD(auth).get(name=data.name): + async def create(self, data: PackageCreateSchema) -> PackageOutSchema: + if await PackageCRUD(self.auth).get(name=data.name): raise CustomException(msg="创建失败，套餐名称已存在") - if await PackageCRUD(auth).get(code=data.code): + if await PackageCRUD(self.auth).get(code=data.code): raise CustomException(msg="创建失败，套餐编码已存在") - obj = await PackageCRUD(auth).create(data=data) + obj = await PackageCRUD(self.auth).create(data=data) result = PackageOutSchema.model_validate(obj) logger.info(f"创建套餐成功: {result.name}") return result - @classmethod @require_superadmin - async def update_service(cls, auth: AuthSchema, id: int, data: PackageUpdateSchema) -> PackageOutSchema: - """ - 更新套餐 - - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 套餐ID - - data (PackageUpdateSchema): 套餐更新模型 - - 返回: - - PackageOutSchema: 套餐详情 - """ - obj = await PackageCRUD(auth).get_or_404(id=id) + async def update(self, id: int, data: PackageUpdateSchema) -> PackageOutSchema: + obj = await PackageCRUD(self.auth).get_or_404(id=id) if data.name is not None: - exist = await PackageCRUD(auth).get(name=data.name) + exist = await PackageCRUD(self.auth).get(name=data.name) if exist and exist.id != id: raise CustomException(msg="更新失败，名称重复") if data.code is not None: - exist = await PackageCRUD(auth).get(code=data.code) + exist = await PackageCRUD(self.auth).get(code=data.code) if exist and exist.id != id: raise CustomException(msg="更新失败，编码重复") - # 套餐禁用时记录受影响租户 if data.status is not None and data.status == 1 and obj.status == 0: - await cls.disable_cascade_service(auth=auth, package_id=id) - - updated = await PackageCRUD(auth).update(id=id, data=data) + await self.disable_cascade(package_id=id) + updated = await PackageCRUD(self.auth).update(id=id, data=data) return PackageOutSchema.model_validate(updated) - @classmethod @require_superadmin - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除套餐 - - 参数: - - auth (AuthSchema): 认证信息模型 - - ids (list[int]): 套餐ID列表 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if not ids: raise CustomException(msg="删除失败，删除对象不能为空") for pid in ids: stmt = select(func.count()).select_from(TenantModel).where(TenantModel.package_id == pid) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) count = result.scalar() if count and count > 0: raise CustomException(msg=f"套餐 ID={pid} 已被 {count} 个租户使用，无法删除") - await PackageCRUD(auth).delete(ids=ids) + await PackageCRUD(self.auth).delete(ids=ids) - @classmethod - async def disable_cascade_service(cls, auth: AuthSchema, package_id: int) -> None: - """ - 套餐禁用时日志记录受影响租户 - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - 返回: - - None - """ + async def disable_cascade(self, package_id: int) -> None: stmt = select(TenantModel.id, TenantModel.name).where( TenantModel.package_id == package_id, TenantModel.status == 0, ) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) rows = result.all() if rows: tenant_ids = [row[0] for row in rows] logger.warning(f"套餐[{package_id}]已禁用，影响租户: {tenant_ids}") - @classmethod - async def get_menus_service(cls, auth: AuthSchema, package_id: int) -> list[int]: - """ - 获取套餐菜单权限 - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - 返回: - - list[int]: menu_id 列表 - """ + async def get_menus(self, package_id: int) -> list[int]: stmt = select(PackageMenuModel.menu_id).where(PackageMenuModel.package_id == package_id) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) return [row[0] for row in result.all()] - @classmethod - async def set_menus_service(cls, auth: AuthSchema, package_id: int, data: PackageMenuSetSchema) -> None: - """ - 批量设置套餐菜单权限（先清空再写入） - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - data (PackageMenuSetSchema): 菜单ID列表 - - 返回: - - None - """ - await auth.db.execute(sa.delete(PackageMenuModel).where(PackageMenuModel.package_id == package_id)) + async def set_menus(self, package_id: int, data: PackageMenuSetSchema) -> None: + await self.auth.db.execute(sa.delete(PackageMenuModel).where(PackageMenuModel.package_id == package_id)) for menu_id in data.menu_ids: - auth.db.add(PackageMenuModel(package_id=package_id, menu_id=menu_id)) - await auth.db.flush() + self.auth.db.add(PackageMenuModel(package_id=package_id, menu_id=menu_id)) + await self.auth.db.flush() logger.info(f"套餐[{package_id}]菜单权限已设置, count={len(data.menu_ids)}") - @classmethod - async def get_package_menu_ids(cls, auth: AuthSchema, package_id: int) -> list[int]: - """ - 获取套餐包含的菜单ID列表 - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - 返回: - - list[int]: menu_id 列表 - """ + async def get_package_menu_ids(self, package_id: int) -> list[int]: stmt = select(PackageMenuModel.menu_id).where(PackageMenuModel.package_id == package_id) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) return [row[0] for row in result.all()] - @classmethod - async def get_tenant_available_menu_ids(cls, auth: AuthSchema, tenant_id: int) -> list[int]: - """ - 获取租户的完整可用菜单ID列表（仅从套餐菜单获取） - - 平台租户 (id=1) 返回全部启用菜单，不受套餐限制。 - - 参数: - - auth (AuthSchema): 认证信息模型 - - tenant_id (int): 租户ID - - 返回: - - list[int]: menu_id 列表 - """ + async def get_tenant_available_menu_ids(self, tenant_id: int) -> list[int]: from app.api.v1.module_platform.menu.model import MenuModel from app.api.v1.module_platform.tenant.model import TenantModel if tenant_id == 1: menu_stmt = select(MenuModel.id).where(MenuModel.status == 0) - result = await auth.db.execute(menu_stmt) + result = await self.auth.db.execute(menu_stmt) return [row[0] for row in result.all()] stmt = select(TenantModel).where(TenantModel.id == tenant_id).limit(1) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) tenant = result.scalar_one_or_none() if not tenant: return [] @@ -256,75 +137,41 @@ class PackageService: return [] pkg_stmt = select(PackageModel.status).where(PackageModel.id == tenant.package_id).limit(1) - pkg_result = await auth.db.execute(pkg_stmt) + pkg_result = await self.auth.db.execute(pkg_stmt) pkg_status = pkg_result.scalar_one_or_none() if pkg_status != 0: return [] menu_stmt = select(PackageMenuModel.menu_id).where(PackageMenuModel.package_id == tenant.package_id) - result = await auth.db.execute(menu_stmt) + result = await self.auth.db.execute(menu_stmt) return [row[0] for row in result.all()] - @classmethod - async def get_tenant_available_plugin_ids(cls, auth: AuthSchema, tenant_id: int) -> list[int]: - """ - 获取租户套餐可用的插件ID列表 - - 参数: - - auth (AuthSchema): 认证信息模型 - - tenant_id (int): 租户ID - - 返回: - - list[int]: plugin_id 列表 - """ + async def get_tenant_available_plugin_ids(self, tenant_id: int) -> list[int]: from app.api.v1.module_platform.tenant.model import TenantModel stmt = select(TenantModel).where(TenantModel.id == tenant_id).limit(1) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) tenant = result.scalar_one_or_none() if not tenant or not tenant.package_id: return [] pkg_stmt = select(PackageModel.status).where(PackageModel.id == tenant.package_id).limit(1) - pkg_result = await auth.db.execute(pkg_stmt) + pkg_result = await self.auth.db.execute(pkg_stmt) pkg_status = pkg_result.scalar_one_or_none() if pkg_status != 0: return [] plugin_stmt = select(PackagePluginModel.plugin_id).where(PackagePluginModel.plugin_id == tenant.package_id) - result = await auth.db.execute(plugin_stmt) + result = await self.auth.db.execute(plugin_stmt) return [row[0] for row in result.all()] - @classmethod - async def get_plugins_service(cls, auth: AuthSchema, package_id: int) -> list[int]: - """ - 获取套餐插件权限 - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - 返回: - - list[int]: plugin_id 列表 - """ + async def get_plugins(self, package_id: int) -> list[int]: stmt = select(PackagePluginModel.plugin_id).where(PackagePluginModel.plugin_id == package_id) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) return [row[0] for row in result.all()] - @classmethod - async def set_plugins_service(cls, auth: AuthSchema, package_id: int, data: PackagePluginSetSchema) -> None: - """ - 批量设置套餐插件（先清空再写入） - - 参数: - - auth (AuthSchema): 认证信息模型 - - package_id (int): 套餐ID - - data (PackagePluginSetSchema): 插件ID列表 - - 返回: - - None - """ - await auth.db.execute(sa.delete(PackagePluginModel).where(PackagePluginModel.package_id == package_id)) + async def set_plugins(self, package_id: int, data: PackagePluginSetSchema) -> None: + await self.auth.db.execute(sa.delete(PackagePluginModel).where(PackagePluginModel.package_id == package_id)) for plugin_id in data.plugin_ids: - auth.db.add(PackagePluginModel(package_id=package_id, plugin_id=plugin_id)) - await auth.db.flush() + self.auth.db.add(PackagePluginModel(package_id=package_id, plugin_id=plugin_id)) + await self.auth.db.flush() diff --git a/backend/app/api/v1/module_platform/plugin/controller.py b/backend/app/api/v1/module_platform/plugin/controller.py index ff5ce39d..3c01a16c 100644 --- a/backend/app/api/v1/module_platform/plugin/controller.py +++ b/backend/app/api/v1/module_platform/plugin/controller.py @@ -20,12 +20,10 @@ from .schema import ( ) from .service import PluginService -PluginRouter = APIRouter(route_class=OperationLogRoute, prefix="/plugin", tags=["插件管理"]) +PluginRouter = APIRouter(route_class=OperationLogRoute, prefix="/plugin", tags=["平台管理", "插件管理"]) _PLUGIN_NS = "plugin" -# ───── 超管：插件 CRUD ───── - @PluginRouter.get( "/list", @@ -38,19 +36,7 @@ async def plugin_list_controller( search: Annotated[PluginQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:query"]))], ) -> JSONResponse: - """ - 插件列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (PluginQueryParam): 查询筛选参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页插件列表的 JSON 响应。 - """ - r = await PluginService.page_service( - auth=auth, + r = await PluginService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -68,17 +54,7 @@ async def plugin_detail_controller( id: Annotated[int, Path()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:query"]))], ) -> JSONResponse: - """ - 插件详情 - - 参数: - - id (int): 插件 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含插件详情的 JSON 响应。 - """ - return SuccessResponse(data=await PluginService.detail_service(auth=auth, id=id), msg="查询成功") + return SuccessResponse(data=await PluginService(auth).detail(id=id), msg="查询成功") @PluginRouter.post( @@ -90,17 +66,7 @@ async def plugin_create_controller( data: PluginCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:create"]))], ) -> JSONResponse: - """ - 创建插件 - - 参数: - - data (PluginCreateSchema): 插件创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含创建后的插件详情的 JSON 响应。 - """ - r = await PluginService.create_service(auth=auth, data=data) + r = await PluginService(auth).create(data=data) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(data=r, msg="创建成功") @@ -115,18 +81,7 @@ async def plugin_update_controller( data: PluginUpdateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:update"]))], ) -> JSONResponse: - """ - 更新插件 - - 参数: - - id (int): 插件 ID。 - - data (PluginUpdateSchema): 插件更新参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含更新后的插件详情的 JSON 响应。 - """ - r = await PluginService.update_service(auth=auth, id=id, data=data) + r = await PluginService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(data=r, msg="更新成功") @@ -140,24 +95,11 @@ async def plugin_delete_controller( ids: Annotated[list[int], Body()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:delete"]))], ) -> JSONResponse: - """ - 删除插件 - - 参数: - - ids (list[int]): 插件 ID 列表。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 删除结果。 - """ - await PluginService.delete_service(auth=auth, ids=ids) + await PluginService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(msg="删除成功") -# ───── 租户：插件市场 ───── - - @PluginRouter.get( "/marketplace", summary="插件市场", @@ -169,18 +111,7 @@ async def plugin_marketplace_controller( page: Annotated[PaginationQueryParam, Depends()], category: Annotated[str | None, Query(description="分类筛选")] = None, ) -> JSONResponse: - """ - 插件市场 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - category (str | None): 分类筛选。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页市场插件列表的 JSON 响应。 - """ - r = await PluginService.marketplace_service(auth=auth, page_no=page.page_no, page_size=page.page_size, category=category) + r = await PluginService(auth).marketplace(page_no=page.page_no, page_size=page.page_size, category=category) return SuccessResponse(data=r, msg="查询成功") @@ -193,17 +124,7 @@ async def plugin_install_controller( data: PluginInstallSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:install"]))], ) -> JSONResponse: - """ - 安装插件 - - 参数: - - data (PluginInstallSchema): 安装参数（插件 ID）。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 安装结果。 - """ - await PluginService.install_service(auth=auth, plugin_id=data.plugin_id) + await PluginService(auth).install(plugin_id=data.plugin_id) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(msg="安装成功") @@ -217,17 +138,7 @@ async def plugin_uninstall_controller( data: PluginInstallSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:uninstall"]))], ) -> JSONResponse: - """ - 卸载插件 - - 参数: - - data (PluginInstallSchema): 卸载参数（插件 ID）。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 卸载结果。 - """ - await PluginService.uninstall_service(auth=auth, plugin_id=data.plugin_id) + await PluginService(auth).uninstall(plugin_id=data.plugin_id) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(msg="卸载成功") @@ -241,17 +152,7 @@ async def plugin_toggle_controller( data: PluginInstallSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:toggle"]))], ) -> JSONResponse: - """ - 启用/禁用插件 - - 参数: - - data (PluginInstallSchema): 操作参数（插件 ID）。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 操作结果。 - """ - await PluginService.toggle_service(auth=auth, plugin_id=data.plugin_id) + await PluginService(auth).toggle(plugin_id=data.plugin_id) await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(msg="操作成功") @@ -265,16 +166,7 @@ async def plugin_toggle_controller( async def plugin_my_list_controller( auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:query"]))], ) -> JSONResponse: - """ - 我的插件 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含已安装插件列表的 JSON 响应。 - """ - return SuccessResponse(data=await PluginService.my_plugins_service(auth=auth), msg="查询成功") + return SuccessResponse(data=await PluginService(auth).my_plugins(), msg="查询成功") @PluginRouter.post( @@ -285,18 +177,6 @@ async def plugin_my_list_controller( async def plugin_reload_controller( auth: Annotated[AuthSchema, Depends(AuthPermission(["module_platform:plugin:reload"]))], ) -> JSONResponse: - """ - 热重载插件路由（管理员）。 - - 重新扫描 app/plugin/module_* 目录，清除模块缓存并注册新路由， - 无需重启服务器。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含重载结果的 JSON 响应。 - """ - msg = PluginService.reload_service() + msg = PluginService.reload() await FastAPICache.clear(namespace=_PLUGIN_NS) return SuccessResponse(data=msg, msg="重载成功") diff --git a/backend/app/api/v1/module_platform/plugin/service.py b/backend/app/api/v1/module_platform/plugin/service.py index f2e5486b..ba07ad5b 100644 --- a/backend/app/api/v1/module_platform/plugin/service.py +++ b/backend/app/api/v1/module_platform/plugin/service.py @@ -13,34 +13,20 @@ from .schema import PluginCreateSchema, PluginOutSchema, PluginQueryParam, Plugi class PluginService: - """ - 插件管理服务（仅超级管理员可操作 CRUD，租户通过 marketplace/install/uninstall/toggle/my 操作） - """ + """插件管理服务（仅超级管理员可操作 CRUD，租户通过 marketplace/install/uninstall/toggle/my 操作）""" + + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - @classmethod @require_superadmin - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: PluginQueryParam | None = None, order_by: list | None = None, ) -> dict: - """ - 分页查询插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页数量 - - search (PluginQueryParam | None): 查询参数 - - order_by (list | None): 排序参数 - - 返回: - - dict: 分页数据 - """ - return await PluginCRUD(auth).page( + return await PluginCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"sort": "asc"}], @@ -48,102 +34,41 @@ class PluginService: out_schema=PluginOutSchema, ) - @classmethod @require_superadmin - async def detail_service(cls, auth: AuthSchema, id: int) -> PluginOutSchema: - """ - 插件详情 + async def detail(self, id: int) -> PluginOutSchema: + return await PluginCRUD(self.auth).get_or_404(id=id, out_schema=PluginOutSchema) - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 插件ID - - 返回: - - PluginOutSchema: 插件详情 - """ - return await PluginCRUD(auth).get_or_404(id=id, out_schema=PluginOutSchema) - - @classmethod @require_superadmin - async def create_service(cls, auth: AuthSchema, data: PluginCreateSchema) -> PluginOutSchema: - """ - 创建插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (PluginCreateSchema): 插件创建模型 - - 返回: - - PluginOutSchema: 插件详情 - """ - if await PluginCRUD(auth).get(code=data.code): + async def create(self, data: PluginCreateSchema) -> PluginOutSchema: + if await PluginCRUD(self.auth).get(code=data.code): raise CustomException(msg="创建失败，插件编码已存在") - obj = await PluginCRUD(auth).create(data=data) + obj = await PluginCRUD(self.auth).create(data=data) return PluginOutSchema.model_validate(obj) - @classmethod @require_superadmin - async def update_service(cls, auth: AuthSchema, id: int, data: PluginUpdateSchema) -> PluginOutSchema: - """ - 更新插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 插件ID - - data (PluginUpdateSchema): 插件更新模型 - - 返回: - - PluginOutSchema: 插件详情 - """ - _ = await PluginCRUD(auth).get_or_404(id=id) - updated = await PluginCRUD(auth).update(id=id, data=data) + async def update(self, id: int, data: PluginUpdateSchema) -> PluginOutSchema: + _ = await PluginCRUD(self.auth).get_or_404(id=id) + updated = await PluginCRUD(self.auth).update(id=id, data=data) return PluginOutSchema.model_validate(updated) - @classmethod @require_superadmin - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除插件 + async def delete(self, ids: list[int]) -> None: + await PluginCRUD(self.auth).delete(ids=ids) - 参数: - - auth (AuthSchema): 认证信息模型 - - ids (list[int]): 插件ID列表 - - 返回: - - None - """ - await PluginCRUD(auth).delete(ids=ids) - - # ───── 插件市场 API ───── - - @classmethod - async def marketplace_service(cls, auth: AuthSchema, page_no: int, page_size: int, category: str | None = None) -> dict: - """ - 插件市场列表（租户端） - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页数量 - - category (str | None): 分类筛选 - - 返回: - - dict: 分页数据（含租户的 installed/purchased 标记） - """ - search = {} + async def marketplace(self, page_no: int, page_size: int, category: str | None = None) -> dict: + search: dict = {"status": ("eq", "0")} if category: search["category"] = ("eq", category) - search["status"] = ("eq", "0") - result = await PluginCRUD(auth).page( + result = await PluginCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=[{"sort": "asc"}], search=search, out_schema=PluginOutSchema, ) - tenant_id = getattr(auth, "tenant_id", None) or auth.user.tenant_id + tenant_id = getattr(self.auth, "tenant_id", None) or self.auth.user.tenant_id if tenant_id and result.items: - records = await auth.db.execute( + records = await self.auth.db.execute( sa.select(TenantPluginModel.plugin_id, TenantPluginModel.purchased).where( TenantPluginModel.tenant_id == tenant_id, ) @@ -155,38 +80,24 @@ class PluginService: item["purchased"] = record_map.get(pid, False) return result - @classmethod - async def install_service(cls, auth: AuthSchema, plugin_id: int) -> None: - """ - 安装插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - plugin_id (int): 插件ID - - 返回: - - None - """ - tenant_id = getattr(auth, "tenant_id", None) or auth.user.tenant_id + async def install(self, plugin_id: int) -> None: + tenant_id = getattr(self.auth, "tenant_id", None) or self.auth.user.tenant_id if not tenant_id: raise CustomException(msg="无法获取租户信息") - # 平台租户不限制插件安装 if tenant_id != 1: from app.api.v1.module_platform.package.service import PackageService - allowed_plugin_ids = await PackageService.get_tenant_available_plugin_ids(auth, tenant_id) - # 套餐有插件配置时，仅允许安装套餐内的插件 + allowed_plugin_ids = await PackageService(self.auth).get_tenant_available_plugin_ids(tenant_id) if allowed_plugin_ids and plugin_id not in allowed_plugin_ids: raise CustomException(msg="当前套餐不支持安装此插件") - plugin = await PluginCRUD(auth).get(id=plugin_id) + plugin = await PluginCRUD(self.auth).get(id=plugin_id) if not plugin or plugin.status == 1: raise CustomException(msg="该数据不存在") - # 付费插件需要先购买 if tenant_id != 1 and getattr(plugin, "price", 0) > 0: - exist = await auth.db.execute( + exist = await self.auth.db.execute( sa.select(TenantPluginModel) .where( TenantPluginModel.tenant_id == tenant_id, @@ -198,7 +109,7 @@ class PluginService: if not tp_record or not tp_record.purchased: raise CustomException(msg="此插件为付费插件，请先购买后再安装") - exist = await auth.db.execute( + exist = await self.auth.db.execute( sa.select(TenantPluginModel) .where( TenantPluginModel.tenant_id == tenant_id, @@ -207,7 +118,7 @@ class PluginService: .limit(1) ) if exist.scalar_one_or_none(): - await auth.db.execute( + await self.auth.db.execute( sa.update(TenantPluginModel) .where( TenantPluginModel.tenant_id == tenant_id, @@ -223,48 +134,26 @@ class PluginService: purchased=True if getattr(plugin, "price", 0) == 0 else False, installed_time=datetime.now(), ) - auth.db.add(tp) - await auth.db.flush() + self.auth.db.add(tp) + await self.auth.db.flush() logger.info(f"租户[{tenant_id}]安装插件[{plugin.name}]") - @classmethod - async def uninstall_service(cls, auth: AuthSchema, plugin_id: int) -> None: - """ - 卸载插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - plugin_id (int): 插件ID - - 返回: - - None - """ - tenant_id = getattr(auth, "tenant_id", None) or auth.user.tenant_id + async def uninstall(self, plugin_id: int) -> None: + tenant_id = getattr(self.auth, "tenant_id", None) or self.auth.user.tenant_id if not tenant_id: raise CustomException(msg="无法获取租户信息") - await auth.db.execute( + await self.auth.db.execute( sa.delete(TenantPluginModel).where( TenantPluginModel.tenant_id == tenant_id, TenantPluginModel.plugin_id == plugin_id, ) ) - await auth.db.flush() + await self.auth.db.flush() logger.info(f"租户[{tenant_id}]卸载插件[{plugin_id}]") - @classmethod - async def toggle_service(cls, auth: AuthSchema, plugin_id: int) -> None: - """ - 启用/禁用插件 - - 参数: - - auth (AuthSchema): 认证信息模型 - - plugin_id (int): 插件ID - - 返回: - - None - """ - tenant_id = getattr(auth, "tenant_id", None) or auth.user.tenant_id - tp = await auth.db.execute( + async def toggle(self, plugin_id: int) -> None: + tenant_id = getattr(self.auth, "tenant_id", None) or self.auth.user.tenant_id + tp = await self.auth.db.execute( sa.select(TenantPluginModel) .where( TenantPluginModel.tenant_id == tenant_id, @@ -276,24 +165,14 @@ class PluginService: if not tp: raise CustomException(msg="未安装该插件") tp.enabled = not tp.enabled - await auth.db.flush() + await self.auth.db.flush() logger.info(f"租户[{tenant_id}]插件[{plugin_id}]状态→{tp.enabled}") - @classmethod - async def my_plugins_service(cls, auth: AuthSchema) -> list[dict]: - """ - 查询我的插件列表（租户端） - - 参数: - - auth (AuthSchema): 认证信息模型 - - 返回: - - list[dict]: 已安装插件列表 - """ - tenant_id = getattr(auth, "tenant_id", None) or auth.user.tenant_id + async def my_plugins(self) -> list[dict]: + tenant_id = getattr(self.auth, "tenant_id", None) or self.auth.user.tenant_id if not tenant_id: return [] - result = await auth.db.execute( + result = await self.auth.db.execute( sa.select(PluginModel, TenantPluginModel).join(TenantPluginModel, TenantPluginModel.plugin_id == PluginModel.id).where(TenantPluginModel.tenant_id == tenant_id).order_by(PluginModel.sort) ) plugins = [] @@ -305,19 +184,8 @@ class PluginService: plugins.append(d) return plugins - # ───── 插件热重载 ───── - - @classmethod - def reload_service(cls) -> str: - """ - 热重载插件路由（同步函数，直接操作模块缓存与 app.routes）。 - - 要求 init_app.py 已在启动时调用 discover.set_app_ref(app)， - 否则仅重建 Router 对象，不会更新运行中的 app 路由。 - - 返回: - - str: 重载结果描述 - """ + @staticmethod + def reload() -> str: from app.core.discover import reload_dynamic_router router = reload_dynamic_router() diff --git a/backend/app/api/v1/module_platform/self_service/controller.py b/backend/app/api/v1/module_platform/self_service/controller.py index 9af98d9e..b543dd90 100644 --- a/backend/app/api/v1/module_platform/self_service/controller.py +++ b/backend/app/api/v1/module_platform/self_service/controller.py @@ -29,7 +29,6 @@ TenantSelfServiceRouter = APIRouter( tags=["自助服务"], ) - @TenantSelfServiceRouter.get( "/package/available", summary="可选套餐列表", @@ -38,16 +37,9 @@ TenantSelfServiceRouter = APIRouter( async def package_available_controller( auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:package:query"]))], ) -> JSONResponse: - """ - 可选套餐列表 - - 返回: - - JSONResponse: 包含可用套餐列表的 JSON 响应。 - """ result = await SelfService.get_available_packages(auth=auth, tenant_id=auth.tenant_id) return SuccessResponse(data=result, msg="查询成功") - @TenantSelfServiceRouter.get( "/package/preview", summary="套餐变更影响预览", @@ -57,19 +49,9 @@ async def package_preview_controller( target_package_id: Annotated[int, Query(ge=1, description="目标套餐ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:package:query"]))], ) -> JSONResponse: - """ - 套餐变更影响预览 - - 参数: - - target_package_id (int): 目标套餐 ID。 - - 返回: - - JSONResponse: 包含套餐变更影响预览的 JSON 响应。 - """ result = await SelfService.preview_package_change(auth=auth, tenant_id=auth.tenant_id, target_package_id=target_package_id) return SuccessResponse(data=result, msg="查询成功") - @TenantSelfServiceRouter.post( "/order/create", summary="创建自助订单", @@ -79,19 +61,9 @@ async def order_create_controller( data: SelfOrderCreate, auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:create"]))], ) -> JSONResponse: - """ - 创建自助订单 - - 参数: - - data (SelfOrderCreate): 订单创建参数。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ result = await SelfService.create_self_order(auth=auth, tenant_id=auth.tenant_id, data=data) return SuccessResponse(data=result, msg="订单创建成功") - @TenantSelfServiceRouter.post( "/plugin/purchase", summary="购买付费插件", @@ -101,19 +73,9 @@ async def plugin_purchase_controller( data: PluginPurchaseCreate, auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:create"]))], ) -> JSONResponse: - """ - 购买付费插件 - - 参数: - - data (PluginPurchaseCreate): 插件购买参数。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ result = await SelfService.create_plugin_purchase_order(auth=auth, tenant_id=auth.tenant_id, data=data) return SuccessResponse(data=result, msg="插件订单创建成功") - @TenantSelfServiceRouter.get( "/order/list", summary="我的订单列表", @@ -123,15 +85,6 @@ async def order_list_controller( page: Annotated[PaginationQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:query"]))], ) -> JSONResponse: - """ - 我的订单列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - 返回: - - JSONResponse: 包含分页订单列表的 JSON 响应。 - """ result = await SelfService.get_self_order_list( auth=auth, tenant_id=auth.tenant_id, @@ -141,7 +94,6 @@ async def order_list_controller( ) return SuccessResponse(data=result, msg="查询成功") - @TenantSelfServiceRouter.get( "/order/detail/{order_id}", summary="订单详情", @@ -151,19 +103,9 @@ async def order_detail_controller( order_id: Annotated[int, Path(ge=1, description="订单ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["tenant:order:query"]))], ) -> JSONResponse: - """ - 订单详情 - - 参数: - - order_id (int): 订单 ID。 - - 返回: - - JSONResponse: 包含订单详情的 JSON 响应。 - """ - result = await SelfService.get_self_order_detail(auth=auth, tenant_id=auth.tenant_id, order_id=order_id) + result = await SelfService.get_self_order_detail(auth=auth, order_id=order_id) return SuccessResponse(data=result, msg="查询成功") - @TenantSelfServiceRouter.get( "/workspace", summary="租户工作台概览", @@ -172,11 +114,5 @@ async def order_detail_controller( async def tenant_workspace_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 租户工作台概览 - - 返回: - - JSONResponse: 包含工作台概览信息的 JSON 响应。 - """ result = await SelfService.get_workspace_data(auth=auth, tenant_id=auth.tenant_id) return SuccessResponse(data=result, msg="查询成功") diff --git a/backend/app/api/v1/module_platform/self_service/service.py b/backend/app/api/v1/module_platform/self_service/service.py index 2f66253c..6200f86c 100644 --- a/backend/app/api/v1/module_platform/self_service/service.py +++ b/backend/app/api/v1/module_platform/self_service/service.py @@ -355,13 +355,12 @@ class SelfService: ) @classmethod - async def get_self_order_detail(cls, auth: AuthSchema, tenant_id: int, order_id: int) -> SelfOrderDetailOut: + async def get_self_order_detail(cls, auth: AuthSchema, order_id: int) -> SelfOrderDetailOut: """ 订单详情 参数: - auth (AuthSchema): 认证信息模型 - - tenant_id (int): 租户ID - order_id (int): 订单ID 返回: @@ -407,12 +406,10 @@ class SelfService: quota=WorkspaceQuotaInfo(), ) - # ── 套餐 ── package = None if tenant.package_id: package = await auth.db.get(PackageModel, tenant.package_id) - # ── 用量计数 ── async def _count(model_cls) -> int: stmt = ( select(func.count()) @@ -428,7 +425,6 @@ class SelfService: role_count = await _count(RoleModel) dept_count = await _count(DeptModel) - # ── 到期状态 ── now = datetime.now() days_remaining = (tenant.end_time - now).days if tenant.end_time else 0 @@ -441,7 +437,6 @@ class SelfService: "5": "已归档", } - # ── 近期订单 ── orders_stmt = select(OrderModel).where(OrderModel.tenant_id == tenant_id).order_by(OrderModel.created_time.desc()).limit(5) orders_result = await auth.db.execute(orders_stmt) recent_orders = [] diff --git a/backend/app/api/v1/module_platform/tenant/controller.py b/backend/app/api/v1/module_platform/tenant/controller.py index 9a673f2c..211604a6 100644 --- a/backend/app/api/v1/module_platform/tenant/controller.py +++ b/backend/app/api/v1/module_platform/tenant/controller.py @@ -26,11 +26,10 @@ from .schema import ( ) from .service import TenantService -TenantRouter = APIRouter(route_class=OperationLogRoute, prefix="/tenant", tags=["租户管理"]) +TenantRouter = APIRouter(route_class=OperationLogRoute, prefix="/tenant", tags=["平台管理", "租户管理"]) _TENANT_NS = "tenant" - @TenantRouter.get( "/detail/{id}", summary="获取租户详情", @@ -41,19 +40,9 @@ async def get_obj_detail_controller( id: Annotated[int, Path(description="租户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:query"]))], ) -> JSONResponse: - """ - 获取租户详情 - - 参数: - - id (int): 租户 ID。 - - 返回: - - JSONResponse: 包含租户详情的 JSON 响应。 - """ - result_dict = await TenantService.detail_service(id=id, auth=auth) + result_dict = await TenantService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取租户详情成功") - @TenantRouter.get( "/list", summary="查询租户列表", @@ -64,21 +53,10 @@ async def get_obj_list_controller( search: Annotated[TenantQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:query"]))], ) -> JSONResponse: - """ - 查询租户列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (TenantQueryParam): 查询筛选参数。 - - 返回: - - JSONResponse: 包含分页租户列表的 JSON 响应。 - """ order_by = [{"id": "asc"}] if page.order_by: order_by = page.order_by - result_dict = await TenantService.page_service( - auth=auth, + result_dict = await TenantService(auth).page( page_no=page.page_no if page.page_no is not None else 1, page_size=page.page_size if page.page_size is not None else 10, search=search, @@ -86,7 +64,6 @@ async def get_obj_list_controller( ) return SuccessResponse(data=result_dict, msg="查询租户列表成功") - @TenantRouter.post( "/create", summary="创建租户", @@ -96,20 +73,10 @@ async def create_obj_controller( data: TenantCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:create"]))], ) -> JSONResponse: - """ - 创建租户 - - 参数: - - data (TenantCreateSchema): 租户创建参数。 - - 返回: - - JSONResponse: 包含创建后的租户详情的 JSON 响应。 - """ - result_dict = await TenantService.create_service(auth=auth, data=data) + result_dict = await TenantService(auth).create(data=data) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(data=result_dict, msg="创建租户成功") - @TenantRouter.put( "/update/{id}", summary="修改租户", @@ -120,21 +87,10 @@ async def update_obj_controller( id: Annotated[int, Path(description="租户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:update"]))], ) -> JSONResponse: - """ - 修改租户 - - 参数: - - id (int): 租户 ID。 - - data (TenantUpdateSchema): 租户更新参数。 - - 返回: - - JSONResponse: 包含更新后的租户详情的 JSON 响应。 - """ - result_dict = await TenantService.update_service(auth=auth, id=id, data=data) + result_dict = await TenantService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(data=result_dict, msg="修改租户成功") - @TenantRouter.delete( "/delete", summary="删除租户", @@ -144,20 +100,10 @@ async def delete_obj_controller( ids: Annotated[list[int], Body(..., description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:delete"]))], ) -> JSONResponse: - """ - 删除租户 - - 参数: - - ids (list[int]): 租户 ID 列表。 - - 返回: - - JSONResponse: 删除结果。 - """ - await TenantService.delete_service(auth=auth, ids=ids) + await TenantService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(msg="删除租户成功") - @TenantRouter.patch( "/status/batch", summary="批量修改租户状态", @@ -167,20 +113,10 @@ async def batch_set_available_obj_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:patch"]))], ) -> JSONResponse: - """ - 批量修改租户状态 - - 参数: - - data (BatchSetAvailable): 批量状态设置参数。 - - 返回: - - JSONResponse: 操作结果。 - """ - await TenantService.set_available_service(auth=auth, data=data) + await TenantService(auth).set_available(data=data) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(msg="批量修改租户状态成功") - @TenantRouter.put( "/status/{id}", summary="启/禁用租户", @@ -190,20 +126,10 @@ async def toggle_tenant_status_controller( id: Annotated[int, Path(description="租户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:patch"]))], ) -> JSONResponse: - """ - 启/禁用租户 - - 参数: - - id (int): 租户 ID。 - - 返回: - - JSONResponse: 操作结果。 - """ - await TenantService.toggle_status_service(auth=auth, id=id) + await TenantService(auth).toggle_status(id=id) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(msg="修改租户状态成功") - @TenantRouter.get( "/{id}/users", summary="获取租户用户列表", @@ -214,19 +140,9 @@ async def get_tenant_users_controller( id: Annotated[int, Path(description="租户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:query"]))], ) -> JSONResponse: - """ - 获取租户用户列表 - - 参数: - - id (int): 租户 ID。 - - 返回: - - JSONResponse: 包含租户用户列表的 JSON 响应。 - """ - result = await TenantService.get_tenant_users_service(auth=auth, tenant_id=id) + result = await TenantService(auth).get_tenant_users(tenant_id=id) return SuccessResponse(data=result, msg="获取租户用户列表成功") - @TenantRouter.post( "/{id}/users", summary="向租户添加用户", @@ -237,21 +153,10 @@ async def add_tenant_user_controller( data: TenantUserAddSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:create"]))], ) -> JSONResponse: - """ - 向租户添加用户 - - 参数: - - id (int): 租户 ID。 - - data (TenantUserAddSchema): 用户添加参数。 - - 返回: - - JSONResponse: 操作结果。 - """ - await TenantService.add_tenant_user_service(auth=auth, tenant_id=id, data=data) + await TenantService(auth).add_tenant_user(tenant_id=id, data=data) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(msg="添加用户成功") - @TenantRouter.delete( "/{id}/users/{uid}", summary="从租户移除用户", @@ -262,24 +167,10 @@ async def remove_tenant_user_controller( uid: Annotated[int, Path(description="用户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:delete"]))], ) -> JSONResponse: - """ - 从租户移除用户 - - 参数: - - id (int): 租户 ID。 - - uid (int): 用户 ID。 - - 返回: - - JSONResponse: 操作结果。 - """ - await TenantService.remove_tenant_user_service(auth=auth, tenant_id=id, user_id=uid) + await TenantService(auth).remove_tenant_user(tenant_id=id, user_id=uid) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(msg="移除用户成功") - -# ============ P1: 租户配置 ============ - - @TenantRouter.get( "/{id}/config", summary="获取租户配置", @@ -289,19 +180,9 @@ async def get_tenant_config_controller( id: Annotated[int, Path(description="租户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:query"]))], ) -> JSONResponse: - """ - 获取租户配置 - - 参数: - - id (int): 租户 ID。 - - 返回: - - JSONResponse: 包含租户配置列表的 JSON 响应。 - """ - result = await TenantService.get_config_items_service(auth=auth, tenant_id=id) + result = await TenantService(auth).get_config_items(tenant_id=id) return SuccessResponse(data=result, msg="获取租户配置成功") - @TenantRouter.get( "/{id}/config/info", summary="获取租户配置（公开-缓存）", @@ -311,19 +192,9 @@ async def get_tenant_config_info_controller( id: Annotated[int, Path(description="租户ID")], redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 获取租户配置（公开-缓存） - - 参数: - - id (int): 租户 ID。 - - 返回: - - JSONResponse: 包含租户配置列表的 JSON 响应。 - """ - result = await TenantService.get_config_cache_items_service(redis=redis, tenant_id=id) + result = await TenantService.get_config_cache_items(redis=redis, tenant_id=id) return SuccessResponse(data=result, msg="获取租户配置成功") - @TenantRouter.put( "/{id}/config", summary="更新租户配置", @@ -335,24 +206,10 @@ async def update_tenant_config_controller( redis: Annotated[Redis, Depends(redis_getter)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:update"]))], ) -> JSONResponse: - """ - 更新租户配置 - - 参数: - - id (int): 租户 ID。 - - data (list[TenantConfigItem]): 配置项列表。 - - 返回: - - JSONResponse: 包含更新后的配置列表的 JSON 响应。 - """ - result = await TenantService.update_config_service(auth=auth, redis=redis, tenant_id=id, config=data) + result = await TenantService(auth).update_config(redis=redis, tenant_id=id, config=data) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(data=result, msg="更新租户配置成功") - -# ============ 续期 ============ - - @TenantRouter.put( "/renew/{id}", summary="租户续期", @@ -363,24 +220,10 @@ async def renew_tenant_controller( data: TenantRenewSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:update"]))], ) -> JSONResponse: - """ - 租户续期 - - 参数: - - id (int): 租户 ID。 - - data (TenantRenewSchema): 续期时间参数。 - - 返回: - - JSONResponse: 包含续期后的租户详情的 JSON 响应。 - """ - result = await TenantService.renew_service(auth=auth, tenant_id=id, end_time=data.end_time) + result = await TenantService(auth).renew(tenant_id=id, end_time=data.end_time) await FastAPICache.clear(namespace=_TENANT_NS) return SuccessResponse(data=result, msg="租户续期成功") - -# ============ 套餐变更预览 ============ - - @TenantRouter.get( "/{id}/package-change-preview", summary="套餐变更影响预览", @@ -391,15 +234,5 @@ async def package_change_preview_controller( new_package_id: Annotated[int, Query(..., description="目标套餐ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:tenant:query"]))], ) -> JSONResponse: - """ - 套餐变更影响预览 - - 参数: - - id (int): 租户 ID。 - - new_package_id (int): 目标套餐 ID。 - - 返回: - - JSONResponse: 包含套餐变更影响预览的 JSON 响应。 - """ - result = await TenantService.package_change_preview_service(auth=auth, tenant_id=id, new_package_id=new_package_id) + result = await TenantService(auth).package_change_preview(tenant_id=id, new_package_id=new_package_id) return SuccessResponse(data=result, msg="套餐变更预览成功") diff --git a/backend/app/api/v1/module_platform/tenant/schema.py b/backend/app/api/v1/module_platform/tenant/schema.py index 44eb0a76..12a27c4e 100644 --- a/backend/app/api/v1/module_platform/tenant/schema.py +++ b/backend/app/api/v1/module_platform/tenant/schema.py @@ -203,9 +203,6 @@ class TenantUserOutSchema(BaseModel): name: str = Field(default="", description="用户姓名") -# ============ P1: 租户配置 ============ - - class TenantConfigItem(BaseModel): """租户配置项""" @@ -222,9 +219,6 @@ class TenantConfigOutSchema(BaseModel): config_value: str | None = Field(default=None, description="配置值") -# ============ 续期 ============ - - class TenantRenewSchema(BaseModel): """租户续期""" @@ -239,9 +233,6 @@ class TenantRenewSchema(BaseModel): return self -# ============ 套餐变更预览 ============ - - class PackageChangePreviewOut(BaseModel): """套餐变更影响预览响应""" diff --git a/backend/app/api/v1/module_platform/tenant/service.py b/backend/app/api/v1/module_platform/tenant/service.py index 1c84e56f..a556bd43 100644 --- a/backend/app/api/v1/module_platform/tenant/service.py +++ b/backend/app/api/v1/module_platform/tenant/service.py @@ -30,32 +30,35 @@ from .schema import ( class TenantService: """ 租户管理服务（查询操作租户可见，写操作仅超级管理员可操作） + + 设计：实例方法承载「当前用户上下文 (auth)」，``redis`` 仍是方法参数。 + 内部跨方法调用从 ``cls.xxx(auth, ...)`` 改为 ``self.xxx(...)``。 + 定时任务方法与静态工具方法保持 ``@staticmethod``（无 auth）。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> TenantOutSchema: + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def detail(self, id: int) -> TenantOutSchema: """ 租户详情 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 租户ID 返回: - TenantOutSchema: 租户详情 """ - return await TenantCRUD(auth).get_or_404(id=id, out_schema=TenantOutSchema) + return await TenantCRUD(self.auth).get_or_404(id=id, out_schema=TenantOutSchema) - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: TenantQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> dict: - return await TenantCRUD(auth).page( + return await TenantCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -63,15 +66,14 @@ class TenantService: out_schema=TenantOutSchema, ) - @classmethod @require_superadmin - async def create_service(cls, auth: AuthSchema, data: TenantCreateSchema) -> TenantOutSchema: - if await TenantCRUD(auth).get(name=data.name): + async def create(self, data: TenantCreateSchema) -> TenantOutSchema: + if await TenantCRUD(self.auth).get(name=data.name): raise CustomException(msg="创建失败，名称已存在") - if await TenantCRUD(auth).get(code=data.code): + if await TenantCRUD(self.auth).get(code=data.code): raise CustomException(msg="创建失败，编码已存在") - tenant_obj = await TenantCRUD(auth).create(data=data) + tenant_obj = await TenantCRUD(self.auth).create(data=data) if not tenant_obj: raise CustomException(msg="创建租户失败") @@ -82,7 +84,7 @@ class TenantService: username = f"{tenant_obj.code}_admin" from app.api.v1.module_system.user.crud import UserCRUD - if await UserCRUD(auth).get(username=username): + if await UserCRUD(self.auth).get(username=username): raise CustomException(msg=f"初始管理员用户名已存在: {username}，请更换租户编码后重试") password_length = 12 @@ -97,7 +99,7 @@ class TenantService: "is_superuser": False, } try: - user_obj = await UserCRUD(auth).create(data=admin_data) + user_obj = await UserCRUD(self.auth).create(data=admin_data) if not user_obj: raise CustomException(msg="创建租户初始管理员失败") except CustomException: @@ -108,26 +110,24 @@ class TenantService: logger.info(f"为租户[{tenant_obj.name}]创建初始管理员成功，用户名: {username}，临时密码: {password}") - await auth.db.refresh(tenant_obj) + await self.auth.db.refresh(tenant_obj) result = TenantOutSchema.model_validate(tenant_obj) return result - @classmethod @require_superadmin - async def update_service(cls, auth: AuthSchema, id: int, data: TenantUpdateSchema) -> TenantOutSchema: + async def update(self, id: int, data: TenantUpdateSchema) -> TenantOutSchema: """ 更新租户 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 租户ID - data (TenantUpdateSchema): 租户更新模型 返回: - TenantOutSchema: 租户详情 """ - obj = await TenantCRUD(auth).get_or_404(id=id) + obj = await TenantCRUD(self.auth).get_or_404(id=id) old_package_id = obj.package_id @@ -139,19 +139,19 @@ class TenantService: # 套餐变更：仅超管可操作，防止租户管理员自行升级/降级套餐 if data.package_id is not None and data.package_id != old_package_id: - if not auth.user or not auth.user.is_superuser: + if not self.auth.user or not self.auth.user.is_superuser: raise CustomException(msg="仅平台管理员可变更租户套餐") if data.name is not None: - exist = await TenantCRUD(auth).get(name=data.name) + exist = await TenantCRUD(self.auth).get(name=data.name) if exist and exist.id != id: raise CustomException(msg="更新失败，名称重复") if data.code is not None: - exist = await TenantCRUD(auth).get(code=data.code) + exist = await TenantCRUD(self.auth).get(code=data.code) if exist and exist.id != id: raise CustomException(msg="更新失败，编码重复") - updated = await TenantCRUD(auth).update(id=id, data=data) + updated = await TenantCRUD(self.auth).update(id=id, data=data) if not updated: raise CustomException(msg="更新失败") @@ -163,32 +163,33 @@ class TenantService: from app.api.v1.module_platform.package.service import PackageService from app.api.v1.module_system.role.model import RoleMenusModel, RoleModel - available_ids = await PackageService.get_tenant_available_menu_ids(auth, id) + available_ids = await PackageService(self.auth).get_tenant_available_menu_ids(id) if available_ids: role_ids_stmt = select(RoleModel.id).where(RoleModel.tenant_id == id) - result = await auth.db.execute(role_ids_stmt) + result = await self.auth.db.execute(role_ids_stmt) tenant_role_ids = [row[0] for row in result.all()] if tenant_role_ids: - await auth.db.execute( + await self.auth.db.execute( sa_delete(RoleMenusModel).where( RoleMenusModel.role_id.in_(tenant_role_ids), RoleMenusModel.menu_id.notin_(available_ids), ) ) - await auth.db.flush() - logger.info(f"租户[{id}]套餐变更：已清理角色中不再可用的菜单关联, available_menus={len(available_ids)}, roles_affected={len(tenant_role_ids)}") + await self.auth.db.flush() + logger.info( + f"租户[{id}]套餐变更：已清理角色中不再可用的菜单关联, " + f"available_menus={len(available_ids)}, roles_affected={len(tenant_role_ids)}" + ) result = TenantOutSchema.model_validate(updated) return result - @classmethod @require_superadmin - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: + async def delete(self, ids: list[int]) -> None: """ 批量删除租户（含级联资源检查：用户/部门/角色/岗位） 参数: - - auth (AuthSchema): 认证信息模型 - ids (list[int]): 租户ID列表 返回: @@ -205,26 +206,24 @@ class TenantService: for tid in ids: reasons: list[str] = [] - if await UserCRUD(auth).list(search={"tenant_id": tid}): + if await UserCRUD(self.auth).list(search={"tenant_id": tid}): reasons.append("用户") - if await DeptCRUD(auth).list(search={"tenant_id": tid}): + if await DeptCRUD(self.auth).list(search={"tenant_id": tid}): reasons.append("部门") - if await RoleCRUD(auth).list(search={"tenant_id": tid}): + if await RoleCRUD(self.auth).list(search={"tenant_id": tid}): reasons.append("角色") - if await PositionCRUD(auth).list(search={"tenant_id": tid}): + if await PositionCRUD(self.auth).list(search={"tenant_id": tid}): reasons.append("岗位") if reasons: raise CustomException(msg=f"租户下已存在{'/'.join(reasons)}，操作失败") - await TenantCRUD(auth).delete(ids=ids) + await TenantCRUD(self.auth).delete(ids=ids) - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: + async def set_available(self, data: BatchSetAvailable) -> None: """ 批量设置租户状态 参数: - - auth (AuthSchema): 认证信息模型 - data (BatchSetAvailable): 批量状态设置 返回: @@ -232,28 +231,25 @@ class TenantService: """ if data.status == 1 and 1 in data.ids: raise CustomException(msg="系统租户不允许禁用") - await TenantCRUD(auth).set(ids=data.ids, status=data.status) + await TenantCRUD(self.auth).set(ids=data.ids, status=data.status) - @classmethod - async def toggle_status_service(cls, auth: AuthSchema, id: int) -> None: + async def toggle_status(self, id: int) -> None: """ 切换单个租户的启用/禁用状态 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 租户ID 返回: - None """ - obj = await TenantCRUD(auth).get_or_404(id=id) + obj = await TenantCRUD(self.auth).get_or_404(id=id) if id == 1: raise CustomException(msg="系统租户不允许禁用") new_status = 0 if obj.status == 1 else 1 - await TenantCRUD(auth).set(ids=[id], status=new_status) + await TenantCRUD(self.auth).set(ids=[id], status=new_status) - @classmethod - async def get_tenant_users_service(cls, auth: AuthSchema, tenant_id: int) -> list[TenantUserOutSchema]: + async def get_tenant_users(self, tenant_id: int) -> list[TenantUserOutSchema]: """获取租户下的用户列表""" from sqlalchemy import select @@ -265,7 +261,7 @@ class TenantService: .where(TenantUserModel.tenant_id == tenant_id) .order_by(TenantUserModel.is_default.desc(), TenantUserModel.id) ) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) rows = result.all() users = [] @@ -284,13 +280,11 @@ class TenantService: ) return users - @classmethod - async def add_tenant_user_service(cls, auth: AuthSchema, tenant_id: int, data: TenantUserAddSchema) -> None: + async def add_tenant_user(self, tenant_id: int, data: TenantUserAddSchema) -> None: """ 向租户添加用户 参数: - - auth (AuthSchema): 认证信息模型 - tenant_id (int): 租户ID - data (TenantUserAddSchema): 用户添加参数 @@ -298,14 +292,14 @@ class TenantService: - None """ # 验证租户存在 - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") # 验证用户存在 from app.api.v1.module_system.user.crud import UserCRUD - user = await UserCRUD(auth).get(id=data.user_id) + user = await UserCRUD(self.auth).get(id=data.user_id) if not user: raise CustomException(msg="该数据不存在") @@ -320,16 +314,20 @@ class TenantService: ) .limit(1) ) - result = await auth.db.execute(exist_stmt) + result = await self.auth.db.execute(exist_stmt) if result.scalar_one_or_none(): raise CustomException(msg="该用户已关联此租户") # 如果设为默认租户，先取消其他默认 if data.is_default == 1: - await auth.db.execute(sa.update(TenantUserModel).where(TenantUserModel.user_id == data.user_id).values(is_default=0)) + await self.auth.db.execute( + sa.update(TenantUserModel).where(TenantUserModel.user_id == data.user_id).values(is_default=0) + ) elif data.is_default == 0: # 检查是否是该用户的第一个租户关联 - count_result = await auth.db.execute(select(sa.func.count()).select_from(TenantUserModel).where(TenantUserModel.user_id == data.user_id)) + count_result = await self.auth.db.execute( + select(sa.func.count()).select_from(TenantUserModel).where(TenantUserModel.user_id == data.user_id) + ) count = count_result.scalar() if count == 0: # 第一个租户自动设为默认 @@ -344,18 +342,16 @@ class TenantService: is_default=data.is_default, create_time=datetime.now(), ) - auth.db.add(tu) - await auth.db.flush() + self.auth.db.add(tu) + await self.auth.db.flush() logger.info(f"向租户[{tenant.name}]添加用户[{user.username}]成功, role={data.role}") - @classmethod - async def remove_tenant_user_service(cls, auth: AuthSchema, tenant_id: int, user_id: int) -> None: + async def remove_tenant_user(self, tenant_id: int, user_id: int) -> None: """ 从租户移除用户 参数: - - auth (AuthSchema): 认证信息模型 - tenant_id (int): 租户ID - user_id (int): 用户ID @@ -373,14 +369,14 @@ class TenantService: ) .limit(1) ) - result = await auth.db.execute(exist_stmt) + result = await self.auth.db.execute(exist_stmt) tu = result.scalar_one_or_none() if not tu: raise CustomException(msg="该用户未关联此租户") # 不允许移除租户最后一个 owner if tu.role == "owner": - count_result = await auth.db.execute( + count_result = await self.auth.db.execute( select(sa.func.count()) .select_from(TenantUserModel) .where( @@ -392,22 +388,16 @@ class TenantService: if owner_count <= 1: raise CustomException(msg="租户至少需要保留一个拥有者(owner)") - await auth.db.delete(tu) - await auth.db.flush() + await self.auth.db.delete(tu) + await self.auth.db.flush() logger.info(f"从租户[{tenant_id}]移除用户[{user_id}]成功") - # ============ P1: 配额管理 ============ - # 配额（max_users / max_roles / max_depts / max_storage_mb）由关联的 Package 控制 - # 系统租户 (id=1) 不受配额限制，普通租户从 package_id 对应的套餐读取配额 - - @classmethod - async def get_quota_service(cls, auth: AuthSchema, tenant_id: int) -> dict: + async def get_quota(self, tenant_id: int) -> dict: """ 获取租户配额（从关联套餐读取，系统租户返回无限配额） 参数: - - auth (AuthSchema): 认证信息模型 - tenant_id (int): 租户ID 返回: @@ -422,7 +412,7 @@ class TenantService: "max_depts": 999999, "package_name": "系统租户(无限)", } - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") if not tenant.package_id: @@ -436,7 +426,7 @@ class TenantService: } from app.api.v1.module_platform.package.crud import PackageCRUD - pkg = await PackageCRUD(auth).get(id=tenant.package_id) + pkg = await PackageCRUD(self.auth).get(id=tenant.package_id) if not pkg: return { "tenant_id": tenant.id, @@ -455,25 +445,19 @@ class TenantService: "package_name": pkg.name, } - @classmethod - async def check_quota_service( - cls, - auth: AuthSchema, - tenant_id: int, - resource_type: str, - ) -> None: + async def check_quota(self, tenant_id: int, resource_type: str) -> None: """检查租户配额是否充足，不足时抛出异常（系统租户跳过检查）""" if tenant_id == 1: return from sqlalchemy import func, select - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant or not tenant.package_id: return from app.api.v1.module_platform.package.crud import PackageCRUD - pkg = await PackageCRUD(auth).get(id=tenant.package_id) + pkg = await PackageCRUD(self.auth).get(id=tenant.package_id) if not pkg: return @@ -528,43 +512,44 @@ class TenantService: # storage 的实际容量校验在文件上传时进行，此处仅检查是否有配额 return - result = await auth.db.execute(count_stmt) + result = await self.auth.db.execute(count_stmt) current_count = result.scalar() or 0 if current_count >= max_limit: resource_labels = {"user": "用户", "role": "角色", "dept": "部门"} - raise CustomException(msg=f"租户{resource_labels.get(resource_type, resource_type)}数量已达套餐上限（{max_limit}），无法继续创建") + raise CustomException( + msg=f"租户{resource_labels.get(resource_type, resource_type)}数量已达套餐上限（{max_limit}），无法继续创建" + ) - # ============ P1: 租户配置（已合并到主表） ============ - - @classmethod - async def get_config_service(cls, auth: AuthSchema, tenant_id: int) -> dict: + async def get_config(self, tenant_id: int) -> dict: """ 获取租户所有配置（从租户主表读取，返回原始 dict 供内部使用） 参数: - - auth (AuthSchema): 认证信息模型 - tenant_id (int): 租户ID 返回: - dict: 配置字典 """ - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") - config_fields = ["name", "description", "version", "logo_url", "favicon", "login_bg", "copyright", "keep_record", "help_doc", "privacy", "clause", "git_code"] + config_fields = [ + "name", "description", "version", "logo_url", "favicon", + "login_bg", "copyright", "keep_record", "help_doc", "privacy", + "clause", "git_code", + ] config = {field: getattr(tenant, field, None) for field in config_fields} return config - @classmethod - async def get_config_items_service(cls, auth: AuthSchema, tenant_id: int) -> list[TenantConfigOutSchema]: + async def get_config_items(self, tenant_id: int) -> list[TenantConfigOutSchema]: """获取租户所有配置（对外接口，返回结构化列表）""" - config = await cls.get_config_service(auth, tenant_id) + config = await self.get_config(tenant_id) return [TenantConfigOutSchema(config_key=k, config_value=str(v) if v is not None else None) for k, v in config.items()] - @classmethod - async def get_config_cache_service(cls, redis: Redis, tenant_id: int) -> dict: + @staticmethod + async def get_config_cache(redis: Redis, tenant_id: int) -> dict: """ 从 Redis 缓存获取租户配置，缓存未命中则从 DB 加载并回写缓存 @@ -589,41 +574,40 @@ class TenantService: async with async_db_session() as session: async with session.begin(): - from app.core.base_schema import AuthSchema + from app.core.base_schema import AuthSchema as _AuthSchema - auth = AuthSchema(db=session, check_data_scope=False) - config = await cls.get_config_service(auth, tenant_id) - await cls._sync_configs_to_redis(redis, tenant_id, config) + _auth = _AuthSchema(db=session, check_data_scope=False) + svc = TenantService(_auth) + config = await svc.get_config(tenant_id) + await TenantService._sync_configs_to_redis(redis, tenant_id, config) logger.info("✅ 已从数据库加载租户配置到缓存") return config - @classmethod - async def get_config_cache_items_service(cls, redis: Redis, tenant_id: int) -> list[TenantConfigOutSchema]: + @staticmethod + async def get_config_cache_items(redis: Redis, tenant_id: int) -> list[TenantConfigOutSchema]: """获取租户缓存配置（对外接口，返回结构化列表）""" - config = await cls.get_config_cache_service(redis, tenant_id) + config = await TenantService.get_config_cache(redis, tenant_id) return [TenantConfigOutSchema(config_key=k, config_value=str(v) if v is not None else None) for k, v in config.items()] - @classmethod - async def _sync_configs_to_redis(cls, redis: Redis, tenant_id: int, config: dict) -> None: + @staticmethod + async def _sync_configs_to_redis(redis: Redis, tenant_id: int, config: dict) -> None: """将租户配置写入 Redis 缓存""" redis_key = f"{RedisInitKeyConfig.TENANT_CONFIG.key}:{tenant_id}" value = json.dumps(config, ensure_ascii=False) await RedisCURD(redis).set(key=redis_key, value=value, expire=None) - @classmethod - async def _del_configs_from_redis(cls, redis: Redis, tenant_id: int) -> None: + @staticmethod + async def _del_configs_from_redis(redis: Redis, tenant_id: int) -> None: """删除租户配置的 Redis 缓存""" redis_key = f"{RedisInitKeyConfig.TENANT_CONFIG.key}:{tenant_id}" await RedisCURD(redis).delete(redis_key) - @classmethod - async def update_config_service(cls, auth: AuthSchema, redis: Redis, tenant_id: int, config: dict) -> list[TenantConfigOutSchema]: + async def update_config(self, redis: Redis, tenant_id: int, config: dict) -> list[TenantConfigOutSchema]: """ 更新租户配置（同步 Redis 缓存） 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis 客户端 - tenant_id (int): 租户ID - config (dict): 配置字典 @@ -631,33 +615,30 @@ class TenantService: 返回: - list[TenantConfigOutSchema]: 更新后的配置项列表 """ - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") - config_fields = ["name", "description", "version", "logo_url", "favicon", "login_bg", "copyright", "keep_record", "help_doc", "privacy", "clause", "git_code"] + config_fields = [ + "name", "description", "version", "logo_url", "favicon", + "login_bg", "copyright", "keep_record", "help_doc", "privacy", + "clause", "git_code", + ] for field in config_fields: if field in config: setattr(tenant, field, config[field]) - await auth.db.flush() + await self.auth.db.flush() # 刷新 DB 数据并同步到 Redis - new_config = await cls.get_config_service(auth, tenant_id) - await cls._sync_configs_to_redis(redis, tenant_id, new_config) + new_config = await self.get_config(tenant_id) + await TenantService._sync_configs_to_redis(redis, tenant_id, new_config) logger.info(f"租户[{tenant_id}]配置已更新") return [TenantConfigOutSchema(config_key=k, config_value=str(v) if v is not None else None) for k, v in new_config.items()] - # ============ P1: 租户菜单 ============ - # 租户菜单权限现通过 Package → PackageMenuModel 统一控制 - # get_menus_service / set_menus_service / get_tenant_menu_ids 已移除 - # 改用 PackageService.get_package_menu_ids / get_tenant_available_menu_ids - - # ============ P1: 初始化缓存 ============ - - @classmethod - async def init_tenant_config_cache(cls, redis: Redis) -> None: + @staticmethod + async def init_cache(redis: Redis) -> None: """ 初始化所有租户配置到 Redis 缓存（应用启动时调用）。 @@ -678,23 +659,23 @@ class TenantService: tenants = result.scalars().all() for tenant in tenants: - config_fields = ["name", "description", "version", "logo_url", "favicon", "login_bg", "copyright", "keep_record", "help_doc", "privacy", "clause", "git_code"] + config_fields = [ + "name", "description", "version", "logo_url", "favicon", + "login_bg", "copyright", "keep_record", "help_doc", "privacy", + "clause", "git_code", + ] config = {field: getattr(tenant, field, None) for field in config_fields} - await cls._sync_configs_to_redis(redis, tenant.id, config) + await TenantService._sync_configs_to_redis(redis, tenant.id, config) logger.info(f"✅ 租户[{tenant.name}](id={tenant.id}) 配置已缓存到 Redis") - # ============ 续期 & 套餐变更预览 ============ - - @classmethod - async def renew_service(cls, auth: AuthSchema, tenant_id: int, end_time: str) -> TenantOutSchema: + async def renew(self, tenant_id: int, end_time: str) -> TenantOutSchema: """租户续期：延长 end_time 并恢复为 active 状态 仅 active(0)/grace(1)/suspended(2) 状态可续期。 expired(4)/frozen(3)/archived(5) 不可续期。 参数: - - auth (AuthSchema): 认证信息 - tenant_id (int): 租户ID - end_time (str): 新的结束时间 @@ -703,7 +684,7 @@ class TenantService: """ from datetime import datetime - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") @@ -720,20 +701,18 @@ class TenantService: tenant.status = 0 tenant.grace_start_time = None - await auth.db.flush() + await self.auth.db.flush() logger.info(f"租户[{tenant.name}]续期成功, 新的结束时间: {end_time}") return TenantOutSchema.model_validate(tenant) - @classmethod - async def package_change_preview_service(cls, auth: AuthSchema, tenant_id: int, new_package_id: int) -> PackageChangePreviewOut: + async def package_change_preview(self, tenant_id: int, new_package_id: int) -> PackageChangePreviewOut: """ 套餐变更影响预览 返回受影响角色、菜单清单、配额对比等，供超管确认后再执行变更。 参数: - - auth (AuthSchema): 认证信息 - tenant_id (int): 租户ID - new_package_id (int): 目标套餐ID @@ -748,19 +727,19 @@ class TenantService: from app.api.v1.module_system.role.model import RoleMenusModel, RoleModel from app.api.v1.module_system.user.model import UserModel - tenant = await TenantCRUD(auth).get(id=tenant_id) + tenant = await TenantCRUD(self.auth).get(id=tenant_id) if not tenant: raise CustomException(msg="该数据不存在") - new_package = await PackageCRUD(auth).get(id=new_package_id) + new_package = await PackageCRUD(self.auth).get(id=new_package_id) if not new_package: raise CustomException(msg="该数据不存在") # 当前可用菜单 - current_menu_ids = await PackageService.get_tenant_available_menu_ids(auth, tenant_id) + current_menu_ids = await PackageService(self.auth).get_tenant_available_menu_ids(tenant_id) # 新套餐可用菜单（直接取套餐菜单，不再包含自定义授权） - new_menu_ids = set(await PackageService.get_package_menu_ids(auth, new_package_id)) + new_menu_ids = set(await PackageService(self.auth).get_package_menu_ids(new_package_id)) final_menu_ids = new_menu_ids # 不再合并租户自定义菜单 # 差异计算 @@ -771,16 +750,16 @@ class TenantService: added_menus = [] if removed_ids: menu_stmt = select(MenuModel).where(MenuModel.id.in_(removed_ids)) - menu_result = await auth.db.execute(menu_stmt) + menu_result = await self.auth.db.execute(menu_stmt) removed_menus = [{"id": m.id, "name": m.name, "route_path": m.route_path} for m in menu_result.scalars().all()] if added_ids: menu_stmt = select(MenuModel).where(MenuModel.id.in_(added_ids)) - menu_result = await auth.db.execute(menu_stmt) + menu_result = await self.auth.db.execute(menu_stmt) added_menus = [{"id": m.id, "name": m.name, "route_path": m.route_path} for m in menu_result.scalars().all()] # 受影响角色 role_stmt = select(RoleModel).where(RoleModel.tenant_id == tenant_id) - role_result = await auth.db.execute(role_stmt) + role_result = await self.auth.db.execute(role_stmt) roles = role_result.scalars().all() affected_roles = [] @@ -788,13 +767,13 @@ class TenantService: for role in roles: # 查该角色下有多少菜单会被移除 role_menu_stmt = select(RoleMenusModel.menu_id).where(RoleMenusModel.role_id == role.id) - rm_result = await auth.db.execute(role_menu_stmt) + rm_result = await self.auth.db.execute(role_menu_stmt) role_menu_ids = {row[0] for row in rm_result.all()} affected_menu_count = len(role_menu_ids & removed_ids) # 查该角色下用户数 user_count_stmt = select(func.count()).select_from(UserModel).join(UserModel.roles).where(RoleModel.id == role.id) - uc_result = await auth.db.execute(user_count_stmt) + uc_result = await self.auth.db.execute(user_count_stmt) user_count = uc_result.scalar() or 0 affected_roles.append( @@ -811,7 +790,7 @@ class TenantService: # 配额对比（从套餐读取） old_pkg = None if tenant.package_id: - old_pkg = await PackageCRUD(auth).get(id=tenant.package_id) + old_pkg = await PackageCRUD(self.auth).get(id=tenant.package_id) quota_changes = { "max_users": { "current": old_pkg.max_users if old_pkg else 0, @@ -837,8 +816,6 @@ class TenantService: total_affected_users=total_affected_users, ) - # ============ P1: 到期提醒（多阶段自动处理） ============ - @staticmethod async def check_tenant_expiry() -> None: """定时任务：多阶段租户到期自动处理 @@ -860,7 +837,10 @@ class TenantService: async with async_db_session() as session: # 获取所有已过期的活跃租户（status=0） rows = await session.execute( - text("SELECT id, name, contact_email, contact_name, end_time, status FROM platform_tenant WHERE status = '0' AND end_time IS NOT NULL AND end_time < :now"), + text( + "SELECT id, name, contact_email, contact_name, end_time, status " + "FROM platform_tenant WHERE status = '0' AND end_time IS NOT NULL AND end_time < :now" + ), {"now": now}, ) expired_tenants = rows.fetchall() @@ -889,7 +869,9 @@ class TenantService: # 发送通知邮件 if email: - await TenantService._send_expiry_email(tenant_name, contact_name, email, end_time, days_past, label) + await TenantService._send_expiry_email( + tenant_name, contact_name, email, end_time, days_past, label + ) await session.commit() @@ -905,7 +887,12 @@ class TenantService: from app.core.database import async_db_session async with async_db_session() as session: - rows = await session.execute(text("SELECT id, name, contact_email, contact_name, end_time FROM platform_tenant WHERE status = '1' AND contact_email IS NOT NULL AND contact_email != ''")) + rows = await session.execute( + text( + "SELECT id, name, contact_email, contact_name, end_time FROM platform_tenant " + "WHERE status = '1' AND contact_email IS NOT NULL AND contact_email != ''" + ) + ) grace_tenants = rows.fetchall() sent = 0 diff --git a/backend/app/api/v1/module_system/auth/controller.py b/backend/app/api/v1/module_system/auth/controller.py index 83b6b293..459e1b3b 100644 --- a/backend/app/api/v1/module_system/auth/controller.py +++ b/backend/app/api/v1/module_system/auth/controller.py @@ -54,7 +54,7 @@ from .service import ( TenantRegisterService, ) -AuthRouter = APIRouter(route_class=OperationLogRoute, prefix="/auth", tags=["认证授权"]) +AuthRouter = APIRouter(route_class=OperationLogRoute, prefix="/auth", tags=["系统管理", "认证授权"]) _AUTH_TENANTS_NS = "auth_tenants" @@ -70,26 +70,10 @@ async def login_for_access_token_controller( login_form: Annotated[CustomOAuth2PasswordRequestForm, Depends()], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse | dict: - """ - 用户登录 - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis 客户端对象 - - login_form (CustomOAuth2PasswordRequestForm): 登录表单数据 - - db (AsyncSession): 数据库会话对象 - - 返回: - - LoginWithTenantsSchema: 包含令牌、租户列表和用户信息的响应模型 - - 异常: - - CustomException: 认证失败时抛出异常。 - """ - login_result = await LoginService.authenticate_user_service(request=request, redis=redis, login_form=login_form, db=db) + login_result = await LoginService.authenticate_user(request=request, redis=redis, login_form=login_form, db=db) logger.info(f"用户{login_form.username}登录成功") - # 如果是文档请求，则不记录日志 if settings.DOCS_URL in request.headers.get("referer", ""): return login_result return SuccessResponse(data=login_result, msg="登录成功") @@ -105,21 +89,7 @@ async def get_new_token_controller( db: Annotated[AsyncSession, Depends(db_getter)], redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 刷新token - - 参数: - - payload (RefreshTokenPayloadSchema): 刷新令牌负载模型 - - db (AsyncSession): 数据库会话对象 - - redis (Redis): Redis 客户端对象 - - 返回: - - JWTOutSchema: 包含新的访问令牌和刷新令牌的响应模型 - - 异常: - - CustomException: 刷新令牌失败时抛出异常。 - """ - new_token = await LoginService.refresh_token_service(db=db, redis=redis, refresh_token=payload) + new_token = await LoginService.refresh_token(db=db, redis=redis, refresh_token=payload) return SuccessResponse(data=new_token, msg="刷新成功") @@ -131,20 +101,7 @@ async def get_new_token_controller( async def get_captcha_for_login_controller( redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 获取登录验证码 - - 参数: - - redis (Redis): Redis客户端对象 - - 返回: - - CaptchaOutSchema: 包含验证码图片和key的响应模型 - - 异常: - - CustomException: 获取验证码失败时抛出异常。 - """ - # 获取验证码 - captcha = await CaptchaService.get_captcha_service(redis=redis) + captcha = await CaptchaService.get_captcha(redis=redis) return SuccessResponse(data=captcha, msg="获取验证码成功") @@ -158,20 +115,7 @@ async def logout_controller( payload: LogoutPayloadSchema, redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 退出登录 - - 参数: - - payload (LogoutPayloadSchema): 退出登录负载模型 - - redis (Redis): Redis客户端对象 - - 返回: - - JSONResponse: 包含退出登录结果的响应模型 - - 异常: - - CustomException: 退出登录失败时抛出异常。 - """ - if await LoginService.logout_service(redis=redis, token=payload): + if await LoginService.logout(redis=redis, token=payload): logger.info("退出成功") return SuccessResponse(msg="退出成功") return ErrorResponse(msg="退出失败") @@ -186,18 +130,8 @@ async def get_auto_login_users_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 获取免登录用户列表 - - 参数: - - auth (AuthSchema): 认证信息 - - db (AsyncSession): 数据库会话对象 - - 返回: - - list[AutoLoginUserSchema]: 免登录用户列表 - """ tenant_id = None if auth.user.is_superuser else auth.user.tenant_id - users = await AutoLoginService.get_auto_login_users_service(db=db, tenant_id=tenant_id) + users = await AutoLoginService.get_auto_login_users(db=db, tenant_id=tenant_id) return SuccessResponse(data=users, msg="获取成功") @@ -212,20 +146,8 @@ async def get_auto_login_token_controller( db: Annotated[AsyncSession, Depends(db_getter)], user_id: int, ) -> JSONResponse: - """ - 获取免登录Token - - 参数: - - auth (AuthSchema): 认证信息 - - redis (Redis): Redis客户端对象 - - db (AsyncSession): 数据库会话对象 - - user_id (int): 用户ID - - 返回: - - AutoLoginTokenSchema: 免登录Token和用户信息 - """ tenant_id = None if auth.user.is_superuser else auth.user.tenant_id - result = await AutoLoginService.create_auto_login_token_service(redis=redis, db=db, user_id=user_id, tenant_id=tenant_id) + result = await AutoLoginService.create_auto_login_token(redis=redis, db=db, user_id=user_id, tenant_id=tenant_id) return SuccessResponse(data=result, msg="获取成功") @@ -240,19 +162,7 @@ async def auto_login_controller( db: Annotated[AsyncSession, Depends(db_getter)], token: str, ) -> JSONResponse: - """ - 免登录 - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis客户端对象 - - db (AsyncSession): 数据库会话对象 - - token (str): 免登录Token - - 返回: - - JWTOutSchema: JWT令牌信息 - """ - login_token = await AutoLoginService.auto_login_service(request=request, redis=redis, db=db, token=token) + login_token = await AutoLoginService.auto_login(request=request, redis=redis, db=db, token=token) logger.info("用户免登录成功") return SuccessResponse(data=login_token, msg="登录成功") @@ -269,21 +179,7 @@ async def select_tenant_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 选择租户 - - 验证用户是否属于该租户，签发包含 tenant_id 的新 JWT Token。 - - 参数: - - request (Request): FastAPI请求对象 - - data (SelectTenantSchema): 租户选择请求 - - auth (AuthSchema): 当前认证信息 - - redis (Redis): Redis客户端对象 - - 返回: - - SelectTenantOutSchema: 包含新令牌的响应 - """ - result = await LoginService.select_tenant_service(request=request, redis=redis, auth=auth, tenant_id=data.tenant_id) + result = await LoginService(auth).select_tenant(request=request, redis=redis, tenant_id=data.tenant_id) await FastAPICache.clear(namespace=_AUTH_TENANTS_NS) return SuccessResponse(data=result, msg="租户切换成功") @@ -299,17 +195,8 @@ async def get_user_tenants_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 获取当前用户的租户列表 - - 参数: - - auth (AuthSchema): 当前认证信息 - - db (AsyncSession): 数据库会话对象 - - 返回: - - list[TenantOptionSchema]: 租户选项列表 - """ - tenants = await LoginService.get_user_tenants_service(auth=auth, db=db) + service = LoginService(auth) + tenants = await service.get_user_tenants() return SuccessResponse(data=tenants, msg="获取租户列表成功") @@ -416,16 +303,7 @@ async def tenant_register_controller( data: TenantRegisterSchema, db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 租户自助注册（PRD §4.5） - - 参数: - - data (TenantRegisterSchema): 注册信息 - - 返回: - - TenantRegisterOutSchema: 注册结果，含 tenant_id/user_id/试用到期日 - """ - result = await TenantRegisterService.register_service( + result = await TenantRegisterService.register( db=db, username=data.username, password=data.password, @@ -436,9 +314,6 @@ async def tenant_register_controller( return SuccessResponse(data=result, msg=result.message) -# ─── 忘记密码（自助重置）──────────────────────────────────── - - @AuthRouter.post( "/forgot-password", summary="忘记密码", @@ -449,16 +324,7 @@ async def forgot_password_controller( redis: Annotated[Redis, Depends(redis_getter)], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 忘记密码：提交邮箱，接收重置邮件 - - 参数: - - data (ForgotPasswordSchema): 邮箱 - - 返回: - - str: 提示信息（无论成功与否均返回相同文案） - """ - msg = await PasswordResetService.forgot_password_service(redis=redis, db=db, email=data.email) + msg = await PasswordResetService.forgot_password(redis=redis, db=db, email=data.email) return SuccessResponse(data=msg, msg="邮件已发送") @@ -472,14 +338,5 @@ async def reset_password_controller( redis: Annotated[Redis, Depends(redis_getter)], db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 重置密码：使用令牌 + 新密码 - - 参数: - - data (ResetPasswordWithTokenSchema): 令牌 + 新密码 - - 返回: - - str: 重置结果 - """ - msg = await PasswordResetService.reset_password_with_token_service(redis=redis, db=db, token=data.token, new_password=data.new_password) + msg = await PasswordResetService.reset_password_with_token(redis=redis, db=db, token=data.token, new_password=data.new_password) return SuccessResponse(data=msg, msg="密码已重置") diff --git a/backend/app/api/v1/module_system/auth/oauth_service.py b/backend/app/api/v1/module_system/auth/oauth_service.py index 8dea5b97..afd93e23 100644 --- a/backend/app/api/v1/module_system/auth/oauth_service.py +++ b/backend/app/api/v1/module_system/auth/oauth_service.py @@ -323,7 +323,7 @@ async def ensure_oauth_user( role_ids=list(settings.OAUTH_DEFAULT_ROLE_IDS), ) try: - await UserService.register_service(auth=auth, data=reg) + await UserService(auth).register(data=reg) except Exception: # 并发创建可能触发唯一约束冲突，回退到再次查询 existing = await UserCRUD(auth).get(username=username) @@ -389,7 +389,7 @@ async def complete_oauth_login( raise CustomException(msg="用户不存在") login_type = f"oauth_{provider}" - token = await LoginService.create_token_service(request=request, redis=redis, user=user, login_type=login_type) + token = await LoginService.create_token(request=request, redis=redis, user=user, login_type=login_type) await rc.delete(f"{STATE_PREFIX}{state}") return token, frontend diff --git a/backend/app/api/v1/module_system/auth/schema.py b/backend/app/api/v1/module_system/auth/schema.py index 49e0e788..b9a98e62 100644 --- a/backend/app/api/v1/module_system/auth/schema.py +++ b/backend/app/api/v1/module_system/auth/schema.py @@ -55,7 +55,7 @@ class SelectTenantOutSchema(BaseModel): model_config = ConfigDict(from_attributes=True) access_token: str = Field(..., description="访问token（含租户上下文）") - token_type: str = Field(default="Bearer", description="token类型") + token_type: str = Field(default="Bearer", description="token类型（RFC 6750）") expires_in: int = Field(..., gt=0, description="过期时间(秒)") @@ -66,9 +66,6 @@ class LoginWithTenantsSchema(JWTOutSchema): user_info: dict = Field(default_factory=dict, description="用户信息") -# ─── 租户自助注册 ────────────────────────────────────────────────────────────── - - class TenantRegisterSchema(BaseModel): """租户自助注册请求""" @@ -91,9 +88,6 @@ class TenantRegisterOutSchema(BaseModel): message: str = Field(default="注册成功", description="提示信息") -# ─── 忘记密码（自助重置）───────────────────────────────────────── - - class ForgotPasswordSchema(BaseModel): """忘记密码：提交邮箱，接收重置邮件""" diff --git a/backend/app/api/v1/module_system/auth/service.py b/backend/app/api/v1/module_system/auth/service.py index 74130c23..03c8f6da 100644 --- a/backend/app/api/v1/module_system/auth/service.py +++ b/backend/app/api/v1/module_system/auth/service.py @@ -58,23 +58,24 @@ async def _write_login_log( msg: str | None = None, ) -> None: """写入登录日志（独立 session，避免事务回滚时丢失失败记录）""" - from app.api.v1.module_system.log.model import LoginLogModel + from app.api.v1.module_system.log.crud import LoginLogCRUD + from app.api.v1.module_system.log.schema import LoginLogCreateSchema + from app.core.base_schema import AuthSchema from app.core.database import async_db_session try: async with async_db_session() as session: async with session.begin(): - session.add( - LoginLogModel( - username=username, - status=status, - login_ip=login_ip, - login_location=login_location, - request_os=request_os, - request_browser=request_browser, - msg=msg, - ) - ) + _auth = AuthSchema(db=session, check_data_scope=False) + await LoginLogCRUD(_auth).create(data=LoginLogCreateSchema( + username=username, + status=status, + login_ip=login_ip, + login_location=login_location, + request_os=request_os, + request_browser=request_browser, + msg=msg, + )) except Exception: pass # 登录日志写入失败不影响登录主流程 @@ -90,29 +91,18 @@ def _resolve_request_ip(request: Request) -> str: class LoginService: """登录认证服务""" + def __init__(self, auth: AuthSchema | None = None) -> None: + self.auth = auth + @classmethod - async def authenticate_user_service( + async def authenticate_user( cls, request: Request, redis: Redis, login_form: CustomOAuth2PasswordRequestForm, db: AsyncSession, ) -> LoginWithTenantsSchema: - """ - 用户认证 - - 参数: - - request (Request): FastAPI请求对象 - - login_form (CustomOAuth2PasswordRequestForm): 登录表单数据 - - db (AsyncSession): 数据库会话对象 - - 返回: - - LoginWithTenantsSchema: 包含令牌和租户列表的响应模型 - - 异常: - - CustomException: 认证失败时抛出异常。 - """ - # 解析请求信息（IP、UA），供登录日志使用 + """用户认证""" user_agent = parse(request.headers.get("user-agent")) request_ip = _resolve_request_ip(request) login_location = await IpLocalUtil.resolve_location_for_log(request_ip) @@ -120,21 +110,19 @@ class LoginService: _login_browser = user_agent.browser.family _login_username = login_form.username - # 判断是否来自API文档 referer = request.headers.get("referer", "") request_from_docs = referer.endswith(("docs", "redoc")) - # 验证码校验 if settings.CAPTCHA_ENABLE and not request_from_docs: if not login_form.captcha_key or not login_form.captcha: raise CustomException(msg="验证码不能为空") - await CaptchaService.check_captcha_service( + await CaptchaService.check_captcha( redis=redis, key=login_form.captcha_key, captcha=login_form.captcha, ) - # 用户认证 - auth = AuthSchema(db=db) + + auth = AuthSchema(db=db, check_data_scope=False) user = await UserCRUD(auth).get(username=login_form.username) if not user: @@ -172,7 +160,6 @@ class LoginService: ) raise CustomException(msg="用户已被停用") - # 检查用户的默认租户是否正常 from sqlalchemy import select from app.api.v1.module_platform.tenant.model import TenantModel @@ -191,7 +178,6 @@ class LoginService: ) raise CustomException(msg="所属租户已被禁用，请联系平台管理员") - # 更新最后登录时间 await UserCRUD(auth).update_last_login(id=user.id) if not user: @@ -199,30 +185,24 @@ class LoginService: if not login_form.login_type: raise CustomException(msg="登录类型不能为空") - # 创建token - token = await cls.create_token_service( + token = await cls.create_token( request=request, redis=redis, user=user, login_type=login_form.login_type, ) - # 查询用户关联的租户列表 - tenants = await cls.get_user_tenants_service( - auth=AuthSchema(db=db, user=user, tenant_id=user.tenant_id, check_data_scope=False), - db=db, - user_id=user.id, - ) + tenants_auth = AuthSchema(db=db, user=user, tenant_id=user.tenant_id, check_data_scope=False) + tenants = await LoginService(tenants_auth).get_user_tenants(user_id=user.id) user_info = { "id": user.id, "username": user.username, "name": user.name, "avatar": user.avatar, - "is_super_admin": user.is_superuser, + "is_superuser": user.is_superuser, } - # 写入登录成功日志 await _write_login_log( username=user.username, status=1, @@ -243,46 +223,36 @@ class LoginService: ) @classmethod - async def create_token_service(cls, request: Request, redis: Redis, user: UserModel, login_type: str) -> JWTOutSchema: - """ - 创建访问令牌和刷新令牌 - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis客户端对象 - - user (UserModel): 用户模型对象 - - login_type (str): 登录类型 - - 返回: - - JWTOutSchema: 包含访问令牌和刷新令牌的响应模型 - - 异常: - - CustomException: 创建令牌失败时抛出异常。 - """ - # 生成会话编号 + async def create_token(cls, request: Request, redis: Redis, user: UserModel, login_type: str) -> JWTOutSchema: + """创建访问令牌和刷新令牌""" session_id = str(uuid.uuid4()) - request.scope["session_id"] = session_id - user_agent = parse(request.headers.get("user-agent")) request_ip = _resolve_request_ip(request) login_location = await IpLocalUtil.resolve_location_for_log(request_ip) - request.scope["login_location"] = login_location - # 确保在请求上下文中设置用户名和会话ID - request.scope["user_username"] = user.username + from dataclasses import replace + + from app.core.request_context import RequestContext + + base_ctx = getattr(request.state, "ctx", None) or RequestContext() + request.state.ctx = replace( + base_ctx, + session_id=session_id, + user_username=user.username, + login_location=login_location, + ) access_expires = timedelta(seconds=settings.ACCESS_TOKEN_EXPIRE_MINUTES) refresh_expires = timedelta(seconds=settings.REFRESH_TOKEN_EXPIRE_MINUTES) now = datetime.now() - # 生成会话信息 session_info = OnlineOutSchema( session_id=session_id, user_id=user.id, tenant_id=user.tenant_id, - is_super_admin=user.is_superuser, + is_superuser=user.is_superuser, name=user.name, user_name=user.username, ipaddr=request_ip, @@ -308,7 +278,6 @@ class LoginService: ) ) - # 设置新的token await RedisCURD(redis).set( key=f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}", value=access_token, @@ -329,31 +298,17 @@ class LoginService: ) @classmethod - async def refresh_token_service( + async def refresh_token( cls, db: AsyncSession, redis: Redis, refresh_token: RefreshTokenPayloadSchema, ) -> JWTOutSchema: - """ - 刷新访问令牌 - - 参数: - - db (AsyncSession): 数据库会话对象 - - redis (Redis): Redis客户端对象 - - refresh_token (RefreshTokenPayloadSchema): 刷新令牌数据 - - 返回: - - JWTOutSchema: 新的令牌对象 - - 异常: - - CustomException: 刷新令牌无效时抛出异常 - """ + """刷新访问令牌""" token_payload: JWTPayloadSchema = decode_access_token(token=refresh_token.refresh_token) if not token_payload.is_refresh: raise CustomException(msg="非法凭证，请传入刷新令牌") - # 去 Redis 查完整信息 session_info = json.loads(token_payload.sub) session_id = session_info.get("session_id") user_id = session_info.get("user_id") @@ -361,15 +316,13 @@ class LoginService: if not session_id or not user_id: raise CustomException(msg="非法凭证,无法获取会话编号或用户ID") - # 用户认证 - auth = AuthSchema(db=db) + auth = AuthSchema(db=db, check_data_scope=False) user = await UserCRUD(auth).get(id=user_id) if not user: raise CustomException(msg="刷新token失败，用户不存在") if user.status == 1: raise CustomException(msg="用户已被停用") - # 设置新的 token access_expires = timedelta(seconds=settings.ACCESS_TOKEN_EXPIRE_MINUTES) refresh_expires = timedelta(seconds=settings.REFRESH_TOKEN_EXPIRE_MINUTES) now = datetime.now() @@ -392,7 +345,6 @@ class LoginService: ) ) - # 覆盖写入 Redis await RedisCURD(redis).set( key=f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}", value=access_token, @@ -412,21 +364,9 @@ class LoginService: expires_in=int(access_expires.total_seconds()), ) - @classmethod - async def logout_service(cls, redis: Redis, token: LogoutPayloadSchema) -> bool: - """ - 退出登录 - - 参数: - - redis (Redis): Redis客户端对象 - - token (LogoutPayloadSchema): 退出登录令牌数据 - - 返回: - - bool: 退出成功返回True - - 异常: - - CustomException: 令牌无效时抛出异常 - """ + @staticmethod + async def logout(redis: Redis, token: LogoutPayloadSchema) -> bool: + """退出登录""" payload: JWTPayloadSchema = decode_access_token(token=token.token) session_info = json.loads(payload.sub) session_id = session_info.get("session_id") @@ -434,7 +374,6 @@ class LoginService: if not session_id: raise CustomException(msg="非法凭证,无法获取会话编号") - # 删除Redis中的在线用户、访问令牌、刷新令牌 await RedisCURD(redis).delete(f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}") await RedisCURD(redis).delete(f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:{session_id}") @@ -442,40 +381,25 @@ class LoginService: return True - @classmethod - async def get_user_tenants_service( - cls, - auth: AuthSchema, - db: AsyncSession, + async def get_user_tenants( + self, user_id: int | None = None, ) -> list[TenantOptionSchema]: - """ - 获取用户关联的租户列表 - - 参数: - - auth (AuthSchema): 认证信息对象 - - db (AsyncSession): 数据库会话对象 - - user_id (int | None): 用户ID，未传入时从 auth.user 获取 - - 返回: - - list[TenantOptionSchema]: 租户选项列表 - """ + """获取用户关联的租户列表""" from sqlalchemy import select from app.api.v1.module_platform.tenant.model import TenantModel, TenantUserModel - uid = user_id or (auth.user.id if auth.user else None) + uid = user_id or (self.auth.user.id if self.auth.user else None) if not uid: return [] - # 超管可以看到所有租户 - if auth.user and auth.user.is_superuser: + if self.auth.user and self.auth.user.is_superuser: stmt = select(TenantModel).where(TenantModel.status == 0, TenantModel.is_deleted.is_(False)).order_by(TenantModel.sort, TenantModel.id) - result = await db.execute(stmt) + result = await self.auth.db.execute(stmt) tenant_objs = result.scalars().all() return [TenantOptionSchema(id=t.id, name=t.name, code=t.code) for t in tenant_objs] - # 普通用户通过 sys_user_tenant 关联表查询 stmt = ( select(TenantModel) .join(TenantUserModel, TenantUserModel.tenant_id == TenantModel.id) @@ -486,73 +410,52 @@ class LoginService: ) .order_by(TenantUserModel.is_default.desc(), TenantModel.sort, TenantModel.id) ) - result = await db.execute(stmt) + result = await self.auth.db.execute(stmt) tenant_objs = result.scalars().all() return [TenantOptionSchema(id=t.id, name=t.name, code=t.code) for t in tenant_objs] - @classmethod - async def select_tenant_service( - cls, + async def select_tenant( + self, request: Request, redis: Redis, - auth: AuthSchema, tenant_id: int, ) -> SelectTenantOutSchema: - """ - 选择租户：验证用户归属并签发含租户上下文的新 JWT Token - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis客户端对象 - - auth (AuthSchema): 当前认证信息 - - tenant_id (int): 目标租户ID - - 返回: - - SelectTenantOutSchema: 包含新令牌的响应 - - 异常: - - CustomException: 用户不属于该租户时抛出 - """ + """选择租户：验证用户归属并签发含租户上下文的新 JWT Token""" from sqlalchemy import select from app.api.v1.module_platform.tenant.model import TenantModel, TenantUserModel - if not auth.user: + if not self.auth.user: raise CustomException(msg="未认证用户") - # 超管可以选择任意租户 - if not auth.user.is_superuser: - # 验证用户是否属于该租户 + if not self.auth.user.is_superuser: exist_stmt = ( select(TenantUserModel) .where( - TenantUserModel.user_id == auth.user.id, + TenantUserModel.user_id == self.auth.user.id, TenantUserModel.tenant_id == tenant_id, ) .limit(1) ) - result = await auth.db.execute(exist_stmt) + result = await self.auth.db.execute(exist_stmt) if not result.scalar_one_or_none(): raise CustomException(msg="您不属于该租户，无法切换") - # 验证租户是否存在且状态正常 tenant_stmt = select(TenantModel).where(TenantModel.id == tenant_id, TenantModel.status == 0).limit(1) - result = await auth.db.execute(tenant_stmt) + result = await self.auth.db.execute(tenant_stmt) tenant = result.scalar_one_or_none() if not tenant: raise CustomException(msg="租户不存在或已被禁用") - # 获取当前会话信息 - session_id = request.scope.get("session_id") - session_info = request.scope.get("session_info") + ctx = getattr(request.state, "ctx", None) + session_id = ctx.session_id if ctx else None + session_info = ctx.session_info if ctx else None if not session_id or not session_info: raise CustomException(msg="会话已失效") - # 更新会话信息中的 tenant_id session_info["tenant_id"] = tenant_id - # 签发新的 access_token（含新的 tenant_id） from app.core.security import create_access_token access_expires = timedelta(seconds=settings.ACCESS_TOKEN_EXPIRE_MINUTES) @@ -566,7 +469,6 @@ class LoginService: ) ) - # 覆盖 Redis 中的 access_token from app.core.redis_crud import RedisCURD await RedisCURD(redis).set( @@ -575,7 +477,6 @@ class LoginService: expire=int(access_expires.total_seconds()), ) - # 同时签发并覆盖 refresh_token（含新 tenant_id）避免刷新时回退 refresh_expires = timedelta(seconds=settings.REFRESH_TOKEN_EXPIRE_MINUTES) new_refresh_token = create_access_token( payload=JWTPayloadSchema( @@ -590,12 +491,11 @@ class LoginService: expire=int(refresh_expires.total_seconds()), ) - # 同时更新租户上下文 - from app.core.tenant import set_current_tenant + from app.core.request_context import set_current_tenant - set_current_tenant(tenant_id, auth.user.is_superuser) + set_current_tenant(tenant_id) - logger.info(f"用户 {auth.user.username}(id={auth.user.id}) 切换到租户 {tenant.name}(id={tenant_id})") + logger.info(f"用户 {self.auth.user.username}(id={self.auth.user.id}) 切换到租户 {tenant.name}(id={tenant_id})") return SelectTenantOutSchema( access_token=new_access_token, @@ -607,28 +507,15 @@ class LoginService: class CaptchaService: """验证码服务""" - @classmethod - async def get_captcha_service(cls, redis: Redis) -> CaptchaOutSchema: - """ - 获取验证码 - - 参数: - - redis (Redis): Redis客户端对象 - - 返回: - - dict[str, CaptchaKey | CaptchaBase64]: 包含验证码key和base64图片的字典 - - 异常: - - CustomException: 验证码服务未启用时抛出异常 - """ + @staticmethod + async def get_captcha(redis: Redis) -> CaptchaOutSchema: + """获取验证码""" if not settings.CAPTCHA_ENABLE: raise CustomException(msg="未开启验证码服务") - # 生成验证码图片和值 captcha_base64, captcha_value = CaptchaUtil.captcha_arithmetic() captcha_key = get_random_character() - # 保存到Redis并设置过期时间 redis_key = f"{RedisInitKeyConfig.CAPTCHA_CODES.key}:{captcha_key}" await RedisCURD(redis).set( key=redis_key, @@ -636,44 +523,26 @@ class CaptchaService: expire=settings.CAPTCHA_EXPIRE_SECONDS, ) - # 返回验证码信息 return CaptchaOutSchema( enable=settings.CAPTCHA_ENABLE, key=CaptchaKey(captcha_key), img_base=CaptchaBase64(f"data:image/png;base64,{captcha_base64}"), ) - @classmethod - async def check_captcha_service(cls, redis: Redis, key: str, captcha: str) -> bool: - """ - 校验验证码 - - 参数: - - redis (Redis): Redis客户端对象 - - key (str): 验证码key - - captcha (str): 用户输入的验证码 - - 返回: - - bool: 验证通过返回True - - 异常: - - CustomException: 验证码无效或错误时抛出异常 - """ + @staticmethod + async def check_captcha(redis: Redis, key: str, captcha: str) -> bool: + """校验验证码""" if not captcha: raise CustomException(msg="验证码不能为空") - # 获取Redis中存储的验证码 redis_key = f"{RedisInitKeyConfig.CAPTCHA_CODES.key}:{key}" - captcha_value = await RedisCURD(redis).get(redis_key) if not captcha_value: raise CustomException(msg="验证码已过期") - # 验证码不区分大小写比对 if captcha.lower() != captcha_value.lower(): raise CustomException(msg="验证码错误") - # 验证成功后删除验证码,避免重复使用 await RedisCURD(redis).delete(redis_key) return True @@ -681,23 +550,12 @@ class CaptchaService: class AutoLoginService: """免登录服务""" - # 免登录Token前缀 AUTO_LOGIN_PREFIX = "fastapiadmin:auto_login:" - # Token有效期(秒) - 5分钟 TOKEN_EXPIRE = 300 @classmethod - async def get_auto_login_users_service(cls, db: AsyncSession, tenant_id: int | None = None) -> list[AutoLoginUserSchema]: - """ - 获取免登录用户列表 - - 参数: - - db (AsyncSession): 数据库会话对象 - - tenant_id (int | None): 租户ID,非超管时必传以限制租户范围 - - 返回: - - list[AutoLoginUserSchema]: 用户列表 - """ + async def get_auto_login_users(cls, db: AsyncSession, tenant_id: int | None = None) -> list[AutoLoginUserSchema]: + """获取免登录用户列表""" from sqlalchemy import select from app.api.v1.module_system.user.model import UserModel @@ -720,29 +578,14 @@ class AutoLoginService: ] @classmethod - async def create_auto_login_token_service( + async def create_auto_login_token( cls, redis: Redis, db: AsyncSession, user_id: int, tenant_id: int | None = None, ) -> AutoLoginTokenSchema: - """ - 创建免登录Token - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis客户端对象 - - db (AsyncSession): 数据库会话对象 - - user_id (int): 用户ID - - tenant_id (int | None): 租户ID,非超管时必传以防止跨租户操作 - - 返回: - - AutoLoginTokenSchema: 免登录Token和用户信息 - - 异常: - - CustomException: 用户不存在或已停用时抛出异常 - """ + """创建免登录Token""" from sqlalchemy import select from app.api.v1.module_system.user.model import UserModel @@ -759,13 +602,11 @@ class AutoLoginService: if user.status == 1: raise CustomException(msg="用户已被停用") - # 生成免登录Token import uuid token = str(uuid.uuid4()) token_key = f"{cls.AUTO_LOGIN_PREFIX}{token}" - # 存储到Redis，设置5分钟过期 token_data = { "user_id": user.id, "username": user.username, @@ -791,7 +632,7 @@ class AutoLoginService: ) @classmethod - async def auto_login_service( + async def auto_login( cls, request: Request, redis: Redis, @@ -799,22 +640,7 @@ class AutoLoginService: token: str, tenant_id: int | None = None, ) -> JWTOutSchema: - """ - 免登录 - - 参数: - - request (Request): FastAPI请求对象 - - redis (Redis): Redis客户端对象 - - db (AsyncSession): 数据库会话对象 - - token (str): 免登录Token - - tenant_id (int | None): 租户ID,非超管时必传以防止跨租户登录 - - 返回: - - JWTOutSchema: JWT令牌信息 - - 异常: - - CustomException: Token无效或过期时抛出异常 - """ + """免登录""" from sqlalchemy import select from app.api.v1.module_system.user.model import UserModel @@ -845,27 +671,22 @@ class AutoLoginService: if user.status == 1: raise CustomException(msg="用户已被停用") - # 删除已使用的Token await RedisCURD(redis).delete(token_key) - # 使用LoginService创建token - jwt_token = await LoginService.create_token_service(request=request, redis=redis, user=user, login_type="PC端") + jwt_token = await LoginService.create_token(request=request, redis=redis, user=user, login_type="PC端") logger.info(f"用户{user.username}免登录成功") return jwt_token -# ─── 租户自助注册 (PRD §4.5) ──────────────────────────────── - - class TenantRegisterService: """PRD §4.5 租户自助注册：一次性创建租户 + 管理员 + owner 角色 + 菜单分配""" DEFAULT_TRIAL_DAYS = 7 @classmethod - async def register_service( + async def register( cls, db: AsyncSession, username: str, @@ -873,22 +694,7 @@ class TenantRegisterService: email: str, tenant_name: str | None = None, ) -> TenantRegisterOutSchema: - """ - 租户自助注册：一次性创建租户 + 管理员 + owner 角色 + 菜单分配。 - - 参数: - - db (AsyncSession): 数据库会话对象。 - - username (str): 登录账号。 - - password (str): 登录密码。 - - email (str): 邮箱。 - - tenant_name (str | None): 企业/团队名称。 - - 返回: - - TenantRegisterOutSchema: 注册结果。 - - 异常: - - CustomException: 用户名或邮箱已被占用时抛出。 - """ + """租户自助注册：一次性创建租户 + 管理员 + owner 角色 + 菜单分配""" from sqlalchemy import func, select from sqlalchemy.exc import IntegrityError @@ -897,7 +703,6 @@ class TenantRegisterService: from app.api.v1.module_system.role.model import RoleMenusModel, RoleModel from app.api.v1.module_system.user.model import UserModel, UserRolesModel - # ── 1. 唯一性校验 ── exists_stmt = ( select(func.count()) .select_from(UserModel) @@ -910,20 +715,16 @@ class TenantRegisterService: if cnt > 0: raise CustomException(msg="用户名或邮箱已被占用") - # ── 2. 获取默认套餐 ── pkg_stmt = select(PackageModel).where(PackageModel.status == 0).order_by(PackageModel.id).limit(1) default_pkg = (await db.execute(pkg_stmt)).scalar_one_or_none() - # ── 3. 计算试用期 ── now = datetime.now() trial_end = now + timedelta(days=cls.DEFAULT_TRIAL_DAYS) - # ── 4. 生成租户 code ── base = tenant_name or username code_suffix = base.encode("utf-8").hex()[:6].upper() tenant_code = f"T{code_suffix}" - # ── 5. 创建租户 ── tenant = TenantModel( name=tenant_name or f"{username}的租户", code=tenant_code, @@ -936,7 +737,6 @@ class TenantRegisterService: db.add(tenant) await db.flush() - # ── 6. 创建管理员用户 ── user = UserModel( username=username, password=PwdUtil.hash_password(password), @@ -947,23 +747,20 @@ class TenantRegisterService: db.add(user) await db.flush() - # ── 7. 创建 owner 角色 ── owner_role = RoleModel( name="租户管理员", code="owner", tenant_id=tenant.id, order=1, - data_scope=4, # 全部数据权限 + data_scope=4, description="自助注册创建的管理员角色", ) db.add(owner_role) await db.flush() - # ── 8. 绑定用户角色 ── user_role = UserRolesModel(user_id=user.id, role_id=owner_role.id) db.add(user_role) - # ── 9. 分配套餐菜单 ── if default_pkg: pkg_menu_stmt = select(PackageMenuModel).where( PackageMenuModel.package_id == default_pkg.id, @@ -978,7 +775,6 @@ class TenantRegisterService: await db.rollback() raise CustomException(msg="租户编码或用户名已被占用，请重试") - # ── 10. 发送欢迎邮件 ── try: await cls._send_welcome_email(email, username, tenant.name, trial_end) except Exception: @@ -998,38 +794,23 @@ class TenantRegisterService: @classmethod async def _send_welcome_email(cls, to_email: str, username: str, tenant_name: str, trial_end: datetime) -> None: """发送欢迎邮件（不阻塞注册流程）。""" - from sqlalchemy import select - - from app.api.v1.module_platform.email.model import EmailConfigModel + from app.api.v1.module_platform.email.crud import EmailConfigCRUD + from app.core.base_schema import AuthSchema from app.core.database import async_db_session - from app.utils.email_util import render_template, send_email + from app.utils.email_util import render_template_file, send_email async with async_db_session() as _db: - cfg_stmt = ( - select(EmailConfigModel) - .where( - EmailConfigModel.is_default.is_(True), - EmailConfigModel.status == 0, - ) - .limit(1) - ) - cfg = (await _db.execute(cfg_stmt)).scalar_one_or_none() + cfg = await EmailConfigCRUD(AuthSchema(db=_db, check_data_scope=False)).get_active_default() if not cfg: logger.info("无可用 SMTP 配置，跳过欢迎邮件") return - html_body = render_template( - """{{ username }}，您好！
-您的租户已成功创建，试用期至 {{ trial_end }}。
-请登录后台开始使用。
""", - { - "tenant_name": tenant_name, - "username": username, - "trial_end": trial_end.strftime("%Y-%m-%d"), - }, - ) + html_body = render_template_file("emails/welcome.jinja2", { + "tenant_name": tenant_name, + "username": username, + "trial_end": trial_end.strftime("%Y-%m-%d"), + }) await send_email( smtp_host=cfg.smtp_host, @@ -1046,9 +827,6 @@ class TenantRegisterService: logger.info(f"欢迎邮件已发送至 {to_email}") -# ─── 忘记密码自助重置 (PRD §4.6) ───────────────────────────── - - class PasswordResetService: """PRD §4.6 忘记密码：邮箱重置令牌 + 密码更新""" @@ -1056,11 +834,8 @@ class PasswordResetService: TOKEN_EXPIRE_SECONDS = 1800 # 30 分钟 @classmethod - async def forgot_password_service(cls, redis: Redis, db: AsyncSession, email: str) -> str: - """ - 忘记密码：根据邮箱查找用户，生成重置令牌并尝试发送邮件。 - 无论邮箱是否存在均返回相同文案（防止邮箱探测攻击）。 - """ + async def forgot_password(cls, redis: Redis, db: AsyncSession, email: str) -> str: + """忘记密码：根据邮箱查找用户，生成重置令牌并尝试发送邮件。""" from sqlalchemy import select from app.api.v1.module_system.user.model import UserModel @@ -1076,12 +851,10 @@ class PasswordResetService: logger.info(f"忘记密码：邮箱 {email} 未注册，静默返回") return "若邮箱已注册，重置邮件已发送" - # 生成一次性令牌 token = secrets.token_urlsafe(32) key = f"{cls.RESET_TOKEN_PREFIX}{token}" await RedisCURD(redis).set(key=key, value=str(user.id), expire=cls.TOKEN_EXPIRE_SECONDS) - # 尝试发送邮件（不阻塞） try: await cls._send_reset_email(email, user.username, token) except Exception: @@ -1090,9 +863,8 @@ class PasswordResetService: return "若邮箱已注册，重置邮件已发送" @classmethod - async def reset_password_with_token_service(cls, redis: Redis, db: AsyncSession, token: str, new_password: str) -> str: + async def reset_password_with_token(cls, redis: Redis, db: AsyncSession, token: str, new_password: str) -> str: """使用令牌重置密码。校验令牌 → 更新密码 → 删除令牌。""" - from app.api.v1.module_system.user.model import UserModel key = f"{cls.RESET_TOKEN_PREFIX}{token}" @@ -1122,40 +894,24 @@ class PasswordResetService: @classmethod async def _send_reset_email(cls, to_email: str, username: str, token: str) -> None: """发送密码重置邮件。""" - from sqlalchemy import select - - from app.api.v1.module_platform.email.model import EmailConfigModel + from app.api.v1.module_platform.email.crud import EmailConfigCRUD + from app.core.base_schema import AuthSchema from app.core.database import async_db_session - from app.utils.email_util import render_template, send_email + from app.utils.email_util import render_template_file, send_email async with async_db_session() as _db: - cfg_stmt = ( - select(EmailConfigModel) - .where( - EmailConfigModel.is_default.is_(True), - EmailConfigModel.status == 0, - ) - .limit(1) - ) - cfg = (await _db.execute(cfg_stmt)).scalar_one_or_none() + cfg = await EmailConfigCRUD(AuthSchema(db=_db, check_data_scope=False)).get_active_default() if not cfg: logger.info("无可用 SMTP 配置，跳过重置邮件") return reset_url = f"{getattr(settings, 'SITE_URL', '')}/reset-password?token={token}" - html_body = render_template( - """{{ username }}，您好！
-请点击以下链接重置密码（{{ expire_minutes }} 分钟内有效）：
- -如果非您本人操作，请忽略此邮件。
""", - { - "username": username, - "reset_url": reset_url, - "expire_minutes": cls.TOKEN_EXPIRE_SECONDS // 60, - }, - ) + html_body = render_template_file("emails/reset_password.jinja2", { + "username": username, + "reset_url": reset_url, + "expire_minutes": cls.TOKEN_EXPIRE_SECONDS // 60, + }) await send_email( smtp_host=cfg.smtp_host, diff --git a/backend/app/api/v1/module_system/dept/controller.py b/backend/app/api/v1/module_system/dept/controller.py index 7a07eba1..6a6490ec 100644 --- a/backend/app/api/v1/module_system/dept/controller.py +++ b/backend/app/api/v1/module_system/dept/controller.py @@ -13,11 +13,10 @@ from app.core.router_class import OperationLogRoute from .schema import DeptCreateSchema, DeptOutSchema, DeptQueryParam, DeptUpdateSchema from .service import DeptService -DeptRouter = APIRouter(route_class=OperationLogRoute, prefix="/dept", tags=["部门管理"]) +DeptRouter = APIRouter(route_class=OperationLogRoute, prefix="/dept", tags=["系统管理", "部门管理"]) _DEPT_NS = "dept" - @DeptRouter.get( "/tree", summary="查询部门树", @@ -28,23 +27,9 @@ async def get_dept_tree_controller( search: Annotated[DeptQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:query"]))], ) -> JSONResponse: - """ - 查询部门树 - - 参数: - - search (DeptQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含部门树的响应模型 - - 异常: - - CustomException: 查询部门树失败时抛出异常。 - """ order_by = [{"order": "asc"}] - result_dict_list = await DeptService.tree_service(search=search, auth=auth, order_by=order_by) - return SuccessResponse(data=result_dict_list, msg="查询部门树成功") - + result_dict_tree = await DeptService(auth).tree(search=search, order_by=order_by) + return SuccessResponse(data=result_dict_tree, msg="查询部门树成功") @DeptRouter.get( "/detail/{id}", @@ -55,23 +40,9 @@ async def get_obj_detail_controller( id: Annotated[int, Path(description="部门ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:detail"]))], ) -> JSONResponse: - """ - 查询部门详情 - - 参数: - - id (int): 部门ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含部门详情的响应模型 - - 异常: - - CustomException: 查询部门详情失败时抛出异常。 - """ - result_dict = await DeptService.detail_service(id=id, auth=auth) + result_dict = await DeptService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="查询部门详情成功") - @DeptRouter.post( "/create", summary="创建部门", @@ -81,24 +52,10 @@ async def create_obj_controller( data: DeptCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:create"]))], ) -> JSONResponse: - """ - 创建部门 - - 参数: - - data (DeptCreateSchema): 创建部门负载模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含创建部门结果的响应模型 - - 异常: - - CustomException: 创建部门失败时抛出异常。 - """ - result_dict = await DeptService.create_service(data=data, auth=auth) + result_dict = await DeptService(auth).create(data=data) await FastAPICache.clear(namespace=_DEPT_NS) return SuccessResponse(data=result_dict, msg="创建部门成功") - @DeptRouter.put( "/update/{id}", summary="修改部门", @@ -109,25 +66,10 @@ async def update_obj_controller( id: Annotated[int, Path(description="部门ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:update"]))], ) -> JSONResponse: - """ - 修改部门 - - 参数: - - data (DeptUpdateSchema): 修改部门负载模型 - - id (int): 部门ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含修改部门结果的响应模型 - - 异常: - - CustomException: 修改部门失败时抛出异常。 - """ - result_dict = await DeptService.update_service(auth=auth, id=id, data=data) + result_dict = await DeptService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_DEPT_NS) return SuccessResponse(data=result_dict, msg="修改部门成功") - @DeptRouter.delete( "/delete", summary="删除部门", @@ -137,24 +79,10 @@ async def delete_obj_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:delete"]))], ) -> JSONResponse: - """ - 删除部门 - - 参数: - - ids (list[int]): 部门ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含删除部门结果的响应模型 - - 异常: - - CustomException: 删除部门失败时抛出异常。 - """ - await DeptService.delete_service(ids=ids, auth=auth) + await DeptService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_DEPT_NS) return SuccessResponse(msg="删除部门成功") - @DeptRouter.patch( "/status/batch", summary="批量修改部门状态", @@ -164,19 +92,6 @@ async def batch_set_available_obj_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dept:patch"]))], ) -> JSONResponse: - """ - 批量修改部门状态 - - 参数: - - data (BatchSetAvailable): 批量修改部门状态负载模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含批量修改部门状态结果的响应模型 - - 异常: - - CustomException: 批量修改部门状态失败时抛出异常。 - """ - await DeptService.batch_set_available_service(data=data, auth=auth) + await DeptService(auth).batch_set_available(data=data) await FastAPICache.clear(namespace=_DEPT_NS) return SuccessResponse(msg="批量修改部门状态成功") diff --git a/backend/app/api/v1/module_system/dept/model.py b/backend/app/api/v1/module_system/dept/model.py index 125f34dc..6c13cae1 100644 --- a/backend/app/api/v1/module_system/dept/model.py +++ b/backend/app/api/v1/module_system/dept/model.py @@ -26,7 +26,7 @@ class DeptModel(ModelMixin, TenantMixin, UserMixin): "deleted_by", "tenant_by", ] - __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.DEPT_BASED + __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.DEPT_RELATION name: Mapped[str] = mapped_column(String(64), nullable=False, comment="部门名称") status: Mapped[int] = mapped_column(Integer, default=0, nullable=False, comment="状态(0:启动 1:停用)", index=True) diff --git a/backend/app/api/v1/module_system/dept/service.py b/backend/app/api/v1/module_system/dept/service.py index 2a9a6954..ec858aae 100644 --- a/backend/app/api/v1/module_system/dept/service.py +++ b/backend/app/api/v1/module_system/dept/service.py @@ -24,159 +24,78 @@ class DeptService: 提供部门 CRUD、树形结构查询、级联启/禁用、租户配额检查等业务能力。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> DeptOutSchema: - """ - 获取部门详情 + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 部门 ID - - 返回: - - DeptOutSchema: 部门详情响应模型 - """ - dept = await DeptCRUD(auth).get_or_404(id=id) + async def detail(self, id: int) -> DeptOutSchema: + dept = await DeptCRUD(self.auth).get_or_404(id=id) dept_out = DeptOutSchema.model_validate(dept) if dept.parent_id: - parent = await DeptCRUD(auth).get(id=dept.parent_id) + parent = await DeptCRUD(self.auth).get(id=dept.parent_id) if parent: dept_out.parent_name = parent.name return dept_out - @classmethod - async def tree_service( - cls, - auth: AuthSchema, + async def tree( + self, search: DeptQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[dict]: - """ - 获取部门树形列表。 - - 参数: - - auth (AuthSchema): 认证对象。 - - search (DeptQueryParam | None): 查询参数对象。 - - order_by (list[dict] | None): 排序参数。 - - 返回: - - list[dict]: 部门树形列表对象。 - """ - # 使用树形结构查询，预加载children关系 - dept_list = await DeptCRUD(auth).tree_list(search=vars(search) if search else None, order_by=order_by) - # 转换为字典列表（使用树形 Schema），tree_list 已通过 selectin 预加载 children + dept_list = await DeptCRUD(self.auth).tree_list(search=vars(search) if search else None, order_by=order_by) dept_dict_list = [DeptTreeOutSchema.model_validate(dept).model_dump() for dept in dept_list] - # 仅保留根节点，子树已在 model_dump 中递归序列化 return [d for d in dept_dict_list if d.get("parent_id") is None] - @classmethod - async def create_service(cls, auth: AuthSchema, data: DeptCreateSchema) -> DeptOutSchema: - """ - 创建部门。 - - 参数: - - auth (AuthSchema): 认证对象。 - - data (DeptCreateSchema): 部门创建对象。 - - 返回: - - DeptOutSchema: 新创建的部门对象。 - - 异常: - - CustomException: 当部门已存在时抛出。 - """ - dept = await DeptCRUD(auth).get(name=data.name) + async def create(self, data: DeptCreateSchema) -> DeptOutSchema: + dept = await DeptCRUD(self.auth).get(name=data.name) if dept: raise CustomException(msg="创建失败，该数据已存在") - obj = await DeptCRUD(auth).get(code=data.code) + obj = await DeptCRUD(self.auth).get(code=data.code) if obj: raise CustomException(msg="创建失败，编码已存在") # 检查租户配额 from app.api.v1.module_platform.tenant.service import TenantService - await TenantService.check_quota_service(auth, auth.tenant_id, "dept") + await TenantService(self.auth).check_quota(self.auth.tenant_id, "dept") - dept = await DeptCRUD(auth).create(data=data) + dept = await DeptCRUD(self.auth).create(data=data) return DeptOutSchema.model_validate(dept) - @classmethod - async def update_service(cls, auth: AuthSchema, id: int, data: DeptUpdateSchema) -> DeptOutSchema: - """ - 更新部门。 - - 参数: - - auth (AuthSchema): 认证对象。 - - id (int): 部门 ID。 - - data (DeptUpdateSchema): 部门更新对象。 - - 返回: - - DeptOutSchema: 更新后的部门对象。 - - 异常: - - CustomException: 当部门不存在或名称重复时抛出。 - """ - dept = await DeptCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") - exist_dept = await DeptCRUD(auth).get(name=data.name) + async def update(self, id: int, data: DeptUpdateSchema) -> DeptOutSchema: + dept = await DeptCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_dept = await DeptCRUD(self.auth).get(name=data.name) if exist_dept and exist_dept.id != id: raise CustomException(msg="更新失败，名称已存在") - exist_code = await DeptCRUD(auth).get(code=data.code) + exist_code = await DeptCRUD(self.auth).get(code=data.code) if exist_code and exist_code.id != id: raise CustomException(msg="更新失败，编码已存在") - dept = await DeptCRUD(auth).update(id=id, data=data) + dept = await DeptCRUD(self.auth).update(id=id, data=data) dept_out = DeptOutSchema.model_validate(dept) if dept_out.parent_id: - parent = await DeptCRUD(auth).get(id=dept_out.parent_id) + parent = await DeptCRUD(self.auth).get(id=dept_out.parent_id) if parent: dept_out.parent_name = parent.name return dept_out - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除部门。 - - 参数: - - auth (AuthSchema): 认证对象。 - - ids (list[int]): 部门 ID 列表。 - - 返回: - - None - - 异常: - - CustomException: 当删除对象为空时抛出。 - - CustomException: 当存在子部门时抛出。 - """ + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") # 获取所有部门列表，用于构建树形关系 - all_depts = await DeptCRUD(auth).list() + all_depts = await DeptCRUD(self.auth).list() # 构建子部门ID映射 child_id_map = get_child_id_map(model_list=all_depts) - for id in ids: - # 检查是否有子部门 - if id in child_id_map and child_id_map[id]: + for pid in ids: + if pid in child_id_map and child_id_map[pid]: raise CustomException(msg="存在子部门，不允许删除父部门") - # 执行批量删除操作 - await DeptCRUD(auth).delete(ids=ids) + await DeptCRUD(self.auth).delete(ids=ids) - @classmethod - async def batch_set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: - """ - 批量设置部门可用状态。 - - 参数: - - auth (AuthSchema): 认证对象。 - - data (BatchSetAvailable): 批量设置可用状态对象。 - - 返回: - - None - """ - dept_list = await DeptCRUD(auth).list() + async def batch_set_available(self, data: BatchSetAvailable) -> None: + dept_list = await DeptCRUD(self.auth).list() total_ids = [] if data.status == 0: @@ -190,4 +109,4 @@ class DeptService: disable_ids = get_child_recursion(id=dept_id, id_map=id_map) total_ids.extend(disable_ids) - await DeptCRUD(auth).set(ids=total_ids, status=data.status) + await DeptCRUD(self.auth).set(ids=total_ids, status=data.status) diff --git a/backend/app/api/v1/module_system/dict/controller.py b/backend/app/api/v1/module_system/dict/controller.py index 8c7dfbc9..4106fa30 100644 --- a/backend/app/api/v1/module_system/dict/controller.py +++ b/backend/app/api/v1/module_system/dict/controller.py @@ -25,11 +25,10 @@ from .schema import ( ) from .service import DictDataService, DictTypeService -DictRouter = APIRouter(route_class=OperationLogRoute, prefix="/dict", tags=["字典管理"]) +DictRouter = APIRouter(route_class=OperationLogRoute, prefix="/dict", tags=["系统管理", "字典管理"]) _DICT_TYPE_NS = "dict_type" - @DictRouter.get( "/type/detail/{id}", summary="获取字典类型详情", @@ -39,23 +38,9 @@ async def get_type_detail_controller( id: Annotated[int, Path(description="字典类型ID", ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:detail"]))], ) -> JSONResponse: - """ - 获取字典类型详情 - - 参数: - - id (int): 字典类型ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含字典类型详情的响应模型 - - 异常: - - CustomException: 获取字典类型详情失败时抛出异常。 - """ - result_dict = await DictTypeService.detail_service(id=id, auth=auth) + result_dict = await DictTypeService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取字典类型详情成功") - @DictRouter.get( "/type/list", summary="查询字典类型", @@ -66,22 +51,7 @@ async def get_type_list_controller( search: Annotated[DictTypeQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:query"]))], ) -> JSONResponse: - """ - 查询字典类型 - - 参数: - - page (PaginationQueryParam): 分页参数模型 - - search (DictTypeQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含查询字典类型结果的响应模型 - - 异常: - - CustomException: 查询字典类型失败时抛出异常。 - """ - result_dict = await DictTypeService.page_service( - auth=auth, + result_dict = await DictTypeService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -89,7 +59,6 @@ async def get_type_list_controller( ) return SuccessResponse(data=result_dict, msg="查询字典类型列表成功") - @DictRouter.get( "/type/optionselect", summary="获取全部字典类型", @@ -99,22 +68,9 @@ async def get_type_list_controller( async def get_type_optionselect_controller( auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:query"]))], ) -> JSONResponse: - """ - 获取全部字典类型 - - 参数: - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含全部字典类型的响应模型 - - 异常: - - CustomException: 获取字典类型列表失败时抛出异常。 - """ - result_dict_list = await DictTypeService.list_service(auth=auth) + result_dict_list = await DictTypeService(auth).list() return SuccessResponse(data=result_dict_list, msg="获取字典类型列表成功") - @DictRouter.post( "/type/create", summary="创建字典类型", @@ -125,25 +81,10 @@ async def create_type_controller( redis: Annotated[Redis, Depends(redis_getter)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:create"]))], ) -> JSONResponse: - """ - 创建字典类型 - - 参数: - - data (DictTypeCreateSchema): 创建字典类型的入参模型 - - redis (Redis): Redis数据库连接 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含创建字典类型结果的响应模型 - - 异常: - - CustomException: 创建字典类型失败时抛出异常。 - """ - result_dict = await DictTypeService.create_service(auth=auth, redis=redis, data=data) + result_dict = await DictTypeService(auth).create(redis=redis, data=data) await FastAPICache.clear(namespace=_DICT_TYPE_NS) return SuccessResponse(data=result_dict, msg="创建字典类型成功") - @DictRouter.put( "/type/update/{id}", summary="修改字典类型", @@ -155,26 +96,10 @@ async def update_type_controller( id: Annotated[int, Path(description="字典类型ID", ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:update"]))], ) -> JSONResponse: - """ - 修改字典类型 - - 参数: - - data (DictTypeUpdateSchema): 修改字典类型的入参模型 - - redis (Redis): Redis数据库连接 - - id (int): 字典类型ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含修改字典类型结果的响应模型 - - 异常: - - CustomException: 修改字典类型失败时抛出异常。 - """ - result_dict = await DictTypeService.update_service(auth=auth, redis=redis, id=id, data=data) + result_dict = await DictTypeService(auth).update(redis=redis, id=id, data=data) await FastAPICache.clear(namespace=_DICT_TYPE_NS) return SuccessResponse(data=result_dict, msg="修改字典类型成功") - @DictRouter.delete( "/type/delete", summary="删除字典类型", @@ -185,25 +110,10 @@ async def delete_type_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:delete"]))], ) -> JSONResponse: - """ - 删除字典类型 - - 参数: - - redis (Redis): Redis数据库连接 - - ids (list[int]): 字典类型ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含删除字典类型结果的响应模型 - - 异常: - - CustomException: 删除字典类型失败时抛出异常。 - """ - await DictTypeService.delete_service(auth=auth, redis=redis, ids=ids) + await DictTypeService(auth).delete(redis=redis, ids=ids) await FastAPICache.clear(namespace=_DICT_TYPE_NS) return SuccessResponse(msg="删除字典类型成功") - @DictRouter.patch( "/type/status/batch", summary="批量修改字典类型状态", @@ -213,24 +123,10 @@ async def batch_set_available_dict_type_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:patch"]))], ) -> JSONResponse: - """ - 批量修改字典类型状态 - - 参数: - - data (BatchSetAvailable): 批量修改字典类型状态负载模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含批量修改字典类型状态结果的响应模型 - - 异常: - - CustomException: 批量修改字典类型状态失败时抛出异常。 - """ - await DictTypeService.set_available_service(auth=auth, data=data) + await DictTypeService(auth).set_available(data=data) await FastAPICache.clear(namespace=_DICT_TYPE_NS) return SuccessResponse(msg="批量修改字典类型状态成功") - @DictRouter.post( "/type/export", summary="导出字典类型", @@ -240,23 +136,10 @@ async def export_type_list_controller( search: Annotated[DictTypeQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_type:export"]))], ) -> StreamingResponse: - """ - 导出字典类型 - - 参数: - - search (DictTypeQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - StreamingResponse: 包含导出字典类型结果的响应模型 - - 异常: - - CustomException: 导出字典类型失败时抛出异常。 - """ # 获取全量数据并转为dict列表 - result_dict_list = await DictTypeService.list_service(search=search, auth=auth) + result_dict_list = await DictTypeService(auth).list(search=search) export_data = [item.model_dump() for item in result_dict_list] - export_result = await DictTypeService.export_service(data_list=export_data) + export_result = DictTypeService.export(data_list=export_data) return StreamResponse( data=bytes2file_response(export_result), @@ -264,7 +147,6 @@ async def export_type_list_controller( headers={"Content-Disposition": "attachment; filename=dict_type.xlsx"}, ) - @DictRouter.get( "/data/detail/{id}", summary="获取字典数据详情", @@ -274,23 +156,9 @@ async def get_data_detail_controller( id: Annotated[int, Path(description="字典数据ID", ge=1)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:detail"]))], ) -> JSONResponse: - """ - 获取字典数据详情 - - 参数: - - id (int): 字典数据ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含字典数据详情的响应模型 - - 异常: - - CustomException: 获取字典数据详情失败时抛出异常。 - """ - result_dict = await DictDataService.detail_service(id=id, auth=auth) + result_dict = await DictDataService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取字典数据详情成功") - @DictRouter.get( "/data/list", summary="查询字典数据", @@ -301,25 +169,10 @@ async def get_data_list_controller( search: Annotated[DictDataQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:query"]))], ) -> JSONResponse: - """ - 查询字典数据 - - 参数: - - page (PaginationQueryParam): 分页查询参数模型 - - search (DictDataQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含字典数据列表的响应模型 - - 异常: - - CustomException: 查询字典数据列表失败时抛出异常。 - """ order_by = [{"order": "asc"}] if page.order_by: order_by = page.order_by - result_dict = await DictDataService.page_service( - auth=auth, + result_dict = await DictDataService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -327,7 +180,6 @@ async def get_data_list_controller( ) return SuccessResponse(data=result_dict, msg="查询字典数据列表成功") - @DictRouter.post( "/data/create", summary="创建字典数据", @@ -338,24 +190,9 @@ async def create_data_controller( redis: Annotated[Redis, Depends(redis_getter)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:create"]))], ) -> JSONResponse: - """ - 创建字典数据 - - 参数: - - data (DictDataCreateSchema): 创建字典数据负载模型 - - redis (Redis): Redis数据库连接 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含创建字典数据结果的响应模型 - - 异常: - - CustomException: 创建字典数据失败时抛出异常。 - """ - result_dict = await DictDataService.create_service(auth=auth, redis=redis, data=data) + result_dict = await DictDataService(auth).create(redis=redis, data=data) return SuccessResponse(data=result_dict, msg="创建字典数据成功") - @DictRouter.put( "/data/update/{id}", summary="修改字典数据", @@ -367,25 +204,9 @@ async def update_data_controller( id: Annotated[int, Path(description="字典数据ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:update"]))], ) -> JSONResponse: - """ - 修改字典数据 - - 参数: - - data (DictDataUpdateSchema): 修改字典数据负载模型 - - redis (Redis): Redis数据库连接 - - id (int): 字典数据ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含修改字典数据结果的响应模型 - - 异常: - - CustomException: 修改字典数据失败时抛出异常。 - """ - result_dict = await DictDataService.update_service(auth=auth, redis=redis, id=id, data=data) + result_dict = await DictDataService(auth).update(redis=redis, id=id, data=data) return SuccessResponse(data=result_dict, msg="修改字典数据成功") - @DictRouter.delete( "/data/delete", summary="删除字典数据", @@ -396,24 +217,9 @@ async def delete_data_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:delete"]))], ) -> JSONResponse: - """ - 删除字典数据 - - 参数: - - redis (Redis): Redis数据库连接 - - ids (list[int]): 字典数据ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含删除字典数据结果的响应模型 - - 异常: - - CustomException: 删除字典数据失败时抛出异常。 - """ - await DictDataService.delete_service(auth=auth, redis=redis, ids=ids) + await DictDataService(auth).delete(redis=redis, ids=ids) return SuccessResponse(msg="删除字典数据成功") - @DictRouter.patch( "/data/status/batch", summary="批量修改字典数据状态", @@ -423,23 +229,9 @@ async def batch_set_available_dict_data_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:patch"]))], ) -> JSONResponse: - """ - 批量修改字典数据状态 - - 参数: - - data (BatchSetAvailable): 批量修改字典数据状态负载模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含批量修改字典数据状态结果的响应模型 - - 异常: - - CustomException: 批量修改字典数据状态失败时抛出异常。 - """ - await DictDataService.set_available_service(auth=auth, data=data) + await DictDataService(auth).set_available(data=data) return SuccessResponse(msg="批量修改字典数据状态成功") - @DictRouter.post( "/data/export", summary="导出字典数据", @@ -450,23 +242,9 @@ async def export_data_list_controller( page: Annotated[PaginationQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:dict_data:export"]))], ) -> StreamingResponse: - """ - 导出字典数据 - - 参数: - - search (DictDataQueryParam): 查询参数模型 - - page (PaginationQueryParam): 分页参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - StreamingResponse: 包含导出字典数据结果的响应模型 - - 异常: - - CustomException: 导出字典数据失败时抛出异常。 - """ - result_dict_list = await DictDataService.list_service(auth=auth, search=search, order_by=page.order_by) + result_dict_list = await DictDataService(auth).list(search=search, order_by=page.order_by) export_data = [item.model_dump() for item in result_dict_list] - export_result = await DictDataService.export_service(data_list=export_data) + export_result = DictDataService.export(data_list=export_data) return StreamResponse( data=bytes2file_response(export_result), @@ -474,26 +252,12 @@ async def export_data_list_controller( headers={"Content-Disposition": "attachment; filename=dice_data.xlsx"}, ) - @DictRouter.get( "/data/info/{dict_type}", summary="根据字典类型获取数据", response_model=ResponseSchema[list[DictDataOutSchema]], ) async def get_init_dict_data_controller(dict_type: str, redis: Annotated[Redis, Depends(redis_getter)]) -> JSONResponse: - """ - 根据字典类型获取数据 - - 参数: - - dict_type (str): 字典类型 - - redis (Redis): Redis数据库连接 - - 返回: - - JSONResponse: 包含根据字典类型获取数据结果的响应模型 - - 异常: - - CustomException: 根据字典类型获取数据失败时抛出异常。 - """ - dict_data_query_result = await DictDataService.get_init_cache_service(redis=redis, dict_type=dict_type, tenant_id=1) + dict_data_query_result = await DictDataService.get_init_cache(redis=redis, dict_type=dict_type, tenant_id=1) return SuccessResponse(data=dict_data_query_result, msg="获取初始化字典数据成功") diff --git a/backend/app/api/v1/module_system/dict/service.py b/backend/app/api/v1/module_system/dict/service.py index 4ad897dc..03cba9c9 100644 --- a/backend/app/api/v1/module_system/dict/service.py +++ b/backend/app/api/v1/module_system/dict/service.py @@ -27,27 +27,28 @@ class DictTypeService: """ 字典类型管理服务 - 提供字典类型 CRUD、Redis 缓存同步、字典数据联动更新、批量启/禁用、Excel 导出等业务能力。 + 设计：实例方法承载「当前用户上下文 (auth)」，``redis`` 仍是方法参数 + （因为不是每个端点都用到）。调用方写法由 ``XxxService.method_service(auth=...)`` + 改为 ``XxxService(auth).method(...)``。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> DictTypeOutSchema: + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def detail(self, id: int) -> DictTypeOutSchema: """ 获取数据字典类型详情 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 数据字典类型ID 返回: - DictTypeOutSchema: 字典类型响应模型 """ - return await DictTypeCRUD(auth).get_or_404(id=id, out_schema=DictTypeOutSchema) + return await DictTypeCRUD(self.auth).get_or_404(id=id, out_schema=DictTypeOutSchema) - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: DictTypeQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[DictTypeOutSchema]: @@ -55,20 +56,17 @@ class DictTypeService: 获取数据字典类型列表 参数: - - auth (AuthSchema): 认证信息模型 - search (DictTypeQueryParam | None): 搜索条件模型 - order_by (list[dict] | None): 排序字段列表 返回: - list[DictTypeOutSchema]: 字典类型响应模型列表 """ - obj_list = await DictTypeCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + obj_list = await DictTypeCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [DictTypeOutSchema.model_validate(obj) for obj in obj_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: DictTypeQueryParam | None = None, @@ -78,17 +76,16 @@ class DictTypeService: 分页查询字典类型（数据库 OFFSET/LIMIT）。 参数: - - auth (AuthSchema): 认证信息模型 - page_no (int): 页码（从 1 开始） - page_size (int): 每页条数 - search (DictTypeQueryParam | None): 查询条件 - order_by (list[dict] | None): 排序字段列表 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） + - dict: 分页结果（结构由 ``CRUD.page`` 返回约定） """ offset = (page_no - 1) * page_size - return await DictTypeCRUD(auth).page( + return await DictTypeCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -96,27 +93,25 @@ class DictTypeService: out_schema=DictTypeOutSchema, ) - @classmethod - async def create_service(cls, auth: AuthSchema, redis: Redis, data: DictTypeCreateSchema) -> DictTypeOutSchema: + async def create(self, redis: Redis, data: DictTypeCreateSchema) -> DictTypeOutSchema: """ 创建数据字典类型 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - data (DictTypeCreateSchema): 数据字典类型创建模型 返回: - DictTypeOutSchema: 字典类型响应模型 """ - exist_obj = await DictTypeCRUD(auth).get(dict_name=data.dict_name) + exist_obj = await DictTypeCRUD(self.auth).get(dict_name=data.dict_name) if exist_obj: raise CustomException(msg="创建失败，该数据已存在") - obj = await DictTypeCRUD(auth).create(data=data) + obj = await DictTypeCRUD(self.auth).create(data=data) new_obj_dict = DictTypeOutSchema.model_validate(obj) - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{data.dict_type}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{data.dict_type}" try: await RedisCURD(redis).set( @@ -131,10 +126,8 @@ class DictTypeService: return new_obj_dict - @classmethod - async def update_service( - cls, - auth: AuthSchema, + async def update( + self, redis: Redis, id: int, data: DictTypeUpdateSchema, @@ -143,7 +136,6 @@ class DictTypeService: 更新数据字典类型 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - id (int): 数据字典类型ID - data (DictTypeUpdateSchema): 数据字典类型更新模型 @@ -151,13 +143,13 @@ class DictTypeService: 返回: - DictTypeOutSchema: 字典类型响应模型 """ - exist_obj = await DictTypeCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_obj = await DictTypeCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") if exist_obj.dict_name != data.dict_name: raise CustomException(msg="更新失败，数据字典类型名称不可以修改") # 如果字典类型修改或状态变更，则修改对应字典数据的类型和状态 if exist_obj.dict_type != data.dict_type or exist_obj.status != data.status: - exist_obj_type_list = await DictDataCRUD(auth).list(search={"dict_type": exist_obj.dict_type}) + exist_obj_type_list = await DictDataCRUD(self.auth).list(search={"dict_type": exist_obj.dict_type}) if exist_obj_type_list: for item in exist_obj_type_list: item.dict_type = data.dict_type @@ -173,16 +165,16 @@ class DictTypeService: status=data.status, description=item.description, ) - await DictDataCRUD(auth).update(id=item.id, data=dict_data) + await DictDataCRUD(self.auth).update(id=item.id, data=dict_data) - obj = await DictTypeCRUD(auth).update(id=id, data=data) + obj = await DictTypeCRUD(self.auth).update(id=id, data=data) new_obj_dict = DictTypeOutSchema.model_validate(obj) - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{data.dict_type}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{data.dict_type}" try: # 获取当前字典类型的所有字典数据，确保包含最新状态 - dict_data_list = await DictDataCRUD(auth).list(search={"dict_type": data.dict_type}) + dict_data_list = await DictDataCRUD(self.auth).list(search={"dict_type": data.dict_type}) dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] value = json.dumps(dict_data, ensure_ascii=False) @@ -198,13 +190,11 @@ class DictTypeService: return new_obj_dict - @classmethod - async def delete_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None: + async def delete(self, redis: Redis, ids: list[int]) -> None: """ 删除数据字典类型 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - ids (list[int]): 数据字典类型ID列表 @@ -213,45 +203,43 @@ class DictTypeService: """ if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - existing = await DictTypeCRUD(auth).list(search={"id": ("in", ids)}) + existing = await DictTypeCRUD(self.auth).list(search={"id": ("in", ids)}) existing_map = {obj.id: obj for obj in existing} for nid in ids: if nid not in existing_map: raise CustomException(msg="删除失败，该数据不存在") exist_obj = existing_map[nid] # 检查是否有字典数据 - exist_obj_type_list = await DictDataCRUD(auth).list(search={"dict_type": exist_obj.dict_type}) + exist_obj_type_list = await DictDataCRUD(self.auth).list(search={"dict_type": exist_obj.dict_type}) if len(exist_obj_type_list) > 0: # 如果有字典数据，不能删除 raise CustomException(msg="删除失败，该数据字典类型下存在字典数据") # 删除Redis缓存 - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{exist_obj.dict_type}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{exist_obj.dict_type}" try: await RedisCURD(redis).delete(redis_key) logger.info(f"删除字典类型成功: {nid}") except Exception as e: logger.error(f"删除字典类型失败: {e}") raise CustomException(msg="同步删除字典缓存失败") from e - await DictTypeCRUD(auth).delete(ids=ids) + await DictTypeCRUD(self.auth).delete(ids=ids) - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: + async def set_available(self, data: BatchSetAvailable) -> None: """ 设置数据字典类型状态 参数: - - auth (AuthSchema): 认证信息模型 - data (BatchSetAvailable): 批量设置状态模型 返回: - None """ - await DictTypeCRUD(auth).set(ids=data.ids, status=data.status) + await DictTypeCRUD(self.auth).set(ids=data.ids, status=data.status) - @classmethod - async def export_service(cls, data_list: list[dict]) -> bytes: + @staticmethod + def export(data_list: list[dict]) -> bytes: """ - 导出数据字典类型列表 + 导出数据字典类型列表（无状态工具方法） 参数: - data_list (list[dict]): 数据字典类型列表 @@ -284,27 +272,26 @@ class DictDataService: """ 字典数据管理服务 - 提供字典数据 CRUD、Redis 缓存同步、初始化字典、批量启/禁用、Excel 导出等业务能力。 + 设计同 DictTypeService：实例方法 + ``__init__(auth)``。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> DictDataOutSchema: + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def detail(self, id: int) -> DictDataOutSchema: """ 获取数据字典数据详情 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 数据字典数据ID 返回: - DictDataOutSchema: 字典数据响应模型 """ - return await DictDataCRUD(auth).get_or_404(id=id, out_schema=DictDataOutSchema) + return await DictDataCRUD(self.auth).get_or_404(id=id, out_schema=DictDataOutSchema) - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: DictDataQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[DictDataOutSchema]: @@ -312,20 +299,17 @@ class DictDataService: 获取数据字典数据列表 参数: - - auth (AuthSchema): 认证信息模型 - search (DictDataQueryParam | None): 搜索条件模型 - order_by (list[dict] | None): 排序字段列表 返回: - list[DictDataOutSchema]: 字典数据响应模型列表 """ - obj_list = await DictDataCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + obj_list = await DictDataCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [DictDataOutSchema.model_validate(obj) for obj in obj_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: DictDataQueryParam | None = None, @@ -335,17 +319,16 @@ class DictDataService: 分页查询字典数据（数据库 OFFSET/LIMIT）。 参数: - - auth (AuthSchema): 认证信息模型 - page_no (int): 页码（从 1 开始） - page_size (int): 每页条数 - search (DictDataQueryParam | None): 查询条件 - order_by (list[dict] | None): 排序字段列表 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） + - dict: 分页结果（结构由 ``CRUD.page`` 返回约定） """ offset = (page_no - 1) * page_size - return await DictDataCRUD(auth).page( + return await DictDataCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -353,10 +336,10 @@ class DictDataService: out_schema=DictDataOutSchema, ) - @classmethod - async def init_cache_service(cls, redis: Redis) -> None: + @staticmethod + async def init_cache(redis: Redis) -> None: """ - 应用初始化: 获取所有字典类型对应的字典数据信息并按租户缓存。 + 应用初始化: 获取所有字典类型对应的字典数据信息并按租户缓存（无 auth）。 参数: - redis (Redis): Redis客户端 @@ -367,8 +350,8 @@ class DictDataService: try: async with async_db_session() as session: async with session.begin(): - auth = AuthSchema(db=session, check_data_scope=False) - obj_list = await DictTypeCRUD(auth).list() + init_auth = AuthSchema(db=session, check_data_scope=False) + obj_list = await DictTypeCRUD(init_auth).list() if not obj_list: logger.warning("未找到任何字典类型数据") return @@ -377,8 +360,14 @@ class DictDataService: dict_type = obj.dict_type tenant_id = obj.tenant_id try: - dict_data_list = await DictDataCRUD(auth).list(search={"dict_type": dict_type, "tenant_id": tenant_id}) - dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] + dict_data_list = await DictDataCRUD(init_auth).list( + search={"dict_type": dict_type, "tenant_id": tenant_id} + ) + dict_data = [ + DictDataOutSchema.model_validate(row).model_dump(mode="json") + for row in dict_data_list + if row + ] redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{tenant_id}:{dict_type}" value = json.dumps(dict_data, ensure_ascii=False) await RedisCURD(redis).set( @@ -393,10 +382,10 @@ class DictDataService: logger.error(f"字典初始化过程发生错误: {e}") raise CustomException(msg="字典数据初始化失败") from e - @classmethod - async def get_init_cache_service(cls, redis: Redis, dict_type: str, tenant_id: int = 1) -> list[dict]: + @staticmethod + async def get_init_cache(redis: Redis, dict_type: str, tenant_id: int = 1) -> list[dict]: """ - 从缓存获取字典数据列表信息 + 从缓存获取字典数据列表信息（无 auth）。 参数: - redis (Redis): Redis客户端 @@ -419,7 +408,7 @@ class DictDataService: elif isinstance(obj_list_dict, list): return obj_list_dict - await cls.init_cache_service(redis) + await DictDataService.init_cache(redis) redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{tenant_id}:{dict_type}" obj_list_dict = await RedisCURD(redis).get(redis_key) if not obj_list_dict: @@ -437,13 +426,11 @@ class DictDataService: logger.error(f"获取字典缓存失败: {e!s}") raise CustomException(msg="获取字典数据失败") from e - @classmethod - async def create_service(cls, auth: AuthSchema, redis: Redis, data: DictDataCreateSchema) -> DictDataOutSchema: + async def create(self, redis: Redis, data: DictDataCreateSchema) -> DictDataOutSchema: """ 创建数据字典数据 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - data (DictDataCreateSchema): 数据字典数据创建模型 @@ -451,21 +438,21 @@ class DictDataService: - DictDataOutSchema: 字典数据响应模型 """ # 检查相同字典类型下dict_label是否已存在 - exist_label_obj = await DictDataCRUD(auth).get(dict_type=data.dict_type, dict_label=data.dict_label) + exist_label_obj = await DictDataCRUD(self.auth).get(dict_type=data.dict_type, dict_label=data.dict_label) if exist_label_obj: raise CustomException(msg=f'创建失败，该字典类型下的字典标签"{data.dict_label}"已存在') # 检查相同字典类型下dict_value是否已存在 - exist_value_obj = await DictDataCRUD(auth).get(dict_type=data.dict_type, dict_value=data.dict_value) + exist_value_obj = await DictDataCRUD(self.auth).get(dict_type=data.dict_type, dict_value=data.dict_value) if exist_value_obj: raise CustomException(msg=f'创建失败，该字典类型下的字典键值"{data.dict_value}"已存在') - obj = await DictDataCRUD(auth).create(data=data) + obj = await DictDataCRUD(self.auth).create(data=data) - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{data.dict_type}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{data.dict_type}" try: # 获取当前字典类型的所有字典数据 - dict_data_list = await DictDataCRUD(auth).list(search={"dict_type": data.dict_type}) + dict_data_list = await DictDataCRUD(self.auth).list(search={"dict_type": data.dict_type}) dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] value = json.dumps(dict_data, ensure_ascii=False) @@ -481,10 +468,8 @@ class DictDataService: return DictDataOutSchema.model_validate(obj) - @classmethod - async def update_service( - cls, - auth: AuthSchema, + async def update( + self, redis: Redis, id: int, data: DictDataUpdateSchema, @@ -493,7 +478,6 @@ class DictDataService: 更新数据字典数据 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - id (int): 数据字典数据ID - data (DictDataUpdateSchema): 数据字典数据更新模型 @@ -501,27 +485,27 @@ class DictDataService: 返回: - DictDataOutSchema: 字典数据响应模型 """ - exist_obj = await DictDataCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_obj = await DictDataCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") # 检查相同字典类型下dict_label是否已存在（排除当前记录） if exist_obj.dict_label != data.dict_label: - exist_label_obj = await DictDataCRUD(auth).get(dict_type=data.dict_type, dict_label=data.dict_label) + exist_label_obj = await DictDataCRUD(self.auth).get(dict_type=data.dict_type, dict_label=data.dict_label) if exist_label_obj: raise CustomException(msg=f'更新失败，该字典类型下的字典标签"{data.dict_label}"已存在') # 检查相同字典类型下dict_value是否已存在（排除当前记录） if exist_obj.dict_value != data.dict_value: - exist_value_obj = await DictDataCRUD(auth).get(dict_type=data.dict_type, dict_value=data.dict_value) + exist_value_obj = await DictDataCRUD(self.auth).get(dict_type=data.dict_type, dict_value=data.dict_value) if exist_value_obj: raise CustomException(msg=f'更新失败，该字典类型下的字典键值"{data.dict_value}"已存在') # 如果字典类型变更，仅刷新旧类型缓存，不联动字典类型状态 if exist_obj.dict_type != data.dict_type: - dict_type = await DictTypeCRUD(auth).get(dict_type=exist_obj.dict_type) + dict_type = await DictTypeCRUD(self.auth).get(dict_type=exist_obj.dict_type) if dict_type: - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{dict_type.dict_type}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{dict_type.dict_type}" try: - dict_data_list = await DictDataCRUD(auth).list(search={"dict_type": dict_type.dict_type}) + dict_data_list = await DictDataCRUD(self.auth).list(search={"dict_type": dict_type.dict_type}) dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] value = json.dumps(dict_data, ensure_ascii=False) await RedisCURD(redis).set( @@ -530,15 +514,16 @@ class DictDataService: expire=None, ) except Exception as e: - logger.error(f"更新字典数据类型变更时刷新旧缓存失败: {e}") + logger.error(f"刷新旧字典缓存失败: {e}") + raise CustomException(msg="同步旧字典数据缓存失败") from e - obj = await DictDataCRUD(auth).update(id=id, data=data) - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{data.dict_type}" + obj = await DictDataCRUD(self.auth).update(id=id, data=data) + + # 刷新新字典类型缓存 + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{data.dict_type}" try: - # 获取当前字典类型的所有字典数据 - dict_data_list = await DictDataCRUD(auth).list(search={"dict_type": data.dict_type}) + dict_data_list = await DictDataCRUD(self.auth).list(search={"dict_type": data.dict_type}) dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] - value = json.dumps(dict_data, ensure_ascii=False) await RedisCURD(redis).set( key=redis_key, @@ -552,76 +537,59 @@ class DictDataService: return DictDataOutSchema.model_validate(obj) - @classmethod - async def delete_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None: + async def delete(self, redis: Redis, ids: list[int]) -> None: """ 删除数据字典数据 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis客户端 - ids (list[int]): 数据字典数据ID列表 返回: - None """ - try: - if len(ids) < 1: - raise CustomException(msg="删除失败，删除对象不能为空") + if len(ids) < 1: + raise CustomException(msg="删除失败，删除对象不能为空") + existing = await DictDataCRUD(self.auth).list(search={"id": ("in", ids)}) + existing_map = {obj.id: obj for obj in existing} + for nid in ids: + if nid not in existing_map: + raise CustomException(msg="删除失败，该数据不存在") + exist_obj = existing_map[nid] + # 删除该字典类型缓存中的对应项 + redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{self.auth.user.tenant_id}:{exist_obj.dict_type}" + try: + # 重新拉取该类型所有字典数据并写回缓存（保持一致） + dict_data_list = await DictDataCRUD(self.auth).list(search={"dict_type": exist_obj.dict_type}) + dict_data = [DictDataOutSchema.model_validate(row).model_dump(mode="json") for row in dict_data_list if row] + value = json.dumps(dict_data, ensure_ascii=False) + await RedisCURD(redis).set( + key=redis_key, + value=value, + expire=None, + ) + logger.info(f"删除字典数据并刷新缓存: {nid}") + except Exception as e: + logger.error(f"删除字典数据刷新缓存失败: {e}") + raise CustomException(msg="同步删除字典数据缓存失败") from e + await DictDataCRUD(self.auth).delete(ids=ids) - # 批量查询所有待删除项 - existing = await DictDataCRUD(auth).list(search={"id": ("in", ids)}) - existing_map = {obj.id: obj for obj in existing} - for nid in ids: - if nid not in existing_map: - raise CustomException(msg=f"{nid} 删除失败，该字典数据不存在") - exist_obj = existing_map[nid] - # 系统默认字典数据不允许删除 - if exist_obj.is_default: - raise CustomException(msg=f"删除失败，ID为{nid}的系统默认字典数据不允许删除") - - # 从批量查询结果中收集缓存键 - dict_types_to_clear = {obj.dict_type for obj in existing} - - # 执行删除操作 - await DictDataCRUD(auth).delete(ids=ids) - - # 清除缓存 - for dict_type in dict_types_to_clear: - try: - redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{auth.user.tenant_id}:{dict_type}" - await RedisCURD(redis).delete(redis_key) - logger.info(f"清除字典缓存成功: {dict_type}") - except Exception as e: - logger.warning(f"清除字典缓存失败: {e}") - # 缓存清除失败不影响删除操作 - - logger.info(f"删除字典数据成功，ID列表: {ids}") - - except CustomException: - raise - except Exception as e: - logger.error(f"删除字典数据失败: {e!s}") - raise CustomException(msg="删除字典数据失败") from e - - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: + async def set_available(self, data: BatchSetAvailable) -> None: """ - 批量修改数据字典数据状态 + 设置数据字典数据状态 参数: - - auth (AuthSchema): 认证信息模型 - - data (BatchSetAvailable): 批量修改数据字典数据状态负载模型 + - data (BatchSetAvailable): 批量设置状态模型 返回: - None """ - await DictDataCRUD(auth).set(ids=data.ids, status=data.status) + await DictDataCRUD(self.auth).set(ids=data.ids, status=data.status) - @classmethod - async def export_service(cls, data_list: list[dict]) -> bytes: + @staticmethod + def export(data_list: list[dict]) -> bytes: """ - 导出数据字典数据列表 + 导出数据字典数据列表（无状态工具方法） 参数: - data_list (list[dict]): 数据字典数据列表 @@ -631,13 +599,10 @@ class DictDataService: """ mapping_dict = { "id": "编号", - "dict_sort": "字典排序", + "dict_type": "字典类型", "dict_label": "字典标签", "dict_value": "字典键值", - "dict_type": "字典类型", - "css_class": "样式属性", - "list_class": "表格回显样式", - "is_default": "是否默认", + "dict_sort": "字典排序", "status": "状态", "description": "备注", "created_time": "创建时间", @@ -649,9 +614,10 @@ class DictDataService: # 复制数据并转换状态 data = data_list.copy() for item in data: - # 处理状态 item["status"] = "启用" if item.get("status") == 0 else "停用" - # 处理是否默认 - item["is_default"] = "是" if item.get("is_default") else "否" + if item.get("is_default") is True: + item["is_default"] = "是" + else: + item["is_default"] = "否" return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict) diff --git a/backend/app/api/v1/module_system/log/controller.py b/backend/app/api/v1/module_system/log/controller.py index 9d561e86..52fdd56c 100644 --- a/backend/app/api/v1/module_system/log/controller.py +++ b/backend/app/api/v1/module_system/log/controller.py @@ -21,7 +21,7 @@ from .schema import ( ) from .service import LoginLogService, OperationLogService -LogRouter = APIRouter(route_class=OperationLogRoute, prefix="/log", tags=["日志管理"]) +LogRouter = APIRouter(route_class=OperationLogRoute, prefix="/log", tags=["系统管理", "日志管理"]) @LogRouter.get( @@ -33,17 +33,7 @@ async def get_log_detail_controller( id: Annotated[int, Path(description="登录日志ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:login_log:query"]))], ) -> JSONResponse: - """ - 获取登录日志详情 - - 参数: - - id (int): 登录日志 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含登录日志详情的 JSON 响应。 - """ - result_dict = await LoginLogService.detail_service(id=id, auth=auth) + result_dict = await LoginLogService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取登录日志详情成功") @@ -57,19 +47,7 @@ async def get_log_list_controller( search: Annotated[LoginLogQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:login_log:query"]))], ) -> JSONResponse: - """ - 查询登录日志列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (LoginLogQueryParam): 查询筛选参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页登录日志列表的 JSON 响应。 - """ - result_dict = await LoginLogService.page_service( - auth=auth, + result_dict = await LoginLogService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -87,17 +65,7 @@ async def create_log_controller( data: LoginLogCreateSchema, auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 创建登录日志 - - 参数: - - data (LoginLogCreateSchema): 登录日志创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含创建后的登录日志详情的 JSON 响应。 - """ - result_dict = await LoginLogService.create_service(auth=auth, data=data) + result_dict = await LoginLogService(auth).create(data=data) return SuccessResponse(data=result_dict, msg="创建登录日志成功") @@ -110,17 +78,7 @@ async def delete_log_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:login_log:delete"]))], ) -> JSONResponse: - """ - 删除登录日志 - - 参数: - - ids (list[int]): 日志 ID 列表。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 删除结果。 - """ - await LoginLogService.delete_service(auth=auth, ids=ids) + await LoginLogService(auth).delete(ids=ids) return SuccessResponse(msg="删除登录日志成功") @@ -135,17 +93,7 @@ async def get_operation_log_detail_controller( id: Annotated[int, Path(gt=0)], auth: Annotated[AuthSchema, Depends(get_current_user)], ): - """ - 获取操作日志详情 - - 参数: - - id (int): 操作日志 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含操作日志详情的 JSON 响应。 - """ - result_dict = await OperationLogService.detail_service(auth=auth, id=id) + result_dict = await OperationLogService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取操作日志详情成功") @@ -161,23 +109,11 @@ async def list( search: Annotated[OperationLogQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(get_current_user)], ): - """ - 获取操作日志列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (OperationLogQueryParam): 查询筛选参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页操作日志列表的 JSON 响应。 - """ - result_dict = await OperationLogService.page_service( - auth, - page.page_no, - page.page_size, - search.model_dump(exclude_none=True), - page.order_by, + result_dict = await OperationLogService(auth).page( + page_no=page.page_no, + page_size=page.page_size, + search=search, + order_by=page.order_by, ) return SuccessResponse(data=result_dict, msg="查询操作日志列表成功") @@ -192,17 +128,7 @@ async def create_operation_log_controller( data: OperationLogCreateSchema, auth: Annotated[AuthSchema, Depends(get_current_user)], ): - """ - 创建操作日志 - - 参数: - - data (OperationLogCreateSchema): 操作日志创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含创建后的操作日志详情的 JSON 响应。 - """ - result_dict = await OperationLogService.create_service(auth=auth, data=data) + result_dict = await OperationLogService(auth).create(data=data) return SuccessResponse(data=result_dict, msg="创建操作日志成功") @@ -217,15 +143,5 @@ async def delete( data: BatchDelete, auth: Annotated[AuthSchema, Depends(get_current_user)], ): - """ - 删除操作日志 - - 参数: - - data (BatchDelete): 批量删除参数（ID 列表）。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 删除结果。 - """ - await OperationLogService.delete_service(auth=auth, ids=data.ids) + await OperationLogService(auth).delete(ids=data.ids) return SuccessResponse(msg="删除操作日志成功") diff --git a/backend/app/api/v1/module_system/log/service.py b/backend/app/api/v1/module_system/log/service.py index a10ad32f..203e9ff7 100644 --- a/backend/app/api/v1/module_system/log/service.py +++ b/backend/app/api/v1/module_system/log/service.py @@ -16,99 +16,75 @@ from .schema import ( class LoginLogService: - """ - 登录日志管理服务 + """登录日志管理服务""" - 提供登录日志 CRUD、清理过期日志等业务能力。 - """ + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> LoginLogDetailOutSchema: - return await LoginLogCRUD(auth).get_or_404(id=id, out_schema=LoginLogDetailOutSchema) + async def detail(self, id: int) -> LoginLogDetailOutSchema: + return await LoginLogCRUD(self.auth).get_or_404(id=id, out_schema=LoginLogDetailOutSchema) - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: LoginLogQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> dict: - search_dict = vars(search) if search else None - order_by_list = order_by or [{"updated_time": "desc"}] - offset = (page_no - 1) * page_size - - result = await LoginLogCRUD(auth).page( - offset=offset, + return await LoginLogCRUD(self.auth).page( + offset=(page_no - 1) * page_size, limit=page_size, - order_by=order_by_list, - search=search_dict, + order_by=order_by or [{"updated_time": "desc"}], + search=vars(search) if search else None, out_schema=LoginLogOutSchema, ) - return result - @classmethod - async def create_service(cls, auth: AuthSchema, data: LoginLogCreateSchema) -> LoginLogDetailOutSchema: - obj = await LoginLogCRUD(auth).create(data=data) + async def create(self, data: LoginLogCreateSchema) -> LoginLogDetailOutSchema: + obj = await LoginLogCRUD(self.auth).create(data=data) if not obj: raise CustomException(msg="创建失败") return LoginLogDetailOutSchema.model_validate(obj) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - existing = await LoginLogCRUD(auth).list(search={"id": ("in", ids)}) + existing = await LoginLogCRUD(self.auth).list(search={"id": ("in", ids)}) existing_map = {obj.id for obj in existing} for nid in ids: if nid not in existing_map: raise CustomException(msg=f"删除失败，ID为{nid}的数据不存在") - await LoginLogCRUD(auth).delete(ids=ids) + await LoginLogCRUD(self.auth).delete(ids=ids) class OperationLogService: - """ - 操作日志管理服务 + """操作日志管理服务""" - 提供操作日志记录、分页查询、清理过期日志等业务能力。 - """ + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth @staticmethod async def cleanup_operation_log() -> None: - """ - 定时任务：清理超过保留期的操作日志和登录日志。 - - 清理 created_time < now - retention_days 的记录。 - 保留期从全局参数 `operation_log_retention_days` 读取，默认 90 天。 - - 返回: - - bool: 清理完成返回 True。 - """ from datetime import datetime, timedelta - from sqlalchemy import delete + from sqlalchemy import delete, select from app.core.database import async_db_session from .model import LoginLogModel, OperationLogModel - retention_days = 90 # 默认 90 天，可通过系统参数覆盖 - # 尝试从系统参数读取自定义保留期 + retention_days = 90 try: from app.api.v1.module_system.params.model import ParamsModel async with async_db_session() as _s: - from sqlalchemy import select - result = await _s.execute(select(ParamsModel.config_value).where(ParamsModel.config_key == "operation_log_retention_days").limit(1)) row = result.scalar() if row is not None: retention_days = int(row) except Exception: - pass # 读取失败使用默认值 + pass cutoff = datetime.now() - timedelta(days=retention_days) async with async_db_session() as session: @@ -122,50 +98,21 @@ class OperationLogService: logger.info(f"操作日志清理完成: 操作日志 {op_result.rowcount} 条, 登录日志 {login_result.rowcount} 条") return True - @classmethod - async def create_service(cls, auth: AuthSchema, data: OperationLogCreateSchema) -> OperationLogDetailOutSchema: - """ - 创建操作日志。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - data (OperationLogCreateSchema): 操作日志创建模型。 - - 返回: - - OperationLogDetailOutSchema: 新创建的操作日志。 - - 异常: - - CustomException: 创建失败时抛出。 - """ - crud = OperationLogCRUD(auth) + async def create(self, data: OperationLogCreateSchema) -> OperationLogDetailOutSchema: + crud = OperationLogCRUD(self.auth) obj = await crud.create(data=data) if not obj: raise CustomException(msg="创建失败") return OperationLogDetailOutSchema.model_validate(obj) - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: OperationLogQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> dict: - """ - 分页查询操作日志。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - page_no (int): 页码。 - - page_size (int): 每页数量。 - - search (OperationLogQueryParam | None): 查询参数。 - - order_by (list[dict[str, str]] | None): 排序参数。 - - 返回: - - dict: 分页数据。 - """ - crud = OperationLogCRUD(auth) + crud = OperationLogCRUD(self.auth) return await crud.page( offset=(page_no - 1) * page_size, limit=page_size, @@ -174,43 +121,17 @@ class OperationLogService: out_schema=OperationLogOutSchema, ) - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> OperationLogDetailOutSchema: - """ - 获取操作日志详情。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - id (int): 操作日志ID。 - - 返回: - - OperationLogDetailOutSchema: 操作日志详情。 - """ - - crud = OperationLogCRUD(auth) + async def detail(self, id: int) -> OperationLogDetailOutSchema: + crud = OperationLogCRUD(self.auth) return await crud.get_or_404(id=id, out_schema=OperationLogDetailOutSchema) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除操作日志。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - ids (list[int]): 操作日志ID列表。 - - 异常: - - CustomException: 删除失败时抛出。 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - existing = await OperationLogCRUD(auth).list(search={"id": ("in", ids)}) + existing = await OperationLogCRUD(self.auth).list(search={"id": ("in", ids)}) existing_map = {obj.id for obj in existing} for nid in ids: if nid not in existing_map: raise CustomException(msg="删除失败，该数据不存在") - crud = OperationLogCRUD(auth) - await crud.delete(ids) + crud = OperationLogCRUD(self.auth) + await crud.delete(ids=ids) diff --git a/backend/app/api/v1/module_system/notice/controller.py b/backend/app/api/v1/module_system/notice/controller.py index 37d2118a..2f03fcb2 100644 --- a/backend/app/api/v1/module_system/notice/controller.py +++ b/backend/app/api/v1/module_system/notice/controller.py @@ -22,11 +22,10 @@ from .schema import ( ) from .service import NoticeService -NoticeRouter = APIRouter(route_class=OperationLogRoute, prefix="/notice", tags=["公告通知"]) +NoticeRouter = APIRouter(route_class=OperationLogRoute, prefix="/notice", tags=["系统管理", "公告通知"]) _NOTICE_NS = "notice" - @NoticeRouter.get( "/detail/{id}", summary="获取公告详情", @@ -36,20 +35,9 @@ async def get_notice_detail_controller( id: Annotated[int, Path(description="公告ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:detail"]))], ) -> JSONResponse: - """ - 获取公告详情。 - - 参数: - - id (int): 公告ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含公告详情的响应模型。 - """ - result_dict = await NoticeService.detail_service(id=id, auth=auth) + result_dict = await NoticeService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取公告详情成功") - @NoticeRouter.get( "/list", summary="查询公告", @@ -60,19 +48,7 @@ async def get_notice_list_controller( search: Annotated[NoticeQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:query"]))], ) -> JSONResponse: - """ - 查询公告。 - - 参数: - - page (PaginationQueryParam): 分页查询参数模型。 - - search (NoticeQueryParam): 查询公告参数模型。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页公告详情的响应模型。 - """ - result_dict = await NoticeService.page_service( - auth=auth, + result_dict = await NoticeService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -80,7 +56,6 @@ async def get_notice_list_controller( ) return SuccessResponse(data=result_dict, msg="查询公告列表成功") - @NoticeRouter.post( "/create", summary="创建公告", @@ -90,21 +65,10 @@ async def create_notice_controller( data: NoticeCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:create"]))], ) -> JSONResponse: - """ - 创建公告。 - - 参数: - - data (NoticeCreateSchema): 创建公告负载模型。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含创建公告结果的响应模型。 - """ - result_dict = await NoticeService.create_service(auth=auth, data=data) + result_dict = await NoticeService(auth).create(data=data) await FastAPICache.clear(namespace=_NOTICE_NS) return SuccessResponse(data=result_dict, msg="创建公告成功") - @NoticeRouter.put( "/update/{id}", summary="修改公告", @@ -115,22 +79,10 @@ async def update_notice_controller( id: Annotated[int, Path(description="公告ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:update"]))], ) -> JSONResponse: - """ - 修改公告。 - - 参数: - - data (NoticeUpdateSchema): 修改公告负载模型。 - - id (int): 公告ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含修改公告结果的响应模型。 - """ - result_dict = await NoticeService.update_service(auth=auth, id=id, data=data) + result_dict = await NoticeService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_NOTICE_NS) return SuccessResponse(data=result_dict, msg="修改公告成功") - @NoticeRouter.delete( "/delete", summary="删除公告", @@ -140,21 +92,10 @@ async def delete_notice_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:delete"]))], ) -> JSONResponse: - """ - 删除公告。 - - 参数: - - ids (list[int]): 公告ID列表。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含删除公告结果的响应模型。 - """ - await NoticeService.delete_service(auth=auth, ids=ids) + await NoticeService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_NOTICE_NS) return SuccessResponse(msg="删除公告成功") - @NoticeRouter.patch( "/status/batch", summary="批量修改公告状态", @@ -164,21 +105,10 @@ async def batch_set_available_notice_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:patch"]))], ) -> JSONResponse: - """ - 批量修改公告状态。 - - 参数: - - data (BatchSetAvailable): 批量修改公告状态负载模型。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含批量修改公告状态结果的响应模型。 - """ - await NoticeService.set_available_service(auth=auth, data=data) + await NoticeService(auth).set_available(data=data) await FastAPICache.clear(namespace=_NOTICE_NS) return SuccessResponse(msg="批量修改公告状态成功") - @NoticeRouter.post( "/export", summary="导出公告", @@ -187,19 +117,9 @@ async def export_notice_list_controller( search: Annotated[NoticeQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:notice:export"]))], ) -> StreamingResponse: - """ - 导出公告。 - - 参数: - - search (NoticeQueryParam): 查询公告参数模型。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - StreamingResponse: 包含导出公告的流式响应模型。 - """ - result_dict_list = await NoticeService.list_service(search=search, auth=auth) + result_dict_list = await NoticeService(auth).list(search=search) export_data = [item.model_dump() for item in result_dict_list] - export_result = await NoticeService.export_notice_service(notice_list=export_data) + export_result = NoticeService.export(notice_list=export_data) return StreamResponse( data=bytes2file_response(export_result), @@ -207,7 +127,6 @@ async def export_notice_list_controller( headers={"Content-Disposition": "attachment; filename=notice.xlsx"}, ) - @NoticeRouter.get( "/available", summary="获取全局启用公告", @@ -217,19 +136,9 @@ async def export_notice_list_controller( async def get_notice_list_available_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 获取全局启用公告。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页已启用公告详情的响应模型。 - """ - result_dict = await NoticeService.available_page_service(auth=auth) + result_dict = await NoticeService(auth).available_page() return SuccessResponse(data=result_dict, msg="查询已启用公告列表成功") - @NoticeRouter.get( "/panel", summary="通知面板数据（铃铛）", @@ -240,13 +149,9 @@ async def get_notification_panel_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: """通知面板聚合接口，返回通知、消息、待办三个列表。""" - result = await NoticeService.get_panel_data_service(auth=auth) + result = await NoticeService(auth).panel_data() return SuccessResponse(data=result, msg="获取面板数据成功") - -# ============ 已读追踪端点 ============ - - @NoticeRouter.post( "/read/{id}", summary="标记已读", @@ -257,12 +162,11 @@ async def mark_read_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: """标记已读。通过 `sys_notice_read` 表记录已读时间。""" - await NoticeService.mark_read_service(auth=auth, notice_id=id) + await NoticeService(auth).mark_read(notice_id=id) await FastAPICache.clear(namespace=_NOTICE_NS) logger.info(f"用户[{auth.user.id}]标记通知[{id}]已读") return SuccessResponse(msg="标记已读成功") - @NoticeRouter.post( "/read-all", summary="全部已读", @@ -272,12 +176,11 @@ async def mark_all_read_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: """全部标记已读。返回本次操作标记的数量。""" - count = await NoticeService.mark_all_read_service(auth=auth) + count = await NoticeService(auth).mark_all_read() await FastAPICache.clear(namespace=_NOTICE_NS) logger.info(f"用户[{auth.user.id}]全部已读, 数量={count}") return SuccessResponse(data=count, msg=f"全部标记已读成功，共标记 {count} 条") - @NoticeRouter.get( "/unread-count", summary="获取未读数量", @@ -288,5 +191,5 @@ async def get_unread_count_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: """获取未读通知数量。通过 LEFT JOIN 统计未读数。""" - count = await NoticeService.get_unread_count_service(auth=auth) + count = await NoticeService(auth).get_unread_count() return SuccessResponse(data=count, msg="获取未读数量成功") diff --git a/backend/app/api/v1/module_system/notice/service.py b/backend/app/api/v1/module_system/notice/service.py index 0886bd4e..b47aff32 100644 --- a/backend/app/api/v1/module_system/notice/service.py +++ b/backend/app/api/v1/module_system/notice/service.py @@ -22,65 +22,29 @@ class NoticeService: 提供公告 CRUD、状态切换、已启用公告分页查询、消息面板、Excel 导出等业务能力。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> NoticeOutSchema: - """ - 获取公告详情。 + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - 参数: - - auth (AuthSchema): 认证信息模型。 - - id (int): 公告ID。 + async def detail(self, id: int) -> NoticeOutSchema: + return await NoticeCRUD(self.auth).get_or_404(id=id, out_schema=NoticeOutSchema) - 返回: - - NoticeOutSchema: 公告响应模型。 - """ - return await NoticeCRUD(auth).get_or_404(id=id, out_schema=NoticeOutSchema) - - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: NoticeQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[NoticeOutSchema]: - """ - 获取公告列表。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - search (NoticeQueryParam | None): 查询参数模型。 - - order_by (list[dict] | None): 排序参数列表。 - - 返回: - - list[NoticeOutSchema]: 公告响应模型列表。 - """ - notice_obj_list = await NoticeCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + notice_obj_list = await NoticeCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [NoticeOutSchema.model_validate(notice_obj) for notice_obj in notice_obj_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: NoticeQueryParam | None = None, order_by: list[dict] | None = None, ) -> dict: - """ - 分页查询公告（数据库 OFFSET/LIMIT）。 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码（从 1 开始） - - page_size (int): 每页条数 - - search (NoticeQueryParam | None): 查询条件 - - order_by (list[dict] | None): 排序字段列表 - - 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） - """ offset = (page_no - 1) * page_size - return await NoticeCRUD(auth).page( + return await NoticeCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -88,18 +52,8 @@ class NoticeService: out_schema=NoticeOutSchema, ) - @classmethod - async def available_page_service(cls, auth: AuthSchema) -> dict: - """ - 已启用公告分页（与历史行为一致：固定第 1 页、每页 10 条）。 - - 参数: - - auth (AuthSchema): 认证信息模型 - - 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） - """ - return await NoticeCRUD(auth).page( + async def available_page(self) -> dict: + return await NoticeCRUD(self.auth).page( offset=0, limit=10, order_by=[{"id": "asc"}], @@ -107,102 +61,36 @@ class NoticeService: out_schema=NoticeOutSchema, ) - @classmethod - async def create_service(cls, auth: AuthSchema, data: NoticeCreateSchema) -> NoticeOutSchema: - """ - 创建公告。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - data (NoticeCreateSchema): 创建公告负载模型。 - - 返回: - - NoticeOutSchema: 创建的公告响应模型。 - - 异常: - - CustomException: 创建失败，该公告通知已存在。 - """ - notice = await NoticeCRUD(auth).get(notice_title=data.notice_title) + async def create(self, data: NoticeCreateSchema) -> NoticeOutSchema: + notice = await NoticeCRUD(self.auth).get(notice_title=data.notice_title) if notice: raise CustomException(msg="创建失败，该数据已存在") - notice_obj = await NoticeCRUD(auth).create(data=data) + notice_obj = await NoticeCRUD(self.auth).create(data=data) return NoticeOutSchema.model_validate(notice_obj) - @classmethod - async def update_service(cls, auth: AuthSchema, id: int, data: NoticeUpdateSchema) -> NoticeOutSchema: - """ - 更新公告。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - id (int): 公告ID。 - - data (NoticeUpdateSchema): 更新公告负载模型。 - - 返回: - - NoticeOutSchema: 更新的公告响应模型。 - - 异常: - - CustomException: 更新失败，该公告通知不存在或公告通知标题重复。 - """ - _ = await NoticeCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") - exist_notice = await NoticeCRUD(auth).get(notice_title=data.notice_title) + async def update(self, id: int, data: NoticeUpdateSchema) -> NoticeOutSchema: + _ = await NoticeCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_notice = await NoticeCRUD(self.auth).get(notice_title=data.notice_title) if exist_notice and exist_notice.id != id: raise CustomException(msg="更新失败，标题已存在") - notice_obj = await NoticeCRUD(auth).update(id=id, data=data) + notice_obj = await NoticeCRUD(self.auth).update(id=id, data=data) return NoticeOutSchema.model_validate(notice_obj) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除公告。 - - 参数: - - auth (AuthSchema): 认证信息模型。 - - ids (list[int]): 删除的ID列表。 - - 异常: - - CustomException: 删除失败，删除对象不能为空或该公告通知不存在。 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - notices = await NoticeCRUD(auth).list(search={"id": ("in", ids)}) + notices = await NoticeCRUD(self.auth).list(search={"id": ("in", ids)}) notice_map = {n.id: n for n in notices} for nid in ids: if nid not in notice_map: raise CustomException(msg="删除失败，该数据不存在") - await NoticeCRUD(auth).delete(ids=ids) + await NoticeCRUD(self.auth).delete(ids=ids) - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: - """ - 批量设置公告状态。 + async def set_available(self, data: BatchSetAvailable) -> None: + await NoticeCRUD(self.auth).set(ids=data.ids, status=data.status) - 参数: - - auth (AuthSchema): 认证信息模型。 - - data (BatchSetAvailable): 批量设置可用负载模型。 - - 异常: - - CustomException: 批量设置失败，该公告通知不存在。 - - 返回: - - None - """ - await NoticeCRUD(auth).set(ids=data.ids, status=data.status) - - @classmethod - async def export_service(cls, notice_list: list[dict]) -> bytes: - """ - 导出公告列表。 - - 参数: - - notice_list (list[dict]): 公告详情字典列表。 - - 返回: - - bytes: Excel 文件的字节流。 - """ + @staticmethod + def export(notice_list: list[dict]) -> bytes: mapping_dict = { "id": "编号", "notice_title": "公告标题", @@ -215,75 +103,56 @@ class NoticeService: "created_id": "创建者ID", "updated_id": "更新者ID", } - - # 复制数据并转换状态 data = notice_list.copy() for item in data: - # 处理状态 item["status"] = "启用" if item.get("status") == 0 else "停用" - # 处理公告类型 item["notice_type"] = "通知" if item.get("notice_type") == "1" else "公告" - return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict) - @classmethod - async def latest_service(cls, auth: AuthSchema, limit: int = 5) -> list[NoticeOutSchema]: - """获取最新 N 条已启用公告""" + async def latest(self, limit: int = 5) -> list[NoticeOutSchema]: from sqlalchemy import desc, select - from .model import NoticeModel - from .schema import NoticeOutSchema - stmt = select(NoticeModel).where(NoticeModel.status == 0).order_by(desc(NoticeModel.created_time)).limit(limit) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) notices = result.scalars().all() return [NoticeOutSchema.model_validate(n) for n in notices] - # ============ 已读追踪 ============ - - @classmethod - async def mark_read_service(cls, auth: AuthSchema, notice_id: int) -> None: - """标记通知为已读（幂等：已读的不重复写入）""" + async def mark_read(self, notice_id: int) -> None: from datetime import datetime from sqlalchemy import select - # 检查公告是否存在 - notice = await NoticeCRUD(auth).get(id=notice_id) + notice = await NoticeCRUD(self.auth).get(id=notice_id) if not notice: raise CustomException(msg="该公告不存在") - # 检查是否已读 exist_stmt = select(NoticeReadModel).where( - NoticeReadModel.user_id == auth.user.id, + NoticeReadModel.user_id == self.auth.user.id, NoticeReadModel.notice_id == notice_id, ) - result = await auth.db.execute(exist_stmt) + result = await self.auth.db.execute(exist_stmt) if result.scalar_one_or_none(): - return # 已读，幂等返回 + return read_record = NoticeReadModel( - user_id=auth.user.id, + user_id=self.auth.user.id, notice_id=notice_id, read_time=datetime.now(), ) - auth.db.add(read_record) - await auth.db.flush() + self.auth.db.add(read_record) + await self.auth.db.flush() - @classmethod - async def mark_all_read_service(cls, auth: AuthSchema) -> int: - """全部标记已读：将当前租户所有 status=0 且未读的公告批量标记为已读，返回操作数量""" + async def mark_all_read(self) -> int: from datetime import datetime - from sqlalchemy import select + from sqlalchemy import insert, select - # 查询所有已启用但未读的公告 - read_ids_stmt = select(NoticeReadModel.notice_id).where(NoticeReadModel.user_id == auth.user.id) - read_ids_result = await auth.db.execute(read_ids_stmt) + read_ids_stmt = select(NoticeReadModel.notice_id).where(NoticeReadModel.user_id == self.auth.user.id) + read_ids_result = await self.auth.db.execute(read_ids_stmt) read_ids = {row[0] for row in read_ids_result.fetchall()} notices_stmt = select(NoticeModel.id).where(NoticeModel.status == 0) - notices_result = await auth.db.execute(notices_stmt) + notices_result = await self.auth.db.execute(notices_stmt) all_ids = {row[0] for row in notices_result.fetchall()} unread_ids = all_ids - read_ids @@ -291,48 +160,38 @@ class NoticeService: return 0 now = datetime.now() - from sqlalchemy import insert - if unread_ids: - await auth.db.execute( + await self.auth.db.execute( insert(NoticeReadModel), - [{"user_id": auth.user.id, "notice_id": nid, "read_time": now} for nid in unread_ids], + [{"user_id": self.auth.user.id, "notice_id": nid, "read_time": now} for nid in unread_ids], ) - await auth.db.flush() + await self.auth.db.flush() return len(unread_ids) - @classmethod - async def get_unread_count_service(cls, auth: AuthSchema) -> int: - """获取当前用户未读通知数量""" + async def get_unread_count(self) -> int: from sqlalchemy import func, select - # 所有已启用公告总数 total_stmt = select(func.count()).select_from(NoticeModel).where(NoticeModel.status == 0) - total_result = await auth.db.execute(total_stmt) + total_result = await self.auth.db.execute(total_stmt) total_count = total_result.scalar() or 0 - # 已读数量 - read_stmt = select(func.count()).select_from(NoticeReadModel).where(NoticeReadModel.user_id == auth.user.id) - read_result = await auth.db.execute(read_stmt) + read_stmt = select(func.count()).select_from(NoticeReadModel).where(NoticeReadModel.user_id == self.auth.user.id) + read_result = await self.auth.db.execute(read_stmt) read_count = read_result.scalar() or 0 return max(0, total_count - read_count) - @classmethod - async def panel_data_service(cls, auth: AuthSchema) -> PanelDataOut: - """聚合通知面板数据：通知 + 消息 + 待办""" + async def panel_data(self) -> PanelDataOut: from sqlalchemy import desc, select - # 1. 通知：最新 5 条已启用公告 - notices = await cls.latest_service(auth, limit=5) + notices = await self.latest(limit=5) - # 2. 消息：最近的操作日志（作为系统消息） messages = [] try: from app.api.v1.module_system.log.model import OperationLogModel stmt = select(OperationLogModel).order_by(desc(OperationLogModel.created_time)).limit(5) - result = await auth.db.execute(stmt) + result = await self.auth.db.execute(stmt) logs = result.scalars().all() for log_entry in logs: messages.append( @@ -347,7 +206,6 @@ class NoticeService: except Exception as e: logger.warning(f"获取面板消息数据失败（操作日志表可能不存在），已跳过: {e}") - # 3. 待办：暂无数据源，返回空列表 pendings: list[dict] = [] return PanelDataOut( diff --git a/backend/app/api/v1/module_system/params/controller.py b/backend/app/api/v1/module_system/params/controller.py index cc974e1a..ef3d4654 100644 --- a/backend/app/api/v1/module_system/params/controller.py +++ b/backend/app/api/v1/module_system/params/controller.py @@ -14,8 +14,7 @@ from app.utils.common_util import bytes2file_response from .schema import ParamsCreateSchema, ParamsOutSchema, ParamsQueryParam, ParamsUpdateSchema from .service import ParamsService -ParamsRouter = APIRouter(route_class=OperationLogRoute, prefix="/param", tags=["参数管理"]) - +ParamsRouter = APIRouter(route_class=OperationLogRoute, prefix="/param", tags=["系统管理", "参数管理"]) @ParamsRouter.get( "/detail/{id}", @@ -26,20 +25,9 @@ async def get_param_detail_controller( id: Annotated[int, Path(description="参数ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:detail"]))], ) -> JSONResponse: - """ - 获取参数详情 - - 参数: - - id (int): 参数ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含参数详情的 JSON 响应 - """ - result_dict = await ParamsService.detail_service(id=id, auth=auth) + result_dict = await ParamsService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取参数详情成功") - @ParamsRouter.get( "/key/{config_key}", summary="根据配置键获取参数详情", @@ -49,20 +37,9 @@ async def get_param_by_key_controller( config_key: Annotated[str, Path(description="配置键")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:query"]))], ) -> JSONResponse: - """ - 根据配置键获取参数详情 - - 参数: - - config_key (str): 配置键 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含参数详情的 JSON 响应 - """ - result_dict = await ParamsService.get_by_key_service(config_key=config_key, auth=auth) + result_dict = await ParamsService(auth).get_by_key(config_key=config_key) return SuccessResponse(data=result_dict, msg="根据配置键获取参数详情成功") - @ParamsRouter.get( "/value/{config_key}", summary="根据配置键获取参数值", @@ -72,20 +49,9 @@ async def get_config_value_by_key_controller( config_key: Annotated[str, Path(description="配置键")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:query"]))], ) -> JSONResponse: - """ - 根据配置键获取参数值 - - 参数: - - config_key (str): 配置键 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含参数值的 JSON 响应 - """ - result_value = await ParamsService.get_config_value_by_key_service(config_key=config_key, auth=auth) + result_value = await ParamsService(auth).get_config_value_by_key(config_key=config_key) return SuccessResponse(data=result_value, msg="根据配置键获取参数值成功") - @ParamsRouter.get( "/list", summary="获取参数列表", @@ -96,19 +62,7 @@ async def get_param_list_controller( page: Annotated[PaginationQueryParam, Depends()], search: Annotated[ParamsQueryParam, Depends()], ) -> JSONResponse: - """ - 获取参数列表 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page (PaginationQueryParam): 分页查询参数模型 - - search (ParamsQueryParam): 参数查询参数模型 - - 返回: - - JSONResponse: 包含参数列表的 JSON 响应 - """ - result_dict = await ParamsService.page_service( - auth=auth, + result_dict = await ParamsService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -116,7 +70,6 @@ async def get_param_list_controller( ) return SuccessResponse(data=result_dict, msg="查询参数列表成功") - @ParamsRouter.post( "/create", summary="创建参数", @@ -127,21 +80,9 @@ async def create_param_controller( redis: Annotated[Redis, Depends(redis_getter)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:create"]))], ) -> JSONResponse: - """ - 创建参数 - - 参数: - - data (ParamsCreateSchema): 参数创建模型 - - redis (Redis): Redis 客户端实例 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含创建参数结果的 JSON 响应 - """ - result_dict = await ParamsService.create_service(auth=auth, redis=redis, data=data) + result_dict = await ParamsService(auth).create(redis=redis, data=data) return SuccessResponse(data=result_dict, msg="创建参数成功") - @ParamsRouter.put( "/update/{id}", summary="修改参数", @@ -153,22 +94,9 @@ async def update_param_controller( redis: Annotated[Redis, Depends(redis_getter)], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:update"]))], ) -> JSONResponse: - """ - 修改参数 - - 参数: - - data (ParamsUpdateSchema): 参数更新模型 - - id (int): 参数ID - - redis (Redis): Redis 客户端实例 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含修改参数结果的 JSON 响应 - """ - result_dict = await ParamsService.update_service(auth=auth, redis=redis, id=id, data=data) + result_dict = await ParamsService(auth).update(redis=redis, id=id, data=data) return SuccessResponse(data=result_dict, msg="更新参数成功") - @ParamsRouter.delete( "/delete", summary="删除参数", @@ -179,21 +107,9 @@ async def delete_param_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:delete"]))], ) -> JSONResponse: - """ - 删除参数 - - 参数: - - redis (Redis): Redis 客户端实例 - - ids (list[int]): 参数ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含删除参数结果的 JSON 响应 - """ - await ParamsService.delete_service(auth=auth, redis=redis, ids=ids) + await ParamsService(auth).delete(redis=redis, ids=ids) return SuccessResponse(msg="删除参数成功") - @ParamsRouter.patch( "/status/batch", summary="批量设置参数状态", @@ -204,21 +120,9 @@ async def batch_set_status_controller( status: Annotated[str, Body(description="状态值")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:patch"]))], ) -> JSONResponse: - """ - 批量设置参数状态 - - 参数: - - ids (list[int]): 参数ID列表 - - status (str): 状态值 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 包含批量设置参数状态结果的 JSON 响应 - """ - await ParamsService.batch_set_status_service(auth=auth, ids=ids, status=status) + await ParamsService(auth).batch_set_status(ids=ids, status=status) return SuccessResponse(msg="批量设置参数状态成功") - @ParamsRouter.get( "/export", summary="导出参数", @@ -228,19 +132,9 @@ async def export_param_list_controller( search: Annotated[ParamsQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:param:export"]))], ) -> StreamingResponse: - """ - 导出参数 - - 参数: - - search (ParamsQueryParam): 参数查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - StreamingResponse: 包含导出参数的 Excel 文件流响应 - """ - result_dict_list = await ParamsService.list_service(search=search, auth=auth) + result_dict_list = await ParamsService(auth).list(search=search) export_data = [item.model_dump() for item in result_dict_list] - export_result = await ParamsService.export_service(data_list=export_data) + export_result = ParamsService.export(data_list=export_data) return StreamResponse( data=bytes2file_response(export_result), @@ -248,7 +142,6 @@ async def export_param_list_controller( headers={"Content-Disposition": "attachment; filename=params.xlsx"}, ) - @ParamsRouter.get( "/info", summary="获取初始化缓存参数", @@ -257,14 +150,5 @@ async def export_param_list_controller( async def get_init_config_controller( redis: Annotated[Redis, Depends(redis_getter)], ) -> JSONResponse: - """ - 获取初始化缓存参数 - - 参数: - - redis (Redis): Redis 客户端实例 - - 返回: - - JSONResponse: 获取初始化缓存参数的 JSON 响应 - """ - result_dict = await ParamsService.get_init_cache_service(redis=redis, tenant_id=1) + result_dict = await ParamsService.get_init_cache(redis=redis, tenant_id=1) return SuccessResponse(data=result_dict, msg="获取初始化缓存参数成功") diff --git a/backend/app/api/v1/module_system/params/service.py b/backend/app/api/v1/module_system/params/service.py index 37eb6ef1..23a5bf46 100644 --- a/backend/app/api/v1/module_system/params/service.py +++ b/backend/app/api/v1/module_system/params/service.py @@ -28,61 +28,58 @@ class ParamsService: """ 参数管理服务 - 提供参数 CRUD、Redis 缓存同步、初始化配置、批量启/禁用、Excel 导出等业务能力。 + 设计：实例方法承载「当前用户上下文 (auth)」，``redis`` 仍是方法参数 + （因为不是每个端点都用到）。调用方写法由 + ``ParamsService.method_service(auth=...)`` 改为 ``ParamsService(auth).method(...)``。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> ParamsOutSchema: + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def detail(self, id: int) -> ParamsOutSchema: """ 获取参数详情 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 参数ID 返回: - ParamsOutSchema: 参数响应模型 """ - return await ParamsCRUD(auth).get_or_404(id=id, out_schema=ParamsOutSchema) + return await ParamsCRUD(self.auth).get_or_404(id=id, out_schema=ParamsOutSchema) - @classmethod - async def get_by_key_service(cls, auth: AuthSchema, config_key: str) -> ParamsOutSchema: + async def get_by_key(self, config_key: str) -> ParamsOutSchema: """ 根据配置键获取参数详情 参数: - - auth (AuthSchema): 认证信息模型 - config_key (str): 参数键名 返回: - ParamsOutSchema: 参数响应模型 """ - obj = await ParamsCRUD(auth).get(config_key=config_key) + obj = await ParamsCRUD(self.auth).get(config_key=config_key) if not obj: raise CustomException(msg="该数据不存在") return ParamsOutSchema.model_validate(obj) - @classmethod - async def get_config_value_by_key_service(cls, auth: AuthSchema, config_key: str) -> str | None: + async def get_config_value_by_key(self, config_key: str) -> str | None: """ 根据配置键获取参数值 参数: - - auth (AuthSchema): 认证信息模型 - config_key (str): 参数键名 返回: - str | None: 参数键值字符串或 None """ - obj = await ParamsCRUD(auth).get(config_key=config_key) + obj = await ParamsCRUD(self.auth).get(config_key=config_key) if not obj: raise CustomException(msg="该数据不存在") return obj.config_value - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: ParamsQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[ParamsOutSchema]: @@ -90,20 +87,17 @@ class ParamsService: 获取配置管理型列表 参数: - - auth (AuthSchema): 认证信息模型 - search (ParamsQueryParam | None): 查询参数对象 - order_by (list[dict] | None): 排序参数列表 返回: - list[ParamsOutSchema]: 参数响应模型列表 """ - obj_list = await ParamsCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + obj_list = await ParamsCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [ParamsOutSchema.model_validate(obj) for obj in obj_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: ParamsQueryParam | None = None, @@ -113,17 +107,16 @@ class ParamsService: 分页查询系统参数（数据库 OFFSET/LIMIT）。 参数: - - auth (AuthSchema): 认证信息模型 - page_no (int): 页码（从 1 开始） - page_size (int): 每页条数 - search (ParamsQueryParam | None): 查询条件 - order_by (list[dict[str, str]] | None): 排序字段列表 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） + - dict: 分页结果（结构由 ``CRUD.page`` 返回约定） """ offset = (page_no - 1) * page_size - return await ParamsCRUD(auth).page( + return await ParamsCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -131,28 +124,26 @@ class ParamsService: out_schema=ParamsOutSchema, ) - @classmethod - async def create_service(cls, auth: AuthSchema, redis: Redis, data: ParamsCreateSchema) -> ParamsOutSchema: + async def create(self, redis: Redis, data: ParamsCreateSchema) -> ParamsOutSchema: """ 创建配置管理型 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis 客户端实例 - data (ParamsCreateSchema): 配置管理型创建模型 返回: - ParamsOutSchema: 新创建的参数响应模型 """ - exist_obj = await ParamsCRUD(auth).get(config_key=data.config_key) + exist_obj = await ParamsCRUD(self.auth).get(config_key=data.config_key) if exist_obj: raise CustomException(msg="创建失败，该数据已存在") - obj = await ParamsCRUD(auth).create(data=data) + obj = await ParamsCRUD(self.auth).create(data=data) out = ParamsOutSchema.model_validate(obj) # 同步redis - redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{auth.user.tenant_id}:{data.config_key}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{self.auth.user.tenant_id}:{data.config_key}" try: redis_payload = out.model_dump(mode="json") value = json.dumps(redis_payload, ensure_ascii=False) @@ -170,13 +161,11 @@ class ParamsService: return out - @classmethod - async def update_service(cls, auth: AuthSchema, redis: Redis, id: int, data: ParamsUpdateSchema) -> ParamsOutSchema: + async def update(self, redis: Redis, id: int, data: ParamsUpdateSchema) -> ParamsOutSchema: """ 更新参数 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis 客户端实例 - id (int): 参数ID - data (ParamsUpdateSchema): 参数更新模型 @@ -184,18 +173,18 @@ class ParamsService: 返回: - ParamsOutSchema: 更新后的参数响应模型 """ - exist_obj = await ParamsCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_obj = await ParamsCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") if exist_obj.config_key != data.config_key: raise CustomException(msg="更新失败，系统配置key不允许修改") - new_obj = await ParamsCRUD(auth).update(id=id, data=data) + new_obj = await ParamsCRUD(self.auth).update(id=id, data=data) if not new_obj: raise CustomException(msg="更新失败，系统配置不存在") out = ParamsOutSchema.model_validate(new_obj) redis_payload = out.model_dump(mode="json") # 同步redis - redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{auth.user.tenant_id}:{new_obj.config_key}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{self.auth.user.tenant_id}:{new_obj.config_key}" try: value = json.dumps(redis_payload, ensure_ascii=False) result = await RedisCURD(redis).set( @@ -212,13 +201,11 @@ class ParamsService: return out - @classmethod - async def delete_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None: + async def delete(self, redis: Redis, ids: list[int]) -> None: """ 删除配置管理型 参数: - - auth (AuthSchema): 认证信息模型 - redis (Redis): Redis 客户端实例 - ids (list[int]): 配置管理型ID列表 @@ -228,7 +215,7 @@ class ParamsService: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") # 批量校验参数存在性 - objs = await ParamsCRUD(auth).list(search={"id": ("in", ids)}) + objs = await ParamsCRUD(self.auth).list(search={"id": ("in", ids)}) obj_map = {o.id: o for o in objs} for pid in ids: obj = obj_map.get(pid) @@ -237,24 +224,22 @@ class ParamsService: if obj.config_type: raise CustomException(msg=f"{obj.config_name} 删除失败，系统初始化配置不可以删除") - await ParamsCRUD(auth).delete(ids=ids) + await ParamsCRUD(self.auth).delete(ids=ids) # 同步删除Redis缓存（使用删除前已获取的对象信息） for obj in objs: - redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{auth.user.tenant_id}:{obj.config_key}" + redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{self.auth.user.tenant_id}:{obj.config_key}" try: await RedisCURD(redis).delete(redis_key) except Exception as e: logger.error(f"删除系统配置失败: {e}") raise CustomException(msg="同步删除缓存失败") from e - @classmethod - async def batch_set_status_service(cls, auth: AuthSchema, ids: list[int], status: str) -> None: + async def batch_set_status(self, ids: list[int], status: str) -> None: """ 批量设置系统参数状态 参数: - - auth (AuthSchema): 认证信息模型 - ids (list[int]): 系统参数ID列表 - status (str): 状态值 @@ -264,12 +249,12 @@ class ParamsService: if not ids: raise CustomException(msg="请选择要操作的数据") - await ParamsCRUD(auth).set(ids=ids, status=status) + await ParamsCRUD(self.auth).set(ids=ids, status=status) - @classmethod - async def export_service(cls, data_list: list[dict]) -> bytes: + @staticmethod + def export(data_list: list[dict]) -> bytes: """ - 导出参数列表 + 导出参数列表（无状态工具方法） 参数: - data_list (list[dict]): 参数字典列表 @@ -298,10 +283,10 @@ class ParamsService: return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict) - @classmethod - async def init_cache_service(cls, redis: Redis) -> None: + @staticmethod + async def init_cache(redis: Redis) -> None: """ - 初始化系统配置并按租户缓存。 + 初始化系统参数并按租户缓存（无 auth）。 参数: - redis (Redis): Redis 客户端实例 @@ -311,8 +296,8 @@ class ParamsService: """ async with async_db_session() as session: async with session.begin(): - auth = AuthSchema(db=session, check_data_scope=False) - config_obj = await ParamsCRUD(auth).list() + init_auth = AuthSchema(db=session, check_data_scope=False) + config_obj = await ParamsCRUD(init_auth).list() if not config_obj: raise CustomException(msg="该数据不存在") try: @@ -334,10 +319,10 @@ class ParamsService: logger.error(f"❌️ 初始化系统配置失败: {e}") raise CustomException(msg="初始化系统配置失败") from e - @classmethod - async def get_init_cache_service(cls, redis: Redis, tenant_id: int = 1) -> list[dict]: + @staticmethod + async def get_init_cache(redis: Redis, tenant_id: int = 1) -> list[dict]: """ - 获取系统配置 + 获取系统配置（无 auth）。 参数: - redis (Redis): Redis 客户端实例 @@ -363,10 +348,8 @@ class ParamsService: if not configs: async with async_db_session() as session: async with session.begin(): - from app.core.base_schema import AuthSchema - - auth = AuthSchema(db=session, check_data_scope=False) - config_obj = await ParamsCRUD(auth).list() + init_auth = AuthSchema(db=session, check_data_scope=False) + config_obj = await ParamsCRUD(init_auth).list() if config_obj: try: for config in config_obj: @@ -388,8 +371,8 @@ class ParamsService: return configs - @classmethod - async def get_system_config_for_middleware(cls, redis: Redis) -> dict: + @staticmethod + async def get_system_config_for_middleware(redis: Redis) -> dict: """ 获取中间件所需的系统配置（带 60 秒内存缓存，避免每请求查 Redis）。 @@ -403,13 +386,13 @@ class ParamsService: if _mid_config_cache["data"] and now - _mid_config_cache["ts"] < _MID_CONFIG_TTL: return _mid_config_cache["data"] - config_result = await cls._fetch_system_config_for_middleware(redis) + config_result = await ParamsService._fetch_system_config_for_middleware(redis) _mid_config_cache["data"] = config_result _mid_config_cache["ts"] = now return config_result - @classmethod - async def _fetch_system_config_for_middleware(cls, redis: Redis) -> dict: + @staticmethod + async def _fetch_system_config_for_middleware(redis: Redis) -> dict: # 定义需要获取的配置键 config_keys = [ f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:1:demo_enable", @@ -433,7 +416,9 @@ class ParamsService: if config_values[0]: try: demo_config = json.loads(config_values[0]) - config_result["demo_enable"] = demo_config.get("config_value", False) if isinstance(demo_config, dict) else False + config_result["demo_enable"] = ( + demo_config.get("config_value", False) if isinstance(demo_config, dict) else False + ) except json.JSONDecodeError: logger.error("解析演示模式配置失败") diff --git a/backend/app/api/v1/module_system/position/controller.py b/backend/app/api/v1/module_system/position/controller.py index 9923dd0a..25735913 100644 --- a/backend/app/api/v1/module_system/position/controller.py +++ b/backend/app/api/v1/module_system/position/controller.py @@ -20,11 +20,10 @@ from .schema import ( ) from .service import PositionService -PositionRouter = APIRouter(route_class=OperationLogRoute, prefix="/position", tags=["岗位管理"]) +PositionRouter = APIRouter(route_class=OperationLogRoute, prefix="/position", tags=["系统管理", "岗位管理"]) _POS_NS = "position" - @PositionRouter.get( "/list", summary="查询岗位", @@ -36,22 +35,10 @@ async def get_obj_list_controller( search: Annotated[PositionQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:query"]))], ) -> JSONResponse: - """ - 查询岗位列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数 - - search (PositionQueryParam): 查询参数 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 分页查询结果 - """ order_by = [{"order": "asc"}] if page.order_by: order_by = page.order_by - result_dict = await PositionService.page_service( - auth=auth, + result_dict = await PositionService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -59,7 +46,6 @@ async def get_obj_list_controller( ) return SuccessResponse(data=result_dict, msg="查询岗位列表成功") - @PositionRouter.get( "/detail/{id}", summary="查询岗位详情", @@ -69,20 +55,9 @@ async def get_obj_detail_controller( id: Annotated[int, Path(description="岗位ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:detail"]))], ) -> JSONResponse: - """ - 查询岗位详情 - - 参数: - - id (int): 岗位ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 岗位详情对象 - """ - result_dict = await PositionService.detail_service(id=id, auth=auth) + result_dict = await PositionService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取岗位详情成功") - @PositionRouter.post( "/create", summary="创建岗位", @@ -92,21 +67,10 @@ async def create_obj_controller( data: PositionCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:create"]))], ) -> JSONResponse: - """ - 创建岗位 - - 参数: - - data (PositionCreateSchema): 创建岗位模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 岗位详情对象 - """ - result_dict = await PositionService.create_service(data=data, auth=auth) + result_dict = await PositionService(auth).create(data=data) await FastAPICache.clear(namespace=_POS_NS) return SuccessResponse(data=result_dict, msg="创建岗位成功") - @PositionRouter.put( "/update/{id}", summary="修改岗位", @@ -117,22 +81,10 @@ async def update_obj_controller( id: Annotated[int, Path(description="岗位ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:update"]))], ) -> JSONResponse: - """ - 修改岗位 - - 参数: - - data (PositionUpdateSchema): 修改岗位模型 - - id (int): 岗位ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 岗位详情对象 - """ - result_dict = await PositionService.update_service(id=id, data=data, auth=auth) + result_dict = await PositionService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_POS_NS) return SuccessResponse(data=result_dict, msg="修改岗位成功") - @PositionRouter.delete( "/delete", summary="删除岗位", @@ -142,21 +94,10 @@ async def delete_obj_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:delete"]))], ) -> JSONResponse: - """ - 删除岗位 - - 参数: - - ids (list[int]): ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 成功消息 - """ - await PositionService.delete_service(ids=ids, auth=auth) + await PositionService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_POS_NS) return SuccessResponse(msg="删除岗位成功") - @PositionRouter.patch( "/status/batch", summary="批量修改岗位状态", @@ -166,21 +107,10 @@ async def batch_set_available_obj_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:patch"]))], ) -> JSONResponse: - """ - 批量修改岗位状态 - - 参数: - - data (BatchSetAvailable): 批量修改岗位状态模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 成功消息 - """ - await PositionService.set_available_service(data=data, auth=auth) + await PositionService(auth).set_available(data=data) await FastAPICache.clear(namespace=_POS_NS) return SuccessResponse(msg="批量修改岗位状态成功") - @PositionRouter.get( "/export", summary="导出岗位", @@ -190,18 +120,8 @@ async def export_obj_list_controller( search: Annotated[PositionQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:position:export"]))], ) -> StreamingResponse: - """ - 导出岗位 - - 参数: - - search (PositionQueryParam): 查询参数 - - auth (AuthSchema): 认证信息模型 - - 返回: - - StreamingResponse: 岗位Excel文件流 - """ - position_query_result = await PositionService.list_service(search=search, auth=auth) - position_export_result = await PositionService.export_list_service(position_list=position_query_result) + position_query_result = await PositionService(auth).list(search=search) + position_export_result = PositionService.export_list(position_list=position_query_result) return StreamResponse( data=bytes2file_response(position_export_result), diff --git a/backend/app/api/v1/module_system/position/service.py b/backend/app/api/v1/module_system/position/service.py index 72d3ec08..3cda1c7e 100644 --- a/backend/app/api/v1/module_system/position/service.py +++ b/backend/app/api/v1/module_system/position/service.py @@ -18,65 +18,29 @@ class PositionService: 提供岗位 CRUD、批量启/禁用、Excel 导出等业务能力。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> PositionOutSchema: - """ - 获取岗位详情 + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 岗位ID + async def detail(self, id: int) -> PositionOutSchema: + return await PositionCRUD(self.auth).get_or_404(id=id, out_schema=PositionOutSchema) - 返回: - - PositionOutSchema: 岗位详情响应模型 - """ - return await PositionCRUD(auth).get_or_404(id=id, out_schema=PositionOutSchema) - - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: PositionQueryParam | None = None, order_by: list[dict] | None = None, ) -> list[PositionOutSchema]: - """ - 获取岗位列表 - - 参数: - - auth (AuthSchema): 认证信息模型 - - search (PositionQueryParam | None): 查询参数对象 - - order_by (list[dict] | None): 排序参数列表 - - 返回: - - list[PositionOutSchema]: 岗位列表 - """ - position_list = await PositionCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + position_list = await PositionCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [PositionOutSchema.model_validate(position) for position in position_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: PositionQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> dict: - """ - 分页查询岗位（数据库 OFFSET/LIMIT）。 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码（从 1 开始） - - page_size (int): 每页条数 - - search (PositionQueryParam | None): 查询条件 - - order_by (list[dict[str, str]] | None): 排序字段列表 - - 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） - """ offset = (page_no - 1) * page_size - return await PositionCRUD(auth).page( + return await PositionCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -84,96 +48,41 @@ class PositionService: out_schema=PositionOutSchema, ) - @classmethod - async def create_service(cls, auth: AuthSchema, data: PositionCreateSchema) -> PositionOutSchema: - """ - 创建岗位 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (PositionCreateSchema): 岗位创建模型 - - 返回: - - PositionOutSchema: 新创建的岗位响应模型 - """ - position = await PositionCRUD(auth).get(name=data.name) + async def create(self, data: PositionCreateSchema) -> PositionOutSchema: + position = await PositionCRUD(self.auth).get(name=data.name) if position: raise CustomException(msg="创建失败，该数据已存在") - new_position = await PositionCRUD(auth).create(data=data) + new_position = await PositionCRUD(self.auth).create(data=data) return PositionOutSchema.model_validate(new_position) - @classmethod - async def update_service(cls, auth: AuthSchema, id: int, data: PositionUpdateSchema) -> PositionOutSchema: - """ - 更新岗位 - - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 岗位ID - - data (PositionUpdateSchema): 岗位更新模型 - - 返回: - - PositionOutSchema: 更新后的岗位响应模型 - """ - _ = await PositionCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") - exist_position = await PositionCRUD(auth).get(name=data.name) + async def update(self, id: int, data: PositionUpdateSchema) -> PositionOutSchema: + _ = await PositionCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_position = await PositionCRUD(self.auth).get(name=data.name) if exist_position and exist_position.id != id: raise CustomException(msg="更新失败，名称已存在") - updated_position = await PositionCRUD(auth).update(id=id, data=data) + updated_position = await PositionCRUD(self.auth).update(id=id, data=data) return PositionOutSchema.model_validate(updated_position) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除岗位 - - 参数: - - auth (AuthSchema): 认证信息模型 - - ids (list[int]): 岗位ID列表 - - 返回: - - None - """ + async def delete(self, ids: list[int]) -> None: if len(ids) < 1: raise CustomException(msg="删除失败，删除对象不能为空") - # 批量校验岗位存在性 - positions = await PositionCRUD(auth).list(search={"id": ("in", ids)}) + positions = await PositionCRUD(self.auth).list(search={"id": ("in", ids)}) position_map = {p.id: p for p in positions} for pid in ids: if pid not in position_map: raise CustomException(msg="删除失败，该数据不存在") - await PositionCRUD(auth).delete(ids=ids) + await PositionCRUD(self.auth).delete(ids=ids) - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: - """ - 设置岗位状态 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (BatchSetAvailable): 批量设置状态模型 - - 返回: - - None - """ - positions = await PositionCRUD(auth).list(search={"id": ("in", data.ids)}) + async def set_available(self, data: BatchSetAvailable) -> None: + positions = await PositionCRUD(self.auth).list(search={"id": ("in", data.ids)}) position_map = {p.id: p for p in positions} for pid in data.ids: if pid not in position_map: raise CustomException(msg="该数据不存在") - await PositionCRUD(auth).set(ids=data.ids, status=data.status) + await PositionCRUD(self.auth).set(ids=data.ids, status=data.status) - @classmethod - async def export_list_service(cls, position_list: list[dict]) -> bytes: - """ - 导出岗位列表 - - 参数: - - position_list (list[dict]): 岗位列表对象 - - 返回: - - bytes: 导出的Excel文件字节流 - """ + @staticmethod + def export_list(position_list: list[dict]) -> bytes: mapping_dict = { "id": "编号", "name": "岗位名称", @@ -185,11 +94,8 @@ class PositionService: "created_id": "创建者ID", "updated_id": "更新者ID", } - - # 复制数据并转换状态 data = position_list.copy() for item in data: item["status"] = "启用" if item.get("status") == 0 else "停用" item["creator"] = item.get("created_by", {}).get("name", "未知") if isinstance(item.get("created_by"), dict) else "未知" - return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict) diff --git a/backend/app/api/v1/module_system/role/controller.py b/backend/app/api/v1/module_system/role/controller.py index 948ceb37..5dc30bfa 100644 --- a/backend/app/api/v1/module_system/role/controller.py +++ b/backend/app/api/v1/module_system/role/controller.py @@ -21,11 +21,10 @@ from .schema import ( ) from .service import RoleService -RoleRouter = APIRouter(route_class=OperationLogRoute, prefix="/role", tags=["角色管理"]) +RoleRouter = APIRouter(route_class=OperationLogRoute, prefix="/role", tags=["系统管理", "角色管理"]) _ROLE_NS = "role" - @RoleRouter.get( "/list", summary="查询角色", @@ -37,22 +36,10 @@ async def get_role_list_controller( search: Annotated[RoleQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:query"]))], ) -> JSONResponse: - """ - 查询角色 - - 参数: - - page (PaginationQueryParam): 分页查询参数模型 - - search (RoleQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 分页查询结果JSON响应 - """ order_by = [{"order": "asc"}] if page.order_by: order_by = page.order_by - result_dict = await RoleService.page_service( - auth=auth, + result_dict = await RoleService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -60,7 +47,6 @@ async def get_role_list_controller( ) return SuccessResponse(data=result_dict, msg="查询角色成功") - @RoleRouter.get( "/detail/{id}", summary="查询角色详情", @@ -70,20 +56,9 @@ async def get_role_detail_controller( id: Annotated[int, Path(description="角色ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:detail"]))], ) -> JSONResponse: - """ - 查询角色详情 - - 参数: - - id (int): 角色ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 角色详情JSON响应 - """ - result_dict = await RoleService.detail_service(id=id, auth=auth) + result_dict = await RoleService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取角色详情成功") - @RoleRouter.post( "/create", summary="创建角色", @@ -93,21 +68,10 @@ async def create_role_controller( data: RoleCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:create"]))], ) -> JSONResponse: - """ - 创建角色 - - 参数: - - data (RoleCreateSchema): 创建角色模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 创建角色JSON响应 - """ - result_dict = await RoleService.create_service(data=data, auth=auth) + result_dict = await RoleService(auth).create(data=data) await FastAPICache.clear(namespace=_ROLE_NS) return SuccessResponse(data=result_dict, msg="创建角色成功") - @RoleRouter.put( "/update/{id}", summary="修改角色", @@ -118,22 +82,10 @@ async def update_role_controller( id: Annotated[int, Path(description="角色ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:update"]))], ) -> JSONResponse: - """ - 修改角色 - - 参数: - - data (RoleUpdateSchema): 修改角色模型 - - id (int): 角色ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 修改角色JSON响应 - """ - result_dict = await RoleService.update_service(id=id, data=data, auth=auth) + result_dict = await RoleService(auth).update(id=id, data=data) await FastAPICache.clear(namespace=_ROLE_NS) return SuccessResponse(data=result_dict, msg="修改角色成功") - @RoleRouter.delete( "/delete", summary="删除角色", @@ -143,21 +95,10 @@ async def delete_role_controller( ids: Annotated[list[int], Body(description="ID列表")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:delete"]))], ) -> JSONResponse: - """ - 删除角色 - - 参数: - - ids (list[int]): ID列表 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 删除角色JSON响应 - """ - await RoleService.delete_service(ids=ids, auth=auth) + await RoleService(auth).delete(ids=ids) await FastAPICache.clear(namespace=_ROLE_NS) return SuccessResponse(msg="删除角色成功") - @RoleRouter.patch( "/status/batch", summary="批量修改角色状态", @@ -167,21 +108,10 @@ async def batch_set_available_role_controller( data: BatchSetAvailable, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:patch"]))], ) -> JSONResponse: - """ - 批量修改角色状态 - - 参数: - - data (BatchSetAvailable): 批量修改角色状态模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 批量修改角色状态JSON响应 - """ - await RoleService.set_available_service(data=data, auth=auth) + await RoleService(auth).set_available(data=data) await FastAPICache.clear(namespace=_ROLE_NS) return SuccessResponse(msg="批量修改角色状态成功") - @RoleRouter.put( "/permission", summary="角色授权", @@ -191,21 +121,10 @@ async def set_role_permission_controller( data: RolePermissionSettingSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:permission"]))], ) -> JSONResponse: - """ - 角色授权 - - 参数: - - data (RolePermissionSettingSchema): 角色授权模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 角色授权JSON响应 - """ - await RoleService.set_permission_service(data=data, auth=auth) + await RoleService(auth).set_permission(data=data) await FastAPICache.clear(namespace=_ROLE_NS) return SuccessResponse(msg="授权角色成功") - @RoleRouter.get( "/export", summary="导出角色", @@ -215,18 +134,8 @@ async def export_role_list_controller( search: Annotated[RoleQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:role:export"]))], ) -> StreamingResponse: - """ - 导出角色 - - 参数: - - search (RoleQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - StreamingResponse: 导出角色流响应 - """ - role_query_result = await RoleService.list_service(search=search, auth=auth) - role_export_result = await RoleService.export_list_service(role_list=role_query_result) + role_query_result = await RoleService(auth).list(search=search) + role_export_result = RoleService.export_list(role_list=role_query_result) return StreamResponse( data=bytes2file_response(role_export_result), diff --git a/backend/app/api/v1/module_system/role/model.py b/backend/app/api/v1/module_system/role/model.py index 039081a3..39fad178 100644 --- a/backend/app/api/v1/module_system/role/model.py +++ b/backend/app/api/v1/module_system/role/model.py @@ -78,7 +78,7 @@ class RoleModel(ModelMixin, TenantMixin, UserMixin): "deleted_by", "tenant_by", ] - __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.USER_ROLE + __permission_strategy__: PermissionFilterStrategy = PermissionFilterStrategy.USER_BINDING name: Mapped[str] = mapped_column(String(64), nullable=False, comment="角色名称") code: Mapped[str] = mapped_column(String(64), nullable=False, comment="角色编码") diff --git a/backend/app/api/v1/module_system/role/service.py b/backend/app/api/v1/module_system/role/service.py index 8c9829e6..34f25db9 100644 --- a/backend/app/api/v1/module_system/role/service.py +++ b/backend/app/api/v1/module_system/role/service.py @@ -22,24 +22,23 @@ class RoleService: 提供角色 CRUD、权限配置、数据权限范围设置、批量启/禁用、Excel 导出等业务能力。 """ - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> RoleOutSchema: + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth + + async def detail(self, id: int) -> RoleOutSchema: """ 获取角色详情 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 角色ID 返回: - RoleOutSchema: 角色详情响应模型 """ - return await RoleCRUD(auth).get_or_404(id=id, out_schema=RoleOutSchema) + return await RoleCRUD(self.auth).get_or_404(id=id, out_schema=RoleOutSchema) - @classmethod - async def list_service( - cls, - auth: AuthSchema, + async def list( + self, search: RoleQueryParam | None = None, order_by: list[dict[str, str]] | None = None, ) -> list[RoleOutSchema]: @@ -47,20 +46,17 @@ class RoleService: 获取角色列表 参数: - - auth (AuthSchema): 认证信息模型 - search (RoleQueryParam | None): 查询参数模型 - order_by (list[dict[str, str]] | None): 排序参数列表 返回: - list[RoleOutSchema]: 角色响应模型列表 """ - role_list = await RoleCRUD(auth).list(search=vars(search) if search else None, order_by=order_by) + role_list = await RoleCRUD(self.auth).list(search=vars(search) if search else None, order_by=order_by) return [RoleOutSchema.model_validate(role) for role in role_list] - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: RoleQueryParam | None = None, @@ -70,17 +66,16 @@ class RoleService: 分页查询角色（数据库 OFFSET/LIMIT）。 参数: - - auth (AuthSchema): 认证信息模型 - page_no (int): 页码（从 1 开始） - page_size (int): 每页条数 - search (RoleQueryParam | None): 查询条件 - order_by (list[dict[str, str]] | None): 排序字段列表 返回: - - dict: 分页结果（结构由 `CRUD.page` 返回约定） + - dict: 分页结果（结构由 ``CRUD.page`` 返回约定） """ offset = (page_no - 1) * page_size - return await RoleCRUD(auth).page( + return await RoleCRUD(self.auth).page( offset=offset, limit=page_size, order_by=order_by or [{"id": "asc"}], @@ -88,61 +83,55 @@ class RoleService: out_schema=RoleOutSchema, ) - @classmethod - async def create_service(cls, auth: AuthSchema, data: RoleCreateSchema) -> RoleOutSchema: + async def create(self, data: RoleCreateSchema) -> RoleOutSchema: """ 创建角色 参数: - - auth (AuthSchema): 认证信息模型 - data (RoleCreateSchema): 创建角色模型 返回: - RoleOutSchema: 新创建的角色响应模型 """ - role = await RoleCRUD(auth).get(name=data.name) + role = await RoleCRUD(self.auth).get(name=data.name) if role: raise CustomException(msg="创建失败，该数据已存在") - obj = await RoleCRUD(auth).get(code=data.code) + obj = await RoleCRUD(self.auth).get(code=data.code) if obj: raise CustomException(msg="创建失败，编码已存在") # 检查租户配额 - await TenantService.check_quota_service(auth, auth.tenant_id, "role") + await TenantService(self.auth).check_quota(self.auth.tenant_id, "role") - new_role = await RoleCRUD(auth).create(data=data) + new_role = await RoleCRUD(self.auth).create(data=data) return RoleOutSchema.model_validate(new_role) - @classmethod - async def update_service(cls, auth: AuthSchema, id: int, data: RoleUpdateSchema) -> RoleOutSchema: + async def update(self, id: int, data: RoleUpdateSchema) -> RoleOutSchema: """ 更新角色 参数: - - auth (AuthSchema): 认证信息模型 - id (int): 角色ID - data (RoleUpdateSchema): 更新角色模型 返回: - RoleOutSchema: 更新后的角色响应模型 """ - _ = await RoleCRUD(auth).get_or_404(id=id, msg="更新失败，该数据不存在") - exist_role = await RoleCRUD(auth).get(name=data.name) + _ = await RoleCRUD(self.auth).get_or_404(id=id, msg="更新失败，该数据不存在") + exist_role = await RoleCRUD(self.auth).get(name=data.name) if exist_role and exist_role.id != id: raise CustomException(msg="更新失败，名称已存在") - exist_code = await RoleCRUD(auth).get(code=data.code) + exist_code = await RoleCRUD(self.auth).get(code=data.code) if exist_code and exist_code.id != id: raise CustomException(msg="更新失败，角色编码已存在") - updated_role = await RoleCRUD(auth).update(id=id, data=data) + updated_role = await RoleCRUD(self.auth).update(id=id, data=data) return RoleOutSchema.model_validate(updated_role) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: + async def delete(self, ids: list[int]) -> None: """ 删除角色 参数: - - auth (AuthSchema): 认证信息模型 - ids (list[int]): 角色ID列表 返回: @@ -152,57 +141,53 @@ class RoleService: raise CustomException(msg="删除失败，删除对象不能为空") # 批量校验角色存在性 - roles = await RoleCRUD(auth).list(search={"id": ("in", ids)}) + roles = await RoleCRUD(self.auth).list(search={"id": ("in", ids)}) if len(roles) != len(ids): raise CustomException(msg="删除失败，部分ID不存在") - await RoleCRUD(auth).delete(ids=ids) + await RoleCRUD(self.auth).delete(ids=ids) - @classmethod - async def set_permission_service(cls, auth: AuthSchema, data: RolePermissionSettingSchema) -> None: + async def set_permission(self, data: RolePermissionSettingSchema) -> None: """ 设置角色权限 参数: - - auth (AuthSchema): 认证信息模型 - data (RolePermissionSettingSchema): 角色权限设置模型 返回: - None """ # 设置角色菜单权限 - await RoleCRUD(auth).set_role_menus_crud(role_ids=data.role_ids, menu_ids=data.menu_ids) + await RoleCRUD(self.auth).set_role_menus_crud(role_ids=data.role_ids, menu_ids=data.menu_ids) # 设置数据权限范围 - await RoleCRUD(auth).set(ids=data.role_ids, data_scope=data.data_scope) + await RoleCRUD(self.auth).set(ids=data.role_ids, data_scope=data.data_scope) # 设置自定义数据权限部门 if data.data_scope == 5 and data.dept_ids: - await RoleCRUD(auth).set_role_depts_crud(role_ids=data.role_ids, dept_ids=data.dept_ids) + await RoleCRUD(self.auth).set_role_depts_crud(role_ids=data.role_ids, dept_ids=data.dept_ids) else: - await RoleCRUD(auth).set_role_depts_crud(role_ids=data.role_ids, dept_ids=[]) + await RoleCRUD(self.auth).set_role_depts_crud(role_ids=data.role_ids, dept_ids=[]) - @classmethod - async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None: + async def set_available(self, data: BatchSetAvailable) -> None: """ 设置角色可用状态 参数: - - auth (AuthSchema): 认证信息模型 - data (BatchSetAvailable): 批量设置可用状态模型 返回: - None """ - roles = await RoleCRUD(auth).list(search={"id": ("in", data.ids)}) + roles = await RoleCRUD(self.auth).list(search={"id": ("in", data.ids)}) role_map = {r.id: r for r in roles} for rid in data.ids: if rid not in role_map: raise CustomException(msg="该数据不存在") - await RoleCRUD(auth).set(ids=data.ids, status=data.status) + await RoleCRUD(self.auth).set(ids=data.ids, status=data.status) - @classmethod - async def export_list_service(cls, role_list: list[dict[str, Any]]) -> bytes: + @staticmethod + def export_list(role_list: list[dict[str, Any]]) -> bytes: """ 导出角色列表 diff --git a/backend/app/api/v1/module_system/ticket/controller.py b/backend/app/api/v1/module_system/ticket/controller.py index a029300e..da1f734b 100644 --- a/backend/app/api/v1/module_system/ticket/controller.py +++ b/backend/app/api/v1/module_system/ticket/controller.py @@ -1,6 +1,6 @@ from typing import Annotated -from fastapi import APIRouter, Body, Depends, Path +from fastapi import APIRouter, Depends from fastapi.responses import JSONResponse from app.common.response import ResponseSchema, SuccessResponse @@ -18,28 +18,15 @@ from .schema import ( ) from .service import TicketService -TicketRouter = APIRouter(route_class=OperationLogRoute, prefix="/ticket", tags=["工单管理"]) - +TicketRouter = APIRouter(route_class=OperationLogRoute, prefix="/ticket", tags=["系统管理", "工单管理"]) @TicketRouter.get("/list", summary="工单列表", response_model=ResponseSchema[PageResultSchema[TicketOutSchema]]) async def ticket_list_controller( - page: Annotated[PaginationQueryParam, Depends()], search: Annotated[TicketQueryParam, Depends()], - auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:query"]))], + page: Annotated[PaginationQueryParam, Depends()], + auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:list"]))], ) -> JSONResponse: - """ - 工单列表 - - 参数: - - page (PaginationQueryParam): 分页查询参数。 - - search (TicketQueryParam): 查询筛选参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含分页工单列表的 JSON 响应。 - """ - result = await TicketService.page_service( - auth=auth, + result = await TicketService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -47,99 +34,43 @@ async def ticket_list_controller( ) return SuccessResponse(data=result, msg="查询成功") - -@TicketRouter.get("/detail/{id}", summary="工单详情", response_model=ResponseSchema[TicketOutSchema]) +@TicketRouter.get("/detail/{id}", summary="获取工单详情", response_model=ResponseSchema[TicketOutSchema]) async def ticket_detail_controller( - id: Annotated[int, Path(description="ID")], - auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:query"]))], + id: int, + auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:detail"]))], ) -> JSONResponse: - """ - 工单详情 - - 参数: - - id (int): 工单 ID。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含工单详情的 JSON 响应。 - """ - result = await TicketService.detail_service(auth=auth, id=id) + result = await TicketService(auth).detail(id=id) return SuccessResponse(data=result, msg="查询成功") - @TicketRouter.post("/create", summary="创建工单", response_model=ResponseSchema[TicketOutSchema]) async def ticket_create_controller( data: TicketCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:create"]))], ) -> JSONResponse: - """ - 创建工单 - - 参数: - - data (TicketCreateSchema): 工单创建参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含创建后的工单详情的 JSON 响应。 - """ - result = await TicketService.create_service(auth=auth, data=data) + result = await TicketService(auth).create(data=data) return SuccessResponse(data=result, msg="创建成功") - @TicketRouter.put("/update/{id}", summary="更新工单", response_model=ResponseSchema[TicketOutSchema]) async def ticket_update_controller( - id: Annotated[int, Path(description="ID")], + id: int, data: TicketUpdateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:update"]))], ) -> JSONResponse: - """ - 更新工单 - - 参数: - - id (int): 工单 ID。 - - data (TicketUpdateSchema): 工单更新参数。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 包含更新后的工单详情的 JSON 响应。 - """ - result = await TicketService.update_service(auth=auth, id=id, data=data) + result = await TicketService(auth).update(id=id, data=data) return SuccessResponse(data=result, msg="更新成功") - @TicketRouter.put("/batch", summary="批量更新工单", response_model=ResponseSchema) async def ticket_batch_update_controller( data: TicketBatchSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:update"]))], ) -> JSONResponse: - """ - 批量更新工单 - - 参数: - - data (TicketBatchSchema): 批量更新参数（ID 列表 + 状态）。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 操作结果。 - """ - await TicketService.batch_service(auth=auth, data=data) - return SuccessResponse(msg="批量更新成功") - + await TicketService(auth).batch(data=data) + return SuccessResponse(msg="批量操作成功") @TicketRouter.delete("/delete", summary="删除工单", response_model=ResponseSchema[None]) async def ticket_delete_controller( - ids: Annotated[list[int], Body()], + ids: list[int], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:ticket:delete"]))], ) -> JSONResponse: - """ - 删除工单 - - 参数: - - ids (list[int]): 工单 ID 列表。 - - auth (AuthSchema): 认证信息模型。 - - 返回: - - JSONResponse: 删除结果。 - """ - await TicketService.delete_service(auth=auth, ids=ids) + await TicketService(auth).delete(ids=ids) return SuccessResponse(msg="删除成功") diff --git a/backend/app/api/v1/module_system/ticket/service.py b/backend/app/api/v1/module_system/ticket/service.py index 9cad23c2..458c9f8b 100644 --- a/backend/app/api/v1/module_system/ticket/service.py +++ b/backend/app/api/v1/module_system/ticket/service.py @@ -29,30 +29,12 @@ _TICKET_STATUS_LABELS = { class TicketService: - """ - 工单管理服务 + """工单管理服务""" - 提供工单 CRUD、状态流转校验、批量更新、分配处理人等业务能力。 - """ + def __init__(self, auth: AuthSchema) -> None: + self.auth = auth - @classmethod - def _validate_status_transition( - cls, - auth: AuthSchema, - ticket, - new_status: int, - ) -> None: - """ - 校验工单状态流转是否合法 - - 参数: - - auth (AuthSchema): 认证信息模型 - - ticket: 工单对象 - - new_status (int): 新状态 - - 异常: - - CustomException: 状态流转不合法或权限不足 - """ + def _validate_status_transition(self, ticket, new_status: int) -> None: old_status = ticket.status if ticket.status is not None else 0 old_label = _TICKET_STATUS_LABELS.get(old_status, str(old_status)) new_label = _TICKET_STATUS_LABELS.get(new_status, str(new_status)) @@ -60,9 +42,9 @@ class TicketService: if new_status not in _TICKET_STATUS_TRANSITIONS.get(old_status, set()): raise CustomException(msg=f"不允许从{old_label}转换为{new_label}") - is_super = auth.user and auth.user.is_superuser - is_creator = auth.user and ticket.created_id == auth.user.id - is_assignee = auth.user and ticket.assigned_id == auth.user.id + is_super = self.auth.user and self.auth.user.is_superuser + is_creator = self.auth.user and ticket.created_id == self.auth.user.id + is_assignee = self.auth.user and ticket.assigned_id == self.auth.user.id if new_status == 0: if not is_super: @@ -83,29 +65,14 @@ class TicketService: if not (is_super or is_creator): raise CustomException(msg="仅创建人或超管可以确认关闭工单") - @classmethod - async def page_service( - cls, - auth: AuthSchema, + async def page( + self, page_no: int, page_size: int, search: TicketQueryParam | None = None, order_by: list | None = None, ) -> dict: - """ - 分页查询工单 - - 参数: - - auth (AuthSchema): 认证信息模型 - - page_no (int): 页码 - - page_size (int): 每页条数 - - search (TicketQueryParam | None): 查询参数 - - order_by (list | None): 排序参数 - - 返回: - - dict: 分页结果 - """ - return await TicketCRUD(auth).page( + return await TicketCRUD(self.auth).page( offset=(page_no - 1) * page_size, limit=page_size, order_by=order_by or [{"created_time": "desc"}], @@ -113,103 +80,52 @@ class TicketService: out_schema=TicketOutSchema, ) - @classmethod - async def detail_service(cls, auth: AuthSchema, id: int) -> TicketOutSchema: - """ - 获取工单详情 + async def detail(self, id: int) -> TicketOutSchema: + return await TicketCRUD(self.auth).get_or_404(id=id, out_schema=TicketOutSchema) - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 工单ID - - 返回: - - TicketOutSchema: 工单详情响应模型 - """ - return await TicketCRUD(auth).get_or_404(id=id, out_schema=TicketOutSchema) - - @classmethod - async def create_service(cls, auth: AuthSchema, data: TicketCreateSchema) -> TicketOutSchema: - """ - 创建工单 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (TicketCreateSchema): 工单创建数据 - - 返回: - - TicketOutSchema: 创建后的工单响应模型 - """ - obj = await TicketCRUD(auth).create(data=data) + async def create(self, data: TicketCreateSchema) -> TicketOutSchema: + obj = await TicketCRUD(self.auth).create(data=data) if not obj: raise CustomException(msg="创建工单失败") return TicketOutSchema.model_validate(obj) - @classmethod - async def update_service(cls, auth: AuthSchema, id: int, data: TicketUpdateSchema) -> TicketOutSchema: - """ - 更新工单 - - 参数: - - auth (AuthSchema): 认证信息模型 - - id (int): 工单ID - - data (TicketUpdateSchema): 工单更新数据 - - 返回: - - TicketOutSchema: 更新后的工单响应模型 - """ - obj = await TicketCRUD(auth).get_or_404(id=id, msg="工单不存在") + async def update(self, id: int, data: TicketUpdateSchema) -> TicketOutSchema: + obj = await TicketCRUD(self.auth).get_or_404(id=id, msg="工单不存在") if data.status is not None: - cls._validate_status_transition(auth, obj, data.status) + self._validate_status_transition(obj, data.status) - # 校验 assigned_id：分配处理人时验证用户是否存在且属于同一租户 if data.assigned_id is not None: user_stmt = select(UserModel).where( UserModel.id == data.assigned_id, UserModel.is_deleted.is_(False), ) - user_result = await auth.db.execute(user_stmt) + user_result = await self.auth.db.execute(user_stmt) assigned_user = user_result.scalar_one_or_none() if not assigned_user: raise CustomException(msg="指定的处理人不存在") if assigned_user.tenant_id != obj.tenant_id: raise CustomException(msg="处理人必须与工单属于同一租户") - updated = await TicketCRUD(auth).update(id=id, data=data) + updated = await TicketCRUD(self.auth).update(id=id, data=data) if not updated: raise CustomException(msg="工单不存在") return TicketOutSchema.model_validate(updated) - @classmethod - async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None: - """ - 删除工单 - - 参数: - - auth (AuthSchema): 认证信息模型 - - ids (list[int]): 工单ID列表 - """ + async def delete(self, ids: list[int]) -> None: if not ids: raise CustomException(msg="删除对象不能为空") - await TicketCRUD(auth).delete(ids=ids) + await TicketCRUD(self.auth).delete(ids=ids) - @classmethod - async def batch_service(cls, auth: AuthSchema, data: TicketBatchSchema) -> None: - """ - 批量更新工单状态 - - 参数: - - auth (AuthSchema): 认证信息模型 - - data (TicketBatchSchema): 批量更新参数 - """ + async def batch(self, data: TicketBatchSchema) -> None: if not data.ids: raise CustomException(msg="请选择要操作的工单") - tickets = await TicketCRUD(auth).get_by_ids_crud(ids=data.ids) + tickets = await TicketCRUD(self.auth).get_by_ids_crud(ids=data.ids) ticket_map = {t.id: t for t in tickets} for tid in data.ids: obj = ticket_map.get(tid) if not obj: raise CustomException(msg=f"工单[{tid}]不存在") - cls._validate_status_transition(auth, obj, data.status) - await TicketCRUD(auth).set_crud(ids=data.ids, status=data.status) + self._validate_status_transition(obj, data.status) + await TicketCRUD(self.auth).set_crud(ids=data.ids, status=data.status) diff --git a/backend/app/api/v1/module_system/user/controller.py b/backend/app/api/v1/module_system/user/controller.py index 74ad3307..20e3f129 100644 --- a/backend/app/api/v1/module_system/user/controller.py +++ b/backend/app/api/v1/module_system/user/controller.py @@ -26,8 +26,7 @@ from .schema import ( ) from .service import UserService -UserRouter = APIRouter(route_class=OperationLogRoute, prefix="/user", tags=["用户管理"]) - +UserRouter = APIRouter(route_class=OperationLogRoute, prefix="/user", tags=["系统管理", "用户管理"]) @UserRouter.get( "/current/info", @@ -37,19 +36,9 @@ UserRouter = APIRouter(route_class=OperationLogRoute, prefix="/user", tags=["用 async def get_current_user_info_controller( auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 查询当前用户信息 - - 参数: - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 当前用户信息JSON响应 - """ - user_dict = await UserService.current_info_service(auth=auth) + user_dict = await UserService(auth).current_info() return SuccessResponse(data=user_dict, msg="获取当前用户信息成功") - @UserRouter.put( "/current/info/update", summary="更新当前用户基本信息", @@ -59,20 +48,9 @@ async def update_current_user_info_controller( data: CurrentUserUpdateSchema, auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 更新当前用户基本信息 - - 参数: - - data (CurrentUserUpdateSchema): 当前用户更新模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 更新当前用户基本信息JSON响应 - """ - result_dict = await UserService.update_current_info_service(auth=auth, data=data) + result_dict = await UserService(auth).update_current_info(data=data) return SuccessResponse(data=result_dict, msg="更新当前用户基本信息成功") - @UserRouter.put( "/password/change", summary="修改当前用户密码", @@ -82,20 +60,9 @@ async def change_current_user_password_controller( data: UserChangePasswordSchema, auth: Annotated[AuthSchema, Depends(get_current_user)], ) -> JSONResponse: - """ - 修改当前用户密码 - - 参数: - - data (UserChangePasswordSchema): 用户密码修改模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 修改密码JSON响应 - """ - result_dict = await UserService.change_password_service(auth=auth, data=data) + result_dict = await UserService(auth).change_password(data=data) return SuccessResponse(data=result_dict, msg="修改密码成功, 请重新登录") - @UserRouter.put( "/password/reset/{id}", summary="重置用户密码", @@ -106,22 +73,10 @@ async def reset_password_controller( data: ResetPasswordSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:user:update"]))], ) -> JSONResponse: - """ - 重置密码 - - 参数: - - id (int): 用户ID - - data (ResetPasswordSchema): 重置密码模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 重置密码JSON响应 - """ data.id = id - result_dict = await UserService.reset_password_service(auth=auth, data=data) + result_dict = await UserService(auth).reset_password(data=data) return SuccessResponse(data=result_dict, msg="重置密码成功") - @UserRouter.post( "/register", summary="注册用户", @@ -131,22 +86,11 @@ async def register_user_controller( data: UserRegisterSchema, db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 注册用户 - - 参数: - - data (UserRegisterSchema): 用户注册模型 - - db (AsyncSession): 异步数据库会话 - - 返回: - - JSONResponse: 注册用户JSON响应 - """ - auth = AuthSchema(db=db) - user_register_result = await UserService.register_service(data=data, auth=auth) + auth = AuthSchema(db=db, check_data_scope=False) + user_register_result = await UserService(auth).register(data=data) logger.info(f"{data.username} 注册用户成功: {user_register_result}") return SuccessResponse(data=user_register_result, msg="注册用户成功") - @UserRouter.post( "/password/forget", summary="忘记密码", @@ -156,22 +100,11 @@ async def forget_password_controller( data: UserForgetPasswordSchema, db: Annotated[AsyncSession, Depends(db_getter)], ) -> JSONResponse: - """ - 忘记密码 - - 参数: - - data (UserForgetPasswordSchema): 用户忘记密码模型 - - db (AsyncSession): 异步数据库会话 - - 返回: - - JSONResponse: 忘记密码JSON响应 - """ - auth = AuthSchema(db=db) - user_forget_password_result = await UserService.forget_password_service(data=data, auth=auth) + auth = AuthSchema(db=db, check_data_scope=False) + user_forget_password_result = await UserService(auth).forget_password(data=data) logger.info(f"{data.username} 重置密码成功: {user_forget_password_result}") return SuccessResponse(data=user_forget_password_result, msg="重置密码成功") - @UserRouter.get( "/list", summary="查询用户", @@ -182,19 +115,7 @@ async def get_user_list_controller( search: Annotated[UserQueryParam, Depends()], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:user:query"]))], ) -> JSONResponse: - """ - 查询用户 - - 参数: - - page (PaginationQueryParam): 分页查询参数模型 - - search (UserQueryParam): 查询参数模型 - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 分页查询结果JSON响应 - """ - result_dict = await UserService.page_service( - auth=auth, + result_dict = await UserService(auth).page( page_no=page.page_no, page_size=page.page_size, search=search, @@ -202,7 +123,6 @@ async def get_user_list_controller( ) return SuccessResponse(data=result_dict, msg="查询用户成功") - @UserRouter.get( "/detail/{id}", summary="查询用户详情", @@ -212,20 +132,9 @@ async def get_user_detail_controller( id: Annotated[int, Path(description="用户ID")], auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:user:detail"]))], ) -> JSONResponse: - """ - 查询用户详情 - - 参数: - - id (int): 用户ID - - auth (AuthSchema): 认证信息模型 - - 返回: - - JSONResponse: 用户详情JSON响应 - """ - result_dict = await UserService.detail_service(auth=auth, id=id) + result_dict = await UserService(auth).detail(id=id) return SuccessResponse(data=result_dict, msg="获取用户详情成功") - @UserRouter.post( "/create", summary="创建用户", @@ -235,24 +144,9 @@ async def create_user_controller( data: UserCreateSchema, auth: Annotated[AuthSchema, Depends(AuthPermission(["module_system:user:create"]))], ) -> JSONResponse: - """ - 创建用户 - - **注意**: - - 创建用户时, 默认密码为:{{ username }}，您好！
+请点击下方按钮重置密码（{{ expire_minutes }} 分钟内有效）：
+ 重置密码 +如果按钮无法点击，请复制以下链接到浏览器打开：
+ +如果非您本人操作，请忽略此邮件。
+{{ username }}，您好！
+您的租户已成功创建，试用期至 {{ trial_end }}。
+请登录后台开始使用。
+