用于实例化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. 
   ( d. u0 X; v. Q$ I2 c
4. $worker = new Worker();
   # K* G$ [5 E, Y: j5 d7 {4 t
5. // 4个进程
   
6. $worker->count = 4;
   / v2 F% M, U7 R6 M4 z: n* ~' ]$ A
7. // 每个进程启动后在当前进程新增一个Worker监听
   6 W+ }2 X( W0 A6 a9 c4 h
8. $worker->onWorkerStart = function($worker)
   1 X. M$ ~0 f7 p: G$ S8 Q
9. {
   
10.     /**
    " h4 f# b* l' @- K9 C, m5 ?, C
11.      * 4个进程启动的时候都创建2016端口的Worker
    8 a/ q  z" ~) e! w/ |0 C
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    - a) g' C( L, s
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ' }! t2 N( L6 X5 h3 R& l
16.     $inner_worker->onMessage = 'on_message';
    8 f; d$ [7 u$ @" l" a* \0 t1 v
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    , r$ P# K  j6 Y" n( z5 V+ T! _7 d0 f
19. };
    
20. 
    9 a# c) S2 ^' V1 Y& {
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    # d8 \6 L; P2 n3 t' M$ [# {5 |7 n7 w: c7 t
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    3 c* |: ?6 Q( Q( ?; U! m
31. 
    
32. use Workerman\Worker;
    ' B5 u* P% D& C; b# Z: K& @/ D
33. require_once './Workerman/Autoloader.php';
    
34. 
    + V  e) B' a2 u
35. $worker = new Worker('text://0.0.0.0:2015');
    ( ]" L) K  x' N2 |
36. // 4个进程
    
37. $worker->count = 4;
    : u$ k2 d& y: _3 d. S$ X
38. // 每个进程启动后在当前进程新增一个Worker监听
    ) R- g2 F' S) i" I6 m
39. $worker->onWorkerStart = function($worker)
    9 Y: ?5 b2 P, X3 h2 o! M+ u6 \( j
40. {
    + j5 Z2 k5 Q% t5 _- X- |
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    . l4 z! c* c" \' w0 w  N- e. S( e
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    - W" L6 P# T$ b' \) r) v# ~
46.     $inner_worker->listen();
    $ q1 [8 o# y- ]+ o( ]' y
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    
52. {
    ' L: @# C6 E$ h% e) G3 X
53.     $connection->send("hello\n");
    
54. }
    * K; `  \/ `+ Y) M" J" X
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
   7 z3 X8 y& e* O
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   - b+ J4 j4 v% \4 q
5. $worker = new Worker('websocket://0.0.0.0:1234');
   # m! m- g$ Y5 L0 F6 w; f
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   ) E$ h7 m8 a9 {  K+ \- b- [2 _
10. */
    
11. $worker->count = 1;
    3 T5 |7 u+ C8 B
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    1 U# h: W, w4 F9 ?* }7 J% t
13. $worker->onWorkerStart = function($worker)
    . Y* C- w. g# \2 k
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    $ n- S6 Z% B, q) G9 |
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    : y- B; z% ~) R
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    + M4 F5 _* @* Y9 [) Z& C
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    $ q1 K& t) k3 O( x+ f' D
33. $worker->onMessage = function($connection, $data)
    $ r, l* A, f% c- N& E
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    / z7 z1 K  ?) y6 O$ ~( O) f
38.     {
    4 e1 y/ `2 P  J: B2 O6 j
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    8 r+ Z8 [4 \0 e( s$ X, r% N" c
44.        $worker->uidConnections[$connection->uid] = $connection;
    ) s( W1 o" y# l, w& }' Z9 Z& i
45.        return;
    
46.     }
      E8 ]! L3 h8 i! q: ^7 c; I+ M
47. };
    ; b# u& K) b- |) A8 H4 y) P2 l  |( A- R
48. 
    , B. \& ]: A2 y3 O7 P' {9 \
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    3 t+ F7 H3 C0 |  I9 k. N$ H7 y
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    + Z) N& P; w; X8 T  z
57.     }
    
58. };
    , s, `* A5 z) J3 _
59. 
    4 T. M% q9 J+ A$ \
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    - q5 w7 C. M0 U. o
63.    global $worker;
    2 i& m7 x4 {2 R6 I3 h
64.    foreach($worker->uidConnections as $connection)
    ) W5 z) B# h. p  G/ ]) P
65.    {
    
66.         $connection->send($message);
    7 Z6 K& n" h3 U& A) d) Y! I
67.    }
    * i2 t2 @& @: o( B5 o( V  `
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    , L8 y8 b4 ]) A: e4 x/ {3 o8 P
72. {
    : v3 v8 M( l, E4 F- \# M: K
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    & m. p. Z. L2 b% ]& L
78.         return true;
    
79.     }
    
80.     return false;
    
81. }
    
82. 
    ( z& |# D9 x" N: p
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';
   0 ]) w& {: Z" N% x8 b
4.     ws.send(uid);
   - l! W5 D, D- o2 a) B- f
5. };
   7 Y7 ]% p' `4 M0 x# ?% K
6. ws.onmessage = function(e){
   : y; C7 e3 N3 c% J# r+ O+ x4 d
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   / j4 \0 o$ ]; n5 w
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   ( A- @6 T% M' q
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
     A( L5 i. d' c$ j8 D$ o) E
8. echo fread($client, 8192);

复制代码

2 e7 A5 t: M& _