Laravel Octane

簡介
安裝
伺服器前置需求
處理你的網站
Dependency Injection and Octane
管理 Memory Leak
併行的任務
Ticks and Intervals
Octane 的 Cache
資料表

簡介

Laravel Octane supercharges your application's performance by serving your application using high-powered application servers, including FrankenPHP, Open Swoole, Swoole, and RoadRunner. Octane boots your application once, keeps it in memory, and then feeds it requests at supersonic speeds.

安裝

可以使用 Composer 套件管理員來安裝 Octane：

1composer require laravel/octane1composer require laravel/octane

安裝好 Octane 後，就可以執行 octane:install Artisan 指令來安裝 Octane 的設定檔到專案中：

1php artisan octane:install1php artisan octane:install

伺服器的前置需求

Laravel Octane 需要 PHP 8.1 或之後的版本。

FrankenPHP

FrankenPHP is a PHP application server, written in Go, that supports modern web features like early hints, Brotli, and Zstandard compression. When you install Octane and choose FrankenPHP as your server, Octane will automatically download and install the FrankenPHP binary for you.

FrankenPHP via Laravel Sail

If you plan to develop your application using Laravel Sail, you should run the following commands to install Octane and FrankenPHP:

1./vendor/bin/sail up
2 
3./vendor/bin/sail composer require laravel/octane1./vendor/bin/sail up
2 
3./vendor/bin/sail composer require laravel/octane

Next, you should use the octane:install Artisan command to install the FrankenPHP binary:

1./vendor/bin/sail artisan octane:install --server=frankenphp1./vendor/bin/sail artisan octane:install --server=frankenphp

Finally, add a SUPERVISOR_PHP_COMMAND environment variable to the laravel.test service definition in your application's docker-compose.yml file. This environment variable will contain the command that Sail will use to serve your application using Octane instead of the PHP development server:

1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=frankenphp --host=0.0.0.0 --admin-port=2019 --port='${APP_PORT:-80}'" 
5      XDG_CONFIG_HOME:  /var/www/html/config 
6      XDG_DATA_HOME:  /var/www/html/data 1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=frankenphp --host=0.0.0.0 --admin-port=2019 --port='${APP_PORT:-80}'" 
5      XDG_CONFIG_HOME:  /var/www/html/config 
6      XDG_DATA_HOME:  /var/www/html/data

To enable HTTPS, HTTP/2, and HTTP/3, apply these modifications instead:

 1services:
 2  laravel.test:
 3    ports:
 4        - '${APP_PORT:-80}:80'
 5        - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
 6        - '443:443' 
 7        - '443:443/udp' 
 8    environment:
 9      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --host=localhost --port=443 --admin-port=2019 --https" 
10      XDG_CONFIG_HOME:  /var/www/html/config 
11      XDG_DATA_HOME:  /var/www/html/data  1services:
 2  laravel.test:
 3    ports:
 4        - '${APP_PORT:-80}:80'
 5        - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
 6        - '443:443' 
 7        - '443:443/udp' 
 8    environment:
 9      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --host=localhost --port=443 --admin-port=2019 --https" 
10      XDG_CONFIG_HOME:  /var/www/html/config 
11      XDG_DATA_HOME:  /var/www/html/data

Typically, you should access your FrankenPHP Sail application via https://localhost, as using https://127.0.0.1 requires additional configuration and is discouraged.

FrankenPHP via Docker

Using FrankenPHP's official Docker images can offer improved performance and the use of additional extensions not included with static installations of FrankenPHP. In addition, the official Docker images provide support for running FrankenPHP on platforms it doesn't natively support, such as Windows. FrankenPHP's official Docker images are suitable for both local development and production usage.

You may use the following Dockerfile as a starting point for containerizing your FrankenPHP powered Laravel application:

1FROM dunglas/frankenphp
2 
3RUN install-php-extensions \
4    pcntl
5    # Add other PHP extensions here...
6 
7COPY . /app
8 
9ENTRYPOINT ["php", "artisan", "octane:frankenphp"]1FROM dunglas/frankenphp
2 
3RUN install-php-extensions \
4    pcntl
5    # Add other PHP extensions here...
6 
7COPY . /app
8 
9ENTRYPOINT ["php", "artisan", "octane:frankenphp"]

