Skip to content

Latest commit

 

History

History
295 lines (197 loc) · 9.05 KB

README-cn.md

File metadata and controls

295 lines (197 loc) · 9.05 KB
Raw

Laravel-Swoole-Http

一个基于Swoole的高性能HTTP Server，帮助你大幅度地提高网站的并发能力。

当然，现在它也支持WebSocket Server。

安装

1、在安装Package之前，请确认自己的环境是否满足条件：

Laravel Lumen Swoole
~5.2 ~5.2 >=1.9.5

2、请根据需求，确认以下PHP拓展是否已安装：

拓展名 必选 说明
swoole true 该package基于swoole开发，所以此拓展必须安装
inotify false 该package为开发者提供了watch模式，如果不需要此功能，可不必安装

注意：PHP拓展可以选择编译安装，或者使用pecl命令快速安装，例如pecl install swoole。PHP拓展安装完成后需要在php.ini中添加配置。

3、然后使用composer安装package：

$ composer require huang-yi/laravel-swoole-http

快速使用

1、注册服务（可选）

如果你正在使用低版本的Laravel框架（小于5.5），请在config/app.php的providers数组中手动添加服务提供器：

[
    'providers' => [
        HuangYi\Swoole\SwooleServiceProvider::class,
    ],
]

如果你正在使用Lumen框架，将下面这行代码添加到bootstrap/app.php文件：

$app->register(HuangYi\Swoole\SwooleServiceProvider::class);

2、 修改配置

请运行以下命令快速发布配置文件，它将生成一个swoole.php在config/文件夹下：

$ php artisan vendor:publish --provider="HuangYi\Swoole\SwooleServiceProvider"

请参考配置说明，调整配置文件参数。

3、启动服务

可以使用php artisan swoole:server来管理服务，这里可以获取更多关于该命令的说明。

在这里，我们只需要简单执行php artisan swoole:server即可快速启动服务。

4、预览效果

默认地，我们可以使用浏览器访问地址http://127.0.0.1:1215，就可以成功看到Web界面了。

如果你想为自己的网站配置域名，请参考Nginx配置

Configurations

driver

服务器驱动，可选项有http、websocket。你可以根据自己的需求选择驱动，来创建相应的服务器。

host

指定服务器监听的IP地址，127.0.0.1表示监听本机，也可以使用内网地址或外网地址，0.0.0.0表示监听所有地址。

port

指定服务器监听的端口，默认为1215，建议使用大于1024的端口。

options

服务器运行时的各项参数，你可根据自己的需求添加或修改配置项，更多细节请阅读官方文档。

注意：如果你想启用Websocket Server或者Task进程，那么必须将task_worker_num配置为大于0的数值。

resets

这项配置允许你配置一些需要被重置的Service Provider或者对象实例。重置时间为每个request后。

为什么需要这个配置呢？基于swoole的应用与传统的PHP应用不同，swoole会使你的应用常驻内存，每次request后并不会像PHP-FPM那样销毁所有变量，所以Laravel IoC容器中的instances都会被保存下来。 例如auth组件就是一个典型的单例，在swoole环境下，如果不重置auth组件，会导致后续request的用户身份一直为第一个request的用户身份。（注意：并非所有的单例都会带来污染问题，请分析具体的使用场景）。 因此为了避免单例带来的污染问题，你可以通过该配置项来解决。

message_parser

Websocket消息的解析器。默认为HuangYi\Swoole\Websocket\Message\JsonParser::class。

开发者可以利用该配置项替换为自己的消息解析器。

注意：消息解析器必须实现HuangYi\Swoole\Contracts\ParserContract合约。

redis

  • connection：Websocket的房间数据使用redis存储，你可以指定一个专有的redis连接来存储相关数据
  • prefix：设置redis键前缀

tables

定义Swoole Table的表结构。由于进程间的内存是相互隔离的，如果想进程间共享数据，需要通过Swoole Table。

例如定义一张users表：

[
    'tables' => [
        [
            'name' => 'users',
            'size' => 1024,
            'columns' => [
                ['id', 'int', 8],
                ['nickname', 'string', 255],
                ['score', 'float']
            ],
        ],
    ],
]

