Lumen HTTP 響應(yīng)

2021-09-15 14:39 更新

1、基本響應(yīng)

所有路由和控制器都會返回某種被發(fā)送到用戶瀏覽器的響應(yīng),Lumen提供了多種不同的方式來返回響應(yīng),最基本的響應(yīng)就是從路由或控制器返回一個簡單的字符串:

$app->get('/', function () {
    return 'Hello World';
});

給定的字符串會被框架自動轉(zhuǎn)化為HTTP響應(yīng)。

但是大多數(shù)路由和控制器動作都會返回一個完整的Illuminate\Http\Response實例或視圖,返回一個完整的Response實例允許你自定義響應(yīng)的HTTP狀態(tài)碼和頭信息,Response實例繼承自Symfony\Component\HttpFoundation\Response類,該類提供了一系列方法用于創(chuàng)建HTTP響應(yīng):

use Illuminate\Http\Response;

$app->get('home', function () {
    return (new Response($content, $status))
                  ->header('Content-Type', $value);
});

為方便起見,還可以使用幫助函數(shù)response

$app->get('home', function () {
    return response($content, $status)
                  ->header('Content-Type', $value);
});

注意:查看完整的Response方法列表,請移步相應(yīng)的API文檔以及Symfony AP文檔

1.1 添加響應(yīng)頭

大部分響應(yīng)方法都是可以鏈?zhǔn)秸{(diào)用的,從而使得可以平滑的構(gòu)建響應(yīng)。例如,可以使用header方法來添加一系列響應(yīng)頭:

return response($content)
            ->header('Content-Type', $type)
            ->header('X-Header-One', 'Header Value')
            ->header('X-Header-Two', 'Header Value');

1.2 添加Cookies

使用response實例的幫助函數(shù)withCookie可以輕松添加cookie到響應(yīng),比如,可以使用withCookie方法來生成cookie并將其添加到response實例:

return response($content)->header('Content-Type', $type)
                 ->withCookie('name', 'value');

withCookie方法接收額外的可選參數(shù)從而允許對cookie屬性更多的自定義:

->withCookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly)

2、其它響應(yīng)類型

幫助函數(shù)response可以用來方便地生成其他類型的響應(yīng)實例,當(dāng)無參數(shù)調(diào)用response時會返回Illuminate\Contracts\Routing\ResponseFactory契約的一個實現(xiàn),該契約提供了一些有用的方法來生成響應(yīng)。

2.1 視圖響應(yīng)

如果你需要控制響應(yīng)狀態(tài)和響應(yīng)頭,還需要返回一個視圖作為響應(yīng)內(nèi)容,可以使用view方法:

return response()->view('hello', $data)->header('Content-Type', $type);

當(dāng)然,如果你不需要傳遞一個自定義的HTTP狀態(tài)碼或者自定義頭,只需要簡單使用全局的幫助函數(shù)view即可。

2.2 JSON響應(yīng)

json方法會自動將Content-Type頭設(shè)置為application/json,并使用PHP函數(shù)json_encode方法將給定數(shù)組轉(zhuǎn)化為JSON:

return response()->json(['name' => 'Abigail', 'state' => 'CA']);

如果你想要創(chuàng)建一個JSONP響應(yīng),可是添加setCallback到j(luò)son方法后面:

return response()->json(['name' => 'Abigail', 'state' => 'CA'])
                 ->setCallback($request->input('callback'));

2.3 文件下載

download方法用于生成強制用戶瀏覽器下載給定路徑文件的響應(yīng)。download方法接受文件名作為第二個參數(shù),該參數(shù)決定用戶下載文件的顯示名稱,你還可以將HTTP頭信息作為第三個參數(shù)傳遞到該方法:

return response()->download($pathToFile);
return response()->download($pathToFile, $name, $headers);

注意:管理文件下載的Symfony HttpFoundation類要求被下載文件有一個ASCII文件名。

3、重定向

重定向響應(yīng)是Illuminate\Http\RedirectResponse類的實例,其中包含了必須的頭信息將用戶重定向到另一個URL,有很多方式來生成RedirectResponse實例,最簡單的方法就是使用全局幫助函數(shù)redirect

$app->get('dashboard', function () {
    return redirect('home/dashboard');
});

有時候你想要將用戶重定向到前一個位置,比如,表單提交后,驗證不通過,你就可以使用back幫助函數(shù)返回前一個URL:

$app->post('user/profile', function () {
    // 驗證請求...
    return back()->withInput();
});

3.1 重定向到命名路由

如果調(diào)用不帶參數(shù)的redirect方法,會返回一個Illuminate\Routing\Redirector實例,從而可以調(diào)用該實例上的任何方法。比如,為了生成一個RedirectResponse到命名路由,可以使用route方法:

return redirect()->route('login');

如果路由中有參數(shù),可以將其作為第二個參數(shù)傳遞到route方法:

// For a route with the following URI: profile/{id}
return redirect()->route('profile', [1]);

如果要重定向到帶ID參數(shù)的路由,并從Eloquent模型中取數(shù)據(jù)填充表單,可以傳遞模型本身,ID會被自動解析出來:

return redirect()->route('profile', [$user]);

3.2 帶一次性Session數(shù)據(jù)的重定向

注意:使用此特性需要開啟session。

重定向到一個新的URL并將數(shù)據(jù)存儲到一次性session中通常是同時完成的,為了方便,可以創(chuàng)建一個RedirectResponse實例然后在同一個方法鏈上將數(shù)據(jù)存儲到session,這種方式在action之后存儲狀態(tài)信息時特別方便:

$app->post('user/profile', function () {
    // 更新用戶屬性...
    return redirect('dashboard')->with('status', 'Profile updated!');
});

當(dāng)然,用戶重定向到新頁面之后,你可以從session中取出并顯示這些一次性信息,比如,使用Blade語法實現(xiàn)如下:

@if (session('status'))
    <div class="alert alert-success">
        {{ session('status') }}
    </div>
@endif
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號