用于实例化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';
   8 a2 V) w7 o/ d6 m, @5 \
3. 
   3 A5 E% V( \# U& {) U
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   # [1 ?3 r2 ]# l5 s/ V; W
8. $worker->onWorkerStart = function($worker)
   8 l6 w7 [' ?+ }3 [# _
9. {
   % {) J7 a) E  c
10.     /**
    8 H$ i6 S) Q4 _: J
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    7 Q( M( \. o% |6 ~' J5 i1 W
13.      * 如果worker->count=1则不会报错
    
14.      */
    6 ~1 d9 v& ]: l! p5 c& K2 t
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    , }# Z7 Q# X, b/ Y
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    * L' V8 j+ |. w2 h( ~
24. {
    
25.     $connection->send("hello\n");
    
26. }
    % U3 ]9 D& `* _  n0 v/ t9 D# S
27. 
    
28. // 运行worker
    . A) Q2 K  @! b- M6 r
29. Worker::runAll();
    0 I  u, ~) B. |7 m, @8 V
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    . U2 @! l! K' U5 ~- w* H  W
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    " r) Q: @9 a( }# n0 b8 i/ _) f
40. {
    . F4 s+ Q) y8 `- t% o
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    ( w' @0 D# \" f8 F& i+ j" {# i
44.     $inner_worker->onMessage = 'on_message';
    * h% f& }9 X) z+ o7 H, G" Y8 Q, p
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    $ A/ l$ d- R7 d4 U9 y
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    4 r; _8 c) p. h
50. 
    " J1 J$ R1 M  Q
51. function on_message($connection, $data)
    
52. {
    % N% E7 |; A/ k6 h) o
53.     $connection->send("hello\n");
    
54. }
    ) Z1 ~2 z2 u5 K! [% |% P! {% K! p1 ]+ G
55. 
    
56. // 运行worker
    3 I4 J7 W) n" k# 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
   
2. use Workerman\Worker;
   4 ~! m1 K) s0 B8 Y, R& ]' j5 P
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   , W9 L0 N7 t) {$ m8 h8 J0 x
5. $worker = new Worker('websocket://0.0.0.0:1234');
   6 O' \! ~* N5 W' K: d6 c6 D
6. 
   ; `! j( k8 D* H2 J+ \
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   # m3 q) w. O: C# R4 t
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   7 ~5 _( J5 [4 S: Q
10. */
    ( n. }! s/ s+ V1 |
11. $worker->count = 1;
    , E3 [7 W1 a: \% o7 \. W
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    - S* u, U; f# }5 p7 a$ G
14. {
    + Z0 F% E8 }7 n9 r
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    1 A2 `% ]1 \, x+ [' O$ |7 B* o
18.     {
    * e2 l) U2 c& G
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    , \5 {% k$ G" Y* S$ H
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
      d6 B; J1 r; e" Q% @; G- ]$ Y
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    ( K, [5 d! ^/ P( T! Z' l
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    ( A; L& F' x  S3 H, M6 y0 C
34. {
    " u/ e8 Z# j, i& J
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    ) j# K. _+ P3 V& f% z
38.     {
    / k2 r/ ?0 l6 r0 P
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    % h; F0 [  R/ P/ N  Q9 I9 U
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    3 A& V, d" u2 X8 m; o% u
43.         */
    ( d; G, j4 Y" W6 ~, F7 r0 u5 f% W
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    : m+ X( d* S/ {9 K
46.     }
    / ~( C# K* [4 Z# ~! l
47. };
    
48. 
    6 \1 n" z& o  h+ T" f, s( M/ N9 s$ d
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    7 D1 |+ ]9 M6 B5 F2 L) v
51. {
    5 l" N3 w: L* E  E6 \7 i& y  @: A
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    ) u8 g) Y: F" r- m# F9 r
57.     }
    : ]% _: Y; D& w: |
58. };
    8 q* i# L5 i' H4 \4 D* U
59. 
    ) }9 n; E% ~6 E$ V% Q
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    ) o- D5 A, s% Z, b% ~$ t) |
63.    global $worker;
    1 Q# r" B! ?6 x/ _$ H
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    
67.    }
    ' Q) a8 N/ n# B) o9 j" K: z
68. }
    
69. 
    
70. // 针对uid推送数据
    / p7 H! Z' e( y% c* c- P" D0 P. J
71. function sendMessageByUid($uid, $message)
    % U  A) t, ?) v0 R3 E) Q: ]
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    1 g9 d' }- z0 j" U  x, k
75.     {
    / H6 y; \. k# D& n: Q5 U
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    ' D+ |' ^  w/ J: L, J3 R9 S0 H9 p
81. }
    
82. 
    $ v6 z8 L  h6 U
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';
   
4.     ws.send(uid);
   3 B2 d: `2 O  O% J$ h
5. };
   
6. ws.onmessage = function(e){
   * A1 V" T. z' e
7.     alert(e.data);
   * I' D1 a. c' W7 G- T) C! C# W
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   3 {. s. e5 M; h3 L& u
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   ) o/ G7 ^: T/ D2 j  v: q$ m0 h
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   " X, A( m2 ^5 \: Q
6. fwrite($client, json_encode($data)."\n");
   7 J1 D& l4 z, T/ ], `4 K
7. // 读取推送结果
   5 S4 U; d: x, O( J" j3 w/ P
8. echo fread($client, 8192);

复制代码

% X0 D5 l& S  q* a