Home | Symfony2Doc »ガイドブック »HTTP キャッシュ

ご注意

Symfony2日本語翻訳ドキュメントは内容が古くなっております。公式サイトの英語ドキュメントを参照してください。

HTTP キャッシュ

リッチな Web アプリケーションの本質は、それが動的であるということでしょう。 アプリケーションがどんなに効率的であったとしても、静的なファイルと比較して動的なファイルへのリクエストは必ずオーバーヘッドが発生します。

多くの Web アプリケーションのケースでは、Symfony2 はとても高速に動作するので、苦労してチューニングしなくても、サーバーに負荷をかけることなく、素早くレスポンスが返されます。

しかし、サイトへのアクセスが多くなると、小さなオーバーヘッドでも現実問題となってくるケースもあります。 このような場合は、それまでリクエストのたびに実行していた処理を、1 回だけ実行されるようにします。 これがキャッシュの目的です。

巨人の肩に乗ってキャッシュする

アプリケーションのパフォーマンスを向上させる最も効果的な方法は、ページ全体の出力をキャッシュし、それ以降のリクエストに対してはアプリケーションの処理が実行されないようにすることです。 もちろん、動的な部分の多いサイトでは、この方法が使えない場合もあります。そういった場合に使える方法はないのでしょうか。 この章では、Symfony2 のキャッシュシステムの機能を説明します。 この章を読むと、Symfony2 のキャッシュのアプローチがとても優れていることが分かるでしょう。

Symfony2 のキャッシュシステムは、これまで他の似たようなフレームワークで実装されていたキャッシュシステムとは一線を画しています。 なぜなら、Symfony2 のキャッシュシステムは、HTTP 仕様 に定義されているとてもシンプルで強力な HTTP キャッシュを実装したものだからです。 キャッシュの手法を再発明するのではなく、Web 上の基本的なプロトコルを定義している標準に準拠することにしたのです。 ですので、HTTP キャッシュの有効期限や検証のモデルについて、基本を一度理解すれば、Symfony2 のキャッシュシステムも理解できます。

Symfony2 のキャッシュを学ぶにあたり、次の 4 つのステップで順に説明していきます。

  • ステップ 1: ゲートウェイキャッシュ またはリバースプロキシと呼ぶ、アプリケーションの手前に位置する独立したレイヤーについて解説します。 リバースプロキシでは、アプリケーションから返されたレスポンスをそのままキャッシュし、アプリケーションに対してリクエストがあると、代わりにキャッシュされたレスポンスを返します。 Symfony2 には独自のリバースプロキシが実装されていますが、他のリバースプロキシを利用することもできます。
  • ステップ 2: HTTP キャッシュ ヘッダーを使うと、アプリケーションとクライアントの間にある、ゲートウェイキャッシュ等のキャッシュシステムと情報をやりとりできます。 Symfony2 には、キャッシュヘッダーに関する使いやすいデフォルトの設定と、キャッシュヘッダーを操作するための強力なインタフェースがあります。
  • ステップ 3: HTTP 有効期限と検証 は、キャッシュされたコンテンツが 最新 (キャッシュから利用可能) か 古い (アプリケーションから再生性する必要がある) かを決定するために使う 2 つのモデルです。
  • ステップ 4: Edge Side Includes (ESI) を使うと、HTTP キャッシュシステムでページの断片を個別にキャッシュできるようになります。ネストされたページ断片も扱えます。 ESI では、ページ全体は 60 分キャッシュし、そこに埋め込まれたサイドバーは 5 分のみキャッシュするということが可能になります。

HTTP キャッシュは Symfony に限った技術ではありませんので、さまざまな解説記事がすでにあります。 HTTP キャッシュについて初めて学ぶ方は、Ryan Tomayko 氏の記事 Things Caches Do を一読しておくことをおすすめします。 さらに詳細な解説は、Mark Nottingham 氏の Cache Tutorial です。

