用于实例化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;
   ( `, V$ k- g/ @3 j6 \6 e$ ?
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   . I: Y. F# T; ~; P6 U3 R
3. 
   ' s+ @! G& \' d# J+ t+ I
4. $worker = new Worker();
   
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   5 D$ q- H  h! N! ]
9. {
   
10.     /**
    
11.      * 4个进程启动的时候都创建2016端口的Worker
    ; f5 d8 Y7 U) k+ J
12.      * 当执行到worker->listen()时会报Address already in use错误
    : ^3 J; N5 D9 J6 D
13.      * 如果worker->count=1则不会报错
    % o& }/ a8 E& m+ O, K! T* j
14.      */
    - u# `( r% \" f# g/ }
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    $ ]* m  _: U8 E, ]9 v8 G& O
16.     $inner_worker->onMessage = 'on_message';
    ' a5 B) p! g( T7 `% d& t! k
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    ! K2 m$ C- J6 B
24. {
    % Z5 v3 k8 }9 f8 s% E& {9 L5 j7 q
25.     $connection->send("hello\n");
    
26. }
    
27. 
    
28. // 运行worker
    4 s" h# h9 X& m) |" U# c! C1 o, C" _
29. Worker::runAll();
    : Q6 v1 r! t' o0 z7 N; B
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    
32. use Workerman\Worker;
    - L2 I7 U6 g* ]" S4 J- Q
33. require_once './Workerman/Autoloader.php';
    * @- b* {6 J/ K5 \2 N' z6 @9 T
34. 
    / D" d$ g; ]. ~6 ~' a; c3 [  L
35. $worker = new Worker('text://0.0.0.0:2015');
    & v! O  O  n/ ?
36. // 4个进程
    - D5 F5 O& |1 B+ t( E% ^, n
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    . Z& R  @. W/ \: b! x3 F% \( o
39. $worker->onWorkerStart = function($worker)
    7 ?5 ~. Q" Q* [  T. [' {$ Z
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    3 Y( O( y! T2 u0 j& k. l, ^
43.     $inner_worker->reusePort = true;
    
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    
48. 
    9 m) |+ U- |( r
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    3 S6 C9 s6 s# ?: n  Z, t9 F& w
52. {
    2 C3 I5 ~* f4 }& F; y' D+ t
53.     $connection->send("hello\n");
    
54. }
    
55. 
    
56. // 运行worker
    0 ]# W) X' K5 ]- S+ C5 {. }
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';
   6 P( B0 C3 f# c/ ?, p1 |8 J
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   & Y, n8 ~$ H. `
7. /*
   0 ]1 [. ?# o* a* u
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    " v( U5 g: I- h/ f9 D, ]
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    
14. {
    9 Z/ e) ~# E( D# l# e8 E
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    / X& \% C3 B( e3 y! ?- W8 a3 e+ o" R
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    4 P: F9 @8 Q7 C7 H5 D; A% A
23.         $ret = sendMessageByUid($uid, $buffer);
    7 Q: T# B6 r0 X# n  ?! W
24.         // 返回推送结果
    & A6 k4 A6 g3 Z+ Q8 w, N! U3 Q
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
      a7 c  N; r  I
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    ( r: j/ W2 o3 _. m' |
31. $worker->uidConnections = array();
      q0 o  F3 K$ w# z% q) E
32. // 当有客户端发来消息时执行的回调函数
    0 A8 k7 o% d% |; t" Y
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    
38.     {
    " e: s9 E- p' c3 V7 @6 S! u. ^
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    - f; X  d. C+ Z, R: ?) t  i
40.        $connection->uid = $data;
    " ^& x4 A# Q, k7 P" r8 v
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    * `8 e7 O; L& @, T
42.         * 实现针对特定uid推送数据
    : b7 @6 W" |7 \3 S* v2 {6 L
43.         */
    , x. d3 x/ V- e( o( u
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    2 n1 @8 Z; v3 h" p* `& O3 C
46.     }
    ' Q. I7 Q5 w+ X2 O' \% k
47. };
    
48. 
    & H# A9 u9 a3 B3 p
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    $ N: W6 c5 l9 W+ Z
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    ( i! z# J# W1 \
56.         unset($worker->uidConnections[$connection->uid]);
    5 @. X2 ?  t3 x' A$ U! h9 ?
57.     }
    
58. };
    4 F, ?; V4 _9 |$ n: w
59. 
    
60. // 向所有验证的用户推送数据
      g1 S, N/ c. `5 X) E1 r
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    / A0 N3 p/ ?" F4 V3 P8 v& F
65.    {
    
66.         $connection->send($message);
    : w8 d' E" {% j% I; c
67.    }
    
68. }
    
69. 
    ' B$ Q) k5 M. H8 j3 t
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    7 F/ `* z. }2 j1 U2 k2 f
72. {
    2 Z$ T# @( [. p
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    ! w1 E+ [0 M# p; ?
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    7 x* C5 S" j, J  J
77.         $connection->send($message);
    
78.         return true;
    9 V0 J9 r. N  |7 n! N3 L; D
79.     }
    
80.     return false;
    
81. }
    
82. 
    8 {: Y6 t/ a- [  D/ ~; p  `7 S, i
83. // 运行所有的worker
    
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   7 ^# p$ Z0 b9 V7 n
2. ws.onopen = function(){
   ( @2 P5 f" X7 h2 Z! u- [2 }
3.     var uid = 'uid1';
   9 l/ |+ O  f7 l8 W  r- @6 k
4.     ws.send(uid);
   
5. };
   7 ^" r/ t+ ^. ~
6. ws.onmessage = function(e){
   ; D) b0 H0 }  m* @
7.     alert(e.data);
   
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   1 e8 m+ Z. l& {, |6 B6 _& w1 a
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协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   0 |0 {, \  }9 W9 [
8. echo fread($client, 8192);

复制代码