yii2/docs/guide-pt-BR/caching-http.md

Cache HTTP

Além do cache no servidor que nós descrevemos nas seções anteriores, aplicações Web pode também aproveitar-se de cache no cliente para economizar o tempo na montagem e transmissão do mesmo conteúdo de uma página.

Para usar o cache no cliente, você poderá configurar yii\filters\HttpCache como um filtro de ações de um controller ao qual o resultado de sua renderização possa ser armazenado em cache no navegador do cliente. A classe yii\filters\HttpCache funciona apenas para requisições GET e HEAD. Ele pode manipular três tipos de cache relacionados a cabeçalhos HTTP para estas requisições:

• yii\filters\HttpCache::lastModified
• yii\filters\HttpCache::etagSeed
• yii\filters\HttpCache::cacheControlHeader

Cabeçalho Last-modified

O cabeçalho Last-modified usa uma data (timestamp) para indicar se a página foi modificada desde que o cliente a armazenou em cache.

Você pode configurar a propriedade yii\filters\HttpCache::lastModified para permitir enviar o cabeçalho Last-modified. A propriedade deve ser um PHP callable retornando uma data (UNIX timestamp) sobre o tempo de modificação. A declaração do PHP callable deve ser a seguinte,

/**
 * @param Action $action O Objeto da ação que está sendo manipulada no momento
 * @param array $params o valor da propriedade "params"
 * @return int uma data(timestamp) UNIX timestamp representando o tempo da
 * última modificação na página
 */
function ($action, $params)

A seguir um exemplo que faz o uso do cabeçalho Last-modified:

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\HttpCache',
            'only' => ['index'],
            'lastModified' => function ($action, $params) {
                $q = new \yii\db\Query();
                return $q->from('post')->max('updated_at');
            },
        ],
    ];
}

O código acima afirma que o cache HTTP deve ser habilitado apenas para a ação index. Este deve gerar um cabeçalho HTTP last-modified baseado na última data de alteração dosposts. Quando um navegador visitar a página index pela primeira vez, a página será gerada no servidor e enviada para o navegador; Se o navegador visitar a mesma página novamente e não houver modificação dos posts durante este período, o servidor não irá remontará a página e o navegador usará a versão em cache no cliente. Como resultado, a renderização do conteúdo na página não será executada no servidor.

Cabeçalho ETag

O cabeçalho "Entity Tag" (ou ETag abreviado) usa um hash para representar o conteúdo de uma página. Se a página for alterada, o hash irá mudar também. Ao comparar o hash mantido no cliente com o hash gerado no servidor, o cache pode determinar se a página foi alterada e se deve ser retransmitida.

Você pode configurar a propriedade yii\filters\HttpCache::etagSeed para habilitar o envio do cabeçalho ETag. A propriedade deve ser um PHP callable retornando um conteúdo ou dados serializados (chamado também de seed na referência americana) para a geração do hash do Etag. A declaração do PHP callable deve ser como a seguinte,

/**
 * @param Action $action o objeto da ação que está sendo manipulada no momento
 * @param array $params o valor da propriedade "params"
 * @return string uma string usada como um conteúdo para gerar o hash ETag
 */
function ($action, $params)

A seguir um exemplo que faz o uso do cabeçalho ETag:

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\HttpCache',
            'only' => ['view'],
            'etagSeed' => function ($action, $params) {
                $post = $this->findModel(\Yii::$app->request->get('id'));
                return serialize([$post->title, $post->content]);
            },
        ],
    ];
}

O código acima afirma que o cache de HTTP deve ser habilitado apenas para a ação view. Este deve gerar um cabeçalho HTTP ETag baseado no título e no conteúdo do post requisitado. Quando um navegador visitar a página view pela primeira vez, a página será gerada no servidor e enviada para ele; Se o navegador visitar a mesma página novamente e não houver alteração para o título e o conteúdo do post, o servidor não remontará a página e o navegador usará a versão que estiver no cache do cliente. Como resultado, a renderização do conteúdo na página não será executada no servidor.

ETags permite estratégias mais complexas e/ou mais precisas do que o uso do cabeçalho de Last-modified. Por exemplo, um ETag pode ser invalidado se o site tiver sido alterado para um novo tema.

Gerações muito complexas de ETags podem contrariar o propósito de se usar HttpCache e introduzir despesas desnecessárias ao processamento, já que eles precisam ser reavaliados a cada requisição. Tente encontrar uma expressão simples que invalida o cache se o conteúdo da página for modificado.

Observação: Em concordância com a RFC 7232, o HttpCache enviará os cabeçalhos ETag e Last-Modified se ambos forem assim configurados. E se o cliente enviar ambos o cabeçalhos If-None-Match e If-Modified-Since, apenas o primeiro será respeitado.

Cabeçalho Cache-Control

O cabeçalho Cache-Control especifica políticas de cache gerais para as páginas. Você pode enviá-lo configurando a propriedade yii\filters\HttpCache::cacheControlHeader com o valor do cabeçalho. Por padrão, o seguinte cabeçalho será enviado:

Cache-Control: public, max-age=3600

Limitador de Cache na Sessão

Quando uma página usa sessão, o PHP automaticamente enviará alguns cabeçalhos HTTP relacionados ao cache como especificado na configuração session.cache_limiter do PHP.INI. Estes cabeçalhos podem interferir ou desabilitar o cache que você deseja do HttpCache. Para prevenir-se deste problema, por padrão, o HttpCache desabilitará o envio destes cabeçalhos automaticamente. Se você quiser modificar estes comportamentos, deve configurar a propriedade yii\filters\HttpCache::sessionCacheLimiter. A propriedade pode receber um valor string, como: public, private, private_no_expire e nocache. Por favor, consulte o manual do PHP sobre session_cache_limiter() para mais explicações sobre estes valores.

Implicações para SEO

Os bots do motor de buscas tendem a respeitar cabeçalhos de cache. Já que alguns rastreadores têm um limite sobre a quantidade de páginas por domínio que eles processam em um certo espaço de tempo, introduzir cabeçalhos de cache podem ajudar na indexação do seu site já que eles reduzem o número de páginas que precisam ser processadas.