Then, during development, you may utilize the following Docker Compose file to run your application:

 1# compose.yaml
 2services:
 3  frankenphp:
 4    build:
 5      context: .
 6    entrypoint: php artisan octane:frankenphp --workers=1 --max-requests=1
 7    ports:
 8      - "8000:8000"
 9    volumes:
10      - .:/app 1# compose.yaml
 2services:
 3  frankenphp:
 4    build:
 5      context: .
 6    entrypoint: php artisan octane:frankenphp --workers=1 --max-requests=1
 7    ports:
 8      - "8000:8000"
 9    volumes:
10      - .:/app

If the --log-level option is explicitly passed to the php artisan octane:start command, Octane will use FrankenPHP's native logger and, unless configured differently, will produce structured JSON logs.

You may consult the official FrankenPHP documentation for more information on running FrankenPHP with Docker.

RoadRunner

RoadRunner 是由 Go 製作的 RoadRunner 執行檔所驅動。初次啟動基於 RoadRunner 的 Octane Server 時，Octane 會為你下載與安裝 RoadRunner 執行檔。

RoadRunner via Laravel Sail

若你打算使用 Laravel Sail 來開發專案，請執行下列指令來安裝 Octane 與 RoadRunner：

1./vendor/bin/sail up
2 
3./vendor/bin/sail composer require laravel/octane spiral/roadrunner-cli spiral/roadrunner-http1./vendor/bin/sail up
2 
3./vendor/bin/sail composer require laravel/octane spiral/roadrunner-cli spiral/roadrunner-http

接著，請開啟 Sail Shell，並使用 rr 執行檔來取得 RoadRunner 的最新版 Linux 執行檔：

1./vendor/bin/sail shell
2 
3# Within the Sail shell...
4./vendor/bin/rr get-binary1./vendor/bin/sail shell
2 
3# Within the Sail shell...
4./vendor/bin/rr get-binary

Then, add a SUPERVISOR_PHP_COMMAND environment variable to the laravel.test service definition in your application's docker-compose.yml file. This environment variable will contain the command that Sail will use to serve your application using Octane instead of the PHP development server:

1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=roadrunner --host=0.0.0.0 --rpc-port=6001 --port='${APP_PORT:-80}'" 1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=roadrunner --host=0.0.0.0 --rpc-port=6001 --port='${APP_PORT:-80}'"

最後，請確認 rr 二進位檔案是否具有可執行權限，並 Build(建置) 你的 Sail Image(映像)：

1chmod +x ./rr
2 
3./vendor/bin/sail build --no-cache1chmod +x ./rr
2 
3./vendor/bin/sail build --no-cache

Swoole

若要使用 Swoole 應用程式伺服器來處理你的 Laravel Octane 網站，需要先安裝 Swoole PHP 擴充套件。一般來說，可以使用 PECL 來安裝：

1pecl install swoole1pecl install swoole

開啟 Swoole

若要使用 Open Swoole 應用程式伺服器來處理你的 Laravel Octane 網站，需要先安裝 Open Swoole PHP 擴充套件。一般來說，可以使用 PECL 來安裝：

1pecl install openswoole1pecl install openswoole

以 Open Swoole 來使用 Laravel Octane 時所提供的功能與以 Swoole 來使用 Laravel Octane 相同，如併行的任務、Tick 與 Interval 等。

Swoole via Laravel Sail

在使用 Sail 來處理 Octane 網站前，請確認是否使用最新版的 Laravel Sail，並在專案的根目錄中執行 ./vendor/bin/sail build --no-cache。

Alternatively, you may develop your Swoole based Octane application using Laravel Sail, the official Docker based development environment for Laravel. Laravel Sail includes the Swoole extension by default. However, you will still need to adjust the docker-compose.yml file used by Sail.

To get started, add a SUPERVISOR_PHP_COMMAND environment variable to the laravel.test service definition in your application's docker-compose.yml file. This environment variable will contain the command that Sail will use to serve your application using Octane instead of the PHP development server:

