用于实例化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';
   / W* C* L, P( q1 E" i
3. 
   $ a' k$ e, n: W+ u% [# i
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   , U" r5 Q2 E0 g) R: `  O
8. $worker->onWorkerStart = function($worker)
   
9. {
   / E2 p1 B5 G5 Z4 ]
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    0 }6 [) v* B4 b2 _/ E
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    0 _  r6 c5 y% C- B. V7 ]/ z! o! z
18.     $inner_worker->listen();
    
19. };
    % u- s% @, m$ ?! F; }9 e
20. 
    
21. $worker->onMessage = 'on_message';
    1 K1 ]8 j; J' ^# G
22. 
    
23. function on_message($connection, $data)
    0 g- t( J( Z. r* N  Q. u
24. {
    ' Y; Z# u3 A. Y" [# a4 O& C
25.     $connection->send("hello\n");
    % |  m% L; [8 i+ ~& s: `8 ?
26. }
    $ s* h7 u. \$ _- f! ]/ M: |
27. 
      n, n- f! _3 o* G* A0 Y6 H7 |+ U
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    : q0 n$ p- L4 Z/ O& j# \
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    " g- x+ p- b3 u( R. g6 ^
36. // 4个进程
    % s$ m( o% i/ x! ]$ V
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    3 ~/ s2 S  O7 i) p: o( q# P! j
39. $worker->onWorkerStart = function($worker)
    
40. {
    " L$ `' V6 \/ _: i# y0 v
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    0 z9 P& x( G2 \% m. Y
43.     $inner_worker->reusePort = true;
    # Z$ N0 z$ l' L$ p; G
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    5 W* n5 p1 H7 q, H( M8 |) U
46.     $inner_worker->listen();
    
47. };
    
48. 
    6 O; Q1 V' Q5 _
49. $worker->onMessage = 'on_message';
    / M1 v" r7 a7 N: ^, F! J! y
50. 
    
51. function on_message($connection, $data)
    : ]% q, V& i+ p6 }" M$ `
52. {
    
53.     $connection->send("hello\n");
    - }) G4 p; _1 G- [
54. }
    
55. 
    , ?" N# b( B$ [5 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
   3 i- {  ?- M6 u" _1 r" U  v
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   : Y' `8 b3 M9 T7 Z6 M
7. /*
   0 |. O8 G6 N  j. Q# h2 o/ H
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    7 V) N/ F- C$ z0 }2 B
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    # H; l7 v( d; K6 j# G
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    7 }% p( p' Z( m, C2 |1 V
21.         $uid = $data['uid'];
    $ I  b" h$ Y# Z
22.         // 通过workerman，向uid的页面推送数据
      t6 g/ b! M' B. B: k
23.         $ret = sendMessageByUid($uid, $buffer);
    . D- G% Q) ]- x
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    * f% b3 R9 i8 y$ J, [
26.     };
    9 y) j5 ^; ]% P4 s
27.     // ## 执行监听 ##
    ' J! |% ]" o0 ~- r- i
28.     $inner_text_worker->listen();
    8 H2 L; `9 t% N' h+ O
29. };
    # W6 P& ?( N$ f, H& X7 f7 f
30. // 新增加一个属性，用来保存uid到connection的映射
    * G0 U: l8 e' v7 W6 [
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    " v* s! z+ O7 V# ^, t# ]: k+ o1 P
33. $worker->onMessage = function($connection, $data)
    : [$ ?8 t" E+ w' M  m5 w. q
34. {
    4 g1 O) p7 h2 n3 f
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    2 m6 S9 Q, A$ z
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    # s( S7 O; n$ Y! `4 n: r' C. y2 j
42.         * 实现针对特定uid推送数据
    - b. H* ]6 r% v
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    - c0 e8 K1 p; l/ `" c2 a8 c: \
45.        return;
    9 l/ `% g3 ~) ^8 o6 l
46.     }
    
47. };
    
48. 
    % l9 T" X: q0 Z! ~4 t" Q
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    # }  O" E2 [; q" d* a4 _; L# l( i# S
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    8 a( o8 @) B% x, [4 W+ H* N" a
57.     }
    
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    2 v& }0 f9 N" a) i- m" ]# g+ O
62. {
    ) @' D5 l3 c: }5 c1 Q: H
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    + |& {9 c% f$ s! u; x
66.         $connection->send($message);
    1 P/ z' X# K" A0 ?, z) \  l
67.    }
    % |* e# z  }! O+ _$ z: N" Q8 X" @
68. }
    + [4 y' ]1 B. \+ y) f1 b8 p6 J
69. 
    
70. // 针对uid推送数据
    6 A% P3 J) k  l. Y/ ^% H  q( I2 x
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    . U. O2 X- v7 g$ Z4 {: c; i
74.     if(isset($worker->uidConnections[$uid]))
    3 Z  O, m# F7 \% ^  M
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    
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';
   
4.     ws.send(uid);
   - I* j1 \" d. n, x
5. };
   . R+ B2 s4 y  u  c
6. ws.onmessage = function(e){
   " S: S' Q: n+ q3 e9 `4 X
7.     alert(e.data);
   & }8 r) E6 z: s) H  F! M* r2 K- \
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   * m% D6 n! ~# C1 \# M' Q7 g: a! e
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   * ^$ P7 m( z% J; L1 W
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   / H7 r! O5 O9 Q( R9 B4 n
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   " `# I8 l# m" u, [2 W
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码