Files
2026-09-11 11:39:07 +08:00

252 lines
11 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# +======================================================================
# | 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.config_item import models
# =============================================================
# 配置项表单验证类
# =============================================================
class ConfigItemForm(forms.ModelForm):
"""
配置项表单验证类
用于创建和更新配置项信息时的表单验证。
配置项是具体的系统参数,每个配置项属于一个配置类型。
验证字段包括:
- configId: 所属配置类型的ID
- name: 配置项名称
- code: 配置项编码
- value: 配置项当前值
- options: 选项列表(用于select/radio/checkbox类型)
- type: 配置项数据类型
- status: 配置项状态
- note: 备注说明
- sort: 排序值
"""
# ----------------------------------------------------------
# 配置ID
# ----------------------------------------------------------
# 字段说明: 所属配置类型的ID
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值0
# 业务说明: 关联到配置表(Config)的主键ID,标识该配置项所属的配置类型
configId = 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字符
# 业务说明: 用于在代码中引用,如"system_name"、"upload_max_size"
# 注意: 编码一旦确定,尽量不要修改,避免代码中的引用失效
code = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '配置项编码不能为空',
'max_length': '配置项编码长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 配置项值
# ----------------------------------------------------------
# 字段说明: 配置项的当前值
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度1000字符
# 业务说明: 根据 type 字段的不同,存储不同格式的数据
value = forms.CharField(
required=False,
max_length=1000,
error_messages={
'max_length': '配置项值长度不得超过1000个字符',
}
)
# ----------------------------------------------------------
# 配置选项
# ----------------------------------------------------------
# 字段说明: 配置项的可选项列表
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度100字符
# 业务说明: 当配置类型为 select、radio、checkbox 时,存储可选项列表
# 格式: 通常为JSON字符串,如 [{"label":"是","value":1},{"label":"否","value":0}]
options = forms.CharField(
required=False,
max_length=100,
error_messages={
'max_length': '配置选项长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 配置类型
# ----------------------------------------------------------
# 字段说明: 配置项的数据类型和输入控件类型
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度100字符
# 可选值: text, textarea, number, select, radio, checkbox, image, file, date, datetime 等
type = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '配置类型不能为空',
'max_length': '配置类型长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 配置项状态
# ----------------------------------------------------------
# 字段说明: 配置项的启用/停用状态
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值1
# 可选值: 1-正常, 2-停用
status = forms.IntegerField(
required=True,
min_value=1,
error_messages={
'required': '配置状态不能为空',
'min_value': '配置状态不能小于1',
}
)
# ----------------------------------------------------------
# 配置项备注
# ----------------------------------------------------------
# 字段说明: 配置项的说明信息
# 字段类型: 字符型(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:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 ConfigItem(配置项)
model = models.ConfigItem
# 指定需要验证的字段
# 只验证以下字段,其他字段不进行表单验证
fields = [
'configId',
'name',
'code',
'value',
'options',
'type',
'status',
'note',
'sort'
]