Version 4.5.0

— y2sunlight 2020-03-05

Slim に戻る

関連記事

• Slim4のインストール
• Slim4のコンセプト
• Slim4の基本的な使い方

本章は以下のサイトの Concepts のセクションを翻訳し若干の補足を加えたのもです。

• https://www.slimframework.com/docs/v4/

まず、Slim\App クラスをインスタンス化します。これはSlimアプリケーションオブジェクトです。インスタンス化の中で、Slimはアプリケーションの依存関係ごとにデフォルトのサービスを登録します。

次に、アプリケーションインスタンスの get()、post()、put()、delete()、patch()、head()、および options() ルーティングメソッドを使用してルートを定義します。これらのインスタンスメソッドは、アプリケーションのルーターオブジェクトにルートを登録します。各ルーティングメソッドは Route インスタンスを返すため、Route インスタンスのメソッドをすぐに呼び出して、ミドルウェアを追加したり、名前を割り当てたりできます。

3番目に、アプリケーションインスタンスの run() メソッドを呼び出します。このメソッドは、次のプロセスを開始します。

run() メソッドは、アプリケーションのミドルウェア・スタックを内側に横断し始めます。これは、ミドルウェア層の同心円構造で、Slimアプリケーションの実行前（および実行後）に Environment、Request、および Responseオブジェクトを受信（またはオプションで操作）します。Slimアプリケーションは、同心円状のミドルウェア構造の最内層にあります。各ミドルウェア層は、最外層から内側に向かって呼び出されていきます。

the Not Found or Not Allowed handler is invoked.

run() メソッドが最も内側のミドルウェア層に到達すると、アプリケーションのインスタンスを呼び出し、現在のHTTPリクエストを適切なアプリケーションのルート(route)オブジェクトにディスパッチします。ルート(route)がHTTPメソッドとURIに一致する場合、ルート(route)のミドルウェアと呼び出し可能(callable)オブジェクトが呼び出されます。一致するルートが見つからない場合は、NotFound または NotAllowed ハンドラーが呼び出されます。

アプリケーションのディスパッチプロセスが完了すると、各ミドルウェアレイヤーは、最も内側のレイヤーから始めて、外側に向かって制御を取り戻します。

最も外側のミドルウェア層が制御を引き渡した後、アプリケーションのインスタンスはHTTPレスポンスを準備し、シリアル化し、そして返します。HTTPレスポンスヘッダーはPHPのネイティブな header() メソッドで設定され、HTTPレスポンスボディーは現在の出力バッファーに出力されます。

Slimは、Request オブジェクトと Response オブジェクトの PSR-7 インターフェイスをサポートしています。これにより、任意のPSR-7実装を使用できるようになるので、Slimはフレキシブルなものになります。例えば、GuzzleHttp\Psr7\CachingStream のインスタンス、または GuzzleHttp\Psr7\stream_for() 関数によって返される任意のインスタンスを返すことができます。

Slimは、箱から出してすぐに機能するように、独自のPSR-7実装を提供します。但し、SlimのデフォルトのPSR-7オブジェクトをサードパーティの実装に自由に置き換えることができます。アプリケーションコンテナのrequest と response サービスをオーバーライドするだけで、それぞれ Psr\Http\Message\ServerRequestInterface と Psr\Http\Message\ResponseInterface のインスタンスが返されます。

PSR-7の邦訳はこちらにあります。

Slimアプリケーションの前後にコードを実行して、必要に応じてRequestオブジェクトとResponseオブジェクトを操作できます。これはミドルウェアと呼ばれます。なぜこれが望まれるのでしょうか？おそらく、CSRFからアプリを保護したいからでしょうか。また、アプリを実行する前にリクエストを認証したい場合もあります。ミドルウェアはこれらのシナリオに最適です。

ミドルウェアは、PSR-15 ミドルウェアインターフェイスを実装します。

1. Psr\Http\Message\ServerRequestInterface — PSR-7 リクエストオブジェクト
2. Psr\Http\Server\RequestHandlerInterface — PSR-15 リクエストハンドラオブジェクト

これらのオブジェクトを使えば、適切なことは何でもできます。唯一の難しい要件は、ミドルウェアが Psr\Http\Message\ResponseInterface のインスタンスを返さなければならないことです( MUST )。 各ミドルウェアは、次のミドルウェアをインボークして、引数としてリクエストオブジェクトとレスポンスオブジェクトを渡す必要があります( SHOULD )。

PSR-15の邦訳はここにあります。

フレームワークが異なれば、ミドルウェアの使用方法も異なります。Slimは、コアアプリケーションを囲む同心円状のレイヤーとしてミドルウェアを追加します。新しいミドルウェア層はそれぞれ、既存のミドルウェア層を囲みます。同心円構造は、ミドルウェア層が追加されると外側に拡張します。

