用于实例化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个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   % C0 O! y: B# Q' m9 Z6 _* ]
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    1 ~+ u; @$ m/ _5 O  q7 p
13.      * 如果worker->count=1则不会报错
    9 h$ D) j& K- Y: w; m/ N/ j* A
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    6 x) ?+ p* m; D5 B6 K: e" n
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
      X1 V7 f, w2 b: a/ p& P' U/ t
18.     $inner_worker->listen();
    7 c+ b6 X2 H% ?
19. };
    $ S, G- I8 W# l* ]3 g0 F
20. 
    
21. $worker->onMessage = 'on_message';
      P7 {: u( ~6 r( ~$ G/ j/ V0 E
22. 
    ( Y8 Y! k# K0 t/ h8 H0 p) J
23. function on_message($connection, $data)
    % o9 u1 m5 K2 v
24. {
    9 i, ?0 {; F+ l  z
25.     $connection->send("hello\n");
    5 z7 K0 a: h, N/ j3 q4 f# s
26. }
    7 x  s' E; O& c6 @( z
27. 
    5 j" }' P6 ?$ f  x; l0 A8 ~
28. // 运行worker
    $ r3 A! U: L& Z9 t2 t# b9 n
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    ( X1 I7 n: x) e
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    2 `4 j, |& e3 |
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
      }3 m8 Z5 W' y# E
39. $worker->onWorkerStart = function($worker)
    3 N7 X! o4 [& x
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    * m1 V" }3 R& o/ h
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    + K1 K' F. p9 t5 E
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    & ^' G; O0 |: I
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    : F; Z! Y% f! \
51. function on_message($connection, $data)
    - Z+ @4 h& a* i! R: [) ~  Y3 i
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
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端口
   * M% s0 W. O& J# C$ ~3 J
5. $worker = new Worker('websocket://0.0.0.0:1234');
   # U( ^- S5 i* L) b2 m: m9 h, T
6. 
   # N+ P8 a% y4 J% P! a
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   6 a+ T- m  |6 b
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    & l6 X4 I/ M, l
13. $worker->onWorkerStart = function($worker)
    6 m' e; E6 N4 n4 v
14. {
    * `/ c# e( ?6 ~- X+ C
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    4 Y7 o/ a! x8 t7 d! W
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    8 q9 E( a) B. R8 h8 l/ I
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    ' m7 z, ]# C4 P& e# j
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
      R3 [; {9 w! r; @# F; P
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    ) g7 C7 D0 ?  p/ `9 p
26.     };
    
27.     // ## 执行监听 ##
    9 W2 ]( D1 F8 e- [
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    % B) |5 Z6 x. t4 h
32. // 当有客户端发来消息时执行的回调函数
    7 ]4 U! X: r/ K- M3 k
33. $worker->onMessage = function($connection, $data)
    6 h8 J" F; A* S6 h1 K5 Y2 I
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    6 p2 j# z1 D8 @3 u8 v
37.     if(!isset($connection->uid))
    
38.     {
    $ c: t, G/ W( F8 V; K
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    6 w$ |" M7 |" N
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    ( I  G; H! d4 B
42.         * 实现针对特定uid推送数据
    , Q5 e- ~- q) C5 N* l
43.         */
    8 l+ U+ h" m$ J/ ^) ~5 }$ e
44.        $worker->uidConnections[$connection->uid] = $connection;
    4 {$ i; Q' K4 P; N3 v& n
45.        return;
    
46.     }
    
47. };
    ( J9 F6 ^$ m4 }2 b
48. 
    
49. // 当有客户端连接断开时
    3 U  ^6 T; |9 ?: ]2 @
50. $worker->onClose = function($connection)
    # \4 ^! Q! f$ _; C* ^9 z
51. {
    * w; B% l5 K( ~1 @  {- F
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    ; W! Y9 G8 [2 O# {- ^+ |9 {- t
58. };
    
59. 
    8 b8 L5 _- B/ i/ G# N
60. // 向所有验证的用户推送数据
    ) A& i& i) |; D; l+ c
61. function broadcast($message)
    
62. {
    - P/ Z( R- K9 a; C$ C5 ~
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    * [( b2 V# @% t! S
66.         $connection->send($message);
    . d4 V! D: @1 @" t
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    ! j6 d5 Q! r9 m4 I+ M: M; N2 U
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    / @. K" p2 j# M6 Q7 B
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    % W+ o: ~, s' \+ O. d8 a
78.         return true;
    
79.     }
    
80.     return false;
    
81. }
    8 B2 ?3 h  H! _- o. c3 V' F6 F
82. 
    0 y1 Q: C* w# ^0 q4 i
83. // 运行所有的worker
    0 E9 ]7 W& w7 k
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. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   & N3 z1 [+ l! i! ?' ^! k
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   9 H- @" @% z0 K, I; J9 |
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   # l1 u% {: G4 \: G1 p
8. echo fread($client, 8192);

复制代码

+ z" s4 ^; a* Y! \! m$ K
6 Z7 Q  X# z1 p+ j( \$ V