用于实例化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';
   ) V6 K9 Z# Z, r, G9 \  ~$ O0 u6 \4 R
3. 
   8 I3 F4 b! w; L$ Q/ o3 o3 M: h
4. $worker = new Worker();
   
5. // 4个进程
   # S# X, z9 u, @; I+ }! u
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   6 f0 I  ^  Z# [# s$ P4 ^
10.     /**
    $ H% K  v$ a5 e8 W! `" |
11.      * 4个进程启动的时候都创建2016端口的Worker
    - \' g* a  m8 D5 R* \+ I* Q
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    " ]. J1 p& C3 X) T: P; Z1 d1 H
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    : q( W7 r5 ?9 ^" @
16.     $inner_worker->onMessage = 'on_message';
    % j# M" V4 D) F" ]2 ^5 U& O
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    1 C; s* z4 H: O' G6 U/ r" l
20. 
    
21. $worker->onMessage = 'on_message';
    
22. 
    
23. function on_message($connection, $data)
    8 o! s4 W1 R8 F4 R' o6 l! {2 t+ z
24. {
    * A1 X# ]5 Q7 A4 p+ N
25.     $connection->send("hello\n");
    5 z1 f1 m, N- _3 @# p, \. h
26. }
    # ^0 l- v) b/ x( @3 f
27. 
    + V( R% y6 d$ ^) V" `
28. // 运行worker
    
29. Worker::runAll();
    
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    
31. 
    , g  M" t4 G0 C) K
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    % A" J( z9 O# g/ L& u$ A$ t
34. 
    ( {4 e2 R( K% w; n* I; T, E1 e
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    # A4 @1 u3 S3 q1 E$ G
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    # t( ?; E0 o! y9 D, S( T" S% k
40. {
    ' x# Y- w' Z% v
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    ' {* ~( j; i( A. w' Z
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    ( U9 E. j+ _9 ~+ h
44.     $inner_worker->onMessage = 'on_message';
    - I( y/ G& D6 ]/ W9 V; c
45.     // 执行监听。正常监听不会报错
    
46.     $inner_worker->listen();
    
47. };
    & V* }' ~* Z/ \& l
48. 
    2 I' h! s, d3 {( S- ^6 M+ v: ~
49. $worker->onMessage = 'on_message';
    4 H" B; I: v) f5 b+ w
50. 
    
51. function on_message($connection, $data)
    
52. {
    
53.     $connection->send("hello\n");
    
54. }
    
55. 
    4 z0 G9 q5 D/ g  M0 K; g
56. // 运行worker
    / ^2 \, w: W2 n% n& q4 g
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
   , R3 d, Z, F8 G+ Y5 |1 z# z# w
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. /*
   6 s5 R6 l' A% R' l* e3 b6 T: g
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   . S; g' T4 m9 S1 p  X
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    ) }1 @, ?' n$ i
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    3 D+ T( I- h; {+ g% y  ~
14. {
    
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
      R1 L5 i' {8 T& ?0 {
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    ( \+ R+ j) W1 J- }4 _
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    4 k0 ?9 n  H, p$ [# }
18.     {
    , O) f- Y9 `+ ]; a7 x% i- V
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    9 x' U7 I5 s' P: j: P! p! |
20.         $data = json_decode($buffer, true);
    - r' [. h/ E, \9 f4 |
21.         $uid = $data['uid'];
    4 c4 E+ |- g+ |* @* V
22.         // 通过workerman，向uid的页面推送数据
    3 x6 [( o% M; k2 {
23.         $ret = sendMessageByUid($uid, $buffer);
    ) ?2 f, u& [1 i- D: i( h- f
24.         // 返回推送结果
    1 X1 E- r" N/ z+ ~& |
25.         $connection->send($ret ? 'ok' : 'fail');
    : w3 N1 q) B5 [- U& z$ q& o
26.     };
    % r3 [( q5 B) c" o/ g+ `
27.     // ## 执行监听 ##
    
28.     $inner_text_worker->listen();
    % n3 C" x: U, d, v2 k4 J6 t( O! `1 B2 i
29. };
    . S2 j9 J& D/ `& ?4 b6 {, j% O
30. // 新增加一个属性，用来保存uid到connection的映射
    7 F( J& L5 x" A$ }
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    " l- D1 v: Q5 b# }& f" I4 B) }. ?0 m
34. {
    % C; t: f( V/ n0 H3 B! E
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    . y1 e+ i# B- a. u( u2 ^& p
38.     {
    . \% q5 K( X, m  ^6 j, s3 q
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    3 q2 N. f2 ^7 ^4 Q: r3 U3 Q3 }
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    / t6 S2 d, f  r5 ^6 V
42.         * 实现针对特定uid推送数据
    " y# x1 {. F7 ~/ E9 G9 ~+ T
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    - O9 p( g7 F! H, {0 n7 @/ F
45.        return;
    
46.     }
    
47. };
    
48. 
    
49. // 当有客户端连接断开时
    ( ^7 I9 Z, S5 D) y
50. $worker->onClose = function($connection)
    
51. {
    1 \( ?. ^, m0 w& W7 m( ^
52.     global $worker;
    
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    6 `1 ~, {% l) Q/ q0 i3 }
57.     }
      e+ m  u; a  F* A% G9 Y
58. };
    
59. 
    
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    , j" O  z& u9 c, X  \! L# i8 e4 L
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    ) I2 d  A5 N3 G  Z
65.    {
    ( ^( A, n9 E- T& z
66.         $connection->send($message);
    & r$ n% w8 H9 t: \
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    
77.         $connection->send($message);
    & _5 Q' \3 X. o& k5 K
78.         return true;
    
79.     }
    6 k; Q0 _" f' ~
80.     return false;
    
81. }
    - G1 H5 y( N) o2 A
82. 
    1 S  P% b) [6 U
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(){
   ; R5 c) a! w. s, Q9 u" d/ J
3.     var uid = 'uid1';
   4 O" o* d. S5 s, e4 d* X
4.     ws.send(uid);
   
5. };
   ; n5 L. U' T% p$ A- {# z
6. ws.onmessage = function(e){
   ! d$ i& y) I, b- _$ F# B" Y6 k* ~
7.     alert(e.data);
   9 ^* G& a( e! ]; m  U5 H1 ]
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   9 D1 p& R! I6 f1 H7 G8 E
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   ( m* p$ j& J6 ~9 W9 j
6. fwrite($client, json_encode($data)."\n");
   / v3 m" o- L& a0 E" O
7. // 读取推送结果
   : A1 \" l  c& N2 n1 L7 Y8 p0 ~, E
8. echo fread($client, 8192);

复制代码

; k$ F- L. {& W# ^0 T