用于实例化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;
     w* A9 N  c  A0 e) w# F" l
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   ) `/ G5 A" Y0 m; E
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   $ h2 R: h0 [+ }+ P- E  v
8. $worker->onWorkerStart = function($worker)
   , k# G, ]; D  G. B. ?. C4 |
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    ) E6 H1 g2 \7 g
12.      * 当执行到worker->listen()时会报Address already in use错误
    : z0 }( ]  a5 G3 }
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    0 p3 {5 n- w5 \7 K* o
16.     $inner_worker->onMessage = 'on_message';
    ' F6 p- H0 f+ j( E
17.     // 执行监听。这里会报Address already in use错误
    4 g1 W- B" h! @+ S# X
18.     $inner_worker->listen();
    
19. };
    
20. 
    9 R$ L5 E2 {/ @7 [3 W- J8 e
21. $worker->onMessage = 'on_message';
    
22. 
    ( y# ~8 l' m; ]
23. function on_message($connection, $data)
    8 A6 v. k% _9 c% V2 A6 @& N
24. {
    ! @3 H1 Q; T7 K4 Z$ Q* q
25.     $connection->send("hello\n");
    ; }; c7 r+ g6 |
26. }
    ( I- A) t5 S3 J0 A0 y
27. 
      J; \' r. Y/ |2 e8 y( @
28. // 运行worker
    ' n: r5 W8 t& W# I6 G
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');
    * @0 b( `1 }9 r8 a+ @" ]/ v
36. // 4个进程
    # j5 ]6 \% u+ P8 ?! J5 C
37. $worker->count = 4;
    - v+ K/ ?& q% ^  z2 m/ M
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    & b. c9 Z, S' ]* s. G9 f
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    ' ?& ^/ m: I$ {
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    4 D6 l  O4 Z' n5 L' E# c* L
46.     $inner_worker->listen();
    0 n3 z/ T* k% ^9 C, m  u  m
47. };
    
48. 
      |: c7 Y, z# x4 d' b; a) t
49. $worker->onMessage = 'on_message';
    4 O( g! ~3 C( A
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
56. // 运行worker
    . x% C' m; B! {: J$ m( }4 W7 q
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 r! Z$ L4 G' |6 K4 U9 C9 x. E
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   $ |" D) S& C$ J4 U5 M
10. */
    
11. $worker->count = 1;
    2 A8 U: q5 K% c; G: f% \
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    9 t2 [5 T  e- k* F2 @( ?- a
13. $worker->onWorkerStart = function($worker)
    & |: H8 @' V0 ^$ n+ @5 f
14. {
    5 S- [+ w( j1 r" J
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    8 C+ `; D2 Q1 C$ `: ~- c! y
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);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    # T/ u* x* ~0 b- ?- t) D
23.         $ret = sendMessageByUid($uid, $buffer);
    ' \7 v' x' Y2 q( O: H
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    ! U9 _! A# G. J9 Q* o" W6 s
27.     // ## 执行监听 ##
    9 R- F. {9 ]9 a# Q
28.     $inner_text_worker->listen();
    
29. };
    8 W( S9 Q  K9 R! d* R# ~8 k8 I$ }0 D( _5 b
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    3 N8 M6 R) |) V( {$ r* k0 i+ d
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    * W; c- ~1 k: [; H1 [) w* L
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    , z$ d" q) Y# @5 g* a1 Z# q
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    $ t% a( g, d8 C, u( L
44.        $worker->uidConnections[$connection->uid] = $connection;
    0 t$ _: {8 I/ [& b
45.        return;
    % H' ^, O& L9 k
46.     }
    , h0 h% g) F2 K2 T0 z
47. };
    6 y4 F$ @% j5 {$ s! O
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    * Y  y; d$ q, H7 B1 C+ M8 T' A
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    8 `  Y; G/ P: K7 z# `1 I9 K
55.         // 连接断开时删除映射
    ( H1 F! ^- [7 D# V( Y! `
56.         unset($worker->uidConnections[$connection->uid]);
    8 ]+ V7 |% o! ~6 S, R
57.     }
    & z! ]; F; H: X
58. };
    , V; A& }" a9 o# x2 I3 A0 ?$ s
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    2 ]2 Y# `, @2 K3 {+ m( z
62. {
    
63.    global $worker;
    " K3 e4 h0 }, M8 R/ N% P
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    ' D* {" D( m+ Y4 W, n( |
66.         $connection->send($message);
    $ u6 m- }: o, k, }5 u
67.    }
    
68. }
    - u3 B2 N  s6 E! a) Q) D# A) A
69. 
    6 U; |7 ?4 k3 ~$ C; P2 v: a
70. // 针对uid推送数据
    . Z; e! M6 v! H: n% m4 p
71. function sendMessageByUid($uid, $message)
    
72. {
    1 w3 J. @6 p' u; c" Q& _
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    1 l" l' t! g" Q2 @0 i
75.     {
    : ]/ ]$ P8 }$ W" c
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    $ T$ j' G1 U! o
78.         return true;
    
79.     }
    
80.     return false;
    
81. }
    7 o" _7 W" `+ B2 `
82. 
    9 E  @9 h. y" a, k" `5 H& L
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   " N4 \8 A( B1 b. g$ X0 J: w' `; j
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   * D. ]; `( t" n3 d% J) R5 a0 t2 P" d
4.     ws.send(uid);
   % B2 b6 r. |3 J- ]' L
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   , V. u8 T* h' g( d  P
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   - {& W0 J0 h' r$ N' g9 m: X0 n
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   % u  D. W8 E' |5 |+ \
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码