ゲートウェイキャッシュを使ったキャッシュ

HTTP でキャッシュを行う場合、キャッシュはアプリケーションから完全に分離され、アプリケーションとリクエストを送信するクライアントとの間で動作します。

キャッシュの仕事は、クライアントからのリクエストを受け取り、それをアプリケーションへ引き渡すことです。 同様に、アプリケーションからのレスポンスを受け取って、クライアントへ返します。 つまり、キャッシュはクライアントとアプリケーションとの間でリクエストとレスポンスの通信を仲介します。

クライアントとアプリケーションの間で仲介をしながら、”キャッシュ可能” とみなせるレスポンス(HTTP キャッシュの導入)をキャッシュに保存します。 同じリソースが再度リクエストされた場合、キャッシュされたレスポンスがクライアントへ返され、アプリケーションは実行されません。

このように動作するキャッシュは、HTTP ゲートウェイキャッシュと呼ばれ、Varnishリバースプロキシモードの Squid等、すでに多くのものが存在します。 Symfony2 リバースプロキシもこの 1 つです。

キャッシュの種類

ゲートウェイキャッシュがキャッシュの唯一の方法というわけではありません。 実際、アプリケーションから送信される HTTP キャッシュヘッダーは、次の 3 種類のキャッシュシステムで受け取って処理されます。

  • ブラウザのキャッシュ: すべてのブラウザには、ローカルキャッシュ機能が実装されています。 “戻る” ボタンを押したときや、画像などのアセットが何度も表示される場合にローカルキャッシュが使われます。 ブラウザキャッシュはプライベートキャッシュなので、キャッシュされたリソースが他人と共有されることはありません。
  • プロキシキャッシュ: プロキシは共有キャッシュで、多くのユーザーに代わって 1 人のユーザーがアクセスします。 通常は、大企業や ISP でレイテンシやネットワークのトラフィックを低下させる目的でインストールされます。
  • ゲートウェイキャッシュ: プロキシと似ていますが、サーバーサイドで、キャッシュを共有します。 インストールはネットワーク管理者が行い、Web サイトの可用性、信頼性、パフォーマンスを向上させます。

Tip

ゲートウェイキャッシュは、リバースプロキシキャッシュ、サロゲートキャッシュ、HTTP アクセラレータと呼ばれることもあります。

Note

キャッシュが プライベート であるか 共有 であるかは、たとえばアカウント情報画面のように厳密に 1 人のユーザーにのみ固有なコンテンツを含むレスポンスをキャッシュする場合に重要になります。

アプリケーションのレスポンスには、最初の 2 つのうちのどちらか一方、または両方を利用できることが多いでしょう。 これらのキャッシュを利用する場合、キャッシュデータを直接管理することはできませんので、レスポンスで HTTP キャシュの命令セットを使うことになります。

Symfony2 リバースプロキシ

Symfony2 には、PHP で記述されたリバースプロキシ(またはゲートウェイキャッシュと呼ばれる)が組み込まれています。 リバースプロキシを有効にすると、アプリケーションからキャッシュ可能なレスポンスが返された場合、すぐにキャッシュされます。 リバースプロキシのインストールはとても簡単です。 Symfony2 アプリケーションには、あらかじめキャッシュカーネル (AppCache) の設定がされています。 キャッシュカーネルは、デフォルトのカーネル (AppKernel) をラップします。 このキャッシュカーネルが、リバースプロキシとして機能します。

キャッシュを有効にするには、キャッシュカーネルを使うようにフロントコントローラのコードを次のように変更します。

// web/app.php

require_once __DIR__.'/../app/bootstrap.php.cache';
require_once __DIR__.'/../app/AppKernel.php';
require_once __DIR__.'/../app/AppCache.php';

use Symfony\Component\HttpFoundation\Request;

