`Response`對象提供了一系列方法用于設置響應參數,包括設置輸出內容、狀態碼及header信息等,并且支持鏈式調用以及多次調用。
## 設置數據
`Response`基類提供了`data`方法用于設置響應數據。
~~~
response()->data($data);
json()->data($data);
~~~
不過需要注意的是`data`方法設置的只是原始數據,并不一定是最終的輸出數據,最終的響應輸出數據是會根據當前的`Response`響應類型做自動轉換的,例如:
~~~
json()->data($data);
~~~
最終的輸出數據就是`json_encode($data)`轉換后的數據。
如果要獲取當前響應對象實例的實際輸出數據可以使用`getContent`方法。
## 設置狀態碼
`Response`基類提供了`code`方法用于設置響應數據,但大部分情況一般我們是直接在調用助手函數的時候直接傳入狀態碼,例如:
~~~
json($data,201);
view($data,401);
~~~
或者在后面鏈式調用`code`方法是等效的:
~~~
json($data)->code(201);
~~~
> 除了`redirect`函數的默認返回狀態碼是`302`之外,其它方法沒有指定狀態碼都是返回`200`狀態碼。
如果要獲取當前響應對象實例的狀態碼的值,可以使用`getCode`方法。
## 設置頭信息
可以使用`Response`類的`header`設置響應的頭信息
~~~
json($data)->code(201)->header(['Cache-control' => 'no-cache,must-revalidate']);
~~~
`header`方法支持兩種方式設置,如果傳入數組,則表示批量設置,如果傳入兩個參數,第一個參數表示頭信息名,第二個參數表示頭信息的值,例如:
~~~
// 單個設置
header('Cache-control', 'no-cache,must-revalidate');
// 批量設置
header([
'Cache-control' => 'no-cache,must-revalidate',
'Last-Modified' => gmdate('D, d M Y H:i:s') . ' GMT',
]);
~~~
除了`header`方法之外,`Response`基類還提供了常用頭信息的快捷設置方法:
| 方法名 | 作用 |
| --- | --- |
| `lastModified` | 設置`Last-Modified`頭信息 |
| `expires` | 設置`Expires`頭信息 |
| `eTag` | 設置`ETag`頭信息 |
| `cacheControl` | 設置`Cache-control`頭信息 |
| `contentType` | 設置`Content-Type`頭信息 |
除非你要清楚自己在做什么,否則不要隨便更改這些頭信息,每個`Response`子類都有默認的`contentType`信息,一般無需設置。
你可以使用`getHeader`方法獲取當前響應對象實例的頭信息。
## 設置額外參數
有些時候,響應輸出需要設置一些額外的參數,例如:
在進行`json`輸出的時候需要設置`json_encode`方法的額外參數,`jsonp`輸出的時候需要設置`jsonp_handler`等參數,這些都可以使用`options`方法來進行處理,例如:
~~~
json($data)
->options(['json_encode_param' => JSON_NUMERIC_CHECK | JSON_UNESCAPED_UNICODE]);
~~~
也可以支持傳入數組作為參數:
~~~
jsonp($data)
->options([
'var_jsonp_handler' => 'callback',
'default_jsonp_handler' => 'jsonpReturn',
'json_encode_param' => JSON_PRETTY_PRINT,
]);
~~~
## 關閉當前的請求緩存(`V5.1.5+`)
`V5.1.5+`版本開始,支持使用`allowCache`方法動態控制是否需要使用請求緩存。
~~~
// 關閉當前頁面的請求緩存
json($data)->code(201)->allowCache(false);
~~~
## 自定義響應
如果需要特別的自定義響應輸出,可以自定義一個`Response`子類,并且在控制器的操作方法中直接返回。又或者通過設置響應參數的方式進行響應設置輸出。
點贊