用于实例化Worker后执行监听

admin

1. void Worker::listen(void)

复制代码

用于实例化Worker后执行监听。

此方法主要用于在Worker进程启动后动态创建新的Worker实例，能够实现同一个进程监听多个端口，支持多种协议。需要注意的是用这种方法只是在当前进程增加监听，并不会动态创建新的进程，也不会触发onWorkerStart方法。

例如一个http Worker启动后实例化一个websocket Worker，那么这个进程即能通过http协议访问，又能通过websocket协议访问。由于websocket Worker和http Worker在同一个进程中，所以它们可以访问共同的内存变量，共享所有socket连接。可以做到接收http请求，然后操作websocket客户端完成向客户端推送数据类似的效果。

注意：

如果PHP版本<=7.0，则不支持在多个子进程中实例化相同端口的Worker。例如A进程创建了监听2016端口的Worker，那么B进程就不能再创建监听2016端口的Worker，否则会报Address already in use错误。例如下面的代码是无法运行的。

1. use Workerman\Worker;
   
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   9 S' C* _- \5 C7 |0 R, G- @2 U- b
4. $worker = new Worker();
   9 e) P/ a+ T4 D% h' S- W+ \( i
5. // 4个进程
   * S5 E. N/ X; s6 ]  C7 n
6. $worker->count = 4;
   ' H7 T# q# r" z
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   * ~% @6 s0 w' n( r9 t0 A0 C2 X# A
9. {
   ) G( f, l( ], p0 V2 c) {( \1 N, r
10.     /**
    6 f3 v+ y2 i  u: ^. t
11.      * 4个进程启动的时候都创建2016端口的Worker
    ) ~7 J) o0 y( r# n, H% u
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    + `. O: ~" d, E% y$ y# f" f9 }* G
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    : C2 z5 `+ Q7 U' k) v7 l! h
16.     $inner_worker->onMessage = 'on_message';
    . q7 B+ \& ?) b9 |* I
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    . F- {1 @. v# Q
20. 
    ' h/ ]3 B: o$ J
21. $worker->onMessage = 'on_message';
    
22. 
    6 U& w5 c* c* ?
23. function on_message($connection, $data)
    5 v5 ~# j9 C$ i3 k& V: _
24. {
    
25.     $connection->send("hello\n");
    " y4 @! P* ]: n1 D5 u/ E
26. }
    
27. 
    ' P- t9 y1 o- R
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    # B! S0 i5 ?! J
32. use Workerman\Worker;
    ! g/ J1 G6 F; k
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    ' ?. x% U5 k6 f4 B6 D
36. // 4个进程
    
37. $worker->count = 4;
    ' O& h: H* o9 b$ G/ ^
38. // 每个进程启动后在当前进程新增一个Worker监听
    # G% |8 {6 |3 P" ~
39. $worker->onWorkerStart = function($worker)
    5 d* U7 M8 v  s
40. {
    5 G% `1 r/ |0 F: r: M1 @
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    - H4 w( [1 g& Z- v( Y8 t: [0 @0 s
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    6 @" b  l+ c) X' x: ]' ?- z" Z
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    + s4 I" H8 c. K) g0 ?
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    & |' m3 W" C1 P# v* R% q
47. };
    
48. 
    / w0 e. a+ z4 h# n
49. $worker->onMessage = 'on_message';
    ! Q. ?. ~. I0 A# b* O* q! ?8 n
50. 
    
51. function on_message($connection, $data)
    % h& q  x& H- A: i; g+ [
52. {
    8 s8 z3 |2 `/ y, g( b* r
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
56. // 运行worker
    
57. Worker::runAll();

复制代码

示例 php后端及时推送消息给客户端

原理：

1、建立一个websocket Worker，用来维持客户端长连接

2、websocket Worker内部建立一个text Worker

3、websocket Worker 与 text Worker是同一个进程，可以方便的共享客户端连接

4、某个独立的php后台系统通过text协议与text Worker通讯

5、text Worker操作websocket连接完成数据推送

代码及步骤

push.php

1. <?php
   3 L( }# A) A: \; s! P. g6 v2 J
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   1 {3 L& [( ?% s- m5 u( |
7. /*
   ' {- L9 o  O, p
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   " H; @( i9 c: X$ ~$ x. o
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    + f  T8 D  S: E' [  U- m
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    8 i4 f6 x1 p2 c4 d
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    " n( e  E2 \( `' @8 O- ?
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    ; Q4 D; H/ ?# S) W% q3 [
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    , C' R5 h' h) s9 c4 D
25.         $connection->send($ret ? 'ok' : 'fail');
    # p+ t4 ~3 ]2 ], A
26.     };
    4 F' K1 M' s. E( w
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    4 H4 b" }4 e! ]$ `9 W
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    7 `& s7 g& Z  P
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    # Q! W# T8 s- g# C! Q. h
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    6 n, ~8 I- m* x1 }6 U" S
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    ( c; x3 f: J/ x- y* Z% F% ]
42.         * 实现针对特定uid推送数据
    " ^& k+ K* }! Z8 Q4 P
43.         */
    8 |7 O/ x/ y+ E9 H; H1 c3 H
44.        $worker->uidConnections[$connection->uid] = $connection;
    % A6 A' P' X! ?  |
45.        return;
    , t) D6 i8 {8 Y4 I
46.     }
    
47. };
    
