用于实例化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. 
   % O$ I4 x1 y; g# t
4. $worker = new Worker();
   & C. F' X7 F; @, Y$ B: D
5. // 4个进程
   , }7 R5 T0 p2 g! d5 H0 A0 B
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   . q# C! q5 i4 W; y
8. $worker->onWorkerStart = function($worker)
   1 M6 e& X$ \/ ]. ]: u
9. {
   9 ^3 Z8 b+ w! z3 u; c+ z
10.     /**
    * ~! A' M6 i8 W2 ^+ m9 ], |2 T
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    $ }9 b, c1 Z" y2 B
13.      * 如果worker->count=1则不会报错
    
14.      */
    ! Z3 Z+ u7 @+ T) Q7 @
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    , s7 d) t# W4 G# k) e0 I- I
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
      i/ D3 w% K$ x* n
18.     $inner_worker->listen();
    7 J. }4 T: p% Y* F$ _* D
19. };
    8 S# Q4 D# \# w" j7 l
20. 
    4 @5 V$ o! U8 G' b
21. $worker->onMessage = 'on_message';
    ' A- d, g; r+ G& ?* @$ h
22. 
    ! G$ x* i5 p. ^6 Y" P. Y
23. function on_message($connection, $data)
    ! Q3 D5 ]  E0 M
24. {
    4 N$ K8 u; p' t
25.     $connection->send("hello\n");
    
26. }
    
27. 
    
28. // 运行worker
      h' T& ^" ]4 E) s6 T
29. Worker::runAll();
    7 Y$ f0 l' l' R- t9 l
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    * Z9 A  W/ h7 w* \% o4 B' w+ s" r
31. 
    9 c, _. z% w0 t7 l" W
32. use Workerman\Worker;
    8 n' z4 a+ N0 w: Y9 g
33. require_once './Workerman/Autoloader.php';
      [& L) t. H$ T1 H1 V: c) x7 E! a" A
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    ; b4 x* D, Z* O7 m
37. $worker->count = 4;
    - j9 X$ O! P6 U/ B, ?6 _+ |! P
38. // 每个进程启动后在当前进程新增一个Worker监听
    * Z2 [/ L4 j( S. u0 Z1 O8 X9 m
39. $worker->onWorkerStart = function($worker)
    * F: b9 P3 J# _
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    2 ~& b8 D- C) N' H) ]
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    , V' h4 w& v6 b: q* y, ]% `4 x7 w4 S$ |
43.     $inner_worker->reusePort = true;
    & s5 U' l) |5 W5 g1 x- z1 f
44.     $inner_worker->onMessage = 'on_message';
    : D8 s: J- v& \* r
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    1 o7 X5 F% g1 H4 p
51. function on_message($connection, $data)
    
52. {
    ! K4 m! w( R" X
53.     $connection->send("hello\n");
    
54. }
    
55. 
    ; z+ u' I$ L3 f: t, W8 I- E# q1 k
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
   . }" m% O& K% W/ p8 Q* b; x
2. use Workerman\Worker;
   - b2 a7 ]; j0 U; R3 z7 D
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   7 G) W; n' }1 M' e. Z
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   " V  T5 l! A( {5 d
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   1 a  K9 z! D0 l4 M
10. */
    
11. $worker->count = 1;
    8 G& d! Z: r3 d: m* k6 K5 j% y% M: M0 [
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    - D5 B" U+ N$ b# m0 Z; ~
13. $worker->onWorkerStart = function($worker)
    $ d( K6 Q& i. O# ~* a( I
14. {
    ( X$ }0 ^: z+ `2 H4 Z
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
      H2 X4 g. v. a$ D! q! P2 F
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    " U. E$ ~4 K5 _( V6 u" q
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    8 c$ d( q! h+ N! M, h% ?5 U( v% ^
18.     {
    6 R2 U; r' X9 t- W
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    4 s0 b3 U7 I1 i# M& x" K
20.         $data = json_decode($buffer, true);
    / @4 C- ]" {0 H) R5 r
21.         $uid = $data['uid'];
    * @$ `5 a' }- M; E$ Q: I/ ~$ U! l
22.         // 通过workerman，向uid的页面推送数据
    0 U" ^3 G0 S" q
23.         $ret = sendMessageByUid($uid, $buffer);
    , n$ e8 ~" [6 |- Q
24.         // 返回推送结果
    8 H! ]* I- f, x# k( E' |
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    6 I1 h. w' m# ?) E& Z
29. };
    ( x- v8 t& V# o  B
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    . p: b* y5 s* Q/ [2 X
32. // 当有客户端发来消息时执行的回调函数
    5 j& \! x9 O; b, c9 {5 L& _4 ?
33. $worker->onMessage = function($connection, $data)
    # r) H, @4 l; `7 n6 f* @0 D
34. {
    : E8 t8 a6 V  j8 b
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    " l! s- e& Q: e0 u4 m/ t2 g/ S
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    2 q, Z. R2 T# C( `, ?. b
42.         * 实现针对特定uid推送数据
    + Y  t2 W( r) i' z3 ]) X4 ?
43.         */
    + g% Q- y: [& Z" K; @
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    7 c+ t/ W! Z( D" q3 Q8 [
47. };
    - M: B. r% h) O  Z7 h8 U
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    % C7 m) k) X1 S! G
54.     {
    
55.         // 连接断开时删除映射
    : H8 d7 ?$ ^( \0 ?
56.         unset($worker->uidConnections[$connection->uid]);
    5 y3 }  j# o4 t3 D
57.     }
    
58. };
    . w2 L# Z! F. p! ~: j
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    ; b+ E! e! P) M. f- ~( e
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    / ?2 J1 i$ ?2 ^: T/ X5 O
66.         $connection->send($message);
    / K# ~) P# e/ l' G8 C7 U9 D8 K& _
67.    }
    5 v4 D/ Q! C2 \" p. {" y3 F2 \3 e& {
68. }
    ) c' D% }2 a8 u' A( s
69. 
    ; {8 j0 l( H3 A2 i2 {  a
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    7 t( N0 Y8 W5 X7 v
72. {
    + S: l# L$ ~4 [. |7 v
73.     global $worker;
    . u$ Z9 R$ C& S; J. `
74.     if(isset($worker->uidConnections[$uid]))
    % N2 Y% N6 U  c, w/ [" @  E
75.     {
    8 q) _) K8 L. @& q% ^) l0 t$ S
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    $ g9 s6 N" A$ @+ e
78.         return true;
    
79.     }
    
80.     return false;
    - M7 ^/ ?$ u* [+ v8 Z1 c' F( e: @: U/ e
81. }
    
82. 
    , s- L3 d$ ?4 g, Z5 v5 e" d, A# s# E
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   ! b/ q5 j4 }1 r# |! V( x* W
3.     var uid = 'uid1';
   + V/ g) o+ i2 T; H  m2 h# }
4.     ws.send(uid);
   / B0 P0 U- U' N) I
5. };
   # v: C. [/ \$ \/ `0 Q# |: D
6. ws.onmessage = function(e){
   ( z7 \9 `4 {7 L$ D! a
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ) j& B6 e1 k' s* I4 `1 b
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   ! G3 k/ ?% `2 K3 e6 H: S
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   ' ?4 J& v! x9 t- O; J' A. i. X
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   6 ^3 G. b+ L* I1 k: R3 z
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   . M" F. b7 o; O( z8 i6 m
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码