Django信号使用指南

2025-04-07T17:29:37+08:00 | 7分钟阅读 | 更新于 2025-04-07T17:29:37+08:00

Macro Zhao

Django信号使用指南

推荐超级课程：

引言：

Django信号是一个强大的功能，允许我们基于应用程序中的事件触发某些行为。本指南详细介绍了Django信号，重点介绍了最常用的信号：pre_save、post_save、pre_delete和post_delete。通过本教程，你将了解如何使用这些信号有效地增强你的Django应用程序。

先决条件：

了解Django模型的基础知识
安装Python ≤ 3.8
设置Django项目

1. 什么是Django信号？

Django信号允许解耦的应用程序在框架中的其他地方发生某些操作时得到通知。最常见的用途包括日志记录、在保存或删除模型时触发额外逻辑以及确保数据完整性。

2：设置你的Django项目

2.1. 安装Django

首先，创建虚拟环境并安装Django库：

# 创建虚拟环境  
python -m venv venv  
  
# 激活虚拟环境  
# 对于Windows：  
venv\Scripts\activate  
# 对于macOS/Linux：  
source venv/bin/activate  
  
# 安装Django  
pip install django

2.2. 创建一个Django项目

# 创建一个Django项目  
django-admin startproject django_signal  
  
# 启动开发服务器  
python manage.py runserver

你应该能看到你的项目运行在 http://127.0.0.1:8000。

3: 创建一个Django应用

在Django中，“应用”是指在项目内执行特定功能的Web应用程序。

# 创建一个名为'blog'的应用  
python manage.py startapp blog  
  
# 创建模板目录  
mkdir templates/blog

将应用添加到 django_signal/settings.py 中的 INSTALLED_APPS：

INSTALLED_APPS = [  
    # Django默认应用  
    'django.contrib.admin',  
    'django.contrib.auth',  
    'django.contrib.contenttypes',  
    'django.contrib.sessions',  
    'django.contrib.messages',  
    'django.contrib.staticfiles',  
      
    # 自定义应用  
    'blog',  
]

4: 在Blog应用中定义一个模型

在 blog/models.py 中创建一个简单的模型来演示信号：

from django.db import models  
  
class Post(models.Model):  
    title = models.CharField(max_length=100)  
    content = models.TextField()  
    created_at = models.DateTimeField(auto_now_add=True)  
    updated_at = models.DateTimeField(auto_now=True)  
  
    def __str__(self):  
        return self.title

5: 在Admin中注册模型

为了在管理界面中轻松管理 Post 模型，在 blog/admin.py 中注册它：

from django.contrib import admin  
from .models import Post  
  
  
admin.site.register(Post)

运行迁移来为模型创建数据库表：

# 创建迁移  
python manage.py makemigrations  
  
# 应用迁移  
python manage.py migrate

6: 创建一个超级用户

为了创建一个超级用户（一个具有管理Django管理面板全部权限的管理用户），使用以下命令：

python manage.py createsuperuser

你将被提示输入一些详细信息：

用户名： 选择任何用户名（例如，admin）
电子邮件地址： 输入一个有效的电子邮件（例如，admin@example.com）
密码： 输入你的强密码然后确认它。

示例：

用户名：admin  
电子邮件地址：admin@example.com  
密码：********  
密码（再次输入）：********  
超级用户创建成功。

7: URL配置

在 blog/urls.py 中，添加视图的URL：

from django.urls import path  
from . import views  
  
  
urlpatterns = [  
    path('posts/', views.post_list, name='post_list'),  
    path('create/', views.create_post, name='create_post'),  
    path('update/<int:post_id>/', views.update_post, name='update_post'),  
    path('delete/<int:post_id>/', views.delete_post, name='delete_post'),  
]

在主 django_signal/urls.py 文件中包含 blog 的所有URL：

from django.contrib import admin  
from django.urls import path, include  
  
  
urlpatterns = [  
    path('admin/', admin.site.urls),  
    path('blog/', include('blog.urls')),  
]

8: 创建视图以测试信号

在 blog/views.py 中，创建简单的视图来处理显示所有帖子、创建、更新和删除帖子：

