用于实例化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();
   7 o: n% Z0 K4 W' O* k- }- B
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   3 t' P9 k$ v. M( Y: M: j+ k
9. {
   6 a- G7 x7 c! F. s  Q' O4 u5 N
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    ! ?- V) i4 T3 E
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    1 N' l0 s3 K8 }  \
14.      */
    - m% Q) y6 n. M
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    ) A. C; T. S2 Y
17.     // 执行监听。这里会报Address already in use错误
    * E; ]0 U% C  Y: c. @
18.     $inner_worker->listen();
    2 M8 f9 u: C5 U) H) ~
19. };
    ) C0 Z6 V1 L/ S% {( a
20. 
    4 A9 c% Y) d" Q! Q' S7 J- s
21. $worker->onMessage = 'on_message';
    
22. 
    + i. S5 E# c. Y% @* ~( [+ I
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    1 e7 `# `+ k8 }. Q
26. }
    ' C- m( U8 p  C. s! m6 C
27. 
    ( A0 H/ k/ t, `. R# }
28. // 运行worker
    3 X* k, E5 O2 T1 u
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    & a, `9 b! D& e" {! v) `/ g$ t
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
      r0 G7 o! o' G: l0 F, i2 a
37. $worker->count = 4;
    4 x* \# t; \6 M! A
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    3 E% ^: b; m! ~* I
40. {
    
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';
    
45.     // 执行监听。正常监听不会报错
    ' W$ z: m2 a# o# Y
46.     $inner_worker->listen();
    1 m: z8 P  D. u# p9 i5 _* F, n5 V0 I5 ^
47. };
    : p6 E/ d2 @" S# `: P+ O
48. 
    " E0 z* q+ F( [0 _$ u# ?
49. $worker->onMessage = 'on_message';
    : y# B3 `6 I+ T" A2 i
50. 
    
51. function on_message($connection, $data)
    
52. {
    : c/ d' s8 k1 Z
53.     $connection->send("hello\n");
    
54. }
    
55. 
    8 f: t4 x7 b( H
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
   / J4 ]$ F# w2 O' g( e7 {
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   ( g. f, H5 z0 H$ t" X
4. // 初始化一个worker容器，监听1234端口
   3 a- e' _! `( X
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ( p( |  P' q5 ]! G0 @, _
6. 
   9 B- {+ \7 H  }% U% J! w7 }, W
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   ; J/ _6 E3 [  ~4 s: K
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    . q: ^; X& A7 c3 ~$ o
11. $worker->count = 1;
    % P: H+ P# H8 k% v, ^: l* E( k; t/ E8 A
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    8 C1 c. v. ]7 E$ y! @
13. $worker->onWorkerStart = function($worker)
    ' i9 m* s+ `2 |: y: `9 Y; N( c
14. {
    * T& q) M, C& H
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    - d4 c& _' N. B2 Y+ s
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    3 h" r9 @' B9 n1 I6 b% }
18.     {
    & T: T1 g8 Z6 a  V& f! k" \
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    / o/ W4 b" F* U( {3 E5 _$ V4 a
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    ( a* V9 _/ y0 V9 J
24.         // 返回推送结果
    2 T5 r  }& ]4 L' x4 O' |
25.         $connection->send($ret ? 'ok' : 'fail');
    . N) L$ @$ q% G* H' q" o
26.     };
    
27.     // ## 执行监听 ##
    0 R* H7 I1 t, R
28.     $inner_text_worker->listen();
    
29. };
    3 d8 v# Q, T: s. e' Y1 z8 @" T
30. // 新增加一个属性，用来保存uid到connection的映射
    3 m' A" v3 `, b7 M
31. $worker->uidConnections = array();
    - _, Q9 j) R/ L3 k
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    : l8 a7 b% _. a. q5 G; {: Q
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    & b+ k" u3 |1 W
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
      `' E" W2 F4 t; B! K2 N% m
40.        $connection->uid = $data;
    1 Y, I! u/ t, S( K: k; w
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    , [! o. X4 ]# G, q+ v
45.        return;
    
46.     }
    . ]1 G! @# J3 x3 i3 U* h4 ^/ z
47. };
    
48. 
    1 P2 z+ _  D% Q0 {# B
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    4 y: T! m3 c! O8 q: i
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
      t/ L  q' W1 h7 a; F( a. Q# w
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    * q* Y6 w& i; @( e$ A; d0 A
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    . }; F) H9 V6 z# t
63.    global $worker;
    6 J, ?; V+ W6 f4 z3 Z
64.    foreach($worker->uidConnections as $connection)
    , C6 p+ k1 v, N
65.    {
    
66.         $connection->send($message);
    
67.    }
    ' B0 P: k  y5 B  N) P
68. }
    + k8 O2 O! X! ]3 R7 B+ z
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    3 J' O2 D2 M9 U) _; R1 w- @0 ]
72. {
    , K& w+ u3 E8 k$ x2 p7 i
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    + x& ?; {8 w5 k3 s
78.         return true;
    4 N1 w8 h$ k- n% G+ {# m
79.     }
    
80.     return false;
    ( |) t- D/ G  g. c0 B- t4 b
81. }
    2 d7 [8 S0 j; w
82. 
    ; `3 H/ |; m. t$ f5 I+ `
83. // 运行所有的worker
    / [5 x1 v  |: |9 X. l; L1 S  k" t
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   0 q  w4 u- ^! i8 [/ u2 g
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   9 v  @1 [4 `/ C" h
4.     ws.send(uid);
   8 X" F+ E2 `* I  \& K
5. };
   6 b4 a/ L. ?2 @( ?
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   % }5 l  @7 n: ]$ T& n, v9 B
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   ) m) s* A3 n' N0 K
6. fwrite($client, json_encode($data)."\n");
   1 _" o1 _( Z" o" {' Z' U
7. // 读取推送结果
   2 @+ }  t4 }7 }- ]' L
8. echo fread($client, 8192);

复制代码

3 p! R& [+ r9 d$ p