Laravel Actions 中关于请求 JSON 响应的正确处理方法

在 Laravel 生态系统中，Laravel Actions 是一个优雅地封装业务逻辑的强大工具包。最近在 Laravel 10 中，关于请求 JSON 响应的处理方式出现了一些变化，这需要我们特别注意。

请求 JSON 响应的判断机制

在 Laravel 中，判断一个请求是否期望 JSON 响应有两种主要方法：

1. expectsJson() - 检查请求是否期望 JSON 响应
2. isJson() - 检查请求内容是否为 JSON 格式

这两个方法看似相似，但实际上有重要区别：

• expectsJson() 检查的是请求头中的 Accept 字段，判断客户端是否期望接收 JSON 格式的响应
• isJson() 检查的是请求头中的 Content-Type 字段，判断客户端发送的内容是否为 JSON 格式

Laravel Actions 中的响应处理

Laravel Actions 提供了优雅的方式来根据请求类型返回不同格式的响应。在控制器装饰器中，它会自动检测请求类型并调用相应的响应方法：

if ($this->hasMethod('jsonResponse') && $request->expectsJson()) {
    $response = $this->callMethod('jsonResponse', [$response, $request]);
} elseif ($this->hasMethod('htmlResponse') && ! $request->expectsJson()) {
    $response = $this->callMethod('htmlResponse', [$response, $request]);
}

常见误区与正确实践

许多开发者容易混淆 expectsJson() 和 isJson() 的使用场景。特别是在使用 API 测试工具（如 Postman 或 Insomnia）时，常见的错误是只设置了 Content-Type: application/json 头，而没有设置 Accept: application/json 头。

正确做法应该是：

1. 当客户端期望接收 JSON 响应时，设置 Accept: application/json 头
2. 当客户端发送 JSON 内容时，设置 Content-Type: application/json 头

向后兼容性考虑

对于需要同时支持 Laravel 9 和 10 的项目，可以采用双重检查的方式：

if ($this->hasMethod('jsonResponse') && ($request->expectsJson() || $request->isJson())) {
    // 处理 JSON 响应
} elseif ($this->hasMethod('htmlResponse') && ! ($request->expectsJson() || $request->isJson())) {
    // 处理 HTML 响应
}

总结

理解 Laravel 中请求类型判断的细微差别对于构建健壮的 API 至关重要。在 Laravel Actions 中使用时，开发者应当明确区分客户端期望接收的响应格式和客户端发送的内容格式。正确的请求头设置不仅能确保应用按预期工作，还能提高代码的可维护性和清晰度。