refactor: 优化代码注释和文档字符串格式

style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串

backend/templates/python/controller.py.j2

@@ -1,113 +1,125 @@
 # -*- coding:utf-8 -*-
 
-from fastapi import APIRouter, Depends, UploadFile
+from fastapi import APIRouter, Depends, UploadFile, Body, Path
 from fastapi.responses import StreamingResponse, JSONResponse
 from app.common.response import SuccessResponse, StreamResponse
 from app.core.dependencies import AuthPermission
 from app.core.router_class import OperationLogRoute
 from app.api.v1.module_system.auth.schema import AuthSchema
-from app.api.v1.module_system.user.schema import UserOutSchema
 from app.common.request import PaginationService
 from app.core.base_params import PaginationQueryParam
 from app.utils.common_util import bytes2file_response
+from app.core.logger import logger
+from app.core.base_schema import BatchSetAvailable
 
-from {{ package_name }}.service.{{ table_name }}_service import {{ table_name|snake_to_pascal_case }}Service
-from {{ package_name }}.schema import {{ table_name|snake_to_pascal_case }}CreateSchema, {{ table_name|snake_to_pascal_case }}UpdateSchema
-from {{ package_name }}.param import {{ table_name|snake_to_pascal_case }}QueryParam
+from .service import {{ table_name|snake_to_pascal_case }}Service
+from .schema import {{ table_name|snake_to_pascal_case }}CreateSchema, {{ table_name|snake_to_pascal_case }}UpdateSchema
+from .param import {{ table_name|snake_to_pascal_case }}QueryParam
 
-{{ table_name }}Controller = APIRouter(route_class=OperationLogRoute, prefix='/{{ module_name }}/{{ business_name }}', tags=["{{ function_name }}模块"])
+{{ table_name|snake_to_pascal_case }}Router = APIRouter(route_class=OperationLogRoute, prefix='/{{ module_name }}/{{ business_name }}', tags=["{{ function_name }}模块"]) 
 
+@{{ table_name|snake_to_pascal_case }}Router.get("/detail/{id}", summary="获取{{ function_name }}详情", description="获取{{ function_name }}详情")
+async def get_obj_detail_controller(
+    id: int = Path(..., description="ID"),
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:query"]))
+) -> JSONResponse:
+    """获取{{ function_name }}详情接口"""
+    result_dict = await {{ table_name|snake_to_pascal_case }}Service.detail_service(auth=auth, id=id)
+    logger.info(f"获取{{ function_name }}详情成功 {id}")
+    return SuccessResponse(data=result_dict, msg="获取{{ function_name }}详情成功")
 
-@{{ table_name }}Controller.get('/list', summary="查询{{ function_name }}列表", description="查询{{ function_name }}列表")
-async def get_{{ table_name }}_list(
-        page: PaginationQueryParam = Depends(),
-        search: {{ table_name|snake_to_pascal_case }}QueryParam = Depends(),
-        auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:list"]))
-):
-    {{ table_name }}_result_list = await {{ table_name|snake_to_pascal_case }}Service.get_{{ table_name }}_list_service(auth, search, page.order_by)
-    {{ table_name }}_result = await PaginationService.paginate(
-        data_list={{ table_name }}_result_list, 
-        page_no=page.page_no, 
-        page_size=page.page_size
-    )
-    return SuccessResponse(data={{ table_name }}_result)
+@{{ table_name|snake_to_pascal_case }}Router.get("/list", summary="查询{{ function_name }}列表", description="查询{{ function_name }}列表")
+async def get_obj_list_controller(
+    page: PaginationQueryParam = Depends(),
+    search: {{ table_name|snake_to_pascal_case }}QueryParam = Depends(),
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:query"]))
+) -> JSONResponse:
+    """查询{{ function_name }}列表接口"""
+    result_dict_list = await {{ table_name|snake_to_pascal_case }}Service.list_service(auth=auth, search=search, order_by=page.order_by)
+    result_dict = await PaginationService.paginate(data_list=result_dict_list, page_no=page.page_no, page_size=page.page_size)
+    logger.info("查询{{ function_name }}列表成功")
+    return SuccessResponse(data=result_dict, msg="查询{{ function_name }}列表成功")
 
