实时互动新体验：在Django-Ninja框架中实现高效的消息推送

于 2024-09-04 10:00:47 发布
阅读量455 收藏 4
点赞数 7
文章标签： 实时互动 django sqlite
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tombosky/article/details/141885606
版权

Django-Ninja框架中实现消息推送及应用实例

在现代Web应用开发中，消息推送是一个非常重要的功能，它可以用于实现即时通讯、通知提醒等多种场景。传统的轮询方式已经不能满足低延迟、高并发的需求，而WebSocket协议的出现则为解决这些问题提供了新的方案。在Python Web开发领域，Django框架是众多开发者的选择之一，而Django-Ninja则为Django提供了简洁易用的RESTful API接口设计工具。本文将介绍如何在Django-Ninja框架中结合Django Channels实现消息推送，并通过一个具体的示例来展示整个过程。

## 一、环境准备

首先，确保你有一个基本的Python虚拟环境，并且已经安装了Django、Django REST framework (DRF) 和 Ninja。如果没有安装，可以通过以下命令进行安装：

pip install django djangorestframework ninja

假设我们已经有了一个名为myproject的Django项目，并且创建了一个名为notifications的应用。

## 二、安装Django Channels

在我们的项目中安装Django Channels：

pip install channels
## 三、配置Django Channels

编辑myproject/settings.py文件，添加channels的相关配置：

INSTALLED_APPS = [
    # ...
    'channels',
    'rest_framework',
    'ninja',
    'notifications',
]

ASGI_APPLICATION = 'myproject.routing.application'

CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels.layers.InMemoryChannelLayer',
    },
}

这里我们使用了内存层作为channel层，适用于开发阶段。生产环境中可能需要使用更可靠的channel层实现，比如Redis。

## 四、定义路由

在项目根目录下创建一个routing.py文件，用于定义WebSocket的路由：

from channels.routing import ProtocolTypeRouter, URLRouter
from django.urls import path
from notifications.consumers import NotificationConsumer

application = ProtocolTypeRouter({
    "websocket": URLRouter([
        path("ws/notifications/", NotificationConsumer.as_asgi()),
    ]),
})

这里我们定义了一个WebSocket路由，指向notifications应用中的NotificationConsumer类。

## 五、编写Consumer

接下来，在notifications应用中创建一个名为consumers.py的文件，用于处理WebSocket连接：

import json
from channels.generic.websocket import AsyncWebsocketConsumer

class NotificationConsumer(AsyncWebsocketConsumer):
    async def connect(self):
        user_id = self.scope['user'].id
        self.user_group_name = f'user_{user_id}'

        # Join user's group
        await self.channel_layer.group_add(
            self.user_group_name,
            self.channel_name
        )

        await self.accept()

    async def disconnect(self, close_code):
        user_id = self.scope['user'].id
        self.user_group_name = f'user_{user_id}'

        # Leave user's group
        await self.channel_layer.group_discard(
            self.user_group_name,
            self.channel_name
        )

    # Receive message from WebSocket
    async def receive(self, text_data):
        text_data_json = json.loads(text_data)
        message = text_data_json['message']

        # Send message to user's group
        await self.channel_layer.group_send(
            self.user_group_name,
            {
                'type': 'send_notification',
                'message': message
            }
        )

    # Receive message from user's group
    async def send_notification(self, event):
        message = event['message']

        # Send message to WebSocket
        await self.send(text_data=json.dumps({
            'message': message
        }))

这个消费者实现了基本的WebSocket连接、断开和接收消息的功能。当接收到消息后，它会将其发送给同一用户组内的所有客户端。

## 六、创建模型

为了存储和管理通知，我们需要定义一个模型。在notifications/models.py中添加如下内容：

from django.db import models
from django.conf import settings

class Notification(models.Model):
    user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    message = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.message
## 七、创建视图

在notifications/views.py中创建一个视图来处理通知的创建和获取：

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Notification
from .serializers import NotificationSerializer
from asgiref.sync import async_to_sync
from channels.layers import get_channel_layer

