用于实例化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;
   * ^, x; f, I4 C  _  s% G6 K9 m
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   . A% p7 w! W2 ]1 D
9. {
   
10.     /**
    % x! O' q; b5 F. M( P) u/ O
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    & M; ?0 _. D% u! b4 g. g
13.      * 如果worker->count=1则不会报错
    & j6 B! L6 P( r7 }
14.      */
    / m6 {# z) D3 Y' W6 S2 j
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();
    ! o0 S" i3 V, {/ c9 t; D  ]
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    
24. {
    
25.     $connection->send("hello\n");
    ' ^; {. v( x2 m7 V' w8 E% o
26. }
    
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    7 A- |  k- D) x* N. V
34. 
    # N% ?; f% d# m" ]" }6 ^
35. $worker = new Worker('text://0.0.0.0:2015');
    ! i) q) E" ~6 X3 J# S
36. // 4个进程
    + W- E- O( K! }" U: v8 |- C8 E
37. $worker->count = 4;
    . D/ m- B' H! P' \8 b6 S1 ~) Q5 @
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    1 `3 y9 l+ K  N9 n
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    6 r. F4 O1 d) w2 o
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    # ^) |' P5 z; `& S, [4 e4 c
48. 
    $ D5 @- Y+ U% N; i; w: g  U
49. $worker->onMessage = 'on_message';
    : }8 U1 e! m. [$ `4 }
50. 
    
51. function on_message($connection, $data)
    
52. {
    ( ?3 K  U" n( n4 o% Z/ g7 C
53.     $connection->send("hello\n");
    4 Z8 l. Q6 @; Y+ v$ H% a
54. }
    
55. 
    ( a% k2 k/ s0 Z7 N
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
   + J' C# H, e7 [$ u8 Z9 c
2. use Workerman\Worker;
   
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   7 W* o$ }3 ~3 L8 }4 g! j# k
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   - ?: K" H% e  x9 w
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    & y5 c6 r% S5 n( E
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    / M1 ?* t8 l7 t0 d% p9 }* P
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    ; a1 T7 L7 K' m3 O! k
18.     {
    # x6 Q' I, ?: ~8 u+ H5 k
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    2 q7 E5 b" @" I* y, w5 `* @2 m
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    , Q* _- v, V3 _5 k* e3 }# Y
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    
29. };
    1 m# k; T9 }. ^6 @, F8 |
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    1 q6 T3 D# |  j* X6 H
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    # C( X4 [: n* ~. C" i, \* o/ `
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    7 ]. F6 P! f* r" r) r+ N
37.     if(!isset($connection->uid))
    
38.     {
    5 C9 H% t4 g- f% s+ Z
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    + Q% X: T# J: M
43.         */
    - H$ a1 u; I, ~& x( }: \: h) k
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    1 y8 X* ~. M. }
47. };
    
48. 
    . E" B7 _7 @; i
49. // 当有客户端连接断开时
    * ]) ^' p1 q+ _
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    ! E; [3 g* ?. H9 x
55.         // 连接断开时删除映射
    " u2 G+ X' O: t% Z9 u6 z+ c
56.         unset($worker->uidConnections[$connection->uid]);
    0 S5 M6 m6 O5 R5 k7 A
57.     }
    , Y+ f; u& D3 K8 k: ^' j
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    3 |- V- t/ R- b9 b# \2 C0 `) p) ^
62. {
    + {) X1 h8 l* l+ N3 G+ c
63.    global $worker;
    " j$ B4 {, n3 z
64.    foreach($worker->uidConnections as $connection)
    
65.    {
      t0 H$ `. l6 J3 F+ P* }  c
66.         $connection->send($message);
    ! s: L3 n. a" D
67.    }
    
68. }
    - M& I) f8 k" r) x7 ?- o
69. 
    & r: a8 {+ x- |
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    6 d( U( c$ ]# a: F' E
73.     global $worker;
    , S4 ~9 n( D4 ^( v* o
74.     if(isset($worker->uidConnections[$uid]))
    1 \+ l% c! U# n8 f
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    
81. }
    ! |( o  `- ]. H; p, |
82. 
    
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   * k; e8 O! ~  l3 {) \$ l  i$ [
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   0 P6 k2 \( d8 H/ Q+ ~1 s$ K
5. };
   
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   9 f! }3 y  X9 o* u! }0 j+ ^6 }
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   # s2 @9 P' n# ]
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   7 K/ v9 r  d) T) N  F3 V+ q% c8 Y/ w
8. echo fread($client, 8192);

复制代码

8 i5 D* \2 J' [9 `
% Y0 e' e9 [& B3 F  v