質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.64%

SlimFramework 3のミドルウェアでリクエスト, レスポンスを書き換えたい

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 2,216

k725

score 10

前提・実現したいこと

Slimにてウェブアプリを書いています。
Slimのミドルウェアにてレスポンスを書き換えたいです。

  1. リクエスト(CSV)
  2. ミドルウェア(CSV to JSON)
  3. ルータ/モデル(JSONを操作)
  4. ミドルウェア(JSON to CSV)
  5. レスポンス(CSV)

なお下記クラスはグループルータに add(new HogeMiddleware); してあります

ソースコード

namespace app\mw;
namespace app\helper;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;

class HogeMiddleware {
    function __invoke(Request $request, Response $response, $next) {
        if (helper::isCSV($request->getBody()->getContents())) {
            $csv = helper::toJSON($request->getBody()->getContents());

            // リクエストを書き換えたい
        }

        $response = $next($request, $response);

        if (helper::isJSON($response->getBody()->getContents())) {
            $json = helper::toCSV($response->getBody()->getContents());

            // レスポンスを書き換えたい
        }

        return $response;
    }
}

試したこと

他の人が作成したSlimのミドルウェアを見てみましたが、リクエストやレスポンスを書き換えているコードが無く困っています。

補足情報(言語/FW/ツール等のバージョンなど)

  • Slim 3.4.1
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

こんな感じでしょうか。
テストしてはいませんが、恐らく動くと思います。

namespace app\mw;
namespace app\helper;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Slim\Http\Body; // 追加

class HogeMiddleware {
    // コードの動作とは無関係だが、アクセス修飾子 public を明記
    // 見間違えなどがあるかもしれないので、どちらかといえば書いたほうが良い
    // ただし、(publicの場合は)省略しても動作に影響はない
    public function __invoke(Request $request, Response $response, $next) {
        if (helper::isCSV($request->getBody()->getContents())) {
            $csv = helper::toJSON($request->getBody()->getContents());

            /*
             * リクエストを書き換え
             *
             * @see https://github.com/slimphp/Slim/blob/3.x/Slim/Handlers/NotFound.php#L54-L59
             * @see https://github.com/slimphp/Slim/blob/3.x/Slim/Http/RequestBody.php#L21
             */
            $body = new Body(fopen('php://temp', 'w+'));
            $body->write($csv);
            $request = $request->withBody($body);
        }

        $response = $next($request, $response);

        if (helper::isJSON($response->getBody()->getContents())) {
            $json = helper::toCSV($response->getBody()->getContents());

            /*
             * レスポンスを書き換え
             *
             * @see https://github.com/slimphp/Slim/blob/3.x/Slim/Handlers/NotFound.php#L54-L59
             * @see https://github.com/slimphp/Slim/blob/3.x/Slim/Http/Response.php#L127
             */
            $body = new Body(fopen('php://temp', 'r+'));
            $body->write($json);
            $response = $response->withBody($body);
        }

        return $response;
    }
}

リクエストやレスポンスのbodyを取得するためにはgetBodyメソッドを使いますが、書き換える場合はwithBodyメソッドを使います。

このメソッドの引数には、文字列ではなくStreamInterfaceのインスタンスを指定しなくてはなりません。
SlimではこれをSlim\Http\Bodyクラスで提供しているため、このクラスを引数に指定すればbodyを書き換えられます。
が、このSlim\Http\Bodyクラスも引数に文字列ではなくPHPのストリームを指定し、肝心のbodyはwriteメソッドで書き込む必要があるため、少々ややこしい事になっています。


SlimのSlim/Handlers/NotFound.phpでは、レスポンスの書き換えをおこなうコードを以下のように実装しています。
変数$outputに、レスポンスのbodyを上書きする文字列が格納されています。

$body = new Body(fopen('php://temp', 'r+'));
$body->write($output);
return $response->withStatus(404)
                ->withHeader('Content-Type', $contentType)
                ->withBody($body);

このコードを簡単に説明すると、fopen('php://temp', 'r+')でストリームを生成してSlim\Http\Bodyクラスの引数に渡した後、
writeメソッドで変数$outputの内容をbodyとして書き込んでいます。
レスポンスのbodyの書き換えはこれをパクりました。

$body = new Body(fopen('php://temp', 'r+'));
$body->write($json);
$response = $response->withBody($body);

リクエストの場合も、withBodyメソッドを利用する点は変わりません。
多分、レスポンスの場合と同じコードで動作するハズです。

…が、この回答では一応のため、Slimがリクエストのbodyを生成している内部処理と同じコードにしました。
レスポンスのコードと異なるのは、fopen関数の第二引数の値です。'r+'から'w+'に変更しています。

$body = new Body(fopen('php://temp', 'w+'));
$body->write($csv);
$request = $request->withBody($body);

(ストリームとして使うなら、r+w+も変わらないと思いますが、ストリーム関係の動作にはあまり詳しくないので、確証を持って「r+w+も同じだ」と言い切ることが出来ません…)


なお、肝心なことですが、Slimが採用しているPSR-7ServerRequestInterfaceResponseInterfaceは不変オブジェクトです。
StreamInterfacegetBodyメソッドで取得できるオブジェクト)を除き、メソッドを実行しただけではオブジェクトそのものの状態(オブジェクトの値)が変化せず、そのメソッドの返り値である「状態が変化したオブジェクト」を利用しなくてはなりません。

このため、withBodyなどのメソッドが返す値のオブジェクトを次に渡す必要があります。
このコードでは以下のように変数に再代入して次に渡しています。
誤って再代入を忘れると、bodyが上書きされません

// 正しい記述
$response = $response->withBody($body);

// 間違えてこうするとbodyが変わらない
$response->withBody($body);

詳細は以下をどうぞ。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/06/03 23:02

    ありがとうございます!無事解決しました

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.64%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる