签入版本
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
"""
|
||||
案例模块
|
||||
=============================================================
|
||||
|
||||
该模块包含案例相关的模型、视图、表单、服务等代码。
|
||||
"""
|
||||
|
||||
# 模块初始化文件,使该目录成为一个Python包
|
||||
# 可以通过以下方式导入模块中的内容:
|
||||
# from application.example import models, views, forms
|
||||
@@ -0,0 +1,3 @@
|
||||
from django.contrib import admin
|
||||
|
||||
# Register your models here.
|
||||
@@ -0,0 +1,77 @@
|
||||
# +======================================================================
|
||||
# | 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 ExampleConfig(AppConfig):
|
||||
"""
|
||||
案例应用配置类
|
||||
|
||||
该类用于配置 'application.example' 应用的基本属性和行为。
|
||||
继承自 Django 的 AppConfig 基类,在 Django 启动时自动加载。
|
||||
|
||||
主要功能:
|
||||
- 指定应用的默认主键字段类型
|
||||
- 定义应用的 Python 导入路径
|
||||
- 可在 ready() 方法中执行应用启动时的初始化操作
|
||||
"""
|
||||
|
||||
# 默认主键字段类型配置
|
||||
# BigAutoField:64位整数自增主键,范围更大(-9223372036854775808 到 9223372036854775807)
|
||||
# 相比默认的 AutoField(32位整数),BigAutoField 的优势:
|
||||
# 1. 支持更大的数据量,适合高并发、大数据量场景
|
||||
# 2. 避免主键溢出的风险,提高系统稳定性
|
||||
# 3. 与分布式系统兼容性更好
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
|
||||
# 应用导入路径配置
|
||||
# 指定该应用在项目中的 Python 导入路径,格式为 '模块名.应用名'
|
||||
# 该路径必须与 INSTALLED_APPS 设置中的路径完全一致
|
||||
# 例如:'application.example' 表示应用位于 application/example 目录下
|
||||
name = 'application.example'
|
||||
@@ -0,0 +1,180 @@
|
||||
# +======================================================================
|
||||
# | 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.example import models
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 案例表单验证类
|
||||
# =============================================================
|
||||
|
||||
class ExampleForm(forms.ModelForm):
|
||||
"""
|
||||
案例表单验证类
|
||||
|
||||
用于创建和更新案例信息时的表单验证。
|
||||
包含案例名称, 案例图片, 案例类型等属性
|
||||
|
||||
验证字段包括:
|
||||
- name: 案例名称
|
||||
- avatar: 案例图片
|
||||
- type: 案例类型
|
||||
- status: 案例状态(1-正常, 2-禁用)
|
||||
- sort: 排序
|
||||
"""
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的名称
|
||||
# 字段类型: 字符串(CharField)
|
||||
# 验证规则: 必填(required=True),最大长度100字符
|
||||
# 业务说明: 案例的核心标识字段,用于列表展示和搜索
|
||||
name = forms.CharField(
|
||||
required=True,
|
||||
max_length=100,
|
||||
error_messages={
|
||||
'required': '案例名称不能为空',
|
||||
'max_length': '案例名称长度不得超过100个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例图片
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的图片
|
||||
# 字段类型: 字符串(CharField)
|
||||
# 验证规则: 可选(required=False),最大长度255字符
|
||||
# 业务说明: 用于案例列表展示和详情页的图片
|
||||
avatar = forms.CharField(
|
||||
required=False,
|
||||
max_length=255,
|
||||
error_messages={
|
||||
'max_length': '案例图片长度不得超过255个字符',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例类型
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的分类类型
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 验证规则: 必填(required=True),取值范围1-4
|
||||
# 业务说明: 对案例进行分类管理,支持按类型筛选
|
||||
type = forms.IntegerField(
|
||||
required=True,
|
||||
min_value=1,
|
||||
max_value=4,
|
||||
error_messages={
|
||||
'required': '案例类型不能为空',
|
||||
'min_value': '案例类型值不能小于1',
|
||||
'max_value': '案例类型值不能大于4',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例状态
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的显示状态
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 验证规则: 必填(required=True),取值范围1-2
|
||||
# 业务说明: 1-正常, 2-禁用,控制案例是否在前端展示
|
||||
status = forms.IntegerField(
|
||||
required=True,
|
||||
min_value=1,
|
||||
max_value=2,
|
||||
error_messages={
|
||||
'required': '案例状态不能为空',
|
||||
'min_value': '案例状态值不能小于1',
|
||||
'max_value': '案例状态值不能大于2',
|
||||
}
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 排序
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的排序权重
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 验证规则: 必填(required=True)
|
||||
# 排序规则: 数值越小越靠前
|
||||
# 业务说明: 手动控制案例在列表中的显示顺序
|
||||
sort = forms.IntegerField(
|
||||
required=True,
|
||||
error_messages={
|
||||
'required': '排序不能为空',
|
||||
}
|
||||
)
|
||||
|
||||
# =============================================================
|
||||
# 表单元数据配置
|
||||
# =============================================================
|
||||
|
||||
class Meta:
|
||||
"""
|
||||
表单元数据配置类
|
||||
|
||||
定义表单绑定的模型和需要验证的字段。
|
||||
"""
|
||||
|
||||
# 绑定模型
|
||||
# 指定该表单对应的数据模型为 Example(案例)
|
||||
model = models.Example
|
||||
|
||||
# 指定需要验证的字段
|
||||
# 只验证以下字段,其他字段不进行表单验证
|
||||
fields = [
|
||||
'name',
|
||||
'avatar',
|
||||
'type',
|
||||
'status',
|
||||
'sort',
|
||||
]
|
||||
@@ -0,0 +1 @@
|
||||
# 保持 migrations 目录在版本控制中
|
||||
@@ -0,0 +1,37 @@
|
||||
# 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='Example',
|
||||
fields=[
|
||||
('name', models.CharField(db_comment='案例名称', db_index=True, help_text='案例名称', max_length=100, verbose_name='案例名称')),
|
||||
('avatar', models.CharField(blank=True, db_comment='案例图片', help_text='案例图片', max_length=255, null=True, verbose_name='案例图片')),
|
||||
('type', models.IntegerField(choices=[(1, '类型1'), (2, '类型2'), (3, '类型3'), (4, '类型4')], db_comment='案例类型:1-类型1 2-类型2 3-类型3 4-类型4', help_text='案例类型:1-类型1 2-类型2 3-类型3 4-类型4', verbose_name='案例类型:1-类型1 2-类型2 3-类型3 4-类型4')),
|
||||
('status', models.IntegerField(choices=[(1, '正常'), (2, '禁用')], db_comment='案例状态:1-正常 2-禁用', help_text='案例状态:1-正常 2-禁用', verbose_name='案例状态:1-正常 2-禁用')),
|
||||
('sort', models.IntegerField(db_comment='排序', 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_example',
|
||||
'db_table_comment': '案例表',
|
||||
'ordering': ('sort',),
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,9 @@
|
||||
"""
|
||||
案例模块数据库迁移文件
|
||||
=============================================================
|
||||
|
||||
该目录包含Django生成的数据库迁移文件,用于管理数据库结构变更。
|
||||
"""
|
||||
|
||||
# Django迁移目录初始化文件
|
||||
# 该文件使migrations目录成为一个Python包,Django可以正确加载迁移文件
|
||||
@@ -0,0 +1,218 @@
|
||||
# +======================================================================
|
||||
# | 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 Example(BaseModel):
|
||||
"""
|
||||
案例模型类
|
||||
|
||||
用于存储系统中的案例信息。
|
||||
继承自 BaseModel,自动包含:
|
||||
- id: 主键
|
||||
- is_delete: 逻辑删除标识
|
||||
- create_user: 创建人
|
||||
- create_time: 创建时间
|
||||
- update_user: 更新人
|
||||
- update_time: 更新时间
|
||||
|
||||
主要业务字段:
|
||||
- name: 案例名称
|
||||
- avatar: 案例图片
|
||||
- type: 案例类型
|
||||
- status: 案例状态(1-正常, 2-禁用)
|
||||
- sort: 排序权重(数值越小越靠前)
|
||||
"""
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例名称
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的名称
|
||||
# 字段类型: 字符串(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=True, blank=True),最大长度255字符
|
||||
# 存储: 存储的是相对路径,通过 get_file_url() 生成完整访问URL
|
||||
# 作用: 用于案例列表展示和详情页的图片
|
||||
avatar = models.CharField(
|
||||
null=True,
|
||||
blank=True,
|
||||
max_length=255,
|
||||
verbose_name="案例图片",
|
||||
help_text="案例图片",
|
||||
db_comment='案例图片' # 数据库字段注释
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例类型
|
||||
# ----------------------------------------------------------
|
||||
# 类型常量定义
|
||||
TYPE_CHOICES = (
|
||||
(1, "类型1"),
|
||||
(2, "类型2"),
|
||||
(3, "类型3"),
|
||||
(4, "类型4"),
|
||||
)
|
||||
|
||||
# 字段说明: 案例的分类类型
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 约束: 非空(null=False)
|
||||
# 选择项: 使用 TYPE_CHOICES 限制可选值
|
||||
# 作用: 对案例进行分类管理,支持按类型筛选
|
||||
type = models.IntegerField(
|
||||
null=False,
|
||||
choices=TYPE_CHOICES,
|
||||
verbose_name="案例类型:1-类型1 2-类型2 3-类型3 4-类型4",
|
||||
help_text="案例类型:1-类型1 2-类型2 3-类型3 4-类型4",
|
||||
db_comment='案例类型:1-类型1 2-类型2 3-类型3 4-类型4' # 数据库字段注释
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 案例状态
|
||||
# ----------------------------------------------------------
|
||||
# 状态常量定义
|
||||
STATUS_CHOICES = (
|
||||
(1, "正常"), # 正常状态:案例正常显示
|
||||
(2, "禁用"), # 禁用状态:案例不对外展示
|
||||
)
|
||||
|
||||
# 字段说明: 案例的显示状态
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 约束: 非空(null=False)
|
||||
# 选择项: 使用 STATUS_CHOICES 限制可选值
|
||||
# 作用: 控制案例是否在前端展示
|
||||
status = models.IntegerField(
|
||||
null=False,
|
||||
choices=STATUS_CHOICES,
|
||||
verbose_name="案例状态:1-正常 2-禁用",
|
||||
help_text="案例状态:1-正常 2-禁用",
|
||||
db_comment='案例状态:1-正常 2-禁用' # 数据库字段注释
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------
|
||||
# 排序
|
||||
# ----------------------------------------------------------
|
||||
# 字段说明: 案例的排序权重
|
||||
# 字段类型: 整数(IntegerField)
|
||||
# 约束: 非空(null=False)
|
||||
# 排序规则: 数值越小越靠前(升序排列)
|
||||
# 作用: 手动控制案例在列表中的显示顺序
|
||||
sort = models.IntegerField(
|
||||
null=False,
|
||||
verbose_name="排序",
|
||||
help_text="排序",
|
||||
db_comment='排序' # 数据库字段注释
|
||||
)
|
||||
|
||||
# =============================================================
|
||||
# 模型元数据配置
|
||||
# =============================================================
|
||||
|
||||
class Meta:
|
||||
"""
|
||||
模型元数据配置类
|
||||
|
||||
定义模型在数据库中的表名、显示名称、默认排序规则等。
|
||||
"""
|
||||
|
||||
# 数据表名
|
||||
# 使用配置文件中的表前缀 + "example",避免与其他应用表名冲突
|
||||
db_table = get_table_name('example')
|
||||
|
||||
# 表注释(Django 3.2+ 支持)
|
||||
# 在数据库中生成 COMMENT 语句,便于数据库管理
|
||||
db_table_comment = "案例表"
|
||||
|
||||
# 模型在admin后台显示的友好名称(单数)
|
||||
verbose_name = "案例表"
|
||||
|
||||
# 模型在admin后台显示的友好名称(复数)
|
||||
verbose_name_plural = verbose_name
|
||||
|
||||
# 默认排序规则
|
||||
# 按照 sort 字段升序排列(数值小的在前),确保显示顺序可控
|
||||
ordering = ("sort",)
|
||||
|
||||
# =============================================================
|
||||
# 实例方法
|
||||
# =============================================================
|
||||
|
||||
def __str__(self):
|
||||
"""
|
||||
模型的字符串表示方法
|
||||
|
||||
当需要将模型实例转换为字符串时调用,如admin后台显示、日志输出等。
|
||||
|
||||
Returns:
|
||||
str: 包含案例名称的字符串
|
||||
"""
|
||||
return f"案例{self.name}"
|
||||
@@ -0,0 +1,538 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意,禁止将本产品用于以下任何行为:
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途;
|
||||
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为,本团队有权:
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
|
||||
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
案例管理服务模块
|
||||
=============================================================
|
||||
|
||||
该模块实现了案例管理相关的所有业务逻辑。
|
||||
包括案例的分页查询、详情查询、添加、更新、删除等功能。
|
||||
包含案例名称, 案例图片, 案例类型等属性
|
||||
|
||||
命名规范:
|
||||
- 函数参数使用驼峰命名(如 id, pageNo)
|
||||
- 表单字段使用下划线命名(如 name, avatar, type, status, sort)- 与数据库字段保持一致
|
||||
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
|
||||
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
|
||||
|
||||
功能模块:
|
||||
1. 分页查询:支持按案例名称搜索、案例类型搜索、案例状态搜索,按sort字段排序
|
||||
2. 详情查询:根据ID获取单个案例的详细信息
|
||||
3. 数据维护:案例的添加、更新、删除(支持批量)
|
||||
4. 状态管理:单独更新案例的启用/禁用状态
|
||||
5. 数据列表:获取所有启用的案例列表(用于下拉选择等场景)
|
||||
"""
|
||||
|
||||
import json
|
||||
import logging
|
||||
|
||||
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
|
||||
|
||||
from application.example import forms
|
||||
from application.example.models import Example
|
||||
from config.env import DJANGO_FILE_URL
|
||||
from constant.constants import PAGE_SIZE
|
||||
from utils import R, regular
|
||||
from utils.common import get_file_url, format_datetime, parse_request_body, save_file, save_content
|
||||
from utils.security import get_username
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 分页查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_example_page(request):
|
||||
"""
|
||||
查询案例分页数据
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含查询参数
|
||||
- pageNo: 当前页码(可选,默认为1)
|
||||
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
|
||||
- name: 案例名称(可选,模糊查询)
|
||||
- type: 案例类型(可选,精确匹配)
|
||||
- status: 案例状态(可选,精确匹配)
|
||||
|
||||
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 = Example.objects.filter(is_delete=False)
|
||||
|
||||
# 应用筛选条件
|
||||
query = _apply_filters(query, request)
|
||||
|
||||
# 按排序字段升序排列
|
||||
query = query.order_by("sort")
|
||||
|
||||
# 执行分页查询
|
||||
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)
|
||||
|
||||
# 案例类型筛选(精确匹配)
|
||||
type = request.GET.get('type')
|
||||
if type:
|
||||
queryset = queryset.filter(type=type)
|
||||
|
||||
# 案例状态筛选(精确匹配)
|
||||
status = request.GET.get('status')
|
||||
if status:
|
||||
queryset = queryset.filter(status=status)
|
||||
|
||||
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:
|
||||
record = {
|
||||
'id': item.id,
|
||||
'name': item.name,
|
||||
'avatar': get_file_url(item.avatar) if item.avatar else "",
|
||||
'type': item.type,
|
||||
'status': item.status,
|
||||
'sort': item.sort,
|
||||
'createUser': item.create_user,
|
||||
'createTime': format_datetime(item.create_time),
|
||||
'updateUser': item.update_user,
|
||||
'updateTime': format_datetime(item.update_time),
|
||||
}
|
||||
records.append(record)
|
||||
|
||||
return {
|
||||
'records': records,
|
||||
'total': paginator.count, # 总记录数
|
||||
'size': page_size, # 每页大小
|
||||
'current': page_no, # 当前页码
|
||||
'pages': paginator.num_pages # 总页数
|
||||
}
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 列表查询服务(不分页)
|
||||
# =============================================================
|
||||
|
||||
def get_example_list(request):
|
||||
"""
|
||||
获取案例列表(不分页,支持筛选条件)
|
||||
|
||||
与分页查询的区别:返回所有符合条件的记录,不分页。
|
||||
通常用于导出数据或内部调用。
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含查询参数
|
||||
- name: 案例名称(可选,模糊查询)
|
||||
- type: 案例类型(可选,精确匹配)
|
||||
- status: 案例状态(可选,精确匹配)
|
||||
|
||||
Returns:
|
||||
list: 案例列表,每个元素为案例模型字典
|
||||
查询失败时返回空列表
|
||||
"""
|
||||
try:
|
||||
# 构建基础查询
|
||||
query = Example.objects.filter(is_delete=False)
|
||||
|
||||
# 应用筛选条件(复用 _apply_filters 方法)
|
||||
query = _apply_filters(query, request)
|
||||
|
||||
# 按排序字段升序排列
|
||||
query = query.order_by("sort")
|
||||
|
||||
# 构建返回数据
|
||||
records = []
|
||||
for item in query:
|
||||
record = {
|
||||
'id': item.id,
|
||||
'name': item.name,
|
||||
'avatar': get_file_url(item.avatar) if item.avatar else "",
|
||||
'type': item.type,
|
||||
'status': item.status,
|
||||
'sort': item.sort,
|
||||
'createUser': item.create_user,
|
||||
'createTime': format_datetime(item.create_time),
|
||||
'updateUser': item.update_user,
|
||||
'updateTime': format_datetime(item.update_time),
|
||||
}
|
||||
records.append(record)
|
||||
|
||||
return records
|
||||
except Exception as e:
|
||||
logging.error(f"查询案例列表异常: {str(e)}")
|
||||
return []
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 详情查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_example_detail(id):
|
||||
"""
|
||||
根据ID查询案例详情
|
||||
|
||||
Args:
|
||||
id: 案例ID
|
||||
|
||||
Returns:
|
||||
dict/None: 案例详情字典,不存在时返回None
|
||||
"""
|
||||
try:
|
||||
# 查询未删除的案例记录
|
||||
instance = Example.objects.filter(is_delete=False, id=id).first()
|
||||
if not instance:
|
||||
return None
|
||||
|
||||
# 返回详情数据
|
||||
return {
|
||||
'id': instance.id,
|
||||
'name': instance.name,
|
||||
'avatar': get_file_url(instance.avatar) if instance.avatar else "",
|
||||
'type': instance.type,
|
||||
'status': instance.status,
|
||||
'sort': instance.sort,
|
||||
}
|
||||
except Exception as e:
|
||||
logging.error(f"查询案例详情异常,ID: {id}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 添加服务
|
||||
# =============================================================
|
||||
|
||||
def add_example(request):
|
||||
"""
|
||||
添加案例
|
||||
|
||||
处理流程:
|
||||
1. 解析请求体中的JSON数据
|
||||
2. 表单验证
|
||||
3. 处理头像图片(保存到 example 目录)
|
||||
4. 创建数据库记录
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含案例信息的JSON数据
|
||||
|
||||
Returns:
|
||||
R: 操作结果(成功/失败)
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 表单验证
|
||||
form = forms.ExampleForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
try:
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 处理头像图片
|
||||
avatar = cleaned_data.get('avatar')
|
||||
if avatar:
|
||||
avatar = save_file(avatar, "example")
|
||||
|
||||
# 创建案例记录
|
||||
Example.objects.create(
|
||||
name=cleaned_data.get('name'),
|
||||
avatar=avatar,
|
||||
type=cleaned_data.get('type'),
|
||||
status=cleaned_data.get('status'),
|
||||
sort=cleaned_data.get('sort'),
|
||||
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_example(request):
|
||||
"""
|
||||
更新案例
|
||||
|
||||
处理流程:
|
||||
1. 解析请求体中的JSON数据
|
||||
2. 验证案例ID
|
||||
3. 表单验证
|
||||
4. 查询现有记录
|
||||
5. 处理头像图片(如有变化则保存新图片)
|
||||
6. 更新各字段
|
||||
7. 保存更新
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含案例ID和更新信息的JSON数据
|
||||
|
||||
Returns:
|
||||
R: 操作结果(成功/失败)
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 验证案例ID
|
||||
instance_id = data.get('id')
|
||||
if not instance_id or not str(instance_id).isdigit() or int(instance_id) <= 0:
|
||||
return R.failed("案例ID无效")
|
||||
instance_id = int(instance_id)
|
||||
|
||||
# 表单验证
|
||||
form = forms.ExampleForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
try:
|
||||
# 查询案例记录
|
||||
instance = Example.objects.filter(id=instance_id, is_delete=False).first()
|
||||
if not instance:
|
||||
return R.failed("案例不存在")
|
||||
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 处理头像图片(仅当有新图片且与当前不同时保存)
|
||||
avatar = cleaned_data.get('avatar')
|
||||
if avatar and avatar != instance.avatar:
|
||||
avatar = save_file(avatar, "example")
|
||||
else:
|
||||
avatar = instance.avatar
|
||||
|
||||
# 更新各字段
|
||||
instance.name = cleaned_data.get('name')
|
||||
instance.avatar = avatar
|
||||
instance.type = cleaned_data.get('type')
|
||||
instance.status = cleaned_data.get('status')
|
||||
instance.sort = cleaned_data.get('sort')
|
||||
instance.update_user = get_username(request)
|
||||
instance.save()
|
||||
|
||||
return R.ok(msg="更新成功")
|
||||
except Exception as e:
|
||||
logging.error(f"更新案例异常,ID: {instance_id}, 错误: {str(e)}")
|
||||
return R.failed(msg="更新失败,请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 删除服务(支持批量)
|
||||
# =============================================================
|
||||
|
||||
def delete_examples(instance_ids):
|
||||
"""
|
||||
删除案例(批量删除)
|
||||
|
||||
采用逻辑删除方式(is_delete=True),而非物理删除。
|
||||
支持逗号分隔的多个ID。
|
||||
|
||||
Args:
|
||||
instance_ids: 案例ID字符串,多个ID用逗号分隔
|
||||
例如: "1" 或 "1,2,3"
|
||||
|
||||
Returns:
|
||||
R: 操作结果,包含删除数量
|
||||
"""
|
||||
if not instance_ids:
|
||||
return R.failed("记录ID不存在")
|
||||
|
||||
try:
|
||||
# 解析ID列表
|
||||
id_list = [int(id_str.strip()) for id_str in instance_ids.split(',') if id_str.strip()]
|
||||
if not id_list:
|
||||
return R.failed("无效的记录ID")
|
||||
|
||||
# 批量更新删除标识(逻辑删除)
|
||||
updated_count = Example.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: {instance_ids}, 错误: {str(e)}")
|
||||
return R.failed(msg="删除失败,请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 状态更新服务
|
||||
# =============================================================
|
||||
|
||||
def update_example_status(request):
|
||||
"""
|
||||
更新案例状态
|
||||
|
||||
单独更新案例的启用/禁用状态,不涉及其他字段。
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
- id: 案例ID
|
||||
- status: 目标状态值(1=启用, 2=禁用)
|
||||
|
||||
Returns:
|
||||
R: 操作结果(成功/失败)
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 验证案例ID
|
||||
instance_id = data.get('id')
|
||||
if not instance_id or not str(instance_id).isdigit() or int(instance_id) <= 0:
|
||||
return R.failed("案例ID无效")
|
||||
instance_id = int(instance_id)
|
||||
|
||||
# 验证状态值(1=启用, 2=禁用)
|
||||
status = data.get('status')
|
||||
if status is None:
|
||||
return R.failed("状态值不能为空")
|
||||
try:
|
||||
status = int(status)
|
||||
if status not in [1, 2]:
|
||||
return R.failed("状态值无效")
|
||||
except ValueError:
|
||||
return R.failed("状态值格式错误")
|
||||
|
||||
try:
|
||||
# 查询案例记录
|
||||
instance = Example.objects.filter(id=instance_id, is_delete=False).first()
|
||||
if not instance:
|
||||
return R.failed("案例不存在")
|
||||
|
||||
# 更新状态
|
||||
instance.status = status
|
||||
instance.update_user = get_username(request)
|
||||
instance.save()
|
||||
|
||||
return R.ok(msg="状态更新成功")
|
||||
except Exception as e:
|
||||
logging.error(f"更新案例状态异常,ID: {instance_id}, 错误: {str(e)}")
|
||||
return R.failed(msg="状态更新失败,请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 数据下拉列表服务
|
||||
# =============================================================
|
||||
|
||||
def get_example_data():
|
||||
"""
|
||||
获取所有启用的案例列表
|
||||
|
||||
通常用于前端下拉选择框等场景。
|
||||
只返回 status=1(启用)且未删除的记录。
|
||||
|
||||
Returns:
|
||||
list: 案例列表,每个元素为案例模型字典
|
||||
查询失败时返回空列表
|
||||
"""
|
||||
try:
|
||||
# 查询启用的案例数据列表
|
||||
# status=1 表示启用,is_delete=False 表示未删除
|
||||
queryset = Example.objects.filter(
|
||||
is_delete=False,
|
||||
status=1
|
||||
).order_by("sort").values()
|
||||
|
||||
return list(queryset)
|
||||
except Exception as e:
|
||||
logging.error(f"获取案例列表异常: {str(e)}")
|
||||
return []
|
||||
@@ -0,0 +1,129 @@
|
||||
# +======================================================================
|
||||
# | 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.example import views
|
||||
|
||||
"""
|
||||
案例模块路由配置
|
||||
=============================================================
|
||||
|
||||
URL端点概览:
|
||||
------------------------------------------------------------------------
|
||||
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|
||||
|-----------------|----------|-----------------------------|-------------------------|
|
||||
| 分页查询 | GET | /example/page | ExamplePageView |
|
||||
| 列表查询 | GET | /example/list | ExampleListView |
|
||||
| 详情查询 | GET | /example/detail/<id> | ExampleDetailView |
|
||||
| 添加案例 | POST | /example/add | ExampleAddView |
|
||||
| 更新案例 | PUT | /example/update | ExampleUpdateView |
|
||||
| 删除案例 | DELETE | /example/delete/<ids>| ExampleDeleteView |
|
||||
| 设置状态 | PUT | /example/status | ExampleStatusView |
|
||||
| 获取列表 | GET | /example/data | ExampleDataView |
|
||||
------------------------------------------------------------------------
|
||||
|
||||
URL参数说明:
|
||||
- id: int类型,案例ID(用于查询详情)
|
||||
- id: str类型,逗号分隔的案例ID字符串(用于批量删除)
|
||||
|
||||
使用示例:
|
||||
1. 分页查询:GET /api/example/page?pageNo=1&pageSize=10
|
||||
2. 列表查询:GET /api/example/list
|
||||
3. 详情查询:GET /api/example/detail/5
|
||||
4. 添加案例:POST /api/example/add
|
||||
5. 更新案例:PUT /api/example/update
|
||||
6. 删除案例:DELETE /api/example/delete/1,2,3
|
||||
7. 设置状态:PUT /api/example/status
|
||||
8. 获取列表:GET /api/example/data
|
||||
"""
|
||||
|
||||
# 案例模块路由配置
|
||||
urlpatterns = [
|
||||
# 查询案例分页列表
|
||||
# URL: /example/page
|
||||
# 请求方法: GET
|
||||
# 功能: 获取案例分页数据,支持按案例名称、案例类型:1-类型1 2-类型2 3-类型3 4-类型4、案例状态:1-正常 2-禁用等条件筛选
|
||||
path('page', views.ExamplePageView.as_view()),
|
||||
|
||||
# 查询案例数据列表(支持筛选)
|
||||
# URL: /example/list
|
||||
# 请求方法: GET
|
||||
# 功能: 获取所有案例的列表数据,支持按条件筛选,用于下拉选择等前端组件
|
||||
path('list', views.ExampleListView.as_view()),
|
||||
|
||||
# 查询案例详情
|
||||
# URL: /example/detail/<int:id>
|
||||
# 请求方法: GET
|
||||
# URL参数: id - 案例ID(整数类型)
|
||||
# 功能: 根据ID获取指定案例的详细信息
|
||||
path('detail/<int:id>', views.ExampleDetailView.as_view()),
|
||||
|
||||
# 添加案例
|
||||
# URL: /example/add
|
||||
# 请求方法: POST
|
||||
# 功能: 创建新的案例记录,请求体需包含案例信息(name、avatar、type、status、sort等)
|
||||
path('add', views.ExampleAddView.as_view()),
|
||||
|
||||
# 更新案例
|
||||
# URL: /example/update
|
||||
# 请求方法: PUT
|
||||
# 功能: 更新现有案例信息,请求体需包含案例ID和更新内容
|
||||
path('update', views.ExampleUpdateView.as_view()),
|
||||
|
||||
# 删除案例
|
||||
# URL: /example/delete/<str:id>
|
||||
# 请求方法: DELETE
|
||||
# URL参数: id - 案例ID字符串,支持单个ID或逗号分隔的多个ID(如 "1,2,3")
|
||||
# 功能: 删除指定案例(逻辑删除,设置is_delete=True)
|
||||
path('delete/<str:id>', views.ExampleDeleteView.as_view()),
|
||||
|
||||
# 设置案例状态
|
||||
# URL: /example/status
|
||||
# 请求方法: PUT
|
||||
# 功能: 更新案例的启用/禁用状态
|
||||
path('status', views.ExampleStatusView.as_view()),
|
||||
|
||||
# 查询案例数据列表
|
||||
# URL: /example/list
|
||||
# 请求方法: GET
|
||||
# 功能: 获取所有启用案例的列表数据,用于下拉选择等前端组件
|
||||
path('list', views.ExampleDataView.as_view()),
|
||||
]
|
||||
@@ -0,0 +1,370 @@
|
||||
# +======================================================================
|
||||
# | 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.example import services
|
||||
from config.env import DJANGO_DEMO
|
||||
from middleware.login_middleware import check_login
|
||||
from middleware.permission_middleware import PermissionRequired
|
||||
from utils import R
|
||||
from application.operation_log.constants import LogType
|
||||
from application.operation_log.decorators import operation_log
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 分页查询视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="get")
|
||||
class ExamplePageView(PermissionRequired, View):
|
||||
"""
|
||||
案例分页数据查询视图
|
||||
|
||||
处理GET请求,返回案例列表的分页数据。
|
||||
支持按案例名称、案例类型、案例状态等条件筛选。
|
||||
|
||||
URL: /example/page
|
||||
请求方法: GET
|
||||
权限要求:sys:example:page
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:example:page",)
|
||||
|
||||
@operation_log(
|
||||
title="案例管理-查询分页列表",
|
||||
log_type=LogType.QUERY
|
||||
)
|
||||
def get(self, request):
|
||||
"""
|
||||
处理GET请求,返回案例分页数据
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含分页参数和筛选条件
|
||||
- pageNo: 当前页码
|
||||
- pageSize: 每页记录数
|
||||
- name: 案例名称(可选,模糊查询)
|
||||
- type: 案例类型(可选,精确匹配)
|
||||
- status: 案例状态(可选,精确匹配)
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含分页数据的JSON响应
|
||||
"""
|
||||
result = services.get_example_page(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 列表查询视图(不分页)
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name='get')
|
||||
class ExampleListView(View):
|
||||
"""
|
||||
案例列表获取视图(支持筛选,不分页)
|
||||
|
||||
处理GET请求,返回所有案例的列表数据。
|
||||
支持按案例名称、案例类型、案例状态等条件筛选。
|
||||
|
||||
URL: /example/list
|
||||
请求方法: GET
|
||||
权限要求:需要登录
|
||||
"""
|
||||
|
||||
def get(self, request):
|
||||
"""
|
||||
处理GET请求,返回案例列表
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含案例列表的JSON响应
|
||||
"""
|
||||
result = services.get_example_list(request)
|
||||
return R.ok(data=result)
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 详情查询视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="get")
|
||||
class ExampleDetailView(PermissionRequired, View):
|
||||
"""
|
||||
案例详情查询视图
|
||||
|
||||
处理GET请求,根据案例ID返回案例详细信息。
|
||||
|
||||
URL: /example/detail/<int:id>
|
||||
请求方法: GET
|
||||
URL参数: id - 案例ID
|
||||
权限要求:sys:example:detail
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:example:detail",)
|
||||
|
||||
@operation_log(
|
||||
title="案例管理-查询记录详情",
|
||||
log_type=LogType.QUERY
|
||||
)
|
||||
def get(self, request, id):
|
||||
"""
|
||||
处理GET请求,返回案例详情
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
id: int, 案例ID(从URL中获取)
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含案例详细信息的JSON响应
|
||||
"""
|
||||
data = services.get_example_detail(id)
|
||||
return R.ok(data=data)
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 添加视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="post")
|
||||
class ExampleAddView(PermissionRequired, View):
|
||||
"""
|
||||
添加案例视图
|
||||
|
||||
处理POST请求,创建新的案例记录。
|
||||
|
||||
URL: /example/add
|
||||
请求方法: POST
|
||||
权限要求:sys:example:add
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ("sys:example: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_example(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 更新视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="put")
|
||||
class ExampleUpdateView(PermissionRequired, View):
|
||||
"""
|
||||
更新案例视图
|
||||
|
||||
处理PUT请求,更新现有案例信息。
|
||||
|
||||
URL: /example/update
|
||||
请求方法: PUT
|
||||
权限要求:sys:example:update
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ('sys:example: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_example(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 删除视图(支持批量)
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="delete")
|
||||
class ExampleDeleteView(PermissionRequired, View):
|
||||
"""
|
||||
删除案例视图
|
||||
|
||||
处理DELETE请求,删除指定案例(支持批量删除)。
|
||||
|
||||
URL: /example/delete/<str:id>
|
||||
请求方法: DELETE
|
||||
URL参数: id - 案例ID字符串,多个ID用逗号分隔
|
||||
权限要求:sys:example:delete
|
||||
|
||||
注意: 删除案例前请确认是否被其他数据关联
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ('sys:example:delete',)
|
||||
|
||||
@operation_log(
|
||||
title="案例管理-删除记录",
|
||||
log_type=LogType.DELETE
|
||||
)
|
||||
def delete(self, request, id):
|
||||
"""
|
||||
处理DELETE请求,删除案例
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
id: str, 案例ID字符串,多个ID用逗号分隔(从URL中获取)
|
||||
例如: "1" 或 "1,2,3"
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含操作结果的JSON响应
|
||||
"""
|
||||
# 演示环境禁止操作
|
||||
if DJANGO_DEMO:
|
||||
return R.failed("演示环境,暂无操作权限")
|
||||
|
||||
result = services.delete_examples(id)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 状态更新视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name="put")
|
||||
class ExampleStatusView(PermissionRequired, View):
|
||||
"""
|
||||
设置案例状态视图
|
||||
|
||||
处理PUT请求,更新案例的启用/禁用状态。
|
||||
|
||||
URL: /example/status
|
||||
请求方法: PUT
|
||||
权限要求:sys:example:status
|
||||
"""
|
||||
|
||||
# 方法权限标识
|
||||
permission_required = ('sys:example:status',)
|
||||
|
||||
def put(self, request):
|
||||
"""
|
||||
处理PUT请求,更新案例状态
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象,包含案例ID和状态值的JSON数据
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含操作结果的JSON响应
|
||||
"""
|
||||
# 演示环境禁止操作
|
||||
if DJANGO_DEMO:
|
||||
return R.failed("演示环境,暂无操作权限")
|
||||
|
||||
result = services.update_example_status(request)
|
||||
return result
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 数据下拉列表视图
|
||||
# =============================================================
|
||||
|
||||
@method_decorator(check_login, name='get')
|
||||
class ExampleDataView(View):
|
||||
"""
|
||||
案例列表获取视图
|
||||
|
||||
处理GET请求,返回所有启用案例的列表数据。
|
||||
通常用于前端下拉选择框等场景。
|
||||
|
||||
URL: /example/data
|
||||
请求方法: GET
|
||||
权限要求:需要登录
|
||||
"""
|
||||
|
||||
def get(self, request):
|
||||
"""
|
||||
处理GET请求,返回案例列表
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象
|
||||
|
||||
Returns:
|
||||
JsonResponse: 包含案例列表的JSON响应
|
||||
"""
|
||||
result = services.get_example_data()
|
||||
return R.ok(data=result)
|
||||
Reference in New Issue
Block a user