用于实例化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';
   4 Y. C7 E: _) J0 \; T4 u
3. 
   
4. $worker = new Worker();
   # T+ \) s# Z( t
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    2 x/ N7 p/ h) t/ J
11.      * 4个进程启动的时候都创建2016端口的Worker
    5 F, d& _5 h2 C8 v, D) V
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    0 O& q  x8 M1 |; o* K6 W
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    : u' _3 Y& o, e- z# K
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    2 V; V9 E3 U& c% m! C$ x
22. 
    # G, z' J+ N8 M/ E" l: {% G
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    6 Q% T1 Q6 b$ D
26. }
    8 c2 \, z0 ?: J' X3 p; g$ s! y
27. 
    + U. [3 W- ^+ i; d6 i3 [' d& `
28. // 运行worker
    
29. Worker::runAll();
    ; a! M2 Z- ]6 n7 i
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    . T, R& J) ]4 x
33. require_once './Workerman/Autoloader.php';
    
34. 
    % D1 k3 m4 E: a* s* ^. c/ p& Q
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    3 k/ f1 N+ h& w( N1 \( B  J
39. $worker->onWorkerStart = function($worker)
    
40. {
    , l% O6 ?3 `3 I* l, ^. o7 ?7 B" b
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    8 d% V1 j6 V/ J' }2 \
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    % y% K: p6 R: T1 f
46.     $inner_worker->listen();
    
47. };
    2 y0 _5 k* B; C4 f
48. 
    ) u' }/ u0 W: ]1 a% {1 ~" P
49. $worker->onMessage = 'on_message';
    
50. 
    & [1 ]- f8 Q7 n  {- T6 y
51. function on_message($connection, $data)
    0 N2 N" a$ S: X0 j5 ?- V9 ~0 h
52. {
    
53.     $connection->send("hello\n");
    ) t. P( C/ o( C. N! ^
54. }
      E; v- n  i5 L* a, ]
55. 
    : c% A3 p. b: b
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 t4 h3 ]2 [0 H/ q
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   ! t8 k& i( J  k% D6 f$ }# @. m" a
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   " G: @( r4 I! h
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   8 S& f- c8 `2 k- P/ `6 x! P5 W% K: C
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    $ c" R* V( o; ~
11. $worker->count = 1;
      Z0 H6 I) }9 I$ r9 u
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    3 ^3 Z% h* \! z3 I9 G
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    9 c: y0 q/ Y$ H7 a; ?
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    8 s/ ]# k3 Y, v  r/ y+ T
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    2 {0 D/ W- i8 n8 L2 L& t( m' a$ I2 D
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    & e# s' g+ G8 _( h: Y) W4 o
24.         // 返回推送结果
    , r' h$ C- I7 d: v! g" Q  h
25.         $connection->send($ret ? 'ok' : 'fail');
      ?7 Z, }7 u; f! k2 j" r: N
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    : o7 n3 O7 ^4 t8 ~1 e
29. };
    , W$ `' d3 [7 i9 _3 T8 K$ y
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    4 t6 H8 ^0 c6 ]- S* E4 u
32. // 当有客户端发来消息时执行的回调函数
    & \. v  i; D% K' F4 C
33. $worker->onMessage = function($connection, $data)
    - p9 f9 g2 g$ O/ \* N: y" o8 U
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    - M! }( V" N" v; n9 p
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    , l# z# C2 B. i1 D' m3 Z4 k
40.        $connection->uid = $data;
    7 ]7 e) s" ]. f1 {  P3 ~% K* {
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    $ ]9 C# z% j( `' p" h2 R
43.         */
    - s; q, v( q& t& x. i9 o3 Y
44.        $worker->uidConnections[$connection->uid] = $connection;
    5 M: m: L# S' s/ \2 i
45.        return;
    ) k7 m7 \+ L9 _
46.     }
    
47. };
    
48. 
    5 x4 s/ a9 ^5 Y  G- a8 g. ]
49. // 当有客户端连接断开时
    * Q1 J2 V7 i9 S$ Q  F
50. $worker->onClose = function($connection)
    5 [1 u5 o  ~- A8 c$ ]& p. f9 h: W
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    ! w# s) O( B1 E6 o; ]% H+ x: E3 l- d6 Q
55.         // 连接断开时删除映射
    , a& c% [7 p8 f% j+ y9 f7 O+ \8 }
56.         unset($worker->uidConnections[$connection->uid]);
    8 e& O: y+ Z) \9 A9 x* D+ x8 j
57.     }
    8 g7 p3 H) ]' |8 n* Q
58. };
    
59. 
    7 m" S0 p9 p8 b7 V
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    ' I0 R' ~" E0 W( T3 s
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    
67.    }
    % R/ M4 T0 b+ w- z+ @4 z0 h$ L
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    ) c- J9 W# H' J7 ^, }7 K% ~
73.     global $worker;
    2 m  V4 @+ N7 i+ r, R, V
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    3 O( l+ E7 T. d, Y! F
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    7 z8 r& [  ~9 L$ x$ B6 X' U1 b/ Z( p
80.     return false;
    
81. }
    
82. 
    + c# Y* f% _. r
83. // 运行所有的worker
    1 R" ?  P; z0 R4 c2 e
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';
   . |1 N( o' [; o5 i
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   5 l8 m" t9 U  `6 M7 U% Z$ L
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   3 m$ F5 u* `4 W, x7 [, h
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   : G/ b( w/ @# J% l
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   # {; ]' y- |3 r7 o8 b
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
     }8 `( T" {0 R( m. [" x
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   7 o! c% `# [5 c/ O3 I
8. echo fread($client, 8192);

复制代码

; g0 z: i# C' a# I. X