用于实例化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;
   $ E) P# H  S- M* |3 q
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   6 S0 H/ h6 e, n# v; s2 N4 W
7. // 每个进程启动后在当前进程新增一个Worker监听
   $ r# ]6 D2 l2 a  K- D
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    , I; l, f2 l; G. G- f: Z6 T/ u$ p
12.      * 当执行到worker->listen()时会报Address already in use错误
    & E" J* Y/ o% }( i. t# }1 @
13.      * 如果worker->count=1则不会报错
    
14.      */
    5 W2 b# q" H7 M
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    4 w) `7 Q+ T  p4 U( A' o
22. 
    
23. function on_message($connection, $data)
    . O: o% j6 ^, C$ M
24. {
    : m+ Y) X* ?  y
25.     $connection->send("hello\n");
    
26. }
    
27. 
    
28. // 运行worker
    ( c' c7 [" y2 [0 C( f. i
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    4 s" X1 M, i  T- Y4 u8 m
32. use Workerman\Worker;
    1 ?6 I0 C2 M6 ^/ h! Z8 G/ _+ m
33. require_once './Workerman/Autoloader.php';
    ( F7 D) K% l, ?# P& G8 d
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    , O2 q' u5 l# G/ e/ n- X
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    ! n! D5 v( U/ f' b* H: H  F
39. $worker->onWorkerStart = function($worker)
    
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ; ~( T0 v4 R; v+ ?  u
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    4 ^! w6 s0 h# L+ z1 g* @  U
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    ( @6 o- i7 k. K- t0 g: \. ]" m1 u
47. };
    % K+ `0 v& A6 Z) |$ N+ G
48. 
    9 ]4 p. V! ]5 O# M& u2 v
49. $worker->onMessage = 'on_message';
    9 }- z: y, j3 R# g! ^, }9 p
50. 
    & e( C# J4 A  {6 h5 w
51. function on_message($connection, $data)
    
52. {
    % P6 Z9 }, |" T
53.     $connection->send("hello\n");
    + [( ^. ]" k7 \8 o# r& g. S
54. }
    9 s+ s# F& f9 i
55. 
    4 }  u8 Q' {, U+ @+ G: c
56. // 运行worker
    7 u9 K. m7 Z# u2 \
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';
   ! E* m+ N4 Q0 p( i
4. // 初始化一个worker容器，监听1234端口
   2 N% S( ^/ t% w/ Y7 f9 g7 o
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   + H0 L; b! k5 H
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    5 ]. Y9 M% G) H3 l8 p! s5 o9 }! ~
11. $worker->count = 1;
    . ]% a6 P7 \  [; ^. {" [- a# ?7 n
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    ; ~; K6 e/ [% T5 L! D
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    1 n2 n: P: y/ @# E2 X/ W! q
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    + g8 m1 r& o' s% I
20.         $data = json_decode($buffer, true);
    4 ~# G  n8 o" _1 T- \: A, g
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    & P+ X8 M+ @/ R5 n$ ~: V) o
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    ) k! o# n7 H* U$ m0 N* l
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    3 @4 s  W  O8 z' Z0 p
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    ( U) g; ~# ^- B* B  B
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    ( i: ], p# a8 h+ _" J( t' S3 b. I
38.     {
    $ Y8 C" o/ J( _2 U
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    + E8 w" b+ @* u4 q* p
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    ; Z& a# k: K. L: Z& S9 B
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    & b5 @+ F; M8 g* I
45.        return;
    
46.     }
    1 t- h" S% {+ Z' Z1 y
47. };
    + u% O" Q/ m/ c5 R4 Q
48. 
    + A7 U* b' d7 o2 |3 E* T3 R* E
49. // 当有客户端连接断开时
    " r- k% a  a/ {( ~
50. $worker->onClose = function($connection)
    
51. {
    & O8 Z% h/ k" r6 @. i
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    0 A. m# D  W" V8 c# S! Y
55.         // 连接断开时删除映射
    ; C) @' h! K  x4 J
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    , W$ f( Y0 d2 F2 n* n0 |
58. };
    ( @. j& o3 j  F: n. n1 i1 p3 I
59. 
    1 B+ Q; _: U( p. f
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    $ \6 t; v: ]) ~% x
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    , l) y1 S& N2 q9 T" u5 Z; b
66.         $connection->send($message);
    
67.    }
    
68. }
    
69. 
    ! E4 U/ V# U' A' c  A$ n0 c
70. // 针对uid推送数据
    ( q5 S9 B, \0 ~, `
71. function sendMessageByUid($uid, $message)
    2 }* A" _3 w+ `  w# D9 o
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    2 a' U/ M, T  u9 Z0 `. U
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    0 f) Y9 L. \) A  a9 Z9 D
81. }
    / r+ {/ k+ M% B' K+ C1 h; I; q2 _  H
82. 
    
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   # R* [; L- c# ?3 q
2. ws.onopen = function(){
   
3.     var uid = 'uid1';
   8 _1 k) Y$ P$ }! P1 `1 ]7 X6 G
4.     ws.send(uid);
   ' R! Y; a' X% P1 i3 @% b
5. };
   & ^$ s1 M) W9 B1 N
6. ws.onmessage = function(e){
   ' T& f! r& v3 F8 \" Z3 Q3 @# R
7.     alert(e.data);
   
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协议需要在数据末尾加上换行符
   + ]; y  \$ T! ?% b7 z
6. fwrite($client, json_encode($data)."\n");
   % b/ _+ }1 m7 P1 M( s
7. // 读取推送结果
   9 o  |+ ?7 Z6 ]; g% P+ U9 O
8. echo fread($client, 8192);

复制代码

% x* n: F1 N# D( W. j2 b; H% W