1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=swoole --host=0.0.0.0 --port='${APP_PORT:-80}'" 1services:
2  laravel.test:
3    environment:
4      SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:start --server=swoole --host=0.0.0.0 --port='${APP_PORT:-80}'"

最後，請 Build(建置) 你的 Sail Image(映像)：

1./vendor/bin/sail build --no-cache1./vendor/bin/sail build --no-cache

Swoole 設定

若由需要，Swoole 還支援多個可以加到 octane 設定檔中的額外設定選項。由於這些選項通常不會被修改，因此在預設的設定檔中並未包含：

1'swoole' => [
2    'options' => [
3        'log_file' => storage_path('logs/swoole_http.log'),
4        'package_max_length' => 10 * 1024 * 1024,
5    ],
6],1'swoole' => [
2    'options' => [
3        'log_file' => storage_path('logs/swoole_http.log'),
4        'package_max_length' => 10 * 1024 * 1024,
5    ],
6],

處理你的網站

可以通過 octane:start Artisan 指令來啟動 Octane Server。預設情況下，這個指令會使用專案中 octane 設定檔內 server 設定選項所指定的伺服器：

1php artisan octane:start1php artisan octane:start

預設情況下，Octane 會在 8000 Port(連接埠) 上啟動伺服器，因此我們可以在瀏覽器上通過 http://localhost:8000 來存取網站：

Serving Your Application via HTTPS

預設情況下。Octane 會產生 http:// 開頭的連結。在專案內的 config/octane.php 中，使用到了 OCTANE_HTTPS 這個環境變數。使用 HTTPS 來處理網站時，請將該環境變數設為 true，以讓 Octane 來告訴 Laravel 所有產生的連結都要以 https:// 開頭：

1'https' => env('OCTANE_HTTPS', false),1'https' => env('OCTANE_HTTPS', false),

Serving Your Application via Nginx

若你還未準備好自行管理伺服器設定，或不擅長設定各種執行大型 Laravel Octane 專案所需要的設定，請參考看看 Laravel Forge。

在正式環境中，請在傳統的網頁伺服器 —— 如 Nginx 或 Apache —— 後處理你的 Octane 網站。這樣一來，網站伺服器就可負責處理如圖片或 CSS 等的靜態網站，或是管理 SSL 憑證等。

在下方的 Nginx 設定檔中，Nginx 會負責處理網站的靜態資源，並將 Request Proxy(代理) 到 8000 Port(連接埠) 上所執行的 Octane 伺服器：

 1map $http_upgrade $connection_upgrade {
 2    default upgrade;
 3    ''      close;
 4}
 5 
 6server {
 7    listen 80;
 8    listen [::]:80;
 9    server_name domain.com;
10    server_tokens off;
11    root /home/forge/domain.com/public;
12 
13    index index.php;
14 
15    charset utf-8;
16 
17    location /index.php {
18        try_files /not_exists @octane;
19    }
20 
21    location / {
22        try_files $uri $uri/ @octane;
23    }
24 
25    location = /favicon.ico { access_log off; log_not_found off; }
26    location = /robots.txt  { access_log off; log_not_found off; }
27 
28    access_log off;
29    error_log  /var/log/nginx/domain.com-error.log error;
30 
31    error_page 404 /index.php;
32 
33    location @octane {
34        set $suffix "";
35 
36        if ($uri = /index.php) {
37            set $suffix ?$query_string;
38        }
39 
40        proxy_http_version 1.1;
41        proxy_set_header Host $http_host;
42        proxy_set_header Scheme $scheme;
43        proxy_set_header SERVER_PORT $server_port;
44        proxy_set_header REMOTE_ADDR $remote_addr;
45        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
46        proxy_set_header Upgrade $http_upgrade;
47        proxy_set_header Connection $connection_upgrade;
48 
49        proxy_pass http://127.0.0.1:8000$suffix;
50    }
51} 1map $http_upgrade $connection_upgrade {
 2    default upgrade;
 3    ''      close;
 4}
 5 
 6server {
 7    listen 80;
 8    listen [::]:80;
 9    server_name domain.com;
10    server_tokens off;
11    root /home/forge/domain.com/public;
12 
13    index index.php;
14 
15    charset utf-8;
16 
17    location /index.php {
18        try_files /not_exists @octane;
19    }
20 
21    location / {
22        try_files $uri $uri/ @octane;
23    }
24 
25    location = /favicon.ico { access_log off; log_not_found off; }
26    location = /robots.txt  { access_log off; log_not_found off; }
27 
28    access_log off;
29    error_log  /var/log/nginx/domain.com-error.log error;
30 
31    error_page 404 /index.php;
32 
33    location @octane {
34        set $suffix "";
35 
36        if ($uri = /index.php) {
37            set $suffix ?$query_string;
38        }
39 
40        proxy_http_version 1.1;
41        proxy_set_header Host $http_host;
42        proxy_set_header Scheme $scheme;
43        proxy_set_header SERVER_PORT $server_port;
44        proxy_set_header REMOTE_ADDR $remote_addr;
45        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
46        proxy_set_header Upgrade $http_upgrade;
47        proxy_set_header Connection $connection_upgrade;
48 
49        proxy_pass http://127.0.0.1:8000$suffix;
50    }
51}

