laravel http response——迹忆客-ag捕鱼王app官网

• 创建 response
• 重定向
• 其他响应类型
• 响应宏

创建response

字符串和数组

所有路由和控制器都应向用户的浏览器返回响应消息。laravel提供了几种不同的返回响应的方式。最基本的响应是从路由或控制器返回字符串。laravel框架将自动把字符串转换为完整的http响应：

route::get('/', function () {
    return 'hello world';
});

除了从路由和控制器返回字符串外，我们还可以返回数组。数组将自动被转换为json响应：

route::get('/', function () {
    return [1, 2, 3];
});

我们还可以从路由或控制器返回eloquent集合，它们将自动被转换为json。试一试！

response 对象实例

通常情况下，我们不仅会从路由操作中返回简单的字符串或数组。而且，我们还会返回完整的illuminate\http\response实例或视图。

返回完整的response实例，可以自定义响应的http状态码和消息头。response实例继承了symfony\component\httpfoundation\response类，它提供了多种用于构建http响应的方法：

route::get('home', function () {
    return response('hello world', 200)
                  ->header('content-type', 'text/plain');
});

给response添加消息头——header

请记住，大多数响应方法返回的都是一个response实例，可以继续调用其中的方法，形成一个链，从而可以流畅地构建响应实例。例如，我们可以使用header方法在将response发送回用户之前向response添加一系列标头：

return response($content)
            ->header('content-type', $type)
            ->header('x-header-one', 'header value')
            ->header('x-header-two', 'header value');

或者，我们可以使用withheaders方法来指定要添加到响应中的标头数组：

return response($content)
            ->withheaders([
                'content-type' => $type,
                'x-header-one' => 'header value',
                'x-header-two' => 'header value',
            ]);

缓存控制中间件

laravel包含一个cache.headers中间件，该中间件可以快速的将一组路由的消息头添加cache-control。如果在指令列表中指定了etag，则会从响应内容生成一个md5的哈希值。该值将自动被设置为etag标识符：

route::middleware('cache.headers:public;max_age=2628000;etag')->group(function () {
    route::get('privacy', function () {
        // ...
    });
    route::get('terms', function () {
        // ...
    });
});

在响应消息中返回cookie

response 实例中的cookie方法可以轻松地将cookie添加到响应消息。例如，我们可以使用cookie方法生成cookie，并将其附加到response实例，如下所示：

return response($content)
                ->header('content-type', $type)
                ->cookie('name', 'value', $minutes);

cookie方法还有很多其他的参数，这些参数都不经常使用。通常，这些参数与php的setcookie方法具有相同的目的和含义：

return response($content)->cookie($name, $value, $minutes, $path, $domain, $secure, $httponly);

另外，我们可以使用cookie facade来将cookie加入队列，依次将其附加到应用程序的响应中。queue方法接受cookie实例或创建cookie实例所需的参数。这些cookie将在发送到浏览器之前附加到response响应中：

cookie::queue(cookie::make('name', 'value', $minutes));
cookie::queue('name', 'value', $minutes);

cookies和加密

默认情况下，laravel生成的所有cookie都经过加密和签名，客户端无法修改或读取。如果我们想对应用程序生成的一部分cookie禁用加密，则可以使用中间件app\http\middleware\encryptcookies的$except属性，该中间件位于app/http/middleware目录中：

/**
 * the names of the cookies that should not be encrypted.
 *
 * @var array
 */
protected $except = [
    'cookie_name',
];

重定向

重定向响应是illuminate\http\redirectresponse类的一个实例，它包含将用户重定向到另一个url所需的标头。有几种生成redirectresponse实例的方法。最简单的方法是使用全局redirect帮助函数：

route::get('dashboard', function () {
    return redirect('home/dashboard');
});

有时，我们可能希望将用户重定向到他们以前的位置，例如，当提交的表单无效时。可以通过使用全局back帮助函数来实现。由于此功能利用了session，因此请确保调用back函数的路由正在使用web中间件组或已应用所有会话中间件：

route::post('user/profile', function () {
    // validate the request...
    return back()->withinput();
});

重定向到命名路由

当我们不带参数的redirect函数时，将返回一个illuminate\routing\redirector的实例，我们可以调用redirector实例上的任何方法。例如，要生成一个redirectresponse实例，该实例要重定向到一个命名路由，可以使用route方法：

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

