Django Herald 使用教程

Django Herald 使用教程

django-herald A Django messaging library 项目地址: https://gitcode.com/gh_mirrors/dj/django-herald

1. 项目介绍

Django Herald 是一个 Django 消息库，旨在将消息内容与传输方法分离。它支持多种传输方式（如电子邮件、短信、Slack 等），并提供了一个类 Django Admin 的声明和注册方法。Django Herald 还支持浏览器预览消息、维护消息发送历史记录，并允许用户禁用特定通知。

2. 项目快速启动

安装

首先，使用 pip 安装 Django Herald：

pip install django-herald

配置

在 Django 项目的 settings.py 文件中，将 herald 和 django.contrib.sites 添加到 INSTALLED_APPS：

INSTALLED_APPS = [
    ...
    'herald',
    'django.contrib.sites',
    ...
]

然后，在 urls.py 中添加 Herald 的 URL：

from django.conf import settings
from django.conf.urls import url, include

urlpatterns = [
    ...
]

if settings.DEBUG:
    urlpatterns = [
        url(r'^herald/', include('herald.urls')),
    ] + urlpatterns

创建通知类

在 Django 应用中创建一个 notifications.py 文件，并添加一个通知类：

from herald import registry
from herald.base import EmailNotification

class WelcomeEmail(EmailNotification):
    template_name = 'welcome_email'  # 模板名称，不带扩展名
    subject = 'Welcome'  # 邮件主题

    def __init__(self, user):
        self.context = {'user': user}  # 设置模板上下文
        self.to_emails = [user.email]  # 设置接收邮件的列表

    @staticmethod
    def get_demo_args():
        from users.models import User
        return [User.objects.order_by('?')[0]]

registry.register(WelcomeEmail)

创建模板

在 templates/herald/ 目录下创建邮件模板：

templates/
    herald/
        text/
            welcome_email.txt
        html/
            welcome_email.html

发送通知

在代码中需要发送通知的地方调用通知类的 send 方法：

WelcomeEmail(user).send()

3. 应用案例和最佳实践

应用案例

Django Herald 可以用于发送各种类型的通知，例如：

• 欢迎邮件：在新用户注册后发送欢迎邮件。
• 密码重置邮件：在用户请求密码重置时发送邮件。
• 订单确认邮件：在用户下单后发送订单确认邮件。

最佳实践

• 模板管理：使用 Django 模板系统来管理邮件内容，确保内容可维护和可扩展。
• 异步发送：对于大量邮件发送，建议使用 django-celery-email 来实现异步发送，避免阻塞主线程。
• 测试通知：使用 get_demo_args 方法来测试通知类，确保邮件内容和格式正确。

4. 典型生态项目

Django Celery Email

Django Celery Email 是一个用于异步发送邮件的 Django 应用。它可以与 Django Herald 结合使用，以提高邮件发送的性能和可靠性。

Django Admin

Django Admin 是 Django 自带的管理后台，可以与 Django Herald 结合使用，方便管理员查看和重新发送历史通知。

Django Auth

Django Auth 是 Django 自带的用户认证系统，Django Herald 提供了对密码重置邮件的支持，可以直接集成到 Django Auth 中。

通过这些生态项目的结合使用，可以进一步提升 Django Herald 的功能和灵活性。

django-herald A Django messaging library 项目地址: https://gitcode.com/gh_mirrors/dj/django-herald