如何在Magento的Dev_Banner模块中创建banner详情页控制器？

前置前提 #

假设你已经完成Dev_Banner模块的基础创建，包括：

• 模块注册文件registration.php
• 模块配置文件etc/module.xml
• Banner模型、资源模型、集合类已经创建完成
• 数据库表已经创建并存在banner_id主键字段

第一步：配置前端路由 #

在你的模块app/code/Dev/Banner/etc/frontend目录下创建routes.xml文件，配置前端路由规则：

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="standard">
        <route id="banner" frontName="banner">
            <module name="Dev_Banner" />
        </route>
    </router>
</config>

这里的frontName="banner"对应路径的第一部分banner，和你要求的访问路径规则匹配。

第二步：创建详情页控制器 #

在模块目录app/code/Dev/Banner/Controller/Index下创建View.php文件，代码如下：

<?php
namespace Dev\Banner\Controller\Index;

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Dev\Banner\Model\BannerFactory;
use Magento\Framework\View\Result\PageFactory;
use Magento\Framework\Controller\Result\ForwardFactory;

class View extends Action
{
    /**
     * @var BannerFactory
     */
    protected $bannerFactory;

    /**
     * @var PageFactory
     */
    protected $resultPageFactory;

    /**
     * @var ForwardFactory
     */
    protected $resultForwardFactory;

    /**
     * @param Context $context
     * @param BannerFactory $bannerFactory
     * @param PageFactory $resultPageFactory
     * @param ForwardFactory $resultForwardFactory
     */
    public function __construct(
        Context $context,
        BannerFactory $bannerFactory,
        PageFactory $resultPageFactory,
        ForwardFactory $resultForwardFactory
    ) {
        $this->bannerFactory = $bannerFactory;
        $this->resultPageFactory = $resultPageFactory;
        $this->resultForwardFactory = $resultForwardFactory;
        parent::__construct($context);
    }

    /**
     * 控制器执行逻辑
     *
     * @return \Magento\Framework\Controller\ResultInterface
     */
    public function execute()
    {
        // 获取URL中传递的banner_id参数
        $bannerId = $this->getRequest()->getParam('id');
        $banner = $this->bannerFactory->create()->load($bannerId);

        // 校验banner是否合法存在，不存在则跳转404
        if (!$banner->getId()) {
            $resultForward = $this->resultForwardFactory->create();
            return $resultForward->forward('noroute');
        }

        // 返回页面结果
        $resultPage = $this->resultPageFactory->create();
        // 将banner对象传递给前端块，方便模板调用
        $resultPage->getLayout()->getBlock('banner.detail')->setData('current_banner', $banner);
        // 自定义页面标题，可读取banner的标题字段
        $resultPage->getConfig()->getTitle()->set($banner->getTitle() ? : __('Banner详情页'));
        return $resultPage;
    }
}

代码说明：

• 控制器路径Controller/Index/View.php对应路由的index控制器、view方法，和你要求的banner/index/view路径完全匹配
• 依赖注入BannerFactory避免模型直接实例化，符合Magento开发规范
• 非法ID自动跳转404页面，兼容异常场景

第三步：创建对应布局文件 #

在app/code/Dev/Banner/view/frontend/layout目录下创建banner_index_view.xml布局文件，和控制器路径一一对应：

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <update handle="1column"/>
    <body>
        <referenceContainer name="content">
            <block class="Magento\Framework\View\Element\Template" name="banner.detail" template="Dev_Banner::detail.phtml" />
        </referenceContainer>
    </body>
</page>

第四步：创建前端模板文件 #

在app/code/Dev/Banner/view/frontend/templates目录下创建detail.phtml模板文件，调用banner数据渲染页面：

<?php
/** @var \Magento\Framework\View\Element\Template $block */
$currentBanner = $block->getData('current_banner');
?>
<div class="banner-detail-wrapper">
    <h1><?= $escaper->escapeHtml($currentBanner->getTitle()) ?></h1>
    <div class="banner-image">
        <img src="<?= $escaper->escapeUrl($currentBanner->getImageUrl()) ?>" alt="<?= $escaper->escapeHtml($currentBanner->getTitle()) ?>">
    </div>
    <?php if ($currentBanner->getDescription()): ?>
    <div class="banner-desc">
        <?= /* @noEscape */ $currentBanner->getDescription() ?>
    </div>
    <?php endif; ?>
</div>

注意：代码中调用的getTitle、getImageUrl、getDescription方法需要和你实际的Banner模型字段对应调整。

生效验证 #

执行命令刷新Magento缓存：

bin/magento cache:flush

访问你的站点地址/banner/index/view/id/[实际存在的banner_id]即可测试访问效果。

内容的提问来源于stack exchange，提问作者user17437182