現在のノードに応じてコンテンツを表示するカスタムブロックのキャッシュを正しく設定するにはどうすればよいですか？

現在のノードの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、キャッシュタグとコンテキストを設定する2つのメソッドがあります。

• 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（）は代替ではありません。これらは、レンダー配列を介して配信できない追加のキャッシュメタデータにのみ使用する必要があります。

ドキュメントを参照してください：

「レンダー配列のキャッシュ可能性をレンダーAPIに通知することが最も重要です。」

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

自動placeholderingとレイジー構築を通じてキャッシュを最適化する際にDrupalは必要に応じてキャッシュメタデータを提供するために、レンダリングの配列を期待どのようにこの例を参照してくださいユーザーコンテキストでカスタムブロックにユーザー固有のキャッシュタグの設定の問題

ここでの問題は、キャッシュコンテキストがビルド関数の適切な場所で宣言されていないことです。

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を実装しようとしましたか？

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