Como configuro corretamente o cache do meu bloco personalizado que mostra o conteúdo, dependendo do nó atual?

Eu tenho esse bloco muito básico que apenas mostra o ID do nó atual.

<?php

/**
 * @file
 * Contains \Drupal\mymodule\Plugin\Block\ExampleEmptyBlock.
 */

namespace Drupal\mymodule\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\Cache\Cache;

/**
 * @Block(
 *   id = "example_empty",
 *   admin_label = @Translation("Example: empty block")
 * )
 */
class ExampleEmptyBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $node = \Drupal::routeMatch()->getParameter('node');
    $build = array();

    if ($node) {
      $config = \Drupal::config('system.site');

      $build = array(
        '#type' => 'markup',
        '#markup' => '<p>' . $node->id() . '<p>',
        '#cache' => array(
          'tags' => $this->getCacheTags(),
          'contexts' => $this->getCacheContexts(),
        ),
      );
    }

    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $node = \Drupal::routeMatch()->getParameter('node');
    return Cache::mergeTags(parent::getCacheTags(), ["node:{$node->id()}"]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), ['user.node_grants:view']);
  }

}

Porém, uma vez armazenado em cache, o bloco permanece o mesmo, independentemente de qual nó eu visito. Como faço para armazenar em cache corretamente o resultado por ID do nó?

Este é um código de trabalho completo com comentários.

namespace Drupal\module_name\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\Cache\Cache;

/**
 * Provides a Node cached block that display node's ID.
 *
 * @Block(
 *   id = "node_cached_block",
 *   admin_label = @Translation("Node Cached")
 * )
 */
class NodeCachedBlock extends BlockBase {
  public function build() {
    $build = array();
    //if node is found from routeMatch create a markup with node ID's.
    if ($node = \Drupal::routeMatch()->getParameter('node')) {
      $build['node_id'] = array(
        '#markup' => '<p>' . $node->id() . '<p>',
      );
    }
    return $build;
  }

  public function getCacheTags() {
    //With this when your node change your block will rebuild
    if ($node = \Drupal::routeMatch()->getParameter('node')) {
      //if there is node add its cachetag
      return Cache::mergeTags(parent::getCacheTags(), array('node:' . $node->id()));
    } else {
      //Return default tags instead.
      return parent::getCacheTags();
    }
  }

  public function getCacheContexts() {
    //if you depends on \Drupal::routeMatch()
    //you must set context of this block with 'route' context tag.
    //Every new route this block will rebuild
    return Cache::mergeContexts(parent::getCacheContexts(), array('route'));
  }
}

Eu testei; funciona.

Basta colocar o código em um arquivo chamado NodeCachedBlock.php na pasta do módulo, alterar o espaço para nome {module_name}, limpar o cache e usá-lo.

A maneira mais fácil de fazer isso é confiar no sistema de contexto de plug-in / bloco.

Veja minha resposta em Como faço para criar um bloco que puxa o conteúdo atual do nó?

Você só precisa colocar uma definição de contexto de nó na anotação de bloco, como segue:

*   context = {
*     "node" = @ContextDefinition("entity:node", label = @Translation("Node"))
*   }

E então use-o assim: $this->getContextValue('node')

O bom disso é que o Drupal cuidará do cache para você. Automaticamente. Porque ele sabe que o contexto do nó padrão (e no que diz respeito apenas ao núcleo) é o nó atual. E como sabe de onde vem, o contexto e as tags de cache são adicionados automaticamente.

Através \Drupal\Core\Plugin\ContextAwarePluginBase::getCacheContexts()dos getCacheTags()métodos correspondentes , BlockBase / sua classe de bloco se estende disso e herda esses métodos.

Se você derivar a classe do seu plug-in de bloco Drupal\Core\Block\BlockBase, você terá dois métodos para definir tags e contextos de cache.

• getCacheTags()
• getCacheContexts()

Por exemplo, o bloco do módulo Livro implementa esses métodos da seguinte maneira.

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), ['route.book_navigation']);
  }