Watching for File Changes

由於你的網站會在 Octane 伺服器啟動當下就被載入到記憶體內，因此，在瀏覽器上重新整理，並不會反映出你對網站所作出的修改。舉例來說，除非重新啟動 Octane 伺服器，不然在 routes/web.php 檔內所新增的 Route 定義並不會被反映出來。為了方便開發，可以使用 --watch Flag(旗標) 來讓 Octane 在偵測到專案內有任何檔案修改時自動重新啟動伺服器：

1php artisan octane:start --watch1php artisan octane:start --watch

在使用此功能前，請先確認本機開發環境上是否有安裝 Node。此外，也需要在專案中安裝 Chokidar 檔案監控套件：

1npm install --save-dev chokidar1npm install --save-dev chokidar

可以在專案內的 config/octane.php 設定檔中，使用 watch 設定選項來設定要監控哪些目錄與檔案。

Specifying the Worker Count

預設情況下，Octane 會依照你裝置的 CPU 核心數量來啟動相應的 Worker 數。啟動之後，當連入的 HTTP Request 進入你的網站時，就會由這些 Worker 來負責處理。可以在執行 octane:start 指令時，使用 --workers 選項來手動指定要啟動多少個 Worker：

1php artisan octane:start --workers=41php artisan octane:start --workers=4

使用 Swoole 應用程式伺服器時，還可以指定要啟動多少個「Task Worker」：

1php artisan octane:start --workers=4 --task-workers=61php artisan octane:start --workers=4 --task-workers=6

Specifying the Max Request Count

為了協助避免造成 Memory Leak，Octane 會在任何 Worker 處理 500 個 Request 後將其柔性重新啟動 (Gracefully Restart)。若要調整此數值，可使用 --max-requests 選項：

1php artisan octane:start --max-requests=2501php artisan octane:start --max-requests=250

Reloading the Workers

可以使用 octane:reload 指令來柔性重啟 Octane 伺服器的應用程式 Worker。一般來說，該指令應在部屬完成後使用，以將新部署的程式碼載入至記憶體當中，並用於處理接下來的 Request：

1php artisan octane:reload1php artisan octane:reload

Stopping the Server

可使用 octane:stop Artisan 指令以停止 Octane 伺服器：

1php artisan octane:stop1php artisan octane:stop

Checking the Server Status

可使用 octane:status Artisan 指令來檢查目前的 Octane 伺服器狀態：

1php artisan octane:status1php artisan octane:status

Dependency Injection and Octane

啟動 Octane 後，由於 Octane 在處理 Request 時只會一次性地將整個網站程式碼載入進記憶體中，因此在製作網站時有一些需要注意的點。舉例來說，在專案的 Service Provider 內，各個 register 與 boot 方法都只會在 Request Worker 第一次載入的時候被執行一次，並接下來的 Request 中重複使用同一個 Application 實體。

In light of this, you should take special care when injecting the application service container or request into any object's constructor. By doing so, that object may have a stale version of the container or request on subsequent requests.

