用于实例化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';
   7 K) Z5 Q# Z6 B- E5 N3 G6 f, g. v' p
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   . @0 r! a1 I: D( H
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   $ p7 n2 M; f1 a/ z5 p7 T. Z" t6 Z
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    8 Q' A3 X8 G5 l/ E* ?* t
12.      * 当执行到worker->listen()时会报Address already in use错误
    - I6 O# q4 ^# h
13.      * 如果worker->count=1则不会报错
    ! G: ?- W/ F0 o, p' X7 ^1 n- O
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    7 P$ U# e& U  o/ ]4 F
17.     // 执行监听。这里会报Address already in use错误
    - A* f- [& [# V: T* i
18.     $inner_worker->listen();
    & R- X" A. ~, B, `, g( _9 G# Q/ e
19. };
    $ m! O. n% b* v, c/ Y$ X
20. 
    ' h1 H: p( O( Y8 H
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    % M* ]4 s) I7 ~
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    $ e( H) ?$ _2 Q7 ~2 Q$ O
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    ' u3 i% W2 T# `, Q  Q
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    ! V2 F6 B8 y: U( U- b: |! A
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    . j4 f" h) ?6 H) D2 G9 P) F" Z7 }8 Y
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    1 T' P9 K. ?) u6 H0 I* S2 j0 W
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    * V$ j% i. \6 `' C$ k2 h
50. 
    ' i0 E) Y3 Z8 R" Q4 Q) R
51. function on_message($connection, $data)
    ; E% g( e. _3 w2 \5 z5 U
52. {
    ) [5 d" L1 r: I0 G
53.     $connection->send("hello\n");
    . `% ^6 K1 J7 u' `* s
54. }
    
55. 
    ( J, O* @, N  _, s! D& 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
   
2. use Workerman\Worker;
   / k. W/ B( \3 R6 T1 v4 o
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   + U2 F0 @2 p8 X! I' s. p) \3 ]. T
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    6 }; m' }- T( t* E/ N3 i
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    ! d8 A( k  o% b2 m( Z2 A3 `7 _
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    5 _7 m" d; n6 Z7 a
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    ( G4 @. n5 s" M0 [% V2 P
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    5 S' J' a; I+ Y' f0 @- [5 ?
21.         $uid = $data['uid'];
    6 V- Z& X8 `/ M- A* ^
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    # h# v  V6 _7 w* Y% W
25.         $connection->send($ret ? 'ok' : 'fail');
    : w2 k  G; `8 Y, z; O- `
26.     };
    
27.     // ## 执行监听 ##
    ' F3 B, t  t- |, ]% v4 K( @/ i2 T/ @% \
28.     $inner_text_worker->listen();
    / h$ ?. x; w" E4 B
29. };
    ! r- R; q- a/ f2 N7 Q1 x. V
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    , f; C) T6 n" I2 G" ]
33. $worker->onMessage = function($connection, $data)
    
34. {
    2 {4 I6 N: r9 i2 f
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    7 K( Y- U  g% R' K+ b
38.     {
    3 z' {" n. A. t( g. S
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    ) U, ]+ \1 n. ~3 G8 l
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    : @2 a' v1 F' t' \2 @) a
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    " ~+ v' ~9 P* [! Y* M0 n) L+ h7 r
45.        return;
    0 k" V& I. f5 Z$ Z+ D7 ^  G
46.     }
    5 i6 L2 C, j) \7 \8 P
47. };
    
48. 
    
49. // 当有客户端连接断开时
    # g' X+ G5 _1 u- h$ e) P' p
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    ) D: G0 v# Z3 \+ h* N; X
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    ) I. K" a# o: P5 j; s7 O% q
58. };
    
59. 
    % K8 x/ F# b9 o/ {* B
60. // 向所有验证的用户推送数据
    ' U) ?; j, z+ u$ p
61. function broadcast($message)
    0 _; a( j/ h8 w/ s' `( m9 V
62. {
      C8 ]# R4 D4 M
63.    global $worker;
    2 U$ y% b( t0 a# i
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    ; l5 w% L4 }5 ~- m8 H
66.         $connection->send($message);
    
67.    }
    3 m7 ^  X. J+ y- m5 r$ Y
68. }
    1 u2 X( p' Y/ V0 d/ v; d; d5 Z2 `
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    2 b' j: q* b( F) X7 [
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    8 ^* }) V8 B! ]% Y" P% Q+ x0 Y
80.     return false;
    
81. }
    / `/ N, ?. a. y7 P
82. 
    ) P. K* d2 q4 X7 [$ r4 M
83. // 运行所有的worker
    ( L1 L" P# c9 b
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   : q& y+ |6 q9 u+ u9 R1 j
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   + Y2 V7 d7 g- Z: g$ m9 A* S
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   & a0 J) U( u  c6 q& W. S/ V
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   ( ?, g2 O/ t9 ~& M; J% c
8. echo fread($client, 8192);

复制代码