用于实例化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';
   # q5 O, G; a: |0 |* Z- M: Z$ F$ t
3. 
   + x9 u5 k0 A- u) v. l
4. $worker = new Worker();
   8 c7 o: v: {6 `9 K  g+ g3 m
5. // 4个进程
   
6. $worker->count = 4;
   . u. ~, G- n4 E; ]
7. // 每个进程启动后在当前进程新增一个Worker监听
   + o$ K  Z% {% _' n  m
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    ; Q2 i7 m) O' ]0 r6 |  ~: p# s/ g
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    4 p, A5 B2 z$ i4 d$ C) x# W
14.      */
    3 {4 _( L& o* \' q/ F1 ]- V
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    / K- [) J6 S9 {! _0 W; E0 s
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    : F: W2 [1 r3 U  R/ H  u" o' t
19. };
    
20. 
      J3 `: w  T; E" f
21. $worker->onMessage = 'on_message';
    4 e+ e% T# t" h+ q* e: k0 Y
22. 
    . {& d! z$ W9 n) s. q8 q
23. function on_message($connection, $data)
    9 c) L4 T1 \# L' ?
24. {
    
25.     $connection->send("hello\n");
    ' l) i) `* {8 r1 s  [' g; a
26. }
    
27. 
    ) n- H& b4 t4 \/ {# k$ z
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    2 O, F9 W7 _7 z4 f. E& P
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    3 f( _* f/ B9 i: B
37. $worker->count = 4;
    + \4 K4 `+ ~/ q' u) m" D5 F
38. // 每个进程启动后在当前进程新增一个Worker监听
    0 H! v$ y' K& b
39. $worker->onWorkerStart = function($worker)
    ) P* s% T+ p$ w3 g5 ]
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    - _) F  v/ p# T$ N! B. i7 c$ f4 I4 O
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    : Q: |! }- X. ?6 A( J' \
48. 
    9 C$ P1 ~6 [: e! c1 j' S' m" a2 M- B
49. $worker->onMessage = 'on_message';
    
50. 
    ) [) j3 K) x) \
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
      ~! T/ `2 f, d( s
54. }
    
55. 
    ) v8 u! _, T/ e/ `1 H% 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;
   ' k* X& W6 y" e! h
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   - ~; {' `/ K8 q% u8 {  a7 D
10. */
    
11. $worker->count = 1;
      z: Z1 Q& u, T, |" P$ m; ?
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    " ]3 ~( Y- ?; L9 L
14. {
    0 I) P& [, X! o9 G* Z, h: v' y
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    1 Y) q4 h- m$ Q, Q0 I  l+ x+ T0 h
18.     {
    - A& l1 _$ l9 h' v4 G9 n
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    * u% B. Y4 m8 k6 ^9 |5 E
20.         $data = json_decode($buffer, true);
    / }* F; q8 W4 A! h# }+ c
21.         $uid = $data['uid'];
    3 t. E- f. }& p
22.         // 通过workerman，向uid的页面推送数据
    - u! h" b, F# q
23.         $ret = sendMessageByUid($uid, $buffer);
    . f/ s, T1 M0 y; x
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    8 H* q; _8 I; n" `
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    + N3 `" J4 }, {' M. J# s, e
31. $worker->uidConnections = array();
    , w9 E2 `/ M  U% G
32. // 当有客户端发来消息时执行的回调函数
    2 B( s1 A& f0 Y  Z* A: c3 f
33. $worker->onMessage = function($connection, $data)
    ) n4 D3 b. J5 y+ X( C
34. {
    4 d" K/ D/ R: _! j  A, O" P  {
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    * D- ^* G7 }: n* ?
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
      e" |9 B/ M. g" `
42.         * 实现针对特定uid推送数据
    ( ]# Z+ S$ f9 N9 y* o
43.         */
    $ y" Z( u, m7 g) u
44.        $worker->uidConnections[$connection->uid] = $connection;
    0 p! S! n4 U% q% K
45.        return;
    
46.     }
    ! u6 F% ^( X4 K( g- N* U* a
47. };
    8 q. r" Q  k( \/ s
48. 
    
49. // 当有客户端连接断开时
      Z- ~& g# Q8 C
50. $worker->onClose = function($connection)
    
51. {
    / u' K; ?6 G, l# h. z' M/ E5 _9 I
52.     global $worker;
    1 ^8 {+ c0 }" c, l* l8 ?
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    $ m- n2 L3 f+ Z9 f( M# ?6 ^. l' o
57.     }
    ) U; n  D# r$ J1 L+ T. t" x7 B
58. };
    ) U( \1 v  F% @* c( Z) W6 A
59. 
    5 I: N* n( x, Q) G" d
60. // 向所有验证的用户推送数据
    ( S/ f7 d" i: ]1 n- M! R
61. function broadcast($message)
    
62. {
    3 V; b' Q8 I. K# i# t! b" s
63.    global $worker;
    5 o# ]% K! [8 p7 R+ z+ d: k4 o
64.    foreach($worker->uidConnections as $connection)
    4 y5 ~  R! H. t0 {" b9 D! X4 o, T
65.    {
    , W: k$ Z; r5 @# k) L8 i  V
66.         $connection->send($message);
    
67.    }
    & O1 C! d' x7 y) o1 N- g# W  e/ Q
68. }
    0 a* b" X7 S5 E5 g& U& b( c+ t
69. 
    " L) S! ?' r0 L! c
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    ; o5 p( [& P. P- n+ s
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    6 n7 c; }' \' E) w+ A
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    - u5 x. K9 u3 ?+ b
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    ' l% o* H7 X, ^/ Z
80.     return false;
    
81. }
    
82. 
    " F# G. t2 F0 s* E1 X; S+ t0 M
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   " F$ Q: K8 \9 |3 j: `4 C& s
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   3 |) D2 K2 _6 `, _* \2 ?3 H/ X
5. };
   6 g- m6 U4 U" \. \6 }4 o4 \
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   + B( p! Q+ h7 L( L
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协议需要在数据末尾加上换行符
   * V% }$ G6 X! g3 R8 g2 p- ]7 W( h
6. fwrite($client, json_encode($data)."\n");
   0 d( b$ g- H! x" u' Y
7. // 读取推送结果
   1 _% b2 q( n4 ]) G. c
8. echo fread($client, 8192);

复制代码

8 _) G) s: L; k