实战指南：如何在Django-Ninja项目中无缝集成django-notifications-hq实现高效消息推送

最新推荐文章于 2024-09-12 16:47:54 发布

Coderabo

最新推荐文章于 2024-09-12 16:47:54 发布

阅读量700

点赞数 5

文章标签： django sqlite python

本文链接：https://blog.csdn.net/tombosky/article/details/141867509

版权

Django-Ninja框架中使用django-notifications-hq实现消息推送全过程

随着Web应用的发展，实时消息通知已经成为了一个不可或缺的功能。无论是社交网络中的好友动态，还是在线教育平台上的课程更新提醒，及时的消息推送都能极大地提升用户体验。在Django项目中，我们可以利用Django-Ninja这个轻量级API框架来构建RESTful API，并结合django-notifications-hq来实现消息推送功能。

一、环境准备与安装

在开始之前，确保你的开发环境中已经安装了Python和Django。我们将使用Django-Ninja作为API框架，因为它可以快速地帮助我们定义API路由，而django-notifications-hq则用来处理通知逻辑。

首先，创建一个新的Django项目（如果你已经有了一个，可以直接跳到安装部分）：

django-admin startproject mysite
cd mysite

接下来，创建一个应用来存放我们的通知逻辑：

python manage.py startapp notifications

然后安装必要的包：

pip install django-ninja django-notifications-hq

记得将新创建的应用添加到INSTALLED_APPS设置中：

# settings.py
INSTALLED_APPS = [
    ...
    'ninja',
    'notifications.apps.NotificationsConfig',
]

二、配置django-notifications-hq

为了使django-notifications-hq正常工作，我们需要对其进行一些基本配置。编辑settings.py文件，添加如下配置：

# settings.py
INSTALLED_APPS = [
    ...
    'notifications',  # 确保在配置中正确添加
]

MIDDLEWARE = [
    ...
    'django.contrib.auth.middleware.AuthenticationMiddleware',  # 需要认证中间件
    'notifications.middleware.NotificationsMiddleware',  # 添加通知中间件
]

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            ...
            'context_processors': [
                ...
                'django.template.context_processors.request',  # 必须要有request处理器
                'notifications.context_processors.notifications',  # 添加通知上下文处理器
            ],
        },
    },
]

NOTIFICATIONS_USE_JSONFIELD = True  # 如果使用PostgreSQL数据库，启用此选项

三、创建模型与视图

接下来，我们将创建一个简单的用户模型以及一个用于触发通知的视图。

1. 用户模型

假设我们已经有如下的用户模型：

# models.py
from django.db import models
from django.contrib.auth.models import AbstractUser

class User(AbstractUser):
    pass  # 可以在这里扩展更多字段

2. 触发通知的视图

使用Django-Ninja定义一个API端点来发送通知给特定用户或所有用户：

# views.py
from ninja import NinjaAPI
from django.contrib.auth import get_user_model
from django.dispatch import receiver
from django.db.models.signals import post_save
from notifications.models import Notification

api = NinjaAPI()

User = get_user_model()

@api.post("/send-notification/")
def send_notification(request, user_id: int, message: str):
    user = User.objects.get(id=user_id)
    if user:
        user.notifications.create(actor_content_type=ContentType.objects.get_for_model(User),
                                  actor_object_id=user.id,
                                  verb=message,
                                  description=message)
        user.notifications.unread().update(unread=False)  # 标记为已读
        return {"status": "success", "message": f"Notification sent to {user.username}"}
    else:
        return {"status": "error", "message": "User not found"}

@receiver(post_save, sender=User)
def create_auth_token(sender, instance=None, created=False, **kwargs):
    if created:
        Notification.objects.create(user=instance, verb='Welcome', description='欢迎注册我们的平台！')

上述代码中，我们定义了一个接收POST请求的端点，该端点接受用户ID和消息内容作为参数，并向指定用户发送一条通知。同时，我们还定义了一个信号处理器，在用户创建时自动发送一条欢迎消息。

四、前端集成

为了展示通知，你需要在前端页面中集成这些通知。例如，在模板中可以这样显示未读通知数量：

<!-- templates/base.html -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{% block title %}My Site{% endblock %}</title>
</head>
<body>
    {% if request.user.is_authenticated %}
        <div>你好, {{ request.user.username }}! 你有{{ request.user|unread_notification_count }}条未读通知。</div>
    {% endif %}
    {% block content %}
    {% endblock %}
</body>
</html>

这里使用了django-notifications-hq提供的模板标签来获取未读通知的数量。

五、运行测试

现在，你可以启动服务器并测试一下是否能够成功发送通知：

python manage.py runserver

打开浏览器访问http://localhost:8000/send-notification/，并使用Postman或者curl命令发送一个POST请求来测试API。

六、总结

通过本文，我们学习了如何在Django项目中利用Django-Ninja和django-notifications-hq来实现消息推送功能。从环境搭建到具体实现细节，再到最后的前端集成，每一个步骤都力求详尽。希望这篇教程能帮助你在自己的项目中实现类似的功能。

完整实例代码

下面是一个包含上述所有步骤的完整代码示例：

# settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'ninja',
    'notifications.apps.NotificationsConfig',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'notifications.middleware.NotificationsMiddleware',
]

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        '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',
                'notifications.context_processors.notifications',
            ],
        },
    },
]

NOTIFICATIONS_USE_JSONFIELD = True

# models.py
from django.db import models
from django.contrib.auth.models import AbstractUser

class User(AbstractUser):
    pass  # 可以在这里扩展更多字段

# views.py
from ninja import NinjaAPI
from django.contrib.auth import get_user_model
from django.dispatch import receiver
from django.db.models.signals import post_save
from django.contrib.contenttypes.models import ContentType
from notifications.models import Notification

api = NinjaAPI()

User = get_user_model()

@api.post("/send-notification/")
def send_notification(request, user_id: int, message: str):
    user = User.objects.get(id=user_id)
    if user:
        user.notifications.create(actor_content_type=ContentType.objects.get_for_model(User),
                                  actor_object_id=user.id,
                                  verb=message,
                                  description=message)
        user.notifications.unread().update(unread=False)  # 标记为已读
        return {"status": "success", "message": f"Notification sent to {user.username}"}
    else:
        return {"status": "error", "message": "User not found"}

@receiver(post_save, sender=User)
def create_auth_token(sender, instance=None, created=False, **kwargs):
    if created:
        Notification.objects.create(user=instance, verb='Welcome', description='欢迎注册我们的平台！')

# templates/base.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{% block title %}My Site{% endblock %}</title>
</head>
<body>
    {% if request.user.is_authenticated %}
        <div>你好, {{ request.user.username }}! 你有{{ request.user|unread_notification_count }}条未读通知。</div>
    {% endif %}
    {% block content %}
    {% endblock %}
</body>
</html>

Coderabo

关注

5
点赞
踩
6

收藏

觉得还不错? 一键收藏
打赏
0
评论
实战指南：如何在Django-Ninja项目中无缝集成django-notifications-hq实现高效消息推送

通过本文，我们学习了如何在Django项目中利用Django-Ninja和django-notifications-hq来实现消息推送功能。从环境搭建到具体实现细节，再到最后的前端集成，每一个步骤都力求详尽。希望这篇教程能帮助你在自己的项目中实现类似的功能。
复制链接

扫一扫