响应宏是 laravel 中轻量、非侵入式统一响应格式的方案,需在 appserviceprovider::boot() 中注册 success、fail、jsonp、negotiate 等宏,支持链式调用与多格式协商。

如果您希望在 Laravel 应用中统一响应格式、减少重复代码,但又不希望通过继承基类或在每个控制器中手动构造 JSON,那么响应宏(Response Macro)是一种轻量、非侵入且全局可用的扩展方式。以下是实现该功能的具体路径:
一、在 AppServiceProvider 的 boot 方法中注册宏
响应宏必须在应用启动早期注册,且仅能在已绑定到容器的 Response Factory 实例上生效;AppServiceProvider::boot() 是最稳定、最推荐的注册位置,此时门面与底层构建器已完全就绪。
1、打开 app/Providers/AppServiceProvider.php 文件。
2、在 boot() 方法内引入 Illuminate\Support\Facades\Response 命名空间。
3、调用 Response::macro('methodName', function () { ... }) 注册闭包,闭包内通过 $this 访问响应构建器实例。
4、确保宏名不与原生方法(如 json、view、download)冲突,否则将导致静默覆盖或 BadMethodCallException 错误。
二、定义统一结构的成功响应宏
该宏用于快速返回标准 JSON 格式,包含 code、message、data 三字段,适用于 API 接口,避免在各处重复书写 response()->json([...])。
1、在 boot() 中添加如下注册语句:Response::macro('success', function ($data = [], $message = 'OK', $code = 200) { return response()->json(['code' => $code, 'message' => $message, 'data' => $data], $code); });
2、在任意控制器方法中直接调用:return response()->success($user, '获取成功');
3、该宏支持链式调用,例如:response()->success($data)->header('X-Api-Version', 'v2');
三、注册支持 JSONP 的响应宏
当需兼容老旧前端跨域请求(如 script 标签加载),JSONP 是一种绕过 CORS 限制的方案;此宏封装了回调函数包裹逻辑与 Content-Type 头设置。
1、在 boot() 中注册:Response::macro('jsonp', function ($data, $callback = 'callback') { return response("{$callback}(".json_encode($data, JSON_UNESCAPED_UNICODE).")")->header('Content-Type', 'application/javascript'); });
2、在路由闭包或控制器中使用:return response()->jsonp(['status' => 'ok'], request()->input('callback', 'cb'));
3、注意:必须手动调用 request()->input() 获取回调名,宏内无法自动注入 $request 实例。
四、创建带状态码与错误信息的失败响应宏
为 API 提供一致的错误响应体,便于前端统一拦截处理;该宏与 success 宏形成对称设计,保持 code 字段负值约定(如 -1 表示通用错误)。
1、在 boot() 中注册:Response::macro('fail', function ($message = '操作失败', $code = -1, $httpCode = 400) { return response()->json(['code' => $code, 'message' => $message, 'data' => null], $httpCode); });
2、在验证失败时调用:return response()->fail('邮箱格式不正确', -102, 422);
3、若需动态读取验证错误消息,可在闭包内使用 session('errors') 或 validator()->errors(),但须通过 app() 或辅助函数显式获取。
五、注册支持多格式协商的响应宏
根据请求头 Accept 字段自动选择返回 JSON 或视图,适用于同时服务 Web 页面与 API 的混合型接口,避免重复路由逻辑。
1、在 boot() 中注册:Response::macro('negotiate', function ($data, $viewName, $viewData = []) { return request()->expectsJson() ? response()->json($data) : response()->view($viewName, array_merge($viewData, ['data' => $data])); });
2、在控制器中调用:return response()->negotiate($posts, 'posts.index', ['title' => '文章列表']);
3、关键点:使用 request() 辅助函数判断格式偏好,不可依赖闭包参数自动注入。











