用于实例化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;
   3 L- e+ t) j# N5 f9 j
2. require_once __DIR__ . '/Workerman/Autoloader.php';
   6 p0 H8 k9 O4 o
3. 
   
4. $worker = new Worker();
   * q9 l5 V: l1 M! Y
5. // 4个进程
   : ^# j, Q! ^6 o7 O, J
6. $worker->count = 4;
   % ^) u4 C1 N7 u
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   
9. {
   
10.     /**
    ! h: I9 y' C2 ^, t: U% t
11.      * 4个进程启动的时候都创建2016端口的Worker
    
12.      * 当执行到worker->listen()时会报Address already in use错误
    
13.      * 如果worker->count=1则不会报错
    
14.      */
    
15.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
16.     $inner_worker->onMessage = 'on_message';
    ! }' [9 t0 o$ N. h
17.     // 执行监听。这里会报Address already in use错误
    
18.     $inner_worker->listen();
    
19. };
    
20. 
    - q! x% Y7 G, F0 f2 ~' c
21. $worker->onMessage = 'on_message';
    
22. 
    ! [% O: y6 c) |
23. function on_message($connection, $data)
    5 a2 ^  t9 K9 g- U% ~
24. {
    
25.     $connection->send("hello\n");
    
26. }
    
27. 
    $ }0 B; k0 n4 k% ^' p5 e( b
28. // 运行worker
    
