用于实例化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 i- V$ N6 W% z6 J0 E
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   + m  \" ^( b& g% V  `) D
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   3 }! E( A8 f0 y" F
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    1 W9 n0 J) s! C8 u  i
12.      * 当执行到worker->listen()时会报Address already in use错误
    + ~# N5 D6 X' W' e
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    " a' K0 x& x3 R
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    % ^; m( @$ b# b0 F; y
21. $worker->onMessage = 'on_message';
    6 r. B" P' ]  f
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    ( N; i% z. A5 [" u
26. }
    
27. 
    
28. // 运行worker
    / H4 Z/ E; I1 M2 V
29. Worker::runAll();
    6 K) p4 G$ I* Y7 z7 m5 I
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    7 ]" n; n! N( w7 `/ x5 L5 ]6 X% v
34. 
    ! T- Z% J- b+ s/ \% I1 O7 A
35. $worker = new Worker('text://0.0.0.0:2015');
    4 ^7 F4 K% ?. y% V& D
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    " d' \5 b/ R' e% |/ a& J
39. $worker->onWorkerStart = function($worker)
    
40. {
    3 R- r! e7 g1 r3 S/ C4 N
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    0 T3 ]. ]+ L- i- s, y2 t6 L
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    % |1 ^! g, p+ }$ I
45.     // 执行监听。正常监听不会报错
    - N8 ?0 ]* |( T5 ?. c/ c
46.     $inner_worker->listen();
    - l  N) p  p2 _, \* X6 ?; E& h  n5 w
47. };
    1 |8 F# W, A9 V1 \
48. 
    2 \/ o( @6 Y4 R6 X9 H# q# g
49. $worker->onMessage = 'on_message';
    
50. 
    . `5 _. j: B% v) `% i
51. function on_message($connection, $data)
    ) r5 K$ F% K! D# l! n- A2 ?
52. {
    
53.     $connection->send("hello\n");
    
54. }
    7 \9 E& Y/ p+ o1 X( h' o  ?$ j, H! J
55. 
    
56. // 运行worker
    ' |; Z  v5 x2 \# F( [
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
     N# ]4 M7 p9 q) l/ ?
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   ' \( u4 I% Q$ ~- J
4. // 初始化一个worker容器，监听1234端口
   * \* B  c, T8 M7 N7 y, Q& Q
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    , d% b- h5 t2 E* R% E
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    $ \4 `' ?/ {4 V$ r- a2 X
14. {
    ) N8 ^! v: t5 O8 c7 m& U
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    " Y  Z1 `* [4 `* M2 g' R8 l3 j
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    - V9 h) }1 B/ I3 K2 A
20.         $data = json_decode($buffer, true);
    5 U' K1 H- G% |% y
21.         $uid = $data['uid'];
    3 w1 H: B8 s$ w, i  l+ ~
22.         // 通过workerman，向uid的页面推送数据
    ! ^+ @( p! e& D0 `/ p
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    % \0 H, Q$ A1 G/ b: c5 @& I4 [
26.     };
    : _% \( M; E( m! c
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    6 R' U- P7 M. a/ A! j+ \5 T
31. $worker->uidConnections = array();
    , H) V2 N2 g, b+ P7 l4 \. _# r: g
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    0 [* v+ ^1 o; v% f
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    * |( I% Y. @+ i
37.     if(!isset($connection->uid))
    
38.     {
    % K; M8 `1 t7 r. L. g. V
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    : n& ]3 \7 p! D( T5 ^
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    8 B  [! R7 }1 k/ C4 T: i
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    ; P! l' y( K/ M* ^1 t/ a5 O' B# \- T
45.        return;
    
46.     }
    ' k. Y6 G. o, `6 U" k+ @
47. };
    
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    1 N& D" A. r( z" J, s5 Y6 x
52.     global $worker;
    3 o& ^, y/ T. Z1 k$ e5 M' e
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    ' W) y, D6 t1 {3 x( B7 f- w: Z
57.     }
    
58. };
    4 H* Z7 m; Z7 S9 `, [( V3 G
59. 
    
60. // 向所有验证的用户推送数据
    # u6 j9 \) R, h) L1 {2 f9 t5 i
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    ) l( L0 M6 C% o8 T$ U
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    : z. ?; x: s* X/ ?: v% d/ l
66.         $connection->send($message);
    ; K7 t$ \8 m2 b7 i7 U, X/ {
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    ' E+ C9 D: a' ?
72. {
    2 F3 k4 g# s( u6 E
73.     global $worker;
    & b( D1 o+ N2 R8 n
74.     if(isset($worker->uidConnections[$uid]))
    7 }! ]- o6 c5 A1 g$ B& G: b6 g
75.     {
    ! n3 S7 S$ q% p+ _) p
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    & ]4 |- u7 q5 f1 [$ f: v% A: B% U
78.         return true;
    
79.     }
    1 l- c- n! E+ Z% u( |
80.     return false;
    4 |: k4 K6 I3 |$ A& m0 D' k7 d
81. }
    8 y5 [, x) t6 y/ L6 j1 r- ~
82. 
    
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';
   
4.     ws.send(uid);
   % v2 _. C: C  q: o$ j
5. };
   : H7 r( v% M9 |0 U# p% x  C- @# q
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   ' j: M7 a9 P8 W( X" r5 W  y' X
8. };

复制代码

后端推送消息的代码

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

复制代码