+@{{ table_name|snake_to_pascal_case }}Router.post("/create", summary="创建{{ function_name }}", description="创建{{ function_name }}")
+async def create_obj_controller(
+    data: {{ table_name|snake_to_pascal_case }}CreateSchema,
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:create"]))
+) -> JSONResponse:
+    """创建{{ function_name }}接口"""
+    result_dict = await {{ table_name|snake_to_pascal_case }}Service.create_service(auth=auth, data=data)
+    logger.info("创建{{ function_name }}成功")
+    return SuccessResponse(data=result_dict, msg="创建{{ function_name }}成功")
 
-@{{ table_name }}Controller.get('/{id}', summary="获取{{ function_name }}详细信息", description="获取{{ function_name }}详细信息")
-async def get_{{ table_name }}_by_id(
-        id: int,
-        auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:query"]))
-):
-    {{ table_name }} = await {{ table_name|snake_to_pascal_case }}Service.get_{{ table_name }}_by_id_service(auth, id)
-    return SuccessResponse(data={{ table_name }})
+@{{ table_name|snake_to_pascal_case }}Router.put("/update/{id}", summary="修改{{ function_name }}", description="修改{{ function_name }}")
+async def update_obj_controller(
+    data: {{ table_name|snake_to_pascal_case }}UpdateSchema,
+    id: int = Path(..., description="ID"),
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:update"]))
+) -> JSONResponse:
+    """修改{{ function_name }}接口"""
+    result_dict = await {{ table_name|snake_to_pascal_case }}Service.update_service(auth=auth, id=id, data=data)
+    logger.info("修改{{ function_name }}成功")
+    return SuccessResponse(data=result_dict, msg="修改{{ function_name }}成功")
 
+@{{ table_name|snake_to_pascal_case }}Router.delete("/delete", summary="删除{{ function_name }}", description="删除{{ function_name }}")
+async def delete_obj_controller(
+    ids: list[int] = Body(..., description="ID列表"),
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:delete"]))
+) -> JSONResponse:
+    """删除{{ function_name }}接口"""
+    await {{ table_name|snake_to_pascal_case }}Service.delete_service(auth=auth, ids=ids)
+    logger.info(f"删除{{ function_name }}成功: {ids}")
+    return SuccessResponse(msg="删除{{ function_name }}成功")
 
-@{{ table_name }}Controller.post('', summary="新增{{ function_name }}", description="新增{{ function_name }}")
-async def add_{{ table_name }} (
-    add_model: {{ table_name|snake_to_pascal_case }}CreateSchema,
-    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:add"])),
-    current_user: UserOutSchema = Depends(lambda auth: auth.user)
-):
-    add_result = await {{ table_name|snake_to_pascal_case }}Service.add_{{ table_name }}_service(auth, add_model)
-    return SuccessResponse(msg="新增成功")
+@{{ table_name|snake_to_pascal_case }}Router.patch("/available/setting", summary="批量修改{{ function_name }}状态", description="批量修改{{ function_name }}状态")
+async def batch_set_available_obj_controller(
+    data: BatchSetAvailable,
+    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:patch"]))
+) -> JSONResponse:
+    """批量修改{{ function_name }}状态接口"""
+    await {{ table_name|snake_to_pascal_case }}Service.set_available_service(auth=auth, data=data)
+    logger.info(f"批量修改{{ function_name }}状态成功: {data.ids}")
+    return SuccessResponse(msg="批量修改{{ function_name }}状态成功")
 
