如何通过Magento 2.3.x声明式Schema创建MySQL存储过程？

好问题！确实，Magento 2.3的**声明式Schema（db_schema.xml）**并没有原生支持创建存储过程的能力——它的设计初衷是统一管理表结构、索引、外键这些数据库实体，存储过程这类自定义数据库逻辑不在它的覆盖范围内。不过你完全可以通过Magento传统的Setup脚本实现这个需求，而且流程非常成熟。

下面是具体的实现步骤：

方法一：使用UpgradeSchema/InstallSchema脚本 #

这是最推荐的方式，因为它能无缝集成到Magento的模块安装/升级流程中，确保存储过程在模块部署时自动创建。

1. 创建Setup脚本文件 #

在你的模块目录下（比如app/code/Vendor/Module/Setup/），创建UpgradeSchema.php（如果是模块首次安装，也可以用InstallSchema.php）：

<?php
namespace Vendor\Module\Setup;

use Magento\Framework\Setup\UpgradeSchemaInterface;
use Magento\Framework\Setup\SchemaSetupInterface;
use Magento\Framework\Setup\ModuleContextInterface;

class UpgradeSchema implements UpgradeSchemaInterface
{
    public function upgrade(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        $setup->startSetup();

        // 仅当模块版本低于1.0.1时执行，避免重复创建存储过程
        if (version_compare($context->getVersion(), '1.0.1', '<')) {
            // 编写存储过程的SQL语句
            $procedureSql = <<<SQL
CREATE PROCEDURE `get_customer_orders`(IN customer_id INT)
BEGIN
    SELECT order_id, increment_id, created_at 
    FROM sales_order 
    WHERE customer_id = customer_id;
END;
SQL;
            // 执行SQL创建存储过程
            $setup->getConnection()->query($procedureSql);
        }

        $setup->endSetup();
    }
}

2. 更新模块版本 #

修改模块根目录下的module.xml，把版本号从之前的（比如1.0.0）升级到1.0.1，这样Magento在检测到版本更新时会自动执行上面的Upgrade脚本：

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Vendor_Module" setup_version="1.0.1">
        <!-- 依赖配置等 -->
    </module>
</config>

调用存储过程 #

创建完成后，你就可以像之前测试的那样，通过Magento的数据库连接调用存储过程了：

// 注入ResourceConnection依赖
public function __construct(
    \Magento\Framework\App\ResourceConnection $resourceConnection
) {
    $this->resourceConnection = $resourceConnection;
}

// 调用存储过程的方法
public function callCustomProcedure($customerId)
{
    $connection = $this->resourceConnection->getConnection();
    $result = $connection->query("CALL get_customer_orders(?)", [$customerId]);
    return $result->fetchAll();
}

注意事项 #

• 权限问题：确保Magento使用的数据库用户拥有CREATE ROUTINE和EXECUTE权限，否则无法创建或调用存储过程。
• 避免重复执行：一定要通过版本判断控制脚本执行时机，否则每次执行setup:upgrade都会尝试创建存储过程，导致数据库报错。
• SQL语法正确性：编写存储过程SQL时注意语法规范，使用HEREDOC格式可以避免MySQL分隔符（;）的冲突问题。

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