$kernel = new AppKernel('prod', false);
$kernel->loadClassCache();
// デフォルトの AppKernel を AppCache でラップ
$kernel = new AppCache($kernel);
$kernel->handle(Request::createFromGlobals())->send();

これですぐに、キャッシュカーネルがリバースプロキシとして動作し始めます。 つまり、アプリケーションからのレスポンスをキャッシュし、クライアントにキャッシュを返します。

Tip

キャッシュカーネルには、キャッシュレイヤーでの処理内容を文字列で返す getLog() メソッドがあります。 開発環境では、このメソッドを使ってキャッシュ戦略を検証できます。

error_log($kernel->getLog());

AppCache オブジェクトのデフォルトコンフィギュレーションは、十分に実用的ですが、開発するアプリケーションに合わせて細かく調整したい場合は getOptions() メソッドをオーバーライドして、キャッシュ用の一連のオプションを書き換えることができます。

// app/AppCache.php
class AppCache extends Cache
{
    protected function getOptions()
    {
        return array(
            'debug'                  => false,
            'default_ttl'            => 0,
            'private_headers'        => array('Authorization', 'Cookie'),
            'allow_reload'           => false,
            'allow_revalidate'       => false,
            'stale_while_revalidate' => 2,
            'stale_if_error'         => 60,
        );
    }
}

Tip

debug の値は、getOptions()メソッドで指定しない場合、AppKernelで設定された値に自動的に設定されます。

主要なオプションの一覧は以下のとおりです:

  • default_ttl: レスポンスで明示的に最新かどうかを判定する情報が指定されなかった場合に、キャッシュエントリが最新であると判定される秒数。 明示的に Cache-Control または Expires ヘッダーを指定した場合、この値は上書きされます (デフォルト: 0);
  • private_headers: レスポンスの Cache-Control ディレクティブによって public ステートまたは private ステートが明示的に指定されていない場合でも、自動的に Cache-Control を “private” として扱う他のヘッダー (デフォルト: AuthorizationCookie)。
  • allow_reload: クライアントからリクエストに Cache-Control “no-cache” ディレクティブを指定して、キャッシュを強制的にリロード可能かどうか。 RFC 2616 に従うには true に設定してください (デフォルト: false)
  • allow_revalidate: クライアントからリクエストに Cache-Control “max-age=0” ディレクティブを指定して、キャッシュの有効期限を強制的に再検証させることが可能かどうか。 RFC 2616 に従うには true に設定してください (デフォルト: false)
  • stale_while_revalidate: キャッシュが有効期限切れになりバックグラウンドで再検証が実行されている間、”stale” レスポンスを即座に返すデフォルトの秒数 (レスポンスの TTL の精度が秒なので、このオプションの精度も秒です) (デフォルト: 2)。 この設定値は HTTP Cache-Control 拡張の stale-while-revalidate で上書きされます (RFC 5861 を参照)
  • stale_if_error: エラーが発生してから、キャッシュが “stale” レスポンスを返す秒数を指定します (デフォルト: 60)。 この設定値は HTTP Cache-Control 拡張の stale-if-error で上書きされます (RFC 5861 を参照)

debugtrue に設定されている場合、Symfony2 により自動的に X-Symfony-Cache ヘッダーがレスポンスに付加されるので、キャッシュのヒットやミスなどに関する調査に役立ちます。

Note

Symfony2 リバースプロキシのパフォーマンスは、アプリケーションの複雑度には依存しません。 リクエストがアプリケーションへフォワードされた場合にのみ、アプリケーションカーネルが起動されるからです。

HTTP キャッシュの導入

キャッシュレイヤーの機能を利用するには、どのレスポンスがキャッシュ可能か、および各キャッシュを有効期限切れとみなす時間や方法をアプリケーションからチェックできる必要があります。 通常、このようなチェックを行うには、レスポンスの HTTP キャッシュヘッダーを使います。

Tip

