用于实例化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;
   * w, C6 p: M* O; P# T9 \& i
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   5 _. Z# n( M. [1 E+ j. X( J
3. 
   3 R1 r7 m; C7 {1 _+ Q5 p
4. $worker = new Worker();
   
5. // 4个进程
   + N3 X0 d( S! B  z+ N( x
6. $worker->count = 4;
   & S  G( D) Y4 F1 E
7. // 每个进程启动后在当前进程新增一个Worker监听
   ; `: {# Z* n% O; t
8. $worker->onWorkerStart = function($worker)
   ; k4 }% c: d9 k" T
9. {
   % v4 g$ ]" r) V: l% e6 R
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    ' R7 ~2 n7 o# s+ _2 m5 M
12.      * 当执行到worker->listen()时会报Address already in use错误
    ; W4 |' g' |" R" X4 r5 g- c+ o) h
13.      * 如果worker->count=1则不会报错
    % u* M+ t5 T# h" k
14.      */
    ; P* k$ N) N3 c. C4 ~- @* v" I* i
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    8 Z& S9 y+ m- l* D4 n4 P& g' i# E
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    , m& u. e5 O; j- g" }
18.     $inner_worker->listen();
    ( P; w8 u* \" \# {/ W% {
19. };
    & j/ F5 p' `9 m
20. 
    8 r7 F$ g! ^0 `. f+ j6 I
21. $worker->onMessage = 'on_message';
    $ |3 k+ c# r/ E# I# @: Y4 b
22. 
    
23. function on_message($connection, $data)
    : Q" n( ^5 u% Q7 z9 t1 ]
24. {
    
25.     $connection->send("hello\n");
    
26. }
    " u5 j) s5 x5 L  J5 y: _
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    ' Z) H2 c% J4 z7 B, B& v: g6 H- n
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    & a( @3 T' C  ?8 w
33. require_once './Workerman/Autoloader.php';
    
34. 
    ( d; f" w% w8 c4 f: _* S
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    7 Y! u% N+ `# g- [4 @1 e
38. // 每个进程启动后在当前进程新增一个Worker监听
    $ J5 G/ O( G5 l! n1 ~+ z
39. $worker->onWorkerStart = function($worker)
    
40. {
    6 h5 j# X1 ]2 t0 \+ O  L+ f3 G
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ) ~1 n1 c: r0 @  r& x
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    " B: f$ A# |" h; \
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    , E* }1 s) G, g6 r
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    5 T5 j) b5 y" W) H7 e  c6 l- @
47. };
    
48. 
    ' D; f: F; b; J" X/ X
49. $worker->onMessage = 'on_message';
    ' `* r7 |8 u" |! R1 d. Y; @) [
50. 
    
51. function on_message($connection, $data)
    ) e- N" }  U8 y' T
52. {
    
53.     $connection->send("hello\n");
    # w- b" J! i6 U" |& V: d
54. }
    4 b9 m) w/ L# g, J) A6 t+ c; g* S
55. 
    0 a( I6 C/ }/ u- p* ~* g
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';
     Y9 V& B% m" f# N$ W$ _- v9 [- f
4. // 初始化一个worker容器，监听1234端口
   " r* K" y4 K& ]1 R) p; j) j
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   2 i$ ?1 X  c% N
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   4 I3 I$ z- S% G  L1 \4 q5 q
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    9 q- }, G+ U. f% S, Q
11. $worker->count = 1;
    * M3 c6 u5 w1 j
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    5 {( H( U4 y/ B! `( q
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    ; I6 ~4 }- c6 i. t7 F. {
18.     {
    1 x0 ?1 B1 d$ K( n+ m$ G, _& d
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    + \/ |4 u7 u7 u) A# n/ ^9 k
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    1 i) [% a; G0 T7 K0 v) r
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    # V2 M$ a, I- H0 D' g9 g9 d& v
25.         $connection->send($ret ? 'ok' : 'fail');
    ) S# l- Y8 e( |, g
26.     };
    - T0 v9 a# G6 x* m5 _9 V0 D
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    ! f1 c# v  y0 `& M  m4 J9 t) }
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    % N7 ^' U2 r4 h# v
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    9 b8 Y3 G* U5 i$ m0 C, u
34. {
    & b' D% @/ @/ E8 P
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    * L$ ?7 q1 p" Q4 N' s3 K9 U) f  U
37.     if(!isset($connection->uid))
    
38.     {
    1 G) C/ U5 o" K, @+ V
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    2 W4 ^& u! G& m  B7 g
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    - V& p# r' y$ z% [# k- t. {2 Q/ [8 G
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    1 V( J* Y0 a- y6 U, }
45.        return;
    5 I3 |) o+ c) a$ ]; b, e1 b
46.     }
    
47. };
    / N+ |/ V. r4 e( p( A, o' e
48. 
    . c' D( T2 [  k+ A1 S
49. // 当有客户端连接断开时
    6 b* {/ o; e  p* I  Y% ^% [- j: M
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    4 a/ C, w0 F/ i; V' C; H8 x
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    $ A' g, u0 H+ }" ^6 E# {5 ]9 I8 s  K
57.     }
    ( Z- U: i- Q9 w$ t( o3 i+ V8 v* W# j
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    8 U- p2 d1 v9 U+ Z' f# L' O
62. {
    
63.    global $worker;
    + i% n4 |) f) i3 T  R
64.    foreach($worker->uidConnections as $connection)
    ' @0 j8 Q" p3 a  W6 V" S
65.    {
    
66.         $connection->send($message);
    2 O5 B) ~  g& p2 _! y) S
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    * [+ B6 j: u' p) x: \
72. {
    6 Q. c( Q+ x  _4 X: C1 j
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    - V8 y9 k; s' q. m" M& W  c" I
75.     {
    ! E. v8 A) ^! u; a, a5 }
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    6 ~3 s! K" M5 N' @) i3 O; G/ ~' r
79.     }
    1 d- D% U! `. b( w! w5 ?
80.     return false;
    
81. }
    
82. 
    7 A5 N( ?7 X; N/ o' u
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(){
   
3.     var uid = 'uid1';
   ! h4 n; h9 X% }5 `! Z3 b' ?8 C
4.     ws.send(uid);
   " Y# ]( S$ K4 H+ L+ T) q
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   9 [" {% u. o' U/ D, m- J3 R/ A* e
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   7 T# f( q) Z& Y% `0 z  s+ i
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   - X9 x7 j/ Z& G( w* O1 i9 p5 l9 n
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   # c/ z$ L% t/ V  r' y
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   ! g  t4 q2 p3 v' r4 L2 y
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   2 [& Z2 l2 {: [) K
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   % s6 O, q( j1 e  `- F
8. echo fread($client, 8192);

复制代码

' A* U$ H1 x; \+ [; `0 ]