追加された最後のミドルウェア層が最初に実行されます。

Slimアプリケーションを実行すると、Requestオブジェクトはミドルウェア構造を外側から内側に横断します。最初に最も外側のミドルウェアに入り、そして次に外側のミドルウェアに入り（というように）、最終的にSlimアプリケーション自体に到達します。Slimアプリケーションが適切なルート(route)をディスパッチした後、結果のResponseオブジェクトがSlimアプリケーションを終了し、ミドルウェア構造を内側から外に横断していきます。最後に、最終的なResponseオブジェクトは、最も外側のミドルウェアを出て、生のHTTPレスポンスにシリアル化され、HTTPクライアントに返されます。ミドルウェアのプロセスフローを示す図は次のとおりです。

ミドルウェアは、2つの引数を受け入れる呼び出し可能オブジェクト(callable)です。それは Request オブジェクトと RequestHandler オブジェクトです。各ミドルウェアは、Psr\Http\Message\ResponseInterface のインスタンスを返さなければなりません（MUST）。

このサンプルのミドルウェアはクロージャです。

<?php
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Factory\AppFactory;
use Slim\Psr7\Response;
 
require __DIR__ . '/../vendor/autoload.php';
 
$app = AppFactory::create();
 
/**
 * Example middleware closure
 *
 * @param  ServerRequest  $request PSR-7 request
 * @param  RequestHandler $handler PSR-15 request handler
 *
 * @return Response
 */
$beforeMiddleware = function (Request $request, RequestHandler $handler) {
    $response = $handler->handle($request);
    $existingContent = (string) $response->getBody();
 
    $response = new Response();
    $response->getBody()->write('BEFORE' . $existingContent);
 
    return $response;
};
 
$afterMiddleware = function ($request, $handler) {
    $response = $handler->handle($request);
    $response->getBody()->write('AFTER');
    return $response;
};
 
$app->add($beforeMiddleware);
$app->add($afterMiddleware);
 
// ...
 
$app->run();

このサンプルミドルウェアは、__invoke() マジックメソッドを実装する呼び出し可能な(invokable)クラスです。

<?php
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Psr7\Response;
 
class ExampleBeforeMiddleware
{
    /**
     * Example middleware invokable class
     *
     * @param  ServerRequest  $request PSR-7 request
     * @param  RequestHandler $handler PSR-15 request handler
     *
     * @return Response
     */
    public function __invoke(Request $request, RequestHandler $handler): Response
    {
        $response = $handler->handle($request);
        $existingContent = (string) $response->getBody();
 
        $response = new Response();
        $response->getBody()->write('BEFORE' . $existingContent);
 
        return $response;
    }
}

<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
 
class ExampleAfterMiddleware
{
    /**
     * Example middleware invokable class
     *
     * @param  ServerRequest  $request PSR-7 request
     * @param  RequestHandler $handler PSR-15 request handler
     *
     * @return Response
     */
    public function __invoke(Request $request, RequestHandler $handler): Response
    {
        $response = $handler->handle($request);
        $response->getBody()->write('AFTER');
        return $response;
    }
}

これらのクラスをミドルウェアとして使用するには、 $app のルートマッピングメソッド get()、post()、put()、patch()、delete()、options()、any()、または group()の後に 関数チェーンとして　add(new ExampleMiddleware()); を使用でき、以下のコードでは、これらの内の一つを含んでいます。

<?php
use Slim\Factory\AppFactory;
 
require __DIR__ . '/../vendor/autoload.php';
 
$app = AppFactory::create();
 
// Add Middleware On App
$app->add(new ExampleMiddleware());
 
// Add Middleware On Route
$app->get('/', function () { ... })->add(new ExampleMiddleware());
 
// Add Middleware On Group
$app->group('/', function () { ... })->add(new ExampleMiddleware());
 
// ...
 
$app->run();

ミドルウェアは、全てのSlimアプリケーション、個別のSlimアプリケーションルート、またはルートグループに追加できます。全てのシナリオは同じミドルウェアを受け入れ、同じミドルウェアインターフェースを実装します。

アプリケーションミドルウェアは、全ての着信HTTPリクエストに対してインボークされます。Slimアプリケーションインスタンスの add() メソッドを使用してアプリケーションミドルウェアを追加します。この例では、上記のクロージャミドルウェアの例を追加します。

<?php
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Factory\AppFactory;
use Slim\Psr7\Response;
 
require __DIR__ . '/../vendor/autoload.php';
 
$app = AppFactory::create();
 
$app->add(function (Request $request, RequestHandler $handler) {
    $response = $handler->handle($request);
    $existingContent = (string) $response->getBody();
 
    $response = new Response();
    $response->getBody()->write('BEFORE ' . $existingContent);
 
    return $response;
});
 
