用于实例化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;
   0 s5 g% F8 ^, w; z8 w
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   ' K: f9 t: d7 |9 B" J" d) U
3. 
   
4. $worker = new Worker();
   & n; v1 t( }/ f5 h$ F
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   3 s/ F& ?% p& Z7 \/ B: C
10.     /**
    1 G! J! i0 F# g# ]
11.      * 4个进程启动的时候都创建2016端口的Worker
    5 m# }& n. n# }/ W7 e
12.      * 当执行到worker->listen()时会报Address already in use错误
    5 }3 Z  r: u" Z; f
13.      * 如果worker->count=1则不会报错
    
14.      */
      ?7 q$ t/ r: t1 A( A3 O4 F/ P
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    " {2 `; D2 Z+ k% N
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    - \0 v8 l5 r6 K! j* ]% p
18.     $inner_worker->listen();
    & K  R- j) O2 ?2 u
19. };
    
20. 
    ; H" Q" _( i% y7 l3 b
21. $worker->onMessage = 'on_message';
    
22. 
    + V" T. |5 x5 N  @4 v" x& }
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    0 E3 S# h! K; P. Z2 j4 V9 M8 k
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
      n2 R1 Y# w/ v" i+ Z+ C
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    ! \+ ?# e2 @) x& q8 L  C
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
      S" N% t6 W8 U, o  W( L8 s* ]% K* k
34. 
    : ?  g! m. _, o; z9 s! M
35. $worker = new Worker('text://0.0.0.0:2015');
    ! e6 B7 V1 E, `" a$ }/ v
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    % u2 X7 b2 D; w4 d1 n( {- c
39. $worker->onWorkerStart = function($worker)
    
40. {
    . e  H9 Z( a. z7 P$ [  C8 x
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    , u- a' m2 V- f' b" l6 y
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    9 d1 v: s( ^4 c9 ]4 w- q4 n
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    8 a5 N2 S) X5 J# z) G, s0 T5 `
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
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;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   9 \  P3 W' E/ f7 _; ~" D% m
5. $worker = new Worker('websocket://0.0.0.0:1234');
   8 l9 W0 G7 }0 w# O
6. 
   7 f" E; q: o& b" b/ p
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   & q7 Y2 M9 C& \; l
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   / D# A& \) z6 G7 g1 i# W* k
10. */
    ( q2 S( h: F' g7 `+ G, M
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    1 ]5 K9 h) n% Z  c9 [+ I( v
13. $worker->onWorkerStart = function($worker)
    8 \9 z' x- p2 s, f
14. {
    + o" k( P; L; E
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
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的页面推送数据
    $ c; E# o3 d4 [' h% d
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    0 {% R  q! ]& S
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    " a7 e9 c7 c. N0 W5 Q$ I% S
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    - [3 B( a: P) S( {+ j9 G$ @$ |" V
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    ( X4 t5 ^5 H8 f! |
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    7 i6 |2 y/ H& V% v7 [( ~' Q& ?7 C/ i8 C
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    ( I& m' A- f  D( C
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    % h1 r/ m8 X9 j, j" P& y
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    + u5 h9 v5 K+ h( H) i/ Y( a
44.        $worker->uidConnections[$connection->uid] = $connection;
    " E; L4 @$ ~6 Q; O) j
45.        return;
    - H' L( Y7 K8 U1 ~3 c6 s% n
46.     }
    5 L7 M9 m, N/ m# c) `8 E  P
47. };
    
48. 
    " {# c( g" }( T: U
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    / B+ d) C2 {# A+ H
54.     {
    
55.         // 连接断开时删除映射
    1 ^; |# W: J6 m* B; B% p- T9 \
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    , U/ w" o# ]& |8 N+ o
62. {
    
63.    global $worker;
    / F* V6 s. F' }
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    3 q8 A" O8 k1 b" N: X; u0 v+ L+ |
67.    }
    
68. }
    " q& Q! {  u6 m) z
69. 
    7 x2 q4 F% j, `: T& u( D- \
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    % S# A5 Z% t* g/ D
72. {
    
73.     global $worker;
    - ]& ~  e& C% o; f) T" ^3 S
74.     if(isset($worker->uidConnections[$uid]))
    ; v( O# N0 e) i9 Y0 X2 y' \% s. Z
75.     {
    4 _" {4 W% e2 d) @
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    % J1 t! e% ~' C- P- u8 u& f; {
78.         return true;
    
79.     }
    8 \+ t' m, L9 R5 V0 ]# f; b9 i) W
80.     return false;
    
81. }
    ! u& o6 A" G2 d: s
82. 
    
83. // 运行所有的worker
    - v4 s& V% 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(){
   
3.     var uid = 'uid1';
   . r  v5 q- N3 ~* S! O
4.     ws.send(uid);
   ! ^* F+ w( j! I6 _) V% ^1 _# P9 [
5. };
   
6. ws.onmessage = function(e){
   " h% ]1 D2 H7 r. T, o
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   , A4 R% P5 Q4 p3 d6 b
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   8 @8 ^" P' }: |+ x1 Z! v
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   5 m3 @$ a. w* _; g3 I1 r% E4 s
7. // 读取推送结果
   : `, h6 w+ p% ~- P; ^
8. echo fread($client, 8192);

复制代码

$ J! r& r3 Z3 F