用于实例化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;
   7 I. |1 J0 t% W2 m4 z0 \
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   5 @: F' l9 o  D6 s1 a# |7 u
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   + n& K! _; d+ C
8. $worker->onWorkerStart = function($worker)
   ! b: J- }; J" S, L1 R' W0 V! {
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    5 Q9 P/ D" c1 ]
14.      */
    : a$ i) i2 V* w/ @, g5 k, Y5 a
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ' T+ q8 Q0 ^6 V1 e7 _8 \" Z
16.     $inner_worker->onMessage = 'on_message';
    * |; `0 V, l8 |
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    & {3 U6 S- v9 s/ f1 e; k
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    " h0 h  r% K6 A4 _& p
25.     $connection->send("hello\n");
    
26. }
    
27. 
    " j5 T. a8 f" r$ T* v, t
28. // 运行worker
    1 L& P9 S' Q" d  s* I/ J
29. Worker::runAll();
    7 v  F3 F. s9 g# p' y
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    " \2 d# H: y- z
31. 
    3 n  F* u6 ]( I& V* S. _! H
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    ( ~" D1 c5 U$ I" z
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    7 w- Z1 V8 b4 s( _5 q% p3 Q
39. $worker->onWorkerStart = function($worker)
    " Z& @; X! n3 c1 }+ C, {1 `
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    + ~/ x- ^- Z. J, a
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    7 V. Y6 D! p/ T& |7 u8 f3 V
44.     $inner_worker->onMessage = 'on_message';
    ' a: z( u) V2 T! B
45.     // 执行监听。正常监听不会报错
    $ O) d; \; ?. ^, F& ]# ]; q
46.     $inner_worker->listen();
    ' M/ A5 U. ^; B" W
47. };
    
48. 
    + d. ^; x1 \5 T
49. $worker->onMessage = 'on_message';
    
50. 
    5 z# A0 w3 @- _* [' S5 u; i
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    - w* T5 U1 i# |6 |+ P+ V
54. }
    
55. 
    ' y/ W" ?" O. ?% G+ z8 {2 T
56. // 运行worker
    0 O8 ~6 a, C7 Z; x! x% E) @
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';
   
4. // 初始化一个worker容器，监听1234端口
   / l9 l1 C# q' O% P  |" f0 Z- s
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   ( J% b' |9 f% s- X% G; J
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    % M) _5 w% M: L% O1 g% U, v5 R
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    3 Y3 x0 K% k: J& {
13. $worker->onWorkerStart = function($worker)
    " {. k; j) a$ _+ R1 B' H
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    7 |; k- Z  k% M; Q8 V! d
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    8 V* l( l; F1 M0 ?1 o6 o
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    2 o% b% c! F4 X8 k
21.         $uid = $data['uid'];
    % y. Y& `9 u# g6 G$ `
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    ' p. t& n3 h/ L  }0 y# ~
24.         // 返回推送结果
      z; W) w. Y' m% l
25.         $connection->send($ret ? 'ok' : 'fail');
    2 A3 x& h% @$ x; g
26.     };
    " B5 R9 c8 v& X5 d. z' \" B: `, S+ _. X
27.     // ## 执行监听 ##
    3 }& W2 R; q; Y5 G2 T
28.     $inner_text_worker->listen();
    
29. };
    . H& t& `) X1 k$ O) z2 D6 D6 h/ h
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    % l! a& d/ [* d1 L* ?( k! Y# s
32. // 当有客户端发来消息时执行的回调函数
    , ~( O$ S- x- F: Z5 ]
33. $worker->onMessage = function($connection, $data)
    
34. {
    * `/ W! }9 G. j7 N. L' q4 a. O
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    8 `( q" N1 O* `0 f9 Q$ A
37.     if(!isset($connection->uid))
    , t2 S* Q2 }) N% P+ m- q
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
      ]7 L5 M7 t2 ~! r, k% Q, m$ S5 F1 m  F; J
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    / ?7 ^/ `/ V6 {( Z/ X
42.         * 实现针对特定uid推送数据
    , E9 i9 d$ u+ H9 ~' R" w: u$ l
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    * [! M  j# S+ P+ r
46.     }
    8 J2 Y& ^( B+ J
47. };
    3 a1 H3 M; q# r
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    # F. y+ J% m  w# K$ y
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    ) @% t  E  i' c
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    $ _8 z0 p. n/ Z+ a9 k
58. };
    
59. 
    $ D. `' F/ t# W$ P- R
60. // 向所有验证的用户推送数据
    % Y& ]5 J) T8 U9 {* \
61. function broadcast($message)
    
62. {
    % s) `/ _* l- x/ V
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    1 v3 B6 r( o# ]/ N  U6 P3 h7 k
65.    {
    & h6 U: P8 L, j, n" Y, s
66.         $connection->send($message);
    
67.    }
    - P# @$ G) U  t0 F& u8 G
68. }
    ) J8 t6 W1 Y# @4 F2 Y+ W
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    ; u. W, D8 o+ T* l+ z; U# i1 G) S  \
77.         $connection->send($message);
    
78.         return true;
    * p6 s8 k$ u7 H- T/ N3 ]
79.     }
    3 e- {+ }% M# @- i
80.     return false;
    # `( j/ Y# o3 h+ q
81. }
    
82. 
    , g$ V' K8 f) K# y
83. // 运行所有的worker
    8 h9 J" a/ k* I; n, m, j3 T
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+ h& ~1 q: K) H- [
4.     ws.send(uid);
   
5. };
   
6. ws.onmessage = function(e){
   ' |# c" C$ w+ J- Y+ o9 v& s" t# Q: X
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   - i' v$ X/ [# l& c8 K1 J
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   2 _9 C' T% t/ Z
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   ( X& q7 N* G" I; T3 x! z* q
6. fwrite($client, json_encode($data)."\n");
   ! m) J" M/ X% F2 }) u8 D2 p; Z- a+ d
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

! G1 D7 U$ ?+ h2 q
5 I( L# X2 B0 X2 A1 @