如果我们的路由具有参数，则可以将所需的参数传递个route方法的第二个参数：

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

通过eloquent模型填充参数

如果要重定向到eloquent模型中填充的带有“ id”参数的路由，则可以传递模型本身。该id将自动提取：

// for a route with the following uri: profile/{id}
return redirect()->route('profile', [$user]);

如果要自定义放置在route参数中的值，可以在路由的参数定义（profile/{id:slug}）中指定列，也可以在eloquent model中重写getroutekey方法：

/**
 * get the value of the model's route key.
 *
 * @return mixed
 */
public function getroutekey()
{
    return $this->slug;
}

重定向到控制器方法

我们还可以生成到控制器方法的重定向。将控制器和操作名称传递给action方法。记住，不需要为控制器指定完整的命名空间，因为laravelrouteserviceprovider会自动设置控制器的基本命名空间：

return redirect()->action('homecontroller@index');

如果控制器路由需要参数，则可以将这些参数以数组的形式传给action方法的第二个参数：

return redirect()->action(
    'usercontroller@profile', ['id' => 1]
);

重定向到外部域

有时我们可能需要重定向到应用程序外部的域。可以通过调用away方法来执行此操作，该方法将创建一个redirectresponse实例，该实例不带任何其他url编码，验证或验证的方法：

return redirect()->away('https://www.jiyik.com');

使用闪存的会话数据进行重定向

重定向到新的url并将数据暂存到会话通常是在同一时间完成的。通常，当我们在执行完一个操作后，当成功将消息闪存到会话时重定向就完成了。为了方便起见，我们可以创建一个redirectresponse实例，并在方法链中将数据闪存到会话中：

route::post('user/profile', function () {
    // update the user's profile...
    return redirect('dashboard')->with('status', 'profile updated!');
});

重定向用户后，可以显示会话中的消息。例如，使用blade语法：

@if (session('status'))
    

        {{ session('status') }}
    
@endif

其他回应类型

response函数也可用于生成其它类型的响应的实例。在response不带参数的情况下调用时，将返回illuminate\contracts\routing\responsefactory接口的一个实现。该接口提供了几种有用的方法来生成响应。

响应视图

如果需要控制响应的状态码和标头，并且返回一个视图作为响应的内容，则应使用view方法：

return response()
            ->view('hello', $data, 200)
            ->header('content-type', $type);

当然，如果不需要传递自定义http状态码或自定义标头，则应使用全局view帮助函数。

json响应

json方法会自动将content-type标头设置为application/json，并使用php的json_encode函数将给定数组转换为json ：

return response()->json([
    'name' => 'abigail',
    'state' => 'ca',
]);

如果想创建一个jsonp响应，则可以将json方法与withcallback方法结合使用：

return response()
            ->json(['name' => 'abigail', 'state' => 'ca'])
            ->withcallback($request->input('callback'));

文件下载

download方法可以用于生成一个用于下载的响应，该响应强制用户的浏览器在给定的路径下下载文件。download方法的第二个参数指定的文件名，用户下载的文件就使用该文件名命名。最后，download方法的第三个参数是用来指定http消息头的，该参数需要一个数组：

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

symfony httpfoundation（用于管理文件下载）要求下载的文件具有ascii文件名。

流式下载

有时，我们可能希望将给定操作的字符串响应转换为可下载的响应，而不必将操作的内容写入磁盘。在这种情况下可以使用使用streamdownload方法。此方法有三个参数，回调函数，文件名和http消息头（数组形式），其中第三个参数——http消息头是可选的：

return response()->streamdownload(function () {
    echo github::api('repo')
                ->contents()
                ->readme('laravel', 'laravel')['contents'];
}, 'laravel-readme.md');

file 响应

file方法可以用于直接在用户的浏览器中显示文件，例如图像或pdf，而不是启动下载。此方法第一个参数是文件的路径，第二个参数是http消息头（可选）：

return response()->file($pathtofile);
return response()->file($pathtofile, $headers);

响应宏

如果要定义可在各种路由和控制器中重复使用的自定义响应，则可以使用response facade的macro方法。例如，在service provider的 boot方法中使用：

return response()->caps('foo');