“HTTP” というのは、Web クライアントと Web サーバーがお互いに通信するのに使う、単なる言語 (単純なテキストの言語) 以上のものではないことに注意してください。 HTTP キャッシュについて話す場合、このテキスト言語の一部分で、クライアントとサーバーがキャッシュに関連する情報をやりとりできるようにすることについて話しています。

HTTP では、次の 4 つのレスポンスキャッシュヘッダーが定義されています:

  • Cache-Control
  • Expires
  • ETag
  • Last-Modified

もっとも重要で広く利用されるヘッダーは、Cache-Control ヘッダーです。 このヘッダーには、キャッシュに関するさまざまな情報が含まれています。

Note

Each of the headers will be explained in full detail in the HTTP キャッシュの有効期限と期限切れの検証 section.

Cache-Control ヘッダー

The Cache-Control header is unique in that it contains not one, but various pieces of information about the cacheability of a response. Each piece of information is separated by a comma:

Cache-Control: private, max-age=0, must-revalidate

Cache-Control: max-age=3600, must-revalidate

Symfony provides an abstraction around the Cache-Control header to make its creation more manageable:

$response = new Response();

// mark the response as either public or private
$response->setPublic();
$response->setPrivate();

// set the private or shared max age
$response->setMaxAge(600);
$response->setSharedMaxAge(600);

// set a custom Cache-Control directive
$response->headers->addCacheControlDirective('must-revalidate', true);

レスポンスの Public と Private

Both gateway and proxy caches are considered “shared” caches as the cached content is shared by more than one user. If a user-specific response were ever mistakenly stored by a shared cache, it might be returned later to any number of different users. Imagine if your account information were cached and then returned to every subsequent user who asked for their account page!

To handle this situation, every response may be set to be public or private:

  • public: Indicates that the response may be cached by both private and shared caches;
  • private: Indicates that all or part of the response message is intended for a single user and must not be cached by a shared cache.

Symfony conservatively defaults each response to be private. To take advantage of shared caches (like the Symfony2 reverse proxy), the response will need to be explicitly set as public.

安全なメソッド

HTTP caching only works for “safe” HTTP methods (like GET and HEAD). Being safe means that you never change the application’s state on the server when serving the request (you can of course log information, cache data, etc). This has two very reasonable consequences:

  • You should never change the state of your application when responding to a GET or HEAD request. Even if you don’t use a gateway cache, the presence of proxy caches mean that any GET or HEAD request may or may not actually hit your server.
  • Don’t expect PUT, POST or DELETE methods to cache. These methods are meant to be used when mutating the state of your application (e.g. deleting a blog post). Caching them would prevent certain requests from hitting and mutating your application.

キャッシュのルールとデフォルト

HTTP 1.1 allows caching anything by default unless there is an explicit Cache-Control header. In practice, most caches do nothing when requests have a cookie, an authorization header, use a non-safe method (i.e. PUT, POST, DELETE), or when responses have a redirect status code.

Symfony2 automatically sets a sensible and conservative Cache-Control header when none is set by the developer by following these rules:

  • If no cache header is defined (Cache-Control, Expires, ETag or Last-Modified), Cache-Control is set to no-cache, meaning that the response will not be cached;
  • If Cache-Control is empty (but one of the other cache headers is present), its value is set to private, must-revalidate;
  • But if at least one Cache-Control directive is set, and no ‘public’ or private directives have been explicitly added, Symfony2 adds the private directive automatically (except when s-maxage is set).

HTTP キャッシュの有効期限と期限切れの検証

The HTTP specification defines two caching models:

  • With the expiration model, you simply specify how long a response should be considered “fresh” by including a Cache-Control and/or an Expires header. Caches that understand expiration will not make the same request until the cached version reaches its expiration time and becomes “stale”.
  • When pages are really dynamic (i.e. their representation changes often), the validation model model is often necessary. With this model, the cache stores the response, but asks the server on each request whether or not the cached response is still valid. The application uses a unique response identifier (the Etag header) and/or a timestamp (the Last-Modified header) to check if the page has changed since being cached.

