ミドルウェア (Slim\Middleware)

Slim\Middleware 名前空間は、Slim 4 に標準同梱されている 6 つの PSR-15（Psr\Http\Server\MiddlewareInterface）ミドルウェア実装を提供します：RoutingMiddleware、ErrorMiddleware、BodyParsingMiddleware、ContentLengthMiddleware、MethodOverrideMiddleware、および OutputBufferingMiddleware。Slim の MiddlewareDispatcher はミドルウェアを同心円状の LIFO（後入れ先出し）オニオン構造でラップするため、最後に追加（$app->add()）されたミドルウェアが、受信リクエストに対して最初に実行されます。

from drawlib.canvas import save, setup
from drawlib.lines import line
from drawlib.shapes import rectangle
from drawlib.styles import Styles
from drawlib.text import text

setup(width=180, height=82)

# Outer frame label
text(
    (90, 75),
    "受信 ServerRequestInterface  --->  同心円 PSR-15 ミドルウェアスタック  --->  RouteRunner",
    style=Styles.PrimaryBold.patch(text_size=11.5),
)

# Top Row (Outer to Mid-Layer)
rectangle(
    (31, 53),
    width=46,
    height=18,
    style=Styles.AccentFlat.patch(shape_r=2.5),
)
text((31, 57.5), "1. ErrorMiddleware", style=Styles.WhiteBold.patch(text_size=11.0))
text((31, 52.0), "最外殻 try / catch", style=Styles.White.patch(text_size=10.0))
text((31, 47.0), "最後に追加 (app->add)", style=Styles.White.patch(text_size=9.5))

rectangle(
    (90, 53),
    width=46,
    height=18,
    style=Styles.Neutral.patch(shape_r=2.5),
)
text((90, 57.5), "2. ContentLength", style=Styles.BlackBold.patch(text_size=11.0))
text((90, 52.0), "& OutputBuffering", style=Styles.Dark.patch(text_size=10.0))
text((90, 47.0), "出力バッファ・サイズ計算", style=Styles.Dark.patch(text_size=9.5))

rectangle(
    (149, 53),
    width=46,
    height=18,
    style=Styles.PrimaryNeutral.patch(shape_r=2.5),
)
text((149, 57.5), "3. BodyParsing", style=Styles.BlackBold.patch(text_size=11.0))
text((149, 52.0), "JSON / XML / Form 解析", style=Styles.Dark.patch(text_size=10.0))
text((149, 47.0), "withParsedBody()", style=Styles.Dark.patch(text_size=9.5))

# Bottom Row (Inner Layers to Kernel)
rectangle(
    (149, 20),
    width=46,
    height=18,
    style=Styles.SecondaryNeutral.patch(shape_r=2.5),
)
text((149, 24.5), "4. MethodOverride", style=Styles.BlackBold.patch(text_size=11.0))
text((149, 19.0), "ヘッダ / POST _METHOD", style=Styles.Dark.patch(text_size=10.0))
text((149, 14.0), "withMethod()", style=Styles.Dark.patch(text_size=9.5))

rectangle(
    (90, 20),
    width=46,
    height=18,
    style=Styles.PrimaryFlat.patch(shape_r=2.5),
)
text((90, 24.5), "5. RoutingMiddleware", style=Styles.WhiteBold.patch(text_size=11.0))
text((90, 19.0), "FastRoute マッチング", style=Styles.White.patch(text_size=10.0))
text((90, 14.0), "RouteContext 属性を付与", style=Styles.White.patch(text_size=9.5))

rectangle(
    (31, 20),
    width=46,
    height=18,
    style=Styles.Neutral.patch(shape_r=2.5),
)
text((31, 24.5), "6. RouteRunner", style=Styles.BlackBold.patch(text_size=11.0))
text((31, 19.0), "グループ・ルート MW 実行", style=Styles.Dark.patch(text_size=10.0))
text((31, 14.0), "Route::run(request)", style=Styles.Dark.patch(text_size=9.5))

# Arrows connecting 1 -> 2 -> 3 -> 4 -> 5 -> 6
line((54, 53), (67, 53), arrow_head="->", style=Styles.PrimaryBold)
line((113, 53), (126, 53), arrow_head="->", style=Styles.PrimaryBold)
line((149, 44), (149, 29), arrow_head="->", style=Styles.PrimaryBold)
line((126, 20), (113, 20), arrow_head="->", style=Styles.PrimaryBold)
line((67, 20), (54, 20), arrow_head="->", style=Styles.PrimaryBold)

save()

classSlim\Middleware\RoutingMiddleware#

• ソースファイル: Slim/Middleware/RoutingMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

