¿Cómo configuro correctamente el almacenamiento en caché para mi bloque personalizado que muestra contenido dependiendo del nodo actual?

Tengo este bloque muy básico que solo muestra la ID del nodo actual.

<?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']);
  }

}

Pero una vez en caché, el bloque permanece igual, independientemente del nodo que visite. ¿Cómo guardo correctamente en caché el resultado por ID de nodo?

Este es un código de trabajo completo con comentarios.

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'));
  }
}

Lo probé; funciona.

Simplemente coloque el código en un archivo llamado NodeCachedBlock.php en la carpeta de su módulo, cambie su espacio de nombres {module_name}, borre el caché y úselo.

La forma más fácil de hacerlo es confiar en el sistema de contexto de complemento / bloque.

Vea mi respuesta para ¿Cómo hago un bloque que extrae el contenido del nodo actual?

Solo tiene que poner una definición de contexto de nodo en su anotación de bloque como esta:

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

Y luego úsalo así: $this->getContextValue('node')

Lo bueno de esto es que Drupal se encargará del almacenamiento en caché por usted. Automáticamente. Porque sabe que el contexto de nodo predeterminado (y en lo que respecta al núcleo únicamente) es el nodo actual. Y eso sabe de dónde viene, por lo que el contexto de caché y las etiquetas de caché se agregan automáticamente.

Mediante \Drupal\Core\Plugin\ContextAwarePluginBase::getCacheContexts()y los getCacheTags()métodos correspondientes , BlockBase / su clase de bloque se extiende a partir de eso y hereda esos métodos.

Si deriva la clase de su complemento de bloque Drupal\Core\Block\BlockBase, tendrá dos métodos para establecer etiquetas y contextos de caché.

• getCacheTags()
• getCacheContexts()

Por ejemplo, el bloque del módulo Libro implementa esos métodos de la siguiente manera.

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

El bloque del módulo Forum utiliza el siguiente 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']);
  }

En su caso, usaría el siguiente código.

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

También podría usar el siguiente método para hacer que el bloque no se pueda almacenar en caché (incluso si lo evitaría). Podría ser útil en otros casos, tal vez.

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

Recuerda agregar use Drupal\Core\Cache\Cache; en la parte superior del archivo, si va a usar la Cacheclase.

Cuando crea una matriz de renderizado, siempre adjunte los metadatos correctos:

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'],
  ],
];

Esto no es específico del bloque y los métodos de dependencia de caché de complementos de bloque getCacheTags (), getCacheContext () y getCacheMaxAge () no son un reemplazo. Solo deben usarse para metadatos de caché adicionales, que no se pueden entregar a través de la matriz de representación.

Ver la documentación:

"Es de suma importancia que informe a la API de Render de la capacidad de almacenamiento en caché de una matriz de render"

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

Vea este ejemplo de cómo Drupal espera que una matriz de renderización proporcione los metadatos de caché necesarios al optimizar el almacenamiento en caché mediante la colocación automática de marcadores de posición y la creación diferida. Problema al configurar etiquetas de caché específicas del usuario en un bloque personalizado con el contexto del usuario

El problema aquí es que los contextos de caché no se declaran en el lugar correcto en la función de compilación:

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;
 }
}

Si llama a ese bloque en un no nodo, la función de construcción devuelve una matriz vacía, por lo que no hay contexto de caché para este bloque y ese comportamiento será almacenado en caché por drupal: la visualización de este bloque no se invalidará o representará correctamente.

La solución es simplemente inicializar $ build con los contextos de caché cada vez:

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;
 }
}

Me doy cuenta de que llego tarde a esta conversación, pero el siguiente código funcionó para mí:

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,
    ));
  }
}

¿Has intentado implementar hook_block_view_BASE_BLOCK_ID_alter?

función hook_block_view_BASE_BLOCK_ID_alter (array & $ build, \ Drupal \ Core \ Block \ BlockPluginInterface $ block) {$ build ['# cache'] ['max-age'] = 0; }