Octane 會自動在各個 Request 間重設 Laravel 第一方的物件狀態 (State)。不過，Octane 無從得知如何處理您的專案所建立的全域狀態。因此，在製作專案時，必須考量到如何針對 Octane 作出調整。在接下來的文件中，我們會討論使用 Octane 時可能會遇到的常見問題。

插入 Container

一般來說，我們應該避免將 Service Container 或 HTTP Request 實體插入到其他物件的 Constructor 中。舉例來說，下列繫結會將整個 Service Container 插入到被繫結為單例 (Singleton) 的物件中：

 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app);
11    });
12} 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app);
11    });
12}

在這個例子中，若該 Service 實體是在網站啟動過程中被解析的，則在解析時，會插入 Container 到該 Service 中。在接下來的 Request 中，Service 實體上都將擁有相同的 Container 實體。對於部分專案來說，此狀況或許不是個問題。不過，在啟動時，若由繫結是在解析 Service 實體之後才被加入到 Container 中的，或是在接下來的 Request 中有其他繫結被加入到 Container 中，則 Service 實體上的 Container 可能會缺少這些繫結。

針對此問題的解決方法有兩種，一種方法是不用單例來註冊繫結，而另一種方法則是將一個用於解析 Container 的 Closure(閉包) 插入到 Service 中，以隨時解析為最新的 Container 實體：

 1use App\Service;
 2use Illuminate\Container\Container;
 3use Illuminate\Contracts\Foundation\Application;
 4 
 5$this->app->bind(Service::class, function (Application $app) {
 6    return new Service($app);
 7});
 8 
 9$this->app->singleton(Service::class, function () {
10    return new Service(fn () => Container::getInstance());
11}); 1use App\Service;
 2use Illuminate\Container\Container;
 3use Illuminate\Contracts\Foundation\Application;
 4 
 5$this->app->bind(Service::class, function (Application $app) {
 6    return new Service($app);
 7});
 8 
 9$this->app->singleton(Service::class, function () {
10    return new Service(fn () => Container::getInstance());
11});

全域補助函式 app 以及 Container::getInstance() 方法都會回傳最新版的 Container。

插入 Request

一般來說，我們應該避免將 Service Container 或 HTTP Request 實體插入到其他物件的 Constructor 中。舉例來說，下列繫結會將整個 Request 實體插入到被繫結為單例 (Singleton) 的物件中：

 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app['request']);
11    });
12} 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app['request']);
11    });
12}

在此例子中，若 Service 實體是在網站啟動過程中被解析的，則 HTTP Request 實體會被插入到 Service 實體內，並且在接下來的 Request 中，該 Service 實體都將擁有同一個 Request 實體。因此，所有的 Header、Input、Query String，以及其他 Request 資料都會是不正確的。

針對此問題，有幾種解決方法。第一種方法就是不要使用單例來註冊繫結，或者，可以將一個用於解析 Request 的 Closure 傳入給 Service 以隨時解析最新的 Request 實體。另一種方法，也是最推薦的作法，就是在執行階段時，只在 Request 中取出該物件所需的資訊，然後只傳入這些資訊到該物件的方法中：

 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4$this->app->bind(Service::class, function (Application $app) {
 5    return new Service($app['request']);
 6});
 7 
 8$this->app->singleton(Service::class, function (Application $app) {
 9    return new Service(fn () => $app['request']);
10});
11 
12// Or...
13 
14$service->method($request->input('name')); 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4$this->app->bind(Service::class, function (Application $app) {
 5    return new Service($app['request']);
 6});
 7 
 8$this->app->singleton(Service::class, function (Application $app) {
 9    return new Service(fn () => $app['request']);
10});
11 
12// Or...
13 
14$service->method($request->input('name'));

全域輔助函式 request 會回傳網站目前正在處理的 Request，因此在專案中可以安全地使用該函式。

在 Controller 方法或 Route Closure 中，可型別提示 Illuminate\Http\Request。

插入 Configuration Repository