O bloco do módulo Fórum usa o seguinte código.

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), ['user.node_grants:view']);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return Cache::mergeTags(parent::getCacheTags(), ['node_list']);
  }

No seu caso, eu usaria o seguinte código.

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $node = \Drupal::routeMatch()->getParameter('node');
    return Cache::mergeTags(parent::getCacheTags(), ["node:{$node->id()}"]);
  }

Você também pode usar o método a seguir, para tornar o bloco inalcançável, mesmo que eu o evite. Pode ser útil em outros casos, talvez.

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

Lembre-se de adicionar use Drupal\Core\Cache\Cache;na parte superior do arquivo, se você for usar a Cacheclasse.

Ao criar uma matriz de renderização, sempre anexe os metadados corretos:

use Drupal\Core\Cache\Cache;

$build['node_id'] = [
  '#markup' => '<p>' . $node->id() . '<p>',
  '#cache' => [
    'tags' => $node->getCacheTags(),
    // add a context if the node is dependent on the route match
    'contexts' => ['route'],
  ],
];

Isso não é específico de um bloco e os métodos de dependência de cache de plug-ins de bloco getCacheTags (), getCacheContext () e getCacheMaxAge () não são um substituto. Eles devem ser usados ​​apenas para metadados de cache adicionais, que não podem ser entregues através da matriz de renderização.

Veja a documentação:

"É da maior importância que você informe a API Render da capacidade de cache de uma matriz de renderização".

https://www.drupal.org/docs/8/api/render-api/cacheability-of-render-arrays

Veja este exemplo de como o Drupal espera que uma matriz de renderização forneça os metadados de cache necessários ao otimizar o armazenamento em cache por meio de reserva automática e construção lenta Problema ao definir tags de cache específicas do usuário no bloco personalizado com o contexto do usuário

O problema aqui é que os contextos de cache não são declarados no lugar certo na função de construção:

class ExampleEmptyBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
   $node = \Drupal::routeMatch()->getParameter('node');
   $build = array();

   if ($node) {
    $config = \Drupal::config('system.site');

    $build = array(
    '#type' => 'markup',
    '#markup' => '<p>' . $node->id() . '<p>',
    '#cache' => array(
      'tags' => $this->getCacheTags(),
      'contexts' => $this->getCacheContexts(),
    ),
   );
 }
 return $build;
 }
}

Se você chamar esse bloco em um não nó, a função de compilação retornará uma matriz vazia, para que não haja contexto de cache para esse bloco e esse comportamento será armazenado em cache por drupal: a exibição desse bloco não invalidará ou será renderizada corretamente.

A solução é apenas inicializar o $ build com os contextos de cache sempre:

class ExampleEmptyBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
   $node = \Drupal::routeMatch()->getParameter('node');

    $build = array(
    '#cache' => array(
      'tags' => $this->getCacheTags(),
      'contexts' => $this->getCacheContexts(),
    ),
   );

   if ($node) {
    $config = \Drupal::config('system.site');

    $build['#markup'] = '<p>' . $node->id() . '<p>';
    $build['#type'] = 'markup';
    }
 return $build;
 }
}

Percebo que estou atrasado para esta conversa, mas o código abaixo funcionou para mim:

class ExampleBlock extends BlockBase
{

  public function build()
  {
    $lcContent = '';

    $loNode = \Drupal::routeMatch()->getParameter('node');

    if (!$loNode)
    {
      return (array(
        '#type' => 'markup',
        '#cache' => array('max-age' => 0),
        '#markup' => $lcContent,
      ));
    }

    $lcContent .= "<div id='example_block' style='overflow: hidden; clear: both;'>\n";
    $lcContent .= $loNode->id();
    $lcContent .= "</div>\n";

    return (array(
      '#type' => 'markup',
      '#cache' => array('max-age' => 0),
      '#markup' => $lcContent,
    ));
  }
}

Você já tentou implementar hook_block_view_BASE_BLOCK_ID_alter?

função hook_block_view_BASE_BLOCK_ID_alter (matriz & $ build, \ Drupal \ Core \ Block \ BlockPluginInterface $ block) {$ build ['# cache'] ['max-age'] = 0; }