workbunny/webman-push-server

Webman plugin workbunny/webman-push-server

2.0.4 2024-04-12 09:27 UTC

README

workbunny

workbunny/webman-push-server

🐇 Webman plugin for push server implementation. 🐇

Build Status Latest Stable Version PHP Version Require GitHub license

当前为2.x版本,点击跳转1.x文档

2.x与1.x的区别

  • PHP版本要求升级^8.0
  • 【废弃】Client类
  • 【替代】使用WsClient替代Client
  • 【废弃】pusher/pusher-php-server包
  • 【重写】ApiClient类
  • 【优化】ApiService 支持 keep-alive

简介

  • 本项目是对Pusher-Channel进行了一比一复刻,是一个完整的即时通讯服务,利用该插件可以轻松实现聊天、在线推送等业务服务,也可以利用该插件作为微服务的消息订阅服务; 该服务是生产可用的服务,在商业化项目作为在线推送服务数字大屏服务中已稳定运行半年以上。
  • 本项目是webman/push多进程实现版本,并且完善了消息事件、权限验证、多租户支持等功能。
  • 如遇问题,欢迎 issue & PR
  • 兼容Pusher-Channel的客户端,包含JS、安卓(java)、IOS(swift)、IOS(Obj-C)、uniapp等; 后端推送SDK支持PHP、Node、Ruby、Asp、Java、Python、Go等;客户端自带心跳和断线自动重连,使用起来非常简单稳定;

依赖

  • php >=8.0
  • redis >= 6.2 【建议使用最新】

安装

composer require workbunny/webman-push-server

说明

  • Server.php: 基于websocket的消息推送服务
  • ApiService.php: 基于http的推送APIs
  • ApiClient.php: 基于http-api的后端推送SDK
  • WsClient.php: 基于websocket的后端客户端
  • HookServer.php: 基于redis-stream的持久化服务端事件订阅服务
  • ChannelClient.php: 服务内部通讯客户端组件
  • ChannelServer.php: 服务内部通讯服务

配置说明

配置信息及对应功能在代码注释中均有解释,详见对应代码注释;

|-- config
    |-- plugin
        |-- webman-push-server
            |-- app.php        # 主配置信息
            |-- bootstrap.php  # 自动加载
            |-- command.php    # 支持命令
            |-- process.php    # 启动进程
            |-- route.php      # APIs路由信息

push-server会启动以下三种类型进程:

  • push-server:主服务;负责启动推送服务及其service
    • ApiService 与主服务共用一个进程、事件循环
  • hook-server:事件消费服务;负责消费服务内部的钩子事件
  • channel-server:进程通道服务;负责多进程通讯

频道说明:

push-server支持以下三种频道类型:

  • 公共频道(public):客户端仅可监听公共频道,不可向公共频道推送消息;
  • 私有频道(private):客户端可向私有频道推送/监听,一般用于端对端的通讯,服务端仅做转发;该频道可以用于私聊场景;
  • 状态频道(presence):与私有频道保持一致,区别在于状态频道还保存有客户端的信息,任何用户的上下线都会收到该频道的广播通知,如user_id、user_info; 状态频道最多支持100个客户端(客户端限制,实际上可以放开);

事件说明:

推送的 event 须遵守以下的约定规范:

  • client- 前缀的事件:拥有 client- 前缀的事件是客户端发起的事件,客户端在推送消息时一定会带有该前缀;
  • pusher: 前缀的事件:拥有 pusher: 前缀的事件一般用于服务端消息、公共消息,比如在公共频道由服务端推送的消息、客户端发起的订阅公共消息;
  • pusher_internal: 前缀的事件:拥有 pusher_internal: 前缀的事件是服务端的回执通知,一般是由客户端发起订阅、取消订阅等操作时,由服务端回执的事件信息带有该前缀的事件;

使用

客户端 (javascript) 使用

1.javascript客户端

  • 引入
<script src="/plugin/workbunny/webman-push-server/push.js"> </script>
  • 创建连接

TIps:每 new 一个 Push 会创建一个连接。

