用于实例化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';
   8 f7 l. w4 R9 G5 {7 _
3. 
   & B! ]0 }. ?/ W9 U% S9 s) o& m
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   6 f& M% l3 b2 E; J3 p) |: t
7. // 每个进程启动后在当前进程新增一个Worker监听
   4 v/ T/ _! i( u+ `0 j  |
8. $worker->onWorkerStart = function($worker)
   7 B5 b( f4 v3 N# d) i
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    : w( G* r, }/ N) F0 L1 K
13.      * 如果worker->count=1则不会报错
    
14.      */
    : T/ x/ `" n. R) G
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    5 M. N, y1 m3 \: B1 y4 N( N$ T
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    ! t! D- G4 R" K1 |
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    0 v" q+ F; S* G0 p9 Q
28. // 运行worker
    % H! P+ Q, q1 t! ^$ d3 b# l
29. Worker::runAll();
    - {) W, z% h  h+ ?1 F
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    4 L+ H9 F' k/ D1 Y( l/ n! \9 ?
31. 
    ) d& q3 k1 w  ~  n* Y
32. use Workerman\Worker;
    4 Y) o3 {4 e2 r+ }! o- Z. U
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    $ ~9 e( \/ D! `5 M, }$ b
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    + \  o. `( E" i! A) S" w
39. $worker->onWorkerStart = function($worker)
    $ k" A, C4 M+ H
40. {
    9 O  ?- w# E: ?
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    0 T' m/ V( {: q; j3 \, g
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    ' l+ A1 C2 u  A0 D/ Z" J
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    9 W6 Z8 S$ V9 F9 \) g2 W
50. 
      _, r8 Q6 |6 q1 Q" V# P
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    1 U  B5 `% A; P) p4 ^) j& c
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
   9 p7 Q  \/ D: w7 a. e2 f
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   " z! F7 m; t9 s6 P$ _
5. $worker = new Worker('websocket://0.0.0.0:1234');
   " o$ ^9 E, I* c& Y- I6 D( Z
6. 
   
7. /*
   8 K0 D) j1 [- r3 ~4 R, |: t
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   + L! U' C  G% D
10. */
    4 X' c7 o& M- v0 s
11. $worker->count = 1;
    1 v8 i# }, @' _  U3 q; R
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    * r! r7 Q9 P: E7 e
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    & x2 b7 t, Y+ z  S& r3 S/ \+ ?- P) h( ^
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    & J9 B- {" }! ~1 o# F- b* i
18.     {
    4 ^: F) [+ U9 j2 I
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    # ?. R7 u# X4 I
20.         $data = json_decode($buffer, true);
    0 m( U' ^' L) l
21.         $uid = $data['uid'];
    5 x( G) k4 U: B" E, [
22.         // 通过workerman，向uid的页面推送数据
    4 }3 v8 [. V% \  f2 H
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    3 ?+ q* L0 s: @1 e
25.         $connection->send($ret ? 'ok' : 'fail');
    " @8 O2 Q% x+ b! D
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    / ?9 p! Q) H. q$ @
29. };
    6 ?3 Q" X- ^! f, o; ?6 b0 |
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    * S% B( i( b0 ]) X! [3 G( L
33. $worker->onMessage = function($connection, $data)
    
34. {
    & a9 q; m! C' `# g- }
35.     global $worker;
    : l8 k) V4 L0 p% k$ F. h
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    9 k- M9 T0 _. }1 B
38.     {
    * Y4 S9 |* t& q6 C5 Z& M
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    7 v4 I0 C- E% T8 s( W% s
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    / B0 t- B3 `5 |% n
47. };
    5 @  B# o8 h% Q% ~' N. J
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    6 d# z$ q4 G. a/ Q! D0 A: A- b
51. {
    
52.     global $worker;
    8 M% M8 h( z0 y' t3 J: a
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    - |$ L1 x, q. H$ G; Y* R
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    3 v* c: ]9 q8 I/ e" P9 t# D: R2 R8 z
59. 
    
60. // 向所有验证的用户推送数据
    / m8 U& r8 |+ `1 A% k; W
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    
67.    }
      R) c8 E- {* a7 x8 v
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    / E- k% u: g2 e! V
73.     global $worker;
    ) v" @( x7 t1 S6 D  n; j/ i# R; d
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    / w# @& S1 @9 n7 \; p
77.         $connection->send($message);
    : H. g4 B$ u2 `3 C& K4 c3 B( Y
78.         return true;
    
79.     }
    8 A5 O# x2 m% z2 i5 I' K
80.     return false;
    ( _& F# D$ ?& G. o
81. }
    
82. 
    
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(){
   4 }1 u5 B6 X: ]) V7 Z1 U
3.     var uid = 'uid1';
   ' Z/ `" r+ l  S
4.     ws.send(uid);
   $ }4 W9 O7 a3 B% I% S5 s6 d4 @
5. };
   
6. ws.onmessage = function(e){
   5 Q0 c5 ^( H& t! r+ \& E
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   # E2 |) r+ E! Y
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   % Q5 R) ^4 U& D9 U/ m! @4 }) |4 [
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   - ]7 b) L7 A3 |! h
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码