签入版本
This commit is contained in:
@@ -0,0 +1,3 @@
|
||||
from django.contrib import admin
|
||||
|
||||
# Register your models here.
|
||||
@@ -0,0 +1,78 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板管理应用配置模块
|
||||
=============================================================
|
||||
|
||||
该模块定义了文件模板管理应用的配置类，用于Django应用注册和初始化。
|
||||
文件模板应用负责管理系统中的各类模板文件，如导出模板、打印模板、消息模板等，
|
||||
通过编码（code）进行唯一标识，便于在代码中动态获取和使用。
|
||||
"""
|
||||
|
||||
from django.apps import AppConfig
|
||||
|
||||
|
||||
class FileTemplateConfig(AppConfig):
|
||||
"""
|
||||
文件模板应用配置类
|
||||
|
||||
该配置类用于配置文件模板应用的基本信息。
|
||||
"""
|
||||
|
||||
# 指定默认的主键字段类型
|
||||
# 使用 BigAutoField（64位整数）而非默认的 AutoField（32位整数）
|
||||
# 优势:
|
||||
# 1. 支持更大的数据量，理论最大值为 2^64-1
|
||||
# 2. 适合高并发场景，避免未来可能的主键溢出问题
|
||||
# 3. 与分布式系统兼容性更好
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
|
||||
# 指定该应用在项目中的Python导入路径
|
||||
# 格式: '应用所在模块.应用名称'
|
||||
# 说明:
|
||||
# - application: 应用模块包名
|
||||
# - file_template: 应用名称（对应应用目录名）
|
||||
# 作用:
|
||||
# 1. 告诉Django如何导入该应用
|
||||
# 2. 用于反向解析URL和模板路径
|
||||
# 3. 在INSTALLED_APPS中标识该应用
|
||||
name = 'application.file_template'
|
||||
@@ -0,0 +1,196 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板表单验证模块
|
||||
=============================================================
|
||||
|
||||
该模块定义了文件模板管理功能中使用的表单验证类。
|
||||
用于对前端提交的文件模板数据进行验证，确保数据符合业务规则和数据库约束。
|
||||
文件模板用于存储系统中的各类模板文件，通过编码（code）进行唯一标识。
|
||||
"""
|
||||
|
||||
from django import forms
|
||||
|
||||
from application.file_template import models
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 文件模板表单验证类
|
||||
# =============================================================
|
||||
|
||||
class FileTemplateForm(forms.ModelForm):
|
||||
"""
|
||||
文件模板表单验证类
|
||||
|
||||
用于创建和更新文件模板信息时的表单验证。
|
||||
文件模板是系统中的各类模板文件，通过编码（code）唯一标识。
|
||||
|
||||
验证字段包括：
|
||||
- name: 模板名称
|
||||
- code: 模板编码
|
||||
- fileName: 文件名称
|
||||
- filePath: 文件路径
|
||||
- sort: 排序值
|
||||
- note: 备注说明
|
||||
"""
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 模板名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的显示名称
|
||||
# 字段类型: 字符型（CharField）
|
||||
# 验证规则: 必填（required=True），最大长度100字符
|
||||
# 业务说明: 如"用户导出模板"、"短信验证码模板"
|
||||
name = forms.CharField(
|
||||
required=True,
|
||||
max_length=100,
|
||||
error_messages={
|
||||
'required': '模板名称不能为空',
|
||||
'max_length': '模板名称长度不得超过100个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 模板编码
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的唯一标识
|
||||
# 字段类型: 字符型（CharField）
|
||||
# 验证规则: 必填（required=True），最大长度50字符
|
||||
# 业务说明: 用于在代码中获取模板，如"USER_EXPORT"、"SMS_VERIFY_CODE"
|
||||
# 建议: 使用大写字母和下划线
|
||||
code = forms.CharField(
|
||||
required=True,
|
||||
max_length=50,
|
||||
error_messages={
|
||||
'required': '模板编码不能为空',
|
||||
'max_length': '模板编码长度不得超过50个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 文件名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 上传时的原始文件名
|
||||
# 字段类型: 字符型（CharField）
|
||||
# 验证规则: 可选填（required=False），最大长度255字符
|
||||
# 业务说明: 如"用户导出模板.xlsx"、"短信模板.txt"
|
||||
fileName = forms.CharField(
|
||||
required=False,
|
||||
max_length=255,
|
||||
error_messages={
|
||||
'max_length': '文件名称长度不得超过255个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 文件路径
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 文件的存储路径
|
||||
# 字段类型: 字符型（CharField）
|
||||
# 验证规则: 可选填（required=False），最大长度255字符
|
||||
# 业务说明: 如"/templates/user_export.xlsx"
|
||||
filePath = 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之间',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 备注
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的说明信息
|
||||
# 字段类型: 字符型（CharField）
|
||||
# 验证规则: 可选填（required=False），最大长度255字符
|
||||
# 业务说明: 存储模板的用途描述、使用说明等附加信息
|
||||
note = forms.CharField(
|
||||
required=False,
|
||||
max_length=255,
|
||||
error_messages={
|
||||
'max_length': '备注长度不得超过255个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# =============================================================
|
||||
# 表单元数据配置
|
||||
# =============================================================
|
||||
|
||||
class Meta:
|
||||
"""
|
||||
表单元数据配置类
|
||||
|
||||
定义表单绑定的模型和需要验证的字段。
|
||||
"""
|
||||
|
||||
# 绑定模型
|
||||
# 指定该表单对应的数据模型为 FileTemplate（文件模板）
|
||||
model = models.FileTemplate
|
||||
|
||||
# 指定需要验证的字段
|
||||
# 只验证以下字段，其他字段不进行表单验证
|
||||
fields = [
|
||||
'name',
|
||||
'code',
|
||||
'fileName',
|
||||
'filePath',
|
||||
'sort',
|
||||
'note'
|
||||
]
|
||||
@@ -0,0 +1,39 @@
|
||||
# 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='FileTemplate',
|
||||
fields=[
|
||||
('name', models.CharField(blank=True, db_comment='模板名称', db_default=None, db_index=True, default=None, help_text='模板名称', max_length=100, null=True, verbose_name='模板名称')),
|
||||
('code', models.CharField(blank=True, db_comment='模板编码', db_default=None, db_index=True, default=None, help_text='模板编码，建议使用大写字母和下划线', max_length=50, null=True, verbose_name='模板编码')),
|
||||
('file_name', models.CharField(blank=True, db_comment='文件名称', db_default=None, default=None, help_text='文件名称', max_length=255, null=True, verbose_name='文件名称')),
|
||||
('file_path', models.CharField(blank=True, db_comment='文件路径', db_default=None, default=None, help_text='文件路径', max_length=255, null=True, verbose_name='文件路径')),
|
||||
('note', models.CharField(db_comment='文件模板备注', help_text='文件模板备注', max_length=255, null=True, verbose_name='文件模板备注')),
|
||||
('sort', models.IntegerField(db_comment='文件模板顺序', db_default=0, default=0, help_text='文件模板顺序', 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_file_template',
|
||||
'db_table_comment': '模板名称',
|
||||
'ordering': ('-create_time',),
|
||||
'indexes': [models.Index(fields=['code'], name='idx_file_template_code'), models.Index(fields=['name'], name='idx_file_template_name')],
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,280 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板模型模块
|
||||
=============================================================
|
||||
|
||||
该模块定义了文件模板相关的数据库模型。
|
||||
文件模板用于存储系统中的各类模板文件，通过编码（code）进行唯一标识。
|
||||
"""
|
||||
|
||||
from django.db import models
|
||||
|
||||
from application.models import BaseModel
|
||||
from utils.common import get_file_url, get_table_name
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 文件模板模型类
|
||||
# =============================================================
|
||||
|
||||
class FileTemplate(BaseModel):
|
||||
"""
|
||||
文件模板模型类
|
||||
|
||||
用于存储系统中的文件模板信息，支持各类业务模板的管理。
|
||||
模板通过编码（code）进行唯一标识，便于在代码中动态获取和使用。
|
||||
继承自 BaseModel，自动包含：
|
||||
- id: 主键
|
||||
- is_delete: 逻辑删除标识
|
||||
- create_user: 创建人
|
||||
- create_time: 创建时间
|
||||
- update_user: 更新人
|
||||
- update_time: 更新时间
|
||||
|
||||
主要业务字段：
|
||||
- name: 模板名称，如"用户导出模板"
|
||||
- code: 模板编码，唯一标识，如"USER_EXPORT"
|
||||
- file_name: 文件名称，上传时的原始文件名
|
||||
- file_path: 文件路径，存储路径
|
||||
- sort: 排序值，控制显示顺序
|
||||
- note: 备注说明
|
||||
"""
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 模板名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的显示名称
|
||||
# 字段类型: 字符串（CharField）
|
||||
# 约束: 最大长度100字符，允许为空（blank=True, null=True）
|
||||
# 索引: 添加了数据库索引（db_index=True）以支持名称搜索
|
||||
# 示例: "用户导出模板"、"短信验证码模板"
|
||||
# 作用: 用于前端展示模板名称
|
||||
name = models.CharField(
|
||||
max_length=100,
|
||||
blank=True,
|
||||
null=True,
|
||||
default=None,
|
||||
db_index=True,
|
||||
verbose_name="模板名称",
|
||||
help_text="模板名称",
|
||||
db_comment='模板名称', # 数据库字段注释
|
||||
db_default=None
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 模板编码
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的唯一标识
|
||||
# 字段类型: 字符串（CharField）
|
||||
# 约束: 最大长度50字符，允许为空（blank=True, null=True）
|
||||
# 索引: 添加了数据库索引（db_index=True）以支持编码查询
|
||||
# 示例: "USER_EXPORT"、"SMS_VERIFY_CODE"
|
||||
# 建议: 使用大写字母和下划线，如 "USER_EXPORT"
|
||||
# 作用: 用于在代码中通过编码获取模板
|
||||
code = models.CharField(
|
||||
max_length=50,
|
||||
blank=True,
|
||||
null=True,
|
||||
default=None,
|
||||
db_index=True,
|
||||
verbose_name="模板编码",
|
||||
help_text="模板编码，建议使用大写字母和下划线",
|
||||
db_comment='模板编码', # 数据库字段注释
|
||||
db_default=None
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 文件名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 上传时的原始文件名
|
||||
# 字段类型: 字符串（CharField）
|
||||
# 约束: 最大长度255字符，允许为空（blank=True, null=True）
|
||||
# 示例: "用户导出模板.xlsx"、"短信模板.txt"
|
||||
# 作用: 用于下载时提供原始文件名
|
||||
file_name = models.CharField(
|
||||
max_length=255,
|
||||
blank=True,
|
||||
null=True,
|
||||
default=None,
|
||||
verbose_name="文件名称",
|
||||
help_text="文件名称",
|
||||
db_comment='文件名称', # 数据库字段注释
|
||||
db_default=None
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 文件路径
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 文件的存储路径
|
||||
# 字段类型: 字符串（CharField）
|
||||
# 约束: 最大长度255字符，允许为空（blank=True, null=True）
|
||||
# 示例: "/templates/user_export.xlsx"
|
||||
# 作用: 存储文件的实际路径，通过 full_file_path 属性获取完整URL
|
||||
file_path = models.CharField(
|
||||
max_length=255,
|
||||
blank=True,
|
||||
null=True,
|
||||
default=None,
|
||||
verbose_name="文件路径",
|
||||
help_text="文件路径",
|
||||
db_comment='文件路径', # 数据库字段注释
|
||||
db_default=None
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 备注
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 模板的说明信息
|
||||
# 字段类型: 字符串（CharField）
|
||||
# 约束: 允许为空（null=True），最大长度255字符
|
||||
# 作用: 存储模板的用途描述、使用说明等附加信息
|
||||
note = models.CharField(
|
||||
null=True,
|
||||
max_length=255,
|
||||
verbose_name="文件模板备注",
|
||||
help_text="文件模板备注",
|
||||
db_comment='文件模板备注' # 数据库字段注释
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 排序
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 控制模板的显示顺序
|
||||
# 字段类型: 整数（IntegerField）
|
||||
# 约束: 默认值为0
|
||||
# 排序规则: 数字越小越靠前
|
||||
# 作用: 手动控制模板在列表中的显示顺序
|
||||
sort = models.IntegerField(
|
||||
default=0,
|
||||
verbose_name="文件模板顺序",
|
||||
help_text="文件模板顺序",
|
||||
db_comment='文件模板顺序', # 数据库字段注释
|
||||
db_default=0
|
||||
)
|
||||
|
||||
# =============================================================
|
||||
# 模型元数据配置
|
||||
# =============================================================
|
||||
|
||||
class Meta:
|
||||
"""
|
||||
模型元数据配置类
|
||||
|
||||
定义模型在数据库中的表名、显示名称、默认排序规则等。
|
||||
"""
|
||||
|
||||
# 数据表名
|
||||
# 使用配置文件中的表前缀 + "file_template"，避免与其他应用表名冲突
|
||||
db_table = get_table_name('file_template')
|
||||
|
||||
# 数据表注释
|
||||
db_table_comment = "模板名称"
|
||||
|
||||
# 模型在admin后台显示的友好名称（单数）
|
||||
verbose_name = "文件模板表"
|
||||
|
||||
# 模型在admin后台显示的友好名称（复数）
|
||||
verbose_name_plural = verbose_name
|
||||
|
||||
# 默认排序规则
|
||||
# 按照创建时间倒序排列，最新的在前
|
||||
ordering = ("-create_time",)
|
||||
|
||||
# 索引定义
|
||||
# 为常用查询字段添加索引，提高查询效率
|
||||
indexes = [
|
||||
models.Index(fields=['code'], name='idx_file_template_code'),
|
||||
models.Index(fields=['name'], name='idx_file_template_name'),
|
||||
]
|
||||
|
||||
# =============================================================
|
||||
# 实例方法
|
||||
# =============================================================
|
||||
|
||||
def __str__(self):
|
||||
"""
|
||||
模型的字符串表示方法
|
||||
|
||||
当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。
|
||||
|
||||
Returns:
|
||||
str: 包含模板名称和编码的字符串
|
||||
"""
|
||||
return f'文件模板{self.name or ""}[{self.code or ""}]'
|
||||
|
||||
@property
|
||||
def full_file_path(self):
|
||||
"""
|
||||
获取文件的完整访问路径
|
||||
|
||||
属性方法，返回文件的完整访问路径。
|
||||
如果 file_path 已经是完整URL则直接返回，否则拼接完整访问路径。
|
||||
|
||||
Returns:
|
||||
str: 文件的完整访问URL，如果 file_path 为空则返回空字符串
|
||||
"""
|
||||
if not self.file_path:
|
||||
return ''
|
||||
|
||||
# 如果已经是完整URL（以 http:// 或 https:// 开头），则直接返回
|
||||
if self.file_path.startswith(('http://', 'https://')):
|
||||
return self.file_path
|
||||
|
||||
# 拼接完整URL
|
||||
return get_file_url(self.file_path)
|
||||
|
||||
@property
|
||||
def file_extension(self):
|
||||
"""
|
||||
获取文件扩展名
|
||||
|
||||
属性方法，从 file_name 中提取文件扩展名。
|
||||
|
||||
Returns:
|
||||
str: 文件扩展名（不含点），如果没有扩展名则返回空字符串
|
||||
"""
|
||||
if not self.file_name:
|
||||
return ''
|
||||
|
||||
import os
|
||||
return os.path.splitext(self.file_name)[1][1:].lower()
|
||||
@@ -0,0 +1,464 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板管理服务模块
|
||||
=============================================================
|
||||
|
||||
该模块实现了文件模板管理相关的所有业务逻辑。
|
||||
包括文件模板的分页查询、详情查询、添加、更新、删除等功能。
|
||||
文件模板用于存储系统中的各类模板文件，如导出模板、打印模板、消息模板等，
|
||||
通过编码（code）进行唯一标识，便于在代码中动态获取和使用。
|
||||
|
||||
命名规范：
|
||||
- 函数参数使用驼峰命名（如 templateId, pageNo）
|
||||
- 表单字段使用下划线命名（如 name, code, file_name, file_path）- 与数据库字段保持一致
|
||||
- 返回数据使用驼峰命名（如 createUser, updateTime）- 与前端规范保持一致
|
||||
- 私有函数以下划线开头（如 _apply_filters, _build_page_data）
|
||||
|
||||
功能模块：
|
||||
1. 分页查询：支持按名称/编码模糊搜索，按sort字段排序
|
||||
2. 详情查询：根据ID获取单个模板的详细信息
|
||||
3. 数据维护：模板的添加、更新、删除（支持批量）
|
||||
4. 编码检查：验证模板编码是否唯一
|
||||
5. 根据编码查询：通过编码获取模板信息
|
||||
"""
|
||||
|
||||
import logging
|
||||
|
||||
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
|
||||
|
||||
from application.file_template import forms
|
||||
from application.file_template.models import FileTemplate
|
||||
from constant.constants import PAGE_SIZE
|
||||
from utils import R, regular
|
||||
from utils.common import format_datetime, get_file_url, parse_request_body, save_file
|
||||
from utils.security import get_username
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 分页查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_file_template_page(request):
|
||||
"""
|
||||
查询文件模板分页数据
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含查询参数
|
||||
- pageNo: 当前页码（可选，默认为1）
|
||||
- pageSize: 每页记录数（可选，默认为PAGE_SIZE）
|
||||
- name: 模板名称（可选，模糊查询）
|
||||
- code: 模板编码（可选，模糊查询）
|
||||
|
||||
Returns:
|
||||
R: 包含分页数据的JSON响应
|
||||
"""
|
||||
try:
|
||||
# 获取分页参数
|
||||
page_no = int(request.GET.get('pageNo', 1))
|
||||
page_size = int(request.GET.get('pageSize', PAGE_SIZE))
|
||||
|
||||
# 构建基础查询（只查询未删除的记录）
|
||||
query = FileTemplate.objects.filter(is_delete=False)
|
||||
|
||||
# 应用筛选条件
|
||||
query = _apply_filters(query, request)
|
||||
|
||||
# 排序：按 sort 升序，再按创建时间降序
|
||||
query = query.order_by("sort", "-create_time")
|
||||
|
||||
# 执行分页查询
|
||||
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,
|
||||
'fileName': item.file_name,
|
||||
'filePath': get_file_url(item.file_path) if item.file_path else "",
|
||||
'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_file_template_detail(template_id):
|
||||
"""
|
||||
根据ID查询文件模板详情
|
||||
|
||||
Args:
|
||||
template_id: 模板ID
|
||||
|
||||
Returns:
|
||||
dict/None: 模板详情字典，不存在时返回None
|
||||
"""
|
||||
try:
|
||||
# 查询未删除的模板记录
|
||||
template = FileTemplate.objects.filter(is_delete=False, id=template_id).first()
|
||||
if not template:
|
||||
return None
|
||||
|
||||
# 返回详情数据
|
||||
return {
|
||||
'id': template.id,
|
||||
'name': template.name,
|
||||
'code': template.code,
|
||||
'fileName': template.file_name,
|
||||
'filePath': get_file_url(template.file_path),
|
||||
'sort': template.sort,
|
||||
'note': template.note,
|
||||
}
|
||||
except Exception as e:
|
||||
logging.error(f"查询文件模板详情异常，ID: {template_id}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 编码查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_file_template_by_code(template_code):
|
||||
"""
|
||||
根据编码查询文件模板
|
||||
|
||||
通常用于业务代码中通过编码动态获取模板信息。
|
||||
|
||||
Args:
|
||||
template_code: 模板编码
|
||||
|
||||
Returns:
|
||||
dict/None: 模板信息字典，不存在时返回None
|
||||
"""
|
||||
try:
|
||||
# 根据编码查询未删除的模板
|
||||
template = FileTemplate.objects.filter(is_delete=False, code=template_code).first()
|
||||
if not template:
|
||||
return None
|
||||
|
||||
return {
|
||||
'id': template.id,
|
||||
'name': template.name,
|
||||
'code': template.code,
|
||||
'fileName': template.file_name,
|
||||
'filePath': get_file_url(template.file_path) if template.file_path else None,
|
||||
'note': template.note,
|
||||
}
|
||||
except Exception as e:
|
||||
logging.error(f"根据编码查询文件模板异常，code: {template_code}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 编码检查服务
|
||||
# =============================================================
|
||||
|
||||
def check_code_exists(code, exclude_id=None):
|
||||
"""
|
||||
检查模板编码是否存在
|
||||
|
||||
用于添加/更新时的编码唯一性验证。
|
||||
|
||||
Args:
|
||||
code: 模板编码
|
||||
exclude_id: 排除的模板ID（更新时使用，避免与自身冲突）
|
||||
|
||||
Returns:
|
||||
bool: 编码是否存在
|
||||
"""
|
||||
try:
|
||||
queryset = FileTemplate.objects.filter(is_delete=False, code=code)
|
||||
if exclude_id:
|
||||
queryset = queryset.exclude(id=exclude_id)
|
||||
return queryset.exists()
|
||||
except Exception as e:
|
||||
logging.error(f"检查模板编码异常，code: {code}, 错误: {str(e)}")
|
||||
return False
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 添加服务
|
||||
# =============================================================
|
||||
|
||||
def add_file_template(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.FileTemplateForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 检查编码是否已存在
|
||||
code = cleaned_data.get('code')
|
||||
if check_code_exists(code):
|
||||
return R.failed(msg=f"模板编码 '{code}' 已存在")
|
||||
|
||||
# 处理文件路径（保存文件到 file 目录）
|
||||
file_path = cleaned_data.get('filePath')
|
||||
if file_path:
|
||||
file_path = save_file(file_path, "file")
|
||||
|
||||
try:
|
||||
# 创建文件模板记录
|
||||
FileTemplate.objects.create(
|
||||
name=cleaned_data.get('name'),
|
||||
code=code,
|
||||
file_name=cleaned_data.get('fileName', ''),
|
||||
file_path=file_path,
|
||||
sort=data.get('sort', 0),
|
||||
note=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_file_template(request):
|
||||
"""
|
||||
更新文件模板
|
||||
|
||||
处理流程：
|
||||
1. 解析请求体中的JSON数据
|
||||
2. 验证模板ID
|
||||
3. 表单验证
|
||||
4. 查询现有记录
|
||||
5. 检查编码唯一性（排除自身）
|
||||
6. 处理文件路径（如有变化则保存新文件）
|
||||
7. 更新各字段
|
||||
8. 保存更新
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含模板ID和更新信息的JSON数据
|
||||
|
||||
Returns:
|
||||
R: 操作结果（成功/失败）
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 验证模板ID
|
||||
template_id = data.get('id')
|
||||
if not template_id or not str(template_id).isdigit() or int(template_id) <= 0:
|
||||
return R.failed("模板ID无效")
|
||||
template_id = int(template_id)
|
||||
|
||||
# 表单验证
|
||||
form = forms.FileTemplateForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
try:
|
||||
# 查询模板记录
|
||||
template = FileTemplate.objects.filter(id=template_id, is_delete=False).first()
|
||||
if not template:
|
||||
return R.failed("模板不存在")
|
||||
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 检查编码是否已存在（排除自身）
|
||||
code = cleaned_data.get('code')
|
||||
if code != template.code and check_code_exists(code, exclude_id=template_id):
|
||||
return R.failed(msg=f"模板编码 '{code}' 已存在")
|
||||
|
||||
# 处理文件路径（如有新文件则保存）
|
||||
file_path = cleaned_data.get('filePath')
|
||||
if file_path:
|
||||
file_path = save_file(file_path, "file")
|
||||
|
||||
# 更新各字段
|
||||
template.name = cleaned_data.get('name')
|
||||
template.code = code
|
||||
template.file_name = cleaned_data.get('fileName', '')
|
||||
template.file_path = file_path
|
||||
|
||||
# 可选字段更新
|
||||
if 'sort' in data:
|
||||
template.sort = int(data.get('sort', 0))
|
||||
if 'note' in data:
|
||||
template.note = data.get('note', '')
|
||||
|
||||
template.update_user = get_username(request)
|
||||
template.save()
|
||||
|
||||
return R.ok(msg="更新成功")
|
||||
except Exception as e:
|
||||
logging.error(f"更新文件模板异常，ID: {template_id}, 错误: {str(e)}")
|
||||
return R.failed(msg="更新失败，请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 删除服务（支持批量）
|
||||
# =============================================================
|
||||
|
||||
def delete_file_templates(template_ids):
|
||||
"""
|
||||
删除文件模板（批量删除）
|
||||
|
||||
采用逻辑删除方式（is_delete=True），而非物理删除。
|
||||
支持逗号分隔的多个ID。
|
||||
|
||||
Args:
|
||||
template_ids: 模板ID字符串，多个ID用逗号分隔
|
||||
例如: "1" 或 "1,2,3"
|
||||
|
||||
Returns:
|
||||
R: 操作结果，包含删除数量
|
||||
"""
|
||||
if not template_ids:
|
||||
return R.failed("记录ID不存在")
|
||||
|
||||
try:
|
||||
# 解析ID列表
|
||||
id_list = [int(id_str.strip()) for id_str in template_ids.split(',') if id_str.strip()]
|
||||
if not id_list:
|
||||
return R.failed("无效的记录ID")
|
||||
|
||||
# 批量更新删除标识（逻辑删除）
|
||||
updated_count = FileTemplate.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: {template_ids}, 错误: {str(e)}")
|
||||
return R.failed(msg="删除失败，请稍后重试")
|
||||
@@ -0,0 +1,3 @@
|
||||
from django.test import TestCase
|
||||
|
||||
# Create your tests here.
|
||||
@@ -0,0 +1,119 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板模块路由配置
|
||||
=============================================================
|
||||
|
||||
该模块定义了文件模板管理相关的API路由端点，提供文件模板的增删改查功能。
|
||||
文件模板用于存储系统中的各类模板文件，通过编码（code）进行唯一标识，
|
||||
便于在代码中动态获取和使用模板文件。
|
||||
|
||||
URL端点概览：
|
||||
------------------------------------------------------------------------
|
||||
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|
||||
|-----------------|----------|-----------------------------|-------------------------|
|
||||
| 分页查询 | GET | /file/template/page | FileTemplatePageView |
|
||||
| 详情查询 | GET | /file/template/detail/<id> | FileTemplateDetailView |
|
||||
| 添加模板 | POST | /file/template/add | FileTemplateAddView |
|
||||
| 更新模板 | PUT | /file/template/update | FileTemplateUpdateView |
|
||||
| 删除模板 | DELETE | /file/template/delete/<ids> | FileTemplateDeleteView |
|
||||
------------------------------------------------------------------------
|
||||
|
||||
URL参数说明：
|
||||
- template_id: int类型，模板ID（用于查询详情）
|
||||
- template_ids: str类型，逗号分隔的模板ID字符串（用于批量删除）
|
||||
- code: str类型，模板编码（用于根据编码查询）
|
||||
|
||||
使用示例：
|
||||
1. 分页查询：GET /api/file/template/page?pageNo=1&pageSize=10&name=用户导出
|
||||
2. 详情查询：GET /api/file/template/detail/5
|
||||
3. 添加模板：POST /api/file/template/add
|
||||
4. 更新模板：PUT /api/file/template/update
|
||||
5. 删除模板：DELETE /api/file/template/delete/1,2,3
|
||||
"""
|
||||
|
||||
from django.urls import path
|
||||
from application.file_template import views
|
||||
|
||||
# 文件模板模块路由配置
|
||||
urlpatterns = [
|
||||
# 查询模板分页列表
|
||||
# URL: /file/template/page
|
||||
# 请求方法: GET
|
||||
# 功能: 获取文件模板分页数据，支持按名称、编码等条件筛选
|
||||
# 查询参数: pageNo(页码), pageSize(每页条数), name(模板名称), code(模板编码)
|
||||
path('page', views.FileTemplatePageView.as_view()),
|
||||
|
||||
# 查询模板详情
|
||||
# URL: /file/template/detail/<int:template_id>
|
||||
# 请求方法: GET
|
||||
# URL参数: template_id - 模板ID（整数类型）
|
||||
# 功能: 根据ID获取指定文件模板的详细信息
|
||||
path('detail/<int:template_id>', views.FileTemplateDetailView.as_view()),
|
||||
|
||||
# 添加模板
|
||||
# URL: /file/template/add
|
||||
# 请求方法: POST
|
||||
# 功能: 创建新的文件模板记录，请求体需包含模板信息（名称、编码、文件名称、文件路径等）
|
||||
# 注意: 编码(code)在同一租户下必须唯一
|
||||
path('add', views.FileTemplateAddView.as_view()),
|
||||
|
||||
# 更新模板
|
||||
# URL: /file/template/update
|
||||
# 请求方法: PUT
|
||||
# 功能: 更新现有文件模板信息，请求体需包含模板ID和更新内容
|
||||
path('update', views.FileTemplateUpdateView.as_view()),
|
||||
|
||||
# 删除模板
|
||||
# URL: /file/template/delete/<str:template_ids>
|
||||
# 请求方法: DELETE
|
||||
# URL参数: template_ids - 模板ID字符串，支持单个ID或逗号分隔的多个ID（如 "1,2,3"）
|
||||
# 功能: 删除指定文件模板（逻辑删除，设置is_delete=1）
|
||||
path('delete/<str:template_ids>', views.FileTemplateDeleteView.as_view()),
|
||||
|
||||
# 根据编码查询模板
|
||||
# URL: /file/template/getTemplateByCode/<str:template_code>
|
||||
# 请求方法: GET
|
||||
# URL参数: template_code - 模板编码（字符串类型）
|
||||
# 功能: 根据模板编码获取指定文件模板的详细信息
|
||||
path('getTemplateByCode/<str:template_code>', views.FileTemplateInfoView.as_view()),
|
||||
]
|
||||
@@ -0,0 +1,316 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板管理视图模块
|
||||
=============================================================
|
||||
|
||||
该模块定义了文件模板管理功能中使用的所有视图类。
|
||||
用于处理文件模板信息的HTTP请求，包括分页查询、详情查询、添加、更新、删除、
|
||||
根据编码查询、文件上传、文件下载等操作。文件模板用于存储系统中的各类模板文件，
|
||||
通过编码（code）进行唯一标识，便于在代码中动态获取和使用。
|
||||
|
||||
每个视图类对应一个特定的API端点，处理相应的业务逻辑。
|
||||
"""
|
||||
|
||||
from django.utils.decorators import method_decorator
|
||||
from django.views import View
|
||||
|
||||
from application.file_template 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 FileTemplatePageView(PermissionRequired, View):
|
||||
"""
|
||||
文件模板分页数据查询视图
|
||||
|
||||
处理GET请求，返回文件模板列表的分页数据。
|
||||
支持按模板名称、编码等条件筛选。
|
||||
|
||||
URL: /file/template/page
|
||||
请求方法: GET
|
||||
权限要求：sys:filetemplate:page
|
||||
|
||||
查询参数:
|
||||
pageNo: int, 当前页码，默认1
|
||||
pageSize: int, 每页记录数，默认10
|
||||
name: str, 模板名称（可选，模糊查询）
|
||||
code: str, 模板编码（可选，模糊查询）
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:filetemplate:page",)
|
||||
|
||||
@operation_log(
|
||||
title="文件模板-查询分页列表",
|
||||
log_type=LogType.QUERY
|
||||
)
|
||||
def get(self, request):
|
||||
"""
|
||||
处理GET请求，返回文件模板分页数据
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含分页参数和筛选条件
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含分页数据的JSON响应
|
||||
"""
|
||||
result = services.get_file_template_page(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 详情查询视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="get")
|
||||
class FileTemplateDetailView(PermissionRequired, View):
|
||||
"""
|
||||
文件模板详情查询视图
|
||||
|
||||
处理GET请求，根据模板ID返回文件模板详细信息。
|
||||
|
||||
URL: /file/template/detail/<int:template_id>
|
||||
请求方法: GET
|
||||
URL参数: template_id - 模板ID
|
||||
权限要求：sys:filetemplate:detail
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:filetemplate:detail",)
|
||||
|
||||
@operation_log(
|
||||
title="文件模板-查询记录详情",
|
||||
log_type=LogType.QUERY
|
||||
)
|
||||
def get(self, request, template_id):
|
||||
"""
|
||||
处理GET请求，返回文件模板详情
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
template_id: int, 模板ID（从URL中获取）
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含模板详细信息的JSON响应
|
||||
"""
|
||||
data = services.get_file_template_detail(template_id)
|
||||
if data is None:
|
||||
return R.failed("文件模板不存在")
|
||||
return R.ok(data=data)
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 添加视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="post")
|
||||
class FileTemplateAddView(PermissionRequired, View):
|
||||
"""
|
||||
添加文件模板视图
|
||||
|
||||
处理POST请求，创建新的文件模板记录。
|
||||
注意：模板编码在同一租户下必须唯一。
|
||||
|
||||
URL: /file/template/add
|
||||
请求方法: POST
|
||||
权限要求：sys:filetemplate:add
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:filetemplate: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_file_template(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 更新视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="put")
|
||||
class FileTemplateUpdateView(PermissionRequired, View):
|
||||
"""
|
||||
更新文件模板视图
|
||||
|
||||
处理PUT请求，更新现有文件模板信息。
|
||||
|
||||
URL: /file/template/update
|
||||
请求方法: PUT
|
||||
权限要求：sys:filetemplate:update
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ('sys:filetemplate: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_file_template(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 删除视图（支持批量）
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="delete")
|
||||
class FileTemplateDeleteView(PermissionRequired, View):
|
||||
"""
|
||||
删除文件模板视图
|
||||
|
||||
处理DELETE请求，删除指定文件模板（支持批量删除）。
|
||||
删除操作是逻辑删除，设置 is_delete=True。
|
||||
|
||||
URL: /file/template/delete/<str:template_ids>
|
||||
请求方法: DELETE
|
||||
URL参数: template_ids - 模板ID字符串，多个ID用逗号分隔
|
||||
权限要求：sys:filetemplate:delete
|
||||
|
||||
注意: 删除模板后，相关业务可能无法正常使用，请谨慎操作
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ('sys:filetemplate:delete',)
|
||||
|
||||
@operation_log(
|
||||
title="文件模板-删除记录",
|
||||
log_type=LogType.DELETE
|
||||
)
|
||||
def delete(self, request, template_ids):
|
||||
"""
|
||||
处理DELETE请求，删除文件模板
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
template_ids: str, 模板ID字符串，多个ID用逗号分隔（从URL中获取）
|
||||
例如: "1" 或 "1,2,3"
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含操作结果的JSON响应
|
||||
"""
|
||||
# 演示环境禁止操作
|
||||
if DJANGO_DEMO:
|
||||
return R.failed("演示环境，暂无操作权限")
|
||||
|
||||
result = services.delete_file_templates(template_ids)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 根据编码查询视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="get")
|
||||
class FileTemplateInfoView(PermissionRequired, View):
|
||||
"""
|
||||
文件模板查询视图（根据编码）
|
||||
|
||||
处理GET请求，根据模板编码返回文件模板详细信息。
|
||||
通常用于业务代码中通过编码获取模板路径。
|
||||
|
||||
URL: /file/template/info/<str:template_code>
|
||||
请求方法: GET
|
||||
URL参数: template_code - 模板编码
|
||||
权限要求：sys:filetemplate:info
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:filetemplate:info",)
|
||||
|
||||
def get(self, request, template_code):
|
||||
"""
|
||||
处理GET请求，返回文件模板详情
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
template_code: str, 模板编码（从URL中获取）
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含模板详细信息的JSON响应
|
||||
"""
|
||||
data = services.get_file_template_by_code(template_code)
|
||||
if data is None:
|
||||
return R.failed("文件模板不存在")
|
||||
return R.ok(data=data)
|
||||
Reference in New Issue
Block a user