Symfony 4 入門。前回の記事は以下
SymfonyでのRDB接続
Symfonyフレームワークでは公式で用意されているレシピではDoctrine (Doctrine DBAL / Doctrine ORM)に対応しています。Doctrine ORMではORマッピングを利用したRDB処理、Doctrine DBALではPHP PDOをラップしたようなものになっています。Doctrine DBALではPDO同様にMySQL / MariaDB / PostgreSQL 等に対して SQL を実行する以外に、SQLを生成するクエリビルダ―の機能も有ります。
また、DoctrineDBALの代わりに他の illuminate/database などを利用できるレシピも公開されているようです。
今回は簡単に使い始められる Doctrine DBAL で説明していきます。RDBには第1回でも説明したようにMySQL 8.0を利用しています。データは symfony_test DBを作成し、以下のような books テーブルを用意しています。
Doctrine DBAL の導入
これまでの実装でcomposer.jsonのrequire部分は以下のようになっています。
"require": {
"php": "^7.1.3",
"ext-ctype": "*",
"ext-iconv": "*",
"sensio/framework-extra-bundle": "^5.2",
"symfony/console": "4.2.*",
"symfony/debug-pack": "^1.0",
"symfony/dotenv": "4.2.*",
"symfony/flex": "^1.1",
"symfony/framework-bundle": "4.2.*",
"symfony/maker-bundle": "^1.11",
"symfony/twig-bundle": "4.2.*",
"symfony/web-server-bundle": "4.2.*",
"symfony/yaml": "4.2.*"
}
Doctrine DBALを利用するには symfony/orm-pack を導入します。名前から分かるようにDoctrine ORM / DBAL の機能はセットで導入されます。
composer require symfony/orm-pack
これで必要なパッケージ群が導入されました。
次にDB接続設定を行います。上記のログの最後にも出ている .env ファイル内に接続情報を記載します。Symfonyプロジェクト直下にある .env ファイルを開き、以下の部分を編集します。
DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name
db_user, db_password, 接続先ホストとポート、DB名を適宜変更したら保存します。なお、MySQLでの設定になっていますが、PostgreSQLなどに接続したい場合はこれも上記ログに出ている config/packages/doctrine.yaml で設定します。現在は以下のようになっています。
doctrine:
dbal:
# configure these for your database server
driver: 'pdo_mysql'
server_version: '5.7'
charset: utf8mb4
default_table_options:
charset: utf8mb4
collate: utf8mb4_unicode_ci
url: '%env(resolve:DATABASE_URL)%'
orm:
auto_generate_proxy_classes: true
naming_strategy: doctrine.orm.naming_strategy.underscore
auto_mapping: true
mappings:
App:
is_bundle: false
type: annotation
dir: '%kernel.project_dir%/src/Entity'
prefix: 'App\Entity'
alias: App
この設定の中で ‘%env(resolve:DATABASE_URL)%’ という部分が .env ファイルで設定した値が投入される部分になります。この yaml 設定ファイル自体に各種接続情報を定義する事も可能ですが、.envファイルに環境ごとの設定を入れておくことで環境ごとに切り替えをしやすくするような仕組みになっています。なお、.envファイルは初期状態だとGitリポジトリへのコミット対象ですが、 .env.local といったファイルを作ると .env.local は最初から Git Ignore されており、設定的にもそちらが優先されるようになっていますので開発環境などでは .env.local を使った方が良いかもしれません。
doctrine.yaml でのdriverの指定はデフォルトではPDO MySQLになっているのでPostgreSQLの場合はここをPDO PostgreSQLを使う設定に変更しておきます。
実際にRDBにアクセスしてみる
実際にDoctrine DBALを利用してRDBから値を取り出してみます。
リポジトリ
RDBへのアクセスはコントローラやサービスなどからも可能でべた書き出来るのですが、今回はアクセスするためのリポジトリとなるクラスを作成します。/src/Repository ディレクトリを作成し、BooksRepository.php を作成します。
<?php
namespace App\Repository\Impl;
use App\Repository\BooksRepository;
class BooksRepositoryImpl implements BooksRepository
{
/** @var \Doctrine\DBAL\Connection connection */
protected $db;
/** @var Psr\Log\LoggerInterface logger */
protected $logger;
public function __construct(\Doctrine\DBAL\Connection $con, \Psr\Log\LoggerInterface $logger)
{
$this->db = $con;
$this->logger = $logger;
}
public function get(int $book_id)
{
$sql = "SELECT * FROM books WHERE book_id = :book_id";
$stmt = $this->db->prepare($sql);
$stmt->bindValue("book_id", $book_id);
$stmt->execute();
$book = $stmt->fetch();
return $book;
}
}
DoctrineDBALではSELECT時に連想配列やオブジェクト、任意のクラスを元にしたオブジェクトなど様々な方法で値を返す事が出来ますが、今回はデフォルトの連想配列のまま扱います。変更する場合は Doctrine\DBAL\Driver\Statement::setFetchMode を呼び出します。
また、上記の例ではSQLの文字列に :book_id というプレースホルダを利用し、bindValue 関数で値を設定しています。この際に値が自動でエスケープされるので値を埋め込む際はプレースホルダを使うようにしましょう。また、DoctrineDBAL にはクエリビルダ機能が有るので、簡単なSQLであればクエリビルダを使って行ってもいいと思います。
コントローラ
順番通りに進めていれば Controller/RootController.php に以下の定義が既にあるはずです。無ければ追加します。
/**
* @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'
]);
}
これをサービスクラスの呼び出しを追加します。サービスクラスに処理の中核となる部分を移し、コントローラではルーティングと送信されたデータの読み込み、ビューの呼び出しに専念させます（今回はIDを受け取ってDBからSELECTするだけですが）。
/**
* @Route("/books/detail/{book_id}/", name="book_detail",
* requirements={"book_id"="\d+"})
*/
public function bookDetailAction($book_id, BooksService $booksService)
{
$book = $booksService->bookDetail($book_id);
return $this->render('books/detail.html.twig', [
'book_id' => $book_id,
'book_detail' => $book
]);
}
サービス
コントローラから呼び出され諸々の処理を行うサービスクラスを作ります。今回はリポジトリから値を受け取るだけです。/src/Service ディレクトリを作成し、BooksService.php を作成します。
<?php
namespace App\Service;
use App\Repository\BooksRepository;
class BooksService
{
private $booksRepository;
public function __construct(BooksRepository $booksRepository)
{
$this->booksRepository = $booksRepository;
}
public function bookDetail(int $book_id)
{
return $this->booksRepository->get($book_id);
}
}
これでコントローラ、サービス、リポジトリの準備は完了です。該当URLにアクセスすると
RootController::bookDetailAction
BooksService:: bookDetail
BooksRepositoryImpl:: get
という段階を踏んでアクセスされます。最後にビュー detail.html.twig を調整しておきます。
{% extends 'base.html.twig' %}
{% block title %}Book Detail{% endblock %}
{% block body %}
<h1>Book Detail ID:{{ book_id }}</h1>
<p>
<div>書籍名: {{ book_detail.book_name }}</div>
<div>価格: {{ book_detail.book_price|number_format }}円</div>
<div>発売日: {{ book_detail.book_release }}</div>
</p>
{% endblock %}
ではSymfonyのサーバーを起動し、アクセスを確認してみます。
php bin\console server:run
でビルトインサーバーを起動し、Webブラウザから http://127.0.0.1:8000/books/detail/1/ にアクセスします。
DBから取得した値を表示できました。導入方法としてはこのような感じでRDBに接続する事が出来ます。導入～SELECTまでの説明ですが、INSERTやUPDATE、DELETEもググりながら簡単に実装できるかと思います。とはいえDoctrine に関する日本語情報ってあまりないので増えてほしいなぁ……。
ここまでのソースの状態は以下を参照
https://github.com/lf-uraku-yuki/symfony4_tutorial/tree/tutorial04
なお、MySQL 8.0ではデフォルトの認証方法が変わった事も有り、「The server requested authentication method unknown to the client”」というエラーになる場合が有ります、これはググれば出てきます該当ユーザーの認証方法を caching_sha2_password から mysql_native_password を使った物に変更する事で回避可能です。
次回はログ出力について