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

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

ただいまの
回答率

87.35%

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

解決済

回答 1

投稿

  • 評価
  • クリップ 1
  • VIEW 1,438

score 24

問題

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のエラーが出る。
コントローラーに直接コンストラクタメソッドを使う場合も上に同様。

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

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

質問への追記・修正、ベストアンサー選択の依頼

  • mix-peach

    2019/10/30 12:00 編集

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

    キャンセル

  • kamille-mio

    2019/10/31 02:25

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

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

    キャンセル

回答 1

check解決した方法

+2

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をかけられないものか? ということは思ったのですが、そもそも配列に変換すれば話は早かったということなのでオブジェクトの扱いがまだまだだなと痛感しました。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

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

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

関連した質問

同じタグがついた質問を見る