Làm cách nào để thiết lập chính xác bộ đệm ẩn cho khối tùy chỉnh hiển thị nội dung tùy thuộc vào nút hiện tại?

Tôi có khối rất cơ bản này chỉ hiển thị ID của nút hiện tại.

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

}

Nhưng một khi được lưu trữ, khối vẫn giữ nguyên, bất kể tôi truy cập nút nào. Làm cách nào để tôi lưu chính xác kết quả vào mỗi ID nút?

Đây là mã làm việc đầy đủ với ý kiến.

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

Tôi đã thử nó; nó hoạt động

Chỉ cần đặt mã vào một tệp có tên NodeCachedBlock.php trong thư mục mô-đun của bạn, thay đổi không gian tên của nó {module_name}, xóa bộ đệm và sử dụng nó.

Cách dễ nhất để làm điều này là dựa vào hệ thống ngữ cảnh plugin / chặn.

Xem câu trả lời của tôi để biết cách tạo khối kéo nội dung nút hiện tại?

Bạn chỉ cần đặt một định nghĩa ngữ cảnh nút trong chú thích khối của bạn như thế này:

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

Và sau đó sử dụng nó như thế này: $this->getContextValue('node')

Điều tuyệt vời ở đây là Drupal sẽ chăm sóc bộ nhớ đệm cho bạn. Tự động. Bởi vì nó biết rằng bối cảnh nút mặc định (và theo như cốt lõi) là nút hiện tại. Và điều đó biết nó đến từ đâu, vì vậy bối cảnh bộ nhớ cache và thẻ bộ nhớ cache được thêm tự động.

Thông qua \Drupal\Core\Plugin\ContextAwarePluginBase::getCacheContexts()và các getCacheTags()phương thức tương ứng , BlockBase / lớp khối của bạn mở rộng từ đó và kế thừa các phương thức đó.

Nếu bạn lấy được lớp của plugin khối từ đó Drupal\Core\Block\BlockBase, bạn sẽ có hai phương pháp để đặt thẻ và bối cảnh bộ đệm.

• getCacheTags()
• getCacheContexts()

Ví dụ, khối mô-đun Sách thực hiện các phương thức đó như sau.

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

Khối mô-đun diễn đàn sử dụng mã sau đây.

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

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

Trong trường hợp của bạn, tôi sẽ sử dụng mã sau đây.

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

Bạn cũng có thể sử dụng phương pháp sau đây, để làm cho khối không thể điều khiển được (ngay cả khi tôi sẽ tránh nó). Nó có thể hữu ích trong các trường hợp khác, có thể.

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

Nhớ thêm use Drupal\Core\Cache\Cache;vào đầu tập tin, nếu bạn định sử dụng Cachelớp.

Khi bạn xây dựng một mảng kết xuất, luôn luôn đính kèm siêu dữ liệu chính xác:

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

Đây không phải là khối cụ thể và các phương thức phụ thuộc bộ đệm của bộ đệm getCacheTags (), getCacheContext () và getCacheMaxAge () không phải là sự thay thế. Chúng chỉ nên được sử dụng cho siêu dữ liệu bộ đệm bổ sung, không thể được phân phối thông qua mảng kết xuất.

Xem tài liệu:

"Điều quan trọng nhất là bạn thông báo cho API kết xuất về khả năng lưu trữ của một mảng kết xuất."

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

Xem ví dụ này về cách Drupal mong đợi một mảng kết xuất cung cấp siêu dữ liệu bộ đệm cần thiết khi tối ưu hóa bộ đệm ẩn thông qua tự động giữ chỗ và xây dựng lười biếng Vấn đề đặt thẻ bộ nhớ cache cụ thể của người dùng trên khối tùy chỉnh với ngữ cảnh người dùng

Vấn đề ở đây là bối cảnh bộ đệm không được khai báo ở đúng nơi trong chức năng xây dựng:

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

Nếu bạn gọi khối đó trên một nút không, hàm xây dựng trả về một mảng trống, do đó không có bối cảnh bộ đệm cho khối này và hành vi đó sẽ được lưu trong bộ đệm bởi drupal: hiển thị của khối này sẽ không hợp lệ hoặc được hiển thị đúng.

Giải pháp chỉ là khởi tạo $ build với bối cảnh bộ đệm mọi lúc:

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

Tôi nhận ra rằng tôi đến trễ cuộc trò chuyện này, nhưng đoạn mã dưới đây đã làm việc cho tôi:

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

Bạn đã thử triển khai hook_block_view_BASE_BLOCK_ID_alter chưa?

hàm hook_block_view_BASE_BLOCK_ID_alter (mảng & $ build, \ Drupal \ Core \ Block \ BlockPluginInterface $ block) {$ build ['# cache'] ['max-age'] = 0; }