from django.shortcuts import render, get_object_or_404, redirect  
from .models import Post  
  
  
# 显示所有帖子的视图  
def post_list(request):  
    posts = Post.objects.all()  
    return render(request, 'blog/post_list.html', {'posts': posts})  
  
# 创建帖子  
def create_post(request):  
    post = Post.objects.create(title="Post title", content="This is a new post content for testing.")  
    return render(request, 'blog/post_detail.html', {'post': post})  
  
# 更新帖子  
def update_post(request, post_id):  
    post = get_object_or_404(Post, id=post_id)  
    post.title = "Updated Post Title"  
    post.save()  
    return render(request, 'blog/post_detail.html', {'post': post})  
  
# 删除帖子  
def delete_post(request, post_id):  
    post = get_object_or_404(Post, id=post_id)  
    post.delete()  
    return redirect('post_list')

9: 设置信号

接下来，我们将添加信号以处理当 Post 模型被保存或删除时的事件。

9.1. 创建一个 `signals.py` 文件

创建一个这样的新文件 blog/signals.py 来定义你的信号处理程序：

from django.db.models.signals import pre_save, post_save, pre_delete, post_delete  
from django.dispatch import receiver  
from .models import Post  
  
  
# 保存前信号  
@receiver(pre_save, sender=Post)  
def pre_save_post(sender, instance, **kwargs):  
    print(f"Pre-save signal triggered for: {instance.title}")  
  
# 保存后信号  
@receiver(post_save, sender=Post)  
def post_save_post(sender, instance, created, **kwargs):  
    if created:  
        print(f"New post created: {instance.title}")  
    else:  
        print(f"Post updated: {instance.title}")  
  
# 删除前信号  
@receiver(pre_delete, sender=Post)  
def pre_delete_post(sender, instance, **kwargs):  
    print(f"Pre-delete signal triggered for: {instance.title}")  
  
# 删除后信号  
@receiver(post_delete, sender=Post)  
def post_delete_post(sender, instance, **kwargs):  
    print(f"Post deleted: {instance.title}")

9.2. 在 `apps.py` 中连接信号

为了确保在应用加载时信号被连接，更新 blog/apps.py：

from django.apps import AppConfig  
  
  
class BlogConfig(AppConfig):  
    default_auto_field = 'django.db.models.BigAutoField'  
    name = 'blog'  
  
    def ready(self):  
        # 这将在应用准备好时导入信号  
        import blog.signals

在 django_signal/settings.py 中的 TEMPLATES 添加应用：

  
TEMPLATES = [  
    {  
        'BACKEND': 'django.template.backends.django.DjangoTemplates',  
        'DIRS': [BASE_DIR / 'templates'], # 添加模板目录位置  
        'APP_DIRS': True,  
        'OPTIONS': {  
            'context_processors': [  
                'django.template.context_processors.debug',  
                'django.template.context_processors.request',  
                'django.contrib.auth.context_processors.auth',  
                'django.contrib.messages.context_processors.messages',  
            ],  
        },  
    },  
]

10: 设置模板

10.1. post_detail.html（用于创建或更新后显示文章详情）

在根目录下创建一个templates目录，然后在该目录下创建post_detail.html。

{% extends 'base.html' %}  
  
{% block title %}  
    {{ post.title }}  
{% endblock %}  
  
{% block content %}  
    <h1>{{ post.title }}</h1>  
    <p>{{ post.content }}</p>  
    <p>创建于：{{ post.created_at }}</p>  
    <p>更新于：{{ post.updated_at }}</p>  
  
    <a href="{% url 'update_post' post.id %}">更新文章</a>  
    <a href="{% url 'delete_post' post.id %}">删除文章</a>  
{% endblock %}

10.2. home.html（用于删除后的重定向）

这是一个简单的首页，用于文章删除后的重定向。

在blog/templates/blog/下创建home.html：

{% extends 'base.html' %}  
{% block title %}  
首页  
{% endblock %}  
  
{% block content %}  
    <h1>欢迎来到博客</h1>  
    <p>文章已成功删除。</p>  
    <a href="{% url 'create_post' %}">创建新文章</a>  
{% endblock %}

10.3. post_list.html（用于显示所有文章）