-
-@{{ table_name }}Controller.put('/{id}', summary="修改{{ function_name }}", description="修改{{ function_name }}")
-async def update_{{ table_name }}(
-    id: int,
-    edit_model: {{ table_name|snake_to_pascal_case }}UpdateSchema,
-    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:edit"])),
-    current_user: UserOutSchema = Depends(lambda auth: auth.user)
-):
-    update_result = await {{ table_name|snake_to_pascal_case }}Service.update_{{ table_name }}_service(auth, id, edit_model)
-    return SuccessResponse(msg="修改成功")
-
-
-@{{ table_name }}Controller.delete('/{ids}', summary="删除{{ function_name }}", description="删除{{ function_name }}")
-async def del_{{ table_name }}(
-    ids: str,
-    auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:remove"]))
-):
-    id_list = [int(id) for id in ids.split(',')]
-    del_result = await {{ table_name|snake_to_pascal_case }}Service.del_{{ table_name }}_service(auth, id_list)
-    return SuccessResponse(msg="删除成功")
-
-
-@{{ table_name }}Controller.post('/export', summary="导出{{ function_name }}", description="导出{{ function_name }}")
-async def export_{{ table_name }}(
+@{{ table_name|snake_to_pascal_case }}Router.post('/export', summary="导出{{ function_name }}", description="导出{{ function_name }}")
+async def export_obj_list_controller(
     search: {{ table_name|snake_to_pascal_case }}QueryParam = Depends(),
     auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:export"]))
 ) -> StreamingResponse:
-    # 获取全量数据
-    {{ table_name }}_list = await {{ table_name|snake_to_pascal_case }}Service.get_{{ table_name }}_list_service(auth=auth, search=search)
-    export_result = await {{ table_name|snake_to_pascal_case }}Service.export_{{ table_name }}_list_service({{ table_name }}_list)
+    """导出{{ function_name }}接口"""
+    result_dict_list = await {{ table_name|snake_to_pascal_case }}Service.list_service(search=search, auth=auth)
+    export_result = await {{ table_name|snake_to_pascal_case }}Service.batch_export_service(obj_list=result_dict_list)
+    logger.info('导出{{ function_name }}成功')
+
     return StreamResponse(
         data=bytes2file_response(export_result),
         media_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-        headers = {
+        headers={
             'Content-Disposition': 'attachment; filename={{ table_name }}.xlsx'
         }
     )
 
-
-@{{ table_name }}Controller.post('/import', summary="导入{{ function_name }}", description="导入{{ function_name }}")
-async def import_{{ table_name }}(
+@{{ table_name|snake_to_pascal_case }}Router.post('/import', summary="导入{{ function_name }}", description="导入{{ function_name }}")
+async def import_obj_list_controller(
     file: UploadFile,
     auth: AuthSchema = Depends(AuthPermission(["{{ permission_prefix }}:import"]))
 ) -> JSONResponse:
-    batch_import_result = await {{ table_name|snake_to_pascal_case }}Service.import_{{ table_name }}_service(file=file, auth=auth, update_support=True)
-    return SuccessResponse(data=batch_import_result, msg="导入成功")
+    """导入{{ function_name }}接口"""
+    batch_import_result = await {{ table_name|snake_to_pascal_case }}Service.batch_import_service(file=file, auth=auth, update_support=True)
+    logger.info("导入{{ function_name }}成功")
+    
+    return SuccessResponse(data=batch_import_result, msg="导入{{ function_name }}成功")
 
+@{{ table_name|snake_to_pascal_case }}Router.post('/download/template', summary="获取{{ function_name }}导入模板", description="获取{{ function_name }}导入模板", dependencies=[Depends(AuthPermission(["{{ permission_prefix }}:download"]))])
+async def export_obj_template_controller() -> StreamingResponse:
+    """获取{{ function_name }}导入模板接口"""
+    example_import_template_result = await {{ table_name|snake_to_pascal_case }}Service.import_template_download_service()
+    logger.info('获取{{ function_name }}导入模板成功')
 
-@{{ tableName }}Controller.post('/download/template', summary="获取{{ functionName }}导入模板", description="获取{{ functionName }}导入模板")
-async def export_{{ tableName }}_template(
-    auth: AuthSchema = Depends(AuthPermission(["{{ permissionPrefix }}:import"]))
-) -> StreamingResponse:
-    {{ tableName }}_import_template_result = await {{ tableName|snake_to_pascal_case }}Service.get_import_template_{{ tableName }}_service()
     return StreamResponse(
-        data=bytes2file_response({{ tableName }}_import_template_result),
+        data=bytes2file_response(example_import_template_result),
         media_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-        headers = {
-            'Content-Disposition': f'attachment; filename={{ tableName }}_import_template.xlsx'
+        headers={
+            'Content-Disposition': 'attachment; filename={{ table_name }}_template.xlsx'
         }
     )