class NotificationAPIView(APIView):
    def post(self, request):
        serializer = NotificationSerializer(data=request.data)
        if serializer.is_valid():
            notification = serializer.save(user=request.user)
            channel_layer = get_channel_layer()
            async_to_sync(channel_layer.group_send)(
                f'user_{request.user.id}',
                {
                    'type': 'send_notification',
                    'message': notification.message
                }
            )
            return Response(serializer.data, status=201)
        return Response(serializer.errors, status=400)

    def get(self, request):
        notifications = Notification.objects.filter(user=request.user)
        serializer = NotificationSerializer(notifications, many=True)
        return Response(serializer.data)

这里我们定义了一个视图来处理POST请求（创建通知）和GET请求（获取通知），并在创建通知后通过Django Channels发送消息。

## 八、序列化器

为了将模型转换为JSON格式，我们需要创建一个序列化器。在notifications/serializers.py中添加如下内容：

from rest_framework import serializers
from .models import Notification

class NotificationSerializer(serializers.ModelSerializer):
    class Meta:
        model = Notification
        fields = ['message']
## 九、URL配置

在notifications/urls.py中配置URL：

from django.urls import path
from .views import NotificationAPIView

urlpatterns = [
    path('notifications/', NotificationAPIView.as_view(), name='notifications'),
]
## 十、集成Ninja

在myproject/urls.py中集成Ninja，并包含notifications的URL：

from django.contrib import admin
from django.urls import path, include
from ninja import NinjaAPI

api = NinjaAPI()

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', api.urls),
    path('notifications/', include('notifications.urls')),
]
## 十一、前端集成

为了让前端能够与WebSocket通信，你可以使用任何WebSocket库。例如，使用JavaScript原生API：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>消息推送示例</title>
</head>
<body>
    <h1>消息推送示例</h1>
    <div id="messages"></div>
    <input type="text" id="messageInput" placeholder="输入消息...">
    <button onclick="sendMessage()">发送</button>

    <script>
        var socket = new WebSocket(`ws://${window.location.host}/ws/notifications/`);

        socket.onopen = function(e) {
            console.log("WebSocket连接已打开");
        };

        socket.onmessage = function(event) {
            var data = JSON.parse(event.data);
            var messagesDiv = document.getElementById('messages');
            messagesDiv.innerHTML += `<p>${data.message}</p>`;
        };

        function sendMessage() {
            var input = document.getElementById("messageInput");
            socket.send(JSON.stringify({message: input.value}));
            input.value = '';
        }

        socket.onerror = function(error) {
            console.error("WebSocket发生错误: ", error);
        };
    </script>
</body>
</html>

这段代码会在页面加载时建立WebSocket连接，并尝试发送一条消息。

完整代码示例

myproject/settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'channels',
    'rest_framework',
    'ninja',
    'notifications',
]

ASGI_APPLICATION = 'myproject.routing.application'

CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels.layers.InMemoryChannelLayer',
    },
}

myproject/routing.py

from channels.routing import ProtocolTypeRouter, URLRouter
from django.urls import path
from notifications.consumers import NotificationConsumer

application = ProtocolTypeRouter({
    "websocket": URLRouter([
        path("ws/notifications/", NotificationConsumer.as_asgi()),
    ]),
})

notifications/models.py

from django.db import models
from django.conf import settings

class Notification(models.Model):
    user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    message = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.message

notifications/views.py

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Notification
from .serializers import NotificationSerializer
from asgiref.sync import async_to_sync
from channels.layers import get_channel_layer

class NotificationAPIView(APIView):
    def post(self, request):
        serializer = NotificationSerializer(data=request.data)
        if serializer.is_valid():
            notification = serializer.save(user=request.user)
            channel_layer = get_channel_layer()
            async_to_sync(channel_layer.group_send)(
                f'user_{request.user.id}',
                {
                    'type': 'send_notification',
                    'message': notification.message
                }
            )
            return Response(serializer.data, status=201)
        return Response(serializer.errors, status=400)

    def get(self, request):
        notifications = Notification.objects.filter(user=request.user)
        serializer = NotificationSerializer(notifications, many=True)
        return Response(serializer.data)

notifications/serializers.py

from rest_framework import serializers
from .models import Notification

class NotificationSerializer(serializers.ModelSerializer):
    class Meta:
        model = Notification
        fields = ['message']

notifications/consumers.py