一般來說，我們應該避免將 Configuration Repository 實體插入到其他物件的 Constructor 中。舉例來說，下列繫結會將整個 Configuration Repository 插入到被繫結為單例 (Singleton) 的物件中：

 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app->make('config'));
11    });
12} 1use App\Service;
 2use Illuminate\Contracts\Foundation\Application;
 3 
 4/**
 5 * Register any application services.
 6 */
 7public function register(): void
 8{
 9    $this->app->singleton(Service::class, function (Application $app) {
10        return new Service($app->make('config'));
11    });
12}

在這個例子中，若在各個 Request 間，設定值有發生變動，則 Service 將無法存取到最新的值，因為 Service 物件仍相依於原始的 Repository 實體。

要解決此問題，有兩種做法。第一種方法就是不要使用單例來繫結，而第二種方法則是插入一個用於解析 Configuration Repository 的 Closure 至該類別中：

 1use App\Service;
 2use Illuminate\Container\Container;
 3use Illuminate\Contracts\Foundation\Application;
 4 
 5$this->app->bind(Service::class, function (Application $app) {
 6    return new Service($app->make('config'));
 7});
 8 
 9$this->app->singleton(Service::class, function () {
10    return new Service(fn () => Container::getInstance()->make('config'));
11}); 1use App\Service;
 2use Illuminate\Container\Container;
 3use Illuminate\Contracts\Foundation\Application;
 4 
 5$this->app->bind(Service::class, function (Application $app) {
 6    return new Service($app->make('config'));
 7});
 8 
 9$this->app->singleton(Service::class, function () {
10    return new Service(fn () => Container::getInstance()->make('config'));
11});

全域函式 config 會回傳最新版本的 Configuration Repository，因此可以安全地在專案中使用該函式。

管理 Memory Leak(記憶體流失)

再次提醒，由於 Octane 會在各個 Request 間將網站程式保留在記憶體中，因此，若將資料加入到靜態維護的陣列將導致 Memory Leak。舉例來說，在下列 Controller 中，由於每個 Request 都會向靜態 $data 陣列加入資料，因此會導致 Memory Leak：

 1use App\Service;
 2use Illuminate\Http\Request;
 3use Illuminate\Support\Str;
 4 
 5/**
 6 * Handle an incoming request.
 7 */
 8public function index(Request $request): array
 9{
10    Service::$data[] = Str::random(10);
11 
12    return [
13        // ...
14    ];
15} 1use App\Service;
 2use Illuminate\Http\Request;
 3use Illuminate\Support\Str;
 4 
 5/**
 6 * Handle an incoming request.
 7 */
 8public function index(Request $request): array
 9{
10    Service::$data[] = Str::random(10);
11 
12    return [
13        // ...
14    ];
15}

在製作網站時，應特別注意以避免造成這些類型的 Memory Leak。建議在本機開發環境上監控網站的記憶體用量，以確保沒有在網站中造成 Memory Leak。

併行的任務

使用此功能時必須使用 Swoole。

在使用 Swoole 時，只需要使用 Octane 的 concurrently 方法，就可以通過輕型的背景任務來併行執行一些動作。可以將 concurrently 方法與 PHP 的陣列解構 (Destructure) 搭配使用以取得各個動作的執行結果：

1use App\Models\User;
2use App\Models\Server;
3use Laravel\Octane\Facades\Octane;
4 
5[$users, $servers] = Octane::concurrently([
6    fn () => User::all(),
7    fn () => Server::all(),
8]);1use App\Models\User;
2use App\Models\Server;
3use Laravel\Octane\Facades\Octane;
4 
5[$users, $servers] = Octane::concurrently([
6    fn () => User::all(),
7    fn () => Server::all(),
8]);

Octane 使用 Swoole 的「Task Worker」來處理併行的任務，並在與處理連入 Request 不同的處理程序中執行。在執行 octane:start 指令時，可以使用 --task-workers 指示詞來指定處理併行任務時可用的 Worker 數量：

1php artisan octane:start --workers=4 --task-workers=61php artisan octane:start --workers=4 --task-workers=6

呼叫 concurrently 方法時，由於 Swoole 任務系統的限制，請不要傳入超過 1024 個任務。

Ticks and Intervals

