lumen Response

2023-08-02 20:00:34

1、基本响应

所有路由和控制器都会返回某种被发送到用户浏览器的响应，Lumen提供了多种不同的方式来返回响应，最基本的响应就是从路由或控制器返回一个简单的字符串：

$app->get('/', function () {

    return 'Hello World';

});

给定的字符串会被框架自动转化为HTTP响应。

但是大多数路由和控制器动作都会返回一个完整的Illuminate\Http\Response实例或视图，返回一个完整的Response实例允许你自定义响应的HTTP状态码和头信息，Response实例继承自Symfony\Component\HttpFoundation\Response类，该类提供了一系列方法用于创建HTTP响应：

use Illuminate\Http\Response;

$app->get('home', function () {

    return (new Response($content, $status))

                  ->header('Content-Type', $value);

});

为方便起见，还可以使用帮助函数response：

$app->get('home', function () {

    return response($content, $status)

                  ->header('Content-Type', $value);

});

注意：查看完整的Response方法列表，请移步相应的API文档以及Symfony AP文档

1.1 添加响应头

大部分响应方法都是可以链式调用的，从而使得可以平滑的构建响应。例如，可以使用header方法来添加一系列响应头：

return response($content)

            ->header('Content-Type', $type)

            ->header('X-Header-One', 'Header Value')

            ->header('X-Header-Two', 'Header Value');

1.2 添加Cookies

使用response实例的帮助函数withCookie可以轻松添加cookie到响应，比如，可以使用withCookie方法来生成cookie并将其添加到response实例：

return response($content)->header('Content-Type', $type)

                 ->withCookie('name', 'value');

withCookie方法接收额外的可选参数从而允许对cookie属性更多的自定义：

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

2、其它响应类型

帮助函数response可以用来方便地生成其他类型的响应实例，当无参数调用response时会返回Illuminate\Contracts\Routing\ResponseFactory契约的一个实现，该契约提供了一些有用的方法来生成响应。

2.1 视图响应

如果你需要控制响应状态和响应头，还需要返回一个视图作为响应内容，可以使用view方法：

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

当然，如果你不需要传递一个自定义的HTTP状态码或者自定义头，只需要简单使用全局的帮助函数view即可。

2.2 JSON响应

json方法会自动将Content-Type头设置为application/json，并使用PHP函数json_encode方法将给定数组转化为JSON：

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

如果你想要创建一个JSONP响应，可是添加setCallback到json方法后面：

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

                 ->setCallback($request->input('callback'));

2.3 文件下载

download方法用于生成强制用户浏览器下载给定路径文件的响应。download方法接受文件名作为第二个参数，该参数决定用户下载文件的显示名称，你还可以将HTTP头信息作为第三个参数传递到该方法：

return response()->download($pathToFile);

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

注意：管理文件下载的Symfony HttpFoundation类要求被下载文件有一个ASCII文件名。

3、重定向

重定向响应是Illuminate\Http\RedirectResponse类的实例，其中包含了必须的头信息将用户重定向到另一个URL，有很多方式来生成RedirectResponse实例，最简单的方法就是使用全局帮助函数redirect：

$app->get('dashboard', function () {

    return redirect('home/dashboard');

});

有时候你想要将用户重定向到前一个位置，比如，表单提交后，验证不通过，你就可以使用back帮助函数返回前一个URL：

$app->post('user/profile', function () {

    // 验证请求...

    return back()->withInput();

});

3.1 重定向到命名路由

如果调用不带参数的redirect方法，会返回一个Illuminate\Routing\Redirector实例，从而可以调用该实例上的任何方法。比如，为了生成一个RedirectResponse到命名路由，可以使用route方法：

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

如果路由中有参数，可以将其作为第二个参数传递到route方法：

// For a route with the following URI: profile/{id}

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

如果要重定向到带ID参数的路由，并从Eloquent模型中取数据填充表单，可以传递模型本身，ID会被自动解析出来：

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

3.2 带一次性Session数据的重定向

注意：使用此特性需要开启session。

重定向到一个新的URL并将数据存储到一次性session中通常是同时完成的，为了方便，可以创建一个RedirectResponse实例然后在同一个方法链上将数据存储到session，这种方式在action之后存储状态信息时特别方便：

$app->post('user/profile', function () {

    // 更新用户属性...

    return redirect('dashboard')->with('status', 'Profile updated!');

});

当然，用户重定向到新页面之后，你可以从session中取出并显示这些一次性信息，比如，使用Blade语法实现如下：

@if (session('status'))

    <div class="alert alert-success">

        {{ session('status') }}

    </div>

@e

码农公寓