在 laravel 框架中，尽管其 orm（eloquent）提供了强大的数据库操作能力，但对于直接调用 mysql 存储过程，特别是涉及到输入和输出参数的复杂场景时，原生 sql 查询是更直接且必要的选择。laravel 并没有提供像 db::select() 那样专门用于存储过程调用的抽象方法，因此我们需要借助 db::statement() 来执行存储过程，并结合 db::select() 来获取输出参数的结果。
核心概念：为什么使用原生 SQL 调用存储过程？
Laravel 的 DB 门面提供了执行原生 SQL 语句的能力。对于存储过程，由于其执行逻辑可能涉及复杂的事务、流程控制以及参数传递机制，直接使用原生 SQL CALL 语句是最可靠的方式。DB::statement() 方法用于执行不返回结果集（如 INSERT, UPDATE, DELETE 或 CALL）的 SQL 语句，而 DB::select() 则用于执行返回结果集（如 SELECT）的 SQL 语句。理解这两种方法的应用场景，是成功调用存储过程的关键。
四种存储过程调用场景
根据存储过程是否需要输入参数以及是否返回输出参数，我们可以将其分为四种主要场景。
1. 无参数存储过程调用
这是最简单的场景，存储过程不接受任何输入，也不返回任何输出。它通常用于执行一些简单的数据库维护任务或无条件的数据操作。
示例代码：
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\DB;
use Illuminate\Http\Request;
class StoredProcedureController extends Controller
{
public function callParameterlessProcedure()
{
$query = "CALL your_stored_procedure(); COMMIT;";
DB::statement($query);
return "无参数存储过程调用成功。";
}
}2. 仅含输入参数的存储过程调用
此场景下，存储过程需要接收一个或多个输入参数来执行其逻辑。参数可以是静态值，也可以是动态变量。
a. 静态参数传入
当输入参数是固定值时，可以直接将其硬编码到 SQL 字符串中。
示例代码：
<?php
// ... (省略命名空间和use语句)
class StoredProcedureController extends Controller
{
public function callProcedureWithStaticInput()
{
// 假设 your_stored_procedure 接受一个字符串参数
$query = "CALL your_stored_procedure('some_static_data'); COMMIT;";
DB::statement($query);
return "带静态输入参数的存储过程调用成功。";
}
}b. 动态参数绑定
为了避免 SQL 注入风险并提高代码的可读性，推荐使用参数绑定来传递动态数据。Laravel 的 DB::statement() 方法支持命名参数绑定。
示例代码：
<?php
// ... (省略命名空间和use语句)
class StoredProcedureController extends Controller
{
public function callProcedureWithDynamicInput(Request $request)
{
$dynamicData = $request->input('data_value'); // 从请求中获取动态数据
$query = "CALL your_stored_procedure(:input_data); COMMIT;";
$bind = [
'input_data' => $dynamicData
];
DB::statement($query, $bind);
return "带动态输入参数的存储过程调用成功。传入数据: " . $dynamicData;
}
}3. 仅含输出参数的存储过程调用
在此场景中，存储过程不接收输入参数，但会通过一个或多个输出参数返回数据。在 MySQL 中，这通常通过用户会话变量（@variable_name）来实现。
示例代码：
<?php
// ... (省略命名空间和use语句)
class StoredProcedureController extends Controller
{
public function callProcedureWithOutput()
{
// 假设 your_stored_procedure 通过 @your_output_data 返回数据
$callQuery = "CALL your_stored_procedure(@your_output_data); COMMIT;";
DB::statement($callQuery);
// 从会话变量中获取返回的数据
$returnQuery = "SELECT @your_output_data AS output_result;";
$result = DB::selectOne($returnQuery); // 使用 selectOne 获取单行结果
// 处理结果
if ($result) {
$outputData = $result->output_result;
return "带输出参数的存储过程调用成功。输出数据: " . $outputData;
} else {
return "未能获取输出数据。";
}
}
}4. 同时包含输入和输出参数的存储过程调用
这是最复杂的场景，存储过程既需要输入参数来执行逻辑，又会通过输出参数返回结果。它是前两种场景的结合。
示例代码：
<?php
// ... (省略命名空间和use语句)
class StoredProcedureController extends Controller
{
public function callProcedureWithInputAndOutput(Request $request)
{
$inputData = $request->input('input_value'); // 从请求中获取输入数据
// 调用存储过程，传入输入参数并指定输出参数变量
$callQuery = "CALL your_stored_procedure(:input_param, @your_output_data); COMMIT;";
$bind = [
'input_param' => $inputData
];
DB::statement($callQuery, $bind);
// 从会话变量中获取返回的输出数据
$returnQuery = "SELECT @your_output_data AS output_result;";
$result = DB::selectOne($returnQuery);
// 处理结果
if ($result) {
$outputData = $result->output_result;
return "带输入输出参数的存储过程调用成功。输入: " . $inputData . ", 输出: " . $outputData;
} else {
return "未能获取输出数据。";
}
}
}关键注意事项：关于 COMMIT 的使用
在上述所有示例中，我们都在 CALL 语句后紧跟着 COMMIT;。这并非总是强制性的，但理解其作用至关重要。
- COMMIT 的作用: COMMIT 语句用于将当前事务中的所有更改永久保存到数据库。如果没有 COMMIT，那么在某些数据库配置下，存储过程执行的数据修改可能不会被立即持久化。
- AUTOCOMMIT: 大多数现代数据库管理系统（包括 MySQL）默认开启了 AUTOCOMMIT 功能。这意味着每条独立的 SQL 语句都会被视为一个独立的事务并自动提交。在这种情况下，显式添加 COMMIT; 似乎是多余的。
-
为何仍推荐使用 COMMIT:
- 显式事务控制: 即使 AUTOCOMMIT 开启，显式 COMMIT 也能让代码意图更清晰，并为未来的事务控制（例如，在存储过程调用失败时执行 ROLLBACK）留下可能性。
- 兼容性与习惯: 养成在数据修改操作后显式提交的习惯，有助于在不同数据库环境或更复杂的事务场景中保持一致性。
- 防止意外回滚: 如果在同一连接中执行了其他未提交的事务，显式 COMMIT 可以确保存储过程的更改被保存，避免因后续操作的回滚而丢失。
因此，在 Laravel 中调用存储过程时，根据实际业务需求和对事务完整性的要求，决定是否在 CALL 语句后添加 COMMIT;。对于简单的、独立的存储过程调用，即使不加 COMMIT 也可能正常工作，但为了更严谨的事务管理，添加它是一个好的实践。
总结与展望
通过上述方法，开发者可以在 Laravel 8.0+ 项目中灵活地调用各种类型的 MySQL 存储过程。虽然这需要编写原生 SQL 语句，但它提供了对数据库操作更深层次的控制。需要注意的是，本文主要聚焦于“如何调用”存储过程，而对于存储过程返回结果后的具体业务逻辑处理（例如，将结果映射到模型、进行数据转换等），则需要开发者根据实际需求进一步实现。熟练掌握这些调用技巧，将极大地增强 Laravel 应用处理复杂数据库逻辑的能力。
