請求 · laravel 5.4

<article><h1>Laravel 的 HTTP 請求 Request</h1><ul><li><a href="#accessing-the-request">獲取請求</a><ul><li><a href="#request-path-and-method">請求路徑 & 方法</a></li><li><a href="#psr7-requests">PSR-7 請求</a></li></ul></li><li><a href="#input-trimming-and-normaliation">輸入數據的預處理和規范化</a></li><li><a href="#retrieving-input">獲取輸入數據</a><ul><li><a href="#old-input">舊輸入數據</a></li><li><a href="#cookies">Cookies</a></li></ul></li><li><a href="#files">文件資源</a><ul><li><a href="#retrieving-uploaded-files">獲取上傳文件</a></li><li><a href="#storing-uploaded-files">儲存上傳文件</a></li></ul></li></ul><a name="accessing-the-request"></a><h2><a href="#accessing-the-request">獲取請求</a></h2>要通過依賴注入的方式來獲取當前 HTTP 請求的實例，你應該在控制器方法中使用 <code class=" language-php">Illuminate\Http\Request</code> 類型提示。當前的請求實例將通過 <a href="/docs/5.4/container">服務容器</a> 自動注入：<pre class=" language-php"><code class=" language-php"><?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserController extends Controller { /** * 儲存一個新用戶。 * * @param Request $request * @return Response */ public function store(Request $request) { $name = $request->input('name'); // } }</code></pre><h4>依賴注入 & 路由參數</h4>如果控制器方法也有輸入數據是從路由參數中傳入的，只需將路由參數置于其他依賴之后。例如，你的路由是這樣定義的：<pre class=" language-php"><code class=" language-php">Route::put('user/{id}', 'UserController@update');</code></pre>只要像下方一樣定義控制器方法，你就可以使用 <code class=" language-php">Illuminate\Http\Request</code> 類型提示了，同時獲取到路由參數 <code class=" language-php">id</code>：<pre class=" language-php"><code class=" language-php"><?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserController extends Controller { /** * 更新指定的用戶。 * * @param Request $request * @param string $id * @return Response */ public function update(Request $request, $id) { // } }</code></pre><h4>通過路由閉包獲取請求</h4>你也可以在一個路由閉包中使用 <code class=" language-php">Illuminate\Http\Request</code> 類型提示。當它執行時，服務容器會自動注入當前請求到閉包中：<pre class=" language-php"><code class=" language-php">use Illuminate\Http\Request; Route::get('/', function (Request $request) { // });</code></pre><a name="request-path-and-method"></a><h3>請求路徑 & 方法</h3><code class=" language-php">Illuminate\Http\Request</code> 的實例提供了多種方法去檢查應用程序的 HTTP 請求，Laravel 的 <code class=" language-php">Illuminate\Http\Request</code> 繼承了 <code class=" language-php">Symfony\Component\HttpFoundation\Request</code> 類。下面是該類幾個有用的方法：<h4>獲取請求路徑</h4><code class=" language-php">path</code> 方法返回請求路徑信息。所以，如果收到的請求目標地址是 <code class=" language-php">http://domain.com/foo/bar</code>，那么 <code class=" language-php">path</code> 將會返回 <code class=" language-php">foo/bar</code>：<pre class=" language-php"><code class=" language-php">$uri = $request->path();</code></pre><code class=" language-php">is</code> 方法可以驗證收到的請求路徑和指定規則是否匹配。使用這個方法的時候你也可以傳遞一個 <code class=" language-php">*</code> 字符作為通配符：<pre class=" language-php"><code class=" language-php">if ($request->is('admin/*')) { // }</code></pre><h4>獲取請求的 URL</h4>你可以使用 <code class=" language-php">url</code> 或 <code class=" language-php">fullUrl</code> 方法去獲取傳入請求的完整 URL。<code class=" language-php">url</code> 方法返回不帶有查詢字符串的 URL，而 <code class=" language-php">fullUrl</code> 方法的返回值包含查詢字符串：<pre class=" language-php"><code class=" language-php">// Without Query String... $url = $request->url(); // With Query String... $url = $request->fullUrl();</code></pre><h4>獲取請求方法</h4>對于傳入的請求 <code class=" language-php">method</code> 方法將返回 HTTP 的請求方式。你也可以使用 <code class=" language-php">isMethod</code> 方法去驗證 HTTP 的請求方式與指定規則是否相配：<pre class=" language-php"><code class=" language-php">$method = $request->method(); if ($request->isMethod('post')) { // }</code></pre><a name="psr7-requests"></a><h3>PSR-7 請求</h3><a href="http://www.php-fig.org/psr/psr-7/">PSR-7 標準</a>制定的 HTTP 消息接口包含了請求和響應。如果你想使用一個 PSR-7 請求來代替一個 Laravel 請求，那么你首先要安裝幾個函數庫。Laravel 使用了 Symfony 的 HTTP 消息橋接組件，將原來的 Laravel 請求和響應轉換到 PSR-7 所兼容的實現：<pre class=" language-php"><code class=" language-php">composer require symfony/psr-http-message-bridge composer require zendframework/zend-diactoros</code></pre>安裝完這些庫后，就可以在路由閉包或控制器中，簡單的對請求類型使用類型提示來獲取 PSR-7 的請求：<pre class=" language-php"><code class=" language-php">use Psr\Http\Message\ServerRequestInterface; Route::get('/', function (ServerRequestInterface $request) { // });</code></pre><blockquote class="has-icon tip"><div class="flag"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" version="1.1" x="0px" y="0px" width="56.6px" height="87.5px" viewBox="0 0 56.6 87.5" enable-background="new 0 0 56.6 87.5" xml:space="preserve"><path fill="#FFFFFF" d="M28.7 64.5c-1.4 0-2.5-1.1-2.5-2.5v-5.7 -5V41c0-1.4 1.1-2.5 2.5-2.5s2.5 1.1 2.5 2.5v10.1 5 5.8C31.2 63.4 30.1 64.5 28.7 64.5zM26.4 0.1C11.9 1 0.3 13.1 0 27.7c-0.1 7.9 3 15.2 8.2 20.4 0.5 0.5 0.8 1 1 1.7l3.1 13.1c0.3 1.1 1.3 1.9 2.4 1.9 0.3 0 0.7-0.1 1.1-0.2 1.1-0.5 1.6-1.8 1.4-3l-2-8.4 -0.4-1.8c-0.7-2.9-2-5.7-4-8 -1-1.2-2-2.5-2.7-3.9C5.8 35.3 4.7 30.3 5.4 25 6.7 14.5 15.2 6.3 25.6 5.1c13.9-1.5 25.8 9.4 25.8 23 0 4.1-1.1 7.9-2.9 11.2 -0.8 1.4-1.7 2.7-2.7 3.9 -2 2.3-3.3 5-4 8L41.4 53l-2 8.4c-0.3 1.2 0.3 2.5 1.4 3 0.3 0.2 0.7 0.2 1.1 0.2 1.1 0 2.2-0.8 2.4-1.9l3.1-13.1c0.2-0.6 0.5-1.2 1-1.7 5-5.1 8.2-12.1 8.2-19.8C56.4 12 42.8-1 26.4 0.1zM43.7 69.6c0 0.5-0.1 0.9-0.3 1.3 -0.4 0.8-0.7 1.6-0.9 2.5 -0.7 3-2 8.6-2 8.6 -1.3 3.2-4.4 5.5-7.9 5.5h-4.1H28h-0.5 -3.6c-3.5 0-6.7-2.4-7.9-5.7l-0.1-0.4 -1.8-7.8c-0.4-1.1-0.8-2.1-1.2-3.1 -0.1-0.3-0.2-0.5-0.2-0.9 0.1-1.3 1.3-2.1 2.6-2.1H41C42.4 67.5 43.6 68.2 43.7 69.6zM37.7 72.5H26.9c-4.2 0-7.2 3.9-6.3 7.9 0.6 1.3 1.8 2.1 3.2 2.1h4.1 0.5 0.5 3.6c1.4 0 2.7-0.8 3.2-2.1L37.7 72.5z"></path></svg></div> 如果你從路由或者控制器返回了一個 PSR-7 響應實例，那么這個實例將被自動轉換回一個 Laravel 響應實例，同時由框架顯示。</blockquote><a name="input-trimming-and-normaliation"></a><h2><a href="#input-trimming-and-normaliation">輸入數據的預處理和規范化</a></h2>在 Laravel 的全局中間件中默認包含了 <code class=" language-php">TrimStrings</code> 和 <code class=" language-php">ConvertEmptyStringsToNull</code> 兩個中間件。這些中間件被列在 <code class=" language-php">App\Http\Kernel</code> 類中。它們會自動處理所有請求中傳入的字符串字段，比如將空的字符串字段轉變成 <code class=" language-php">null</code> 值。你再也不用擔心路由和控制器中數據規范化的問題。如果你想停用這些功能，你可以在 <code class=" language-php">App\Http\Kernel</code> 類的 <code class=" language-php">$middleware</code> 屬性中移除這些中間件。<a name="retrieving-input"></a><h2><a href="#retrieving-input">獲取輸入數據</a></h2><h4>獲取所有輸入數據</h4>你可以使用 <code class=" language-php">all</code> 方法以 <code class=" language-php">數組</code> 形式獲取到所有輸入數據:<pre class=" language-php"><code class=" language-php">$input = $request->all();</code></pre><h4>獲取指定輸入值</h4>你可以通過 <code class=" language-php">Illuminate\Http\Request</code> 的實例，借助幾個簡單的方法，就可以獲取到用戶輸入的所有數據。而不需要擔心發起請求時使用了哪一種請求方式，<code class=" language-php">input</code> 方法通常被用來獲取用戶輸入數據：<pre class=" language-php"><code class=" language-php">$name = $request->input('name');</code></pre>你可以給 <code class=" language-php">input</code> 方法的第二個參數傳入一個默認值。當請求的輸入數據不存在于此請求時，返回該默認值：<pre class=" language-php"><code class=" language-php">$name = $request->input('name', 'Sally');</code></pre>如果傳輸表單數據中包含「數組」形式的數據，那么可以使用「點」語法來獲取數組：<pre class=" language-php"><code class=" language-php">$name = $request->input('products.0.name'); $names = $request->input('products.*.name');</code></pre><h4>通過動態屬性獲取輸入數據</h4>你也可以通過 <code class=" language-php">Illuminate\Http\Request</code> 實例的動態屬性來獲取用戶輸入的數據。例如，如果你應用程序表單中包含 <code class=" language-php">name</code> 字段，那么可以像這樣訪問提交的值：<pre class=" language-php"><code class=" language-php">$name = $request->name;</code></pre>Laravel 在處理動態屬性的優先級是，先從請求的數據中查找，沒有的話再到路由參數中找。<h4>獲取 JSON 輸入信息</h4>當你發送 JSON 請求到應用時，只要請求表頭中設置了 <code class=" language-php">Content-Type</code> 為 <code class=" language-php">application/json</code>，你就可以直接從 <code class=" language-php">Input</code> 方法中獲取 JSON 數據。你也可以通過「點」語法來讀取 JSON 數組：<pre class=" language-php"><code class=" language-php">$name = $request->input('user.name');</code></pre><h4>獲取部分輸入數據</h4>如果你需要獲取輸入數據的子集，則可以用 <code class=" language-php">only</code> 和 <code class=" language-php">except</code> 方法。這兩個方法都接收單個 <code class=" language-php">數組</code> 或動態列表作為參數：<pre class=" language-php"><code class=" language-php">$input = $request->only(['username', 'password']); $input = $request->only('username', 'password'); $input = $request->except(['credit_card']); $input = $request->except('credit_card');</code></pre><code class=" language-php">only</code> 方法會返回所有你指定的鍵值對，即使這個鍵在輸入數據中并不存在。如果一個鍵在輸入數據中并不存在時，它對應的值是 <code class=" language-php">null</code> 。當你想要獲取請求中實際存在的輸入數據時，你可以使用 <code class=" language-php">intersect</code> 方法。<pre class=" language-php"><code class=" language-php">$input = $request->intersect(['username', 'password']);</code></pre><h4>確定是否有輸入值</h4>要判斷請求是否存在該數據，可以使用 <code class=" language-php">has</code> 方法。當數據存在 并且 字符串不為空時，<code class=" language-php">has</code> 方法就會返回 <code class=" language-php">true</code>：<pre class=" language-php"><code class=" language-php">if ($request->has('name')) { // }</code></pre><a name="old-input"></a><h3>舊輸入數據</h3>Laravel 允許你將本次的輸入數據保留到下一次請求發送前。這個特性在表單驗證錯誤后重新填寫表單相當有用。但是，如果你使用了 Laravel 的 <a href="/docs/5.4/validation">驗證特性</a>，你就不需要在手動實現這些方法，因為 Laravel 內置的驗證工具會自動調用他們。<h4>將輸入數據閃存至 Session</h4><code class=" language-php">Illuminate\Http\Request</code> 的 <code class=" language-php">flash</code> 方法會將當前輸入的數據存進 <a href="/docs/5.4/session">session</a> 中，因此下次用戶發送請求到應用程序時就可以使用它們：<pre class=" language-php"><code class=" language-php">$request->flash();</code></pre>你也可以使用 <code class=" language-php">flashOnly</code> 和 <code class=" language-php">flashExcept</code> 方法將當前請求數據的子集保存到 session。這些方法對敏感信息的保護非常有用：<pre class=" language-php"><code class=" language-php">$request->flashOnly(['username', 'email']); $request->flashExcept('password');</code></pre><h4>閃存輸入數據到 Session 后重定向</h4>你可能需要把輸入數據閃存到 session 并重定向到前一個頁面，這時只需要在重定向方法后加上 <code class=" language-php">withInput</code> 即可：<pre class=" language-php"><code class=" language-php">return redirect('form')->withInput(); return redirect('form')->withInput( $request->except('password') );</code></pre><h4>獲取舊輸入數據</h4>若要獲取上一次請求后所閃存的輸入數據，則可以使用 <code class=" language-php">Request</code> 實例中的 <code class=" language-php">old</code> 方法。<code class=" language-php">old</code> 方法提供一個簡便的方式從 <a href="/docs/5.4/session">Session</a> 取出被閃存的輸入數據：<pre class=" language-php"><code class=" language-php">$username = $request->old('username');</code></pre>Laravel 也提供了全局輔助函數 <code class=" language-php">old</code>。如果你要在 <a href="/docs/5.4/blade">Blade 模板</a> 中顯示舊輸入數據，可以使用更加方便的 <code class=" language-php">old</code> 輔助函數。如果舊數據不存在，則返回 <code class=" language-php">null</code>：<pre class=" language-php"><code class=" language-php"><input type="text" name="username" value="{{ old('username') }}"></code></pre><a name="cookies"></a><h3>Cookies</h3><h4>從請求中獲取 Cookie 值</h4>Laravel 框架創建的每個 cookie 都會被加密并且加上認證標識，這代表著用戶擅自更改的 cookie 都會失效。若要從此次請求獲取 cookie 值，你可以使用 <code class=" language-php">Illuminate\Http\Request</code> 實例中的 <code class=" language-php">cookie</code> 方法：<pre class=" language-php"><code class=" language-php">$value = $request->cookie('name');</code></pre><h4>將 Cookies 附加到響應</h4>你可以使用 <code class=" language-php">cookie</code> 方法附加一個 cookie 到 <code class=" language-php">Illuminate\Http\Response</code> 實例。有效 cookie 應該傳遞字段名稱，字段值和過期時間給這個方法：<pre class=" language-php"><code class=" language-php">return response('Hello World')->cookie( 'name', 'value', $minutes );</code></pre><code class=" language-php">cookie</code> 方法還可以接受更多參數，只是使用頻率較低。通常作用是傳遞參數給 PHP 原生 <a href="http://php.net/manual/en/function.setcookie.php">設置 cookie</a> 方法：<pre class=" language-php"><code class=" language-php">return response('Hello World')->cookie( 'name', 'value', $minutes, $path, $domain, $secure, $httpOnly );</code></pre><h4>生成 Cookie 實例</h4>如果你想要在一段時間以后生成一個可以給定 <code class=" language-php">Symfony\Component\HttpFoundation\Cookie</code> 的響應實例，你可以先生成 $cookie 實例，然后再指定給 response 實例，否則這個 cookie 不會被發送回客戶端：<pre class=" language-php"><code class=" language-php">$cookie = cookie('name', 'value', $minutes); return response('Hello World')->cookie($cookie);</code></pre><blockquote>譯者注：關于 Cookie，需要注意一點，默認 Laravel 創建的所有 Cookie 都是加密過的，創建未加密的 Cookie 的方法請見 <a href="https://laravel-china.org/topics/1758">【小技巧分享】在 Laravel 中設置沒有加密的 cookie</a></blockquote><a name="files"></a><h2><a href="#files">文件資源</a></h2><a name="retrieving-uploaded-files"></a><h3>獲取上傳文件</h3>你可以使用 <code class=" language-php">Illuminate\Http\Request</code> 實例中的 <code class=" language-php">file</code> 方法獲取上傳的文件。file 方法返回的對象是 <code class=" language-php">Symfony\Component\HttpFoundation\File\UploadedFile</code> 類的實例，該類繼承了 PHP 的 <code class=" language-php">SplFileInfo</code> 類，并提供了許多和文件交互的方法：<pre class=" language-php"><code class=" language-php">$file = $request->file('photo'); $file = $request->photo;</code></pre>你可以使用請求的 <code class=" language-php">hasFile</code> 方法確認上傳的文件是否存在：<pre class=" language-php"><code class=" language-php">if ($request->hasFile('photo')) { // }</code></pre><h4>確認上傳的文件是否有效</h4>除了檢查上傳的文件是否存在外，你也可以通過 <code class=" language-php">isValid</code> 方法驗證上傳的文件是否有效：<pre class=" language-php"><code class=" language-php">if ($request->file('photo')->isValid()) { // }</code></pre><h4>文件路徑 & 擴展</h4><code class=" language-php">UploadedFile</code> 這個類也包含了訪問文件完整路徑和擴展的方法。<code class=" language-php">extension</code> 方法會嘗試根據文件內容猜測文件的擴展名。猜測結果可能不同于客戶端原始的擴展名：<pre class=" language-php"><code class=" language-php">$path = $request->photo->path(); $extension = $request->photo->extension();</code></pre><h4>其它上傳文件的方法</h4><code class=" language-php">UploadedFile</code> 的實例還有許多可用的方法，可以到該對象的 <a href="http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/File/UploadedFile.html">API 文檔</a> 了解這些方法的詳細信息。<a name="storing-uploaded-files"></a><h3>儲存上傳文件</h3>在設置好 <a href="/docs/5.4/filesystem">文件系統</a> 的配置信息后，你可以使用 <code class=" language-php">UploadedFile</code> 的 <code class=" language-php">store</code> 方法把上傳文件儲存到本地磁盤，或者是亞馬遜 S3 云存儲上。<code class=" language-php">store</code> 方法允許存儲文件到相對于文件系統根目錄配置的路徑。這個路徑不能包含文件名，名稱將使用 MD5 散列文件內容自動生成。<code class=" language-php">store</code> 方法還接受一個可選的第二個參數，用于文件存儲到磁盤的名稱。這個方法會返回文件相對于磁盤根目錄的路徑：<pre class=" language-php"><code class=" language-php">$path = $request->photo->store('images'); $path = $request->photo->store('images', 's3');</code></pre>如果你不想自動生成文件名，那么可以使用 <code class=" language-php">storeAs</code> 方法去設置路徑，文件名和磁盤名作為方法參數：<pre class=" language-php"><code class=" language-php">$path = $request->photo->storeAs('images', 'filename.jpg'); $path = $request->photo->storeAs('images', 'filename.jpg', 's3');</code></pre></article>