# 创建前端控制器操作 ## 说明此技能将指导您在 Adobe Commerce/Magento 2 (Mage-OS) 中创建前端控制器操作。前端控制器处理 HTTP 请求并返回店面区域的响应。 ## 何时使用 * 为 AJAX 请求创建自定义前端端点 * 构建可供客户访问的自定义页面或操作 * 实现自定义表单提交 * 为前端 JavaScript 创建类似 API 的端点 ## 先决条件 * 现有的具有适当结构的 Magento 2 模块 * 依赖注入的理解 * 了解Magento路由系统 ## Adobe 文档中的最佳实践 ### 1\.使用特定于 HTTP 方法的接口始终实现 HTTP 方法特定的操作接口： * `HttpGetActionInterface` \- 用于 GET 请求 * `HttpPostActionInterface` \- 用于 POST 请求 * 两个接口都可以为接受多种方法的端点实现 ### 2\.使用严格类型始终在控制器文件的顶部声明严格类型：声明(strict_types=1); ### 3\.使用依赖注入切勿直接使用 ObjectManager。始终通过构造函数注入依赖项。 ### 4\.返回正确的结果对象使用结果工厂返回适当的响应类型： * 用于 JSON 响应的“JsonFactory” * 用于整页响应的“PageFactory” * 用于重定向的“RedirectFactory” * 用于原始输出的“RawFactory” ## 逐步实施 ### 步骤1：创建routes.xml 在 `etc/frontend/routes.xml` 中定义路由配置： <路由器id=“标准”> <模块名称=“Vendor_ModuleName”/> **网址结构：** `https://yourdomain.com/{frontName}/{controller}/{action}` ### 步骤 2：创建控制器目录结构创建控制器目录：应用程序/代码/供应商/模块名称/控制器/ └── 控制器名称/ └── ActionName.php **示例：** `Controller/Custom/Search.php` 映射到 URL：`/yourmodule/custom/search` ### 步骤 3：创建控制器操作类 #### 示例 1：JSON 响应控制器 (GET/POST) resultJsonFactory = $resultJsonFactory; $这个->请求= $请求； } /** * 执行动作 * * @return 结果接口 */ 公共函数execute()：ResultInterface { // 获取请求参数 $searchKey = $this->request->getParam('searchKey'); $page = (int)$this->request->getParam('page', 1); $limit = (int)$this->request->getParam('limit', 10); // 这里是你的业务逻辑 $数据 = [ '成功' => 正确， 'message' => '操作成功完成', '数据' => [ 'searchKey' => $searchKey, '页面' => $页面， '限制' => $限制 ] ]; // 返回 JSON 响应 $resultJson = $this->resultJsonFactory->create(); 返回 $resultJson->setData($data); } } #### 示例 2：页面响应控制器（仅限 GET） resultPageFactory = $resultPageFactory; } /** * 执行动作 * * @返回页面 */ 公共函数execute()：页面 { $resultPage = $this->resultPageFactory->create(); $resultPage->getConfig()->getTitle()->set(__('页面标题')); 返回$结果页； } } #### 示例 3：重定向响应控制器 resultRedirectFactory = $resultRedirectFactory; } /** * 执行动作 * * @return 结果接口 */ 公共函数execute()：ResultInterface { $resultRedirect = $this->resultRedirectFactory->create(); $resultRedirect->setPath('客户/帐户'); 返回$resultRedirect； } } ### 步骤 4：创建布局 XML（对于页面控制器）如果返回页面，请创建布局 XML：`view/frontend/layout/yourmodule_controllername_actionname.xml` <页面 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd"> <头> <标题>页面标题 <正文> <参考容器名称=“内容”> ### 步骤 5：创建模板（对于页面控制器）创建模板文件：`view/frontend/templates/custom/template.phtml`

escapeHtml(__('自定义页面')) ?>

escapeHtml(__('此处为您的内容')) ?>

