用于实例化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;
   : u6 d+ w8 t# o  b+ x- E& e
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   1 B( ^9 H* \$ U6 X1 O
5. // 4个进程
   & C8 J; j( ?" s7 ~, s
6. $worker->count = 4;
   7 Y6 |0 |  u0 s% t* g' L
7. // 每个进程启动后在当前进程新增一个Worker监听
   ' |3 F4 B$ D7 Z6 Z
8. $worker->onWorkerStart = function($worker)
   1 B9 O+ h/ L8 c0 I
9. {
   5 c: `2 U9 S9 c5 \. d, p: w! I
10.     /**
    7 |# g2 b$ w8 B; ?
11.      * 4个进程启动的时候都创建2016端口的Worker
    0 u# _$ ]5 r) n; h  r8 Z5 s
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    9 \( s* `+ ?9 b2 E5 p
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    6 y7 l& p  \& U$ ?/ M
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    ( ~; u+ P+ X/ ~: ^- c
18.     $inner_worker->listen();
    7 I; Z' t2 @, t7 ^
19. };
    
20. 
    - @* f. U8 Z  V5 z, |/ j
21. $worker->onMessage = 'on_message';
    : h, H- K+ ^3 O/ z: z3 g
22. 
    ( Z5 Q& k# E$ u5 L
23. function on_message($connection, $data)
    1 V# k- q* Z( X' B
24. {
    " y4 ~# @2 o. k; K$ S" G
25.     $connection->send("hello\n");
    
26. }
    1 I9 x, R/ I! G4 \1 q5 g4 W
27. 
    3 r- _- e. P+ J
28. // 运行worker
    ) `! g6 s9 Y5 q
29. Worker::runAll();
    7 u. p3 R! e: |0 a6 U, F
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    9 n1 a+ y- m# y& x# J
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    5 \& V( P" e- m# V' ]  @
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    , s$ J( a; k3 b
37. $worker->count = 4;
    - ]$ W1 d- R$ V1 ?' l
38. // 每个进程启动后在当前进程新增一个Worker监听
    7 H: P" `& Z2 Y$ H$ C* s, E
39. $worker->onWorkerStart = function($worker)
    
40. {
    . l9 R' h/ d1 L& `6 A; l
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    3 P! ]2 P* C) M9 @3 O/ Q
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
      B) y1 w& M' c+ s- A: G
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    ! U2 |& g0 Q0 h: o
46.     $inner_worker->listen();
    " l- e' F" ~# L3 ?
47. };
    : b2 f1 _( ~( {$ l5 A, g6 N4 p+ k- H" B
48. 
    
49. $worker->onMessage = 'on_message';
    % g) y: ?4 r5 E5 B
50. 
    0 y3 F% h# ^& n( u9 D! D8 o8 C- e
51. function on_message($connection, $data)
    
52. {
      B& \+ {9 g' Z3 q/ C5 N
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';
   , N/ n7 ?2 O/ k7 D& K$ k
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   1 w: O2 W# h. ~+ ?* L
6. 
   
7. /*
   0 Y: \9 f4 s1 J$ r# n
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    + U3 ]1 p+ t2 z6 |
11. $worker->count = 1;
    , A2 e: u% j% z: |- x2 Q# j( k
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    3 A) y0 |2 _' c0 l$ K
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    $ t/ q  y: V- ~" X& y
18.     {
    * N/ ]) M! f" j4 ^9 S& P8 M
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    * c: G0 B5 z+ ^  p. Y: E" t; D( Y
22.         // 通过workerman，向uid的页面推送数据
    $ k/ ]- `* l/ |# P+ v5 y
23.         $ret = sendMessageByUid($uid, $buffer);
    ! t; ^) s0 N3 Z8 ~/ A( E: a
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    ' T+ S0 a3 V* M5 Z& [# \  [( z
26.     };
    6 N9 j7 q: c! p; G/ Q# j0 B. z0 K
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    & [5 c  k8 Q9 o1 G+ G9 y
30. // 新增加一个属性，用来保存uid到connection的映射
    - c  L' q% {' b) R, W8 s8 b
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    0 v; A  W+ _- B0 A, C, p
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    1 l$ c! Z1 `4 ]# ^* y8 {  I% P: F
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    0 P+ G3 g, X% F! J5 H, z
40.        $connection->uid = $data;
    * J2 p; u9 `, s, m9 |7 f
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
      F/ b8 b5 w1 G/ O
42.         * 实现针对特定uid推送数据
    - R6 u' Q0 a+ {! S$ q6 o
43.         */
    * w* Z- k- ]3 C
44.        $worker->uidConnections[$connection->uid] = $connection;
    6 B5 Z+ w5 h: t! ~# d! r. w' G& V
45.        return;
    3 ?! q! N) O" t. J
46.     }
    
47. };
    # O& Y9 U+ U) C# K  x; |. F, G% j
48. 
    
49. // 当有客户端连接断开时
    3 _( _) r+ J% }& F1 _5 X
50. $worker->onClose = function($connection)
    
51. {
    % |' g; R& |* R' P/ z
52.     global $worker;
    5 e) `2 _2 O- U" T) }% M
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    ! t. D9 U. n5 o  X
57.     }
    
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    $ U7 Y1 r) {4 G9 T/ |
61. function broadcast($message)
    
62. {
    4 {# R/ e6 Q1 I. e) T: b# {
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    , h6 W+ c: _+ x+ |) r
66.         $connection->send($message);
    8 v7 c( d4 K% ^! O4 U
67.    }
    
68. }
    
69. 
    ! b( X3 e" C& ^2 }# b
70. // 针对uid推送数据
    ' V& A; `0 J0 j. u9 Z, {
71. function sendMessageByUid($uid, $message)
    2 V: a! i, r* }& S' L' F
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    * n0 p- d7 o: ]9 A
75.     {
    8 i/ Z$ F% H3 {* v  j0 Z/ Y
76.         $connection = $worker->uidConnections[$uid];
    4 R) r6 g, ]6 j0 p$ Z8 d1 A
77.         $connection->send($message);
    
78.         return true;
    - n: r7 D3 U/ A: H6 ?% J
79.     }
    
80.     return false;
    ' s8 ~0 _- d! _2 y$ P" M1 p, [
81. }
    0 {$ U; O, K+ q' m
82. 
    6 ?! z; I8 p2 a& x- V) A0 Y0 |
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(){
   
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   : \4 V) ]" O8 h( Q% U
5. };
   , X% L* C/ `8 s  J( f: y7 M6 w
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   * e: Z3 \; K' `8 |$ S# C% e% @3 `( n
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   * p) q' d8 c* Z7 V. E
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   , B. ~: T. w+ ?; u
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   % v; R  v% q1 K9 T) j  e4 ^  W
8. echo fread($client, 8192);

复制代码

4 Q+ Q1 \" [  d+ X# y