タグ別アーカイブ: PHP

マイクロフレームワークっぽく使う Symfony 4 事始め 3 ~DIコンテナ編~

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

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

Symfony 4 の DIコンテナ(サービスコンテナ)

今回は Symfony 4 の DIコンテナ(サービスコンテナ) について説明します。

ある程度のサイズのアプリケーションを構築する際にはコントローラとビュー(テンプレート)だけで処理が完結する事は少なく、具体的なロジックを別のクラスに移したり、データベースの読み書き部分を更に別のクラスに移したりといった設計をするかと思います。DIコンテナはそうしたオブジェクト間の依存関係に対して Dependency Injection (依存性注入) をしやすくするための仕組みです。

例えば機能Aに関する諸々を提供するサービスクラスAが更に別のオブジェクトや変数を必要とする(依存性がある)場合に、それらをサービスクラスA上で直接newせずにDIコンテナの機能を利用してサービスクラスAに注入する事で依存性が薄まり、テストコードが書きやすくなるなどのメリットが出てきます。

Symfony 4 のDI機能については config ディレクトリ内の services.yaml で定義されています。こちらを開いてみると以下のような定義が有ると思います。

services:
    # default configuration for services in *this* file
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.

    # makes classes in src/ available to be used as services
    # this creates a service per class whose id is the fully-qualified class name
    App\:
        resource: '../src/*'
        exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'

services.yaml 内の services: 内に自分で定義を書いていく事でも定義できるのですが autowire という機能によりその辺りはあまり意識せずに設定フリーで動かして行く事が出来ます。初期設定では App\ 名前空間配下であり ディレクトリは /src/ 配下の 「DependencyInjection」「Entity」「Migrations」「Tests」以外のディレクトリに切られたクラスであれば、自動でDIコンテナにクラスが登録されます。

DIコンテナに登録されたサービスは利用したいクラスのコンストラクタでコンストラクタインジェクション(コンストラクタの引数からクラスのフィールドに注入)したり、メソッドインジェクション(メソッドの引数からメソッド内に注入)したりして利用します。

例えばコントローラでルーティングを定義する場合に、リクエスト内容を利用するために引数に Request オブジェクトを受け取っていたと思います。このようにクラスの型を定義しておくことでDIコンテナが自動で必要なサービスを受け渡してくれます。

    /**
     * @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'
        ]);
    }

実際に利用してみる

これを自前で作成したサービスクラスで試してみます。以下のサービスクラスを定義します。
名前空間: App\Service
ファイル: src/Service/SampleService.php

<?php
namespace App\Serivce;

class SampleService
{
    public function helloWorld(): string
    {
        return 'hello world.';
    }

}

これをコントローラ上のルーティングから利用してみます。まずはメソッド(関数)インジェクションを試してみます。

    /**
     * @Route("/service/useService1", methods={"GET"})
     */
    public function useSerivce1(\App\Service\SampleService $sampleService)
    {
        $result = $sampleService->helloWorld();
        
        return $this->render('/serivce/use_service.html.twig', [
            'body' => $result
        ]);
    }

Twigテンプレートは以下です。bodyに渡した変数を表示するだけです。

<!DOCTYPE html>
<html lang="ja">
    <head>
        <meta charset="UTF-8">
        <title>{{ title|default('default title')}}</title>
    </head>
    <body>
        {{ body }}
    </body>
</html>

やっている事は引数に使いたいオブジェクトの型を指定しているだけです。これだけで Symfony のDIコンテナが SampleService のオブジェクトを注入してくれます。PHPビルトインサーバーを起動しWebブラウザから確認してみます。

しっかりサービスクラスのオブジェクトが利用できています。

次はコンストラクタでのインジェクションを試してみます。クラス内で恒常的に使うものはこちらの方がいいでしょう。

    // 利用するサービスクラスをコンストラクタインジェクションする
    private $sampleService;

    public function __construct(\App\Service\SampleService $sampleService)
    {
        $this->sampleService = $sampleService;
    }

    /**
     * @Route("/service/useService2", methods={"GET"})
     */
    public function useSerivce2()
    {
        $result = $this->sampleService->helloWorld();
        
        return $this->render('/service/use_service.html.twig', [
            'body' => $result
        ]);
    }

コンストラクタの引数でDIコンテナから受け取ったオブジェクトをフィールドに保存しておいて使います。書き方としてはあまり変わらないですね。

