Magento 2：在PHTML或Block中动态加载模板文件

本文详细介绍了在magento 2中，如何不依赖布局xml文件，直接从phtml模板或php block类中动态调用并渲染其他phtml模板文件。文章提供了两种主要方法：通过phtml文件中的`getlayout()`方法，以及通过php block类中注入`layoutinterface`或`blockfactory`来创建和渲染模板，并强调了使用依赖注入的最佳实践，避免直接使用`objectmanager`。

在Magento 2的开发实践中，通常我们通过布局XML文件来定义页面的结构，并将Block与PHTML模板关联起来。然而，在某些特定的场景下，例如需要根据动态条件加载不同的模板片段，或者在现有PHTML模板内部需要插入一个独立的、可复用的模板组件时，直接从PHTML文件或PHP Block类中动态调用并渲染模板会更加灵活和高效。本文将深入探讨如何在不依赖布局XML的情况下实现这一目标。

1. 从PHTML模板文件中直接调用模板

当您需要在当前的PHTML模板内部直接引入并渲染另一个PHTML模板文件时，可以使用当前模板的Layout对象来创建并渲染新的模板。

示例代码：

<?php
/**
 * @var \Magento\Framework\View\Element\Template $block
 */

echo $block->getLayout()
           ->createBlock(\Magento\Framework\View\Element\Template::class)
           ->setTemplate('Vendor_Module::path/to/your/template.phtml')
           ->toHtml();
?>

代码解析：

立即学习“前端免费学习笔记（深入）”；

• $block->getLayout(): 获取当前Block实例的布局对象。
• createBlock(\Magento\Framework\View\Element\Template::class): 使用布局对象创建一个新的通用模板Block实例。\Magento\Framework\View\Element\Template 是一个通用的Block类型，适用于大多数简单的模板渲染场景。如果您需要调用一个具有特定业务逻辑的自定义Block，可以替换为您的自定义Block类名。
• setTemplate('Vendor_Module::path/to/your/template.phtml'): 设置要渲染的PHTML模板文件的路径。Vendor_Module是您的模块名称，path/to/your/template.phtml是相对于该模块view/frontend/templates/或view/adminhtml/templates/目录的路径。
• toHtml(): 渲染并返回模板的HTML内容。

适用场景： 这种方法适用于在现有PHTML文件中动态插入小部件、通用提示信息或任何不需要复杂逻辑的独立模板片段。

2. 从PHP Block类中动态调用模板

在PHP Block类中动态调用模板更为常见，尤其当您需要在Block的业务逻辑中根据条件判断或数据处理结果来决定渲染哪个模板时。

不推荐的做法（但可实现）：使用ObjectManager

尽管以下代码可以实现功能，但在Magento 2中，直接使用ObjectManager::getInstance()被视为一种反模式，因为它破坏了依赖注入的原则，增加了代码的耦合度，并使得单元测试变得困难。

<?php
// 这是一个不推荐的示例，仅为说明其可行性
$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$templateBlock = $objectManager->create(\Magento\Framework\View\Element\Template::class);
$templateBlock->setTemplate('Vendor_Module::path/to/your/template.phtml');
$content = $templateBlock->toHtml();
// ... 在Block的其他方法中使用 $content
?>

推荐做法：使用依赖注入 (Dependency Injection)

正确的做法是通过构造函数依赖注入\Magento\Framework\View\LayoutInterface或\Magento\Framework\View\Element\BlockFactory来创建模板Block。

Khroma

AI调色盘生成工具

下载

步骤一：在Block类的构造函数中注入依赖

<?php
namespace Vendor\Module\Block;

use Magento\Framework\View\Element\Template;
use Magento\Framework\View\Element\Template\Context;
use Magento\Framework\View\LayoutInterface; // 或者使用 \Magento\Framework\View\Element\BlockFactory

class MyCustomBlock extends Template
{
    /**
     * @var LayoutInterface
     */
    protected $layout;

    /**
     * @param Context $context
     * @param LayoutInterface $layout
     * @param array $data
     */
    public function __construct(
        Context $context,
        LayoutInterface $layout, // 注入LayoutInterface
        array $data = []
    ) {
        $this->layout = $layout;
        parent::__construct($context, $data);
    }

