用于实例化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;
   6 a1 v( r* @. r0 }1 u% v
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   , ^, K0 a, g' X8 J
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    3 C/ o& _6 U8 x6 U. ^
11.      * 4个进程启动的时候都创建2016端口的Worker
      R1 u& f, ^" S3 w9 j+ }
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    7 [; }) i7 q2 P( x( x
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    2 V: L9 S2 E! u+ o
19. };
    ! d& z  ]4 j: A5 a# F- S5 l
20. 
    , r% ]0 T; E# D7 V
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    * J# |+ Q" k( F9 W' E
31. 
    " E) h$ I% r$ e/ e
32. use Workerman\Worker;
    " m. t, H+ c1 C0 `: _# D/ w! e% I
33. require_once './Workerman/Autoloader.php';
    3 S2 D5 o% w$ I
34. 
    5 @4 I  Q$ e0 C# B
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    ; b3 L3 y0 `! \: ~4 Y
37. $worker->count = 4;
    $ o4 K. p; e' s+ u: x: }
38. // 每个进程启动后在当前进程新增一个Worker监听
    ' n4 {2 i, N1 o" R# U# x3 G; K  o7 D
39. $worker->onWorkerStart = function($worker)
    1 {5 M4 D( V& l4 q
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    * f5 E* R8 }' q* }8 r
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    ( T. |4 m, x, W' f  U9 g* j- q) k, e
49. $worker->onMessage = 'on_message';
    
50. 
    $ Z0 s! K5 s5 D2 M
51. function on_message($connection, $data)
    
52. {
    - d5 g% R; d9 W. ^" v; ~, O  n; }& Q
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
   
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   % V* t1 _( b; z, }6 Y8 A
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ! ~3 T3 u( A8 ]$ w3 ~) N
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   ( p& _+ |. i/ H# X  j
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   3 c7 P- B' n0 J6 |
10. */
    
11. $worker->count = 1;
    ' s3 a# j0 F. ]! R7 x5 Z0 h
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    - G% R7 _, C+ p& j/ e% B
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    . o! K" ~9 y0 k4 [
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    5 [6 t9 m# f1 P3 L7 S
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    ( S. p' P+ E2 R! E) Q/ @+ g$ O
24.         // 返回推送结果
    ( C! z6 B- H- Q1 ]4 D8 _
25.         $connection->send($ret ? 'ok' : 'fail');
    3 ^5 z; l( ]2 O8 c2 W5 Y+ |0 k
26.     };
    
27.     // ## 执行监听 ##
    ' `  c  M" t$ S' O: W& F- w& R2 K
28.     $inner_text_worker->listen();
    
29. };
    7 R2 Y4 R2 Q2 p4 m& [( j8 N. N8 ]+ Q
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    * a' ]" Y) Q6 a& F( s- Z
34. {
    3 ]0 W* Q5 ?1 `! Y7 F9 a
35.     global $worker;
    ! |6 N. `) c! v% K1 p+ O* p$ i% |' ~9 Q
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    & ~6 H( u% ~- s4 ~5 W  i- ~3 i
37.     if(!isset($connection->uid))
    
38.     {
    7 ^2 Y: p4 i8 L+ K
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    2 U( @$ o, d8 }+ Y. }
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    6 [% f: O$ s" O% e
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    / l5 y7 D2 ^9 f' Z  f8 \7 U
45.        return;
    7 e/ W, M! v; |/ c/ j: _: ^% O
46.     }
    
47. };
    
48. 
    ' e( q  D# N3 @" P& a4 l$ h/ }) h
49. // 当有客户端连接断开时
    / h5 g$ W) F. A
50. $worker->onClose = function($connection)
    3 ?. i& o4 _9 `
51. {
    $ j' g/ E$ a5 T2 e# }9 J
52.     global $worker;
    $ e9 i" K* l; O) \& {  C
53.     if(isset($connection->uid))
    # P9 q. _8 p0 t
54.     {
    6 Q5 J/ ~5 k  V2 G
55.         // 连接断开时删除映射
    . [$ d, x  ?9 V, F
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    $ f5 s: s! U& M2 E
58. };
    2 G. o2 P- ^2 _1 Y  X
59. 
    . `* `9 I# }, p2 c
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    0 T. ?- P# f( m7 ]3 G! i
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    . Q/ b% ?2 V/ n* o; P0 J, r
65.    {
    
66.         $connection->send($message);
    
67.    }
    
68. }
    , K8 ~! i& D% E6 l
69. 
    
70. // 针对uid推送数据
      o& v; X; }7 E7 k0 u
71. function sendMessageByUid($uid, $message)
    ; P0 Q1 q2 g; l' m& s
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    & T( P' w) A( N
75.     {
    : n  ^* {. I+ Q8 K+ B  p& N: C
76.         $connection = $worker->uidConnections[$uid];
    ! S4 H3 v- m/ j5 D! Z6 H
77.         $connection->send($message);
    
78.         return true;
    ; o8 P5 |8 T. p! Q7 z2 S9 n
79.     }
    + H4 d# E2 H% ]8 r0 f9 l  F
80.     return false;
    
81. }
    
82. 
    
83. // 运行所有的worker
    , B2 t7 _5 ]- d! W8 R2 l2 F
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   ' B! A* J' x) M
2. ws.onopen = function(){
   & ~$ ]7 C. {! V
3.     var uid = 'uid1';
   9 Y" M  S& U* A& B6 i" g, @
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   5 m+ ~6 S5 g; f- T
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码