The goal of both models is to never generate the same response twice by relying on a cache to store and return “fresh” responses.

有効期限

The expiration model is the more efficient and straightforward of the two caching models and should be used whenever possible. When a response is cached with an expiration, the cache will store the response and return it directly without hitting the application until it expires.

The expiration model can be accomplished using one of two, nearly identical, HTTP headers: Expires or Cache-Control.

Expires ヘッダーを使った有効期限の設定

According to the HTTP specification, “the Expires header field gives the date/time after which the response is considered stale.” The Expires header can be set with the setExpires() Response method. It takes a DateTime instance as an argument:

$date = new DateTime();
$date->modify('+600 seconds');

$response->setExpires($date);

The resulting HTTP header will look like this:

Expires: Thu, 01 Mar 2011 16:00:00 GMT

Note

The setExpires() method automatically converts the date to the GMT timezone as required by the specification.

The Expires header suffers from two limitations. First, the clocks on the Web server and the cache (e.g. the browser) must be synchronized. Then, the specification states that “HTTP/1.1 servers should not send Expires dates more than one year in the future.”

Cache-Control ヘッダーを使った有効期限の設定

Because of the Expires header limitations, most of the time, you should use the Cache-Control header instead. Recall that the Cache-Control header is used to specify many different cache directives. For expiration, there are two directives, max-age and s-maxage. The first one is used by all caches, whereas the second one is only taken into account by shared caches:

// Sets the number of seconds after which the response
// should no longer be considered fresh
$response->setMaxAge(600);

// Same as above but only for shared caches
$response->setSharedMaxAge(600);

The Cache-Control header would take on the following format (it may have additional directives):

Cache-Control: max-age=600, s-maxage=600

期限切れの検証

When a resource needs to be updated as soon as a change is made to the underlying data, the expiration model falls short. With the expiration model, the application won’t be asked to return the updated response until the cache finally becomes stale.

The validation model addresses this issue. Under this model, the cache continues to store responses. The difference is that, for each request, the cache asks the application whether or not the cached response is still valid. If the cache is still valid, your application should return a 304 status code and no content. This tells the cache that it’s ok to return the cached response.

Under this model, you mainly save bandwidth as the representation is not sent twice to the same client (a 304 response is sent instead). But if you design your application carefully, you might be able to get the bare minimum data needed to send a 304 response and save CPU also (see below for an implementation example).

Tip

The 304 status code means “Not Modified”. It’s important because with this status code do not contain the actual content being requested. Instead, the response is simply a light-weight set of directions that tell cache that it should use its stored version.

Like with expiration, there are two different HTTP headers that can be used to implement the validation model: ETag and Last-Modified.

ETag ヘッダーを使った検証

The ETag header is a string header (called the “entity-tag”) that uniquely identifies one representation of the target resource. It’s entirely generated and set by your application so that you can tell, for example, if the /about resource that’s stored by the cache is up-to-date with what your application would return. An ETag is like a fingerprint and is used to quickly compare if two different versions of a resource are equivalent. Like fingerprints, each ETag must be unique across all representations of the same resource.

Let’s walk through a simple implementation that generates the ETag as the md5 of the content:

public function indexAction()
{
    $response = $this->render('MyBundle:Main:index.html.twig');
    $response->setETag(md5($response->getContent()));
    $response->isNotModified($this->getRequest());

    return $response;
}

The Response::isNotModified() method compares the ETag sent with the Request with the one set on the Response. If the two match, the method automatically sets the Response status code to 304.

This algorithm is simple enough and very generic, but you need to create the whole Response before being able to compute the ETag, which is sub-optimal. In other words, it saves on bandwidth, but not CPU cycles.

