实战指南：利用Django-Ninja与django-notifications-hq打造高效的API消息推送系统

Coderabo

已于 2024-09-04 08:18:29 修改

阅读量765

点赞数 5

文章标签： django sqlite python

于 2024-09-03 18:37:46 首次发布

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

版权

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

在现代Web应用中，通过API实现消息推送是非常常见的需求。本篇教程将详细介绍如何在Django项目中，利用Django-Ninja构建RESTful API，并结合django-notifications-hq来实现消息推送功能。

一、环境准备与安装

确保你的开发环境中已经安装了Python和Django。我们将使用Django-Ninja作为API框架，并结合django-notifications-hq来处理通知逻辑。

创建一个新的Django项目：

django-admin startproject mysite
cd mysite

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

python manage.py startapp api

安装必要的包：

pip install django-ninja django-notifications-hq

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

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

二、配置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数据库，启用此选项

三、定义API与模型

我们将创建一个简单的用户模型以及一个用于触发通知的API端点。

1. 用户模型

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

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

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

2. 触发通知的API端点

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

# api/views.py
from ninja import Router
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 django.http import JsonResponse
from notifications.models import Notification

router = Router()

User = get_user_model()

@router.post("/send-notification/")
def send_notification(request, user_id: int, message: str):
    try:
        user = User.objects.get(pk=user_id)
        user.notifications.create(
            actor_content_type=ContentType.objects.get_for_model(user),
            actor_object_id=user.id,
            verb=message,
            description=message,
            recipient=user,
        )
        return JsonResponse({"status": "success", "message": f"Notification sent to {user.username}"})
    except User.DoesNotExist:
        return JsonResponse({"status": "error", "message": "User not found"}, status=404)

@receiver(post_save, sender=User)
def send_welcome_notification(sender, instance=None, created=False, **kwargs):
    if created:
        instance.notifications.create(
            actor_content_type=ContentType.objects.get_for_model(instance),
            actor_object_id=instance.id,
            verb='Welcome',
            description='欢迎注册我们的平台！',
            recipient=instance,
        )

这里定义了一个接收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.notifications.unread|length }}条未读通知。</div>
    {% endif %}
    {% block content %}
    {% endblock %}
</body>
</html>

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

五、运行测试

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

python manage.py runserver

使用Postman或者curl命令发送一个POST请求来测试API：

curl -X POST http://localhost:8000/api/send-notification/ -d "user_id=1&message=Hello%20from%20API"

六、总结

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

Coderabo

关注

5
点赞
踩
10

收藏

觉得还不错? 一键收藏
打赏
0
评论
实战指南：利用Django-Ninja与django-notifications-hq打造高效的API消息推送系统

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

扫一扫