用于实例化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';
   2 _. q. k0 r( O6 Z2 ]' L8 W! w4 D
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   8 M. ?2 g: g0 B( p6 D
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   8 W2 x: F; E- V4 w* l
8. $worker->onWorkerStart = function($worker)
   * O3 t+ F8 B" B. D4 S
9. {
   1 y4 \  r; A! {& M, N8 w
10.     /**
    1 f7 o0 ?; t$ O8 }  _
11.      * 4个进程启动的时候都创建2016端口的Worker
    ) k1 N: f8 t6 ^! o) ?, G& f: M5 `/ T8 c
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    . z& n8 m# f5 R' h
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    5 d/ T1 l7 T: x
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
      d2 l( ^6 @( E* L& ]$ Q4 R; u
19. };
    4 y7 g* Y0 A  j3 l6 I& c- R
20. 
    9 j. _' j- H, z4 c
21. $worker->onMessage = 'on_message';
    ( F. e/ N) g" j  d  @: d- h1 ^( w
22. 
    
23. function on_message($connection, $data)
    6 a; ]5 s2 U: j+ r
24. {
    ( C' D4 H& M7 X+ L. {/ R
25.     $connection->send("hello\n");
    
26. }
    / S# Y+ }' W: L
27. 
    # ~6 g5 _$ I/ W# {4 C
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    : _1 Y- `* u2 M# u3 j
31. 
    ; c4 Y! ~' T3 ?$ F, A; s
32. use Workerman\Worker;
    . H7 R" w$ {5 ^! l
33. require_once './Workerman/Autoloader.php';
    3 _; g4 G. S: g: g7 l  D; a
34. 
    : j  {+ k6 w( d
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    ! F/ r% `" f  L5 ^& W
37. $worker->count = 4;
    % Q& l* ?" {( G% G2 J/ c' k! J
38. // 每个进程启动后在当前进程新增一个Worker监听
    ! }7 [- j" L2 Q, A' R
39. $worker->onWorkerStart = function($worker)
    - G7 b5 q; b2 Q# A+ ~3 O6 B
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ! ^( d. [+ X  C5 G5 d* G+ P
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    , R: E( J2 v5 I+ B6 Y8 B$ g
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    ' o4 d3 M* A  |. Q% A
46.     $inner_worker->listen();
    
47. };
    9 l1 q/ }0 b: _7 t
48. 
    
49. $worker->onMessage = 'on_message';
    & Z  q! e( c- r/ E0 i5 A
50. 
    : Y6 n/ F& `' a: O
51. function on_message($connection, $data)
    : z- N8 S9 F* q' J" e
52. {
    2 S1 q& d& h) K5 _
53.     $connection->send("hello\n");
    # f8 p3 Z) u' x% v$ G  u
54. }
    
55. 
    
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
   
2. use Workerman\Worker;
   . p& X6 T/ p; [! U9 u! e
3. require_once './Workerman/Autoloader.php';
   ' r& f/ i2 Y0 q# I% d  s" V% n
4. // 初始化一个worker容器，监听1234端口
   - ]3 b0 w6 {5 V7 `7 `
5. $worker = new Worker('websocket://0.0.0.0:1234');
   + Z; x; N* A- o. n4 k
6. 
   
7. /*
   & t) V6 z8 U7 w7 o  H' \
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   . \# I/ C- ~5 w7 W2 O
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   " O- }0 o4 H5 D
10. */
    
11. $worker->count = 1;
    4 U6 @% V; K: p2 V- W
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    0 A0 b$ Y$ @! {( S, X0 ^2 K9 h" Q
13. $worker->onWorkerStart = function($worker)
    
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    ; Y* w6 U# ?8 Z$ z2 v
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    % m; e7 `4 x( t* r# {# v8 E
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    % O& s8 m6 n7 I
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    # h0 }8 P# p0 H; D. C( j) [
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    ' R2 E4 P; @0 y9 W4 k) z
29. };
    $ E, v: z3 T- Z: W
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    " \$ |0 a/ a0 D$ f( ~  Q
33. $worker->onMessage = function($connection, $data)
    
34. {
    9 O& ]% B, S: v% J# j) a% h
35.     global $worker;
    2 w  o5 y! W, S1 f2 L: T
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    * K+ C0 x' h! _6 ]% k* z
37.     if(!isset($connection->uid))
    . R! x' E% s# |7 G' N
38.     {
    $ L2 X- u* @2 Z8 W# P
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    0 i5 V/ s+ v. E3 X
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    . U' W$ |+ ]# G2 [( V* \% o
46.     }
    
47. };
    1 ]4 g" k' k* M; f& D* u: j
48. 
    # F9 O# u+ _# R0 J
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    & l2 H+ ^% J% I- o4 y
51. {
    
52.     global $worker;
    ; g5 V# n8 c' y7 W
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    % b3 F- h% k; J/ \6 k
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    ! Q  m/ R. e3 E" g- n
59. 
    
60. // 向所有验证的用户推送数据
    0 ?( F8 F* I3 w) e
61. function broadcast($message)
    
62. {
    9 r6 J0 N" l' W- n+ T$ `. `
63.    global $worker;
      u$ t5 O4 N8 e' O
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    7 q7 s. c: J  p3 U
66.         $connection->send($message);
    - v# ^* B* I; z5 X% n9 G6 _
67.    }
    
68. }
    7 L( g5 F" X% R4 K0 `# S& l- `
69. 
    
70. // 针对uid推送数据
    - ~2 Q& u! |* ^" e* r5 E, U
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    : ?0 z9 p  M- ~3 w% T9 z+ y6 N
74.     if(isset($worker->uidConnections[$uid]))
    . _* t6 e3 W- k) M0 d8 Q
75.     {
      D, C& @# @; f% t. }
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    ! n$ y' r, [! c1 N; I
78.         return true;
    6 A. w4 S  {+ n! \! d
79.     }
    
80.     return false;
    2 b  F. ?9 R( j0 P& g+ {
81. }
    
82. 
    
83. // 运行所有的worker
      u5 Q4 F: n/ ^! h
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   5 S. G, {3 M; P0 ^
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   
5. };
   . E( @0 O" G- v: {3 T7 W
6. ws.onmessage = function(e){
   5 R( A7 [) y2 `; H. Z
7.     alert(e.data);
   2 A; b* F$ F! [" i
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   7 c6 w0 E9 j; ~
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   6 s0 k3 w2 P4 M8 C  H) W$ J7 r# u( {
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   + A$ F7 t1 [8 ]2 j7 z) S
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

) S; u6 R0 Q* z# @