用于实例化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;
   % d' J4 s, P5 |$ T3 ]2 `  ?: |
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   5 U! Q" l+ O1 K6 m
4. $worker = new Worker();
   
5. // 4个进程
   ! j4 m& d9 e$ m6 r# H: V( @
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   " N' f2 J) n9 S9 R: ^! Y1 E) ^/ Y
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    6 L# o8 Y2 h1 G$ U+ B
13.      * 如果worker->count=1则不会报错
      `9 f% L& w" C: [
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    * K  b0 r# `4 P8 y' L. X1 E- p$ @
17.     // 执行监听。这里会报Address already in use错误
    + l. @6 T; u8 ^2 m+ e  N
18.     $inner_worker->listen();
    . d5 G) X5 |- _" l' o6 Z
19. };
    , D/ z9 a1 u, l
20. 
    ; b0 e+ u$ p$ n( @4 V0 P
21. $worker->onMessage = 'on_message';
    
22. 
    ( h; ^! x1 o( A" r' z
23. function on_message($connection, $data)
    ) L& D) }, P; m0 |
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    # N% O& q+ f2 g
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    6 l, L  R7 W4 y/ h
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    6 A( y8 f# B% o0 L+ o3 z
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    9 [+ }4 c7 Z$ Q
39. $worker->onWorkerStart = function($worker)
    . P) s0 E. z% C* h
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    2 s7 A  _8 W: Q- [8 x' {, k, ]
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    ; p6 R0 D" E* n
43.     $inner_worker->reusePort = true;
    ! j: u/ o+ G& x% R7 s
44.     $inner_worker->onMessage = 'on_message';
      F8 B4 d& b8 a9 y  j( _. `* Y
45.     // 执行监听。正常监听不会报错
      A8 z5 e0 q( t: X
46.     $inner_worker->listen();
    . N" [4 U5 E5 Y" M; J
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    
52. {
    6 q" k" Q/ V2 B2 ?& F
53.     $connection->send("hello\n");
    
54. }
    / s; H8 V5 e4 V6 f. u
55. 
    
56. // 运行worker
    - p, J6 A& e- |
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
   ( m, H: U0 |" W) e, V- o
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   # P$ \/ q7 {9 B
4. // 初始化一个worker容器，监听1234端口
   # T' W0 u+ j9 l1 Y
5. $worker = new Worker('websocket://0.0.0.0:1234');
   - r! Z( ~: L2 t9 W
6. 
   . D, x0 C  s/ c6 @: T9 U
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   * {, j; Y! y0 }+ U1 m. s
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    , r. o2 c0 @1 s# X
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    ( A1 B# J. k# D0 L( ~$ t) t; C
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    9 U! }( [) K0 f3 e# i4 U3 `- B
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    ' `( V+ [) {5 N
22.         // 通过workerman，向uid的页面推送数据
    ! _2 j/ V" T9 K, ?
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    5 U0 a! t6 O5 \3 U* o8 D8 t
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    : V* W: N4 C7 U: y2 ~# W
29. };
    " K: ^( C( x8 J& G! |! p) ^, H
30. // 新增加一个属性，用来保存uid到connection的映射
    + i; c' ]9 E% p3 F! q- H2 S$ u8 }
31. $worker->uidConnections = array();
    ) S# o9 L7 F( R
32. // 当有客户端发来消息时执行的回调函数
    1 V/ M" ^5 O: j2 L9 {
33. $worker->onMessage = function($connection, $data)
    1 h- Y; X0 Q" O
34. {
    ) d- k- J: T! t( }4 e
35.     global $worker;
    2 E! `. n0 u2 B, E+ ?. j" @
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    : Y  x3 z. \0 v: @  e6 s* s
37.     if(!isset($connection->uid))
    , a9 W7 b/ w( p- q# \
38.     {
    ; c  k! a6 L( U0 K8 n% N, X
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    * m1 [1 v$ \) z, m% M( X: C
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    , K' E; M4 c; _' T, T  |
42.         * 实现针对特定uid推送数据
    * T" H  k3 u8 N1 D3 @* f
43.         */
    - v3 _0 n/ C: r' o5 I5 m, Z  _$ r
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    
47. };
    ' G# s. \2 A4 u$ Z
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    : e2 d; n/ c; K& N  c
52.     global $worker;
    
53.     if(isset($connection->uid))
    3 G+ m- a6 D$ y% u1 A6 V, h* _
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    ' s7 S8 l! [# z# B4 _& B
57.     }
    , r) g) \# l4 B- u* W
58. };
    , E# o- x' [4 J
59. 
    + D9 C6 j: O' s! f
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    * E. m% I# t' r6 T' \
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    " M% r, j' I1 a
65.    {
    
66.         $connection->send($message);
    
67.    }
    
68. }
    $ v! R& H& X9 _/ V- }: V
69. 
    
70. // 针对uid推送数据
    " e# ?( e+ f& B# ~3 K
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    + N8 s, z* _7 j* Y/ b' S$ f
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    % k+ C0 x7 Y; j) H) {3 K
78.         return true;
    
79.     }
    
80.     return false;
    4 c. f  e  {, a; Q5 v
81. }
    5 U# T5 x, o: ?4 |1 A
82. 
    0 `# t7 s4 I% y  ]$ Q* |
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';
   : D* Z( A5 G- t3 N, X
4.     ws.send(uid);
   * [/ Q$ {) A) \  Z
5. };
   
6. ws.onmessage = function(e){
   & w& S' x3 f8 E# Q5 b1 R
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");
   6 Y+ H8 ?* Q+ i# D- k: w) e
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码