用于实例化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;
   - s+ x6 d; F. u1 f( @8 b
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   % P3 p! {: Z5 N) `, ~4 d
4. $worker = new Worker();
   $ @. i, u( ?9 O! E: T2 L) h
5. // 4个进程
   8 X# U9 U1 Q6 l8 {& i' N
6. $worker->count = 4;
   / E/ G" j; U! C2 q2 ]
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    3 A0 W( J. V0 }- d5 V& g
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    8 r0 |6 `' s) g% K: N% \
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    8 z4 ]' X- `- X7 s% l. A; F  s
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    5 ~  f" {$ ]$ s
19. };
    ! ~8 s2 n6 U( i% _
20. 
    $ J6 e' ]4 q# O% T; W: P" E9 v1 M) b
21. $worker->onMessage = 'on_message';
    
22. 
    . g' X7 l$ T* `/ b  D% p& R" \
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    9 Y" B6 g  V6 Y
26. }
    0 d. G7 Q2 k( t  v0 c+ Z8 t" o" c
27. 
    5 R6 j6 I* n+ S7 j: J0 s4 ^& s
28. // 运行worker
    " T% V; D; `5 ?
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    0 f) l" ]6 ?& i! v% d$ y, F  Y
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    6 X& _* H* d4 Y/ {( l# ~1 A* I
34. 
    3 o3 p$ v5 O$ E
35. $worker = new Worker('text://0.0.0.0:2015');
    4 X+ k1 f0 T1 j8 ]* _" t
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    3 ]- M! D( {* D- {6 ^- g! w; i
39. $worker->onWorkerStart = function($worker)
    1 s6 c5 p( B% J  L) T  |: v
40. {
    5 M' w% b/ T" x
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';
    ; A) _: b9 j$ N# _; f/ B! H
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    0 B" d$ A& _. N
48. 
    5 H5 z4 V0 [: s" \
49. $worker->onMessage = 'on_message';
    , q: m4 i$ r6 \- Q/ T# X
50. 
    
51. function on_message($connection, $data)
    3 J0 z! `3 |+ N) B
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
56. // 运行worker
    / n6 K- A* L6 ?9 R
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;
   + d! y8 G; w$ H. j  N0 J4 M  O
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   1 Q. e* n$ r! Y( H. f
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   9 p5 M- L* {0 ~+ q9 V4 l+ Y
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    ' i9 i3 Z; F; q6 C
13. $worker->onWorkerStart = function($worker)
    9 ]5 |4 Q3 o  \1 K. _  a
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    2 @; H# S8 V9 P9 \. Z5 t
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    % q/ X4 m* W& \) h# g
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    " w2 U1 \- b$ |4 j/ c+ U
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    # e/ N9 P/ c9 C0 s' t  V: _' a3 J
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    & V/ V& x' m9 x1 |1 S4 v( _
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    2 b$ s7 @- A7 X8 {3 q- B; J; P
26.     };
    ! i) l* `# E! z" Q
27.     // ## 执行监听 ##
    3 ~. ]- ?6 A. J7 y$ y8 q
28.     $inner_text_worker->listen();
    ( S1 A8 W3 |3 E1 j! [" B
29. };
    5 _1 E( C$ I; x
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    5 H9 p# \9 z& r+ I
32. // 当有客户端发来消息时执行的回调函数
    9 w6 T" O7 U" ?" |
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    . Y+ k$ }* l6 s! c7 |, {5 H
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
      I3 A# R, B% U' X( J7 ?
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    / `2 r1 ?. I. @. E  m% u
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    . v) h! b: \) \! P6 U( X
43.         */
    % P# M; j0 r7 Z0 v
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    6 C5 c; V% L9 p9 s! ~( ?7 M3 Y9 W/ \
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    ; v+ [6 N$ e8 a. U& P+ |. G( k1 z- B
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    2 A9 K" ^7 X, [; h2 B0 o
62. {
    ( n0 v# X9 S0 `) \+ A  o
63.    global $worker;
    $ V, u) }" @/ f9 U& J/ _0 d
64.    foreach($worker->uidConnections as $connection)
    * E3 L6 r6 U1 z4 \2 {. D
65.    {
    % K/ V( L# ~/ A6 g* s$ ^' o
66.         $connection->send($message);
    6 ~) i9 W+ O' U4 a" K) g: W) z
67.    }
    8 @6 M, k* k; @
68. }
    
69. 
    # I" H2 G+ l' w
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    $ q$ C, E' K9 d* Q* J
75.     {
    " n' [+ ^/ T; O8 [6 e* X- ^4 i( F1 p
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    , d+ ^( o9 v1 o2 M7 x
79.     }
    4 _! T- \8 B- v4 L  J% A% b4 Z
80.     return false;
    
81. }
    
82. 
    
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   0 v' ]+ C: e" ~1 c6 T; F# f
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   ) B* k3 A4 A5 S9 g0 _
4.     ws.send(uid);
   : o' k5 e# G8 O' u/ j; i
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ; g, q" R* y6 s/ ]; H
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   ' I! M" P1 g9 a4 z2 q/ O( r
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   # q$ A4 v$ Y& C' E5 r& @
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

. f3 Z" U( m: y' [
: d3 K( h( ?% ^9 A