384 lines
14 KiB
Smarty
384 lines
14 KiB
Smarty
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
"""
|
||
{{ module_comment }}视图模块模板
|
||
=============================================================
|
||
|
||
该模板用于生成{{ module_comment }}管理功能中使用的所有视图类。
|
||
用于处理{{ module_comment }}信息的HTTP请求，包括分页查询、详情查询、添加、更新、删除、获取列表等操作。
|
||
{{ module_comment }}用于{{ business_description }}。
|
||
每个视图类对应一个特定的API端点，处理相应的业务逻辑。
|
||
|
||
模板变量说明：
|
||
- module_comment: 模块注释，如"文章管理"
|
||
- app_name: 应用名称，如"article"
|
||
- model_class_name: 模型类名，如"Article"
|
||
- permission_prefix: 权限前缀，如"sys:article"
|
||
- route_prefix: 路由前缀，如"article"
|
||
- primary_key: 主键字段名，如"id"
|
||
- filter_fields: 筛选字段列表
|
||
- has_status: 是否包含状态字段
|
||
- business_description: 业务描述
|
||
- filter_fields_comment: 筛选字段注释
|
||
"""
|
||
|
||
from django.utils.decorators import method_decorator
|
||
from django.views import View
|
||
|
||
from application.{{ app_name }} import services
|
||
from config.env import DJANGO_DEMO
|
||
from middleware.login_middleware import check_login
|
||
from middleware.permission_middleware import PermissionRequired
|
||
from utils import R
|
||
from application.operation_log.constants import LogType
|
||
from application.operation_log.decorators import operation_log
|
||
|
||
|
||
# =============================================================
|
||
# 分页查询视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="get")
|
||
class {{ model_class_name }}PageView(PermissionRequired, View):
|
||
"""
|
||
{{ module_comment }}分页数据查询视图
|
||
|
||
处理GET请求，返回{{ module_comment }}列表的分页数据。
|
||
支持按{{ filter_fields_comment }}等条件筛选。
|
||
|
||
URL: /{{ route_prefix }}/page
|
||
请求方法: GET
|
||
权限要求：{{ permission_prefix }}:page
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ("{{ permission_prefix }}:page",)
|
||
|
||
@operation_log(
|
||
title="{{ module_comment }}管理-查询分页列表",
|
||
log_type=LogType.QUERY
|
||
)
|
||
def get(self, request):
|
||
"""
|
||
处理GET请求，返回{{ module_comment }}分页数据
|
||
|
||
Args:
|
||
request: HttpRequest对象，包含分页参数和筛选条件
|
||
- pageNo: 当前页码
|
||
- pageSize: 每页记录数
|
||
{% for filter_field in filter_fields %}
|
||
- {{ filter_field.name }}: {{ filter_field.comment }}（可选，{{ filter_field.filter_type }}）
|
||
{% endfor %}
|
||
|
||
Returns:
|
||
JsonResponse: 包含分页数据的JSON响应
|
||
"""
|
||
result = services.get_{{ app_name }}_page(request)
|
||
return result
|
||
|
||
|
||
# =============================================================
|
||
# 列表查询视图（不分页）
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name='get')
|
||
class {{ model_class_name }}ListView(View):
|
||
"""
|
||
{{ module_comment }}列表获取视图（支持筛选，不分页）
|
||
|
||
处理GET请求，返回所有{{ module_comment }}的列表数据。
|
||
支持按{% for filter_field in filter_fields %}{{ filter_field.comment }}{% if not loop.last %}、{% endif %}{% endfor %}等条件筛选。
|
||
|
||
URL: /{{ route_prefix }}/list
|
||
请求方法: GET
|
||
权限要求：需要登录
|
||
"""
|
||
|
||
def get(self, request):
|
||
"""
|
||
处理GET请求，返回{{ module_comment }}列表
|
||
|
||
Args:
|
||
request: HttpRequest对象
|
||
|
||
Returns:
|
||
JsonResponse: 包含{{ module_comment }}列表的JSON响应
|
||
"""
|
||
result = services.get_{{ app_name }}_list(request)
|
||
return R.ok(data=result)
|
||
|
||
|
||
# =============================================================
|
||
# 详情查询视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="get")
|
||
class {{ model_class_name }}DetailView(PermissionRequired, View):
|
||
"""
|
||
{{ module_comment }}详情查询视图
|
||
|
||
处理GET请求，根据{{ module_comment }}ID返回{{ module_comment }}详细信息。
|
||
|
||
URL: /{{ route_prefix }}/detail/<int:{{ primary_key }}>
|
||
请求方法: GET
|
||
URL参数: {{ primary_key }} - {{ module_comment }}ID
|
||
权限要求：{{ permission_prefix }}:detail
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ("{{ permission_prefix }}:detail",)
|
||
|
||
@operation_log(
|
||
title="{{ module_comment }}管理-查询记录详情",
|
||
log_type=LogType.QUERY
|
||
)
|
||
def get(self, request, {{ primary_key }}):
|
||
"""
|
||
处理GET请求，返回{{ module_comment }}详情
|
||
|
||
Args:
|
||
request: HttpRequest对象
|
||
{{ primary_key }}: int, {{ module_comment }}ID（从URL中获取）
|
||
|
||
Returns:
|
||
JsonResponse: 包含{{ module_comment }}详细信息的JSON响应
|
||
"""
|
||
data = services.get_{{ app_name }}_detail({{ primary_key }})
|
||
return R.ok(data=data)
|
||
|
||
|
||
# =============================================================
|
||
# 添加视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="post")
|
||
class {{ model_class_name }}AddView(PermissionRequired, View):
|
||
"""
|
||
添加{{ module_comment }}视图
|
||
|
||
处理POST请求，创建新的{{ module_comment }}记录。
|
||
|
||
URL: /{{ route_prefix }}/add
|
||
请求方法: POST
|
||
权限要求：{{ permission_prefix }}:add
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ("{{ permission_prefix }}:add",)
|
||
|
||
@operation_log(
|
||
title="{{ module_comment }}管理-添加记录",
|
||
log_type=LogType.ADD
|
||
)
|
||
def post(self, request):
|
||
"""
|
||
处理POST请求，添加新{{ module_comment }}
|
||
|
||
Args:
|
||
request: HttpRequest对象，包含{{ module_comment }}信息的JSON数据
|
||
|
||
Returns:
|
||
JsonResponse: 包含操作结果的JSON响应
|
||
"""
|
||
# 演示环境禁止操作
|
||
if DJANGO_DEMO:
|
||
return R.failed("演示环境，暂无操作权限")
|
||
|
||
result = services.add_{{ app_name }}(request)
|
||
return result
|
||
|
||
|
||
# =============================================================
|
||
# 更新视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="put")
|
||
class {{ model_class_name }}UpdateView(PermissionRequired, View):
|
||
"""
|
||
更新{{ module_comment }}视图
|
||
|
||
处理PUT请求，更新现有{{ module_comment }}信息。
|
||
|
||
URL: /{{ route_prefix }}/update
|
||
请求方法: PUT
|
||
权限要求：{{ permission_prefix }}:update
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ('{{ permission_prefix }}:update',)
|
||
|
||
@operation_log(
|
||
title="{{ module_comment }}管理-更新记录",
|
||
log_type=LogType.UPDATE
|
||
)
|
||
def put(self, request):
|
||
"""
|
||
处理PUT请求，更新{{ module_comment }}信息
|
||
|
||
Args:
|
||
request: HttpRequest对象，包含{{ module_comment }}ID和更新信息的JSON数据
|
||
|
||
Returns:
|
||
JsonResponse: 包含操作结果的JSON响应
|
||
"""
|
||
# 演示环境禁止操作
|
||
if DJANGO_DEMO:
|
||
return R.failed("演示环境，暂无操作权限")
|
||
|
||
result = services.update_{{ app_name }}(request)
|
||
return result
|
||
|
||
|
||
# =============================================================
|
||
# 删除视图（支持批量）
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="delete")
|
||
class {{ model_class_name }}DeleteView(PermissionRequired, View):
|
||
"""
|
||
删除{{ module_comment }}视图
|
||
|
||
处理DELETE请求，删除指定{{ module_comment }}（支持批量删除）。
|
||
|
||
URL: /{{ route_prefix }}/delete/<str:{{ primary_key }}>
|
||
请求方法: DELETE
|
||
URL参数: {{ primary_key }} - {{ module_comment }}ID字符串，多个ID用逗号分隔
|
||
权限要求：{{ permission_prefix }}:delete
|
||
|
||
注意: 删除{{ module_comment }}前请确认是否被其他数据关联
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ('{{ permission_prefix }}:delete',)
|
||
|
||
@operation_log(
|
||
title="{{ module_comment }}管理-删除记录",
|
||
log_type=LogType.DELETE
|
||
)
|
||
def delete(self, request, {{ primary_key }}):
|
||
"""
|
||
处理DELETE请求，删除{{ module_comment }}
|
||
|
||
Args:
|
||
request: HttpRequest对象
|
||
{{ primary_key }}: str, {{ module_comment }}ID字符串，多个ID用逗号分隔（从URL中获取）
|
||
例如: "1" 或 "1,2,3"
|
||
|
||
Returns:
|
||
JsonResponse: 包含操作结果的JSON响应
|
||
"""
|
||
# 演示环境禁止操作
|
||
if DJANGO_DEMO:
|
||
return R.failed("演示环境，暂无操作权限")
|
||
|
||
result = services.delete_{{ app_name }}s({{ primary_key }})
|
||
return result
|
||
|
||
|
||
{% if has_status %}
|
||
# =============================================================
|
||
# 状态更新视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name="put")
|
||
class {{ model_class_name }}StatusView(PermissionRequired, View):
|
||
"""
|
||
设置{{ module_comment }}状态视图
|
||
|
||
处理PUT请求，更新{{ module_comment }}的启用/禁用状态。
|
||
|
||
URL: /{{ route_prefix }}/status
|
||
请求方法: PUT
|
||
权限要求：{{ permission_prefix }}:status
|
||
"""
|
||
|
||
# 方法权限标识
|
||
permission_required = ('{{ permission_prefix }}:status',)
|
||
|
||
def put(self, request):
|
||
"""
|
||
处理PUT请求，更新{{ module_comment }}状态
|
||
|
||
Args:
|
||
request: HttpRequest对象，包含{{ module_comment }}ID和状态值的JSON数据
|
||
|
||
Returns:
|
||
JsonResponse: 包含操作结果的JSON响应
|
||
"""
|
||
# 演示环境禁止操作
|
||
if DJANGO_DEMO:
|
||
return R.failed("演示环境，暂无操作权限")
|
||
|
||
result = services.update_{{ app_name }}_status(request)
|
||
return result
|
||
{% endif %}
|
||
|
||
|
||
# =============================================================
|
||
# 数据下拉列表视图
|
||
# =============================================================
|
||
|
||
@method_decorator(check_login, name='get')
|
||
class {{ model_class_name }}DataView(View):
|
||
"""
|
||
{{ module_comment }}列表获取视图
|
||
|
||
处理GET请求，返回所有启用{{ module_comment }}的列表数据。
|
||
通常用于前端下拉选择框等场景。
|
||
|
||
URL: /{{ route_prefix }}/data
|
||
请求方法: GET
|
||
权限要求：需要登录
|
||
"""
|
||
|
||
def get(self, request):
|
||
"""
|
||
处理GET请求，返回{{ module_comment }}列表
|
||
|
||
Args:
|
||
request: HttpRequest对象
|
||
|
||
Returns:
|
||
JsonResponse: 包含{{ module_comment }}列表的JSON响应
|
||
"""
|
||
result = services.get_{{ app_name }}_data()
|
||
return R.ok(data=result) |