RoutingMiddleware は、後続のミドルウェアや RouteRunner に到達する前に RouteResolverInterface を通じて FastRoute による URI・HTTP メソッドのマッチングを実行します。ServerRequestInterface に RouteContext::ROUTE_PARSER、RouteContext::ROUTING_RESULTS、および RouteContext::ROUTE 属性を設定し、マッチしなかった場合は HttpNotFoundException または HttpMethodNotAllowedException をスローします。

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use RuntimeException;
use Slim\Exception\HttpMethodNotAllowedException;
use Slim\Exception\HttpNotFoundException;
use Slim\Interfaces\RouteParserInterface;
use Slim\Interfaces\RouteResolverInterface;
use Slim\Routing\RoutingResults;

class RoutingMiddleware implements MiddlewareInterface
{
    protected RouteResolverInterface $routeResolver;
    protected RouteParserInterface $routeParser;

    public function __construct(
        RouteResolverInterface $routeResolver,
        RouteParserInterface $routeParser
    );

    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;

    public function performRouting(ServerRequestInterface $request): ServerRequestInterface;

    protected function resolveRoutingResultsFromRequest(
        ServerRequestInterface $request
    ): RoutingResults;
}

プロパティ#

メソッドとパラメータ#

使用例#

use Slim\Factory\AppFactory;

$app = AppFactory::create();

// ErrorMiddleware より前（内側）に RoutingMiddleware を登録:
$app->addRoutingMiddleware();

// addRoutingMiddleware() より前に add() されたミドルウェアからは RouteContext を参照可能:
$app->addErrorMiddleware(true, true, true);

classSlim\Middleware\ErrorMiddleware#

• ソースファイル: Slim/Middleware/ErrorMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

ErrorMiddleware は後続のリクエストハンドラ実行を try / catch (Throwable $e) で囲み、捕捉した例外や PHP エラーを例外型ごとにマッピングされた ErrorHandlerInterface またはカスタムエラーハンドラへ委譲します。捕捉した例外が HttpException のサブクラスである場合、$exception->getRequest() から最新のリクエストオブジェクトを取り出すため、パイプライン内部で付与されたルーティング属性などをエラーレンダラ側でも参照できます。

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Psr\Log\LoggerInterface;
use Slim\Handlers\ErrorHandler;
use Slim\Interfaces\CallableResolverInterface;
use Slim\Interfaces\ErrorHandlerInterface;
use Throwable;

/** @api */
class ErrorMiddleware implements MiddlewareInterface
{
    protected CallableResolverInterface $callableResolver;
    protected ResponseFactoryInterface $responseFactory;
    protected bool $displayErrorDetails;
    protected bool $logErrors;
    protected bool $logErrorDetails;
    protected ?LoggerInterface $logger = null;
    protected array $handlers = [];
    protected array $subClassHandlers = [];
    protected $defaultErrorHandler;

    public function __construct(
        CallableResolverInterface $callableResolver,
        ResponseFactoryInterface $responseFactory,
        bool $displayErrorDetails,
        bool $logErrors,
        bool $logErrorDetails,
        ?LoggerInterface $logger = null
    );

    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;

    public function handleException(
        ServerRequestInterface $request,
        Throwable $exception
    ): ResponseInterface;

    public function getErrorHandler(string $type);
    public function getDefaultErrorHandler();
    public function setDefaultErrorHandler($handler): self;
    public function setErrorHandler(
        $typeOrTypes,
        $handler,
        bool $handleSubclasses = false
    ): self;
}

プロパティ#

メソッドとパラメータ#

使用例#

use DomainException;
use Slim\Factory\AppFactory;

$app = AppFactory::create();
$errorMiddleware = $app->addErrorMiddleware(false, true, true, $logger);

// DomainException およびその全サブクラスに対するカスタムハンドラを登録
$errorMiddleware->setErrorHandler(
    DomainException::class,
    CustomDomainErrorHandler::class,
    true
);

// デフォルト ErrorHandler の出力形式を JSON に固定
$defaultHandler = $errorMiddleware->getDefaultErrorHandler();
$defaultHandler->forceContentType('application/json');

classSlim\Middleware\BodyParsingMiddleware#

• ソースファイル: Slim/Middleware/BodyParsingMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

BodyParsingMiddleware は、$request->getParsedBody() が空の場合に受信リクエストの Content-Type ヘッダを検査し、メディアタイプ別のパーサレジストリを用いてリクエストボディストリームを解析し、$request->withParsedBody($parsedBody) で新しいリクエストインスタンスを生成して後続へ渡します。標準で application/json、application/x-www-form-urlencoded、application/xml、text/xml の 4 種類のパーサを備えるほか、RFC 6839 の構造化構文サフィックス（+json、+xml など）へのフォールバック解決も自動的に行います。