    /**
     * 动态获取并渲染一个模板
     *
     * @return string
     */
    public function getDynamicTemplateHtml(): string
    {
        /** @var \Magento\Framework\View\Element\Template $templateBlock */
        $templateBlock = $this->layout->createBlock(\Magento\Framework\View\Element\Template::class);
        $templateBlock->setTemplate('Vendor_Module::path/to/your/dynamic_template.phtml');
        // 您也可以在这里向模板传递数据，例如：
        // $templateBlock->setData('custom_variable', 'Hello from Block!');
        return $templateBlock->toHtml();
    }
}

代码解析：

立即学习“前端免费学习笔记（深入）”；

• LayoutInterface $layout: 在构造函数中注入LayoutInterface。这是获取Layout对象并创建Block的推荐方式。
• $this->layout->createBlock(\Magento\Framework\View\Element\Template::class): 使用注入的LayoutInterface实例来创建模板Block。
• setTemplate('Vendor_Module::path/to/your/dynamic_template.phtml'): 设置要渲染的PHTML模板路径。
• toHtml(): 渲染并返回模板的HTML内容。

替代方法：注入BlockFactory

如果您更倾向于使用工厂模式来创建Block，可以注入\Magento\Framework\View\Element\BlockFactory：

<?php
namespace Vendor\Module\Block;

use Magento\Framework\View\Element\Template;
use Magento\Framework\View\Element\Template\Context;
use Magento\Framework\View\Element\BlockFactory;

class MyCustomBlock extends Template
{
    /**
     * @var BlockFactory
     */
    protected $blockFactory;

    /**
     * @param Context $context
     * @param BlockFactory $blockFactory
     * @param array $data
     */
    public function __construct(
        Context $context,
        BlockFactory $blockFactory, // 注入BlockFactory
        array $data = []
    ) {
        $this->blockFactory = $blockFactory;
        parent::__construct($context, $data);
    }

    /**
     * 动态获取并渲染一个模板
     *
     * @return string
     */
    public function getDynamicTemplateHtmlWithFactory(): string
    {
        /** @var \Magento\Framework\View\Element\Template $templateBlock */
        $templateBlock = $this->blockFactory->createBlock(\Magento\Framework\View\Element\Template::class);
        $templateBlock->setTemplate('Vendor_Module::path/to/your/factory_template.phtml');
        return $templateBlock->toHtml();
    }
}

适用场景： 这种方法适用于Block中需要根据复杂的业务逻辑来决定渲染哪个模板，或者需要向动态加载的模板传递特定数据的情况。

3. 关于模板路径的注意事项

Vendor_Module::template.phtml这种格式是Magento 2中推荐的模板路径写法，它会自动解析到模块的view/frontend/templates/或view/adminhtml/templates/目录下。

• Vendor_Module: 代表您的模块名称，例如Magento_Cms。
• template.phtml: 是相对于模块templates目录的模板文件路径。如果模板在子目录中，例如view/frontend/templates/customer/form.phtml，则路径应写为Vendor_Module::customer/form.phtml。

总结

在Magento 2中，直接从PHTML模板或PHP Block类中动态调用和渲染其他模板文件，为开发者提供了极大的灵活性，尤其适用于构建动态内容或可复用组件。无论是从PHTML内部使用$block->getLayout()，还是从PHP Block类中通过依赖注入LayoutInterface或BlockFactory，都能够有效地实现这一目标。

关键注意事项：

• 避免使用ObjectManager： 始终坚持使用依赖注入来获取所需的类实例，以保持代码的清晰性、可测试性和可维护性。
• 模板路径： 遵循Vendor_Module::path/to/template.phtml的命名约定。
• 数据传递： 如果动态加载的模板需要数据，可以通过$templateBlock->setData('key', $value)方法向其传递数据。
• 性能考量： 频繁地动态创建和渲染Block可能会对性能产生轻微影响，但对于大多数场景而言，这种影响通常可以忽略不计。在性能敏感的区域，应权衡其灵活性与潜在的开销。

掌握这些技术将使您在Magento 2开发中更加游刃有余，能够创建更具响应性和模块化的前端体验。