48. 
    ) k6 o  I% }3 Y* Y5 ]. h& U" g
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    4 |' e- ]6 O9 x: M, U
51. {
    ; y/ U% M1 b: ^# T4 C8 c* e9 g
52.     global $worker;
    ! w- C/ D8 w1 r
53.     if(isset($connection->uid))
    * z0 S4 v# J# e+ R. ]
54.     {
    
55.         // 连接断开时删除映射
    2 ]5 D  g  Y4 I' B% g
56.         unset($worker->uidConnections[$connection->uid]);
    " T" z) T2 }/ u- L) p  A. b9 O
57.     }
    
58. };
    # j7 J* c/ p# z) V' ^8 Y
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    $ I- L& a7 i! T& [$ w4 I( G- t2 g
64.    foreach($worker->uidConnections as $connection)
    / J+ {& Y1 A/ H( s7 f- i
65.    {
    
66.         $connection->send($message);
    
67.    }
    ( s- {5 D% w. W9 K4 ~! y
68. }
    9 [3 n4 Q  I! W( y
69. 
    ; D9 |8 G( Z/ x8 I# `# S( I# [
70. // 针对uid推送数据
    $ P* q& U3 i' {1 A3 V8 n3 p6 ~
71. function sendMessageByUid($uid, $message)
    / ^4 t5 E+ |# @. D4 Q+ I
72. {
    
73.     global $worker;
      B' G. ~/ z( h5 F/ x- g
74.     if(isset($worker->uidConnections[$uid]))
    " K0 T7 u% O3 b% T- R  ?" c
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    " e# S1 x3 z. ~5 a3 B, F
77.         $connection->send($message);
    ) F7 \9 l! Z0 e9 H" e' G
78.         return true;
    
79.     }
    : Z$ r; u  e2 g! ~7 @7 R
80.     return false;
    $ a3 r5 [7 Q0 M" z. x
81. }
    
82. 
    
83. // 运行所有的worker
    4 N0 N7 l# V, X3 y( c6 f0 g
84. Worker::runAll();

复制代码

启动后端服务 php push.php start -d

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   * E* Z- |0 L- n  N( M
2. ws.onopen = function(){
   ' |* W- C' e( ~8 J" g
3.     var uid = 'uid1';
   4 @: E' D! N  D! o( {
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   " z$ X! C1 G% l% t' s$ x' q# f& L
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
     @' G7 z+ A8 r- t
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   3 E3 |2 [6 c3 G3 k4 E* ]' l; L' \
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   & ~/ m' Z" C% x8 u. G
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   # R$ j1 E) \# _# N4 Q: ~) \
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   , h0 z( ?" Y6 o% b9 r( j% o
8. echo fread($client, 8192);

复制代码

( m7 N. Z# e' G; H# {7 v& M* L
1 V$ G; s- i, {( A; N9 e