マイクロフレームワークっぽく使う Symfony 4 事始め 2 ~ルーティング編~

Symfony 4 入門。 前回の記事は以下

前回までは Symfony 4.2 のインストールからTwigテンプレートを使ったWebページを一つ表示するところまでを作りました。今回はコントローラ上にルーティングを増やしていきます。

参考にすべきページは以下

Create your First Page in Symfony (Symfony Docs)
Routing (Symfony Docs)
Controller (Symfony Docs)

結構ボリュームが有るので説明してない分は参照先の公式ドキュメントを参照してください。

ルーティング

前回作成したRootControllerの定義を再確認します。

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Routing\Annotation\Route;

class RootController extends AbstractController
{
    /**
     * @Route("/root", name="root")
     */
    public function index()
    {
        return $this->render('root/index.html.twig', [
            'controller_name' => 'RootController',
        ]);
    }
}

PHPDocに記載の有る @Route 定義がアノテーションによるルーティングです。”/root”にマッチするURLが来た場合にこの index 関数が実行されます。nameはユニーク(他とかぶりが無い)である必要が有るので注意してください。

結果はResponseオブジェクト( Symfony\Bundle\FrameworkBundle\Controller\Response)をreturnで返します。$this->render() を呼び出すとTwigでレンダリングした結果をResponseオブジェクトとして返してくれます。

ルーティングを増やす

    /**
     * @Route("/root", name="root")
     */
    public function index()
    {
        return $this->render('root/index.html.twig', [
            'controller_name' => 'RootController',
        ]);
    }

    /**
     * @Route("/root/demo", name="root_demo")
     */
    public function demoAction()
    {
        return $this->render('root/index.html.twig', [
            'controller_name' => 'RootController::demo',
        ]);
    }

@Routeアノテーションの定義された関数を増やすします。Routeアノテーションの一つ目の引数にパス、2つ目に入力する名前は他とのかぶりが無いものにします。

引数のあるルーティング

例えば /books/detail/20/ のようなページを作りたいと思います。20の部分は可変とします。その場合パスを指定する際に{変数名}を指定するとその名前で関数の引数に変数を受け取る事が出来ます。また、例えばこの引数が必ず数字で構成される場合などは requirements の定義に変数名と正規表現の対応を記述しておくと、数字である場合のみ処理されるような制約設定が可能です。

    /**
     * @Route("/books/detail/{book_id}/", name="book_detail", 
     * requirements={"book_id"="\d+"})
     */
    public function bookDetailAction($book_id)
    {
        return $this->render('books/detail.html.twig', [
            'book_id' => $book_id,
            'book_detail' => 'dumy text'
        ]);
    }

テンプレート books/detai.html.twig は以下のように定義。受け取ったIDをそのまま表示します。

{% extends 'base.html.twig' %}

{% block title %}Book Detail{% endblock %}

{% block body %}

<h1>Book Detail ID:{{ book_id }}</h1>
<p>
    {{ book_detail }}
</p>

{% endblock %}

Webブラウザで http://127.0.0.1:8000/books/detail/20/ にアクセスしてみます。

リクエスト内容を受け取る

SymfonyにはDI(Dependency Injection : 依存性注入)の仕組みが有り、サービスクラス(≒アプリが行う処理のコア部分のクラス)のコンストラクタであったり引数で有ったりにSymfonyが認識しているクラス名や引数名を指定すると自動で必要なオブジェクトを渡してくれます。リクエスト内容を受け取るには Request のオブジェクトを受け取ります。

    /**
     * @Route("/books/detail/", name="book_detail_for_query")
     */
    public function bookDetailActionForQuery(Request $req)
    {
        $book_id = $req->query->get('book_id');

        return $this->render('books/detail.html.twig', [
            'book_id' => $book_id,
            'book_detail' => 'dumy text'
        ]);
    }

受け取った引数 $req から book_id を取り出しています。Webブラウザで http://127.0.0.1:8000/books/detail/?book_id=33 にアクセスしてみます。

HTTPメソッドに応じてルーティングする

基本的には先ほどと同じですが @Route の定義に methods={“POST”} を追加しています。これによりPOSTであった場合のルーティングを行っています。

    /**
     * @Route("/books/edit/", name="book_edit_exec", methods={"POST"})
     */
    public function bookEditExecAction(Request $req)
    {
        return $this->render('books/detail.html.twig', [
            'book_id' => 0,
            'book_detail' => '編集に成功しました'
        ]);
    }

複数のHTTPメソッドに一つの関数で対応する場合は
methods={“POST”, “PUT”}
のように定義します。

なお、先にメソッド指定のないルーティングを行った後に同じパス指定でPOSTに限定したルーティングを書いてもPOSTでのアクセスは先に定義しているメソッド縛り無しの方が呼ばれて適切に動作しません。同じパスでHTTPメソッド違いのルーティングを作る場合はGETについても適切に定義してください。

404 Not Found を返す

NotFoundHttpException 例外を発生させる事で HTTP 404 Not Found の処理を行います。直接newしてnewしてthrowしてもいいですが、$this-> createNotFoundException を使って生成する事が出来ます。この時例外は return ではなく throw する事に気を付けてください。

throw $this->createNotFoundException('見つからないようです');

設定したメッセージが表示されています。

呼び出し先のコードを読めばわかりますが NotFoundException を生成して返しているだけです。この NotFoundException を更に追うと HttpException の第1引数に 404 を渡して例外を生成している事が確認できます。 404以外のステータスコードを返したい時は HttpException を直接扱えばよさそうですね。HttpExceptionを生成する際は第1引数にステータスコードを渡してやります。

throw new \Symfony\Component\HttpKernel\Exception\HttpException(
            500, 'インターナルなサーバーのエラー');

リダイレクトする

$this->redirect(‘URL’) を使う方法と $this->redirectToRoute (‘ROOT’, []) を使う方法が有ります。前者はURLを直接渡す普通のリダイレクト、後者はアノテーションでルーティングを記述する際に指定する name で指定してリダイレクトします。また、redirectToRootの場合は第2引数で連想配列などを渡しておくと自動でURLのクエリ文字列をつけ足したりなど良い感じに処理してくれます。

$this->redirect('/books/detail?book_id=20');
$this->redirectToRoute('book_detail', ['book_id' => 20]);

例えば目的のパスの定義が /books/{book_id}/ というような場合でも変数名を合わせて第2引数に渡しておけば、例えば /books/50/ といったページにリダイレクトしてくれます。

// book_detail の定義が /books/{book_id}/ だったとしてもちゃんと引数が渡る
$this->redirectToRoute('book_detail', ['book_id' => 20]);

JSONを返す

$this->json() を使います。1つ目の引数に返したいデータ(例えば連想配列など)、必要であれば2つ目の引数にHTTPステータスコードを渡します。デフォルトはHTTP 200で返します。

        return $this->json([
            'データ1' => 100,
            'データ2' => 200
        ]);

ここまででだいたいのルーティングは作る事が出来るんじゃないかと思います。また、引数を取る際にデフォルト値を設定したい場合とかも公式のドキュメントに方法が書いてありますのでご参照ください。コントローラクラスは無秩序に1ファイルに増やしていく事も可能ですが、適宜クラスを分けた方が分かりやすいかと思います。

ここまでのコードの状態は以下を参照してください。
https://github.com/lf-uraku-yuki/symfony4_tutorial/tree/tutorial02

また、ルーティングがどうなっているかは php bin/console debug:route で一覧表示する事が出来きます。

次回はサービスとDIとデータベースについて書こうと思います。

続きの記事が出来ました(2019年1月31日)