// 建立连接
var connection = new Push({
    url: 'ws://127.0.0.1:8001', // websocket地址
    app_key: '<app_key>', // 在config/plugin/workbunny/webman-push-server/app.php里配置
});

2.客户端订阅公共频道

TIps:频道和事件可以是任意符合约定前缀的字符串,不需要服务端预先配置。

// 建立连接
var connection = new Push({
    url: 'ws://127.0.0.1:8001', // websocket地址
    app_key: '<app_key>', // 在config/plugin/workbunny/webman-push-server/app.php里配置
});

// 监听 public-test 公共频道
var user_channel = connection.subscribe('public-test');

// 当 public-test 频道有message事件的消息回调
user_channel.on('message', function(data) {
    // data里是消息内容
    console.log(data);
});
// 取消监听 public-test 频道
connection.unsubscribe('public-test')
// 取消所有频道的监听
connection.unsubscribeAll()

3.客户端订阅私有/状态频道

Tips:您需要先实现用于鉴权的接口服务

  • 私有频道

Tips:样例鉴权接口详见 config/plugin/workbunny/webman-push-server/route.php

// 订阅发生前,浏览器会发起一个ajax鉴权请求(ajax地址为new Push时auth参数配置的地址),开发者可以在这里判断,当前用户是否有权限监听这个频道。这样就保证了订阅的安全性。
var connection = new Push({
    url: 'ws://127.0.0.1:8001', // websocket地址
    app_key: '<app_key>',
    auth: 'http://127.0.0.1:8002/subscribe/auth' // 该接口是样例接口,请根据源码自行实现业务
});
// 监听 private-test 私有频道
var user_channel = connection.subscribe('private-test');
// 当 private-test 频道有message事件的消息回调
user_channel.on('message', function(data) {
    // data里是消息内容
    console.log(data);
});
// 取消监听 private-test 频道
connection.unsubscribe('private-test')
// 取消所有频道的监听
connection.unsubscribeAll()
  • 状态频道

Tips:样例鉴权接口详见 config/plugin/workbunny/webman-push-server/route.php

  • 方法一
// 方法一

// 订阅发生前,浏览器会发起一个ajax鉴权请求(ajax地址为new Push时auth参数配置的地址),开发者可以在这里判断,当前用户是否有权限监听这个频道。这样就保证了订阅的安全性。
var connection = new Push({
    url: 'ws://127.0.0.1:8001', // websocket地址
    app_key: '<app_key>',
    auth: 'http://127.0.0.1:8002/subscribe/auth' // 该接口是样例接口,请根据源码自行实现业务
});
  • 方法二
// 方法二

// 先通过接口查询获得用户信息,组装成如下
var channel_data = {
    user_id: '100',
    user_info: "{\'name\':\'John\',\'sex\':\'man\'}"
}
// 订阅发生前,浏览器会发起一个ajax鉴权请求(ajax地址为new Push时auth参数配置的地址),开发者可以在这里判断,当前用户是否有权限监听这个频道。这样就保证了订阅的安全性。
var connection = new Push({
    url: 'ws://127.0.0.1:8001', // websocket地址
    app_key: '<app_key>',
    auth: 'http://127.0.0.1:8002/subscribe/auth', // 该接口是样例接口,请根据源码自行实现业务
    channel_data: channel_data
});

// 监听 presence-test 状态频道
var user_channel = connection.subscribe('presence-test');
// 当 presence-test 频道有message事件的消息回调
user_channel.on('message', function(data) {
    // data里是消息内容
    console.log(data);
});
// 取消监听 presence-test 频道
connection.unsubscribe('presence-test')
// 取消所有频道的监听
connection.unsubscribeAll()

4.客户端推送

Tips:
  • 客户端间推送仅支持私有频道(private-)/状态频道(presence-),并且客户端只能触发以 client- 开头的事件。 客户端触发事件推送的例子
  • 以下代码给所有订阅了 private-user-1 的客户端推送 client-message 事件的数据,而当前客户端不会收到自己的推送消息
// 以上省略

// 私有频道
var user_channel = connection.subscribe('private-user-1');
user_channel.on('client-message', function (data) {
//
});
user_channel.trigger('client-message', {form_uid:2, content:"hello"});

