用于实例化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;
   - F: ^+ h* \& R. n
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   6 |) L" z  j: ^; D2 G" v6 c
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   4 N4 b; G9 T; N, L. l, P
9. {
   
10.     /**
    , |' ^# d7 T/ l0 B  O
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    . v/ {7 _" W" J; Q- t" G
13.      * 如果worker->count=1则不会报错
    1 S9 N% M' }# \8 l
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    % c( J- Y/ F) ^$ H) g( S+ E9 N
22. 
    
23. function on_message($connection, $data)
    
24. {
    7 t# m/ q5 }8 O, f+ R4 w4 {
25.     $connection->send("hello\n");
    3 S" x. R: [* [  A- B
26. }
    
27. 
    
28. // 运行worker
    & L) C) I8 V8 `# w4 k
29. Worker::runAll();
    7 M! Y- q2 P- v; H( @; X
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    6 i, n3 J) K  M
31. 
    2 Y' r  a0 |% Z( a
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    3 D6 _* I  r6 s! ^
34. 
    , K: V5 |$ ~4 u% Z) l
35. $worker = new Worker('text://0.0.0.0:2015');
    5 F$ {# {9 B* Z. r# a
36. // 4个进程
    # b  Y" u3 _! ~- K
37. $worker->count = 4;
    + X( M0 x; ^) {5 j2 c6 T" ?. m
38. // 每个进程启动后在当前进程新增一个Worker监听
    % G; u9 V" N4 B: L4 h# b
39. $worker->onWorkerStart = function($worker)
    
40. {
    4 @7 H# x( s% ~! c" `
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    " O' [! O6 V$ _8 o  M) r# t9 M
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    9 y3 h. Q. @( P9 G; H  [
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    ( C3 g! K6 D, I% o+ c$ n
48. 
    
49. $worker->onMessage = 'on_message';
    3 O9 l5 X  [. d2 e# u7 \
50. 
    8 k5 j, O- @" {: g0 I
51. function on_message($connection, $data)
    2 v/ q0 e8 h! }, z
52. {
      D. E4 D- |4 ~
53.     $connection->send("hello\n");
    8 y% p6 z8 a' P7 @: I
54. }
    8 g8 Q) ^! e3 i6 B8 C8 L
55. 
    
56. // 运行worker
    . ?& Y9 D2 X6 y/ g
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;
   
3. require_once './Workerman/Autoloader.php';
   & J0 P% ^$ \% {; b0 x) B9 b6 t
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   , j& n3 O" F- B9 m, o6 Z. O3 h
7. /*
   & G; s# B4 z  n; r' O+ Z0 @
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   & ^6 q* ?& V  d6 R
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   * S$ f. U* D5 m0 E3 H
10. */
    1 g# K2 x; |9 z3 u  b) D
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
      q7 D+ |, V  H  ~& n! ^
13. $worker->onWorkerStart = function($worker)
    1 J7 D4 ]6 d. i+ `4 ~, h
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    8 Z/ @9 [( E6 B* P, t
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    ) @: m& \; T2 `- C' s/ S0 I
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    ; B6 l1 B; w& B" |; d; v
23.         $ret = sendMessageByUid($uid, $buffer);
    9 q$ q7 n3 L6 Z; C
24.         // 返回推送结果
    - Z0 N) _  [! U  u) H6 \
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    5 ]/ |: I! A. i
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    ) a7 x; x& _, `8 f# g3 R) g
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    ; W9 [; |4 h# c7 `4 t, Y
37.     if(!isset($connection->uid))
    ; _' P& W/ o. a; F1 T' S
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    % s' i7 p$ o# @/ B7 y. G9 u( K
44.        $worker->uidConnections[$connection->uid] = $connection;
    $ y( i; |4 H) K, ]) z/ x
45.        return;
    . G! w' M: F" u$ f7 A/ [& {
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    - c, X2 G+ e$ I' c
50. $worker->onClose = function($connection)
    ( _. g% }. B: Q# d; Q4 \
51. {
    
52.     global $worker;
    % F' q. L% o# V8 ~% Y7 {+ u
53.     if(isset($connection->uid))
    
54.     {
    4 ~6 C3 ~6 G: r, i; Z: H
55.         // 连接断开时删除映射
    % O: k7 I" w6 W% c2 @& S$ c
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    ; s3 W8 ~3 Z  Y9 m6 c. Z7 W
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    + F! K% I( I8 [; z
66.         $connection->send($message);
    5 L5 K$ v" ~! _. W* r3 N( i; k
67.    }
    
68. }
    & }2 k7 n& P/ [; d
69. 
    0 S2 Y6 `1 d  W$ h1 p+ z
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    , ^9 C5 |5 @6 ?1 m: x
73.     global $worker;
    & U8 m0 \5 j0 K# ]
74.     if(isset($worker->uidConnections[$uid]))
    6 M2 T+ n6 p/ A& I
75.     {
    ' E5 k2 G/ K/ M* w! \: l& [
76.         $connection = $worker->uidConnections[$uid];
    0 U; N! u, T/ a& ^$ K1 a: o% C
77.         $connection->send($message);
    ( u  b. z; r" [( H: \/ y
78.         return true;
    / H, C4 j8 Y8 B. s2 z+ a7 h" V+ ]. q
79.     }
    . f% j5 G( c, f, e9 \, W: [
80.     return false;
    4 s* S7 I4 d* l( A( ?
81. }
    # ]4 }7 s9 S  }# U# p
82. 
    
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   / @+ W) y( R5 m
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   6 v6 G9 w+ h8 B2 F0 O6 D
4.     ws.send(uid);
   , |! p& H$ k& g$ F; [- \0 a
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   # _+ h* Y. L- n  ^- ^4 i5 T! i
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ( a' d+ S& {% O
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   ) m$ M0 _' S  u2 P
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   ' ]( I: h& u( `) D. c
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   $ J* f5 L& o- N1 n
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   % _6 S0 `( `1 ]( k2 r8 q5 \) f
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   8 O; V1 R0 {4 |! ?& k$ x* n
8. echo fread($client, 8192);

复制代码

0 c  h$ B' B8 p+ A" Y. q3 N