使用此功能時必須使用 Swoole。

在使用 Swoole 時，可以註冊一個「Tick」動作。每隔指定秒數時，就會執行一次該動作。可以使用 tick 方法來註冊「Tick」Callback(回呼)。tick 方法的第一個引數為字串，代表該 Ticker 的名稱。第二個引數則為每個特定間隔會被呼叫的 Callable。

在這個例子中，我們會註冊一個沒隔 10 秒會被執行的 Closure。一般來說，應在專案中某個 Service Provider 內的 boot 方法中呼叫 tick 方法：

1Octane::tick('simple-ticker', fn () => ray('Ticking...'))
2        ->seconds(10);1Octane::tick('simple-ticker', fn () => ray('Ticking...'))
2        ->seconds(10);

使用 immediate 方法，就可以讓 Octane 在 Octane 伺服器一啟動後馬上呼叫該 Tick Callback，並在接下來的每 N 秒執行：

1Octane::tick('simple-ticker', fn () => ray('Ticking...'))
2        ->seconds(10)
3        ->immediate();1Octane::tick('simple-ticker', fn () => ray('Ticking...'))
2        ->seconds(10)
3        ->immediate();

Octane Cache

使用此功能時必須使用 Swoole。

使用 Swoole 時，可以使用 Octane 的 Cache Driver。Octane 的 Cache Driver 提供了最快 2 百萬讀寫 / 秒的讀寫速度。因此，對於在快取層上需要高度讀寫速度的專案，Octane 的 Cache Driver 是很好的選擇。

該 Cache Driver 由 Swoole Table 驅動。儲存在 Cache 中的所有資料可在 Swoole Server 中的所有 Worker 中取用。不過，若重新啟動 Server，則已快取的資料會被清除。

1Cache::store('octane')->put('framework', 'Laravel', 30);1Cache::store('octane')->put('framework', 'Laravel', 30);

可存在 Octane Cache 中的最大資料筆數可在專案的 octane 設定檔中定義。

Cache 週期

除了 Laravel 的 Cache 系統所提供的一般方法外，Octane 的 Cache Driver 還提供了基於週期的快取。這些快取會在特定週期後被自動重新整理。需要在專案中某個 Service Provider 內的 boot 方法中註冊這些快取。舉例來說，下列快取每隔 5 秒就會被重新整理：

1use Illuminate\Support\Str;
2 
3Cache::store('octane')->interval('random', function () {
4    return Str::random(10);
5}, seconds: 5);1use Illuminate\Support\Str;
2 
3Cache::store('octane')->interval('random', function () {
4    return Str::random(10);
5}, seconds: 5);

Table

使用此功能時必須使用 Swoole。

使用 Swoole 時，也可以定義與使用任意的 Swoole Table。Swoole Table 提供了超快的吞吐效能。而存在 Swoole Table 中的資料可被 Swoole Server 中的所有 Worker 存取。不過，一旦重新啟動 Server，存在 Swoole Table 中的資料就會消失。

可以在專案的 octane 設定檔中 tables 設定陣列內定義 Swoole Table。在設定檔中，已包含了一個允許最多 1000 行資料的範例 Table 定義。可像下面範例這樣在欄位型別後指定字串欄位的最大大小：

1'tables' => [
2    'example:1000' => [
3        'name' => 'string:1000',
4        'votes' => 'int',
5    ],
6],1'tables' => [
2    'example:1000' => [
3        'name' => 'string:1000',
4        'votes' => 'int',
5    ],
6],

若要存取 Swoole Table，可使用 Octane::table 方法：

1use Laravel\Octane\Facades\Octane;
2 
3Octane::table('example')->set('uuid', [
4    'name' => 'Nuno Maduro',
5    'votes' => 1000,
6]);
7 
8return Octane::table('example')->get('uuid');1use Laravel\Octane\Facades\Octane;
2 
3Octane::table('example')->set('uuid', [
4    'name' => 'Nuno Maduro',
5    'votes' => 1000,
6]);
7 
8return Octane::table('example')->get('uuid');

Swoole 所支援的欄位型別為：string、int，與 float。

Laravel Octane

留言