workerman でのワーカークラスの使用法に関する簡単な説明-Workerman-php.cn

この記事では、workerman について紹介し、workerman でのワーカークラスの使用法について説明します。一定の参考値があるので、困っている友達が参考になれば幸いです。

workerman でのワーカークラスの使用法に関する簡単な説明

workerman とは何ですか?

Workerman は、オープンソースの高性能非同期 PHP ソケットインスタントメッセージングフレームワークです。高い同時実行性と超高い安定性をサポートし、モバイルアプリ、モバイル通信、WeChat アプレット、モバイルゲームサーバー、オンラインゲーム、PHP チャットルーム、ハードウェア通信、スマートホーム、車両のインターネット、モノのインターネットなどの分野で広く使用されています。。発達。 TCP の長い接続をサポートし、Websocket、HTTP およびその他のプロトコルをサポートし、カスタムプロトコルをサポートします。非同期 Mysql、非同期 Redis、非同期 Http、MQTT IoT クライアント、非同期メッセージキューなど、多くの高性能コンポーネントを備えています。

公式サイト: https://www.workerman.net/

workerman の特徴

純粋な PHP 開発
PHP マルチプロセスをサポート
TCP をサポート、UDP
長時間接続をサポート
さまざまなアプリケーション層プロトコルをサポート
高同時実行をサポート
スムーズなサービスの再起動をサポート
HHVM
指定されたユーザーとして子プロセスの実行をサポート
モニタリングが付属
ミリ秒レベルのタイマーをサポート
非同期 IO をサポート
オブジェクトまたはリソースの永続的な保持をサポート
高パフォーマンス
分散展開をサポート
ハートビート検出をサポート

ワーカーマンアプリケーションシナリオ

#workerman のインストール

環境要件:

Workerman は、バージョン 3.5.3 以降、Linux と Windows システムの両方をサポートできるようになりました。

PHP>=5.3.3 が必要で、PHP 環境変数を構成します。

注: このチュートリアルでは Linux を使用しており、Windows については説明しません。実際の使用には Windows システムを使用することはお勧めできません。

Linux lnmp ワンクリックインストールスクリプト

1. PHP>=5.3.3 をインストールし、pcntl および posix 拡張機能 --enable-pcntl --enable-posix

をインストールします。 2. events または libevent 拡張機能をインストールすることをお勧めしますが、必須ではありません (event 拡張機能に注意してください)拡張機能には PHP>=5.4 が必要です)

curl -Ss http://www.workerman.net/check.php | php

git clone https: //github.com/walkor/Workerman

libevent をインストールします

yum install libevent-devel

php のバージョンは 7

未満です wget http://pecl.php .net/get/libevent-0.1.0.tgz

現在、libevent 拡張機能は php7 をサポートしておらず、php7 ユーザーは Event 拡張機能のみを使用できることに注意してください。

wget http://pecl.php.net/get/event-2.4.3.tgz

解凍コンパイル

/user/local/php/bin/phpize
./configure --with-php-config=/usr/local/php/bin/php-config
make && make install

php.ini

workerman ディレクトリ構造に設定します

workerman の簡単な開発デモ

簡単な http サーバーを実装する

require_once  &#39;workman/Autoloader.php&#39;;

use \Workerman\Worker;

