用于实例化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';
   ! e" A: C; M2 c
3. 
   : _  U1 B4 Y' u1 @+ R
4. $worker = new Worker();
   & W- y3 x+ s- I) O( i2 W, l; w
5. // 4个进程
   
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则不会报错
    3 @& h1 N, k% H4 W: x. g0 Y6 E9 S1 z
14.      */
      c# Y# G& ~" f: Q! x  q& ~
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. 
    ' L, R" F) \( j, b& b) f; t( A
21. $worker->onMessage = 'on_message';
    
22. 
    ; f, }. O5 I" q& P
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    3 O8 z" G# R9 n  ?& ^4 N% z0 e
26. }
    
27. 
    % y* v) f: i8 I, h) Q+ z& l
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    + q) z% u! C5 I' t
31. 
    
32. use Workerman\Worker;
    2 O6 b8 [; K! q% w  H/ k/ W2 {; X: s
33. require_once './Workerman/Autoloader.php';
    
34. 
    , u4 y" L, ^% r$ A& b9 Z5 d' g
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    - L/ y- ^& k8 O: m3 ^0 [: p
38. // 每个进程启动后在当前进程新增一个Worker监听
    ) i$ y5 d& i* s# K- i
39. $worker->onWorkerStart = function($worker)
    ) ~2 x8 g. E1 p; ]/ W
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    . n( c; m8 H! T
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    6 ?/ ?% U) E$ {- M* E
44.     $inner_worker->onMessage = 'on_message';
    ' m' V# L; G: e8 e. q
45.     // 执行监听。正常监听不会报错
    7 s# B9 o6 ^) `' z; G
46.     $inner_worker->listen();
    ; \# F) @: J* d0 m7 k
47. };
    3 ^; p$ {. L4 p6 G
48. 
    
49. $worker->onMessage = 'on_message';
    ( `) }8 W9 v. [6 |. M# }7 z
50. 
    & N  i2 b# w3 [$ U4 c- ^0 Y; Q
51. function on_message($connection, $data)
    8 M) U( k; o5 H
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
56. // 运行worker
    4 m0 S2 c" Q/ m$ _# ^
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
   ) U4 N$ P- K8 e$ H% {0 ?
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   , J0 t4 l  \* O$ i, @" b, i# I6 k
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
     Y& ?) w. |0 T1 |
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   7 p* O' ~; F3 p4 c: a
10. */
    / F, _) x# ^) [7 n+ X
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    * C/ Z! a" N% h' L6 C- G7 j7 W
13. $worker->onWorkerStart = function($worker)
    ( L, [7 T$ \  a: T: a
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    6 e$ p7 b% Z! \( P
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    & B0 |5 x1 c: X: \7 H2 P5 ]* u
18.     {
    ) [6 R- w4 R  p0 z0 m
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    - U: ^7 l: M% n
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    0 ^7 Y; i3 J! ^* o# G0 f3 n
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    4 e/ k6 p; O: H! H3 B4 P
26.     };
    $ P( Y9 |- |+ w. Y+ q4 d
27.     // ## 执行监听 ##
      K# L; I7 n7 u
28.     $inner_text_worker->listen();
    , n" i. V6 y7 Y4 R) n, d
29. };
    " o8 J% M. t) ?  o
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    ' u  f% h, U1 ?4 j/ m
34. {
    0 B1 S, [: {; q6 r- d& q' g
35.     global $worker;
    - D2 j) ^* B0 J; Q, V
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    ! C  l9 B& c2 y: c% G
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    . b: ]( T$ [6 q7 V9 C1 w! S
45.        return;
    . M3 w# r8 w9 ?! F3 P
46.     }
    ' M. J& r5 w3 v6 N
47. };
    
48. 
    
49. // 当有客户端连接断开时
    1 @8 Z- |5 p8 `  F$ y3 y
50. $worker->onClose = function($connection)
    - S8 p3 x7 l2 [$ f) {6 x
51. {
      A' N" ]1 h1 c5 Z
52.     global $worker;
    6 z+ a6 F( @. ~& z! Y* [1 W
53.     if(isset($connection->uid))
    
54.     {
    ) u% t! _; n* S& C# M8 c
55.         // 连接断开时删除映射
    6 O$ @# Z! p( D; N+ A& X
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    
59. 
    8 D+ `- Q" U; }$ h, Y$ Q. l
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    : o6 y5 L3 ^8 [% \: Q
63.    global $worker;
    " N, h( `% I" q% I5 ?5 g
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    , M3 P1 C. N% g  [) B
67.    }
      ]- \/ f! N2 [4 f9 w
68. }
    
69. 
    3 ]. d5 |4 J3 l# c5 m' \' d" z
70. // 针对uid推送数据
    * m" m  U% ~' i$ u0 Z; U
71. function sendMessageByUid($uid, $message)
    ! b: s& ~( S8 r+ P1 i2 i0 E
72. {
    9 K0 Y# z; L6 b; q
73.     global $worker;
    ' c4 X+ T: ^* D4 i; P
74.     if(isset($worker->uidConnections[$uid]))
    6 h, Z0 I& M  ~  {
75.     {
    # E  `1 A7 S. x$ i( }" t
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    + u9 b( j- L" b/ Z$ k
78.         return true;
    6 g% ^. [" U! m% U1 P) W9 y
79.     }
    
80.     return false;
    $ P& l; b$ |6 U6 r* a
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';
   & C' R$ ~1 D$ A: U! z2 Z
4.     ws.send(uid);
   
5. };
   " H4 c  m' o4 h
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   6 W( J; _9 \4 p1 n! D- l4 T
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   ! B' ?8 t" _7 g) F
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   $ q8 d7 G( e' j5 A6 n+ |# `0 @
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   * J7 N4 X! L( U4 J2 o9 w
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   # }; \1 C2 z$ {! m& }8 |
8. echo fread($client, 8192);

复制代码

- x4 e6 _, v& ?% }