签入版本

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