用于实例化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;
   7 {  C( N4 q6 q$ M. `
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   1 B5 {% F4 w0 L9 z
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   4 s. T; b: z$ w8 B/ R
9. {
   
10.     /**
    ! b* h7 N9 d% }7 x1 f' x
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    , b; a/ F6 w8 v* l, A( x3 T6 g
14.      */
    " y0 v3 H( K) p2 e2 x& M! b0 f
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    4 d' ?' B% R* G4 h1 q
18.     $inner_worker->listen();
    
19. };
    
20. 
    0 J' p" F# G, i& ^' j( `
21. $worker->onMessage = 'on_message';
    5 D( J" H$ ~, T8 |
22. 
    
23. function on_message($connection, $data)
    . ~. w9 L7 `9 O0 d
24. {
    4 E) ]: G/ ?% a. n, ?
25.     $connection->send("hello\n");
    
26. }
    
27. 
    % V8 E2 N. N/ z5 ~- w+ k
28. // 运行worker
    # A7 t3 Y( I2 j" B3 e
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    1 y4 W4 v2 _. f" g% P, i, J
31. 
    # H9 t  U/ q, z- I, X6 S
32. use Workerman\Worker;
    ; w0 a9 M6 i, j8 \  |
33. require_once './Workerman/Autoloader.php';
    4 r  \; M# w9 ?, G' Q, p
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    9 B+ f6 _) N& U5 Q. @9 B
36. // 4个进程
    " l. K6 y7 t6 h6 k& T5 k: W
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    8 r0 b$ ?" S3 j' ^" w, h2 p
39. $worker->onWorkerStart = function($worker)
    / g3 m3 J. h& a8 J; ?
40. {
    0 g& ?" U* A9 {$ }5 a/ Z
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    5 e9 E' x8 U- U! r7 u2 ]
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    4 O+ j0 o8 p1 Z6 P: J! O
43.     $inner_worker->reusePort = true;
    * p' K; G1 w' y( t
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    8 u. B+ w- F7 s  h0 V: v2 L( G$ a
49. $worker->onMessage = 'on_message';
    
50. 
    ( c6 Q- D" T6 D3 Y! r% t
51. function on_message($connection, $data)
    
52. {
    # P8 M3 L9 R6 r2 e% J+ Q  s$ j/ @; y
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
   * [# z, ^/ @/ _: q8 V! ~  ^* P
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   ' l5 o; J/ X$ }0 g+ l; r6 |
4. // 初始化一个worker容器，监听1234端口
   9 q! J) p) E+ ]7 w
5. $worker = new Worker('websocket://0.0.0.0:1234');
   * d; M! a& j" l
6. 
   4 m: q- ~( \" X$ M0 x( p
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   - k9 [- ^5 E( i- `! _
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   4 h3 U9 I' l0 p" a+ o
10. */
    
11. $worker->count = 1;
    ( s  `4 u) c* U% o, c. y0 @: z6 v
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    $ S4 h5 ?0 i. x$ @- ~! {
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    " v& q6 X4 N. Y* K+ @, [9 w3 P
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    6 n4 l1 D1 H2 n$ ?- Q6 i
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    % W5 O/ @3 \# g: W6 T% K, t5 t- Y
18.     {
      d" E1 _3 r/ S  E8 A
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    & V/ K0 L2 R! o+ x0 |: L
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    2 G! Q! R0 g- P' e% v! ~
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    ; |' o5 o: r( n/ H5 M0 u3 |
27.     // ## 执行监听 ##
    0 a( L+ ?1 p2 t9 Q- {9 ]
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    " u+ G  e4 s5 b$ d3 S
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    + }7 \5 D3 _1 O* p* y
33. $worker->onMessage = function($connection, $data)
    3 V. Y2 R! z+ A% r: j. V0 d
34. {
    
35.     global $worker;
      |8 Q' m$ |( h# R# |9 i
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    ) \' j/ {+ p0 b. G; R. {
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    " z- {( |, H) [7 z
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    7 W, {0 W# G& _; ]
51. {
    4 n& T: P8 w! `7 c" L0 E
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    ' B2 I, P" P2 k6 ^/ U
55.         // 连接断开时删除映射
    1 G3 X4 s' e7 X/ O7 @* @7 F2 @! w  n, \5 c/ Z
56.         unset($worker->uidConnections[$connection->uid]);
    1 b/ {  J2 q3 G4 |, x
57.     }
    
58. };
    9 G5 }% B! i4 p7 t
59. 
    2 L' W% A$ L/ `: `5 O2 `
60. // 向所有验证的用户推送数据
    * K0 A% F0 a" m9 E* y
61. function broadcast($message)
    3 m, ~/ S6 T- [) s# ~
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    + D5 Y1 ?  I, y$ R; }
67.    }
    . u3 q' V. @& T( B7 \& p* n2 N
68. }
    
69. 
    ; D' l; w( Q4 e. I- p0 w  K  Q
70. // 针对uid推送数据
    ) h  ~- @* r5 i; O2 _
71. function sendMessageByUid($uid, $message)
    " s7 U9 r# `; s$ T  h; E
72. {
    / b. _' o% P7 m- y  H5 }( `9 [
73.     global $worker;
    1 |; S5 W& O/ N5 S
74.     if(isset($worker->uidConnections[$uid]))
    " v9 K/ _5 l; j) E- O! j4 w5 Y
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    ; m9 O9 @& X  E5 O; W$ y
77.         $connection->send($message);
    
78.         return true;
      U& f9 E9 s. t- `( X
79.     }
    
80.     return false;
    ! k) g& _. N; g# ~; R5 ^7 u
81. }
    5 L0 ]; \+ m/ U' d
82. 
    
83. // 运行所有的worker
    7 B; K) _, e$ a4 j$ a9 v( \- E
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
     B4 i1 T0 l" A5 s0 R
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   
5. };
   3 z+ v! n! U) [1 a7 y/ {) p& ]5 T0 B
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ( P  ?# x. r) B" o! r% k" o
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   % Z2 K5 g+ s% I5 I+ `3 C
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   2 D' H% \/ h' R
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

8 `8 \' d% u# h  b0 P
' N- l5 G/ a2 C* m  H1 O