### 步骤 6：清除缓存并测试 # 清除缓存 ddev exec bin/magento 缓存：刷新 # 升级设置（如果是新模块） ddev exec bin/magento 设置：升级 # 测试端点卷曲 https://ntotank.ddev.site/yourmodule/controllername/actionname ## 常见模式 ### 模式 1：带有集合的 AJAX 端点公共函数execute()：ResultInterface { $searchKey = $this->request->getParam('searchKey'); // 加载集合 $collection = $this->collectionFactory->create(); $collection->addFieldToFilter('name', ['like' => "%{$searchKey}%"]); $集合->setPageSize(10); // 格式化结果 $结果=[]; foreach（$collection 作为$item）{ $结果[] = [ 'id' => $item->getId(), '名称' => $item->getName(), 'url' => $item->getUrl() ]; } $resultJson = $this->resultJsonFactory->create(); 返回 $resultJson->setData([ '项目' => $结果， '总计' => $collection->getSize() ]); } ### 模式 2：表单提交处理程序公共函数execute()：ResultInterface { if (!$this->request->isPost()) { $resultRedirect = $this->resultRedirectFactory->create(); 返回 $resultRedirect->setPath('*/*/'); } 尝试{ // 验证 CSRF 令牌（由 Magento 自动完成） $formData = $this->request->getPostValue(); // 处理表单数据 // ...你的逻辑在这里 $this->messageManager->addSuccessMessage(__('表单提交成功。')); $resultRedirect = $this->resultRedirectFactory->create(); 返回 $resultRedirect->setPath('*/*/success'); } catch (\Exception $e) { $this->messageManager->addErrorMessage($e->getMessage()); $resultRedirect = $this->resultRedirectFactory->create(); 返回 $resultRedirect->setPath('*/*/'); } } ### 模式 3：客户身份验证检查私人 \Magento\Customer\Model\Session $customerSession; 公共函数execute()：ResultInterface { if (!$this->customerSession->isLoggedIn()) { $resultRedirect = $this->resultRedirectFactory->create(); $resultRedirect->setPath('客户/帐户/登录'); 返回$resultRedirect； } // 继续验证逻辑 // ... } ## 测试 ### 单元测试示例创建：`Test/Unit/Controller/ControllerName/ActionNameTest.php` createMock(\Magento\Framework\Controller\Result\JsonFactory::class); $request = $this->createMock(\Magento\Framework\App\RequestInterface::class); // 创建控制器实例 $controller = new ActionName($resultJsonFactory, $request); // 执行并断言 $结果= $控制器->执行(); $this->assertInstanceOf(\Magento\Framework\Controller\ResultInterface::class, $result); } } ## 故障排除 ### 问题：404 未找到 * 检查 `routes.xml` 是否位于正确的位置 (`etc/frontend/routes.xml`) * 验证frontName是否唯一 * 运行 `ddev exec bin/magento setup:upgrade` * 清除缓存：`ddev exec bin/magento 缓存:flush` ### 问题：控制器未加载 * 检查类命名空间是否与目录结构匹配 * 确保控制器实现 HttpGetActionInterface 或 HttpPostActionInterface * 检查文件命名：控制器文件必须与类名完全匹配 ### 问题：JSON 响应不起作用 * 确保您返回 JsonFactory 结果 * 检查 Content-Type 标头设置是否正确 * 返回结果之前验证没有输出 ## 参考文献 * Adobe Commerce 前端核心文档： * Magento 2 路由： * 控制器操作接口：对现代 Magento 2 使用 HttpGetActionInterface 和 HttpPostActionInterface ## NTOTanks-具体注释 * 对于 AJAX 端点，请遵循“ProxiBlue_SearchDynaTable”中使用的模式 * 使用“x-data”和“fetch()”调用在前端与 Alpine.js 集成 * 使用ViewModels准备数据供Alpine.js使用 * 遵循PSR-12编码标准 * Magento CLI 命令始终使用 `ddev exec` 前缀

创建前端控制器

包含技能