274 lines
12 KiB
Python
274 lines
12 KiB
Python
# +======================================================================
|
||
# | 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 ConfigItem(BaseModel):
|
||
"""
|
||
配置项模型类
|
||
|
||
用于存储系统配置的具体项，每个配置项属于一个配置类型。
|
||
配置项是系统中可动态调整的参数，支持多种数据类型和输入方式。
|
||
继承自 BaseModel，自动包含：
|
||
- id: 主键
|
||
- is_delete: 逻辑删除标识
|
||
- create_user: 创建人
|
||
- create_time: 创建时间
|
||
- update_user: 更新人
|
||
- update_time: 更新时间
|
||
|
||
主要业务字段：
|
||
- name: 配置项显示名称
|
||
- code: 配置项编码，用于在代码中引用
|
||
- value: 配置项当前值
|
||
- config_id: 所属配置类型的ID
|
||
- type: 配置项数据类型（text、number、select等）
|
||
- options: 配置选项（用于select、radio、checkbox类型）
|
||
- status: 配置项状态（正常/停用）
|
||
- sort: 排序值，控制显示顺序
|
||
|
||
关联关系：
|
||
- 与 Config 模型为多对一关系，多个配置项属于同一个配置类型
|
||
"""
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置项名称
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的显示名称
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 最大长度100字符
|
||
# 索引: 添加了数据库索引（db_index=True）以支持名称搜索
|
||
# 示例: "系统名称"、"上传文件大小限制"
|
||
# 作用: 用于前端展示配置项的名称
|
||
name = models.CharField(
|
||
max_length=100,
|
||
db_index=True,
|
||
verbose_name="配置项名称",
|
||
help_text="配置项名称",
|
||
db_comment='配置项名称' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置项编码
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的唯一编码
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 最大长度100字符
|
||
# 示例: "system_name"、"upload_max_size"
|
||
# 注意: 编码一旦确定，尽量不要修改，避免代码中的引用失效
|
||
# 作用: 用于在代码中引用配置项的值，如通过编码获取配置
|
||
code = models.CharField(
|
||
max_length=100,
|
||
verbose_name="配置项编码",
|
||
help_text="配置项编码",
|
||
db_comment='配置项编码' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置项值
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的当前值
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 最大长度1000字符
|
||
# 作用: 存储配置项的当前值，根据 type 字段的不同，存储不同格式的数据
|
||
value = models.CharField(
|
||
max_length=1000,
|
||
verbose_name="配置项值",
|
||
help_text="配置项值",
|
||
db_comment='配置项值' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置选项
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的可选项列表
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 最大长度255字符
|
||
# 格式: 通常为JSON字符串，如 [{"label":"是","value":1},{"label":"否","value":0}]
|
||
# 作用: 当配置类型为 select、radio、checkbox 时，存储可选值列表
|
||
options = models.CharField(
|
||
max_length=255,
|
||
verbose_name="配置选项",
|
||
help_text="配置选项",
|
||
db_comment='配置选项' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置ID
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 所属配置类型的ID
|
||
# 字段类型: 整数（IntegerField）
|
||
# 约束: 默认值为0
|
||
# 索引: 添加了数据库索引（db_index=True）以提升查询效率
|
||
# 作用: 关联到配置表（Config）的主键ID，标识该配置项属于哪个配置类型
|
||
config_id = models.IntegerField(
|
||
default=0,
|
||
db_index=True,
|
||
verbose_name="配置ID",
|
||
help_text="配置ID",
|
||
db_comment='配置ID', # 数据库字段注释
|
||
db_default=0
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置类型
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的数据类型和输入控件类型
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 最大长度100字符
|
||
# 可选值: text, textarea, number, select, radio, checkbox, image, file, date, datetime 等
|
||
# 作用: 指定前端渲染的输入控件类型，以及后端数据的处理方式
|
||
type = models.CharField(
|
||
max_length=100,
|
||
verbose_name="配置类型",
|
||
help_text="配置类型",
|
||
db_comment='配置类型' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置状态
|
||
# ----------------------------------------------------------
|
||
# 状态常量定义
|
||
STATUS_CHOICES = (
|
||
(1, "正常"), # 正常状态：配置项可用
|
||
(2, "停用"), # 停用状态：配置项不可用
|
||
)
|
||
|
||
# 字段说明: 配置项的启用/停用状态
|
||
# 字段类型: 整数（IntegerField）
|
||
# 约束: 使用 STATUS_CHOICES 限制可选值
|
||
# 默认值: 1（正常）
|
||
# 作用: 控制配置项是否可用，停用的配置项在前端不显示或不可编辑
|
||
status = models.IntegerField(
|
||
choices=STATUS_CHOICES,
|
||
default=1,
|
||
verbose_name="配置状态：1-正常 2-停用",
|
||
help_text="配置状态：1-正常 2-停用",
|
||
db_comment='配置状态：1-正常 2-停用', # 数据库字段注释
|
||
db_default=1
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置项排序
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的显示顺序
|
||
# 字段类型: 整数（IntegerField）
|
||
# 约束: 默认值为0
|
||
# 排序规则: 数字越小越靠前
|
||
# 作用: 控制配置项在列表中的显示顺序
|
||
sort = models.IntegerField(
|
||
default=0,
|
||
verbose_name="配置项顺序",
|
||
help_text="配置项顺序",
|
||
db_comment='配置项顺序', # 数据库字段注释
|
||
db_default=0
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 配置项备注
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 配置项的说明信息
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 允许为空（null=True），最大长度255字符
|
||
# 作用: 存储配置项的说明信息，描述其用途、取值范围、注意事项等
|
||
note = models.CharField(
|
||
null=True,
|
||
max_length=255,
|
||
verbose_name="配置项备注",
|
||
help_text="配置项备注",
|
||
db_comment='配置项备注' # 数据库字段注释
|
||
)
|
||
|
||
# =============================================================
|
||
# 模型元数据配置
|
||
# =============================================================
|
||
|
||
class Meta:
|
||
"""
|
||
模型元数据配置类
|
||
|
||
定义模型在数据库中的表名、显示名称等。
|
||
"""
|
||
|
||
# 数据表名
|
||
# 使用配置文件中的表前缀 + "config_item"，避免与其他应用表名冲突
|
||
db_table = get_table_name('config_item')
|
||
|
||
# 数据表注释
|
||
db_table_comment = "配置项名称"
|
||
|
||
# 模型在admin后台显示的友好名称（单数）
|
||
verbose_name = "配置项表"
|
||
|
||
# 模型在admin后台显示的友好名称（复数）
|
||
verbose_name_plural = verbose_name
|
||
|
||
# =============================================================
|
||
# 实例方法
|
||
# =============================================================
|
||
|
||
def __str__(self):
|
||
"""
|
||
模型的字符串表示方法
|
||
|
||
当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。
|
||
|
||
Returns:
|
||
str: 包含配置项ID的字符串
|
||
"""
|
||
return f"配置项{self.id}"
|