PHP Swoole 基本使用

背景

在项目中，我们使用了PHP语言，但由于存在长耗时的任务，所以需要服务器端异步响应。为了实现异步响应，我们有多种方案可选，包括MQ（消息队列）、fsocket（文件套接字）、Swoole等。

其中，Swoole是一个使用纯C语言编写的工具，它提供了PHP语言的异步多线程服务器、异步TCP/UDP网络客户端、异步MySQL、异步Redis、数据库连接池、AsyncTask、消息队列、毫秒定时器、异步文件读写、异步DNS查询等功能。此外，Swoole还内置了Http/WebSocket服务器端/客户端以及Http2.0服务器端。

最重要的是，Swoole完美支持PHP语言。因此，我们选择使用Swoole搭建了一个异步服务器，以实现异步响应、推送、定时任务等一系列工作。

安装

Swoole是用C语言编写的，并且需要通过编译安装来进行安装。

安装前请确保已经安装以下依赖项：

• PHP 5.3.10或更高版本

• GCC 4.4或更高版本

• make

• autoconf

• pcre（对于CentOS系统，可以执行命令：yum install pcre-devel来安装）

安装步骤如下：

1. 执行命令phpize（如果命令不存在，请使用实际的PHP路径来执行此命令）

2. 运行命令./configure

3. 执行命令make

4. 使用sudo权限运行命令make install

安装完成后，需要在php.ini文件中添加Swoole扩展：

extension=swoole.so

使用

服务端

class Server{
    private $serv;
    public function __construct() {
        $this->serv = new swoole_server("0.0.0.0", 9501);
        $this->serv->set(array(
 
            //'worker_num' => 1,  //一般设置为服务器CPU数的1-4倍
 
            'daemonize' => 1,  //以守护进程执行
            'max_request' => 10000,
            'task_worker_num' => 1,  //task进程的数量
 
            "task_ipc_mode " => 3 ,  //使用消息队列通信，并设置为争抢模式
            'open_length_check'    => true,
            'dispatch_mode'        => 1,
 
            'package_length_type'  => 'N',  //这个很关键，定位包头的
            'package_length_offset' => 0,      //第N个字节是包长度的值
            'package_body_offset'  => 4,      //第几个字节开始计算长度
 
            'package_max_length'    => 2000000,  //协议最大长度
            "log_file" => "/tmp/swoole_test.log"  //日志
 
        ));
 
        $this->serv->on('Receive', array($this, 'onReceive'));
        $this->serv->on('Task', array($this, 'onTask'));
        $this->serv->on('Finish', array($this, 'onFinish'));
        $this->serv->start();
 
    }
 
    public function onReceive( swoole_server $serv, $fd, $from_id, $data ) {
 
        //放入任务队列，开始执行
        $task_id = $serv->task( $data );
 
    }
 
    public function onTask($serv,$task_id,$from_id, $data) {
      //做一些事情
 
    }

客户端

class Client{
 
    private $client, $ip, $port, $params;
 
    public function __construct($ip, $port, $params)
    {
 
        $this->ip = $ip;
        $this->port = $port;
        $this->params = $params;
 
        $this->client = new swoole_client(SWOOLE_SOCK_TCP, SWOOLE_SOCK_ASYNC);
        $this->client->set(array(
            'open_length_check'    => true,
            'package_length_type'  => 'N',
            'package_length_offset' => 0,      //第N个字节是包长度的值
            'package_body_offset'  => 4,      //第几个字节开始计算长度
            'package_max_length'    => 2000000,  //协议最大长度
 
        ));
 
        //设置事件回调函数
 
        $this->client->on('Connect', array($this, 'onConnect'));
        $this->client->on('Receive', array($this, 'onReceive'));
        $this->client->on('Close', array($this, 'onClose'));
        $this->client->on('Error', array($this, 'onError'));
 
        //发起网络连接
        $this->client->connect($ip, $port, 3);
    }
 
    public function onReceive( $cli, $data ) {
        echo "Received: " . $data . "\n";
 
    }
 
    public function onConnect($cli) {
 
        $data = pack('N', strlen($data)) . $data;
        $cli->send($data);
        $cli->close();
 
    }
 
    public function onClose( $cli)
    {
        echo "Connection close\n";
    }
 
    public function onError()
    {
        echo "Connect failed\n";
    }
 
}

注意问题

'open_length_check'    => true,
'package_length_type'  => 'N',
'package_length_offset' => 0,      //第N个字节是包长度的值
'package_body_offset'  => 4,      //第几个字节开始计算长度
'package_max_length'    => 2000000,  //协长度

这几个是定义帧定界的，因为Swoole的客户端和服务器端通信是TCP连接的，因此得给帧定界符，有多种帧定界方式，具体参考Swoole官方文档。这里其中是用头额外加长度的方式。