自動で登録され注入できる物の一覧はSymfonyのコンソールコマンド debug:autowiring 、自動登録以外もすべて含めての一覧は debug:container から確認できます。実際に試してみると結構いろいろなものが出てくると思います。例えば Request 以外にも、セッション(SessionInterface)であったり、ログファイルに書き込むロガー(LoggerInterface)であったりデータベース接続が設定済みである場合のデフォルトコネクションを取得したり出来ます。

また、上記の SessionInterface や LoggerInterface のように、インタフェースを実装したクラスである場合インタフェース名で注入するオブジェクトを指定する事が出来ます。インタフェース名で指定した場合でも SymfonyのDIコンテナは実際に実装した方のオブジェクトを渡してくれます。

設定値の注入

クラス名を持たない値を注入したい事が有ります。例えばメールを送信するクラスを初期化する際に送信元アドレスを固定で渡す仕様だったとします。

<?php
namespace App\Service;

class MailService
{
    private $from_address;

    public function __construct($from_address)
    {
        $this->from_address = $from_address;
    }
}

from_addressはメールアドレスを文字列として渡す仕様です。これだと型での指定ができませんし string 型を指定しても仕方が有りません。このような場合に services.yaml での手動定義が必要になってきます。parameters にパラメータを定義しておき、 services 内で「どのサービスの」「どの変数名に」「どのパラメータを渡すか」を指定します。

parameters:
    from_address: 'xxx@yyy.zzz'

services:

    # 既存で記載されているもろもろを中略

    App\Service\MailService:
        arguments:
            $from_address: '%from_address%'

この定義を追加する事で App\Serivce\MailService の引数 $from_address に対してパラメータ from_address を渡す事が出来ます。serivces.yaml での手動設定では他にも以下のような物に対して解決が行えます。

  • 一つのインタフェースに対して複数の実装が有る場合にどれを注入するか。
  • デフォルトではない方のDB接続を注入したい。
  • etc..

コンテナから直接取得する

コンテナに登録済みのオブジェクトは直接取得する事も出来ます。依存性は高くなりますがそうしたい場合もあるかと思いますので記載しておきます。

$sampleService = $this->container->get('App\Service\SampleService');
$from_address = $this->getParameter('from_address');

なお、上記の $this->container->get() で取りに行く方法はコントローラ内では制限が有り利用できないのでご注意ください。

実際のユースケースとしてはPHPUnitのテストコードを書く際に利用する事が多いです。PHPUnitテストコード内に対してはコンストラクタインジェクション、メソッドインジェクションを使った自動注入が機能しません。通常利用する TestCase クラスを継承した KernelTestCase を継承してテストを実装するとSymfonyのカーネルとDIコンテナを起動する事が可能になるので、そこから必要なオブジェクトを取得したり出来るようになります。これについては後でまた説明したいです。

その他の諸々

Symfony 4 をマイクロフレームワークとして使う場合、このDIコンテナ(サービスコンテナ)機能(とComposerによるオートロードの仕組み)がアプリケーションの機能を組み立てる骨組みになってくるかと思います。他にも説明していない様々な機能が有りますので、普通のインジェクション機能では解決できないものが出てきた場合は公式のドキュメントを参照してみてください。

Service Container (Symfony Docs)

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

次回はDB接続について書きたいです。


マイクロフレームワークっぽく使う 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日)


マイクロフレームワークっぽく使う Symfony 4 事始め 1 ~インストール編~

PHPのWebアプリケーションフレームワーク Symfony 4.x をマイクロフレームワークっぽく利用し始める事始め(入門)をまとめてみたいと思います。Symfonyは公式のドキュメントがそれなりに充実しているのでそこを読める人であれば読めばOK!なんですが、あまりにも日本語の情報が無く、有ってもバージョンが古い頃の情報だったりしてちょっとつらいです。今回は以下の環境でまとめています。私自身が使い始めたばかりなのでよく分かっていない部分はよく分かっていないと書いています。

Symfony: 4.2
PHP: 7.2 (Windows版ですが他の環境と特に違いは無いです)
Composer: 導入済み
MySQL: 8.0 (Windows版ですが他の環境と特に違いは無いです)

PHPのビルトインサーバーで動作するのでApacheやNginxは開発環境で動かす分には不要です。

インストール

インストール完了までの手順は以下の記事を大いに参考にさせて頂いております。リンク先の方が詳しいです。

Symfony4をインストールして”Hello World”を表示させるまでの手順 | QUARTETCOM TECH BLOG
Installing & Setting up the Symfony Framework (Symfony Docs)

プロジェクトを作るディレクトリに移動しComposerでインストールしていきます。symfony/skeltonを導入する事で必要な最小限の諸々 + Symfonyのパッケージ管理を楽にするための仕組み Symfony Flex が導入されます。