from drawlib.canvas import save, setup
from drawlib.lines import line
from drawlib.shapes import rectangle
from drawlib.styles import Styles
from drawlib.text import text

setup(width=180, height=84)

# Left Panel: ErrorMiddleware
rectangle(
    (46, 42),
    width=80,
    height=74,
    style=Styles.Neutral.patch(shape_r=3.0),
)
text((46, 73.5), "ErrorMiddleware::getErrorHandler()", style=Styles.PrimaryBold.patch(text_size=11.5))

rectangle(
    (46, 59),
    width=66,
    height=12,
    style=Styles.PrimaryFlat.patch(shape_r=2.0),
)
text((46, 61.5), "1. クラス名の完全一致", style=Styles.WhiteBold.patch(text_size=11.0))
text((46, 56.5), "handlers[type] の直接検索", style=Styles.White.patch(text_size=10.0))

rectangle(
    (46, 40),
    width=66,
    height=12,
    style=Styles.PrimaryNeutral.patch(shape_r=2.0),
)
text((46, 42.5), "2. サブクラス一致", style=Styles.BlackBold.patch(text_size=11.0))
text((46, 37.5), "is_subclass_of(type, class)", style=Styles.Dark.patch(text_size=10.0))

rectangle(
    (46, 21),
    width=66,
    height=12,
    style=Styles.SecondaryNeutral.patch(shape_r=2.0),
)
text((46, 23.5), "3. デフォルト ErrorHandler", style=Styles.BlackBold.patch(text_size=11.0))
text((46, 18.5), "getDefaultErrorHandler()", style=Styles.Dark.patch(text_size=10.0))

line((46, 53), (46, 46), arrow_head="->", style=Styles.PrimaryBold)
line((46, 34), (46, 27), arrow_head="->", style=Styles.PrimaryBold)

# Right Panel: BodyParsingMiddleware
rectangle(
    (134, 42),
    width=80,
    height=74,
    style=Styles.PrimaryNeutral.patch(shape_r=3.0),
)
text((134, 73.5), "BodyParsingMiddleware::parseBody()", style=Styles.PrimaryBold.patch(text_size=11.5))

rectangle(
    (134, 59),
    width=66,
    height=12,
    style=Styles.AccentFlat.patch(shape_r=2.0),
)
text((134, 61.5), "1. メディアタイプ完全一致", style=Styles.WhiteBold.patch(text_size=11.0))
text((134, 56.5), "json / form-urlencoded / xml", style=Styles.White.patch(text_size=10.0))

rectangle(
    (134, 40),
    width=66,
    height=12,
    style=Styles.SecondaryNeutral.patch(shape_r=2.0),
)
text((134, 42.5), "2. RFC 6839 +サフィックス解決", style=Styles.BlackBold.patch(text_size=11.0))
text((134, 37.5), "vnd.api+json -> application/json", style=Styles.Dark.patch(text_size=9.5))

rectangle(
    (134, 21),
    width=66,
    height=12,
    style=Styles.Neutral.patch(shape_r=2.0),
)
text((134, 23.5), "3. 型検証とリクエストへの付与", style=Styles.BlackBold.patch(text_size=11.0))
text((134, 18.5), "array | object | null -> Request", style=Styles.Dark.patch(text_size=10.0))

line((134, 53), (134, 46), arrow_head="->", style=Styles.PrimaryBold)
line((134, 34), (134, 27), arrow_head="->", style=Styles.PrimaryBold)

save()

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use RuntimeException;

/** @api */
class BodyParsingMiddleware implements MiddlewareInterface
{
    /** @var callable[] */
    protected array $bodyParsers;

    /**
     * @param callable[] $bodyParsers
     */
    public function __construct(array $bodyParsers = []);

    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;

    public function registerBodyParser(string $mediaType, callable $callable): self;
    public function hasBodyParser(string $mediaType): bool;
    public function getBodyParser(string $mediaType): callable;

    protected function registerDefaultBodyParsers(): void;
    protected function parseBody(ServerRequestInterface $request);
    protected function getMediaType(ServerRequestInterface $request): ?string;
    protected static function disableXmlEntityLoader(bool $disable): bool;
}

プロパティと標準パーサ#

メソッドとパラメータ#

使用例#

use Slim\Factory\AppFactory;

$app = AppFactory::create();

// App ヘルパー経由で BodyParsingMiddleware を登録:
$bodyParsingMiddleware = $app->addBodyParsingMiddleware();

