用于实例化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. 
   ; U; |3 e5 O& n: o$ n: F
4. $worker = new Worker();
   / F( {% L2 @+ L$ s3 q
5. // 4个进程
   
6. $worker->count = 4;
   8 w- e% c  L: e6 ]
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   ; g) V6 i- @! {
10.     /**
    ) M; O6 p+ H9 D6 f! |. J1 H' U
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    9 y1 E4 S4 L# P& i8 V- v* H9 P
13.      * 如果worker->count=1则不会报错
    
14.      */
    - w4 W! A; g! C6 W7 m3 _, v2 \  S+ S$ r
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    3 L" c' x- k# P" J# [0 ]
16.     $inner_worker->onMessage = 'on_message';
    9 F3 L- W2 P$ m/ O
17.     // 执行监听。这里会报Address already in use错误
    1 q6 N( F- j; [2 Y6 I
18.     $inner_worker->listen();
    2 R- a8 E5 W+ a* Y% t
19. };
    8 A: f3 F" a4 n
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    0 m& z, ^" I2 e6 u$ S/ T
24. {
    
25.     $connection->send("hello\n");
    
26. }
    0 Q% H# [$ r$ H% D! d
27. 
    8 Z) I) `! m! b( m9 H
28. // 运行worker
    : z2 W. [3 f, Y* K2 G
29. Worker::runAll();
    0 ]' I$ l) @3 E4 _9 w2 F
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
      P; M+ Y* n/ I( ^& E7 T
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    + _( ?% D" d  K! ]3 q* v
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    ( U! |: `% x( X; h
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    + x/ Y+ H, N0 x2 ?# `- s
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    % G" w/ B" m# N. `2 n  t( r
43.     $inner_worker->reusePort = true;
    - H& D) |6 W# m3 i2 y; |/ l
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    : _1 A6 I) c7 o1 y# |/ y
46.     $inner_worker->listen();
    
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    * W. e+ f+ E, }# Z  L! I
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    4 c! I- M( F" s( R
55. 
    8 C, I; k% |1 A
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
   
2. use Workerman\Worker;
   5 ?( c' D" D$ o# `& L0 v* B
3. require_once './Workerman/Autoloader.php';
   6 W6 @! U9 k4 Y5 \  J* A* ^+ B
4. // 初始化一个worker容器，监听1234端口
   + _2 W( U$ z8 K" s1 ~+ T
5. $worker = new Worker('websocket://0.0.0.0:1234');
   3 s" ?3 o; H% v2 D: g
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   6 @. R7 i( A' P# B4 Q- R- e
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   1 }; O# N( q4 t0 r  W! x
10. */
    
11. $worker->count = 1;
    % T2 C. P/ V  c  \) h2 r. L1 p
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    " U& a: }! y  n+ N& G" Y( Q6 \
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    8 h: D! [% t# R  O3 F. m3 {* i0 e
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    5 b/ ^; L+ J0 R) o( }5 B8 s  h* Z7 P
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    6 G7 J& x$ c1 z; a$ V! E* A5 G) k! Z. ^5 h
24.         // 返回推送结果
    5 k0 B2 E7 ?' F4 ?
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    ; ]6 M( e; r) c7 b8 J
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    % }' `* N9 e7 i! E" J: u) z- x
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    " I! h, f# M/ j3 ]
31. $worker->uidConnections = array();
    9 J) k- Z5 P$ M& S
32. // 当有客户端发来消息时执行的回调函数
    2 c5 B- f* \+ b% \* \- o) R
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    1 P" ?; W* p/ p) t* ]6 H
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    + u: v7 m* F7 _! V) ^: o% A
42.         * 实现针对特定uid推送数据
    
43.         */
    # O# \0 \5 M9 Q" L- [7 R' w
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
      \9 j% T* u1 L) H) M
46.     }
    0 q, B0 o# [( d
47. };
    / y8 K9 @  H( F& h- v
48. 
    & [! ^- u7 c& N  ~# R
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    - g9 V3 R1 a7 I% c
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    * g7 R# Y, h5 l+ U8 {
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    * [- k. z# e: C# L3 a$ H& n5 s
62. {
    
63.    global $worker;
    # o$ |4 P: }" `, x) l
64.    foreach($worker->uidConnections as $connection)
    4 I) ]# Q0 g6 U$ Q0 ?
65.    {
    " m7 }- T. i2 |& d. r
66.         $connection->send($message);
    
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    8 f+ a# S7 X+ R9 b
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    ! S  _# P2 i" Y8 @, {- g- }/ u
76.         $connection = $worker->uidConnections[$uid];
    ; P( ~8 q$ r) `" a, B1 D
77.         $connection->send($message);
    7 s9 c$ {1 {& n7 v( ~" |/ P
78.         return true;
    
79.     }
    # H$ z7 c0 s4 s+ k1 g7 {& Z
80.     return false;
    
81. }
    / @; O: g; Q  h; Z! @
82. 
    % |! Z) ]9 O% c$ C  ~
83. // 运行所有的worker
    9 Y+ w% j2 x6 c' s  X
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   * m: H/ s# T2 ~" ?
2. ws.onopen = function(){
   9 T$ T1 h+ \3 d- A* ^0 S2 p
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   9 ^: R$ t+ ?/ W2 s/ D' O5 q* G+ A
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   ' f5 E9 H, H8 N- h) h( k
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   / }& Q' D/ X3 [: |
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   ! d' O) u- U+ N; ~- Z
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   ) h9 x1 ~  Z9 H) r% t  f% t" M$ D
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

9 v2 C6 r& }9 k% Y- i