// 状态频道
var user_channel = connection.subscribe('presence-user-1');
user_channel.on('client-message', function (data) {
//
});
user_channel.trigger('client-message', {form_uid:2, content:"hello"});

客户端(PHP)使用

Tips:区别于 HTTP-apis;HTTP-APIs 用于服务端管理等工作;

1. 创建连接

use Workbunny\WebmanPushServer\WsClient;
use Workerman\Connection\AsyncTcpConnection;
use Workbunny\WebmanPushServer\EVENT_SUBSCRIBE;
use Workbunny\WebmanPushServer\EVENT_SUBSCRIPTION_SUCCEEDED;

// 创建连接
$client = WsClient::instance('127.0.0.1:8001', [
    'app_key'        => 'workbunny',
    'heartbeat'      => 60,
    'auth'           => 'http://127.0.0.1:8002/subscribe/auth',
    'channel_data'   => []  // channel_data
    'query'          => [], // query
    'context_option' => []
])
// 建立连接
$client->connect();
// 关闭连接
$client->disconnect();

2. 订阅/退订

use Workbunny\WebmanPushServer\WsClient;
use Workerman\Connection\AsyncTcpConnection;

// 创建连接
$client = WsClient::instance('127.0.0.1:8001', [
    'app_key'        => 'workbunny',
    'heartbeat'      => 60,
    'auth'           => 'http://127.0.0.1:8002/subscribe/auth',
    'channel_data'   => []  // channel_data
    'query'          => [], // query
    'context_option' => []
])

// 订阅一个私有通道,订阅成功后会执行回调函数
$client->subscribe('private-test', function (AsyncTcpConnection $connection, array $data) {
    // 订阅成功后打印
    dump($data);
});
// 订阅一个私有通道,不注册订阅成功后的回调
$client->subscribe('private-test');

// 取消订阅一个私有通道
$client->unsubscribe('private-test', function (AsyncTcpConnection $connection, array $data) {
    // 取消订阅成功后打印
    dump($data);
});
// 取消订阅一个私有通道,不注册订阅成功后的回调
$client->unsubscribe('private-test');

// 取消全部订阅
$client->unsubscribeAll();

3. 触发消息

// 向 private-test 通道发送 client-test 事件消息
$client->trigger('private-test', 'client-test', [
    'message' => 'hello workbunny!'
]);

// 向 presence-test 通道发送 client-test 事件消息
$client->trigger('presence-test', 'client-test', [
    'message' => 'hello workbunny!'
]);

// 事件不带 client- 前缀会抛出RuntimeException
try {
    $client->trigger('presence-test', 'test', [
        'message' => 'hello workbunny!'
    ]);
} catch (RuntimeException $exception){
    dump($exception);
}

4. 事件注册回调

use Workerman\Connection\AsyncTcpConnection;

// 注册关注private-test通道的client-test事件
$client->eventOn('private-test', 'client-test', function(AsyncTcpConnection $connection, array $data) {
    // 打印事件数据
    dump($data);
});
// 取消关注private-test通道的client-test事件
$client->eventOff('private-test', 'client-test');

// 获取所有注册事件回调
$client->getEvents();

5. 其他

// 获取客户端id,当连接创建前该方法返回null
$client->getSocketId();

// 获取已订阅通道,订阅触发前该方法返回空数组
$client->getChannels();

// 发布消息
$client->publish();

// 更多详见 WsClient.php

服务端使用

服务端会分别启动一下服务进程:

  • push-server
    • 主服务进程,用于监听websocket协议信息
    • 配置位于config/plugin/workbunny/webman-push-server/app.php
    • api-service子服务
      • api子服务,用于提供http-api接口服务
      • 路由配置位于config/plugin/workbunny/webman-push-server/route.php
  • hook-server
    • hook多进程消费服务,用于消费事件钩子,进行webhook通知
    • 配置位于config/plugin/workbunny/webman-push-server/app.php

1.HOOK服务

