HyperfにおけるCORS対策の実装方法

HyperfフレームワークでCORSを適切に処理するための4つのアプローチについて説明します。Laravelと類似した構造を持つHyperfですが、Swooleのコルーチン機能を活用することで柔軟な開発が可能です。

方法1:カスタムミドルウェアの作成

公式ドキュメントに記載されている方法を拡張し、OPTIONSリクエストの処理を追加します。


declare(strict_types=1);

namespace App\Middleware;

use Hyperf\Context\Context;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class CorsMiddleware implements MiddlewareInterface
{
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $res = Context::get(ResponseInterface::class);
        $res = $res->withHeader('Access-Control-Allow-Origin', '*')
            ->withHeader('Access-Control-Allow-Credentials', 'true')
            ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
            ->withHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');

        Context::set(ResponseInterface::class, $res);

        if ($request->getMethod() === 'OPTIONS') {
            return $res->withStatus(204)->withBody(new SwooleStream(''));
        }

        return $handler->handle($request);
    }
}

config/autoload/middlewares.phpにミドルウェアを登録してください。

方法2:Nginxによるグローバル設定


location / {
    add_header Access-Control-Allow-Origin * always;
    add_header Access-Control-Allow-Methods "GET, POST, OPTIONS" always;
    add_header Access-Control-Allow-Headers "Content-Type, Authorization" always;

    if ($request_method = OPTIONS) {
        return 204;
    }
}

方法3:例外ハンドラのカスタマイズ

HttpExceptionHandlerをカスタマイズしてCORSヘッダを追加します。


namespace App\Exception\Handler;

use Hyperf\Context\Context;
use Hyperf\HttpMessage\Exception\HttpException;
use Hyperf\HttpMessage\Stream\SwooleStream;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;

class HttpExceptionHandler extends ExceptionHandler
{
    public function handle(Throwable $throwable, ResponseInterface $response)
    {
        $request = Context::get(ServerRequestInterface::class);
        if ($request->getMethod() === 'OPTIONS') {
            return $response->withHeader('Access-Control-Allow-Origin', '*')
                ->withHeader('Access-Control-Allow-Methods', 'POST, GET, OPTIONS')
                ->withStatus(204);
        }

        return parent::handle($throwable, $response);
    }
}

方法4:ルート定義の変更


Router::addRoute(['OPTIONS', 'POST'], '/api/login', [LoginController::class, 'login']);

複数のHTTPメソッドを一度に指定できるため、ミドルウェアと併用することで効果的です。

タグ: Hyperf CORS Swoole ミドルウェア 例外処理

8月4日 04:30 投稿