アーキテクチャ¶
最初の 3 つの章を読み終えてこの章へたどり着いたみなさん、お疲れ様でした。 ここまでで学んだ内容は、すぐにあなたの役に立ちます。 ただし、この 3 つの章では、フレームワークのアーキテクチャーについて深くは学びませんでした。 Symfony2 のアーキテクチャは、さまざまなフレームワークの中でも際立っています。 この章では Symfony2 のアーキテクチャについて学びます。
ディレクトリ構造について¶
Symfony2 アプリケーション のディレクトリ構造の制限は緩く柔軟ですが、Standard Edition ディストリビューションでは、Symfony2 アプリケーションで典型的に使用するディレクトリの推奨構成が採用されています。
- app/: アプリケーションのコンフィギュレーション
- src/: プロジェクトの PHP コード
- vendor/: サードパーティの依存ライブラリ
- web/: Web ルートディレクトリ
web/ ディレクトリ¶
web ディレクトリは、画像やJavaScript、スタイルシートなどの Web に公開する静的ファイルの基点となるディレクトリです。 また、各フロントコントローラファイルもこのディレクトリに配置されます。
// web/app.php
require_once __DIR__.'/../app/bootstrap.php.cache';
require_once __DIR__.'/../app/AppKernel.php';
use Symfony\Component\HttpFoundation\Request;
$kernel = new AppKernel('prod', false);
$kernel->loadClassCache();
$kernel->handle(Request::createFromGlobals())->send();
カーネルは最初に bootstrap.php.cache ファイルを読み込みます。 このファイルでは、フレームワークの初期化処理とオートローダの登録処理が行われます。
フロントコントローラのファイルである app.php は、カーネルクラスとして AppKernel を使い、アプリケーションを起動します。
app/ ディレクトリ¶
AppKernel クラスは、アプリケーションコンフィギュレーションの中心となるエントリポイントで、ファイルは app/ ディレクトリにあります。
このクラスには、次の 2 つのメソッドを実装する必要があります。
- registerBundles() メソッドは、アプリケーションの実行に必要なすべてのバンドルの配列を返すようにします。
- registerContainerConfiguration() メソッドは、アプリケーションコンフィギュレーションを読み込むようにします。
PHP のオートロードは、app/autoload.php ファイルで設定します。
// app/autoload.php
use Symfony\Component\ClassLoader\UniversalClassLoader;
$loader = new UniversalClassLoader();
$loader->registerNamespaces(array(
'Symfony' => array(__DIR__.'/../vendor/symfony/src', __DIR__.'/../vendor/bundles'),
'Sensio' => __DIR__.'/../vendor/bundles',
'JMS' => __DIR__.'/../vendor/bundles',
'Doctrine\\Common' => __DIR__.'/../vendor/doctrine-common/lib',
'Doctrine\\DBAL' => __DIR__.'/../vendor/doctrine-dbal/lib',
'Doctrine' => __DIR__.'/../vendor/doctrine/lib',
'Monolog' => __DIR__.'/../vendor/monolog/src',
'Assetic' => __DIR__.'/../vendor/assetic/src',
'Metadata' => __DIR__.'/../vendor/metadata/src',
));
$loader->registerPrefixes(array(
'Twig_Extensions_' => __DIR__.'/../vendor/twig-extensions/lib',
'Twig_' => __DIR__.'/../vendor/twig/lib',
));
// ...
$loader->registerNamespaceFallbacks(array(
__DIR__.'/../src',
));
$loader->register();
PHP 5.3 の名前空間に関する技術的な互換性の標準や PEAR の命名規約に従うクラスファイルをオートロードするために、Symfony\Component\ClassLoader\UniversalClassLoader が使われます。 このファイルを見て分かるように、依存ライブラリはすべて vendor/ ディレクトリに配置されていますが、これは単なる慣習です。 サーバー上でグローバルな共有場所や、プロジェクトごとのローカルの場所など、好きな場所に配置することもできます。
Note
Symfony2 のオートローダの柔軟性についてさらに学びたい場合は、クックブックの “クラスのオートローディングの方法” レシピを参照してください。
バンドルシステムについて¶
この節では、Symfony2 の強力な機能の 1 つであるバンドルシステムについて紹介します。
バンドルは、他のソフトウェアでプラグインと呼ばれているものに似ています。 なぜプラグインと呼ばずバンドルと呼ぶのでしょうか。 それは、Symfony2 ではフレームワークのコア機能から、開発者が記述するアプリケーションコードまで、すべてがバンドルだからです。 Symfony2 では、バンドルは第一級オブジェクトです。 バンドルの柔軟性により、よく使う機能が実装されパッケージングされたサードパーティ製のバンドルを自分のアプリケーションで使ったり、自分のバンドルを配布したりできます。 アプリケーションで有効にする機能を選択したり、好きな方法で最適化することも簡単です。 最終的には、作成するアプリケーションコードはコアフレームワークと同じくらい重要になっていきます。
バンドルを登録する¶
アプリケーションは、AppKernel クラスの registerBundles() メソッドで定義されたバンドルで構成されます。 各バンドルはディレクトリになっており、バンドル自身を表す Bundle クラスが 1 つあります。
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
new Symfony\Bundle\SecurityBundle\SecurityBundle(),
new Symfony\Bundle\TwigBundle\TwigBundle(),
new Symfony\Bundle\MonologBundle\MonologBundle(),
new Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle(),
new Symfony\Bundle\DoctrineBundle\DoctrineBundle(),
new Symfony\Bundle\AsseticBundle\AsseticBundle(),
new Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle(),
new JMS\SecurityExtraBundle\JMSSecurityExtraBundle(),
);
if (in_array($this->getEnvironment(), array('dev', 'test'))) {
$bundles[] = new Acme\DemoBundle\AcmeDemoBundle();
$bundles[] = new Symfony\Bundle\WebProfilerBundle\WebProfilerBundle();
$bundles[] = new Sensio\Bundle\DistributionBundle\SensioDistributionBundle();
$bundles[] = new Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle();
}
return $bundles;
}
チュートリアルで見てきた AcmeDemoBundle バンドル以外に、FrameworkBundle、DoctrineBundle、SwiftmailerBundle、AsseticBundle といったバンドルがカーネルに登録されていることが分かります。 これらはすべて、フレームワークのコア機能の一部です。
バンドルのコンフィギュレーション¶
各バンドルは、YAML、XML、PHP などの形式で記述されたコンフィギュレーションファイルでカスタマイズできます。 デフォルトのコンフィギュレーションファイルの中身を見てみましょう。
# app/config/config.yml
imports:
- { resource: parameters.ini }
- { resource: security.yml }
framework:
secret: %secret%
charset: UTF-8
router: { resource: "%kernel.root_dir%/config/routing.yml" }
form: true
csrf_protection: true
validation: { enable_annotations: true }
templating: { engines: ['twig'] } #assets_version: SomeVersionScheme
session:
default_locale: %locale%
auto_start: true
# Twig Configuration
twig:
debug: %kernel.debug%
strict_variables: %kernel.debug%
# Assetic Configuration
assetic:
debug: %kernel.debug%
use_controller: false
filters:
cssrewrite: ~
# closure:
# jar: %kernel.root_dir%/java/compiler.jar
# yui_css:
# jar: %kernel.root_dir%/java/yuicompressor-2.4.2.jar
# Doctrine Configuration
doctrine:
dbal:
driver: %database_driver%
host: %database_host%
dbname: %database_name%
user: %database_user%
password: %database_password%
charset: UTF8
orm:
auto_generate_proxy_classes: %kernel.debug%
auto_mapping: true
# Swiftmailer Configuration
swiftmailer:
transport: %mailer_transport%
host: %mailer_host%
username: %mailer_user%
password: %mailer_password%
jms_security_extra:
secure_controllers: true
secure_all_services: false
framework などの各エントリは、特定のバンドルのコンフィギュレーションを定義しています。 たとえば、framework エントリは FrameworkBundle のコンフィギュレーション、swiftmailer エントリは SwiftmailerBundle のコンフィギュレーションとなっています。
各環境 向けのコンフィギュレーションファイルを用意することで、デフォルトのコンフィギュレーションを上書きできます。 たとえば dev 環境では config_dev.yml ファイルが読み込まれます。 このファイルではメインのコンフィギュレーションファイル（たとえばconfig.yml）を読み込み、その後デバッギングツール用の設定をいくつか追加します。
# app/config/config_dev.yml
imports:
- { resource: config.yml }
framework:
router: { resource: "%kernel.root_dir%/config/routing_dev.yml" }
profiler: { only_exceptions: false }
web_profiler:
toolbar: true
intercept_redirects: false
zend:
logger:
priority: debug
path: %kernel.logs_dir%/%kernel.environment%.log
assetic:
use_controller: true
バンドルを拡張する¶
バンドルはコードの整理方法や設定方法を提供するだけでなく、他のバンドルを拡張することもできます。 バンドルを継承すると、既存のバンドルの機能をオーバーライドしてコントローラやテンプレート、その他バンドルに含まれる任意のファイルをカスタマイズできます。 このようにバンドルを継承する場合、リソースに論理名 (@AcmeDemoBundle/Controller/SecuredController.php など) を使うと、リソースが実際に格納されている場所を抽象化して扱えるため便利です。
論理ファイル名¶
バンドルにあるファイルを参照したい場合、@BUNDLE_NAME/path/to/file という記法を使います。 Symfony2 により、@BUNDLE_NAME はバンドルの実際のパスに置き換えられます。 たとえば、@AcmeDemoBundle/Controller/DemoController.php という論理パスの場合、``AcmeDemoBundle`` バンドルのパスは Symfony で管理されているため、src/Acme/DemoBundle/Controller/DemoController.php というパスに変換されます。
論理コントローラ名¶
コントローラを参照する場合、BUNDLE_NAME:CONTROLLER_NAME:ACTION_NAME という記法でアクションメソッドを指定します。 たとえば、AcmeDemoBundle:Welcome:index の場合はAcme\DemoBundle\Controller\WelcomeController クラスの indexAction メソッドにマップされます。
論理テンプレート名¶
テンプレートを参照する場合、AcmeDemoBundle:Welcome:index.html.twig という論理名は src/Acme/DemoBundle/Resources/views/Welcome/index.html.twig というファイルのパスに変換されます。 テンプレートに関する面白い機能としては、必ずしもファイルシステムに保存されている必要はないというものがあります。たとえばデータベースのテーブルに保存するように簡単に変更できます。
バンドルを拡張する¶
これらの規約に従うことで、バンドルの継承 の機能を使ってファイル、コントローラ、テンプレートを “上書き” できるようになります。 たとえば、新しい AcmeNewBundle という名前のバンドルが AcmeDemoBundle を継承している場合、Symfony により、まず最初に AcmeNewBundle の中にある AcmeDemoBundle:Welcome:index コントローラが検索され、次に AcmeDemoBundle のコントローラが検索されます。
Symfony2 の柔軟性が少しずつ分かってきたでしょうか。 アプリケーション間でバンドルを共有したり、プロジェクトローカルやサーバー上のグローバルな位置に配置するといったことも自由にできます。
vendor ディレクトリの使い方¶
構築するアプリケーションがサードパーティのライブラリに依存している場合もあるでしょう。 このようなライブラリは、vendor/ ディレクトリへ配置することをおすすめします。 このディレクトリには、SwiftMailer ライブラリ、Doctrine ORM、Twig テンプレートシステム、および他のサードパーティライブラリやバンドルといった Symfony2 のライブラリがすでに配置されています。
キャッシュとログについて¶
Symfony2 はフルスタックのフレームワークの中で最も高速なものの 1 つでしょう。 しかし、膨大な YAML や XML のファイルをリクエストの度にパースして解析していたら、このような速度は得られません。 高速な応答にとって重要な要素の 1 つに、キャッシュシステムがあります。 アプリケーションコンフィギュレーションは最初のリクエストの時にのみパースされ、プレーンな PHP コードにコンパイルされて app/cache/ ディレクトリへ保存されます。 開発環境の場合は、コンフィギュレーションの変更を Symfony2 が検知してキャッシュのクリアを行います。 しかし運用環境では、コードやコンフィギュレーションを更新した後にキャッシュをクリアすることは開発者の責務となっています。
Web アプリケーションを構築していると、何かがおかしくなってしまう場合があります。 app/logs/ ディレクトリにあるログファイルを見ると、リクエストに関するすべての情報を確認でき、問題の原因を素早く見つけるのに役立ちます。
コマンドラインインタフェース¶
Symfony2 アプリケーションにはコマンドラインインターフェイス用のツール（app/console）が組み込まれており、アプリケーションのメンテナンスに役立ちます。 また、何度も実行するようなタスクを自動化するコマンドを使うと、生産性が大きく向上します。
引数を指定せずに実行すると、その時点で利用可能なコマンドの一覧が表示されます。
php app/console
--help オプションを指定して実行すると、コマンドの使用方法が表示されます。
php app/console router:debug --help