在blog/templates/blog/下创建模板post_list.html：

{% extends 'base.html' %}  
  
{% block title %}  
所有文章  
{% endblock %}  
  
{% block content %}  
    <h1>所有文章</h1>  
    <ul>  
        {% for post in posts %}  
        <li>  
            <a href="{% url 'update_post' post.id %}">{{ post.title }}</a> - {{post.created_at}}  
        </li>  
        {% endfor %}  
    </ul>  
{% endblock %}

10.4. base.html（可选，如果你想要扩展模板）

如果你计划将来创建更多的视图或模板，你可能需要一个基础模板来定义布局。

在blog/templates/blog/下创建base.html：

<!DOCTYPE html>  
<html lang="en">  
<head>  
    <meta charset="UTF-8">  
    <meta name="viewport" content="width=device-width, initial-scale=1.0">  
    <title>{% block title %}我的博客{% endblock %}</title>  
</head>  
<body>  
    <header>  
        <h1>我的博客</h1>  
    </header>  
  
    <main>  
        {% block content %}  
        <!-- 内容放这里 -->  
        {% endblock %}  
    </main>  
  
    <footer>  
        <p>&copy; 2024 我的博客</p>  
    </footer>  
</body>  
</html>

11: 启动开发服务器

运行开发服务器以访问Django管理面板，使用以下命令：

python manage.py runserver

在浏览器中点击或浏览以下URL：

http://127.0.0.1:8000/admin

12: 登录管理面板

您将看到Django管理员登录页面。使用步骤2中创建的超级用户凭据（用户名和密码）登录。

12.1. 使用管理员界面输入数据

登录后，您将在Django管理员界面中看到列出的Post模型。
点击“Posts”。
在右上角点击“添加Post”。
填写表单，为您的帖子输入标题和内容。
点击“保存”以创建帖子。

您也可以通过点击帖子标题，直接在管理面板中更新和删除帖子。

12.2. 测试信号

现在一切已经设置完毕，您可以通过访问以下URL在浏览器中测试信号：posts

获取所有帖子：http://127.0.0.1:8000/blog/posts/
创建帖子：http://127.0.0.1:8000/blog/create/
更新帖子：http://127.0.0.1:8000/blog/update/1/
删除帖子：http://127.0.0.1:8000/blog/delete/1/

检查您的终端，确认信号被触发的打印语句。

13. 最佳实践和用例

解耦逻辑： 信号允许您解耦可能嵌入在模型方法或视图中的逻辑。
避免过度使用信号： 虽然信号功能强大，但避免过度依赖信号，因为它们可能使您的应用程序更难调试。
处理复杂操作： 使用信号触发复杂操作，如发送电子邮件或更新相关对象，以确保一切无缝进行。

14. 结论

Django信号提供了一种很好的方式，基于您的模型生命周期触发操作。通过有效理解如何使用pre_save、post_save、pre_delete和post_delete，您可以构建更健壮、可扩展的Django应用程序。

感谢阅读。如果您发现错误或更好的方法，请在下面的评论中告诉我。

上一页使用 `tqdm` 跟踪您的 Python 任务进度：完整示例教程

下一页 Django分页教程及示例

Django信号使用指南

引言：

先决条件：

目录：

1. 什么是Django信号？

2：设置你的Django项目

2.1. 安装Django

2.2. 创建一个Django项目

3: 创建一个Django应用

4: 在Blog应用中定义一个模型

5: 在Admin中注册模型

6: 创建一个超级用户

7: URL配置

8: 创建视图以测试信号

9: 设置信号

9.1. 创建一个 signals.py 文件

9.2. 在 apps.py 中连接信号

10: 设置模板

10.1. post_detail.html（用于创建或更新后显示文章详情）

10.2. home.html（用于删除后的重定向）

10.3. post_list.html（用于显示所有文章）

10.4. base.html（可选，如果你想要扩展模板）

11: 启动开发服务器

12: 登录管理面板

12.1. 使用管理员界面输入数据

12.2. 测试信号

13. 最佳实践和用例

14. 结论

9.1. 创建一个 `signals.py` 文件

9.2. 在 `apps.py` 中连接信号