用于实例化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';
   + H& Z1 {8 j! o' O) q
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   : v2 j2 ~6 }- \7 d8 o5 ]/ o& Q9 F
7. // 每个进程启动后在当前进程新增一个Worker监听
   . v' O% ]$ G% W  b
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    9 ]& R+ X" `6 `! m! b: h1 h" g& M
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    & F/ Z; X+ a' d7 k+ z' t
18.     $inner_worker->listen();
    
19. };
    : G1 I9 F5 s& M, U) c& }" z$ q
20. 
    ! ?" \* S" D+ w) R, J9 J
21. $worker->onMessage = 'on_message';
    
22. 
    ! O( P7 I" X. f) @- c: C/ E2 S
23. function on_message($connection, $data)
    
24. {
    # w3 J6 c  K& t  B  X8 H
25.     $connection->send("hello\n");
    4 }& x! a$ ?: \. x' y2 ]
26. }
    6 C2 @4 E8 \% |5 w$ o
27. 
    
28. // 运行worker
    & w5 p( l. }0 _# w9 }% l+ h/ Y
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
      j% X2 D1 A3 L  g
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    2 f$ \( u8 r& z2 H  j
35. $worker = new Worker('text://0.0.0.0:2015');
    3 m4 W0 y) Z+ F: R
36. // 4个进程
    , |. L" [& ], C( }- m. W
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    , m- y# U! X2 p$ ]
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    9 E3 P. }9 L5 c0 B& |9 a6 O3 S" D
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    ' t  g( Q) ~9 j
45.     // 执行监听。正常监听不会报错
    3 Z- I! H: a5 v& @7 W' ^, y
46.     $inner_worker->listen();
    0 r* ?9 a" C& @  ^) X: @( H
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    0 {$ Q4 \& D* v+ y
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    . S2 k' a' r( R, ~
54. }
    % I- T0 o  b: ]. K* M
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
   1 Y( _0 V6 k4 _: I8 ^4 W1 ]
2. use Workerman\Worker;
   3 _; W' B) I! h7 ?9 k# l
3. require_once './Workerman/Autoloader.php';
   ( Z# S! D" l5 d- R0 A1 N1 ~0 {
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   % Q  T4 k+ J& z
6. 
   9 a) H% \& i7 D! z0 C" o8 s7 e
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   , y& P4 w( C, o/ m) g
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   ( d5 W* ^6 f0 d; \) q
10. */
    1 C' m' J' T7 q, @8 p
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    ! w8 O4 w0 [9 |4 T
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    ; o( J6 e3 V+ R( C& k- m
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    & g) g; k& }# X( c9 D- R' |4 x
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    ) y2 d3 @* V' h2 S8 W& R$ d
23.         $ret = sendMessageByUid($uid, $buffer);
    2 U+ h% H. f5 q
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    ! h& q1 ~, }9 S+ k) Q; ]9 Z( t
34. {
    ' O! G2 Q9 ]) N0 y0 B
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    3 S; Q3 |3 F/ Q7 `# Z& E
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    % [4 t  T0 ~. H
42.         * 实现针对特定uid推送数据
    . @, _; M0 }1 W" i8 {) ?# }
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    
47. };
    
48. 
    " x, `' N% P. _' {) N1 d' F6 l# O6 j
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    / t2 F; z# ]) g( G' y' h# m
54.     {
    0 |; V4 G! P" f0 _
55.         // 连接断开时删除映射
    ! Z6 j: I5 ~. n7 I$ V4 h
56.         unset($worker->uidConnections[$connection->uid]);
    # u) q6 J0 E8 t* b
57.     }
    
58. };
    * D. j4 Q* U$ N5 h2 s2 k) Y
59. 
    % c% F0 {! ?( {& K  o* a2 t
60. // 向所有验证的用户推送数据
    0 r& M( q! c) B" {0 B8 g$ {
61. function broadcast($message)
    7 g/ `0 a, W6 Z) F  p) g
62. {
    
63.    global $worker;
    8 K2 b9 {5 V. q
64.    foreach($worker->uidConnections as $connection)
    # D9 k: b, r; w- @* A, A4 o
65.    {
    
66.         $connection->send($message);
    
67.    }
    1 r: I; g1 p( k
68. }
    
69. 
    
70. // 针对uid推送数据
    6 m! P; U; ^" D
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    ' n* c2 Y& q0 f' R
74.     if(isset($worker->uidConnections[$uid]))
    / q9 s0 m# K2 c) {0 V' ?8 U$ @
75.     {
    * {" r  N2 Q( |: _3 \1 m
76.         $connection = $worker->uidConnections[$uid];
    4 b: z+ D/ B! U4 Y
77.         $connection->send($message);
    
78.         return true;
    0 t! i1 N4 X. W- f
79.     }
    2 {; S+ Y9 X* |4 |
80.     return false;
    
81. }
    - \( w5 U3 J* g/ }2 x
82. 
    
83. // 运行所有的worker
    + {. `, T- g! D! N: U! C8 o
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   ! l% \  c$ F9 t* v
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   0 J0 _" u" j/ u# W4 U  J
5. };
   8 n2 {  O" g6 ?6 W; ^0 W! x
6. ws.onmessage = function(e){
   6 ?, B1 E  R7 ]' @5 m
7.     alert(e.data);
   + i- O1 \; G- y% p8 D, j
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   + Q2 V$ v5 `! h' T8 i! [2 T; e
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   ' l* g8 N  I4 N
7. // 读取推送结果
   5 u+ {8 r# |2 }0 |& S( S5 G
8. echo fread($client, 8192);

复制代码

' l* x5 b9 V. ?& i8 f