用于实例化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. 
   
4. $worker = new Worker();
   
5. // 4个进程
   0 Y5 E9 D! W* ?/ F. v
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   5 z" j0 g" U( N+ i
8. $worker->onWorkerStart = function($worker)
   
9. {
   $ z7 K! [* a+ g& E
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    , l. o1 S- H- \* a& d4 @% _! v
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    8 @* x4 `# x6 ]7 H; A& c+ `
16.     $inner_worker->onMessage = 'on_message';
    + m9 ^, N4 w2 N
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    9 x7 L) D1 u" B3 ]3 }" M) t
19. };
    $ }4 ~) G6 f7 W0 B
20. 
    2 E$ B# i+ Y) ~
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    9 G+ Q' M* t' d  h5 c9 j* K
25.     $connection->send("hello\n");
    
26. }
    , _% B5 b8 {4 _/ A5 k
27. 
    1 {( X8 ?* b2 M2 H  e) a$ R
28. // 运行worker
    
29. Worker::runAll();
    & c# }3 q" W4 U
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    # J! ?% m3 V) X, ?
31. 
    
32. use Workerman\Worker;
    5 l  J: P# s+ E# U# r. h1 D
33. require_once './Workerman/Autoloader.php';
    3 a+ r' U' O9 _# C: G$ r
34. 
    4 Y" ^9 V( g5 ~; ^
35. $worker = new Worker('text://0.0.0.0:2015');
    - S' f, q/ j% u' B! M- I
36. // 4个进程
    
37. $worker->count = 4;
    # J* o1 D* {/ z3 C8 J  \$ Q
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    # J% R- o0 x4 o: [: j/ K* I7 v( l5 A% H
40. {
    . \7 }, F/ p) \9 ]
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    $ k! U8 @1 u6 ~5 S. j! `# @, e: |
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    ' B5 R: [; d9 c5 M5 M5 H9 @+ w* M
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    - [% q8 k0 d) [! t. ^
46.     $inner_worker->listen();
    + L0 ]9 r6 F( P" {
47. };
    8 Z& R( E5 u: k" {
48. 
    - v6 P4 c) [* w7 D
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    . m7 h7 K+ f2 [( L2 z7 K
55. 
    ' |# |$ t  W& Y
56. // 运行worker
    8 }, z+ ~! c6 ?) V' }3 p* U4 V' @
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;
   + B" j0 t1 U- y2 l& H7 Z
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   ' O2 b$ S' `$ [& d$ H8 I  U, }; w
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   " d' b3 n( q0 w
7. /*
   2 z3 D! w/ K& \& ~
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   % H2 U: h1 D, H
10. */
    ' ^, l( `: o' a7 e% y2 i
11. $worker->count = 1;
    , R: f/ h3 H9 a. ^& H
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    $ w6 ]: x) m" f' N+ D* {2 s
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    8 t0 u' {" K3 i( Z$ V9 k0 i
20.         $data = json_decode($buffer, true);
    3 Y" h( E+ Z% X9 C8 Z$ j5 T# V
21.         $uid = $data['uid'];
      ^2 z8 n2 }7 ~6 N4 [9 C
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    # V( k5 D5 Z' W
28.     $inner_text_worker->listen();
    # b9 D6 }/ T1 e
29. };
    ' z1 Y) R1 d# A7 s# e
30. // 新增加一个属性，用来保存uid到connection的映射
    $ q  Q& }2 @. m% @  B) g
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    9 J0 `( C& {! W
33. $worker->onMessage = function($connection, $data)
      V7 c" {1 }3 A/ B7 _
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    - U- U6 ]& f3 M
38.     {
    + J$ p7 {: @4 ?  N; K9 m$ A9 c
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    ; q3 q' g1 l$ M  p  x9 g9 N
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    - C1 u  @' z4 Q1 D; j6 t
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    - d7 g. p7 e+ u. Y2 P4 [
45.        return;
    - i7 o: D- W" t. P7 w
46.     }
    
47. };
    
48. 
      M7 J: l2 _3 j; a5 }( q7 C0 w
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    7 t3 Y5 r7 S, ~5 n
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    $ r5 i  c% {) `7 `+ Z7 s2 i( P  \1 j
58. };
    
59. 
      l0 r( u/ O% g2 n2 i
60. // 向所有验证的用户推送数据
    3 {) Q! |" i" n1 T. ~& @) Z+ ~
61. function broadcast($message)
    3 X, U6 E4 `  x) m; F5 f+ a, J6 }/ ]; Y
62. {
    5 U* b; k- a: V
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    - j9 K3 @0 L4 k
65.    {
    
66.         $connection->send($message);
    
67.    }
    
68. }
    
69. 
    : v/ D3 k% m7 ^  t' A5 f* R9 ^' Q
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    + M/ @5 s3 \$ [) O- R: f9 }
72. {
    2 n% P% M  W7 f$ D( |
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    1 L% Y0 s7 G* Y% D% S
75.     {
    * Z5 o0 ]9 H2 s+ {
76.         $connection = $worker->uidConnections[$uid];
    1 u1 a! \1 K$ L/ ]* y
77.         $connection->send($message);
    9 Y: V6 [* S. k- @
78.         return true;
    
79.     }
    
80.     return false;
    ( H- P4 x' Q" t* F: d) v
81. }
    8 f+ t' ~4 u: G8 L7 O
82. 
    * o2 d" m% a  `1 K9 }; @7 L5 D
83. // 运行所有的worker
    5 C; `0 Z" N" c% Y: y
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   8 y! N6 e) O" n) _/ D
2. ws.onopen = function(){
   ) r! d: q+ a# Q( z0 Y6 ^+ i1 {% d
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   . d# ^0 a' h- m$ J0 I; g
5. };
   . x/ A$ E6 N5 w8 |9 c
6. ws.onmessage = function(e){
   2 w' F( W/ H, L- b; Q  b$ `
7.     alert(e.data);
   + I1 D/ X/ e0 T2 ?
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   , p, l$ y# d5 W* H
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   $ g$ A/ m' u( w  ~$ W/ p
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   6 F: h. }7 k; i/ Q+ v! ^) L( G& `
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

( t+ l( i% V4 \