用于实例化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个进程
   ( J# P, H, V1 t
6. $worker->count = 4;
   * e& `/ K  M- H2 S0 T: D
7. // 每个进程启动后在当前进程新增一个Worker监听
     ]9 m( K; h/ @, H4 n2 D6 p) t
8. $worker->onWorkerStart = function($worker)
   8 g, s4 X/ u1 w( g
9. {
   8 o7 ^1 \4 z6 |: x1 e" L8 w, o
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    9 b% l. X/ K: B6 h% `6 A
12.      * 当执行到worker->listen()时会报Address already in use错误
    3 X* T" }; h% s: W, D0 I) u
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    4 k# `# r" j$ M' p) A  a
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
      n" s4 I" {7 M' E7 O: w
20. 
    ! f4 d" e2 g" G* h1 A
21. $worker->onMessage = 'on_message';
    & ?+ T4 j, s1 {: Q4 }! ?7 b8 \% n
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    $ X, @! |8 B4 F9 w) d: k4 R, I
26. }
    
27. 
    $ n6 J6 {/ @+ ^+ J/ {
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    6 i% }9 d7 |( Y& R6 E
33. require_once './Workerman/Autoloader.php';
    6 u- l% k4 W* X  s0 ?
34. 
    * J. a3 ~8 u$ I$ P: w$ Y4 N
35. $worker = new Worker('text://0.0.0.0:2015');
    2 g( z" u. [7 D. ^  Q3 a
36. // 4个进程
    
37. $worker->count = 4;
    4 M1 B+ Z) J9 z7 A9 N/ N% V2 z
38. // 每个进程启动后在当前进程新增一个Worker监听
    8 [; X% O/ @: n2 t
39. $worker->onWorkerStart = function($worker)
    
40. {
    + p" L3 L4 ^% f  N! Y& e
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    & h7 \0 X. D4 t0 |5 b
43.     $inner_worker->reusePort = true;
    & _+ D( ]* c# V2 i: G6 R8 V, k
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    ( _0 Y* G9 X6 r4 ~$ `% p
47. };
    . s! U" ^; U1 G8 h6 G- ]% V
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    5 I  P' R, z$ y3 K4 u: l3 Z' X
51. function on_message($connection, $data)
    + T6 n  v" @" @
52. {
    
53.     $connection->send("hello\n");
    4 u( G* r$ ]/ w4 I7 q7 D
54. }
    $ I1 G' p7 A- a$ M
55. 
    
56. // 运行worker
    . d' h6 D  \9 |1 y
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';
   5 ?* \6 G' o* _5 P2 b
4. // 初始化一个worker容器，监听1234端口
   ) J7 i; a9 |8 Y
5. $worker = new Worker('websocket://0.0.0.0:1234');
   - j9 t7 X( ?6 c6 l* }+ S* N. t
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   2 Z4 T) }# r% W/ v
10. */
    7 G8 O) P1 Q. R2 P" c
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    / q' t5 E  i. w  N( z" b# o
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    4 r! ]/ U4 y7 Y' Q' b+ S
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    8 n9 Y; B- a& ?( x+ [4 k& l
21.         $uid = $data['uid'];
    ! F- z6 L$ R' ?3 \9 N9 Z
22.         // 通过workerman，向uid的页面推送数据
    3 p  E5 B. w# t$ y8 {$ \0 ?" C
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    , R# x. x7 V' \( @
28.     $inner_text_worker->listen();
    ; E( I" |; t+ ^9 k3 L
29. };
    ( P3 _! s% O2 Z- S8 l3 C+ m3 ~8 T. q9 G3 d
30. // 新增加一个属性，用来保存uid到connection的映射
    % n, q9 O# e: L. a0 N. Y3 Y
31. $worker->uidConnections = array();
    $ q+ H2 ?; I" s
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    1 f. p5 r9 k0 y2 ^! V
35.     global $worker;
    6 g* c4 g' T% \, ^: x8 p- S
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    9 W3 v3 a$ ]3 R: x: |" V
38.     {
    $ n# X! v- P5 w, @  A" M: M
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
      I, `$ X( z, E7 E: o# L* C$ i# E, q
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    ! f9 E, m' f$ e+ K2 x, f( ]
47. };
    2 l& f) {3 M5 y0 o% Y+ {
48. 
    " H9 u' X3 O; W
49. // 当有客户端连接断开时
    7 Q  R3 _" @7 Z. J) O+ m
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    * j7 G9 a, C/ s$ u! R
53.     if(isset($connection->uid))
    4 Z" O9 |% Y2 n3 q& g# `" ~
54.     {
    
55.         // 连接断开时删除映射
    / \+ R* ^- c0 }) ^4 D$ f  L
56.         unset($worker->uidConnections[$connection->uid]);
    & ~/ t) c- w$ g3 s
57.     }
    
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    4 j/ v% @0 R+ ]5 ~5 R
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    + X4 @  i5 u# [2 x; q/ d
64.    foreach($worker->uidConnections as $connection)
    ' [% F, T9 `3 F- q/ ?
65.    {
    ' E4 B  X( ]* C9 U+ R& q% s: Z
66.         $connection->send($message);
    
67.    }
    5 S* A6 o' q0 W" o& D9 M3 {. ?6 r
68. }
    
69. 
    
70. // 针对uid推送数据
    % p0 s- l6 a. L. |& x
71. function sendMessageByUid($uid, $message)
    
72. {
    6 s/ ~1 ~. z* n. P, m6 B/ Q. x6 A
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    / D- o6 k" o5 U3 r2 Q( r; ]. ~8 V
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    , |, A0 A8 t/ z! T( W! c8 I, S
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(){
   - g, |! P1 p$ ~- h" R
3.     var uid = 'uid1';
   3 D$ Q/ h& [  B& C
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   . {5 ]) b# @6 C- g0 }
7.     alert(e.data);
   . y- {# `$ A" x4 T) a
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   - e3 F$ ~6 |0 x( c
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   / q* R& s0 u" L% }5 {
8. echo fread($client, 8192);

复制代码

% K+ g- C5 s$ z" [