用于实例化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();
   
5. // 4个进程
   ; ]' Q6 A, l2 [: v. ^
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    " u' i2 w- u3 A+ r& w, o8 |
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    % N* ^+ R8 M! D+ p" m
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    ! R% ?( l& w+ A! ~" ^7 V
19. };
    " Y6 V* I$ c+ X- K7 H
20. 
    : O' Z& @; O$ T
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    $ w& C3 u! p) C- T# |
24. {
    ! p6 ^5 }+ l4 U' f8 a7 g3 R
25.     $connection->send("hello\n");
    
26. }
    
27. 
    ) X- V7 B" o7 Y  {
28. // 运行worker
    # |7 g& P3 X* L) D
29. Worker::runAll();
    : b8 Y: S) B  T6 ]! j& W
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    0 Q3 \3 S5 _4 |8 t% D8 `
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    & [8 M8 o5 ?: r4 X; O" \+ y
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    0 h* F( x5 H: j
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ' u0 c2 f; z0 w4 K# J
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    9 Q& V! G, Y: i1 ]) M. Y
44.     $inner_worker->onMessage = 'on_message';
    ( _" x/ e# {' g$ N) ]. U( b" {0 _
45.     // 执行监听。正常监听不会报错
    7 {4 B4 E# A2 @& R2 i* [' G
46.     $inner_worker->listen();
    
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    ! |# ?9 l* [0 h! b, Q, \
50. 
    # E% j- b0 L. j# Z- q
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    , L+ n# I# b2 Q
54. }
    . q3 n3 i" F  ^( Z9 c) V
55. 
    
56. // 运行worker
    8 x' r7 x. {/ W
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
   & n2 U$ _6 ~6 E( B% ]% P, ]7 a
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   6 w+ U7 H; v5 h' j; L
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ' t; `: X! n' ~7 |5 S3 U0 T
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   + \0 i) [- _" R# r0 G
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   / [3 n  w5 D  h% @: \
10. */
    
11. $worker->count = 1;
    " D, @( @2 V, W) c! n
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    3 T9 U  T, l1 l7 b% A- i; ?  V# e* S
14. {
    9 [1 O) W' X9 T. _# }8 [# f+ v
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    . \0 C1 t0 @$ |3 }! r0 M
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    $ g* d' t0 O- k8 f/ U1 W  _4 J. o# c
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    * |* b, O  S  Z  b: M: A
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    " c" p; d; p" C8 y
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    % \' F0 o, |3 H
22.         // 通过workerman，向uid的页面推送数据
    ' P; e4 o/ b: u
23.         $ret = sendMessageByUid($uid, $buffer);
    1 a( e' Z6 E3 @' N5 [  Q( Z
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    ' h7 a: v9 j" m. l: v1 ]1 Q
26.     };
    
27.     // ## 执行监听 ##
    3 V. v. y7 W0 d9 K# ~
28.     $inner_text_worker->listen();
    0 u  J# |2 f5 O) Z
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    + o1 q" r4 ]  h/ U" K
31. $worker->uidConnections = array();
    ( Q! A3 X9 s% K9 s# {( _0 m9 d+ i2 {
32. // 当有客户端发来消息时执行的回调函数
    ! n. Y& I2 q4 m- i: W7 W6 h
33. $worker->onMessage = function($connection, $data)
    
34. {
    $ v( G8 m  E% a- I; p! y1 _1 n( C1 p
35.     global $worker;
    ( g0 l7 q6 j4 g
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    $ q3 D2 Q8 `* K' n% R! L9 N( l
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    5 Q! K; W7 Q8 p" y4 H- U
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    2 c, j/ D2 X9 u8 [
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    $ k( p# H: }: d/ K+ O/ D! h
46.     }
    & j/ r+ X  z" Z/ r
47. };
    % S! p% I* b7 f! h: l) }7 r
48. 
    6 @( a7 X) e% r$ H9 m
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    . d: ?" Y; Q* |0 Q! H( q
52.     global $worker;
    # o* @+ k1 |" z5 u* Z8 G% _
53.     if(isset($connection->uid))
    
54.     {
    - @* }1 v2 Q2 o' {1 G: w7 L
55.         // 连接断开时删除映射
    ! d1 e' [& i0 W% F. s, s
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    ; y0 q3 D' {  M# M# H: m/ q
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    8 c+ S! K  V0 Z- N1 R' d# t
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    ( E! l" r% I4 z5 I- \$ N9 K, J  Y
65.    {
    / H- T( l7 l) _7 V5 R( F% q& ~
66.         $connection->send($message);
    
67.    }
    + `: `" u7 c/ T0 T6 z
68. }
    
69. 
    & S4 i- S7 V5 t! w+ i/ I1 G4 R
70. // 针对uid推送数据
    # V' g& ?/ ?0 l6 H( Z9 J% q. J
71. function sendMessageByUid($uid, $message)
    % W/ P. `+ F  W3 U
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    2 a$ R( {9 h' X* ^; v3 v; U
77.         $connection->send($message);
    
78.         return true;
    & R( B6 O3 c: A- x: q" e
79.     }
    & `1 N: S* y5 X0 E! ]* T
80.     return false;
    * }, |, v" J) ^
81. }
    
82. 
    
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);
   , a# U. w( \/ H% F# d: O
5. };
   1 U4 X( m4 Z* P/ I' l6 D
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   $ p9 s$ R2 b* `  M! U9 [
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   $ I7 S+ `, m/ `3 V7 {7 h: D; H
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   0 j( M( R4 y+ S
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

9 P3 Z( J5 z4 @( Z: F3 f