import json
from channels.generic.websocket import AsyncWebsocketConsumer

class NotificationConsumer(AsyncWebsocketConsumer):
    async def connect(self):
        user_id = self.scope['user'].id
        self.user_group_name = f'user_{user_id}'

        # Join user's group
        await self.channel_layer.group_add(
            self.user_group_name,
            self.channel_name
        )

        await self.accept()

    async def disconnect(self, close_code):
        user_id = self.scope['user'].id
        self.user_group_name = f'user_{user_id}'

        # Leave user's group
        await self.channel_layer.group_discard(
            self.user_group_name,
            self.channel_name
        )

    # Receive message from WebSocket
    async def receive(self, text_data):
        text_data_json = json.loads(text_data)
        message = text_data_json['message']

        # Send message to user's group
        await self.channel_layer.group_send(
            self.user_group_name,
            {
                'type': 'send_notification',
                'message': message
            }
        )

    # Receive message from user's group
    async def send_notification(self, event):
        message = event['message']

        # Send message to WebSocket
        await self.send(text_data=json.dumps({
            'message': message
        }))

notifications/urls.py

from django.urls import path
from .views import NotificationAPIView

urlpatterns = [
    path('notifications/', NotificationAPIView.as_view(), name='notifications'),
]

myproject/urls.py

from django.contrib import admin
from django.urls import path, include
from ninja import NinjaAPI

api = NinjaAPI()

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', api.urls),
    path('notifications/', include('notifications.urls')),
]

index.html

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>消息推送示例</title>
</head>
<body>
    <h1>消息推送示例</h1>
    <div id="messages"></div>
    <input type="text" id="messageInput" placeholder="输入消息...">
    <button onclick="sendMessage()">发送</button>

    <script>
        var socket = new WebSocket(`ws://${window.location.host}/ws/notifications/`);

        socket.onopen = function(e) {
            console.log("WebSocket连接已打开");
        };

        socket.onmessage = function(event) {
            var data = JSON.parse(event.data);
            var messagesDiv = document.getElementById('messages');
            messagesDiv.innerHTML += `<p>${data.message}</p>`;
        };

        function sendMessage() {
            var input = document.getElementById("messageInput");
            socket.send(JSON.stringify({message: input.value}));
            input.value = '';
        }

        socket.onerror = function(error) {
            console.error("WebSocket发生错误: ", error);
        };
    </script>
</body>
</html>
## 十二、启动你的应用

现在可以启动你的Django开发服务器，并通过访问ws://localhost:8000/ws/notifications/来测试WebSocket连接。

python manage.py runserver

以上就是如何在Django-Ninja框架中结合Django Channels实现消息推送，并通过一个具体的示例来展示整个过程。通过这个例子，你可以了解到如何在Django项目中引入WebSocket支持，并利用Django Channels实现简单的多用户实时通信。希望这篇教程能够帮助你在未来开发更加丰富的实时应用。

