djangoadmin/djangoadmin-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

优化更新

Browse Source
This commit is contained in:
gitadmin
2026-09-13 17:33:13 +08:00
parent 8be23a62a3
commit 7f758cc6e9
97 changed files with 2333 additions and 3595 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DjangoAdmin_Django_EleVue/zh/volume2/form.md
+58 -1
View File
@@ -16,15 +16,32 @@ from django import forms
from application.example import models
# =============================================================
# 案例表单验证类
# =============================================================
class ExampleForm(forms.ModelForm):
"""
案例表单验证类
用于创建和更新案例信息时的表单验证。
验证字段包括：name, avatar, type, status, sort
包含案例名称, 案例图片, 案例类型等属性
验证字段包括：
- name: 案例名称
- avatar: 案例图片
- type: 案例类型
- status: 案例状态（1-正常, 2-禁用）
- sort: 排序
"""
# ----------------------------------------------------------
# 案例名称
# ----------------------------------------------------------
# 字段说明: 案例的名称
# 字段类型: 字符串（CharField）
# 验证规则: 必填（required=True），最大长度100字符
# 业务说明: 案例的核心标识字段，用于列表展示和搜索
name = forms.CharField(
required=True,
max_length=100,
@@ -34,7 +51,13 @@ class ExampleForm(forms.ModelForm):
}
)
# ----------------------------------------------------------
# 案例图片
# ----------------------------------------------------------
# 字段说明: 案例的图片
# 字段类型: 字符串（CharField）
# 验证规则: 可选（required=False），最大长度255字符
# 业务说明: 用于案例列表展示和详情页的图片
avatar = forms.CharField(
required=False,
max_length=255,
@@ -43,7 +66,13 @@ class ExampleForm(forms.ModelForm):
}
)
# ----------------------------------------------------------
# 案例类型
# ----------------------------------------------------------
# 字段说明: 案例的分类类型
# 字段类型: 整数（IntegerField）
# 验证规则: 必填（required=True），取值范围1-4
# 业务说明: 对案例进行分类管理，支持按类型筛选
type = forms.IntegerField(
required=True,
min_value=1,
@@ -55,7 +84,13 @@ class ExampleForm(forms.ModelForm):
}
)
# ----------------------------------------------------------
# 案例状态
# ----------------------------------------------------------
# 字段说明: 案例的显示状态
# 字段类型: 整数（IntegerField）
# 验证规则: 必填（required=True），取值范围1-2
# 业务说明: 1-正常, 2-禁用，控制案例是否在前端展示
status = forms.IntegerField(
required=True,
min_value=1,
@@ -67,7 +102,14 @@ class ExampleForm(forms.ModelForm):
}
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 案例的排序权重
# 字段类型: 整数（IntegerField）
# 验证规则: 必填（required=True）
# 排序规则: 数值越小越靠前
# 业务说明: 手动控制案例在列表中的显示顺序
sort = forms.IntegerField(
required=True,
error_messages={
@@ -75,8 +117,23 @@ class ExampleForm(forms.ModelForm):
}
)
# =============================================================
# 表单元数据配置
# =============================================================
class Meta:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 Example（案例）
model = models.Example
# 指定需要验证的字段
# 只验证以下字段，其他字段不进行表单验证
fields = [
'name',
'avatar',
DjangoAdmin_Django_EleVue/zh/volume2/model.md
+89 -7
View File
@@ -17,6 +17,10 @@ from application.models import BaseModel
from utils.common import get_table_name
# =============================================================
# 案例模型类
# =============================================================
class Example(BaseModel):
"""
案例模型类
@@ -29,29 +33,53 @@ class Example(BaseModel):
- 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='案例名称'
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='案例图片'
db_comment='案例图片' # 数据库字段注释
)
# ----------------------------------------------------------
# 案例类型
# ----------------------------------------------------------
# 类型常量定义
TYPE_CHOICES = (
(1, "类型1"),
(2, "类型2"),
@@ -59,44 +87,98 @@ class Example(BaseModel):
(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'
db_comment='案例类型：1-类型1 2-类型2 3-类型3 4-类型4' # 数据库字段注释
)
# ----------------------------------------------------------
# 案例状态
# ----------------------------------------------------------
# 状态常量定义
STATUS_CHOICES = (
(1, "正常"),
(2, "禁用"),
(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-禁用'
db_comment='案例状态：1-正常 2-禁用' # 数据库字段注释
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 案例的排序权重
# 字段类型: 整数（IntegerField）
# 约束: 非空（null=False）
# 排序规则: 数值越小越靠前（升序排列）
# 作用: 手动控制案例在列表中的显示顺序
sort = models.IntegerField(
null=False,
verbose_name="排序",
help_text="排序",
db_comment='排序'
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}"
```
DjangoAdmin_Django_EleVue/zh/volume2/url.md
+61 -1
View File
@@ -17,30 +17,90 @@ application/urls.py # 主路由
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
# 功能: 获取案例分页数据，支持按案例名称、案例类型、案例状态等条件筛选
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()),
# 查询案例数据列表
path('list', views.ExampleDataView.as_view()),
# URL: /example/data
# 请求方法: GET
# 功能: 获取所有启用案例的列表数据，用于下拉选择等前端组件
path('data', views.ExampleDataView.as_view()),
]
```
DjangoAdmin_Django_EleVue/zh/volume2/view.md
+225 -13
View File
@@ -23,93 +23,305 @@ 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)
@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
权限要求：sys:example:detail
"""
# 方法权限标识
permission_required = ("sys:example:detail",)
@operation_log(title="案例管理-查询记录详情", log_type=LogType.QUERY)
@operation_log(
title="案例管理-查询记录详情",
log_type=LogType.QUERY
)
def get(self, request, id):
"""
处理GET请求，返回案例详情
Args:
request: HttpRequest对象
id: 案例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请求，创建新的案例记录。
请求体需包含案例信息（name、avatar、type、status、sort等）。
URL: /example/add
请求方法: POST
权限要求：sys:example:add
"""
# 方法权限标识
permission_required = ("sys:example:add",)
@operation_log(title="案例管理-添加记录", log_type=LogType.ADD)
@operation_log(
title="案例管理-添加记录",
log_type=LogType.ADD
)
def post(self, request):
"""
处理POST请求，添加案例
Args:
request: HttpRequest对象，请求体包含案例信息
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请求，更新现有案例信息。
请求体需包含案例ID和更新内容。
URL: /example/update
请求方法: PUT
权限要求：sys:example:update
"""
# 方法权限标识
permission_required = ('sys:example:update',)
@operation_log(title="案例管理-更新记录", log_type=LogType.UPDATE)
@operation_log(
title="案例管理-更新记录",
log_type=LogType.UPDATE
)
def put(self, request):
"""
处理PUT请求，更新案例
Args:
request: HttpRequest对象，请求体包含更新信息
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请求，删除指定案例（逻辑删除）。
支持批量删除，多个ID用逗号分隔。
URL: /example/delete/<str:id>
请求方法: DELETE
权限要求：sys:example:delete
"""
# 方法权限标识
permission_required = ('sys:example:delete',)
@operation_log(title="案例管理-删除记录", log_type=LogType.DELETE)
@operation_log(
title="案例管理-删除记录",
log_type=LogType.DELETE
)
def delete(self, request, id):
"""
处理DELETE请求，删除案例
Args:
request: HttpRequest对象
id: 案例ID字符串，支持逗号分隔的多个ID（如 "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和新状态
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)
```