composer create-project symfony/skeleton <プロジェクト名>

作成されたプロジェクトのディレクトリに移動し、PHPのビルトインサーバを使うための Server レシピを導入します。serverという名前指定だけで目的のパッケージが導入されますが、この部分がFlexにより支援されている部分のようです。

composer require server

導入後は以下のコマンドでビルトインサーバーが起動します。consoleファイルの中身はPHPで実行するようにshebangが設定されたPHPファイルです。Windowsの場合はコマンドの頭に「php 」を付けてPHPのファイルである事を明示的に指定してやれば同様に動きます。

php console/bin server:run

実行した様子。Ctrl+C で終了。

コントローラなどを生成できる maker レシピ、コントローラを実装する際に定義ファイルの編集ではなくコントローラコード上のアノテーションで行えるようにする annot レシピを導入します。アノテーションでルーティングする機能は実態としては sensio/framework-extra-bundle に含まれています。デバッグ・プロファイリングに便利な debug-pack も導入します。

composer require maker
composer require annot
composer require debug-pack

テンプレートエンジンにTwigを使いたいので twig レシピを導入します。APIサーバーとして使う(JSONしか返さないつもり)なら入れなくても良いんじゃないかと思います。

composer require twig

これで「何かしらのURLにアクセスしたらコントローラがルーティングしてテンプレートエンジンがテンプレートを使ってページを表示する」という基本部分が完成しました(DB処理は後からふれます)。

色々と導入してきましたが、それに伴いconsoleコマンドでCLI実行できる機能も増えています。 bin/console xxx:xxx で使えるコマンドの一覧は特に引数を渡さずに実行すると確認できます。

php bin/console

以下が実行結果。多いので中略しています。

Hello World

決まった文字が文字が表示されるだけのページを作ってみます。以下のコマンドでコントローラを作成します。

php bin/console make:controller RootController

テンプレートとコントローラが作成されました。 maker:controller は便利コマンド的な物なので作り込んで来たら既存のコントローラをコピペするなどして手動で作成しても良いのですが、最初はこれを叩いた方が簡単です。

この時点でのプロジェクトのルート配下のファイル・ディレクトリ構成は以下のような感じになっています。

  • /bin :consoleコマンドやあとで導入するphpunitコマンドがここに入ります。
  • /config :各種設定ファイルが入ります。
  • /public :ドキュメントルートはここ。index.phpの場所。
  • /src :PHPのコード
    • Controller :コントローラーが作られる場所。
  • /template :Twigテンプレートの場所。src配下ではない。
  • /var :ログファイルであったりなどがここに作られます。
  • /vendor :Composerで導入されていくパッケージ。
  • .env :これもSymfonyの環境設定に関わるファイル。ここで環境によって設定を変えたりできる?
  • composer.json :Composerで導入されたパッケージの管理。
  • composer.lock :同上。
  • symfony.lock :Symfony関連のパッケージ管理。謎が多い。

コントローラのコードは以下のようになっています。

<?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オブジェクトとして返してくれます。JSONで返したい場合は $this->json() という関数が有ります。

Twigテンプレートは以下のようになっています。

普通のTwigテンプレートなので特に必要はないかと思いますが、念のため雑に説明しておきます。

  • {{ xxx }} 変数の表示。自動でHTMLスケープされます。
  • {% xxx %} 変数を表示する以外の分岐やループなどの機能は {% で囲まれます。
  • {# xxx #} コメントアウト。コメントアウトは {# で囲みます。

$this->render() 時に渡した変数 controller_name からコントローラー名「RootController」が表示されるようになっていますね。

ではページを見てみます。php bin/console server:run でビルトインサーバを起動し、Webブラウザで http://127.0.0.1:8000 にアクセスします。

これはデフォルトのルートページ的な物になり、画面左下にも出ているように HTTP 404 Not Foundとなっています。ページ下部に表示されているステータスコード、処理時間、エラーログ確認などが debug-pack で導入された機能によって表示されているプロファイラ機能です。クリックするとより詳細な情報を確認する事が出来ます。

作成したコントローラに対応する http://127.0.0.1/root にアクセスしてみます。

目的のページが表示されました。画面左下よりステータスコードも HTTP 200 (正常) となっていますね。

とりあえずここまででページを表示するための最低限のものが動くようになりましたが、ルーティングの詳細やDB処理などまだ必要な物が有ります。次はルーティングについてまとめます。

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

続きの記事