Invalidar páginas em cache do AEM invalidating-cached-pages-from-aem

Ao usar o Dispatcher com o AEM, a interação deve ser configurada para garantir um gerenciamento eficiente do cache. Dependendo do seu ambiente, a configuração também pode aumentar o desempenho.

Configuração das contas de usuário do AEM setting-up-aem-user-accounts

A conta de usuário admin padrão é usada para autenticar os agentes de replicação instalados por padrão. Você deve criar uma conta de usuário dedicada para usar com agentes de replicação.

Para obter mais informações, consulte a seção Configuração de usuários de replicação e transporte da Lista de verificação de segurança do AEM.

Invalidação do cache do Dispatcher no ambiente de criação invalidating-dispatcher-cache-from-the-authoring-environment

Um agente de replicação na instância do autor do AEM envia uma solicitação de invalidação de cache para o Dispatcher quando uma página é publicada. A solicitação faz com que o Dispatcher posteriormente atualize o arquivo no cache conforme o novo conteúdo é publicado.

Use o procedimento a seguir para configurar um agente de replicação na instância do autor do AEM para invalidar o cache do Dispatcher na ativação da página:

Como alternativa, você também pode acessar e configurar o agente de limpeza do Dispatcher direto do AEM Touch UI.

Para obter detalhes adicionais sobre como habilitar o acesso a URLs personalizados, consulte Habilitação de acesso a URLs personalizados.

Há dois problemas potenciais com essa abordagem:

Invalidação do cache do Dispatcher de uma Instância de publicação invalidating-dispatcher-cache-from-a-publishing-instance

Em determinadas circunstâncias, os ganhos de desempenho podem ser feitos pela transferência do gerenciamento de cache do ambiente de criação para uma instância de publicação. Em seguida, será o ambiente de publicação (não o ambiente de criação do AEM) que enviará uma solicitação de invalidação de cache para o Dispatcher quando uma página publicada for recebida.

Essas circunstâncias incluem:

A liberação do dispatcher é controlada por um agente de replicação que opera na instância de publicação. No entanto, a configuração é feita no ambiente de criação e depois transferida pela ativação do agente:

Após a configuração, ao ativar uma página do autor para publicar, esse agente inicia uma replicação padrão. O log inclui mensagens indicando solicitações provenientes do seu servidor de publicação, semelhantes ao seguinte exemplo:

Invalidação manual do cache do Dispatcher manually-invalidating-the-dispatcher-cache

Para invalidar (ou liberar) o cache do Dispatcher sem ativar uma página, você pode emitir uma solicitação HTTP para o Dispatcher. Por exemplo, você pode criar um aplicativo do AEM que permita aos administradores ou outros aplicativos liberar o cache.

A solicitação HTTP faz com que o Dispatcher exclua arquivos específicos do cache. Como opção, o Dispatcher atualiza o cache com uma nova cópia.

Exclusão de arquivos em cache delete-cached-files

Emita uma solicitação HTTP que faz com que o Dispatcher exclua arquivos do cache. O Dispatcher armazena os arquivos em cache novamente somente quando recebe uma solicitação do cliente para a página. A exclusão de arquivos em cache dessa maneira é adequada para sites que provavelmente não receberão solicitações simultâneas para a mesma página.

A solicitação HTTP tem o seguinte formato:

POST /dispatcher/invalidate.cache HTTP/1.1
CQ-Action: Activate
CQ-Handle: path-pattern
Content-Length: 0

O Dispatcher libera (exclui) os arquivos e pastas em cache com nomes que correspondam ao valor do cabeçalho CQ-Handler. Por exemplo, um CQ-Handle de /content/geomtrixx-outdoors/en corresponde aos seguintes itens:

Todos os outros arquivos no cache do dispatcher (ou até um nível específico, dependendo da configuração /statfileslevel) são invalidados ao tocar no arquivo .stat. A última data de modificação desse arquivo é comparada com a última data de modificação de um documento em cache, e o documento será buscado novamente se o arquivo .stat for mais recente. Consulte Invalidação de arquivos por nível de pasta para obter mais detalhes.