In the 有効期限の検証を使ってコードを最適化する section, we’ll show how validation can be used more intelligently to determine the validity of a cache without doing so much work.

Tip

Symfony2 also supports weak ETags by passing true as the second argument to the setETag() method.

Last-Modified ヘッダーを使った検証

The Last-Modified header is the second form of validation. According to the HTTP specification, “The Last-Modified header field indicates the date and time at which the origin server believes the representation was last modified.” In other words, the application decides whether or not the cached content has been updated based on whether or not it’s been updated since the response was cached.

For instance, you can use the latest update date for all the objects needed to compute the resource representation as the value for the Last-Modified header value:

public function showAction($articleSlug)
{
    // ...

    $articleDate = new \DateTime($article->getUpdatedAt());
    $authorDate = new \DateTime($author->getUpdatedAt());

    $date = $authorDate > $articleDate ? $authorDate : $articleDate;

    $response->setLastModified($date);
    $response->isNotModified($this->getRequest());

    return $response;
}

The Response::isNotModified() method compares the If-Modified-Since header sent by the request with the Last-Modified header set on the response. If they are equivalent, the Response will be set to a 304 status code.

Note

The If-Modified-Since request header equals the Last-Modified header of the last response sent to the client for the particular resource. This is how the client and server communicate with each other and decide whether or not the resource has been updated since it was cached.

有効期限の検証を使ってコードを最適化する

The main goal of any caching strategy is to lighten the load on the application. Put another way, the less you do in your application to return a 304 response, the better. The Response::isNotModified() method does exactly that by exposing a simple and efficient pattern:

public function showAction($articleSlug)
{
    // Get the minimum information to compute
    // the ETag or the Last-Modified value
    // (based on the Request, data are retrieved from
    // a database or a key-value store for instance)
    $article = // ...

    // create a Response with a ETag and/or a Last-Modified header
    $response = new Response();
    $response->setETag($article->computeETag());
    $response->setLastModified($article->getPublishedAt());

    // Check that the Response is not modified for the given Request
    if ($response->isNotModified($this->getRequest())) {
        // return the 304 Response immediately
        return $response;
    } else {
        // do more work here - like retrieving more data
        $comments = // ...

        // or render a template with the $response you've already started
        return $this->render(
            'MyBundle:MyController:article.html.twig',
            array('article' => $article, 'comments' => $comments),
            $response
        );
    }
}

When the Response is not modified, the isNotModified() automatically sets the response status code to 304, removes the content, and removes some headers that must not be present for 304 responses (see setNotModified()).

Varying the Response

So far, we’ve assumed that each URI has exactly one representation of the target resource. By default, HTTP caching is done by using the URI of the resource as the cache key. If two people request the same URI of a cacheable resource, the second person will receive the cached version.

Sometimes this isn’t enough and different versions of the same URI need to be cached based on one or more request header values. For instance, if you compress pages when the client supports it, any given URI has two representations: one when the client supports compression, and one when it does not. This determination is done by the value of the Accept-Encoding request header.

In this case, we need the cache to store both a compressed and uncompressed version of the response for the particular URI and return them based on the request’s Accept-Encoding value. This is done by using the Vary response header, which is a comma-separated list of different headers whose values trigger a different representation of the requested resource:

Vary: Accept-Encoding, User-Agent

Tip

This particular Vary header would cache different versions of each resource based on the URI and the value of the Accept-Encoding and User-Agent request header.

The Response object offers a clean interface for managing the Vary header:

// set one vary header
$response->setVary('Accept-Encoding');

// set multiple vary headers
$response->setVary(array('Accept-Encoding', 'User-Agent'));

The setVary() method takes a header name or an array of header names for which the response varies.

有効期限と期限の検証

You can of course use both validation and expiration within the same Response. As expiration wins over validation, you can easily benefit from the best of both worlds. In other words, by using both expiration and validation, you can instruct the cache to server the cached content, while checking back at some interval (the expiration) to verify that the content is still valid.