$app->add(function (Request $request, RequestHandler $handler) {
    $response = $handler->handle($request);
    $response->getBody()->write(' AFTER');
    return $response;
});
 
$app->get('/', function (Request $request, Response $response, $args) {
    $response->getBody()->write('Hello World');
    return $response;
});
 
$app->run();

これにより、次のHTTP応答本文が出力されます：

BEFORE Hello World AFTER

Add middleware to a Route with the Route instance’s add() method. This example adds the Closure middleware example above:

ルートミドルウェアは、そのルートが現在のHTTPリクエストメソッドとURIに一致する場合にのみインボークされます。ルートミドルウェアは、Slimアプリケーションのルーティングメソッド（get() や post() など）を呼び出した直後に指定されます。各ルーティングメソッドは \Slim\Route のインスタンスを返し、このクラスはSlimアプリケーションインスタンスと同じミドルウェアインターフェイスを提供します。Route インスタンスの add() メソッドを使用して、ミドルウェアを Route に追加します。この例では、上記のクロージャミドルウェアの例を追加します。

<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Factory\AppFactory;
 
require __DIR__ . '/../vendor/autoload.php';
 
$app = AppFactory::create();
 
$mw = function (Request $request, RequestHandler $handler) {
    $response = $handler->handle($request);
    $response->getBody()->write('World');
 
    return $response;
};
 
$app->get('/', function (Request $request, Response $response, $args) {
    $response->getBody()->write('Hello ');
 
    return $response;
})->add($mw);
 
$app->run();

This would output this HTTP response body:

これにより、次のHTTP応答本文が出力されます。

Hello World

In addition to the overall application, and standard routes being able to accept middleware, the group() multi-route definition functionality, also allows individual routes internally. Route group middleware is invoked only if its route matches one of the defined HTTP request methods and URIs from the group. To add middleware within the callback, and entire-group middleware to be set by chaining add() after the group() method.

アプリケーション全体、およびミドルウェアを受け入れることができる標準ルートに加えて、group（）マルチルート定義機能は、内部で個々のルートも許可します。 ルートグループミドルウェアは、そのルートがグループから定義されたHTTP要求メソッドおよびURIの1つと一致する場合にのみ呼び出されます。 コールバック内にミドルウェアを追加し、group（）メソッドの後にadd（）をチェーンすることによって設定されるグループ全体のミドルウェア。

Sample Application, making use of callback middleware on a group of url-handlers

URLハンドラーのグループでコールバックミドルウェアを利用するサンプルアプリケーション

<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Factory\AppFactory;
use Slim\Routing\RouteCollectorProxy;
 
require __DIR__ . '/../vendor/autoload.php';
 
$app = AppFactory::create();
 
$app->get('/', function (Request $request, Response $response) {
    $response->getBody()->write('Hello World');
    return $response;
});
 
$app->group('/utils', function (RouteCollectorProxy $group) {
    $group->get('/date', function (Request $request, Response $response) {
        $response->getBody()->write(date('Y-m-d H:i:s'));
        return $response;
    });
 
    $group->get('/time', function (Request $request, Response $response) {
        $response->getBody()->write((string)time());
        return $response;
    });
})->add(function (Request $request, RequestHandler $handler) use ($app) {
    $response = $handler->handle($request);
    $dateOrTime = (string) $response->getBody();
 
    $response = $app->getResponseFactory()->createResponse();
    $response->getBody()->write('It is now ' . $dateOrTime . '. Enjoy!');
 
    return $response;
});
 
$app->run();

When calling the /utils/date method, this would output a string similar to the below

/ utils / dateメソッドを呼び出すと、次のような文字列が出力されます。

It is now 2015-07-06 03:11:01. Enjoy!

Visiting /utils/time would output a string similar to the below

/ utils / timeにアクセスすると、次のような文字列が出力されます。

It is now 1436148762. Enjoy!

But visiting / (domain-root), would be expected to generate the following output as no middleware has been assigned

ただし、/（domain-root）にアクセスすると、ミドルウェアが割り当てられていないため、次の出力が生成されると予想されます。

Hello World

The easiest way to pass attributes from middleware is to use the request’s attributes.

ミドルウェアから属性を渡す最も簡単な方法は、リクエストの属性を使用することです。

Setting the variable in the middleware:

ミドルウェアでの変数の設定：

$request = $request->withAttribute('foo', 'bar');

Getting the variable in the route callback:

ルートコールバックで変数を取得する：

$foo = $request->getAttribute('foo');

要求を満たすPSR-15ミドルウェアクラスがすでに作成されている場合があります。検索する非公式のリストをいくつか示します。

• Middleware for Slim Framework v4.x wiki
• middlewares/awesome-psr15-middlewares

TODO