用于实例化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';
   / Q+ h' q  C' X4 Y7 m/ r
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   ! O" C) A  ]# O% L4 [
7. // 每个进程启动后在当前进程新增一个Worker监听
   ; X) j9 }6 m- ^
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    . K- {6 Y+ M) G" U
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    / X/ Q* s- g9 o! f) {3 [9 c
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    2 X( o( n8 l: \( W2 Y1 l
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    / f5 v# P6 F+ u1 U; r8 E# B
19. };
    
20. 
    ; y5 s( n4 M' Y8 Q
21. $worker->onMessage = 'on_message';
    + z. T8 g# m- S0 T7 z
22. 
    - ?1 w2 A3 Z' ]6 z& [) N
23. function on_message($connection, $data)
    
24. {
    " M; g* B; K7 q' l: N
25.     $connection->send("hello\n");
    - M6 R- L7 h2 Z9 ]# c
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    5 q( T" ?8 ~9 M3 R1 J0 ^
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    3 z. O/ o4 d5 O; `, P" b0 R- J
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    
34. 
    ) `3 Q: {! ]0 f
35. $worker = new Worker('text://0.0.0.0:2015');
    ! s# i2 i0 `6 X0 ^( _* m0 q, p: k
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    + K! s9 J" s, Q3 E
46.     $inner_worker->listen();
    0 Y2 E/ z5 S0 o/ l& [
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    % @; [' F& r# S$ X5 T1 l
50. 
    # d4 f3 A; k8 d% L( b
51. function on_message($connection, $data)
    * V2 S6 T  \! L( M
52. {
    
53.     $connection->send("hello\n");
    , c0 e; M3 W' q  C4 W& z' `: ~
54. }
    2 Z0 @" i8 D: a9 g& S0 H9 ]
55. 
    6 r3 O* E: r0 Y. ]4 C; C6 s) F
56. // 运行worker
    % B& k- C3 r0 S! d! z- K9 j, k
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端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   : w6 F% x8 G( i
7. /*
   " \, n0 N/ ^( k9 P+ ]
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   9 e3 f7 A1 }# H" y  Z7 b0 T. ?9 S4 d0 H
10. */
    * w6 `; g/ i1 V+ d2 i" {
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    ; p7 v& I- m- ]0 i) H2 O
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    2 @) z! ~, [. p# M, W* X
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    9 Z4 n5 e; u$ F$ Q2 N7 I
18.     {
    5 `2 r' o/ A# |4 B8 J4 j  n
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    , N- _( _5 x/ f6 g, F0 L1 T! q
23.         $ret = sendMessageByUid($uid, $buffer);
    ) E; `; B5 u7 H- @  E
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    " Q' m2 I4 a1 H' ^: J! t/ m
26.     };
    
27.     // ## 执行监听 ##
    $ M( h5 ^0 L& [* }' K; B5 |1 I
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    ( J" z6 @/ b% m& U
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    ) A3 l: M5 F: {2 G  h: K
34. {
    : d( m0 q; @7 \2 @& \
35.     global $worker;
    4 T9 u2 }. @( |+ Z: m4 M
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    " W% n& @% K3 d7 c7 \5 Q0 M
37.     if(!isset($connection->uid))
    
38.     {
    6 V( @; p+ p! @( y
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    9 \" Q: D/ C2 B6 a0 j
40.        $connection->uid = $data;
    9 M" y  u7 J/ ~# Q
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    ' Z) F4 V* ^/ K
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
      r( g7 D2 k8 x5 E# z- r& }3 d
46.     }
    
47. };
    6 U7 X0 i/ C* k( ]
48. 
    * b$ x* }. S$ r& j1 ]) U6 f
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    ' [0 v% n  I; L$ i8 S; O
54.     {
    
55.         // 连接断开时删除映射
    + O3 y$ F, p9 O+ L: l2 Y
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    & D/ S; w4 E9 c8 |: F
58. };
    
59. 
    ; T0 _- U# ^/ N. `0 l8 ?$ w8 A
60. // 向所有验证的用户推送数据
    7 K: D( c7 }% a$ F" O! t, }
61. function broadcast($message)
    - Y2 A  l0 b9 h4 n2 H
62. {
    + M7 W/ y3 @) K3 g' J+ ]
63.    global $worker;
    6 f% d+ T+ m$ u4 V7 F6 K& C3 F8 E
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    1 o* B4 o% v3 k2 _5 _$ @% s
66.         $connection->send($message);
    
67.    }
    4 S) J2 Q1 {) I9 X! E1 d
68. }
    ) e! i% F$ q' Q
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    3 Z4 q5 E( @' F  Y. Z
72. {
    
73.     global $worker;
    ( b. _- d4 f  {
74.     if(isset($worker->uidConnections[$uid]))
    % N# h: T& A1 E  t
75.     {
    & k1 Q7 c: p; d; h9 [% `
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    . O6 ?/ T6 D7 S
81. }
    7 v* ?/ g7 w6 t# d4 M" F% G- t7 r
82. 
    
83. // 运行所有的worker
    " e8 h8 G5 l9 v% U) ]8 i
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   % f6 a& R# G3 B: ^
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   . y6 n3 B! h; n
5. };
   2 H. l' }, U1 E) Y: ]5 g
6. ws.onmessage = function(e){
   / F8 A2 h$ j$ K# K9 `
7.     alert(e.data);
   * [( k0 a) S3 z6 _9 n1 K8 r% F4 R
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   1 J$ e: |# z; Y4 L
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协议需要在数据末尾加上换行符
   . w- J( J7 b5 G& }$ f
6. fwrite($client, json_encode($data)."\n");
   - g3 @: K1 T, e4 T% E
7. // 读取推送结果
   ' U0 X5 L2 R5 m( p7 }
8. echo fread($client, 8192);

复制代码