用于实例化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';
   
3. 
   
4. $worker = new Worker();
   
5. // 4个进程
   , _0 [5 d4 t; g. D- C
6. $worker->count = 4;
   ) D( \$ \, w) F: B# p
7. // 每个进程启动后在当前进程新增一个Worker监听
   ) w) a! s  G5 E; @" D# N
8. $worker->onWorkerStart = function($worker)
   
9. {
   / e6 N8 m/ E0 W$ W9 x; v: M
10.     /**
    * H, y+ \" w) e" L* h+ T, q. t
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
      s- z9 E# q5 }
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    4 E( d/ z( U7 B
16.     $inner_worker->onMessage = 'on_message';
    ; Z* ^  I3 b2 ~9 ^
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    / o6 F8 ]  a' q6 y! d3 q
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    5 ^4 [8 t/ e" A/ d- m9 n( y5 ^
22. 
    
23. function on_message($connection, $data)
    7 f; J( I! a; [7 a# `
24. {
    7 v0 m, U$ ^* m  w* j
25.     $connection->send("hello\n");
    # O4 S8 D; A- a! A
26. }
    + d+ C- P. o& f0 f
27. 
    
28. // 运行worker
    - T# P$ u- E4 h; |* s  y
29. Worker::runAll();
    ( m, J( l3 d. G" d$ V
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    & V4 r3 G1 F5 V# \6 e
32. use Workerman\Worker;
    + t/ C" u2 D. r# R7 k$ I" Q
33. require_once './Workerman/Autoloader.php';
    + X' y( e$ Q- U
34. 
    3 Z% ]" ]4 ]+ U1 i+ S/ u6 M
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    / \0 e( G) [; W. }. [
38. // 每个进程启动后在当前进程新增一个Worker监听
    # m% p" r. k& }0 }6 o
39. $worker->onWorkerStart = function($worker)
    
40. {
    7 O. e3 _% r, t1 Z& j' T0 }
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    7 n- j, w" g9 `3 t# q' E
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    / v8 X! e$ l/ ~: H- C7 L6 y* O
43.     $inner_worker->reusePort = true;
      d: t2 ^8 w4 J7 S; N) K
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    3 l: \# @5 ?/ N* e0 ?" n0 U  _& I
48. 
    
49. $worker->onMessage = 'on_message';
    6 s9 d" m6 I8 m2 T8 [' j# B
50. 
    
51. function on_message($connection, $data)
    
52. {
    # c: K, _) x1 E# ?
53.     $connection->send("hello\n");
    7 d8 {/ t/ `- i! ~, b. j& _$ 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;
   4 b! a7 E* l/ e
3. require_once './Workerman/Autoloader.php';
   : s/ }% G% b/ A2 L" X/ [( E
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    - H6 R9 o5 B  e  @8 y% v* s  g
11. $worker->count = 1;
    6 A+ @. ?) l6 G" m- q0 b' }& h" P
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    8 J$ e$ |* Q& H. I) a* N. b1 V
13. $worker->onWorkerStart = function($worker)
    # B* p) g/ P! e, {5 o# R" ]9 p# N
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    " [0 y6 \. q# f9 f
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    ' j- _2 Z. |. x6 G  }4 m, I9 e
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    $ _4 y4 K( u% \
20.         $data = json_decode($buffer, true);
    
21.         $uid = $data['uid'];
    " b7 `  k  v7 m4 s
22.         // 通过workerman，向uid的页面推送数据
    
23.         $ret = sendMessageByUid($uid, $buffer);
    
24.         // 返回推送结果
    
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    ) B( C( w7 Y; y/ Z% H6 c6 e
29. };
    . {+ w: P4 V% w* J- E$ F% V+ ?
30. // 新增加一个属性，用来保存uid到connection的映射
      u- t! z% p" n' H' t8 _% s$ y
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    
35.     global $worker;
    $ @; R  \9 A7 K- m& N
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    : l  S! \; i" j: Q* z
37.     if(!isset($connection->uid))
    
38.     {
    
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    * W* w: J2 S' d+ Y, {0 j
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
      M3 ^1 b4 T, x  a7 q* }, y! y* h* F
45.        return;
    $ u) d' C6 O' w+ G3 G
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    
50. $worker->onClose = function($connection)
    
51. {
    
52.     global $worker;
    4 b9 D# a9 k% b$ x8 ^$ ?) h
53.     if(isset($connection->uid))
    
54.     {
    4 Q; |5 `: M0 Q
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    5 n: J( i& @2 o) o8 c0 U& `9 t' X9 `
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    
66.         $connection->send($message);
    
67.    }
    
68. }
    ) G. a+ j1 V; a$ ^9 U! F2 N
69. 
    1 n$ |! g) V: Q' w: K
70. // 针对uid推送数据
    6 J& T' p7 j/ j
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    : S! \& v0 w; v- K$ G$ W8 o
75.     {
    ) Z% ^& T- W( Y
76.         $connection = $worker->uidConnections[$uid];
    % l. {1 P' y: Q7 Z$ O! f, h
77.         $connection->send($message);
    $ k! j9 r  i# C- ]" }
78.         return true;
    
79.     }
    
80.     return false;
    
81. }
    " C1 L4 |7 N& \" m" A
82. 
    / e! ^2 r% h6 b. K
83. // 运行所有的worker
    , \5 i, e- `  _2 {, O' f
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';
   2 Q4 U- G8 y+ N! A, L6 j/ c
4.     ws.send(uid);
   " s. n* U/ a# j& g2 U! N& a
5. };
   
6. ws.onmessage = function(e){
   " p% f# S- l8 n0 j# ^& [( A$ G
7.     alert(e.data);
   0 Y0 F6 p" s% S1 G3 R+ q2 t
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   # r( q: {' o  f7 Q. s1 Z+ P+ [
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协议需要在数据末尾加上换行符
   + `$ E% u* e  z1 J- e# z8 ^3 v6 w
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   
8. echo fread($client, 8192);

复制代码

3 y4 l( |) _- k! A( V
4 g5 ^9 \8 @. t