$http_work = new Worker(&#39;http://0.0.0.0:1111’);

$http_work->onMessage = function($conn,$data){

        $conn->send(&#39;hello workman&#39;);
};

Worker::runAll();

浏览器 访问  ip:1111  即可

ログイン後にコピー

WebSocket を実装する

ws.php

require_once  &#39;workman/Autoloader.php&#39;;
use \Workerman\Worker;
$http_work = new Worker(&#39;websocket://0.0.0.0:2222&#39;);
$http_work->onMessage = function($conn,$data){
        $conn->send(&#39;hello workman&#39;.$data);
};
Worker::runAll();


<!DOCTYPE HTML>
<html>
<body>

<script>
        ws = new WebSocket("ws://192.168.113.136:2222");
        ws.onopen = function(){
           ws.send(&#39;lampol&#39;);
        }

        ws.onmessage = function(e){
                console.log(e.data)
        }

</script>
</body>
</html>

ログイン後にコピー

workermanPrinciple

Worker Class

WorkerMan には、Worker と Connection の 2 つの重要なクラスがあります。

Workerクラスはポート監視を実現するクラスであり、クライアント接続イベント、接続メッセージイベント、接続切断イベントのコールバック関数を設定して業務処理を実現できます。

$worker = new Worker($listen,$context); //インスタンス化による戻りオブジェクト

$listen の形式は <プロトコル>://<リスニングアドレス>

<プロトコル> は次の形式にすることができます:

tcp: 例: tcp://0.0.0.0:8686

udp: 例: udp:// 0.0.0.0 :8686

unix: たとえば、unix:///tmp/my_file (Workerman>=3.2.7 が必要)

http: たとえば、http://0.0。 0.0:80

websocket: たとえば、websocket://0.0.0.0:8686

text: たとえば、text://0.0.0.0:8686 (テキストは Workerman の組み込みですテキストプロトコルであり、Telnet と互換性があります。詳細については、付録の「テキストプロトコル」セクションを参照してください。)

$context ソケットを渡すためのコンテキストオプション

ワーカークラス属性

count

プロセスを開始する現在の Worker インスタンスの数を設定します。設定されていない場合、デフォルトは 1 です。

このプロパティを有効にするには、Worker::runAll(); を実行する前に設定する必要があります。 Windows システムはこの機能をサポートしていません。

プロセス数設定の根拠:

1. CPU コアの数

2. メモリサイズ

3. ビジネスが IO かどうか-集中型または CPU 集中型

どちらのタイプのビジネスを好むかわからない場合は、プロセス数を CPU コア数の約 2 倍に設定できます。

lscpu top  1 CPUコア数の確認

当前worker进程的id编号，范围为0到$worker->count-1。进程重启后id编号值是不变的。

name

设置当前Worker实例的名称，方便运行status命令时识别进程。不设置时默认为none。

protocol
设置当前Worker实例的协议类。

transport
设置当前Worker实例所使用的传输层协议，目前只支持3种(tcp、udp、ssl)。不设置默认为tcp。

daemonize
此属性为全局静态属性，表示是否以daemon(守护进程)方式运行。如果启动命令使用了 -d参数，则该属性会自动设置为true。也可以代码中手动设置。

logFile

用来指定workerman日志文件位置。此文件记录了workerman自身相关的日志，包括启动、停止等。
Worker::$logFile = '/tmp/workerman.log’;

stdoutFile

此属性为全局静态属性，如果以守护进程方式(-d启动)运行，则所有向终端的输出(echo var_dump等)都会被重定向到stdoutFile指定的文件中。
Worker::$stdoutFile = 'test.log’;

pidFile
如果无特殊需要，建议不要设置此属性
Worker::$pidFile = '/var/run/workerman.pid’;

user
设置当前Worker实例以哪个用户运行。此属性只有当前用户为root时才能生效。不设置时默认以当前用户运行。
建议$user设置权限较低的用户，例如www-data、apache、nobody等。

connections

array(id=>connection, id=>connection, ...)
此属性中存储了当前进程的所有的客户端连接对象，其中id为connection的id编号

reloadable
设置当前Worker实例是否可以reload，即收到reload信号后是否退出重启。不设置默认为true，收到reload信号后自动重启进程。

reusePort

设置当前worker是否开启监听端口复用(socket的SO_REUSEPORT选项)，默认为false，不开启。

globalEvent
此属性为全局静态属性，为全局的eventloop实例，可以向其注册文件描述符的读写事件或者信号事件。

Worker类回调属性

onWorkerStart

设置Worker子进程启动时的回调函数，每个子进程启动时都会执行。

回掉函数参数 $worker Worker 对象

$worker->onWorkerStart = function($worker){
     //代码
};

$worker->onWorkerStart = &#39;test’;
function test($worker){
        echo &#39;hhhhh&#39;;
}

ログイン後にコピー

onConnect

当客户端与Workerman建立连接时(TCP三次握手完成后)触发的回调函数。每个连接只会触发一次onConnect回调。

回调函数的参数

$connection

ログイン後にコピー

连接对象，即TcpConnection实例，用于操作客户端连接，如发送数据，关闭连接等

$worker->onConnect = function($connection){
        echo &#39;new connect....&#39;.$connection->getRemoteIp();
};

ログイン後にコピー

onMessage

当客户端通过连接发来数据时(Workerman收到数据时)触发的回调函数

回调函数的参数

$connection
连接对象，即TcpConnection实例，用于操作客户端连接，如发送数据，关闭连接等

$data
客户端连接上发来的数据，如果Worker指定了协议，则$data是对应协议decode（解码）了的数据

$worker->onMessage = function($connection,$data){
        echo $data;
        $connection->send(&#39;hello &#39;.$data.PHP_EOL);
};

ログイン後にコピー

onClose

当客户端连接与Workerman断开时触发的回调函数。不管连接是如何断开的，只要断开就会触发onClose。每个连接只会触发一次onClose。由于断网或者断电等极端情况断开的连接，也就无法及时触发onClose，这种情况需要通过应用层心跳来解决

$worker->onClose = function($connection){
        echo &#39;connection close&#39;;
};

ログイン後にコピー

onError
当客户端的连接上发生错误时触发。

目前错误类型有

1、调用Connection::send由于客户端连接断开导致的失败（紧接着会触发onClose回调） (code:WORKERMAN_SEND_FAIL msg:client closed)

2、在触发onBufferFull后(发送缓冲区已满)，仍然调用Connection::send，并且发送缓冲区仍然是满的状态导致发送失败(不会触发onClose回调)(code:WORKERMAN_SEND_FAIL msg:send buffer full and drop package)

3、使用AsyncTcpConnection异步连接失败时(紧接着会触发onClose回调) (code:WORKERMAN_CONNECT_FAIL msg:stream_socket_client返回的错误消息)

onWorkerReload

此特性不常用到。

设置Worker收到reload信号后执行的回调。

可以利用onWorkerReload回调做很多事情，例如在不需要重启进程的情况下重新加载业务配置文件。

onBufferFull

每个连接都有一个单独的应用层发送缓冲区，如果客户端接收速度小于服务端发送速度，数据会在应用层缓冲区暂存，如果缓冲区满则会触发onBufferFull回调。

缓冲区大为TcpConnection::$maxSendBufferSize，默认值为1MB，可以为当前连接动态设置缓冲区大小例

onBufferDrain

每个连接都有一个单独的应用层发送缓冲区，缓冲区大小由TcpConnection::$maxSendBufferSize决定，默认值为1MB，可以手动设置更改大小，更改后会对所有连接生效。

Worker类接口方法

runAll

运行所有Worker实例。

Worker::runAll()执行后将永久阻塞，也就是说位于Worker::runAll()后面的代码将不会被执行。所有Worker实例化应该都在Worker::runAll()前进行。

stopAll

停止当前进程（子进程）的所有Worker实例并退出。
此方法用于安全退出当前子进程，作用相当于调用exit/die退出当前子进程。

listen

用于实例化Worker后执行监听。

Worker类代码流程分析

public function __construct($socket_name = &#39;&#39;, $context_option = array())

public static function runAll()
{
    static::checkSapiEnv();     //检测命令行模式
    static::init();                      //初始化日志 pid  workid…
    static::lock();                     //启动文件 加锁 独占锁
    static::parseCommand();  //解析命令  start   stop  restart  …
    static::daemonize();          //守护进程运行
    static::initWorkers();          //初始化 所有worker 实例
    static::installSignal();         //安装信号
    static::saveMasterPid();    //保存主进程id
    static::unlock();                  //解锁
    static::displayUI();              //展示UI
    static::forkWorkers();          //fork 进程
    static::resetStd();                //重置输入输出
    static::monitorWorkers();    //主进程监控各个worker的状态
}

ログイン後にコピー

SAPI（Server Application Programming Interface）服务器应用程序编程接口，即PHP与其他应用交互的接口，PHP脚本要执行有很多方式，通过Web服务器，或者直接在命令行下，也可以嵌入在其他程序中。

常见的SAPI有：cgi、fast-cgi、cli、apache模块的DLL、isapi

Linux 常用SIG信号及其键值

01 SIGHUP 挂起（hangup）
02 SIGINT 中断，当用户从键盘按^c键或^break键时
03 SIGQUIT 退出，当用户从键盘按quit键时
04 SIGILL 非法指令
05 SIGTRAP 跟踪陷阱（trace trap），启动进程，跟踪代码的执行
06 SIGIOT IOT指令
07 SIGEMT EMT指令
08 SIGFPE 浮点运算溢出
09 SIGKILL 杀死、终止进程
10 SIGBUS 总线错误
11 SIGSEGV 段违例（segmentation violation），进程试图去访问其虚地址空间以外的位置
12 SIGSYS 系统调用中参数错，如系统调用号非法
13 SIGPIPE 向某个非读管道中写入数据
14 SIGALRM 闹钟。当某进程希望在某时间后接收信号时发此信号
15 SIGTERM 软件终止（software termination）
16 SIGUSR1 用户自定义信号1
17 SIGUSR2 用户自定义信号2
18 SIGCLD 某个子进程死