django-pubsub 技术文档

1. 安装指南

在开始使用django-pubsub之前，请确保您的环境满足以下要求：

• 一个支持pubsub的XMPP服务器（已测试ejabberd）
• 一个BOSH传输到XMPP（已测试nginx和ejabberd）
• xmpppy库
• Strophe.js及其pubsub插件

安装步骤如下：

1. 安装必要的依赖库：

   pip install django-pubsub xmpppy
   

2. 在你的项目settings.py文件中添加django-pubsub应用。

3. 确保XMPP服务器和BOSH传输已正确安装和配置。

4. 将Strophe.js和pubsub插件添加到你的静态文件目录。

2. 项目的使用说明

django-pubsub允许你为你的模型创建类似Twitter的实时更新。

发布（Publish）

如果你的应用中有一个Tweet模型，并且你希望它的更新能够实时推送，你只需要做以下操作：

from pubsub import pubsub

pubsub.register(Tweet)

你可以通过传递一个模型列表来注册多个模型。每个注册的模型都会成为一个Publisher Node，并且在创建新的实例时会通知所有订阅者。创建的node名称是基于应用名和模型名组成的。例如，如果你的应用名为Twitter，那么Tweet模型的node将会是/Twitter/Tweet。通知中携带的payload包含了实例序列化后的XML。

你也可以在任何视图中发布事件到任何node：

from pubsub import publish
publish("/home", "Hello World")

订阅（Subscribe）

使用strophe.js编写的XMPP客户端将会监听Publisher并接收事件。应用中包含了在media/js中的客户端。

要在你的模板中使用客户端，需要包含以下脚本：

<script type="text/javascript" src="{{ MEDIA_URL }}/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="{{ MEDIA_URL }}/js/strophe.js"></script>
<script type="text/javascript" src="{{ MEDIA_URL }}/js/strophe.pubsub.js"></script>
<script type="text/javascript" src="{{ MEDIA_URL }}/js/pubsub.settings.js"></script>
<script type="text/javascript" src="{{ MEDIA_URL }}/js/pubsub.client.js"></script>

然后调用客户端：

pubsub = new PubSubClient({
    'nick': '<unique_nick>',
    'node': '<node>',
    'event_cb': <callback to receive the events>
});

如果你需要一个授权用户登录，可以传递username和password代替nick。

一个简单的事件回调函数如下：

function event_cb(entry, pubsub) {
    console.log("payload: ", $(entry).text());
    console.log("unread: ", pubsub.unread);
}

回调函数event_cb接收新的更新。entry包含了发布者发送的payload，被包裹在<entry>标签中。pubsub是PubSubClient的实例。

此外，你还可以访问pubsub.unread，它表示当窗口失去焦点时的未读消息数，以及pubsub.focus，它表示窗口是否处于活动状态。

3. 项目API使用文档

django-pubsub提供的API主要围绕发布和订阅事件。以下是一些核心API的使用方法：

• pubsub.register(model): 注册一个Django模型，使其成为一个发布节点。
• pubsub.unregister(model): 取消注册一个模型的发布节点。
• publish(node, payload): 向指定的节点发布一个事件。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明。简而言之，您需要通过pip安装django-pubsub和xmpppy库，并在您的Django项目中正确配置。同时，确保您的XMPP服务器支持pubsub，并且BOSH传输已正确配置。最后，将必要的JavaScript文件包含到您的模板中，以便前端能够订阅和接收事件。