1.6アップグレードガイド

アップグレード前にバックアップを作成し、以下のコマンドを実行してください

composer config -g --unset repos.packagist
composer require -W workerman/webman-framework ^v1.6.11

webman-framework バージョン1.6.0をリリース

新機能

要求PHP>=8.0

コントローラの引数から入力を取得するサポート

<?php
namespace app\controller;
use support\Response;

class UserController
{
    public function create(string $name, int $age, float $balance, bool $vip, array $extension): Response
    {
        return json([
            'name' => $name,
            'age' => $age,
            'balance' => $balance,
            'vip' => $vip,
            'extension' => $extension,
        ]);
    }
}

/user/create?name=tom&age=18&balance=100.5&vip=1&extension[foo]=barにアクセスすると、結果が得られます

{
  "name": "tom",
  "age": 18,
  "balance": 100.5,
  "vip": true,
  "extension": {
    "foo": "bar"
  }
}

引数のバインドにはモデルを含むクラスタイプもサポートされています。たとえば

<?php
namespace app\controller;
use app\model\User;
class UserController
{
    public function create(User $user): int
    {
        $user->save();
        return $user->id;
    }
}

詳しくはコントローラ引数バインディングをご覧ください。

コントローラミドルウェアのサポート

<?php
namespace app\controller;
use app\middleware\MiddlewareA;
use app\middleware\MiddlewareB;
use support\Request;
class IndexController
{
    protected $middleware = [
        MiddlewareA::class,
        MiddlewareB::class,
    ];
    public function index(Request $request): string
    {
        return 'hello';
    }
}

Route::fallback()->middleware(...)が4xxリクエストにミドルウェアを追加するサポート

通常、404リクエストはどのミドルウェアも通過しませんが、バージョン1.6.0から4xxリクエストにミドルウェアを設定できるようになりました

Route::fallback(function(){
    return json(['code' => 404, 'msg' => '404 not found']);
})->middleware([
    app\middleware\MiddlewareA::class,
    app\middleware\MiddlewareB::class,
]);

Route::disableDefaultRoute()が特定のアプリケーションやコントローラのデフォルトルーティングを無効にするサポート

// 主プロジェクトのデフォルトルーティングを無効にし、アプリプラグインには影響しません
Route::disableDefaultRoute();
// 主プロジェクトのadminアプリケーションのルーティングを無効にし、アプリプラグインには影響しません
Route::disableDefaultRoute('', 'admin');
// fooプラグインのデフォルトルーティングを無効にし、主プロジェクトには影響しません
Route::disableDefaultRoute('foo');
// fooプラグインのadminアプリケーションのデフォルトルーティングを無効にし、主プロジェクトには影響しません
Route::disableDefaultRoute('foo', 'admin');
// コントローラ [\app\controller\IndexController::class, 'index'] のデフォルトルーティングを無効にします
Route::disableDefaultRoute([\app\controller\IndexController::class, 'index']);

その他の参考文書

$request->setGet(), $request->setPost(), $request->setHeader() でGET、POST、ヘッダーのデータを上書きするサポート

$request->get(); // 仮に得られるものは ['name' => 'tom', 'age' => 18]
$request->setGet(['name' => 'tom']);
$request->get(); // 最終的に得られるものは ['name' => 'tom']
// 以下も同様です
$requset->setPost();
$request->setHeaders();

その他の参考文書

view()がテンプレートパラメータや絶対パスを省略するサポート

<?php
namespace app\controller;
use support\Request;
class UserController
{
    public function hello(Request $request)
    {
        // 等価： return view('user/hello', ['name' => 'webman']);
        // 等価： return view('/app/view/user/hello', ['name' => 'webman']);
        return view(['name' => 'webman']);
    }
}

その他の設定およびファイルの変更

新しいバージョンでは、config/server.phpのlistenなどの設定がconfig/process.phpに移動しました。これはcomposer create-projectで作成された新しいプロジェクトにのみ影響し、古いプロジェクトのアップグレードには影響しません。
新しいバージョンではprocessディレクトリがapp/processに移動しました。これもcomposer create-projectで作成された新しいプロジェクトにのみ影響し、古いプロジェクトのアップグレードには影響しません。

アップグレードの注意点

以前のプロジェクトコードがあまり規範に従っていない場合、いくつかの互換性の問題が発生する可能性があります。主な問題は以下の通りです：

view()関数の使用を確認

アップグレードするプロジェクトでview()が/から始まるテンプレートパラメータを持っているか確認してください。あれば、先頭の/を削除してください。たとえば

return view('/user/index');
// これを変更する必要があります
return view('user/index');

カスタムルーティングパラメータの整合性を確認

Route::any('/user/{name}', function (Request $request, $myname) {
   return response($myname);
});
// これを変更する必要があります
Route::any('/user/{name}', function (Request $request, $name) {
   return response($name);
});

注意： $requestパラメータの前にRequest型ヒントを追加する必要があります。

composerプロキシを無効にする

阿里云などのcomposerミラー代理は遅延があり、中のパッケージのバージョンが最新でない可能性があるため、アップグレード時に問題が発生する可能性があります。以下のコマンドを実行してcomposerプロキシを削除し、再度アップグレードを行ってください。

composer config -g --unset repos.packagist