如何根据当前节点为显示内容的自定义块正确设置缓存？

我有一个非常基本的块，它仅显示当前节点的ID。

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

}

但是，一旦缓存，该块将保持不变，无论我访问哪个节点。如何正确缓存每个节点ID的结果？

这是带有注释的完整工作代码。

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

我测试过了 有用。

只需将代码放入模块文件夹中名为NodeCachedBlock.php的文件中，更改其命名空间{module_name}，清除缓存并使用它。

到目前为止，最简单的方法是依靠插件/块上下文系统。

请参阅我的答案，以了解如何制作一个提取当前节点内容的块？

您只需要在块注释中放置一个节点上下文定义，如下所示：

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

然后像这样使用它： $this->getContextValue('node')

这样做的好处是Drupal会为您处理缓存。自动地。因为它知道默认的节点上下文（并且仅就核心而言）是当前节点。而且知道了它的来源，因此自动添加了缓存上下文和缓存标签。

通过\Drupal\Core\Plugin\ContextAwarePluginBase::getCacheContexts()和相应的getCacheTags()方法，BlockBase /您的块类从该类扩展而来，并继承这些方法。

如果从派生块插件的类Drupal\Core\Block\BlockBase，则将有两种方法来设置缓存标记和上下文。

• getCacheTags()
• getCacheContexts()

例如，Book模块块实现了以下方法。

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

论坛模块块使用以下代码。

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

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

在您的情况下，我将使用以下代码。

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

您也可以使用以下方法，使该块完全不可缓存（即使我会避免）。也许在其他情况下可能有用。

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

use Drupal\Core\Cache\Cache;如果要使用Cache该类，请记住在文件顶部添加。

构建渲染数组时，请始终附加正确的元数据：

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

这不是特定于块的，并且块插件缓存依赖方法getCacheTags（），getCacheContext（）和getCacheMaxAge（）不能替代。它们仅应用于其他缓存元数据，而这些元数据不能通过渲染数组传递。

请参阅文档：

“将渲染数组的可缓存性告知Render API，这一点至关重要。”

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

看到这个例子中的Drupal如何期望优化通过自动placeholdering和懒建设缓存时渲染阵列以提供必要的高速缓存元数据与用户上下文定制块上设置问题的用户专用高速缓存标签

这里的问题是，缓存上下文未在构建函数中的正确位置声明：

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

如果在非节点上调用该块，则构建函数将返回一个空数组，因此该块没有缓存上下文，并且该行为将被drupal缓存：该块的显示不会正确无效或呈现。

解决方案是每次都使用缓存上下文初始化$ build：

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

我意识到自己这次对话很晚，但是下面的代码对我有用：

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

您是否尝试过实现hook_block_view_BASE_BLOCK_ID_alter？

函数hook_block_view_BASE_BLOCK_ID_alter（array＆$ build，\ Drupal \ Core \ Block \ BlockPluginInterface $ block）{$ build ['＃cache'] ['max-age'] = 0; }