LaravelのDebugbarにおいてJSONレスポンスのUnicodeエスケープを無効にできない

Question

問題

middlewareでHTTPリクエストの前後に処理を入れる
JSONレスポンスのUnicodeエスケープ無効化はミドルウェアで！

LaravelのDebugbarでデータベースのデータの一覧表示をロギングすると、日本語の部分が文字コードで表示されるので、上記2つの記事を参考にミドルウェアでUnicodeエスケープを無効にしようとしているのですがうまく行かない。

コード

コントローラー

<?php

namespace App\Http\Controllers;

use App\UserModel;
use App\Http\Requests\UserModelRequest;
use Illuminate\Http\Request;


class UserModelController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    
    // 一覧表示
    public function index() {


        $usermodels = UserModel::all();
        \Debugbar::info('$usermodels='.$usermodels); // デバックバーのロギング
        return view('usermodel.index', compact('usermodels'));
    }

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    
    /*1件のデータを新規作成。本来は必要がない（WebAPIにおいて、画面に登録フォームを表示する画面はいらないから）。
    storeメソッドとセット。
    */
    public function create() {

        return view('usermodel.create');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    
    // createメソッドで飛ばされた先の実際の処理
    public function store(UserModelRequest $request) {
        $usermodel = new UserModel;

        // フォームから受け取った値をすべて格納する
        $form = $request->all();

        // fill()->save();でフォームから受け取った値をもとに複数のカラムの値を更新・追加しセーブする。
        // UserModelのprotect $fillableの項目も参照。
        unset($form['_token']);
        $usermodel->fill($form)->save();

        return redirect('usermodel/' . $usermodel->id);

    }

    /**
     * Display the specified resource.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    
     /*
    レコード表示。indexと違ってidで紐つけて1件ずつ表示する。
    テスト用としてviewはつくらず、返された連想配列を単に表示するだけにしている。
     */
    public function show(UserModel $usermodel)
    {
        \Debugbar::info('$usermodel='.$usermodel);
         return view('usermodel.show', compact('usermodel'));
         // オブジェクトを単なる連想配列として返すだけ。
         // return $usermodels->toArray();
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    
    // 更新処理。updateメソッドとセット
    
    // モデル結合ルート、引数にコントローラー名とその変数をいれるとFindorFail()を含めた一連の処理を書かなくて済む。
    public function edit(UserModel $usermodel) {
       return view('usermodel/edit', compact('usermodel'));
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    
    // 更新処理
    public function update(UserModelRequest $request, UserModel $usermodel)
    {
        // 更新するカラムの数だけインスタンスにアクセスする。
        $usermodel->user_name = $request->user_name;
        $usermodel->email = $request->email;
        $usermodel->save();
        return redirect('usermodel/'.$usermodel->id);
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    
    // 削除処理
    public function destroy(UserModel $usermodel) {
        $usermodel->delete();
        return redirect('usermodel');
    }
}

使いたいミドルウェア

<?php

/*
JSONレスポンスのUnicodeエスケープを無効化する。実装時にはデバッグモードのみで使用できるようにする。
 */

namespace App\Http\Middleware;

use Symfony\Component\HttpFoundation\JsonResponse;

class UnescapeJsonResponse {
    /**
     * @param  \Illuminate\Http\Request $request
     * @param  \Closure $next
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function handle($request, \Closure $next)
    {
        $response = $next($request);

        // JSON以外はそのまま
        if (!$response instanceof JsonResponse) {
            return $response;
        }

        // エンコードオプションを追加して設定し直す
        $newEncodingOptions = $response->getEncodingOptions() | JSON_UNESCAPED_UNICODE;
        $response->setEncodingOptions($newEncodingOptions);

        return $response;
    }
}

カーネル

protected $middleware = [
        \App\Http\Middleware\TrustProxies::class,
        \App\Http\Middleware\CheckForMaintenanceMode::class,
        \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
        \App\Http\Middleware\TrimStrings::class,
        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
        \App\Http\Middleware\UnescapeJsonResponse::class,
    ];

試したこと

冒頭記事の1つ目の記事でのmiddleware定義の項。
カーネルに直接書く場合はエラーは出ないが、Unicodeエスケープがそのままでミドルウェアが反映されていない。
ルーティングの場合はartisanのRoute:listで定義は確認はできるものの、リクエストするとTarget class does not existのエラーが出る。
コントローラーに直接コンストラクタメソッドを使う場合も上に同様。

エラーの内容的にクラス名の誤字かと思い、自分で何度か確認したものの見つからなかったのでもしスペルミス等または他の原因がありましたらご指摘いただけると助かります。

Comments

[mix-peach]

やりたいことは、UserModelController@indexの、
\Debugbar::info('$usermodels='.$usermodels); // デバックバーのロギング
これで、デバッグバーに表示されるデータをUnicodeエスケープしたくない、ってことですか？？

[kamille-mio]

返信ありがとうございます。

質問した時点では、テーブルから取得してきたデータのうち日本語だけが文字コードでデバックバーに表示されていたので、検索してみたらUnicodeエスケープできていないのではということで冒頭の記事のうち2つ目の記事にたどり着いたという次第なのでそういうことになります。
ですが、その記事の筆者さんから返信がありまして全く別の問題であったということが判明したので問題は解決しました。
当方、まだまだプログラミング歴が浅いのでそこから沼にハマってしまったみたいでお恥ずかしい限りです。
解決方法に経緯を書くので、よろしければ拝見していただけると幸いです。

Answer 1

JSONレスポンスのUnicodeエスケープ無効化はミドルウェアで！

冒頭で引用させて頂いた記事の筆者様から返信を頂けて、無事に解決しました。
引用させていただくと

元の質問も拝見しましたが、これはJSONレスポンスとは全く関係のない問題のようです。

$usermodelsはIlluminate\Support\Collectionクラスのオブジェクトになっており、
'$usermodels=' . $usermodels のように文字列と結合しようした時点でCollection::__toString()が呼ばれます。Collection::__toString()は内部的にCollection::toJson()を呼び出しているため、\Debugbar::info()に渡す引数の時点で既にJSON文字列となってしまっています。
\Debugbar::info(['usermodels' => $usermodels->toArray()]);
などと配列に変換してから情報を渡す方がオススメです。

ということだったそうです。
Debugbar::info()にjson_decodeをかけられないものか？ ということは思ったのですが、そもそも配列に変換すれば話は早かったということなのでオブジェクトの扱いがまだまだだなと痛感しました。