签入版本

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 RoleConfig(AppConfig):
"""角色管理应用配置类"""
# 指定该应用在项目中的Python导入路径
# 格式为 '应用所在模块.应用名称'
name = 'application.role'
+161
View File
@@ -0,0 +1,161 @@
# +======================================================================
# | 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.role import models
# =============================================================
# 角色表单验证类
# =============================================================
class RoleForm(forms.ModelForm):
"""
角色表单验证类
用于创建和更新角色信息时的表单验证。
角色是权限的集合,一个角色代表一组权限。
验证字段包括:
- name: 角色名称
- code: 角色编码
- sort: 排序值
- note: 备注说明
"""
# ----------------------------------------------------------
# 角色名称
# ----------------------------------------------------------
# 字段说明: 角色的显示名称
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度100字符
# 业务说明: 如"超级管理员"、"普通用户"、"访客"
name = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '角色名称不能为空',
'max_length': '角色名称长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 角色编码
# ----------------------------------------------------------
# 字段说明: 角色的唯一编码
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度100字符
# 业务说明: 用于在代码中引用,如"admin"、"user"、"guest"
# 注意: 编码一旦确定,尽量不要修改,避免代码中的引用失效
code = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '角色编码不能为空',
'max_length': '角色编码长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 控制角色的显示顺序
# 字段类型: 整型(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:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 Role(角色)
model = models.Role
# 指定需要验证的字段
fields = [
'name',
'code',
'sort',
'note'
]
@@ -0,0 +1,36 @@
# 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='Role',
fields=[
('name', models.CharField(db_comment='角色名称', db_index=True, help_text='角色名称', max_length=100, verbose_name='角色名称')),
('code', models.CharField(db_comment='角色编码', db_index=True, help_text='角色编码', max_length=100, verbose_name='角色编码')),
('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_role',
'db_table_comment': '角色名称',
'ordering': ('sort',),
},
),
]
+197
View File
@@ -0,0 +1,197 @@
# +======================================================================
# | 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 Role(BaseModel):
"""
角色模型类
用于存储系统的角色信息。
角色是权限的集合,一个角色代表一组权限。
通过给用户分配角色,实现对用户权限的控制。
继承自 BaseModel,自动包含:
- id: 主键
- is_delete: 逻辑删除标识
- create_user: 创建人
- create_time: 创建时间
- update_user: 更新人
- update_time: 更新时间
主要业务字段:
- name: 角色名称,如"超级管理员"、"普通用户"
- code: 角色编码,系统内部标识,如"admin"、"user"
- sort: 排序值,控制显示顺序
- note: 备注说明,描述角色的用途和权限范围
关联关系:
- 与 User 模型为多对多关系,一个用户可以有多个角色,一个角色可以被多个用户拥有
- 与 Menu 模型为多对多关系,通过 RoleMenu 中间表关联,表示角色拥有的菜单权限
"""
# ----------------------------------------------------------
# 角色名称
# ----------------------------------------------------------
# 字段说明: 角色的显示名称
# 字段类型: 字符串(CharField)
# 约束: 非空(null=False),最大长度100字符
# 索引: 添加了数据库索引(db_index=True)以提升查询效率
# 示例: "超级管理员"、"普通用户"、"访客"
# 作用: 用于前端展示角色名称
name = models.CharField(
null=False,
max_length=100,
db_index=True,
verbose_name="角色名称",
help_text="角色名称",
db_comment='角色名称' # 数据库字段注释
)
# ----------------------------------------------------------
# 角色编码
# ----------------------------------------------------------
# 字段说明: 角色的唯一编码
# 字段类型: 字符串(CharField)
# 约束: 非空(null=False),最大长度100字符
# 索引: 添加了数据库索引(db_index=True)以提升查询效率
# 示例: "admin"、"user"、"guest"
# 注意: 编码一旦确定,尽量不要修改,避免代码中的引用失效
# 作用: 用于在代码中引用角色,如通过编码判断用户角色
code = models.CharField(
null=False,
max_length=100,
db_index=True,
verbose_name="角色编码",
help_text="角色编码",
db_comment='角色编码' # 数据库字段注释
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 控制角色的显示顺序
# 字段类型: 整数(IntegerField)
# 约束: 非空(null=False),默认值为0
# 排序规则: 数字越小越靠前
# 作用: 手动控制角色在列表中的显示顺序
sort = models.IntegerField(
null=False,
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:
"""
模型元数据配置类
定义模型在数据库中的表名、显示名称、默认排序规则等。
"""
# 数据表名
# 使用配置文件中的表前缀 + "role",避免与其他应用表名冲突
db_table = get_table_name('role')
# 数据表注释
db_table_comment = "角色名称"
# 模型在admin后台显示的友好名称(单数)
verbose_name = "角色表"
# 模型在admin后台显示的友好名称(复数)
verbose_name_plural = verbose_name
# 默认排序规则
# 按照 sort 字段升序排列(数值小的在前),确保显示顺序可控
ordering = ("sort",)
# =============================================================
# 实例方法
# =============================================================
def __str__(self):
"""
模型的字符串表示方法
当需要将模型实例转换为字符串时调用,如admin后台显示、日志输出等。
Returns:
str: 包含角色名称的字符串
"""
return f'角色{self.name}:'
+408
View File
@@ -0,0 +1,408 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
角色管理服务模块
=============================================================
该模块实现了角色管理相关的所有业务逻辑。
包括角色的分页查询、详情查询、添加、更新、删除等功能。
角色用于定义系统中的权限集合,通过角色可以方便地为用户分配权限,
每个角色包含名称、编码、排序、备注等属性,通过 sort 字段控制显示顺序。
命名规范:
- 函数参数使用驼峰命名(如 roleId, pageNo)
- 表单字段使用下划线命名(如 name, code, sort)- 与数据库字段保持一致
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
功能模块:
1. 分页查询:支持按名称模糊搜索,按 sort 字段排序
2. 详情查询:根据ID获取单个角色的详细信息
3. 数据维护:角色的添加、更新、删除(支持批量)
4. 数据列表:获取所有启用的角色列表(用于下拉选择等场景)
"""
import logging
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
from application.role import forms
from application.role.models import Role
from constant.constants import PAGE_SIZE
from utils import R, regular
from utils.common import format_datetime, parse_request_body
from utils.security import get_username
# =============================================================
# 分页查询服务
# =============================================================
def get_role_page(request):
"""
查询角色分页数据
Args:
request: HttpRequest对象,包含查询参数
- pageNo: 当前页码(可选,默认为1)
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
- name: 角色名称(可选,模糊查询)
Returns:
R: 包含分页数据的JSON响应
"""
try:
# 获取分页参数
page_no = int(request.GET.get('pageNo', 1))
page_size = int(request.GET.get('pageSize', PAGE_SIZE))
# 构建基础查询(只查询未删除的记录)
query = Role.objects.filter(is_delete=False)
# 应用筛选条件
query = _apply_filters(query, request)
# 按排序字段和ID升序排列
query = query.order_by("sort", "id")
# 执行分页查询
paginator = Paginator(query, page_size)
try:
page_list = paginator.page(page_no)
except (PageNotAnInteger, InvalidPage, EmptyPage):
# 页码无效时默认返回第一页
page_list = paginator.page(1)
page_no = 1
# 构建并返回分页数据
page_data = _build_page_data(page_list, paginator, page_no, page_size)
return R.ok(data=page_data)
except Exception as e:
logging.error(f"查询角色分页数据异常: {str(e)}")
return R.failed(msg="查询失败,请稍后重试")
def _apply_filters(queryset, request):
"""
应用查询筛选条件
Args:
queryset: 初始查询集
request: HttpRequest对象,包含筛选参数
Returns:
QuerySet: 应用筛选后的查询集
"""
# 角色名称模糊筛选
name = request.GET.get('name')
if name:
queryset = queryset.filter(name__contains=name)
# 角色编码筛选
code = request.GET.get('code')
if code:
queryset = queryset.filter(code__contains=code)
return queryset
def _build_page_data(page_list, paginator, page_no, page_size):
"""
构建分页返回数据
Args:
page_list: 当前页数据列表
paginator: 分页器对象
page_no: 当前页码
page_size: 每页大小
Returns:
dict: 分页数据
"""
records = []
for item in page_list:
records.append({
'id': item.id,
'name': item.name,
'code': item.code,
'sort': item.sort,
'note': item.note,
'createUser': item.create_user,
'createTime': format_datetime(item.create_time),
'updateUser': item.update_user,
'updateTime': format_datetime(item.update_time),
})
return {
'records': records,
'total': paginator.count,
'size': page_size,
'current': page_no,
'pages': paginator.num_pages
}
# =============================================================
# 详情查询服务
# =============================================================
def get_role_detail(role_id):
"""
根据ID查询角色详情
Args:
role_id: 角色ID
Returns:
dict/None: 角色详情字典,不存在时返回None
"""
try:
# 查询未删除的角色记录
role = Role.objects.filter(is_delete=False, id=role_id).first()
if not role:
return None
# 返回详情数据
return {
'id': role.id,
'name': role.name,
'code': role.code,
'sort': role.sort,
'note': role.note,
}
except Exception as e:
logging.error(f"查询角色详情异常,ID: {role_id}, 错误: {str(e)}")
return None
# =============================================================
# 添加服务
# =============================================================
def add_role(request):
"""
添加角色
处理流程:
1. 解析请求体中的JSON数据
2. 表单验证
3. 检查角色编码唯一性
4. 创建数据库记录
Args:
request: HttpRequest对象,包含角色信息的JSON数据
Returns:
R: 操作结果(成功/失败)
"""
# 解析请求参数
data, error = parse_request_body(request)
if error:
return R.failed(msg=error)
# 表单验证
form = forms.RoleForm(data)
if not form.is_valid():
return R.failed(msg=regular.get_err(form))
try:
cleaned_data = form.cleaned_data
# 检查角色编码是否已存在(编码必须唯一)
code = cleaned_data.get('code')
if code and Role.objects.filter(code=code, is_delete=False).exists():
return R.failed(msg=f"角色编码 '{code}' 已存在")
# 创建角色记录
Role.objects.create(
name=cleaned_data.get('name'),
code=code,
sort=cleaned_data.get('sort'),
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_role(request):
"""
更新角色
处理流程:
1. 解析请求体中的JSON数据
2. 验证角色ID
3. 表单验证
4. 查询现有记录
5. 检查编码唯一性(排除自身)
6. 更新各字段
7. 保存更新
Args:
request: HttpRequest对象,包含角色ID和更新信息的JSON数据
Returns:
R: 操作结果(成功/失败)
"""
# 解析请求参数
data, error = parse_request_body(request)
if error:
return R.failed(msg=error)
# 验证角色ID
role_id = data.get('id')
if not role_id or not str(role_id).isdigit() or int(role_id) <= 0:
return R.failed("角色ID无效")
role_id = int(role_id)
# 表单验证
form = forms.RoleForm(data)
if not form.is_valid():
return R.failed(msg=regular.get_err(form))
try:
# 查询角色记录
role = Role.objects.filter(id=role_id, is_delete=False).first()
if not role:
return R.failed("角色不存在")
cleaned_data = form.cleaned_data
# 检查角色编码是否与其他角色冲突(排除自身)
code = cleaned_data.get('code')
if code and code != role.code:
if Role.objects.filter(code=code, is_delete=False).exclude(id=role_id).exists():
return R.failed(msg=f"角色编码 '{code}' 已存在")
# 更新各字段
role.name = cleaned_data.get('name')
role.code = code
role.sort = cleaned_data.get('sort')
role.note = cleaned_data.get('note')
role.update_user = get_username(request)
role.save()
return R.ok(msg="更新成功")
except Exception as e:
logging.error(f"更新角色异常,ID: {role_id}, 错误: {str(e)}")
return R.failed(msg="更新失败,请稍后重试")
# =============================================================
# 删除服务(支持批量)
# =============================================================
def delete_roles(role_ids):
"""
删除角色(批量删除)
采用逻辑删除方式(is_delete=True),而非物理删除。
支持逗号分隔的多个ID。
Args:
role_ids: 角色ID字符串,多个ID用逗号分隔
例如: "1" 或 "1,2,3"
Returns:
R: 操作结果,包含删除数量
"""
if not role_ids:
return R.failed("记录ID不存在")
try:
# 解析ID列表
id_list = [int(id_str.strip()) for id_str in role_ids.split(',') if id_str.strip()]
if not id_list:
return R.failed("无效的记录ID")
# 检查角色是否被用户使用(如果被使用则不能删除)
# from application.user.models import User
# if User.objects.filter(role_id__in=id_list, is_delete=False).exists():
# return R.failed("选中的角色已被用户使用,无法删除")
# 批量更新删除标识(逻辑删除)
updated_count = Role.objects.filter(
id__in=id_list,
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: {role_ids}, 错误: {str(e)}")
return R.failed(msg="删除失败,请稍后重试")
# =============================================================
# 下拉列表获取服务
# =============================================================
def get_role_list():
"""
获取所有角色列表
返回所有未删除的角色列表,按排序升序排列。
通常用于前端下拉选择框等场景。
Returns:
list: 角色列表,每个元素包含 id、name、code 等字段
查询失败时返回空列表
"""
try:
# 查询未删除的角色数据列表
queryset = Role.objects.filter(
is_delete=False
).order_by("sort").values()
return list(queryset)
except Exception as e:
logging.error(f"获取角色列表异常: {str(e)}")
return []
+3
View File
@@ -0,0 +1,3 @@
from django.test import TestCase
# Create your tests here.
+116
View File
@@ -0,0 +1,116 @@
# +======================================================================
# | 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.role import views
"""
角色模块路由配置
=============================================================
URL端点概览:
------------------------------------------------------------------------
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|-----------------|----------|-----------------------------|---------------------|
| 分页查询 | GET | /role/page | RolePageView |
| 详情查询 | GET | /role/detail/<id> | RoleDetailView |
| 添加角色 | POST | /role/add | RoleAddView |
| 更新角色 | PUT | /role/update | RoleUpdateView |
| 删除角色 | DELETE | /role/delete/<ids> | RoleDeleteView |
| 获取角色列表 | GET | /role/list | RoleGetListView |
------------------------------------------------------------------------
URL参数说明:
- role_id: int类型,角色ID(用于查询详情)
- role_id: str类型,逗号分隔的角色ID字符串(用于批量删除)
使用示例:
1. 分页查询:GET /api/role/page?pageNo=1&pageSize=10&name=管理员&status=1
2. 详情查询:GET /api/role/detail/5
3. 添加角色:POST /api/role/add
4. 更新角色:PUT /api/role/update
5. 删除角色:DELETE /api/role/delete/5,6,7
6. 获取角色列表:GET /api/role/list
"""
# 角色模块路由配置
urlpatterns = [
# 查询角色分页列表
# URL: /role/page
# 请求方法: GET
# 功能: 获取角色分页数据,支持按名称、编码、状态等条件筛选
path('page', views.RolePageView.as_view()),
# 根据ID查询角色详情
# URL: /role/detail/<int:role_id>
# 请求方法: GET
# URL参数: role_id - 角色ID(整数类型)
# 功能: 根据ID获取指定角色的详细信息,包含角色基本信息、权限ID列表、数据权限范围等
path('detail/<int:role_id>', views.RoleDetailView.as_view()),
# 添加角色
# URL: /role/add
# 请求方法: POST
# 功能: 创建新的角色记录,需指定角色名称、编码、权限ID列表、数据权限范围等
path('add', views.RoleAddView.as_view()),
# 更新角色
# URL: /role/update
# 请求方法: PUT
# 功能: 更新现有角色信息
path('update', views.RoleUpdateView.as_view()),
# 根据ID删除角色
# URL: /role/delete/<str:role_id>
# 请求方法: DELETE
# URL参数: role_id - 角色ID字符串,支持单个ID或逗号分隔的多个ID(如 "1,2,3")
# 功能: 删除指定角色(逻辑删除,设置is_delete=True)
# 注意: 删除角色前请确认该角色未被任何用户关联
path('delete/<str:role_id>', views.RoleDeleteView.as_view()),
# 获取角色列表(用于下拉选择)
# URL: /role/list
# 请求方法: GET
# 功能: 获取所有正常状态角色的精简列表数据,用于前端下拉选择框
# 返回数据: 通常包含角色ID、角色名称等基本信息
path('list', views.RoleGetListView.as_view()),
]
+303
View File
@@ -0,0 +1,303 @@
# +======================================================================
# | 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.operation_log.constants import LogType
from application.operation_log.decorators import operation_log
from application.role 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
# =============================================================
# 分页查询视图
# =============================================================
@method_decorator(check_login, name='get')
class RolePageView(PermissionRequired, View):
"""
角色分页列表查询视图
处理GET请求,返回角色列表的分页数据。
支持按角色名称、编码、状态等条件筛选。
URL: /role/page
请求方法: GET
权限要求: sys:role:page
"""
# 方法权限标识
permission_required = ('sys:role:page',)
@operation_log(
title="角色管理-查询分页列表",
log_type=LogType.QUERY
)
def get(self, request):
"""
处理GET请求,返回角色分页数据
Args:
request: HttpRequest对象,包含分页参数和筛选条件
- pageNo: 当前页码
- pageSize: 每页记录数
- name: 角色名称(可选,模糊查询)
- code: 角色编码(可选,模糊查询)
- status: 角色状态(可选,1-正常, 2-停用)
Returns:
JsonResponse: 包含分页数据的JSON响应
"""
result = services.get_role_page(request)
return result
# =============================================================
# 详情查询视图
# =============================================================
@method_decorator(check_login, name='get')
class RoleDetailView(PermissionRequired, View):
"""
角色详情查询视图
处理GET请求,根据角色ID返回角色详细信息。
URL: /role/detail/<int:role_id>
请求方法: GET
URL参数: role_id - 角色ID
权限要求: sys:role:detail
"""
# 方法权限标识
permission_required = ('sys:role:detail',)
@operation_log(
title="角色管理-查询记录详情",
log_type=LogType.QUERY
)
def get(self, request, role_id):
"""
处理GET请求,返回角色详情
Args:
request: HttpRequest对象
role_id: int, 角色ID(从URL中获取)
Returns:
JsonResponse: 包含角色详细信息的JSON响应
"""
data = services.get_role_detail(role_id)
return R.ok(data=data)
# =============================================================
# 添加视图
# =============================================================
@method_decorator(check_login, name='post')
class RoleAddView(PermissionRequired, View):
"""
添加角色视图
处理POST请求,创建新的角色记录。
URL: /role/add
请求方法: POST
权限要求: sys:role:add
"""
# 方法权限标识
permission_required = ('sys:role: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_role(request)
return result
# =============================================================
# 更新视图
# =============================================================
@method_decorator(check_login, name='put')
class RoleUpdateView(PermissionRequired, View):
"""
更新角色视图
处理PUT请求,更新现有角色信息。
URL: /role/update
请求方法: PUT
权限要求: sys:role:update
"""
# 方法权限标识
permission_required = ('sys:role: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_role(request)
return result
# =============================================================
# 删除视图(支持批量)
# =============================================================
@method_decorator(check_login, name='delete')
class RoleDeleteView(PermissionRequired, View):
"""
删除角色视图
处理DELETE请求,删除指定角色(支持批量删除)。
URL: /role/delete/<str:role_id>
请求方法: DELETE
URL参数: role_id - 角色ID字符串,多个ID用逗号分隔
权限要求: sys:role:delete
注意: 删除角色前请确认该角色未被任何用户关联
"""
# 方法权限标识
permission_required = ('sys:role:delete',)
@operation_log(
title="角色管理-删除记录",
log_type=LogType.DELETE
)
def delete(self, request, role_id):
"""
处理DELETE请求,删除角色
Args:
request: HttpRequest对象
role_id: str, 角色ID字符串,支持单个ID或逗号分隔的多个ID
例如: "1" 或 "1,2,3"
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.delete_roles(role_id)
return result
# =============================================================
# 下拉列表获取视图
# =============================================================
@method_decorator(check_login, name='get')
class RoleGetListView(View):
"""
角色列表获取视图(用于下拉选择)
处理GET请求,获取所有正常状态的角色列表。
通常用于前端下拉选择框、用户分配角色等场景。
URL: /role/list
请求方法: GET
权限要求: 需要登录
"""
def get(self, request):
"""
处理GET请求,获取所有角色列表
Args:
request: HttpRequest对象
Returns:
JsonResponse: 包含角色列表的JSON响应
"""
result = services.get_role_list()
return R.ok(data=result)