[TOC]
# 使用場景
我們在使用laravel來寫API時,經常需要返回一個json字符串或JsonResponse,通常我們的做法可能有兩種。
1. 在BaseController中定義一個返回Json響應de方法,然后繼承該BaseController。如:
~~~
//BaseController.php
public function json($data = null, $status = 200, $headers = [], $options = 0)
{
return new JsonResponse($data, $status, $headers, $options);
}
//YourController.php
class YourController extends BaseController
{
public function users(UserRepository $userRepository)
{
return $this->json($userRepository->allUser());
}
}
~~~
然而這寫法確實挺方便,然而當你在其他地方需要使用到Json響應時(如中間件驗證失敗時你想要返回一個Json響應)。你無法使用到$this->json(...)。
2. 直接在需要用到Json響應得地方使用return new JsonResponse或者使用Response Facade。但這種做法當需要修改Response響應時得全部改動,不可取。
# Response 宏
Laravel提供了一個非常方便的響應宏來處理這一情況
首先,我們需要先注冊一個響應宏,在任意一個ServiceProvider的boot方法里(ResponseMacroServiceProvider),使用Response Facade注冊
~~~
Response::macro('success', function ($data = [], $message = 'success') {
return new JsonResponse([
'code' => 0,
'data' => $data,
'message' => $message
], 200);
});
~~~
接下來, 你可以再任何地方使用它response()。
~~~
//UserController.php
public function users(UserRepository $userRepository)
{
return response()->success($userRepository->all(), 'success');
}
~~~
注意,你只能通過response()這個全局方法或是app('Illuminate\Routing\ResponseFactory')來使用它
~~~
response()->success();//OK
app('Illuminate\Routing\ResponseFactory')->success();//OK
//Response Facade
Response::success();//ok
(new \Illuminate\Http\Response)->success();//Error
~~~
# 原理
我們在ServiceProvider里使用Response Facade來注冊的success宏,我們先看看Response這個Facade的正真類是什么。
~~~
// Illuminate\Support\Facades.php
protected static function getFacadeAccessor()
{
return 'Illuminate\Contracts\Routing\ResponseFactory';
}
~~~
該Facade返回了一個ResponseFactory接口,那該接口的具體實列對象時什么呢。
~~~
//Illuminate\Routing\RoutingServiceProvider.php
/**
* Register the response factory implementation.
*
* @return void
*/
protected function registerResponseFactory()
{
$this->app->singleton('Illuminate\Contracts\Routing\ResponseFactory', function ($app) {
return new ResponseFactory($app['Illuminate\Contracts\View\Factory'], $app['redirect']);
});
}
~~~
可以看到,該RoutingServiceProvider注冊了一個Illuminate\Routing\ResponseFactory的實列給Response Facade。
我們在Illuminate\Routing\ResponseFactory的源碼中可以看到,它引用了一個Illuminate\Support\Traits\Macroable trait。
~~~
namespace Illuminate\Routing;
use Illuminate\Support\Traits\Macroable;
class ResponseFactory implements FactoryContract
{
use Macroable;
}
~~~
該Trait源碼如下,看完源碼就知道為什么調用response()就能正常訪問success方法了。
~~~
trait Macroable
{
protected static $macros = [];
public static function macro($name, callable $macro)
{
static::$macros[$name] = $macro;
}
public static function hasMacro($name)
{
return isset(static::$macros[$name]);
}
public static function __callStatic($method, $parameters)
{
if (! static::hasMacro($method)) {
throw new BadMethodCallException("Method {$method} does not exist.");
}
if (static::$macros[$method] instanceof Closure) {
return call_user_func_array(Closure::bind(static::$macros[$method], null, static::class), $parameters);
}
return call_user_func_array(static::$macros[$method], $parameters);
}
public function __call($method, $parameters)
{
if (! static::hasMacro($method)) {
throw new BadMethodCallException("Method {$method} does not exist.");
}
if (static::$macros[$method] instanceof Closure) {
return call_user_func_array(static::$macros[$method]->bindTo($this, static::class), $parameters);
}
return call_user_func_array(static::$macros[$method], $parameters);
}
}
~~~
其實該 trait Illuminate\Support\Traits\Macroable 在很多地方都有使用,包括 FileSystem、Database-Builder。
http://d.laravel-china.org/docs/5.4/responses#response-macros
- 配置
- composer安裝
- composer用法
- composer版本約束表達
- phpstorm
- sftp文件同步
- php類型約束
- laradock
- 配置文件緩存詳解
- git
- 自定義函數
- 核心概念
- IOC
- 服務提供者
- Facade
- 契約
- 生命周期
- 路由
- 請求
- 命名路由
- 路由分組
- 資源路由
- 控制器路由
- 響應宏
- 響應
- Command
- 創建命令
- 定時任務
- console路由
- 執行用戶自定義的定時任務
- artisan命令
- 中間件
- 創建中間件
- 使用中間件
- 前置和后置
- 詳細介紹
- 訪問次數限制
- 為 VerifyCsrfToken 添加過濾條件
- 單點登錄
- 事件
- 創建
- ORM
- 簡介
- DB類
- 配置
- CURD
- queryScope和setAttribute
- 查看sql執行過程
- 關聯關系
- 一對一
- 一對多
- 多對多
- 遠程關聯
- 多態一對多
- 多態多對多
- 關聯數據庫的調用
- withDefault
- 跨模型更新時間戳
- withCount,withSum ,withAvg, withMax,withMin
- SQL常見操作
- 模型事件
- 模型事件詳解
- 模型事件與 Observer
- deleted 事件未被觸發
- model validation
- ORM/代碼片段
- Repository模式
- 多重where語句
- 中間表類型轉換
- Collection集合
- 新增的一些方法
- 常見用法
- 求和例子
- 機場登機例子
- 計算github活躍度
- 轉化評論格式
- 計算營業額
- 創建lookup數組
- 重新組織出表和字段關系并且字段排序
- 重構循環
- 其他例子
- 其他問題一
- 去重
- 第二個數組按第一個數組的鍵值排序
- 搜索ES
- 安裝
- 表單
- Request
- sessiom
- Response
- Input
- 表單驗證
- 簡介
- Validator
- Request類
- 接口中的表單驗證
- Lumen 中自定義表單驗證返回消息
- redis
- 廣播事件
- 發布訂閱
- 隊列
- 守護進程
- redis隊列的坑
- beanstalkd
- rabbitmq
- redis隊列
- 日志模塊
- 錯誤
- 日志詳解
- 數據填充與遷移
- 生成數據
- 數據填充seed
- migrate
- 常見錯誤
- Blade模板
- 流程控制
- 子視圖
- URL
- 代碼片段
- Carbon時間類
- 一些用法
- 郵件
- 分頁
- 加密解密
- 緩存
- 文件上傳
- 優化
- 隨記
- 嵌套評論
- 判斷字符串是否是合法的 json 字符串
- 單元測試
- 計算出兩個日期的diff
- 自定義一個類文件讓composer加載
- 時間加減
- 對象數組互轉方法
- 用戶停留過久自動退出登錄
- optional 輔助方法
- 文件下載
- Api
- Dingo api
- auth.basic
- api_token
- Jwt-Auth
- passport
- Auth
- Authentication 和 Authorization
- Auth Facade
- 授權策略
- Gates
- composer包
- debug包
- idehelp包
- image處理
- 驗證碼
- jq插件
- 第三方登錄
- 第三方支付
- log顯示包
- 微信包
- xss過濾
- Excel包
- MongoDB
- php操作
- 聚合查詢
- 發送帶附件郵件
- 中文轉拼音包
- clockwork網頁調試
- emoji表情
- symfony組件
- swooletw/laravel-swoole
- 常見問題
- 跨域問題
- Laravel隊列優先級的一個坑
- cache:clear清除緩存問題
- .env無法讀取
- 源碼相關基礎知識
- __set和__get
- 依賴注入、控制反轉和依賴倒置原則
- 控制反轉容器(Ioc Container)
- 深入服務容器
- call_user_func
- compact
- 中間件簡易實現
- array_reduce
- 中間件實現代碼
- Pipeline管道操作
- composer自動加載
- redis延時隊列
- 了解laravel redis隊列
- cli
- 源碼解讀
- Facade分析
- Facade源碼分析
- IOC服務容器
- 中間件原理
- 依賴注入淺析
- 微信
- 微信公眾號
- 常用接收消息
- 6大接收接口
- 常用被動回復消息
- 接口調用憑證
- 自定義菜單
- 新增素材
- 客服消息
- 二維碼
- 微信語音
- LBS定位
- 網頁授權
- JSSDK
- easywechat
- 小程序
- 小程序配置app.json