其中name为表名；size为表格最大行数，其值必须为2的次方；columns为表的列，每个列需要定义三个属性：列名、类型、长度。其中类型可以为int、integer、string、varchar、char、float。

这里可以获取更多关于Tables的说明。

注意：int、integer都表示整型，string、varchar、char都表示字符串，没有什么区别。

watcher

File watcher配置。当使用php artisan swoole:server watch运行服务时，会进入watch模式。

directories：被监控的目录列表；

excluded_directories：不被监控的目录列表；

suffixes：文件后缀列表，只有符合后缀条件的文件才会被监控；

Commands

该package为开发者提供了便捷的Artisan命令来管理服务：php artisan swoole:server。该命令接收一个action参数：

Action 说明
start 启动服务，该值为默认值，可缺省
stop 停止服务
reload 重载服务。此命令可以帮你平滑地重启服务器
restart 重启服务
watch watch模式。当监控到文件发生变动时，服务会自动重载，这样就省去了手动重载的麻烦，让你拥有更愉悦的开发体验。该模式必须安装inotify拓展，建议仅在开发环境下使用。

注意：Swoole Server只能在cli模式下运行。

Tables

由于进程间的内存是相互隔离的，我们可以借助Swoole Table实现进程间的共享数据。

开发者可以通过配置文件中的tables选项定义表结构，定义好的tables会在服务启动时创建好，我们可以使用FacadeHuangYi\Swoole\Facades\Table来方便地操作：

<?php
use HuangYi\Swoole\Facades\Table;

// 插入一条数据
Table::use('users')->set(1, ['id' => 1, 'nickname' => 'Bob', 'score' => 9.5]);

// 查询数据
$bob = Table::use('users')->get(1);
$nickname = Table::use('users')->get(1, 'nickname');

// 清空表
Table::truncate('users');

更多关于Swoole Table的操作方法，可以查看官方文档。

注意：Swoole Table必须在Swoole Server启动之前创建好，所以请不要在应用程序中创建Swoole Table。

Task

在Swoole中，Task是异步非阻塞的。如果开发者遇到一些耗时的工作，我们可以创建一个Task，将其投递到task worker进程中进行异步处理。

新建的Task必须实现HuangYi\Swoole\Contracts\TaskContract合约：

<?php

use HuangYi\Swoole\Contracts\TaskContract;
use Illuminate\Support\Facades\Mail;

class SendMailTask implements TaskContract
{
    /**
     * @var array $mail
     */
    protected $mail;

    /**
     * Mail task
     * 
     * @var array $mail
     * @return void
     */
    public function __construct(array $mail)
    {
        $this->mail = $mail;
    }

    /**
     * Task handler.
     *
     * @param \Swoole\Server $server
     * @param int $taskId
     * @param int $srcWorkerId
     * @return void
     */
    public function handle($server, $taskId, $srcWorkerId)
    {
        Mail::to($this->mail['to'])->send($this->mail['view'], $this->mail['data']);
    }
}

投递任务：

<?php

$task = new SendMailTask([
    'to' => 'bob@mail.com',
    'view' => 'mail',
    'data' => [],
]);

app('swoole.server')->task($task);

注意：启用Task进程，必须将配置项swoole.options.task_worker_num配置为大于0的数值。

Nginx

由于Swoole对HTTP协议的支持并不完整，建议仅作为应用服务器，开发者需要使用Nginx做反向代理。

server {
    listen 80;
    server_name your.domain;
    root /path/to/laravel/public;
    index index.php;

    location = /index.php {
        # Ensure that there is no such file named "not_exists" in your "public" directory.
        try_files /not_exists @swoole;
    }

    location / {
        try_files $uri $uri/ @swoole;
    }

    location @swoole {
        set $suffix "";
        
        if ($uri = /index.php) {
            set $suffix "/";
        }

        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        proxy_pass http://127.0.0.1:1215$suffix;
    }
}

注意：请将swoole-server的IP（默认是127.0.0.1）添加到App\Http\Middleware\TrustProxies中间件，这样Request::ip()和Request::url()才能获取到正确的值。

编程须知

  • 这些函数不应该出现在程序中（Artisan Command除外）：sleep()、exit()、die()。
  • 谨慎使用单例。