A invalidação (ou seja, tocar em arquivos .stat) pode ser evitada ao enviar um Cabeçalho adicional CQ-Action-Scope: ResourceOnly. Isso pode ser usado para liberar recursos específicos sem invalidar outras partes do cache, como dados JSON criados dinamicamente e que exigem limpeza regular independente do cache (por exemplo, representando dados obtidos de um sistema de terceiros para exibir notícias, marcadores de ações etc.).

Exclusão e rearmazenamento de arquivos em cache delete-and-recache-files

Emita uma solicitação HTTP que faz com que o Dispatcher exclua arquivos em cache e, imediatamente, recupere e armazene o arquivo em cache novamente. Exclua e imediatamente armazene arquivos em cache novamente quando houver probabilidade de os sites receberem solicitações simultâneas do cliente para a mesma página. O rearmazenamento em cache imediato garante que o Dispatcher recupere e armazene em cache a página apenas uma vez, e não um vez para cada uma das solicitações simultâneas do cliente.

Observação: a exclusão e o rearmazenamento em cache de arquivos devem ser executados somente na instância de publicação. Quando executados da instância do autor, as condições de corrida ocorrem mediante tentativas de recuperar recursos antes de serem publicadas.

A solicitação HTTP tem o seguinte formato:

POST /dispatcher/invalidate.cache HTTP/1.1
CQ-Action: Activate
`Content-Type: text/plain
CQ-Handle: path-pattern
Content-Length: numchars in bodypage_path0

page_path1
...
page_pathn

Os caminhos da página para rearmazenamento imediato são listados em linhas separadas no corpo da mensagem. O valor de CQ-Handle é o caminho de uma página que invalida as páginas para o rearmazenamento em cache. (Consulte o parâmetro /statfileslevel do item de configuração do Cache.) O exemplo de mensagem de solicitação HTTP a seguir exclui e rearmazena em cache o /content/geometrixx-outdoors/en.html page:

POST /dispatcher/invalidate.cache HTTP/1.1
CQ-Action: Activate
Content-Type: text/plain
CQ-Handle: /content/geometrixx-outdoors/en/men.html
Content-Length: 36

/content/geometrixx-outdoors/en.html

Exemplo de servlet de liberação example-flush-servlet

O código a seguir implementa um servlet que envia uma solicitação de invalidação para o Dispatcher. O servlet recebe uma mensagem de solicitação que contém os parâmetros handle e page. Esses parâmetros fornecem o valor do cabeçalho CQ-Handle e o caminho da página para refazer o armazenamento em cache, respectivamente. O servlet usa os valores para criar a solicitação HTTP para o Dispatcher.

Quando o servlet é implantado na instância de publicação, o seguinte URL faz com que o Dispatcher exclua a página /content/geometrixx-outdoors/en.html e, em seguida, armazene em cache uma nova cópia.

10.36.79.223:4503/bin/flushcache/html?page=/content/geometrixx-outdoors/en.html&handle=/content/geometrixx-outdoors/en/men.html

package com.adobe.example;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Property;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.StringRequestEntity;

@Component(metatype=true)
@Service
public class Flushcache extends SlingSafeMethodsServlet {

 @Property(value="/bin/flushcache")
 static final String SERVLET_PATH="sling.servlet.paths";

 private Logger logger = LoggerFactory.getLogger(this.getClass());

 public void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  try{
      //retrieve the request parameters
      String handle = request.getParameter("handle");
      String page = request.getParameter("page");

      //hard-coding connection properties is a bad practice, but is done here to simplify the example
      String server = "localhost";
      String uri = "/dispatcher/invalidate.cache";

      HttpClient client = new HttpClient();

      PostMethod post = new PostMethod("https://"+host+uri);
      post.setRequestHeader("CQ-Action", "Activate");
      post.setRequestHeader("CQ-Handle",handle);

      StringRequestEntity body = new StringRequestEntity(page,null,null);
      post.setRequestEntity(body);
      post.setRequestHeader("Content-length", String.valueOf(body.getContentLength()));
      client.executeMethod(post);
      post.releaseConnection();
      //log the results
      logger.info("result: " + post.getResponseBodyAsString());
      }
  }catch(Exception e){
      logger.error("Flushcache servlet exception: " + e.getMessage());
  }
 }
}