基于 Swoole 构建高性能 Laravel 应用系列 —— 在 Laravel 中集成 Swoole 实现 WebSocket 服务器

栏目: PHP · 发布时间: 5年前

内容简介：在上篇教程中，我们基于 Swoole 实现了简单的 WebSocket 服务器，然后在客户端通过 JavaScript 实现了 WebSocket 客户端，并演示了 WebSocket 的握手和通信过程，今天，学院君将基于关于 LaravelS 扩展包我们之前在介绍在这个 WebSocket 服务器类中，需要实现接口中声明的方法，其实就是 WebSocket 通信事件的回调函数，和

在上篇教程中，我们基于 Swoole 实现了简单的 WebSocket 服务器，然后在客户端通过 JavaScript 实现了 WebSocket 客户端，并演示了 WebSocket 的握手和通信过程，今天，学院君将基于 LaravelS 扩展包把 Swoole 集成到 Laravel 项目来实现 WebSocket 服务器，以便与客户端进行 WebSocket 通信从而实现广播功能。

创建 WebSocketService 类

关于 LaravelS 扩展包我们之前在介绍基于 Swoole 实现 HTTP 服务器的时候已经提到过了，这里不再赘述，没有安装的同学可以去参考那篇教程进行安装和配置，要基于该扩展包实现 WebSocket 服务器，首先首先需要创建一个实现了 Hhxsv5\LaravelS\Swoole\WebSocketHandlerInterface 接口的 WebSocketService 类：

<?php

namespace App\Services;

use Hhxsv5\LaravelS\Swoole\WebSocketHandlerInterface;
use Illuminate\Support\Facades\Log;
use Swoole\Http\Request;
use Swoole\WebSocket\Frame;
use Swoole\WebSocket\Server;

class WebSocketService implements WebSocketHandlerInterface
{
    public function __construct()
    {

    }

    // 连接建立时触发
    public function onOpen(Server $server, Request $request)
    {
        // 在触发 WebSocket 连接建立事件之前，Laravel 应用初始化的生命周期已经结束，你可以在这里获取 Laravel 请求和会话数据
        // 调用 push 方法向客户端推送数据，fd 是客户端连接标识字段
        Log::info('WebSocket 连接建立');
        $server->push($request->fd, 'Welcome to WebSocket Server built on LaravelS');
    }

    // 收到消息时触发
    public function onMessage(Server $server, Frame $frame)
    {
        // 调用 push 方法向客户端推送数据
        $server->push($frame->fd, 'This is a message sent from WebSocket Server at ' . date('Y-m-d H:i:s'));
    }

    // 关闭连接时触发
    public function onClose(Server $server, $fd, $reactorId)
    {
        Log::info('WebSocket 连接关闭');
    }
}

在这个 WebSocket 服务器类中，需要实现接口中声明的方法，其实就是 WebSocket 通信事件的回调函数，和上篇教程介绍的原生实现基本一致，只是通过类进行了封装而已。

修改配置文件

接下来，打开配置文件 config/laravels.php ，启用 WebSocket 通信并将刚刚创建的服务器类配置到对应的配置项：

'websocket' => [
    'enable' => true,
    'handler' => \App\Services\WebSocketService::class,
],

我们还可以在 swoole 配置项中配置 WebSocket 长连接的强制关闭逻辑：

'swoole' => [
    ...

    // 每隔 60s 检测一次所有连接，如果某个连接在 600s 内都没有发送任何数据，则关闭该连接
    'heartbeat_idle_time'      => 600,
    'heartbeat_check_interval' => 60,

    ...
],

配置 Nginx 支持 WebSocket

由于 WebSocket 通信是基于 HTTP 协议的，所以，我们还要配置 HTTP 服务器来支持 WebSocket 请求，以 Nginx 为例，我们在基于 Swoole 实现 HTTP 服务器一节中添加的 Nginx 配置文件基础上进行 WebSocket 配置，为了与之前基于 PHP-FPM 作为进程管理器的站点配置区分开，创建一个新的站点配置 todoapp-s.conf （基于待办任务项目进行测试），编辑配置文件内容如下：

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}
upstream laravels {
    # Connect IP:Port
    server workspace:5200 weight=5 max_fails=3 fail_timeout=30s;
    keepalive 16;
}
server {
    listen 80;

    server_name todo-s.test;
    root /var/www/todoapp/public;

    error_log /var/log/nginx/todoapp_s_error.log;
    access_log /var/log/nginx/todoapp_s_access.log;

    index index.php index.html index.htm;

    # Nginx handles the static resources(recommend enabling gzip), LaravelS handles the dynamic resource.
    location / {
        try_files $uri @laravels;
    }

    # Response 404 directly when request the PHP file, to avoid exposing public/*.php
    #location ~* \.php$ {
    #    return 404;
    #}

    # Http and WebSocket are concomitant, Nginx identifies them by "location"
    # !!! The location of WebSocket is "/ws"
    # Javascript: var ws = new WebSocket("ws://todo-s.test/ws");
    # 处理 WebSocket 通信
    location =/ws {
        # proxy_connect_timeout 60s;
        # proxy_send_timeout 60s;
        # proxy_read_timeout: Nginx will close the connection if the proxied server does not send data to Nginx in 60 seconds; At the same time, this close behavior is also affected by heartbeat setting of Swoole.
        # proxy_read_timeout 60s;
        proxy_http_version 1.1;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header Scheme $scheme;
        proxy_set_header Server-Protocol $server_protocol;
        proxy_set_header Server-Name $server_name;
        proxy_set_header Server-Addr $server_addr;
        proxy_set_header Server-Port $server_port;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_pass http://laravels;
    }

    location @laravels {
        # proxy_connect_timeout 60s;
        # proxy_send_timeout 60s;
        # proxy_read_timeout 60s;
        proxy_http_version 1.1;
        proxy_set_header Connection "";
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header Scheme $scheme;
        proxy_set_header Server-Protocol $server_protocol;
        proxy_set_header Server-Name $server_name;
        proxy_set_header Server-Addr $server_addr;
        proxy_set_header Server-Port $server_port;
        proxy_pass http://laravels;
    }
}

学院君的本地开发环境是 Laradock，所以配置的监听 IP 是 Docker 容器名称 workspace ，如果你不是在 Laradock 中开发，需要将其改成自己的 Swoole WebSocket Server 监听 IP。

配置完成后，即可构建容器并重新启动：

docker-compose build nginx
docker-compose down
docker-compose up -d nginx mysql

此外，记得在对应 Laravel 项目根目录下 .env 环境配置文件中设置如下配置项：

LARAVELS_LISTEN_IP=workspace  // 这里的 IP 需要和 nginx upstream 中配置的监听 IP 保持一致
LARAVELS_DAEMONIZE=true