Coderabo
关注
  • 7
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Django restful framework生成API文档过程详解
12-16
Django Restful Framework 是一个强大的工具，用于快速构建高质量的 Web API。它基于 Django 框架，并且遵循 REST（Representational State Transfer）架构风格。本文将深入探讨如何使用 Django Restful Framework ...
Django restful web services the easiest way to build python
07-02
### Django RESTful Web Services: The Easiest Way to Build Python #### 一、概述与背景 本书主要聚焦于如何利用Python及其最受欢迎的Web框架Django来构建RESTful Web服务。随着互联网技术的发展，RESTful Web...
Django Restful Framework
落笔成名
12-05 362
Django Drf 使用感想关于Restful关于Django Restful Framework 关于Restful 所有得请求，都是需要依赖一个对象得。 比如登录请求，要依赖用户对象； 比如创建文章，需要依赖文章对象 比如借书，需要依赖图书-租借服务对象 进而，在这些对象得基础上，通过请求Method，我们就会知道请求得目的。 Get 获取对象信息 Put 更新对象信息 Post 新增对象信息 Delete 删除对象信息 从而，以借书为例，我们可以设计如下： Url Method No
Django restful环境
不完美中的完美
07-03 158
环境配置 设置文件 调试运行
python django restful_利用Django实现RESTful API(一)
weixin_39789101的博客
11-29 298
RESTful API现在很流行，这里是它的介绍 理解RESTful架构和 RESTful API设计指南.按照Django的常规方法当然也可以实现REST，但有一种更快捷、强大的方法，那就是 Django RESTframework.它是python的一个模块，通过在Django里面配置就可以把app的models中的各个表实现RESTful API。下面是实现方法：一、安装配置pip inst...
django restful权限认证方式
m0_62520968的博客
04-24 690
1.session认证： # # 全局所有页面都有权限认证 # REST_FRAMEWORK = { # 'DEFAULT_AUTHENTICATION_CLASSES': ( # 'rest_framework.authentication.BasicAuthentication', # 'rest_framework.authentication.SessionAuthentication', # ), .
Django RESTful API设计与实践指南
05-14 1413
Django是一个使用Python语言开发的开源Web应用框架，它遵循MVC（Model-View-Controller）模式，旨在帮助开发者快速构建高质量、功能强大的Web应用程序。Django具有强大的功能和丰富的功能模块，如ORM（对象关系映射）、模板引擎、表单处理、管理后台等，使得开发过程更加高效和简洁。
Django RESTful Web Services epub
05-03
Django RESTful Web Services 英文epub 本资源转载自网络，如有侵权，请联系上传者或csdn删除 查看此书详细信息请在美国亚马逊官网搜索此书
Django RESTful Web Services_Code 源码
05-03
Django RESTful Web Services_Code 源码 本资源转载自网络，如有侵权，请联系上传者或csdn删除 查看此书详细信息请在美国亚马逊官网搜索此书
Django RESTful Web Services-Packt Publishing(2018)
05-27
also known as RESTful web APIs, with Python 3.6 or greater, and want to learn how to do it with the most popular Python web framework—Django.
DPDK：RTE_PMD_REGISTER_PCI 的原型
hhd1988的专栏
08-27 284
DPDK：RTE_PMD_REGISTER_PCI 的原型
Django中的第一个自动化测试编写
慢也好，步子小也好，往前走就好~
08-30 651
编写第一个测试
13、Django Admin创建两个独立的管理站点
netandghost的博客
08-30 281
【代码】Django Admin创建两个独立的管理站点。
二、再识Django
D_A_I_H_A_O的博客
09-03 515
进入虚拟环境或PyCharm提供的terminal终端，输入如下命令即可安装最新Django版本。当然你还可以通过==指定所需的Django版本。
10、Django Admin修改标题
netandghost的博客
08-30 320
【代码】Django Admin修改标题。
7、Django Admin删除默认应用程序
netandghost的博客
08-30 341
【代码】Django Admin删除默认应用程序。
【精选】基于Django的智能水果销售系统设计与实现
程序员阿龙的博客
08-30 1524
我是程序员阿龙，专注于软件开发，拥有丰富的编程能力和实战经验。在过去的几年里，我辅导了上千名学生，帮助他们顺利完成毕业项目，同时我的技术分享也吸引了超过50W+的粉丝。我是CSDN特邀作者、博客专家、新星计划导师，并在Java领域内获得了多项荣誉，如博客之星。我的作品也被掘金、华为云、阿里云、InfoQ等多个平台推荐，成为各大平台的优质作者。 在Java技术领域和学生毕业项目实战中，我积累了深厚的知识与经验，并与高校老师、讲师及行业内的同行前辈保持着广泛的交流与合作。我的专业背景和丰富的实战经验使
12、Django Admin在列表视图页面上显示计算字段
netandghost的博客
08-31 536
注册模型有两种方式，需要首先添加或者修改admin中的注册模型如下方式。1、在models的模型类中添加函数。
Django跨域问题
最新发布
qq_28837549的博客
09-03 900
由于本站以及很大部分项目都是前后端分离模式，前后端所配置的域名并不相同，所以会受到浏览器的同源策略限制，导致不能正确的请求资源，以下内容先用最简单的方法实现Django后端的跨域问题解决，后续原理再慢慢补充CORS（Cross-Origin Resource Sharing）是一种浏览器技术的规范，也被称为跨域资源共享。它允许浏览器向跨源服务器发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Coderabo

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值