用于实例化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';
   # G6 @  k# m2 D' J* t
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   ; N. u! y% v* J4 G3 d
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   % L6 \0 V1 O$ a. n3 g) n
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    : P  k0 t: B5 e6 g" r+ {
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    . @" G" t% p% y9 _  V1 |" H
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    " i7 V' \& i& O7 ~. b  @2 x
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    ! Z5 R! [  H% B  \( C
22. 
    ( e  f( \, F0 B; w5 ]
23. function on_message($connection, $data)
    $ n+ G# C* J2 }9 G# Y
24. {
    
25.     $connection->send("hello\n");
    1 M$ U$ k" x5 ?  C' T" g# i
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    8 ]3 }) j$ H2 l- v' U
38. // 每个进程启动后在当前进程新增一个Worker监听
    5 j6 N4 ^: b8 x, t9 ^( z; Q
39. $worker->onWorkerStart = function($worker)
    
40. {
    ( y, j$ Y" e9 d0 _& R
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    3 i5 f. H' m- K9 _5 l* e* h
43.     $inner_worker->reusePort = true;
    ( M2 J4 T+ j4 f' [; K% G
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    . d: v! o& ^5 W& P& ?
47. };
    . a# L2 r' B, J3 G
48. 
    5 a! r. t0 f/ S
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    - `1 d; U, \# x; N$ I
55. 
    
56. // 运行worker
    # P& [3 C. \3 Y# @3 }6 Z4 d, h$ {
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';
   0 B7 M! d" C, t' h! R4 P% @! ~
4. // 初始化一个worker容器，监听1234端口
   7 v- q4 w( ]8 K1 I
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   % _7 C5 s. E! _7 T2 J8 s
7. /*
   4 e0 v, P: B9 ?/ t9 @
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    $ V: m% i  D+ Q+ Q; Y6 E
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    - d9 ^9 L, H/ W
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    7 I% l' e9 m6 O. Q
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    . K3 Y* b8 }  W
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    9 A, L6 f  K6 Z* e' f2 p
27.     // ## 执行监听 ##
    ; T  j) v1 S) }: v- @
28.     $inner_text_worker->listen();
    1 H5 ?% W  h( ]- @6 J
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    ( t1 c9 Y; b2 t9 K3 D4 N, e; ~
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    $ p6 R3 m( T7 I. h7 Q
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    " `0 ~# I5 S$ u% {" o. \( D
37.     if(!isset($connection->uid))
    : x# |5 i; _7 D) K' _( T! a7 d' i! Q
38.     {
    ( k+ F, f; g, L/ ]8 D( l
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    " O" A$ i5 G! `
43.         */
    1 n  N& C: r. |, n7 C) L$ y
44.        $worker->uidConnections[$connection->uid] = $connection;
    9 }4 O. h7 V. e6 a3 P: w. d  c
45.        return;
    4 Q' q2 w+ P% U0 {
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    ( y; J$ y; l3 M" \; x4 p
50. $worker->onClose = function($connection)
    
51. {
    . E7 M/ b: o2 E# G( B+ v
52.     global $worker;
    
53.     if(isset($connection->uid))
    1 t# }1 Q  F) [6 x
54.     {
    
55.         // 连接断开时删除映射
    # u6 j  F% Q. M: R) q) |; ~& b
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    0 r' e& m: m$ @& P2 d/ l
58. };
    % {3 V. a8 V3 Q5 o6 t4 q
59. 
    
60. // 向所有验证的用户推送数据
    $ W& u: ?7 \8 E0 `  T& S; T$ [. j
61. function broadcast($message)
    2 U& j8 z: j) t8 G% e, L
62. {
    
63.    global $worker;
    9 `6 _+ A4 z2 c' h% i6 a8 A
64.    foreach($worker->uidConnections as $connection)
    0 _6 y) b0 ^, J
65.    {
    
66.         $connection->send($message);
    : `# n: e  a; b2 c- \
67.    }
    9 G8 A+ K3 [1 s, d
68. }
    % n% w; q- @# L+ K& x" H; e' @; s
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
      K2 R4 h% |0 O( y  i5 d
72. {
    # J7 X0 |1 @' _# D0 u# Y) k
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    * l5 i2 [% j, v7 Q
75.     {
    % v+ w" K4 @. |; F  Q: P
76.         $connection = $worker->uidConnections[$uid];
    - J, h) o4 R& h* a
77.         $connection->send($message);
    
78.         return true;
    ( F: p1 N2 f  u. T5 @$ i& a
79.     }
    
80.     return false;
    # o; K2 Y! @1 E1 T8 c
81. }
    ! h: C* n$ c# ~7 x2 p( A% T; p; O
82. 
    5 i2 \1 L6 O( X2 j- F
83. // 运行所有的worker
    8 h  M" K. Y) T3 ]3 E
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   ! C3 D& G) _5 a( N
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   
5. };
   ' R( B# g( l7 G' H
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   ! x! c1 M; X: y7 g5 x
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   7 A9 ^4 Q3 h% A# j
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   9 L# V$ J  {/ s# E6 Y
8. echo fread($client, 8192);

复制代码

7 ?6 n5 p' q1 f; b% ]# E