用于实例化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;
   + B2 A4 S; ~+ M* [5 \5 J" B
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   ) B0 ?) ^3 M6 s
5. // 4个进程
   , ]$ @0 ]/ x+ \2 _( b* [0 B8 z6 @
6. $worker->count = 4;
   " C" g4 d  w/ C  W! Q5 [
7. // 每个进程启动后在当前进程新增一个Worker监听
   ) z* |3 Q0 D1 g' Z2 I4 Z9 a
8. $worker->onWorkerStart = function($worker)
   3 O9 p6 Y2 R' I9 z0 h0 A/ P
9. {
   
10.     /**
    - y  a; s% \5 C  R
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    9 ?' S! G8 W: Q+ g
14.      */
    , o" ?! W/ l% ]' E" m5 u. w
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    1 ^/ l+ G, z. E8 k2 \
18.     $inner_worker->listen();
    1 Z+ P' h8 f3 r( U1 X4 k. F# s
19. };
    ! T+ j& E$ \$ e
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    , m" k( T1 l- H! o* k
23. function on_message($connection, $data)
    " W) X) R& }, D! ]( V9 E( b/ k
24. {
    % `2 b7 {  f7 ]. d
25.     $connection->send("hello\n");
    / M% d( V$ M4 k1 l
26. }
    . A( L0 c. x) Y+ Y, v
27. 
    7 e4 @5 f3 I9 s
28. // 运行worker
    
29. Worker::runAll();
    3 L. [7 j0 J6 ?) Y* h; @! k  Z
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    6 w7 c# r. h. S1 Q
31. 
      `3 W6 M# N1 a3 J& H
32. use Workerman\Worker;
    6 ^# H' l6 c4 S+ i
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    / C: Q0 r8 {: D& ^& Q# u# g
36. // 4个进程
    . l: e+ {1 k4 f6 m
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    2 c3 x0 _8 k" f. _  E, z
39. $worker->onWorkerStart = function($worker)
    
40. {
    1 \; t. a* Y0 M; T6 p6 O. e
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    ( X0 d+ B. s) h9 K- L9 a
46.     $inner_worker->listen();
    
47. };
    / }$ ^* @9 ~$ v) J
48. 
    
49. $worker->onMessage = 'on_message';
    : t1 X2 B7 m4 x) K. ]& j
50. 
    / L. V1 J1 T# r& y8 c& ~
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    ) C/ U: v% z% x& Z' G
55. 
    % I$ v7 o  a! r1 m$ m
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;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ! ^! [' G1 }8 H. o- N( v- d# R
6. 
   9 s0 ?/ m5 q* r  A
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   9 g* I% N4 M8 x; E$ \" F2 p5 i
10. */
    ' e5 R2 _2 \9 U; o( ~$ v! {
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    9 R- @$ ~2 K/ |
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    7 p$ B: E9 R5 H
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    2 W! G) O$ h# L! j& ]
20.         $data = json_decode($buffer, true);
    8 q! T* y+ v5 ^& d: \+ a& I
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    ! }" }$ \; p3 H+ F% _2 n; n
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    0 p2 C6 S+ P3 p, @
25.         $connection->send($ret ? 'ok' : 'fail');
    , m' t9 E9 n0 j" F! _* A7 s( ?
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    0 [) m# v) y8 G' H
32. // 当有客户端发来消息时执行的回调函数
    * K7 ?! Q' F3 t, [* X0 B% ^' e
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    " C& Z: ]' G! ~/ W0 G
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    / c) k3 d4 f( F3 C. M& l* T
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    : v8 K3 }2 C; R  \/ k7 V* h
45.        return;
    
46.     }
    
47. };
    , x3 A. u% B6 q. f+ |2 e
48. 
    
49. // 当有客户端连接断开时
    0 E( ?) s8 f) O5 K8 G0 I
50. $worker->onClose = function($connection)
    ; A  s! h  |# Y4 z; L8 T; J) o% t
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    0 ~! {: I4 a6 D0 [4 j
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    4 K( k" S2 P$ ?' F
57.     }
    
58. };
    . d3 y0 t, {$ t/ N- n
59. 
    
60. // 向所有验证的用户推送数据
    / h0 y7 s0 J+ ^. L7 s( i9 K/ [
61. function broadcast($message)
    2 R8 _4 S8 d8 D. n: o+ A; |
62. {
    5 }. a; ]! O; R) f3 e( M: x' s
63.    global $worker;
    $ L% p# O6 N. Q9 r+ e- W
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    0 V1 e# M0 V! v5 K
66.         $connection->send($message);
    
67.    }
    
68. }
    
69. 
    ( |7 J+ Q/ J0 Q! \: ^
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    2 F+ h9 z0 p( b
72. {
    / v0 I, s% P, ^5 ?( R
73.     global $worker;
    ! F8 d0 z, l$ j8 M  h* @
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    $ P7 @5 a8 M- B( M
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    ' O3 I+ S6 A: P- }1 g
79.     }
    
80.     return false;
    
81. }
    7 Q6 p# d! B6 E( C# y3 ~* v
82. 
    : m; V) H" d  V: w
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);
   
5. };
   5 U+ [* h9 T/ Y, D: {' A
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   5 W9 p7 |+ O8 L+ y5 p# A8 a
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%');
   ' v( u( S. k# O! d! i4 d  U
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   ) X1 J1 P# v, G
7. // 读取推送结果
   , F0 E1 R7 Q  N. `: {  D9 i$ n
8. echo fread($client, 8192);

复制代码

; Z' a( i- f0 R( Q  z