用于实例化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;
   , T! N: _2 k. G- Q: b9 g; Z
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   7 w2 p' i% n! y0 D' \' q& N
3. 
   2 {' r2 w* Q. P" e- n; a% s7 Y" ^& C
4. $worker = new Worker();
   
5. // 4个进程
   2 N3 d9 ?( Q3 p* s) [' p
6. $worker->count = 4;
   , D6 \, e# T/ Q: D( V% u1 C
7. // 每个进程启动后在当前进程新增一个Worker监听
   7 B% E- T- o0 d* d+ P$ O4 t
8. $worker->onWorkerStart = function($worker)
   ; m$ f$ }9 H. r5 a! }6 V2 x
9. {
   " T' Y, v9 L  |6 P7 z
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    6 c/ s3 [! }9 f0 [  Y/ D3 B
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    ( n: e! y1 \0 F% c; ~& Y
17.     // 执行监听。这里会报Address already in use错误
    0 z3 J5 O) e6 O' |' l% s
18.     $inner_worker->listen();
    ' y7 p+ o! |0 h) O
19. };
    2 I( t+ E& C( e. P1 h; m3 p9 b
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    & v0 Y8 R& b- |0 z# Z
24. {
    : m  o4 p9 j+ X6 g1 E0 K
25.     $connection->send("hello\n");
    * ~! s# F' I8 ]) ?# _9 j
26. }
    
27. 
    
28. // 运行worker
    " f( e# G7 L$ q. M
29. Worker::runAll();
    / m: g7 ~& r2 l8 B% e
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    2 ~6 R# n8 Z8 b9 x; {
32. use Workerman\Worker;
    0 c4 e" w  D3 s2 D( m0 }: G: g, }. M
33. require_once './Workerman/Autoloader.php';
    $ x  z3 [  n! y: u+ Q/ S
34. 
    # [6 a/ R+ z. s# t
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    9 @$ X" K, @! [# P; D
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    ' p, g: f5 b3 w! d
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    % Z) N4 R4 q) u# n6 i7 w
44.     $inner_worker->onMessage = 'on_message';
    + p+ [) T3 j' Q" R; }4 x3 G0 H
45.     // 执行监听。正常监听不会报错
      ~1 @2 I# g2 R) O
46.     $inner_worker->listen();
    
47. };
    : ~8 f" W( X- |5 \! c1 }# h
48. 
    ' m, f2 B+ q3 A$ X% z1 C2 {- M
49. $worker->onMessage = 'on_message';
    6 x( ~3 L" n$ d2 C: S( K
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    % E  `; n  \) l6 e! l- l
56. // 运行worker
    - A# E/ _) N6 t! s$ a# u" [
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
   1 u& H5 g- v- S6 l; I: z
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   & j# h& _6 t" v5 Z$ q" G- x
5. $worker = new Worker('websocket://0.0.0.0:1234');
   3 }) T+ y) w& [8 G6 r
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    8 G9 G& I/ D$ p, I' p: e
14. {
    % j+ b) I7 x8 {; }, _( |9 o
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    ' Y9 s5 R, Q: E; `" f1 m* G
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    5 v8 L; P+ ^1 j/ b2 R! ^
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
      M: m* s; V( R" c: s3 e
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    ) V) }6 n0 C- B2 L* g
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    + C* m8 H1 n1 n: M6 n* r0 ?
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    : }. u2 w  x0 m+ z1 O; M5 l
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    . L/ _2 k$ u0 q: R+ `& U* d
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    9 A" m: R3 p5 c4 F4 n1 ^3 ^
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    " @9 x" T; m) E+ K9 S- s
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
      f: E1 N* O, B) d
40.        $connection->uid = $data;
    5 @- P7 ?+ J/ x9 q+ Y
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    5 L! E1 t& u( f* t9 }
42.         * 实现针对特定uid推送数据
    
43.         */
    3 b: P7 @# g4 q5 r1 R( y
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    
47. };
    
48. 
    ' D1 z5 r* v; D* h' L" D; v( }
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    / t/ d7 _3 w" z) `, S: E
52.     global $worker;
    2 b) O# r6 B" i; ~- W7 l
53.     if(isset($connection->uid))
    + d( K8 m" Y+ t$ a$ l' w
54.     {
    ) t) g7 Q! F4 y: I, d7 N6 g9 J
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    & G. y% A) }! v: x" q, V0 @/ |) |
58. };
    
59. 
    6 }8 y* j1 w  K- Q
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    2 |9 b7 F& b! _9 b' U
64.    foreach($worker->uidConnections as $connection)
    6 C1 O3 z/ O2 }7 q9 D! p5 @
65.    {
    
66.         $connection->send($message);
    " H" ^) h4 z  c% G6 L% R2 }
67.    }
      \& v4 ]' U% |+ C: e$ I
68. }
    0 r, |) H; I6 l3 W$ `0 V* E
69. 
    , t8 m! }4 Q' v1 {# g
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    3 _5 B1 l# c9 \* v  H
72. {
    
73.     global $worker;
    2 L8 K, [0 ^8 r2 [  A3 ]5 o, I
74.     if(isset($worker->uidConnections[$uid]))
    " W' T) c4 Z8 S4 T5 M8 E) X
75.     {
    , I1 B. C! D$ Q$ W% w& K$ d' K
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    2 J9 O5 ^+ Z9 R9 i* v  ?, _
78.         return true;
    4 B$ r) r/ h# d# w
79.     }
    " Q6 b# V$ M4 W: G) U% H. d
80.     return false;
    
81. }
    
82. 
    ) |/ l' U* R6 L8 V6 V% O0 _* _- f
83. // 运行所有的worker
    * i( B9 r( j7 f" [, A2 |
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   6 L3 m0 b! z! d3 ~1 u* q! g% e
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   % q% T5 O! v" U% `% C* W. o
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   ! n5 Q, ^3 N; ?3 M( X$ A: j
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ) i) s2 \. Q5 ]' u% i' M7 o% v
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   1 Q5 n1 G* z+ U" x( Z4 ^
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   6 I+ Y0 |& k4 z- b3 b+ n
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   / N' C* K5 D3 f" {% ]5 k  C8 S
8. echo fread($client, 8192);

复制代码

* H+ z$ [% `% J: B3 f- ?
+ T% I  F& t# i* |