// カスタム YAML ボディパーサを追加登録:
$bodyParsingMiddleware->registerBodyParser('application/x-yaml', function (string $input) {
    $parsed = yaml_parse($input);
    return is_array($parsed) ? $parsed : null;
});

classSlim\Middleware\ContentLengthMiddleware#

• ソースファイル: Slim/Middleware/ContentLengthMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

ContentLengthMiddleware は、後続ハンドラ（$handler->handle($request)）から返された ResponseInterface のボディサイズ（$response->getBody()->getSize()）を検査し、サイズが取得可能かつ Content-Length ヘッダが未設定の場合に自動的に Content-Length ヘッダを付与する後処理ミドルウェアです。

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

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

/** @api */
class ContentLengthMiddleware implements MiddlewareInterface
{
    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;
}

メソッドとパラメータ#

使用例#

use Slim\Factory\AppFactory;
use Slim\Middleware\ContentLengthMiddleware;

$app = AppFactory::create();

// すべてのレスポンスに Content-Length を付与するためスタックの外側に追加:
$app->add(new ContentLengthMiddleware());

classSlim\Middleware\MethodOverrideMiddleware#

• ソースファイル: Slim/Middleware/MethodOverrideMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

MethodOverrideMiddleware は、HTML フォームや制限付き HTTP クライアントから POST リクエストやカスタムヘッダ経由で PUT、PATCH、DELETE などの HTTP メソッドをトンネリングできるようにするミドルウェアです。まず X-Http-Method-Override リクエストヘッダを確認し、ヘッダが存在せずリクエストメソッドが POST の場合は $request->getParsedBody()['_METHOD'] を参照して $request->withMethod() でメソッドを上書きします（ボディストリームが EOF に達している場合は rewind() します）。

[!IMPORTANT] application/x-www-form-urlencoded や application/json の POST ボディに含まれる _METHOD パラメータを使用する場合、実行順序が BodyParsingMiddleware -> MethodOverrideMiddleware -> RoutingMiddleware となる必要があります。Slim のミドルウェアスタックは LIFO（後入れ先出し）であるため、コード上の登録順序は逆順（addRoutingMiddleware() -> add(MethodOverrideMiddleware) -> addBodyParsingMiddleware()）にしてください。

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

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

/** @api */
class MethodOverrideMiddleware implements MiddlewareInterface
{
    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;
}

メソッドとパラメータ#

使用例#

use Slim\Factory\AppFactory;
use Slim\Middleware\MethodOverrideMiddleware;

$app = AppFactory::create();

// LIFO 登録順序:
// 1. RoutingMiddleware（3番目に実行：上書き後のメソッドでルート判定）
$app->addRoutingMiddleware();

// 2. MethodOverrideMiddleware（2番目に実行：パース済み _METHOD またはヘッダを参照）
$app->add(new MethodOverrideMiddleware());

// 3. BodyParsingMiddleware（1番目に実行：POST ボディをパース）
$app->addBodyParsingMiddleware();

classSlim\Middleware\OutputBufferingMiddleware#

• ソースファイル: Slim/Middleware/OutputBufferingMiddleware.php
• 名前空間: Slim\Middleware
• 実装インターフェース: Psr\Http\Server\MiddlewareInterface

OutputBufferingMiddleware は、後続のミドルウェアやルートハンドラ実行中に echo、print、var_dump などで直接標準出力へ書き出された出力を ob_start() と ob_get_clean() でキャプチャし、PSR-7 ResponseInterface のボディ末尾（APPEND）または先頭（PREPEND）に結合します。後続処理で例外がスローされた場合は ob_end_clean() で安全にバッファを破棄してから例外を再スローします。

クラスシグネチャ#

<?php

declare(strict_types=1);

namespace Slim\Middleware;

use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Throwable;

/** @api */
class OutputBufferingMiddleware implements MiddlewareInterface
{
    public const APPEND = 'append';
    public const PREPEND = 'prepend';

    protected StreamFactoryInterface $streamFactory;
    protected string $style;

    public function __construct(
        StreamFactoryInterface $streamFactory,
        string $style = 'append'
    );

    public function process(
        ServerRequestInterface $request,
        RequestHandlerInterface $handler
    ): ResponseInterface;
}

定数とプロパティ#

メソッドとパラメータ#

使用例#

use Slim\Factory\AppFactory;
use Slim\Middleware\OutputBufferingMiddleware;
use Slim\Psr7\Factory\StreamFactory;

$app = AppFactory::create();

$streamFactory = new StreamFactory();
$app->add(new OutputBufferingMiddleware($streamFactory, OutputBufferingMiddleware::APPEND));