Response の他のメソッド

The Response class provides many more methods related to the cache. Here are the most useful ones:

// Marks the Response stale
$response->expire();

// Force the response to return a proper 304 response with no content
$response->setNotModified();

Additionally, most cache-related HTTP headers can be set via the single setCache() method:

// Set cache settings in one call
$response->setCache(array(
    'etag'          => $etag,
    'last_modified' => $date,
    'max_age'       => 10,
    's_maxage'      => 10,
    'public'        => true,
    // 'private'    => true,
));

Edge Side Includes の使い方

Gateway caches are a great way to make your website perform better. But they have one limitation: they can only cache whole pages. If you can’t cache whole pages or if parts of a page has “more” dynamic parts, you are out of luck. Fortunately, Symfony2 provides a solution for these cases, based on a technology called ESI, or Edge Side Includes. Akama誰 wrote this specification almost 10 years ago, and it allows specific parts of a page to have a different caching strategy than the main page.

The ESI specification describes tags you can embed in your pages to communicate with the gateway cache. Only one tag is implemented in Symfony2, include, as this is the only useful one outside of Akama誰 context:

<html>
    <body>
        Some content

        <!-- Embed the content of another page here -->
        <esi:include src="http://..." />

        More content
    </body>
</html>

Note

Notice from the example that each ESI tag has a fully-qualified URL. An ESI tag represents a page fragment that can be fetched via the given URL.

When a request is handled, the gateway cache fetches the entire page from its cache or requests it from the backend application. If the response contains one or more ESI tags, these are processed in the same way. In other words, the gateway cache either retrieves the included page fragment from its cache or requests the page fragment from the backend application again. When all the ESI tags have been resolved, the gateway cache merges each into the main page and sends the final content to the client.

All of this happens transparently at the gateway cache level (i.e. outside of your application). As you’ll see, if you choose to take advantage of ESI tags, Symfony2 makes the process of including them almost effortless.

Using ESI in Symfony2

First, to use ESI, be sure to enable it in your application configuration:

  • YAML
    # app/config/config.yml
    framework:
        # ...
        esi: { enabled: true }
    
  • XML
    <!-- app/config/config.xml -->
    <framework:config ...>
        <!-- ... -->
        <framework:esi enabled="true" />
    </framework:config>
    
  • PHP
    // app/config/config.php
    $container->loadFromExtension('framework', array(
        // ...
        'esi'    => array('enabled' => true),
    ));
    

Now, suppose we have a page that is relatively static, except for a news ticker at the bottom of the content. With ESI, we can cache the news ticker independent of the rest of the page.

public function indexAction()
{
    $response = $this->render('MyBundle:MyController:index.html.twig');
    $response->setSharedMaxAge(600);

    return $response;
}

In this example, we’ve given the full-page cache a lifetime of ten minutes. Next, let’s include the news ticker in the template by embedding an action. This is done via the render helper (See templating-embedding-controller for more details).

As the embedded content comes from another page (or controller for that matter), Symfony2 uses the standard render helper to configure ESI tags:

  • Twig
    {% render '...:news' with {}, {'standalone': true} %}
    
  • PHP
    <?php echo $view['actions']->render('...:news', array(), array('standalone' => true)) ?>
    

By setting standalone to true, you tell Symfony2 that the action should be rendered as an ESI tag. You might be wondering why you would want to use a helper instead of just writing the ESI tag yourself. That’s because using a helper makes your application work even if there is no gateway cache installed. Let’s see how it works.

When standalone is false (the default), Symfony2 merges the included page content within the main one before sending the response to the client. But when standalone is true, and if Symfony2 detects that it’s talking to a gateway cache that supports ESI, it generates an ESI include tag. But if there is no gateway cache or if it does not support ESI, Symfony2 will just merge the included page content within the main one as it would have done were standalone set to false.

Note

