用于实例化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. 
   / C7 e" e6 v- @4 K# ]( L, M6 o) N
4. $worker = new Worker();
   ; ~5 P. v  {* m5 R9 P
5. // 4个进程
   / s" I. i* q$ L  R
6. $worker->count = 4;
   0 w6 Q9 n, z4 q2 {9 g7 ^. U' C
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   * H) w' L* Q% ^& t& G  D% X' s3 |
9. {
   & v0 A: W4 |- Q5 r* ^
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    8 P5 |: y0 w* T" j5 X! e
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    6 R! ?6 Z6 e  S% X& V
17.     // 执行监听。这里会报Address already in use错误
    * |9 t1 a# y" D" {: g: r3 y
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    # U9 O$ t1 F( P* @
22. 
    
23. function on_message($connection, $data)
    
24. {
    - O! n2 F; m, S1 f5 q
25.     $connection->send("hello\n");
    
26. }
    5 u. O$ Z: O$ h) a
27. 
    $ h: I& E8 y/ z
28. // 运行worker
    + i' r: K& Z2 F, [
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
      Q9 Y. k$ r% `. |; t- O8 o1 b
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    + i) a0 c! T3 y# B
34. 
    ) c! n" V2 k' F! ]: w" Q  X
35. $worker = new Worker('text://0.0.0.0:2015');
    9 c4 q2 N* u$ M8 r$ l8 N7 \0 f
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    2 f: M# `5 Q% U
39. $worker->onWorkerStart = function($worker)
    & k, C9 P8 m9 h# E( O! L( v7 H4 Z
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    1 S5 W2 l% W1 E
45.     // 执行监听。正常监听不会报错
    / a5 g9 {0 T& N  y! Q8 Y/ E! |
46.     $inner_worker->listen();
    4 t; P2 s  B" t6 U* J2 s
47. };
    ) i+ g+ C& n$ j- {! K
48. 
    
49. $worker->onMessage = 'on_message';
    $ ?5 d) b4 @. U' V; c  E' C
50. 
    $ D+ m5 S, h1 Q2 r. @0 C. _" F$ k
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    ( x- Q' d% M4 A$ n
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
   : P! r. `- u2 O* I- Z8 l9 A$ b8 h
2. use Workerman\Worker;
   : \& T' r9 v/ E; q5 U
3. require_once './Workerman/Autoloader.php';
   + p+ v% j6 [  n4 E
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ! D- ~2 i; S+ ]" H
6. 
   6 K5 j, |# ^% g& o( `
7. /*
   6 a+ \! h/ k$ [/ P  u: S5 a
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   " S. h6 J; L6 O6 s1 M0 q
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    5 e9 _+ o1 ~# z$ ?
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    4 {8 z* }( ~+ `+ d3 D+ P. R& B
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    , `: T7 T! _. L9 P6 C
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    : U; f, ^2 [9 L3 \2 c, M
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    ( C4 A) p+ h$ i/ S* Q/ d
22.         // 通过workerman，向uid的页面推送数据
    ; C3 X7 j( q; _& n0 o8 c
23.         $ret = sendMessageByUid($uid, $buffer);
    + j' ^* r, |) k  Q( [0 t7 x
24.         // 返回推送结果
    * F0 V8 r( L( c; g6 z& p
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    * z/ I2 h$ P/ z( b- C* `
29. };
      y/ U; }1 I" Y$ N& R7 G
30. // 新增加一个属性，用来保存uid到connection的映射
    7 C  ?4 g' x! S+ g5 m1 s
31. $worker->uidConnections = array();
    . P& F. j8 [* F- C7 b& H# L
32. // 当有客户端发来消息时执行的回调函数
    # @. e1 y: X+ C7 X" z& \% o' C
33. $worker->onMessage = function($connection, $data)
    $ h! P* v5 Z4 y, y( [6 ~8 ~5 }' \0 H
34. {
    & l/ i8 V9 d5 k
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    2 i$ y- G* B" Y" Z. e* a, [
37.     if(!isset($connection->uid))
    
38.     {
    / N* X5 T2 e0 A# }6 c
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    ! p; U( o% L$ m$ ~% L
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    1 P$ z/ [% {6 c4 ], ]0 p3 S4 H
43.         */
    ( B) t+ K( t; \
44.        $worker->uidConnections[$connection->uid] = $connection;
    , q3 C2 K* R- ~7 `; j; {! x. k
45.        return;
    ' K+ c0 P. F2 o$ i2 x3 e
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    1 B2 z: f3 G! c( i$ {# n
50. $worker->onClose = function($connection)
    
51. {
    & V* H. Y9 W! A% O; j
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    & E( w- N7 v; k9 h
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    5 P- }2 j& R- X+ L' g
57.     }
    
58. };
    # r9 Z" F% r4 G% ~7 P" V
59. 
    8 m3 Y& y4 E- n! q( r
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    9 P( h( x: }/ E& _/ `
66.         $connection->send($message);
    
67.    }
    & y; F7 [) J% `  s2 n
68. }
      F- [7 y& J6 |2 j& h
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    9 Z. p( I, C8 O! y' `
74.     if(isset($worker->uidConnections[$uid]))
    8 u. c1 A+ O2 R8 ?4 n# i
75.     {
    ) d4 s& h5 u& m# m
76.         $connection = $worker->uidConnections[$uid];
    9 c* l6 A- [* P$ L+ N
77.         $connection->send($message);
    ( s0 P- n  p9 Q
78.         return true;
    3 O, e7 i# n- v4 J* `; ]
79.     }
    0 e* a6 j' T" Q
80.     return false;
    
81. }
    . Y5 B# q0 p' q  ?# H; v
82. 
    
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   ! s# G  ^0 n; `
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   - o( E- J/ |. s# P& W
4.     ws.send(uid);
   
5. };
   6 O, F+ w3 ~; s! K% w9 D
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   0 W+ b0 V$ b. v  q
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   2 [* x, [1 m9 ]: E9 q/ {( K' Y2 N! A
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   8 l; z+ W! n4 t2 \8 x/ z
8. echo fread($client, 8192);

复制代码

) j/ Z4 T3 ?* I7 E5 L+ _