支持的HOOK事件:
  • 通道类型事件
    • channel_occupied:当通道被建立时,该事件触发
    • channel_vacated:当通道被销毁时,该事件被触发
  • 用户类型事件
    • member_added:当用户加入通道时,该事件被触发
    • member_removed:当用户被移除通道时,该事件被触发
  • 消息类型事件
    • client_event:当通道产生客户端消息时,该事件被触发
    • server-event:当通道产生服务端消息(服务端推送消息、服务端回执消息)时,该事件被触发
事件处理器:
  1. Hook服务是多进程消费队列,进程数详见config/plugin/workbunny/webman-push-server/process.php
  2. 默认使用webhook方式进行消费通知,详见WebhookHandler;
  3. 支持自定义消费方式,方法如下:
    • 创建自定义handler类,实现接口HookHandlerInterface
    • 将类名添加至配置文件config/plugin/workbunny/webman-push-server/app.phphook_handler
    • 重启服务
注意事项:
  1. 在队列无法发布消息等意外情况下,队列消息会暂时持久化至本地数据库,直到队列恢复后队列消息将自动恢复至队列;
    • 本地数据库默认采用SQLite3,配置详见config/plugin/workbunny/webman-push-server/database.php
    • 本地暂存的队列消息会以定时器的方式重载至队列,配置详见config/plugin/workbunny/webman-push-server/app.php -> hook_server.requeue_interval
  2. 队列消息存在一定的pending时间,配置支持设置pending_timeoutclaim_interval用于缓解可能存在的消息数据冗余;
    • config/plugin/workbunny/webman-push-server/app.php -> hook_server.claim_interval用于创建消息回收定时器来进行冗余消息回收
    • config/plugin/workbunny/webman-push-server/app.php -> hook_server.pending_timeout用于确定需要被回收的冗余消息,pending时间达到该配置的消息将会被消息回收定时器回收

2.API子服务

API子服务提供REST风格的http-APIs,接口内容与 pusher-channel-api 基本保持一致;

支持的http-api接口:
method url 描述
POST /apps/[app_id]/events 对应的pusher文档地址
POST /apps/[app_id]/batch_events 对应的pusher文档地址
GET /apps/[app_id]/channels 对应的pusher文档地址
GET /apps/[app_id]/channels/[channel_name] 对应的pusher文档地址
POST /apps/[app_id]/users/[user_id]/terminate_connections 对应的pusher文档地址
GET /apps/[app_id]/channels/[channel_name]/users 对应的pusher文档地址
API客户端
  1. 使用pusher提供的api客户端
    • 不建议使用,客户端请求没有使用keep-alive
composer require pusher/pusher-php-server
  1. 或者使用\Workbunny\WebmanPushServer\ApiClient
    • 建议使用

服务端推送(PHP示例):

use Workbunny\WebmanPushServer\ApiClient;

try {
    $pusher = new ApiClient(
        'APP_KEY', 
        'APP_SECRET',
        'APP_ID',
        [
            'host'       =>"http://127.0.0.1:8001",
            'timeout'    => 60,
            'keep-alive' => true
        ]
    );
    $pusher->trigger(
        // 频道(channel)支持多个通道
        ["private-d"], 
        // 事件
        "client-a", 
        // 消息体
        [
            'message' => 'hello workbunny!'
        ],
        // query
        []
    );
} catch (GuzzleException|ApiErrorException|PusherException $e) {
    dump($e);
}

其他

wss代理(SSL)

https下无法使用ws连接,需要使用wss连接。这种情况可以使用nginx代理wss,配置类似如下:

server {
# .... 这里省略了其它配置 ...

    location /app
    {
        proxy_pass http://127.0.0.1:3131;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-Real-IP $remote_addr;
    }
}

重启nginx后,使用以下方式连接服务端

var connection = new Push({
    url: 'wss://example.com',
    app_key: '<app_key>'
});

Tips:wss开头,不写端口,必须使用ssl证书对应的域名连接

其他客户端地址

兼容pusher,其他语言(Java Swift .NET Objective-C Unity Flutter Android IOS AngularJS等)客户端地址下载地址: https://pusher.com/docs/channels/channels_libraries/libraries/