Symfony2 detects if a gateway cache supports ESI via another Akama誰 specification that is supported out of the box by the Symfony2 reverse proxy.

The embedded action can now specify its own caching rules, entirely independent of the master page.

public function newsAction()
{
  // ...

  $response->setSharedMaxAge(60);
}

With ESI, the full page cache will be valid for 600 seconds, but the news component cache will only last for 60 seconds.

A requirement of ESI, however, is that the embedded action be accessible via a URL so the gateway cache can fetch it independently of the rest of the page. Of course, an action can’t be accessed via a URL unless it has a route that points to it. Symfony2 takes care of this via a generic route and controller. For the ESI include tag to work properly, you must define the _internal route:

  • YAML
    # app/config/routing.yml
    _internal:
        resource: "@FrameworkBundle/Resources/config/routing/internal.xml"
        prefix:   /_internal
    
  • XML
    <!-- app/config/routing.xml -->
    <?xml version="1.0" encoding="UTF-8" ?>
    
    <routes xmlns="http://symfony.com/schema/routing"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
    
        <import resource="@FrameworkBundle/Resources/config/routing/internal.xml" prefix="/_internal" />
    </routes>
    
  • PHP
    // app/config/routing.php
    use Symfony\Component\Routing\RouteCollection;
    use Symfony\Component\Routing\Route;
    
    $collection->addCollection($loader->import('@FrameworkBundle/Resources/config/routing/internal.xml', '/_internal'));
    
    return $collection;
    

Tip

Since this route allows all actions to be accessed via a URL, you might want to protect it by using the Symfony2 firewall feature (by allowing access to your reverse proxy’s IP range).

One great advantage of this caching strategy is that you can make your application as dynamic as needed and at the same time, hit the application as little as possible.

Note

Once you start using ESI, remember to always use the s-maxage directive instead of max-age. As the browser only ever receives the aggregated resource, it is not aware of the sub-components, and so it will obey the max-age directive and cache the entire page. And you don’t want that.

The render helper supports two other useful options:

  • alt: used as the alt attribute on the ESI tag, which allows you to specify an alternative URL to be used if the src cannot be found;
  • ignore_errors: if set to true, an onerror attribute will be added to the ESI with a value of continue indicating that, in the event of a failure, the gateway cache will simply remove the ESI tag silently.

Cache Invalidation

“There are only two hard things in Computer Science: cache invalidation and naming things.” –Phil Karlton

You should never need to invalidate cached data because invalidation is already taken into account natively in the HTTP cache models. If you use validation, you never need to invalidate anything by definition; and if you use expiration and need to invalidate a resource, it means that you set the expires date too far away in the future.

Note

It’s also because there is no invalidation mechanism that you can use any reverse proxy without changing anything in your application code.

Actually, all reverse proxies provide ways to purge cached data, but you should avoid them as much as possible. The most standard way is to purge the cache for a given URL by requesting it with the special PURGE HTTP method.

Here is how you can configure the Symfony2 reverse proxy to support the PURGE HTTP method:

// app/AppCache.php
class AppCache extends Cache
{
    protected function invalidate(Request $request)
    {
        if ('PURGE' !== $request->getMethod()) {
            return parent::invalidate($request);
        }

        $response = new Response();
        if (!$this->store->purge($request->getUri())) {
            $response->setStatusCode(404, 'Not purged');
        } else {
            $response->setStatusCode(200, 'Purged');
        }

        return $response;
    }
}

Caution

You must protect the PURGE HTTP method somehow to avoid random people purging your cached data.

Summary

Symfony2 was designed to follow the proven rules of the road: HTTP. Caching is no exception. Mastering the Symfony2 cache system means becoming familiar with the HTTP cache models and using them effectively. This means that, instead of relying only on Symfony2 documentation and code examples, you have access to a world of knowledge related to HTTP caching and gateway caches such as Varnish.

blog comments powered by Disqus