签入版本

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