29. Worker::runAll();
    + H3 f1 o( D: b! c! H0 ^
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    $ d/ g* H% ]  i4 k& W5 p' E. G
31. 
    * Z( p0 a( q6 M& P+ i! ]
32. use Workerman\Worker;
    1 h' s0 U7 Z2 ^8 }$ z6 N+ D
33. require_once './Workerman/Autoloader.php';
    
34. 
    
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    - z) q. k, l+ V+ r! I
40. {
    ( [: D: v# V4 |- [. P0 `  I# T5 g
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    
43.     $inner_worker->reusePort = true;
    ) k, S9 K' k; }9 O& E9 t5 C% J3 x
44.     $inner_worker->onMessage = 'on_message';
    7 R4 ^5 E1 g& V! Z% s6 @
45.     // 执行监听。正常监听不会报错
    + O. R1 o+ V/ O# X1 g; ]* H
46.     $inner_worker->listen();
    
47. };
    8 ~+ W# E4 b  k. g0 Z
48. 
    1 F3 p; v& E2 b9 [
49. $worker->onMessage = 'on_message';
      a9 \/ n  V$ E1 O' J- |
50. 
    
51. function on_message($connection, $data)
    
52. {
    : I& E2 T/ H' D% |/ H- \
53.     $connection->send("hello\n");
    . W' h6 n+ {! }- [; J; F
54. }
    8 H" r1 u8 b% _- {4 c
55. 
    
56. // 运行worker
    ; E( [) T1 U( c. u$ \# K: I
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;
   " \) P$ U9 o" U2 x, {
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   ; x% P7 j3 Z- S" ?+ z# J6 U, Q5 V
5. $worker = new Worker('websocket://0.0.0.0:1234');
   3 \( y6 I/ N, f1 r& d, S
6. 
   
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   ' J/ D1 r* Q- G( ]. U
10. */
    7 H1 J# U& R* {2 ~5 n  H
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    8 I" Q1 F( S, {. Y
13. $worker->onWorkerStart = function($worker)
    
14. {
    * @/ d- l/ a8 U) D$ ]7 S
15.     // 开启一个内部端口，方便内部系统推送数据，Text协议格式 文本+换行符
    
16.     $inner_text_worker = new Worker('text://0.0.0.0:5678');
    
17.     $inner_text_worker->onMessage = function($connection, $buffer)
    
18.     {
    
19.         // $data数组格式，里面有uid，表示向那个uid的页面推送数据
    . k: i0 ?! ^  b6 k
20.         $data = json_decode($buffer, true);
    % i% `/ T* }* T, s5 s- q6 x
21.         $uid = $data['uid'];
    ; Y) ?5 C1 t  ]+ g& n" d
22.         // 通过workerman，向uid的页面推送数据
    3 m2 `7 G1 [8 l2 Y: _
23.         $ret = sendMessageByUid($uid, $buffer);
    - x+ \  E0 p) T2 J' s  W. s& l7 ~' A6 A% W
24.         // 返回推送结果
    , C4 q. ]3 H! v/ E! s, Q
25.         $connection->send($ret ? 'ok' : 'fail');
    # i# ^: \# o- G5 n! H
26.     };
    7 x- H/ y# x  v# d
27.     // ## 执行监听 ##
    + w" E) \) U" A0 n5 K" x) B& g
28.     $inner_text_worker->listen();
    
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    
34. {
    ' N! z  ~) N; g: a& ^$ R
35.     global $worker;
    0 h% @: O1 W! R$ X# L9 T  R
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    * |/ A0 d  L6 D% A0 R! v2 J
37.     if(!isset($connection->uid))
    
38.     {
    , p; k% G6 _1 ?( J  f: n0 e
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    - E: G; J6 [0 U8 Y5 N6 S$ j% c
40.        $connection->uid = $data;
    7 T+ l* u0 y, P+ D
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    
42.         * 实现针对特定uid推送数据
    
43.         */
    
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    
46.     }
    
47. };
    
48. 
    / O0 S2 i: {2 n- V
49. // 当有客户端连接断开时
    % e5 I7 t( ]6 K6 @( j" H) N
50. $worker->onClose = function($connection)
    
51. {
    - Z! B9 ]+ {. [% {4 Z* F
52.     global $worker;
    * Q+ k3 k6 K9 C1 t6 v/ Z: f4 u
53.     if(isset($connection->uid))
    
54.     {
    8 W8 J' `1 _- o% W6 ^
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    
57.     }
    
58. };
    
59. 
    ( `6 p" Y( Z7 J- m( g$ |! q
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    7 S+ R; H1 m) X! w
62. {
    : O6 {* p) K  u# e5 r$ h8 @
63.    global $worker;
    ) h! Y+ I. V8 {5 M! m
64.    foreach($worker->uidConnections as $connection)
    ' B/ K% J" G4 u# Q  g- S( J* \# p9 e
65.    {
    & C' w0 y8 T+ U; \9 u3 R# @- F
66.         $connection->send($message);
    5 I. i7 L7 J0 K  D
67.    }
    8 I! i8 z& x# L9 b5 x
68. }
    5 Y' ?% ]& i8 p- b' ?2 k  J8 N
69. 
    . o' W3 F1 x; T4 Z9 P
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    
72. {
    
73.     global $worker;
    " t( h  d! V" s
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    
76.         $connection = $worker->uidConnections[$uid];
    ) ?3 \2 Y; o& `0 {$ B- I5 Z
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    ( q0 K& s; ^4 u9 T# D
80.     return false;
    
81. }
    " m* S) v8 z$ |/ t
82. 
    
83. // 运行所有的worker
    , d# o1 L, c  O9 D7 C0 t( W; r% D
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   
2. ws.onopen = function(){
   2 q, s% W9 X8 \/ w! t% G; L( \
3.     var uid = 'uid1';
   
4.     ws.send(uid);
   
5. };
   / e) F1 y6 ?' n# |1 _4 C' w
6. ws.onmessage = function(e){
   9 w- j  j& f2 p2 L# {. h& V* V2 a* `
7.     alert(e.data);
   # ~0 A8 r6 L$ M, b3 h  C( c6 r
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   6 _1 {1 c- g4 M0 P3 i
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   9 r% h1 O" b' i! E+ w
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   
7. // 读取推送结果
   4 n1 q+ H- m$ W2 ~
8. echo fread($client, 8192);

复制代码