签入版本

This commit is contained in:
2026-09-12 11:46:38 +08:00
commit c5a9d20cb8
932 changed files with 116861 additions and 0 deletions
View File
+3
View File
@@ -0,0 +1,3 @@
from django.contrib import admin
# Register your models here.
+57
View File
@@ -0,0 +1,57 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
菜单管理应用配置模块
=============================================================
该模块定义了菜单管理应用的配置类,用于Django应用注册和初始化。
"""
from django.apps import AppConfig
class MenuConfig(AppConfig):
"""菜单管理应用配置类"""
# 指定该应用在项目中的Python导入路径
# 格式为 '应用所在模块.应用名称'
name = 'application.menu'
+306
View File
@@ -0,0 +1,306 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
菜单表单验证模块
=============================================================
该模块定义了菜单管理功能中使用的表单验证类。
用于对前端提交的菜单数据进行验证,确保数据符合业务规则和数据库约束。
菜单用于构建前端导航菜单和权限控制节点。
"""
from django import forms
from application.menu import models
# =============================================================
# 菜单表单验证类
# =============================================================
class MenuForm(forms.ModelForm):
"""
菜单表单验证类
用于创建和更新菜单信息时的表单验证。
菜单包括导航菜单和权限节点两种类型,支持树形层级结构。
验证字段包括:
- name: 菜单名称
- icon: 菜单图标
- path: 路由地址
- component: 组件路径
- parentId: 上级菜单ID
- target: 打开方式(0-内链, 1-外链)
- permission: 权限节点标识
- type: 菜单类型(0-菜单, 1-节点)
- status: 菜单状态(0-正常, 1-禁用)
- hide: 是否可见(0-可见, 1-不可见)
- note: 备注说明
- sort: 排序值
"""
# ----------------------------------------------------------
# 菜单名称
# ----------------------------------------------------------
# 字段说明: 菜单的显示名称
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度100字符
# 业务说明: 如"用户管理"、"系统设置"
name = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '菜单名称不能为空',
'max_length': '菜单名称长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 菜单图标
# ----------------------------------------------------------
# 字段说明: 菜单的图标样式类或图标地址
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度100字符
# 业务说明: 用于前端导航栏图标的渲染
icon = forms.CharField(
required=False,
max_length=100,
error_messages={
'max_length': '菜单图标长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 上级菜单ID
# ----------------------------------------------------------
# 字段说明: 上级菜单的ID
# 字段类型: 整型(IntegerField)
# 验证规则: 可选填(required=False),最小值为0
# 业务说明: 0表示顶级菜单,用于构建树形结构
parentId = forms.IntegerField(
required=False,
min_value=0,
error_messages={
'min_value': '上级菜单ID不能小于0'
}
)
# ----------------------------------------------------------
# 路由地址
# ----------------------------------------------------------
# 字段说明: 前端路由的URL路径
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
# 业务说明: 如"/system/user"
path = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '路由地址长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 组件路径
# ----------------------------------------------------------
# 字段说明: 前端组件的文件路径
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
# 业务说明: 如"system/user/index"
component = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '组件路径长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 权限节点
# ----------------------------------------------------------
# 字段说明: 权限标识
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度100字符
# 业务说明: 用于后端接口权限控制,如"sys:user:add"
permission = forms.CharField(
required=False,
max_length=100,
error_messages={
'max_length': '权限节点长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 打开方式
# ----------------------------------------------------------
# 字段说明: 菜单链接的打开方式
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-1
# 可选值: 0-内链(当前窗口), 1-外链(新窗口)
target = forms.IntegerField(
required=True,
min_value=0,
max_value=1,
error_messages={
'required': '打开方式不能为空',
'min_value': '打开方式值在0~1之间',
'max_value': '打开方式值在0~1之间',
}
)
# ----------------------------------------------------------
# 菜单类型
# ----------------------------------------------------------
# 字段说明: 区分菜单和权限节点
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-1
# 可选值: 0-菜单(显示在导航栏), 1-节点(按钮/权限)
type = forms.IntegerField(
required=True,
min_value=0,
max_value=1,
error_messages={
'required': '菜单类型不能为空',
'min_value': '菜单类型值在0~1之间',
'max_value': '菜单类型值在0~1之间',
}
)
# ----------------------------------------------------------
# 菜单状态
# ----------------------------------------------------------
# 字段说明: 菜单的启用/禁用状态
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-1
# 可选值: 0-正常, 1-禁用
status = forms.IntegerField(
required=True,
min_value=0,
max_value=1,
error_messages={
'required': '菜单状态不能为空',
'min_value': '菜单状态值在0~1之间',
'max_value': '菜单状态值在0~1之间',
}
)
# ----------------------------------------------------------
# 是否可见
# ----------------------------------------------------------
# 字段说明: 菜单是否在导航栏显示
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-1
# 可选值: 0-可见, 1-不可见
hide = forms.IntegerField(
required=True,
min_value=0,
max_value=1,
error_messages={
'required': '是否可见不能为空',
'min_value': '是否可见值在0~1之间',
'max_value': '是否可见值在0~1之间',
}
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 菜单的显示顺序
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-99999
# 排序规则: 数字越小越靠前
sort = forms.IntegerField(
required=True,
min_value=0,
max_value=99999,
error_messages={
'required': '菜单排序不能为空',
'min_value': '菜单排序值在0~99999之间',
'max_value': '菜单排序值在0~99999之间',
}
)
# ----------------------------------------------------------
# 备注
# ----------------------------------------------------------
# 字段说明: 菜单的说明信息
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
note = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '菜单备注长度不能大于255个字符'
}
)
# =============================================================
# 表单元数据配置
# =============================================================
class Meta:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 Menu(菜单)
model = models.Menu
# 指定需要验证的字段
fields = [
'name',
'icon',
'path',
'component',
'parentId',
'target',
'permission',
'type',
'status',
'hide',
'note',
'sort'
]
@@ -0,0 +1,44 @@
# Generated by Django 6.0.3 on 2026-09-04 11:44
from django.db import migrations, models
class Migration(migrations.Migration):
initial = True
dependencies = [
]
operations = [
migrations.CreateModel(
name='Menu',
fields=[
('name', models.CharField(db_comment='菜单名称', db_index=True, help_text='菜单名称', max_length=100, verbose_name='菜单名称')),
('icon', models.CharField(db_comment='菜单图标', help_text='菜单图标', max_length=50, null=True, verbose_name='菜单图标')),
('icon2', models.CharField(db_comment='菜单图标', help_text='菜单图标', max_length=50, null=True, verbose_name='菜单图标')),
('parent_id', models.IntegerField(db_comment='上级ID', db_default=0, db_index=True, default=0, help_text='上级ID', verbose_name='上级ID')),
('path', models.CharField(db_comment='菜单路径', help_text='菜单路径', max_length=255, null=True, verbose_name='菜单路径')),
('component', models.CharField(db_comment='菜单组件', help_text='菜单组件', max_length=255, null=True, verbose_name='菜单组件')),
('permission', models.CharField(db_comment='权限节点', help_text='权限节点', max_length=100, null=True, verbose_name='权限节点')),
('target', models.IntegerField(db_comment='打开方式', db_default=0, default=0, help_text='打开方式', verbose_name='打开方式')),
('type', models.IntegerField(db_comment='菜单类型:0-菜单 1-节点', db_default=0, default=0, help_text='菜单类型:0-菜单 1-节点', verbose_name='菜单类型:0-菜单 1-节点')),
('status', models.IntegerField(choices=[(0, '正常'), (1, '禁用')], db_comment='菜单状态:0-正常 1-禁用', db_default=0, default=0, help_text='菜单状态:0-正常 1-禁用', verbose_name='菜单状态:0-正常 1-禁用')),
('hide', models.IntegerField(choices=[(0, '可见'), (1, '不可见')], db_comment='是否可见:0-可见 1-不可见', db_default=1, default=1, help_text='是否可见:0-可见 1-不可见', verbose_name='是否可见:0-可见 1-不可见')),
('sort', models.IntegerField(db_comment='排序', db_default=0, default=0, help_text='排序', verbose_name='排序')),
('note', models.CharField(db_comment='备注', help_text='备注', max_length=255, null=True, verbose_name='备注')),
('id', models.AutoField(auto_created=True, db_comment='主键ID', primary_key=True, serialize=False, verbose_name='主键ID')),
('create_user', models.CharField(db_comment='创建人', db_default=None, default=None, max_length=50, null=True, verbose_name='创建人')),
('create_time', models.DateTimeField(auto_now_add=True, db_comment='创建时间', max_length=11, null=True, verbose_name='创建时间')),
('update_user', models.CharField(db_comment='更新人', db_default=None, default=None, max_length=50, null=True, verbose_name='更新人')),
('update_time', models.DateTimeField(auto_now=True, db_comment='更新时间', max_length=11, null=True, verbose_name='更新时间')),
('is_delete', models.BooleanField(db_comment='逻辑删除:0-正常 1-已删除', db_default=0, default=0, verbose_name='逻辑删除')),
],
options={
'verbose_name': '菜单表',
'verbose_name_plural': '菜单表',
'db_table': 'django_menu',
'db_table_comment': '菜单名称',
},
),
]
+351
View File
@@ -0,0 +1,351 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
菜单模型模块
=============================================================
该模块定义了菜单和权限节点相关的数据库模型。
菜单用于构建前端导航菜单,权限节点用于后端接口权限控制。
"""
from django.db import models
from application.models import BaseModel
from utils.common import get_table_name
# =============================================================
# 菜单模型类
# =============================================================
class Menu(BaseModel):
"""
菜单模型类
用于存储系统的菜单和权限节点信息。
菜单用于构建前端导航菜单,权限节点用于后端接口权限控制。
支持树形层级结构,通过 parent_id 关联上级菜单。
继承自 BaseModel,自动包含:
- id: 主键
- is_delete: 逻辑删除标识
- create_user: 创建人
- create_time: 创建时间
- update_user: 更新人
- update_time: 更新时间
主要业务字段:
- name: 菜单名称,如"用户管理"、"系统设置"
- icon: 菜单图标,用于前端展示
- icon2: 备用菜单图标
- parent_id: 上级菜单ID,用于构建树形结构
- path: 前端路由路径
- component: 前端组件路径
- permission: 权限标识,如"sys:user:list"
- target: 打开方式(0-内部, 1-外部)
- type: 菜单类型(0-菜单, 1-节点)
- status: 菜单状态(0-正常, 1-禁用)
- hide: 是否隐藏(0-可见, 1-不可见)
- sort: 排序值,控制显示顺序
关联关系:
- 自关联:通过 parent_id 关联到自身的上级菜单,形成树形结构
- 与 Role 模型为多对多关系,通过 RoleMenu 中间表关联
"""
# ----------------------------------------------------------
# 菜单名称
# ----------------------------------------------------------
# 字段说明: 菜单的显示名称
# 字段类型: 字符串(CharField)
# 约束: 最大长度100字符
# 索引: 添加了数据库索引(db_index=True)以提升查询效率
# 示例: "用户管理"、"角色管理"、"系统设置"
# 作用: 用于前端导航栏展示
name = models.CharField(
max_length=100,
db_index=True,
verbose_name="菜单名称",
help_text="菜单名称",
db_comment='菜单名称' # 数据库字段注释
)
# ----------------------------------------------------------
# 菜单图标
# ----------------------------------------------------------
# 字段说明: 菜单的图标样式类或图标地址
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度50字符
# 示例: "el-icon-user"、"fa-users"
# 作用: 用于前端导航栏图标的渲染
icon = models.CharField(
null=True,
max_length=50,
verbose_name="菜单图标",
help_text="菜单图标",
db_comment='菜单图标' # 数据库字段注释
)
# ----------------------------------------------------------
# 备用菜单图标
# ----------------------------------------------------------
# 字段说明: 备用菜单图标
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度50字符
# 作用: 用于兼容不同版本的图标库
icon2 = models.CharField(
null=True,
max_length=50,
verbose_name="菜单图标",
help_text="菜单图标",
db_comment='菜单图标' # 数据库字段注释
)
# ----------------------------------------------------------
# 上级ID
# ----------------------------------------------------------
# 字段说明: 上级菜单的ID
# 字段类型: 整数(IntegerField)
# 约束: 默认值为0(表示顶级菜单)
# 索引: 添加了数据库索引(db_index=True)以支持树形结构查询
# 作用: 构建菜单树形结构,实现多层级导航
parent_id = models.IntegerField(
default=0,
db_index=True,
verbose_name="上级ID",
help_text="上级ID",
db_comment='上级ID', # 数据库字段注释
db_default=0
)
# ----------------------------------------------------------
# 菜单路径
# ----------------------------------------------------------
# 字段说明: 前端路由的URL路径
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度255字符
# 示例: "/system/user"、"/system/role"
# 作用: 定义菜单对应的前端路由地址
path = models.CharField(
null=True,
max_length=255,
verbose_name="菜单路径",
help_text="菜单路径",
db_comment='菜单路径' # 数据库字段注释
)
# ----------------------------------------------------------
# 菜单组件
# ----------------------------------------------------------
# 字段说明: 前端组件的文件路径
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度255字符
# 示例: "system/user/index"、"system/role/index"
# 作用: 定义菜单对应的前端组件位置
component = models.CharField(
null=True,
max_length=255,
verbose_name="菜单组件",
help_text="菜单组件",
db_comment='菜单组件' # 数据库字段注释
)
# ----------------------------------------------------------
# 权限节点
# ----------------------------------------------------------
# 字段说明: 权限标识
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度100字符
# 示例: "sys:user:list"、"sys:user:add"
# 作用: 用于后端接口权限控制,当 type=1 时表示具体的操作权限
permission = models.CharField(
null=True,
max_length=100,
verbose_name="权限节点",
help_text="权限节点",
db_comment='权限节点' # 数据库字段注释
)
# ----------------------------------------------------------
# 打开方式
# ----------------------------------------------------------
# 字段说明: 菜单链接的打开方式
# 字段类型: 整数(IntegerField)
# 约束: 默认值为0
# 可选值: 0-内部打开, 1-外部打开
# 作用: 控制菜单链接在内部框架还是新窗口中打开
target = models.IntegerField(
default=0,
verbose_name="打开方式",
help_text="打开方式",
db_comment='打开方式', # 数据库字段注释
db_default=0
)
# ----------------------------------------------------------
# 菜单类型
# ----------------------------------------------------------
# 字段说明: 区分菜单和权限节点
# 字段类型: 整数(IntegerField)
# 约束: 默认值为0
# 可选值: 0-菜单(显示在导航栏), 1-节点(按钮/权限,不显示在菜单树中)
# 作用: 区分导航菜单和权限节点
type = models.IntegerField(
default=0,
verbose_name="菜单类型:0-菜单 1-节点",
help_text="菜单类型:0-菜单 1-节点",
db_comment='菜单类型:0-菜单 1-节点', # 数据库字段注释
db_default=0
)
# ----------------------------------------------------------
# 菜单状态
# ----------------------------------------------------------
# 状态常量定义
STATUS_CHOICES = (
(0, "正常"), # 正常状态:菜单可用
(1, "禁用"), # 禁用状态:菜单不可用
)
# 字段说明: 菜单的启用/禁用状态
# 字段类型: 整数(IntegerField)
# 约束: 使用 STATUS_CHOICES 限制可选值,默认值为0(正常)
# 作用: 控制菜单是否可用,禁用的菜单不显示且无权访问
status = models.IntegerField(
choices=STATUS_CHOICES,
default=0,
verbose_name="菜单状态:0-正常 1-禁用",
help_text="菜单状态:0-正常 1-禁用",
db_comment='菜单状态:0-正常 1-禁用', # 数据库字段注释
db_default=0
)
# ----------------------------------------------------------
# 是否可见
# ----------------------------------------------------------
# 可见性常量定义
HIDE_CHOICES = (
(0, "可见"), # 菜单在导航栏显示
(1, "不可见"), # 菜单在导航栏隐藏
)
# 字段说明: 菜单是否在导航栏显示
# 字段类型: 整数(IntegerField)
# 约束: 使用 HIDE_CHOICES 限制可选值,默认值为1(不可见)
# 作用: 控制菜单是否在导航栏显示,隐藏的菜单不显示但可通过URL访问
hide = models.IntegerField(
choices=HIDE_CHOICES,
default=1,
verbose_name="是否可见:0-可见 1-不可见",
help_text="是否可见:0-可见 1-不可见",
db_comment='是否可见:0-可见 1-不可见', # 数据库字段注释
db_default=1
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 菜单的显示顺序
# 字段类型: 整数(IntegerField)
# 约束: 默认值为0
# 排序规则: 数字越小越靠前
# 作用: 手动控制菜单在导航栏中的显示顺序
sort = models.IntegerField(
default=0,
verbose_name="排序",
help_text="排序",
db_comment='排序', # 数据库字段注释
db_default=0
)
# ----------------------------------------------------------
# 备注
# ----------------------------------------------------------
# 字段说明: 菜单的说明信息
# 字段类型: 字符串(CharField)
# 约束: 允许为空(null=True),最大长度255字符
# 作用: 存储菜单的备注信息,便于管理
note = models.CharField(
null=True,
max_length=255,
verbose_name="备注",
help_text="备注",
db_comment='备注' # 数据库字段注释
)
# =============================================================
# 模型元数据配置
# =============================================================
class Meta:
"""
模型元数据配置类
定义模型在数据库中的表名、显示名称等。
"""
# 数据表名
# 使用配置文件中的表前缀 + "menu",避免与其他应用表名冲突
db_table = get_table_name('menu')
# 数据表注释
db_table_comment = "菜单名称"
# 模型在admin后台显示的友好名称(单数)
verbose_name = "菜单表"
# 模型在admin后台显示的友好名称(复数)
verbose_name_plural = verbose_name
# =============================================================
# 实例方法
# =============================================================
def __str__(self):
"""
模型的字符串表示方法
当需要将模型实例转换为字符串时调用,如admin后台显示、日志输出等。
Returns:
str: 包含菜单ID的字符串
"""
return f"菜单{self.id}"
+535
View File
@@ -0,0 +1,535 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
菜单管理服务模块
=============================================================
该模块实现了菜单管理相关的所有业务逻辑。
包括菜单的列表查询、详情查询、添加、更新、删除等功能,以及用户菜单权限的获取。
菜单用于构建系统的导航结构,支持树形结构展示,包含目录、菜单、按钮三种类型。
命名规范:
- 函数参数使用驼峰命名(如 menuId, userId)
- 表单字段使用下划线命名(如 name, icon, parent_id)- 与数据库字段保持一致
- 返回数据使用驼峰命名(如 parentId, createUser)- 与前端规范保持一致
- 私有函数以下划线开头(如 _build_tree, _get_tree)
功能模块:
1. 菜单维护:菜单的增删改查操作
2. 菜单树构建:将扁平菜单数据转换为树形结构
3. 权限控制:根据用户角色获取可访问的菜单和权限节点
"""
import logging
from typing import Dict, Any, Optional
from django.db import connection
from application.menu import forms
from application.menu.models import Menu
from utils import R, regular
from utils.common import format_datetime, parse_request_body
from utils.security import get_username
# =============================================================
# 列表查询服务
# =============================================================
def get_menu_list(request):
"""
获取菜单列表数据
Args:
request: HttpRequest对象,包含查询参数
- name: 菜单名称(可选,模糊查询)
Returns:
R: 包含菜单列表数据的JSON响应
"""
try:
# 构建基础查询(只查询未删除的记录)
query = Menu.objects.filter(is_delete=False)
# 菜单名称模糊筛选
name = request.GET.get('name')
if name:
query = query.filter(name__contains=name)
# 按排序字段和ID升序排列
menu_list = query.order_by('sort', 'id').all()
# 构建返回数据
result = []
for item in menu_list:
result.append(_menu_to_dict(item))
return R.ok(data=result)
except Exception as e:
logging.error(f"获取菜单列表异常: {str(e)}")
return R.failed(msg="查询失败,请稍后重试")
def _menu_to_dict(menu) -> Dict[str, Any]:
"""
将菜单模型转换为字典(私有辅助函数)
Args:
menu: Menu模型实例
Returns:
Dict: 菜单数据字典
"""
return {
'id': menu.id,
'name': menu.name,
'icon': menu.icon,
'parentId': menu.parent_id,
'path': menu.path,
'component': menu.component,
'permission': menu.permission,
'target': menu.target,
'type': menu.type,
'status': menu.status,
'hide': menu.hide,
'note': menu.note,
'sort': menu.sort,
'createUser': menu.create_user,
'createTime': format_datetime(menu.create_time),
'updateUser': menu.update_user,
'updateTime': format_datetime(menu.update_time),
}
# =============================================================
# 详情查询服务
# =============================================================
def get_menu_detail(menu_id: int) -> Optional[Dict[str, Any]]:
"""
根据ID查询菜单详情
Args:
menu_id: 菜单ID
Returns:
Optional[Dict]: 菜单详情字典,不存在时返回None
"""
try:
# 查询未删除的菜单记录
menu = Menu.objects.filter(id=menu_id, is_delete=False).first()
if not menu:
return None
# 返回详情数据
return {
'id': menu.id,
'name': menu.name,
'icon': menu.icon,
'parentId': menu.parent_id,
'path': menu.path,
'component': menu.component,
'permission': menu.permission,
'target': menu.target,
'type': menu.type,
'status': menu.status,
'hide': menu.hide,
'sort': menu.sort,
'note': menu.note,
'createUser': menu.create_user,
'createTime': format_datetime(menu.create_time),
'updateUser': menu.update_user,
'updateTime': format_datetime(menu.update_time),
}
except Exception as e:
logging.error(f"查询菜单详情异常,ID: {menu_id}, 错误: {str(e)}")
return None
# =============================================================
# 添加服务
# =============================================================
def add_menu(request):
"""
添加菜单
处理流程:
1. 解析请求体中的JSON数据
2. 表单验证
3. 验证上级菜单是否存在
4. 验证路径唯一性
5. 创建数据库记录
Args:
request: HttpRequest对象,包含菜单信息的JSON数据
Returns:
R: 操作结果(成功/失败)
"""
# 解析请求参数
data, error = parse_request_body(request)
if error:
return R.failed(msg=error)
# 表单验证
form = forms.MenuForm(data=data)
if not form.is_valid():
return R.failed(msg=regular.get_err(form))
try:
cleaned_data = form.cleaned_data
# 验证上级菜单是否存在(如果 parentId 不为0)
parent_id = cleaned_data.get('parentId')
if parent_id and parent_id > 0:
parent_exists = Menu.objects.filter(id=parent_id, is_delete=False).exists()
if not parent_exists:
return R.failed("上级菜单不存在")
# 验证路径唯一性(如果是菜单类型)
path = cleaned_data.get('path')
menu_type = cleaned_data.get('type')
if menu_type == 1 and path: # 1 表示菜单类型
if Menu.objects.filter(path=path, is_delete=False).exists():
return R.failed(f"菜单路径 '{path}' 已存在")
# 创建菜单记录
Menu.objects.create(
name=cleaned_data.get('name'),
icon=cleaned_data.get('icon'),
parent_id=parent_id,
path=path,
component=cleaned_data.get('component'),
target=cleaned_data.get('target'),
permission=cleaned_data.get('permission'),
type=menu_type,
status=cleaned_data.get('status'),
hide=cleaned_data.get('hide', False),
sort=cleaned_data.get('sort', 0),
note=cleaned_data.get('note'),
create_user=get_username(request),
update_user=get_username(request)
)
return R.ok(msg="创建成功")
except Exception as e:
logging.error(f"添加菜单异常: {str(e)}")
return R.failed(msg="添加失败,请稍后重试")
# =============================================================
# 更新服务
# =============================================================
def update_menu(request):
"""
更新菜单
处理流程:
1. 解析请求体中的JSON数据
2. 验证菜单ID
3. 表单验证
4. 查询现有记录
5. 验证上级菜单(不能选择自己作为上级)
6. 验证路径唯一性(排除自身)
7. 更新各字段
8. 保存更新
Args:
request: HttpRequest对象,包含菜单ID和更新信息的JSON数据
Returns:
R: 操作结果(成功/失败)
"""
# 解析请求参数
data, error = parse_request_body(request)
if error:
return R.failed(msg=error)
# 验证菜单ID
menu_id = data.get('id')
if not menu_id or not str(menu_id).isdigit() or int(menu_id) <= 0:
return R.failed("菜单ID无效")
menu_id = int(menu_id)
# 表单验证
form = forms.MenuForm(data)
if not form.is_valid():
return R.failed(msg=regular.get_err(form))
try:
cleaned_data = form.cleaned_data
# 查询菜单记录
menu = Menu.objects.filter(id=menu_id, is_delete=False).first()
if not menu:
return R.failed("菜单不存在")
# 验证上级菜单是否存在且不能选择自己作为上级
parent_id = cleaned_data.get('parentId')
if parent_id and parent_id > 0:
if parent_id == menu_id:
return R.failed("不能将自己设为上级菜单")
parent_exists = Menu.objects.filter(id=parent_id, is_delete=False).exists()
if not parent_exists:
return R.failed("上级菜单不存在")
# 验证路径唯一性(如果是菜单类型且路径变更)
path = cleaned_data.get('path')
menu_type = cleaned_data.get('type')
if menu_type == 1 and path and path != menu.path:
if Menu.objects.filter(path=path, is_delete=False).exclude(id=menu_id).exists():
return R.failed(f"菜单路径 '{path}' 已存在")
# 更新各字段
menu.name = cleaned_data.get('name')
menu.icon = cleaned_data.get('icon')
menu.parent_id = parent_id
menu.path = path
menu.component = cleaned_data.get('component')
menu.permission = cleaned_data.get('permission')
menu.target = cleaned_data.get('target')
menu.type = menu_type
menu.status = cleaned_data.get('status')
menu.hide = cleaned_data.get('hide', menu.hide)
menu.sort = cleaned_data.get('sort', menu.sort)
menu.note = cleaned_data.get('note')
menu.update_user = get_username(request)
menu.save()
return R.ok(msg="更新成功")
except Exception as e:
logging.error(f"更新菜单异常,ID: {menu_id}, 错误: {str(e)}")
return R.failed(msg="更新失败,请稍后重试")
# =============================================================
# 删除服务(支持批量)
# =============================================================
def delete_menus(menu_ids: str):
"""
批量删除菜单
根据传入的菜单ID字符串(逗号分隔)批量删除菜单。
删除前会检查每个菜单是否存在子级菜单,如有子级则禁止删除。
Args:
menu_ids: 逗号分隔的菜单ID字符串,如 "1,2,3"
Returns:
R: 操作结果
"""
if not menu_ids:
return R.failed("记录ID不存在")
try:
# 解析ID列表
id_list = [int(id_str.strip()) for id_str in menu_ids.split(',') if id_str.strip()]
if not id_list:
return R.failed("无效的记录ID")
# 存储有子级无法删除的菜单名称
has_children_menus = []
success_ids = []
# 遍历检查每个菜单
for menu_id in id_list:
menu = Menu.objects.only('id', 'name').filter(id=menu_id, is_delete=False).first()
if not menu:
return R.failed(f"ID为{menu_id}的菜单不存在")
# 检查是否有子级菜单
child_exists = Menu.objects.filter(parent_id=menu_id, is_delete=False).exists()
if child_exists:
has_children_menus.append(menu.name)
else:
success_ids.append(menu_id)
# 如果有包含子级的菜单,返回错误
if has_children_menus:
menu_names = "、".join(has_children_menus)
return R.failed(f"菜单【{menu_names}】存在子级菜单,无法删除")
# 批量执行软删除
updated_count = Menu.objects.filter(
id__in=success_ids,
is_delete=False
).update(is_delete=True)
return R.ok(msg=f"本次共删除{updated_count}条数据")
except ValueError:
return R.failed("记录ID格式错误")
except Exception as e:
logging.error(f"删除菜单异常,IDs: {menu_ids}, 错误: {str(e)}")
return R.failed(msg="删除失败,请稍后重试")
# =============================================================
# 权限获取服务
# =============================================================
def get_user_permissions(user_id):
"""
获取用户权限节点列表
根据用户ID获取该用户拥有的所有权限标识。
Args:
user_id: 用户ID
Returns:
list: 权限标识列表
"""
if user_id == 1:
# 超级管理员拥有所有权限
menu_list = Menu.objects.filter(is_delete=False, type=1, status=0).values()
permission_list = []
for item in menu_list:
permission_list.append(item['permission'])
return permission_list
else:
# 普通用户从角色关联中获取权限
qn = connection.ops.quote_name
sql = 'SELECT m.* FROM django_menu AS m '
sql += 'INNER JOIN django_role_menu AS rm ON m.id=rm.menu_id '
sql += 'INNER JOIN django_user_role AS ur ON ur.role_id=rm.role_id '
sql += f'WHERE ur.user_id=%s AND (m.type=1 OR (m.type=0 AND m.permission!=\'\')) AND m.{qn("status")}=0 AND m.is_delete=0'
menu_list = Menu.objects.raw(sql, [user_id])
permission_list = []
for item in menu_list:
permission_list.append(item.permission)
return permission_list
def get_user_permission_menus(user_id):
"""
获取用户权限菜单树
根据用户ID获取该用户可访问的菜单树结构。
Args:
user_id: 用户ID
Returns:
list: 菜单树结构列表
"""
if user_id == 1:
# 超级管理员查看全部菜单
menu_list = Menu.objects.filter(is_delete=False, status=0, type=0).order_by("sort")
return _build_tree(menu_list)
else:
# 普通用户从角色关联中获取菜单
qn = connection.ops.quote_name
sql = 'SELECT m.* FROM django_menu AS m '
sql += 'INNER JOIN django_role_menu AS rm ON m.id=rm.menu_id '
sql += 'INNER JOIN django_user_role AS ur ON ur.role_id=rm.role_id '
sql += f'WHERE ur.user_id=%s AND m.type=0 AND m.{qn("status")}=0 AND m.is_delete=0 '
sql += 'ORDER BY m.sort ASC;'
menu_list = Menu.objects.raw(sql, [user_id])
return _build_tree(menu_list)
def _build_tree(menu_list):
"""
构建菜单树结构(私有辅助函数)
将扁平的菜单列表转换为树形结构。
Args:
menu_list: 菜单查询集或列表
Returns:
list: 树形结构的菜单列表
"""
menu_data = []
for item in menu_list:
data = {
'id': item.id,
'name': item.name,
'icon': item.icon,
'icon2': getattr(item, 'icon2', ''),
'parentId': item.parent_id,
'path': item.path,
'component': item.component,
'permission': item.permission,
'target': item.target,
'type': item.type,
'hide': item.hide,
}
menu_data.append(data)
# 递归构建树形结构
result = _get_tree(menu_data, 0)
return result
def _get_tree(data, parent_id):
"""
递归获取树状结构(私有辅助函数)
Args:
data: 菜单数据列表
parent_id: 父级ID
Returns:
list: 树形结构数据
"""
result = []
for item in data:
if parent_id != item["parentId"]:
continue
# 递归获取子节点
children = _get_tree(data, item["id"])
if children:
item["children"] = children
else:
item["children"] = []
result.append(item)
return result
+3
View File
@@ -0,0 +1,3 @@
from django.test import TestCase
# Create your tests here.
+131
View File
@@ -0,0 +1,131 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
from django.urls import path # 导入路径相关配置
from application.menu import views
"""
菜单模块路由配置
=============================================================
URL端点概览:
------------------------------------------------------------------------
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|-----------------|----------|-----------------------------|---------------------|
| 分页查询 | GET | /menu/list | MenuListView |
| 详情查询 | GET | /menu/detail/<id> | MenuDetailView |
| 添加菜单 | POST | /menu/add | MenuAddView |
| 更新菜单 | PUT | /menu/update | MenuUpdateView |
| 删除菜单 | DELETE | /menu/delete/<ids> | MenuDeleteView |
------------------------------------------------------------------------
URL参数说明:
- menu_id: int类型,菜单ID(用于查询详情)
- menu_id: str类型,逗号分隔的菜单ID字符串(用于批量删除)
使用示例:
1. 分页查询:GET /api/menu/list?pageNo=1&pageSize=10&name=用户管理&status=1
2. 详情查询:GET /api/menu/detail/5
3. 添加菜单:POST /api/menu/add
4. 更新菜单:PUT /api/menu/update
5. 删除菜单:DELETE /api/menu/delete/5,6,7
菜单类型说明:
- 目录:顶级菜单,可以包含子菜单(通常type=0)
- 菜单:页面菜单,对应前端路由(通常type=1)
- 按钮:页面内的功能按钮,用于权限控制(通常type=2)
字段说明:
- name: 菜单名称
- parent_id: 父菜单ID(0表示顶级菜单)
- path: 前端路由路径
- component: 组件路径
- permission: 权限标识(如 sys:user:add)
- icon: 菜单图标
- sort: 排序值
- type: 菜单类型(0-目录, 1-菜单, 2-按钮)
- status: 状态(1-正常, 2-禁用)
- visible: 是否显示(1-显示, 2-隐藏)
注意事项:
- 菜单数据通常以树形结构展示,通过parent_id关联父子关系
- 删除菜单前需要检查是否有子菜单,建议先删除子菜单
- 菜单权限标识(permission)用于后端接口权限控制
- 按钮类型的菜单通常不显示在菜单树中,仅用于权限分配
- 修改菜单后可能需要刷新用户权限缓存
"""
# 菜单模块路由配置
urlpatterns = [
# 查询菜单分页列表
# URL: /menu/list
# 请求方法: GET
# 功能: 获取菜单分页数据,支持按名称、状态等条件筛选
path('list', views.MenuListView.as_view()),
# 查询菜单详情
# URL: /menu/detail/<int:menu_id>
# 请求方法: GET
# URL参数: menu_id - 菜单ID(整数类型)
# 功能: 根据ID获取指定菜单的详细信息
path('detail/<int:menu_id>', views.MenuDetailView.as_view()),
# 添加菜单
# URL: /menu/add
# 请求方法: POST
# 功能: 创建新的菜单记录,支持目录、菜单、按钮三种类型
path('add', views.MenuAddView.as_view()),
# 更新菜单
# URL: /menu/update
# 请求方法: PUT
# 功能: 更新现有菜单信息
path('update', views.MenuUpdateView.as_view()),
# 删除菜单
# URL: /menu/delete/<str:menu_id>
# 请求方法: DELETE
# URL参数: menu_id - 菜单ID字符串,支持单个ID或逗号分隔的多个ID(如 "1,2,3")
# 功能: 删除指定菜单(逻辑删除,设置is_delete=True)
# 注意: 删除菜单前请确认是否有子菜单,建议先删除子菜单
path('delete/<str:menu_id>', views.MenuDeleteView.as_view()),
]
+274
View File
@@ -0,0 +1,274 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
菜单管理视图模块
=============================================================
该模块定义了菜单管理功能中使用的所有视图类。
用于处理菜单信息的HTTP请求,包括分页查询、详情查询、添加、更新、删除等操作。
菜单用于构建前端导航菜单和权限控制节点,支持树形层级结构。
每个视图类对应一个特定的API端点,处理相应的业务逻辑。
"""
from django.utils.decorators import method_decorator
from django.views import View
from application.menu import services
from application.operation_log.constants import LogType
from application.operation_log.decorators import operation_log
from config.env import DJANGO_DEMO
from middleware.login_middleware import check_login
from middleware.permission_middleware import PermissionRequired
from utils import R
# =============================================================
# 分页列表查询视图
# =============================================================
@method_decorator(check_login, name='get')
class MenuListView(PermissionRequired, View):
"""
菜单分页列表查询视图
处理GET请求,返回菜单列表的分页数据。
支持按菜单名称、类型、状态等条件筛选。
URL: /menu/list
请求方法: GET
权限要求: sys:menu:list
"""
# 方法权限标识
permission_required = ("sys:menu:list",)
@operation_log(
title="权限菜单-查询记录列表",
log_type=LogType.QUERY
)
def get(self, request):
"""
处理GET请求,返回菜单分页数据
Args:
request: HttpRequest对象,包含分页参数和筛选条件
- pageNo: 当前页码
- pageSize: 每页记录数
- name: 菜单名称(可选,模糊查询)
- type: 菜单类型(可选,0-菜单, 1-节点)
- status: 菜单状态(可选,0-显示, 1-不显示)
Returns:
JsonResponse: 包含分页数据的JSON响应
"""
result = services.get_menu_list(request)
return result
# =============================================================
# 详情查询视图
# =============================================================
@method_decorator(check_login, name='get')
class MenuDetailView(PermissionRequired, View):
"""
菜单详情查询视图
处理GET请求,根据菜单ID返回菜单详细信息。
URL: /menu/detail/<int:menu_id>
请求方法: GET
URL参数: menu_id - 菜单ID
权限要求: sys:menu:detail
"""
# 方法权限标识
permission_required = ("sys:menu:detail",)
@operation_log(
title="权限菜单-查询记录详情",
log_type=LogType.QUERY
)
def get(self, request, menu_id):
"""
处理GET请求,返回菜单详情
Args:
request: HttpRequest对象
menu_id: int, 菜单ID(从URL中获取)
Returns:
JsonResponse: 包含菜单详细信息的JSON响应
"""
data = services.get_menu_detail(menu_id)
return R.ok(data=data)
# =============================================================
# 添加视图
# =============================================================
@method_decorator(check_login, name='post')
class MenuAddView(PermissionRequired, View):
"""
添加菜单视图
处理POST请求,创建新的菜单记录。
URL: /menu/add
请求方法: POST
权限要求: sys:menu:add
"""
# 方法权限标识
permission_required = ("sys:menu:add",)
@operation_log(
title="权限菜单-添加记录",
log_type=LogType.ADD
)
def post(self, request):
"""
处理POST请求,添加新菜单
Args:
request: HttpRequest对象,包含菜单信息的JSON数据
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.add_menu(request)
return result
# =============================================================
# 更新视图
# =============================================================
@method_decorator(check_login, name='put')
class MenuUpdateView(PermissionRequired, View):
"""
更新菜单视图
处理PUT请求,更新现有菜单信息。
URL: /menu/update
请求方法: PUT
权限要求: sys:menu:update
"""
# 方法权限标识
permission_required = ("sys:menu:update",)
@operation_log(
title="权限菜单-更新记录",
log_type=LogType.UPDATE
)
def put(self, request):
"""
处理PUT请求,更新菜单信息
Args:
request: HttpRequest对象,包含菜单ID和更新信息的JSON数据
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.update_menu(request)
return result
# =============================================================
# 删除视图(支持批量)
# =============================================================
@method_decorator(check_login, name='delete')
class MenuDeleteView(PermissionRequired, View):
"""
删除菜单视图
处理DELETE请求,删除指定菜单(支持批量删除)。
URL: /menu/delete/<str:menu_id>
请求方法: DELETE
URL参数: menu_id - 菜单ID字符串,多个ID用逗号分隔
权限要求: sys:menu:delete
注意:
- 删除菜单前请确认是否有子菜单,建议先删除子菜单
- 删除操作为逻辑删除,数据仍保留在数据库中
"""
# 方法权限标识
permission_required = ("sys:menu:delete",)
@operation_log(
title="权限菜单-删除记录",
log_type=LogType.DELETE
)
def delete(self, request, menu_id):
"""
处理DELETE请求,删除菜单
Args:
request: HttpRequest对象
menu_id: str, 菜单ID字符串,支持单个ID或逗号分隔的多个ID
例如: "1" 或 "1,2,3"
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.delete_menus(menu_id)
return result