用于实例化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();
   6 D/ V# _' J! e" c- z
5. // 4个进程
   . J+ o- t# a$ G/ q2 ~
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   9 ?0 n9 Z. n! }" K. U
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    9 b4 {" r3 c" e- Y2 Y$ e
13.      * 如果worker->count=1则不会报错
    + B' t9 L; J5 e+ }4 H
14.      */
    7 q0 s9 k! W+ I, |7 s
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    8 t) L8 ~0 q. a, K6 X$ L( j! M5 O+ V
18.     $inner_worker->listen();
    0 N" p& k1 D$ r  K6 U& a% e
19. };
    
20. 
    6 `+ X. R' I! B3 y- _$ x
21. $worker->onMessage = 'on_message';
    # R; S/ W( w) R1 ]. M/ ]7 [
22. 
    1 }3 ~% `7 R3 r' M$ r# Z
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    3 ?" u8 f# w; j& b3 @
28. // 运行worker
    6 {! ]& o# a6 C# @, s
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    3 n, i6 w. M' I" {& C& j
31. 
    . ^' b8 b- V1 \) w
32. use Workerman\Worker;
    - g/ j6 m7 `2 o
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
      t) B" ]' q' F
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
      n& }' q5 A# L: O( v' S9 J
39. $worker->onWorkerStart = function($worker)
    
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';
    " v3 G) y! n1 C2 B
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
      c, a) c3 G& s7 u8 |$ b
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    . }8 @3 a  n, c2 I4 K
52. {
    ! `. \; F! a- Z$ F# N4 G
53.     $connection->send("hello\n");
    : A8 Y+ r8 J1 M
54. }
    # h, s$ v; x& N; V' a5 R7 k* D$ v
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
   % f% |/ M' W% e2 M
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   8 o5 Y+ i- w8 s1 a
4. // 初始化一个worker容器，监听1234端口
   , c1 v+ B4 R2 l, m
5. $worker = new Worker('websocket://0.0.0.0:1234');
   1 i! f, G/ C0 J6 S2 v. e
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    ' }; O8 f' s7 `3 c/ x% ]
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)
    8 w8 b2 G9 q" y& |! F6 B4 ~; G1 t
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    ; B: Z' Q) n) W, H3 B
20.         $data = json_decode($buffer, true);
    - g" f+ ^; T' j- m5 B: j9 O, z# O
21.         $uid = $data['uid'];
    # i% `, y& L9 D& s! y
22.         // 通过workerman，向uid的页面推送数据
    7 `' [/ B0 A1 q" e- \) I4 y/ i; I
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    + @$ S# N0 Y; l+ ]' P  o5 y* V
27.     // ## 执行监听 ##
    : B' E% y5 Z! R" t; h  x; Q
28.     $inner_text_worker->listen();
    " S$ b  [* U- i; q' |) I* s5 h
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    3 R2 F& s* m1 P$ @7 V! c/ ^3 L
34. {
    9 E! I! \# [5 _& b' C5 o
35.     global $worker;
    3 R3 K! U+ I  ]' x; \
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    8 y9 T" J6 _) B! q2 _* o
37.     if(!isset($connection->uid))
    6 D7 U2 ^2 _2 w  A" s4 b5 B3 m
38.     {
    ! p% _& ~& e! v7 q) h
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    * h! f. v; X9 b% R& e0 U
45.        return;
    ' \" G, J7 c- M
46.     }
    
47. };
    $ b6 A& [3 l9 {; O" m% x' b
48. 
    
49. // 当有客户端连接断开时
    ) e1 r+ D4 v. }2 i
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    , Z8 ~7 N2 o7 h7 P2 d' m( n! ~
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    : t2 g5 M/ Y5 b0 y3 L
57.     }
    ! t  H  a) X# o! |9 k* E( o0 k
58. };
    6 ?% |6 ?1 W- Q4 Z2 T. C& F
59. 
    ' F3 t( Y  f# ^2 a. [6 g
60. // 向所有验证的用户推送数据
    # Z2 V9 ]/ T7 [+ s" `* B# V. g
61. function broadcast($message)
    $ ^' v7 ~" C" j8 g! U" f
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    0 x0 a4 T3 x+ ?/ a' `( L
66.         $connection->send($message);
    $ U4 z; M# W8 C; @. d
67.    }
    
68. }
    , }+ D- f+ t9 b" |3 ~  ~: Z
69. 
    
70. // 针对uid推送数据
    5 k) s* {/ R% X" _
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    ' }; O  I/ N# l7 }, N
74.     if(isset($worker->uidConnections[$uid]))
    5 k4 S) t* V+ F: P/ U& j
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    % ]# D- W7 z, @  ^
80.     return false;
    
81. }
    # o8 K6 o7 _& `- h8 w& E. @
82. 
    2 P0 ^, x8 V% t$ u3 K
83. // 运行所有的worker
    9 D; r& `- c8 ~" c
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   # V8 o& E+ h- H3 l/ H+ e
2. ws.onopen = function(){
   : m3 }0 W8 w# g. p8 m: g4 d9 ?: N
3.     var uid = 'uid1';
   / H* m: |' E2 i- u% h6 x
4.     ws.send(uid);
   6 R8 Q5 B( c& e; x: n
5. };
   
6. ws.onmessage = function(e){
   ! }/ ^: Q, s1 i7 L6 m1 }+ Z1 D
7.     alert(e.data);
   3 K" ^2 h( S0 S" ~3 H& W' F
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   , i, f/ U! b! A" O& Q! m
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   4 y' i+ M* D' I* B! ]
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
     y4 S# d; B7 \6 E6 F8 f8 `
7. // 读取推送结果
   , T: @& Z! M; A: e' u( D: x- @
8. echo fread($client, 8192);

复制代码

# k, W0 z' `5 T6 N0 }! v2 z
( H9 @4 ]/ V2 R& H