用于实例化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. 
   0 ]( z+ d$ d/ D# m0 @
4. $worker = new Worker();
   , N+ L9 W% r8 j
5. // 4个进程
   
6. $worker->count = 4;
   
7. // 每个进程启动后在当前进程新增一个Worker监听
   
8. $worker->onWorkerStart = function($worker)
   7 R" D6 N' |% `7 E' G+ g
9. {
   
10.     /**
    & r/ h5 b' w; c0 `/ k0 u0 c- d3 A
11.      * 4个进程启动的时候都创建2016端口的Worker
    - ?6 d8 ]6 ~$ T! r" h
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';
    1 P) F8 k5 p8 X/ s
17.     // 执行监听。这里会报Address already in use错误
    " L( K/ q# e8 `& Q; b
18.     $inner_worker->listen();
    
19. };
    
20. 
    
21. $worker->onMessage = 'on_message';
    , X: m! |7 f( f( T! z* \
22. 
    
23. function on_message($connection, $data)
    4 Z4 @" J6 g' L% C5 e/ n" T
24. {
    
25.     $connection->send("hello\n");
    
26. }
    6 O( U: i) ]' B- ~- ]
27. 
    
28. // 运行worker
    
29. Worker::runAll();
    : `7 ?/ O! A: z& H
30. 如果您的PHP版本>=7.0，可以设置Worker->reusePort=true， 这样可以做到多个子进程创建相同端口的Worker。见下面的例子：
    ; z) s/ e. ?( k: p* C
31. 
    , B" J4 K- {* q! f% r
32. use Workerman\Worker;
    
33. require_once './Workerman/Autoloader.php';
    : ], `' `! t# e$ I3 \- {6 R" {  L7 g
34. 
    ( \& f' H0 w2 M
35. $worker = new Worker('text://0.0.0.0:2015');
    
36. // 4个进程
    
37. $worker->count = 4;
    $ X4 P2 v% }* V9 R: i8 ]2 r
38. // 每个进程启动后在当前进程新增一个Worker监听
    
39. $worker->onWorkerStart = function($worker)
    
40. {
    
41.     $inner_worker = new Worker('http://0.0.0.0:2016');
    1 U7 _9 N2 {, u* T$ X, q, K( z) c
42.     // 设置端口复用，可以创建监听相同端口的Worker（需要PHP>=7.0）
    , L0 F% [! b( N! e# ]
43.     $inner_worker->reusePort = true;
    / C2 B& D/ ~& M
44.     $inner_worker->onMessage = 'on_message';
    
45.     // 执行监听。正常监听不会报错
    9 S. U! S: E' }
46.     $inner_worker->listen();
    # ?$ B2 O! d; D  `0 `! E- a
47. };
    
48. 
    
49. $worker->onMessage = 'on_message';
    
50. 
    
51. function on_message($connection, $data)
    2 q/ N* \* x& b+ k
52. {
    4 D; m) D% i. L+ e
53.     $connection->send("hello\n");
    7 S, {4 w# y& C; o
54. }
    1 q- y6 U9 U% K0 e- [
55. 
    * ~% p9 |6 c' U) r3 e
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;
   & H$ l* u* d0 S% L2 d3 v: g7 U
3. require_once './Workerman/Autoloader.php';
   
4. // 初始化一个worker容器，监听1234端口
   
5. $worker = new Worker('websocket://0.0.0.0:1234');
   ; C" }8 C% c. v2 b
6. 
   ' U$ `" V2 _6 n# I6 D; \
7. /*
   
8. * 注意这里进程数必须设置为1，否则会报端口占用错误
   
9. * (php 7可以设置进程数大于1，前提是$inner_text_worker->reusePort=true)
   
10. */
    
11. $worker->count = 1;
    
12. // worker进程启动后创建一个text Worker以便打开一个内部通讯端口
    
13. $worker->onWorkerStart = function($worker)
    # q- C7 Z# @4 U% p+ z
14. {
    
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的页面推送数据
    
20.         $data = json_decode($buffer, true);
    $ B+ U: {$ `9 H5 e- l
21.         $uid = $data['uid'];
    
22.         // 通过workerman，向uid的页面推送数据
    5 K6 ?4 F, z/ C( N% _* h
23.         $ret = sendMessageByUid($uid, $buffer);
    7 _* H/ X4 l: J) ^/ y
24.         // 返回推送结果
    ) N( F& @$ U: X8 k" l
25.         $connection->send($ret ? 'ok' : 'fail');
    
26.     };
    ' P, h2 [6 a) K" d
27.     // ## 执行监听 ##
    9 N; j* C* {! {' J
28.     $inner_text_worker->listen();
    4 `$ X) R; A: I5 Q; a, l
29. };
    
30. // 新增加一个属性，用来保存uid到connection的映射
    
31. $worker->uidConnections = array();
    ( |% R; Q( c4 m( R, \7 q3 ?; F6 z0 a
32. // 当有客户端发来消息时执行的回调函数
    
33. $worker->onMessage = function($connection, $data)
    . t" L7 s6 x4 s! a4 e( h5 L
34. {
    1 M% ~8 B/ X9 a! Q) ~6 Y8 H4 P
35.     global $worker;
    
36.     // 判断当前客户端是否已经验证,既是否设置了uid
    
37.     if(!isset($connection->uid))
    0 U; j. B% Y7 x* Y0 F; X1 ^* T
38.     {
    , Q; C, x. n9 ]# U) H
39.        // 没验证的话把第一个包当做uid（这里为了方便演示，没做真正的验证）
    
40.        $connection->uid = $data;
    
41.        /* 保存uid到connection的映射，这样可以方便的通过uid查找connection，
    9 c* Q: R0 [$ D$ {$ w
42.         * 实现针对特定uid推送数据
    $ c/ N! j8 l+ J7 E' b
43.         */
    / k1 b- _! G/ u( U; V/ e  k2 f
44.        $worker->uidConnections[$connection->uid] = $connection;
    
45.        return;
    ! Y% M$ w# B1 T+ p
46.     }
    
47. };
    
48. 
    1 m* C7 K0 |5 t! [# a" E4 I, N3 }5 e
49. // 当有客户端连接断开时
    ( l2 b& O& `' c9 L$ N3 \/ H
50. $worker->onClose = function($connection)
    / ^) [( J) d" K: e( X
51. {
    
52.     global $worker;
    $ p4 w6 p/ g, l& X  _/ d
53.     if(isset($connection->uid))
    
54.     {
    
55.         // 连接断开时删除映射
    
56.         unset($worker->uidConnections[$connection->uid]);
    , P& [. Z) a# }$ j1 W- z/ L
57.     }
    5 d/ ^4 x$ a$ b% i, Q
58. };
    ! O1 H( l0 f; a# W
59. 
      B4 D  F! l& S. x* n
60. // 向所有验证的用户推送数据
    
61. function broadcast($message)
    
62. {
    
63.    global $worker;
    
64.    foreach($worker->uidConnections as $connection)
    
65.    {
    3 j6 J$ _' q# a! c  e! v& j! g+ u; s
66.         $connection->send($message);
    3 a. V0 t% F0 J$ C) ?: Q1 ]! L
67.    }
    
68. }
    
69. 
    
70. // 针对uid推送数据
    
71. function sendMessageByUid($uid, $message)
    1 `$ X1 ?8 \9 L8 p9 H& {5 p( D
72. {
    ( F2 N1 A) ^. M  n+ ]) m: N6 [: o
73.     global $worker;
    6 r: y5 {5 C9 a9 j; F5 n
74.     if(isset($worker->uidConnections[$uid]))
    
75.     {
    ; h8 N- |1 F3 ^7 z+ `" Y5 j: ]! s
76.         $connection = $worker->uidConnections[$uid];
    $ O, [9 h* b! S
77.         $connection->send($message);
    
78.         return true;
    
79.     }
    
80.     return false;
    ( L7 K& w: X/ U2 Y* ]& u  ]1 W7 R
81. }
    + A0 J  a( l7 E5 z/ [
82. 
    : y" ]+ b8 |9 a% a0 e  ]
83. // 运行所有的worker
    ! x0 y# W8 R% i( i+ X' E
84. Worker::runAll();

复制代码

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

前端接收推送的js代码

1. var ws = new WebSocket('ws://127.0.0.1:1234');
   5 x2 @3 @  w# c* ^8 A) s
2. ws.onopen = function(){
   & H5 y/ h; D+ |* P6 d+ L
3.     var uid = 'uid1';
   - v+ L7 r& j2 e3 B
4.     ws.send(uid);
   
5. };
   , L, p1 g. h2 Z% P
6. ws.onmessage = function(e){
   
7.     alert(e.data);
   . `, A/ p/ Y; s, X' G
8. };

复制代码

后端推送消息的代码

1. // 建立socket连接到内部推送端口
   : ~# D% R& z# K: h: t+ R  x# N. ~
2. $client = stream_socket_client('tcp://127.0.0.1:5678', $errno, $errmsg, 1);
   ) g. ]4 j/ ~- m- L7 a+ I
3. // 推送的数据，包含uid字段，表示是给这个uid推送
   ; W' u; f5 p, j+ p$ J  J
4. $data = array('uid'=>'uid1', 'percent'=>'88%');
   3 u( B1 A  I+ c2 Q8 C& L! T
5. // 发送数据，注意5678端口是Text协议的端口，Text协议需要在数据末尾加上换行符
   
6. fwrite($client, json_encode($data)."\n");
   ' L' h# i+ w9 }3 @( k* ^1 ], u
7. // 读取推送结果
   + W2 T7 P) M+ x2 i1 z' W4 L
8. echo fread($client, 8192);

复制代码