用于实例化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;
   # |  O- [0 m+ \, U+ H3 Q
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   $ K/ r! I) s# u# K
4. $worker = new Worker();
   . c9 h. C- b# ]$ s0 O: J
5. // 4个进程
   
6. $worker->count = 4;
   6 v5 H' y* H& W( g4 R( S1 Q# m
7. // 每个进程启动后在当前进程新增一个Worker监听
   8 m% S2 d; t/ d% J
8. $worker->onWorkerStart = function($worker)
   , a; b5 ^, q% P: c% D, {9 ]* b- U  ?
9. {
   6 d: `# L* ~* U% `) W) b9 |
10.     /**
    . D- c& y2 b6 W& v  Y
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    , R% S% {- k% b# }9 O! R9 z
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    % [. `& h" S1 U
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    ! {: E" T; _! w2 _
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    4 B! K( W$ w6 a4 ], W3 i% C0 q
24. {
    
25.     $connection->send("hello\n");
    
26. }
    8 B  D% y* K. Y7 t, d- R
27. 
    
28. // 运行worker
    $ C+ J0 Y" H* f  A9 T( t8 d  Z
29. Worker::runAll();
    + A' Z' O3 a" G  A: f
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    7 a% q1 ]% q7 O, I  M) z% B
32. use Workerman\Worker;
    & H% @  l  `6 N% }$ T8 {& J
33. require_once './Workerman/Autoloader.php';
    
34. 
    ' h; k* v( w, D" n1 g, }
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    , l% H2 \) f# r6 T
37. $worker->count = 4;
    7 f( H/ o& E- _4 u) M0 I' J4 D! r
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    " B9 y$ R6 K$ \" @9 X' J
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    2 k) Q8 C% _! W7 _2 [
43.     $inner_worker->reusePort = true;
    9 g) O' D6 W! t- R( r) |( R
44.     $inner_worker->onMessage = 'on_message';
    ; u' X2 A* a1 q# l6 M
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    . q2 c9 X4 }5 N
47. };
    6 x+ a- D. D/ B7 L* s" v+ A
48. 
    + l8 o" N1 A3 d- X
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    ' H6 e  u* l3 G& E6 O( N6 s
52. {
    9 S7 |8 ~9 ^- |  n6 Z  H
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;
   ) x. M) y* h3 q: m4 `
3. require_once './Workerman/Autoloader.php';
   / p" i0 E( v9 |5 Y" I# Q9 c
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   & T1 d: A. S' ?, b- [8 F2 @
6. 
   
7. /*
   + `; x' J6 H" y! l
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   , \3 j. C* i: @8 ]% c
10. */
    4 y6 F' _8 d& i  e: x
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    2 Y/ J+ {: W4 S# o/ ?/ ]5 H" w8 O
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
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);
    
21.         $uid = $data['uid'];
    ' l; I+ j* w4 S
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    * E* Z. ~2 I1 I9 p3 E1 J& o4 J( J- h
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    - {$ q- b+ ^  ^7 m8 T
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    ) U" w+ M/ {! J2 w& X' A7 d+ @
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    , p! n! W* [8 H0 G' ^& c, f$ A
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    / I/ a( D5 v: w4 ]4 m9 i4 }
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    ' _2 V8 d8 {. O4 _
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    4 S' s) i9 @  k/ t! e% A/ W
42.         * 实现针对特定uid推送数据
    4 f  ~% ]8 Y7 D
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    ! m* a: R+ {3 @( I3 w$ V4 L2 x- V7 W
47. };
    ' G% Y3 \- F( J. @" Z6 H
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    : X: ^4 r+ e1 P  h: v
52.     global $worker;
    
53.     if(isset($connection->uid))
    ( w) X$ W6 I/ T- `' X$ t
54.     {
    
55.         // 连接断开时删除映射
    3 q2 Z5 K: u* l( N' [, V
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    7 [9 X# v3 {3 l4 M; b: O# y
58. };
    + E: ]. H$ R, w$ P' E' K( _
59. 
    3 S6 c6 t5 }9 |8 T! v7 e9 H' j3 B
60. // 向所有验证的用户推送数据
    4 H, S8 `* n  Y8 u
61. function broadcast($message)
    % b5 b' H3 ?7 y4 B) Z' g
62. {
    
63.    global $worker;
    8 ]) ]9 G. r) q
64.    foreach($worker->uidConnections as $connection)
    & n! O) A6 ^7 O  q1 U8 s
65.    {
    , E7 M6 \1 f3 y6 Q% [9 ]
66.         $connection->send($message);
    
67.    }
    
68. }
    ' n8 _8 l" U8 m( _2 c7 M3 u
69. 
    & [, j$ ]4 Z  Z  O4 Z6 T
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
      L% p2 |& Q4 O" ~( k4 c# a4 G
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    7 ^. D$ U9 B& V5 \% b1 _' s
76.         $connection = $worker->uidConnections[$uid];
    " \' U! a* C0 A" Y$ G. o  j; D. A5 U
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    ' q% h8 C/ @8 O. y
80.     return false;
    
81. }
    
82. 
    5 B4 b" @  K: o  O% ]
83. // 运行所有的worker
    6 k$ e9 Y8 t" ~2 P$ U: R/ T
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   ) U" [, U8 E) H+ k( g
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   6 c7 v  r" f& E9 y, l0 p
5. };
   
6. ws.onmessage = function(e){
     ^( o8 n7 a2 b$ |) }) h
7.     alert(e.data);
   2 u: ^2 S, C% I; c5 W- I
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   / V# r5 P/ I- A$ \+ p' N
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   8 j  R0 F& e3 ]0 ?
7. // 读取推送结果
   + H9 `9 F+ O1 T& Q' v; @) q
8. echo fread($client, 8192);

复制代码

; Y8 j& K7 z. d) F- g7 r$ }
5 J8 _0 V1 c: A