Django中信号signals的简单使用方法

下面是Django中信号signals的简单使用方法：

什么是信号signals？

信号signals是Django提供的一种机制，通过该机制，某些操作的完成可以触发指定的处理函数，我们可以在这些处理函数中实现一些自己想要的操作。比如：在用户注册成功后，我们想给他发送一封欢迎电子邮件，那么我们就可以使用信号来实现这个功能。

Django中的信号signals如何使用？

Django中信号提供了2个API：

django.dispatch.Signal：一个signal实例，许多应用程序都使用它。
django.dispatch.receiver(signal, **kwargs)：一个装饰器，用于注册signal。

使用Django的信号有三个步骤：

定义信号

from django.dispatch import Signal
my_signal = Signal(providing_args=["arg1", "arg2"])

定义处理函数

def signal_handler(sender, **kwargs):
    # Do something

在适当的位置调用信号

my_signal.connect(signal_handler, sender=None)
my_signal.send(sender=self, arg1='hello', arg2='world')

上面的代码以一个自定义信号my_signal为例，展示了Django中信号signals的完整调用过程。

下面是两条示例说明：

示例一：实现邮件发送

假设我们需要在用户注册成功后发送一封欢迎邮件，我们可以使用如下代码：

定义信号

from django.dispatch import Signal
user_registered = Signal(providing_args=['user'])

定义处理函数

from django.core.mail import send_mail
def send_welcome_mail(sender, **kwargs):
    user = kwargs['user']
    subject = '欢迎您使用XXX网站'
    message = '尊敬的用户%s，感谢您成为我们的会员！' % user.username
    recipient_list = [user.email]
    send_mail(subject, message, 'xxx@163.com', recipient_list)

在适当的位置调用信号

user_registered.connect(send_welcome_mail, sender=User)

这里的User是Django自带的用户模型。用户注册成功后，我们可以在注册视图函数中调用信号：

from django.contrib.auth.forms import UserCreationForm
from django.contrib.auth import login
from django.shortcuts import render, redirect
from .signals import user_registered

def register(request):
    if request.method == 'POST':
        form = UserCreationForm(request.POST)
        if form.is_valid():
            user = form.save()
            login(request, user)
            # 发送注册成功信号
            user_registered.send(sender=User, user=user)
            return redirect('home')
    else:
        form = UserCreationForm()
    return render(request, 'register.html', {'form': form})

这段代码中在用户注册成功后调用了user_registered信号，并把发送者设置为User，并且将用户实例作为参数。

示例二：实现日志记录

假设我们需要在每次用户登陆成功后记录日志，我们可以使用如下代码：

定义信号

from django.dispatch import Signal
user_logged_in = Signal(providing_args=['user'])

定义处理函数

import logging
def record_log(sender, **kwargs):
    user = kwargs['user']
    logging.info('user %s logged in' % user.username)

在适当的位置调用信号

user_logged_in.connect(record_log, sender=User)

这里的User是Django自带的用户模型，应该在Django项目的settings.py中配置logging：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
        'handlers': {
            'file': {
                'level': 'INFO',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': os.path.join(BASE_DIR, 'logs/debug.log'),
                'maxBytes': 1024 * 1024,
                'backupCount': 5,
                'formatter': 'verbose',
            }
        },
     'formatters': {
            'verbose': {
                'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
            }
        },
        'loggers': {
            '': {
                'handlers': ['file'],
                'level': 'INFO',
                'propagate': True,
            },
        }
}

这段代码将INFO级别以上的信息记录在logs/debug.log文件中。

当用户登陆成功后将会记录用户登陆日志。在Django的视图函数中调用信号：

from django.contrib.auth import authenticate, login
from django.http import HttpResponse
from django.shortcuts import render
from .signals import user_logged_in

def user_login(request):
    if request.method == 'POST':
        username = request.POST['username']
        password = request.POST['password']
        user = authenticate(request, username=username, password=password)
        if user is not None:
            login(request, user)
            # 发送登陆成功信号
            user_logged_in.send(sender=User, user=user)
            return HttpResponse('登录成功')
        else:
            return HttpResponse('登录失败')
    else:
        return render(request, 'login.html')

这段代码中在用户登陆成功后调用了user_logged_in信号，并把发送者设置为User，并且将用户实例作为参数。

以上就是基于Django中信号signals的简单使用方法的完整攻略。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：Django中信号signals的简单使用方法 - Python技术站