Http Responses响应

创建响应

字符串和数组

所有路由和控制器都应返回一个要发送回用户浏览器的响应。Laravel 提供了几种不同的方式来返回响应。最基本的响应是从路由或控制器返回一个字符串。框架将自动将字符串转换为一个完整的 HTTP 响应：

Route::get('/', function () {
    return 'Hello World';
});

除了从路由和控制器返回字符串之外，您还可以返回数组。框架将自动将数组转换为 JSON 响应：

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

您知道您还可以从路由或控制器返回 Eloquent 集合吗？它们将自动转换为 JSON。试一试吧！

响应对象

通常，您不会只从路由操作返回简单的字符串或数组。相反，您将返回完整的 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');
});

Eloquent 模型和集合

您还可以直接从路由和控制器返回 Eloquent ORM 模型和集合。当您这样做时，Laravel 会自动将模型和集合转换为 JSON 响应，同时遵守模型的隐藏属性：

use App\Models\User;

Route::get('/user/{user}', function (User $user) {
    return $user;
});

为响应附加头

请记住，大多数响应方法都是可链接的，允许流畅地构建响应实例。例如，您可以使用 header 方法在将响应发送回用户之前向其添加一系列头：

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 () {
        // ...
    });
});

为响应附加 Cookies

您可以使用 cookie 方法将 cookie 附加到传出的 Illuminate\Http\Response 实例。您应该将名称、值和 cookie 应被视为有效的分钟数传递给此方法：

return response('Hello World')->cookie(
    'name', 'value', $minutes
);

cookie 方法还接受一些不常用的参数。通常，这些参数与将提供给 PHP 的原生 setcookie 方法的参数具有相同的目的和含义：

return response('Hello World')->cookie(
    'name', 'value', $minutes, $path, $domain, $secure, $httpOnly
);

如果您想确保在传出的响应中发送 cookie，但您还没有该响应的实例，您可以使用 Cookie facade 来“排队”cookie，以便在响应发送时附加到它。queue 方法接受创建 cookie 实例所需的参数。这些 cookie 将在传出的响应发送到浏览器之前附加到它：

use Illuminate\Support\Facades\Cookie;

Cookie::queue('name', 'value', $minutes);

生成 Cookie 实例

如果您想生成一个 Symfony\Component\HttpFoundation\Cookie 实例，以便稍后附加到响应实例，您可以使用全局 cookie 助手。除非将此 cookie 附加到响应实例，否则它不会发送回客户端：

$cookie = cookie('name', 'value', $minutes);

return response('Hello World')->cookie($cookie);

提前过期 Cookies

您可以通过传出响应的 withoutCookie 方法使其过期来移除一个 cookie：

return response('Hello World')->withoutCookie('name');

如果您还没有传出响应的实例，您可以使用 Cookie facade 的 expire 方法来使 cookie 过期：

Cookie::expire('name');

Cookies 和加密

默认情况下，由于 Illuminate\Cookie\Middleware\EncryptCookies 中间件，Laravel 生成的所有 cookie 都会被加密和签名，因此它们不能被客户端修改或读取。如果您想为您的应用程序生成的 cookie 子集禁用加密，您可以在应用程序的 bootstrap/app.php 文件中使用 encryptCookies 方法：

->withMiddleware(function (Middleware $middleware) {
    $middleware->encryptCookies(except: [
        'cookie_name',
    ]);
})

重定向

重定向响应是 Illuminate\Http\RedirectResponse 类的实例，并包含将用户重定向到另一个 URL 所需的正确头。有几种方法可以生成 RedirectResponse 实例。最简单的方法是使用全局 redirect 助手：

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

有时您可能希望将用户重定向到他们以前的位置，例如提交的表单无效时。您可以使用全局 back 助手函数来做到这一点。由于此功能利用了会话，请确保调用 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]);

如果您想自定义放置在路由参数中的值，您可以在路由参数定义中指定列（/profile/{id:slug}）或者您可以在您的 Eloquent 模型上覆盖 getRouteKey 方法：

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

重定向到控制器动作

您还可以生成重定向到控制器动作。为此，将控制器和动作名称传递给 action 方法：

use App\Http\Controllers\UserController;

return redirect()->action([UserController::class, 'index']);

如果您的控制器路由需要参数，您可以将它们作为第二个参数传递给 action 方法：

return redirect()->action(
    [UserController::class, 'profile'], ['id' => 1]
);

重定向到外部域

有时您可能需要重定向到您的应用程序之外的域。您可以通过调用 away 方法来做到这一点，该方法创建一个不带任何额外 URL 编码、验证或验证的 RedirectResponse：

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

重定向并闪存会话数据

重定向到新 URL 并将数据闪存到会话通常是同时完成的。通常，这在成功执行某个操作后完成，当您将成功消息闪存到会话时。为了方便起见，您可以在一个流畅的方法链中创建 RedirectResponse 实例并将数据闪存到会话：

Route::post('/user/profile', function () {
    // ...

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

在用户被重定向后，您可以从会话中显示闪存的消息。例如，使用 Blade 语法：

@if (session('status'))
    <div class="alert alert-success">
        {{ session('status') }}
    </div>
@endif

重定向并输入

您可以使用 RedirectResponse 实例提供的 withInput 方法，在将用户重定向到新位置之前，将当前请求的输入数据闪存到会话。如果用户遇到验证错误，通常会这样做。一旦输入被闪存到会话，您可以在下一次请求期间轻松地检索它以重新填充表单：

return back()->withInput();

其他响应类型

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 方法接受一个文件名作为方法的第二个参数，该文件名将决定下载文件的用户看到的文件名。最后，您可以将一个 HTTP 头数组作为方法的第三个参数传递：

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

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

管理文件下载的 Symfony HttpFoundation 要求正在下载的文件具有 ASCII 文件名。

文件响应

file 方法可用于直接在用户的浏览器中显示文件（例如图像或 PDF），而不是启动下载。此方法接受文件的绝对路径作为其第一个参数，并接受一个头数组作为其第二个参数：

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

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

流式响应*

通过将数据作为流传输到客户端，您可以显著减少内存使用并提高性能，特别是对于非常大的响应。流式响应允许客户端在服务器完成发送之前开始处理数据：

Route::get('/stream', function () {
    return response()->stream(function (): void {
        foreach (['developer', 'admin'] as $string) {
            echo $string;
            ob_flush();
            flush();
            sleep(2); // Simulate delay between chunks...
        }
    }, 200, ['X-Accel-Buffering' => 'no']);
});

为了方便起见，如果您提供给 stream 方法的闭包返回一个 Generator，Laravel 将在生成器返回的字符串之间自动刷新输出缓冲区，并禁用 Nginx 输出缓冲：

Route::post('/chat', function () {
    return response()->stream(function (): Generator {
        $stream = OpenAI::client()->chat()->createStreamed(...);

        foreach ($stream as $response) {
            yield $response->choices[0];
        }
    });
});

消费流式响应

可以使用 Laravel 的 stream npm 包来消费流式响应，该包提供了与 Laravel 响应和事件流交互的便捷 API。要开始，请安装 @laravel/stream-react 或 @laravel/stream-vue 包：

npm install @laravel/stream-react

npm install @laravel/stream-vue

然后，可以使用 useStream 来消费事件流。在提供流 URL 后，随着内容从您的 Laravel 应用程序返回，该钩子将自动用连接的响应更新 data：

import { useStream } from "@laravel/stream-react";

function App() {
    const { data, isFetching, isStreaming, send } = useStream("chat");

    const sendMessage = () => {
        send({
            message: `Current timestamp: ${Date.now()}`,
        });
    };

    return (
        <div>
            <div>{data}</div>
            {isFetching && <div>Connecting...</div>}
            {isStreaming && <div>Generating...</div>}
            <button onClick={sendMessage}>Send Message</button>
        </div>
    );
}

<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";

const { data, isFetching, isStreaming, send } = useStream("chat");

const sendMessage = () => {
    send({
        message: `Current timestamp: ${Date.now()}`,
    });
};
</script>

<template>
    <div>
        <div>{{ data }}</div>
        <div v-if="isFetching">Connecting...</div>
        <div v-if="isStreaming">Generating...</div>
        <button @click="sendMessage">Send Message</button>
    </div>
</template>

当通过 send 将数据发送回流时，活动连接将被取消，然后发送新数据。所有请求都作为 JSON POST 请求发送。

由于 useStream 钩子向您的应用程序发出 POST 请求，因此需要有效的 CSRF 令牌。提供 CSRF 令牌最简单的方法是通过应用程序布局的头部中的 meta 标签包含它。

提供给 useStream 的第二个参数是一个选项对象，您可以使用它来自定义流消费行为。此对象的默认值如下所示：

import { useStream } from "@laravel/stream-react";

function App() {
    const { data } = useStream("chat", {
        id: undefined,
        initialInput: undefined,
        headers: undefined,
        csrfToken: undefined,
        onResponse: (response: Response) => void,
        onData: (data: string) => void,
        onCancel: () => void,
        onFinish: () => void,
        onError: (error: Error) => void,
    });

    return <div>{data}</div>;
}

<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";

const { data } = useStream("chat", {
    id: undefined,
    initialInput: undefined,
    headers: undefined,
    csrfToken: undefined,
    onResponse: (response: Response) => void,
    onData: (data: string) => void,
    onCancel: () => void,
    onFinish: () => void,
    onError: (error: Error) => void,
});
</script>

<template>
    <div>{{ data }}</div>
</template>

onResponse 在从流中获得成功的初始响应后触发，并将原始 Response 传递给回调。onData 在接收到每个块时调用 - 当前块被传递给回调。当流完成时以及在抓取/读取周期中抛出错误时，都会调用 onFinish。

默认情况下，在初始化时不会向流发出请求。您可以使用 initialInput 选项向流传递初始有效负载：

import { useStream } from "@laravel/stream-react";

function App() {
    const { data } = useStream("chat", {
        initialInput: {
            message: "Introduce yourself.",
        },
    });

    return <div>{data}</div>;
}

<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";

const { data } = useStream("chat", {
    initialInput: {
        message: "Introduce yourself.",
    },
});
</script>

<template>
    <div>{{ data }}</div>
</template>

要手动取消流，您可以使用从钩子返回的 cancel 方法：

import { useStream } from "@laravel/stream-react";

function App() {
    const { data, cancel } = useStream("chat");

    return (
        <div>
            <div>{data}</div>
            <button onClick={cancel}>Cancel</button>
        </div>
    );
}

<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";

const { data, cancel } = useStream("chat");
</script>

<template>
    <div>
        <div>{{ data }}</div>
        <button @click="cancel">Cancel</button>
    </div>
</template>

每次使用 useStream 钩子时，都会生成一个随机 id 来标识流。此 ID 会在每个请求中通过 X-STREAM-ID 头发送回服务器。当从多个组件消费同一个流时，您可以通过提供自己的 id 来读取和写入该流：

// App.tsx
import { useStream } from "@laravel/stream-react";

function App() {
    const { data, id } = useStream("chat");

    return (
        <div>
            <div>{data}</div>
            <StreamStatus id={id} />
        </div>
    );
}

// StreamStatus.tsx
import { useStream } from "@laravel/stream-react";

function StreamStatus({ id }) {
    const { isFetching, isStreaming } = useStream("chat", { id });

    return (
        <div>
            {isFetching && <div>Connecting...</div>}
            {isStreaming && <div>Generating...</div>}
        </div>
    );
}

<!-- App.vue -->
<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";
import StreamStatus from "./StreamStatus.vue";

const { data, id } = useStream("chat");
</script>

<template>
    <div>
        <div>{{ data }}</div>
        <StreamStatus :id="id" />
    </div>
</template>

<!-- StreamStatus.vue -->
<script setup lang="ts">
import { useStream } from "@laravel/stream-vue";

const props = defineProps<{
    id: string;
}>();

const { isFetching, isStreaming } = useStream("chat", { id: props.id });
</script>

<template>
    <div>
        <div v-if="isFetching">Connecting...</div>
        <div v-if="isStreaming">Generating...</div>
    </div>
</template>

流式 JSON 响应

如果您需要以增量方式流式传输 JSON 数据，您可以使用 streamJson 方法。此方法对于需要以可以被 JavaScript 轻松解析的格式逐步发送到浏览器的庞大数据集特别有用：

use App\Models\User;

Route::get('/users.json', function () {
    return response()->streamJson([
        'users' => User::cursor(),
    ]);
});

useJsonStream 钩子与 useStream 钩子相同，只是它会在流式传输完成后尝试将数据解析为 JSON：

import { useJsonStream } from "@laravel/stream-react";

type User = {
    id: number;
    name: string;
    email: string;
};

function App() {
    const { data, send } = useJsonStream<{ users: User[] }>("users");

    const loadUsers = () => {
        send({
            query: "taylor",
        });
    };

    return (
        <div>
            <ul>
                {data?.users.map((user) => (
                    <li>
                        {user.id}: {user.name}
                    </li>
                ))}
            </ul>
            <button onClick={loadUsers}>Load Users</button>
        </div>
    );
}

<script setup lang="ts">
import { useJsonStream } from "@laravel/stream-vue";

type User = {
    id: number;
    name: string;
    email: string;
};

const { data, send } = useJsonStream<{ users: User[] }>("users");

const loadUsers = () => {
    send({
        query: "taylor",
    });
};
</script>

<template>
    <div>
        <ul>
            <li v-for="user in data?.users" :key="user.id">
                {{ user.id }}: {{ user.name }}
            </li>
        </ul>
        <button @click="loadUsers">Load Users</button>
    </div>
</template>

事件流 (SSE)

eventStream 方法可用于使用 text/event-stream 内容类型返回服务器发送事件 (SSE) 流式响应。eventStream 方法接受一个闭包，该闭包应在响应可用时 yield 响应到流中：

Route::get('/chat', function () {
    return response()->eventStream(function () {
        $stream = OpenAI::client()->chat()->createStreamed(...);

        foreach ($stream as $response) {
            yield $response->choices[0];
        }
    });
});

如果您想自定义事件的名称，您可以 yield 一个 StreamedEvent 类的实例：

use Illuminate\Http\StreamedEvent;

yield new StreamedEvent(
    event: 'update',
    data: $response->choices[0],
);

消费事件流

可以使用 Laravel 的 stream npm 包来消费事件流，该包提供了与 Laravel 事件流交互的便捷 API。要开始，请安装 @laravel/stream-react 或 @laravel/stream-vue 包：

npm install @laravel/stream-react

npm install @laravel/stream-vue

然后，可以使用 useEventStream 来消费事件流。在提供流 URL 后，随着消息从您的 Laravel 应用程序返回，该钩子将自动用连接的响应更新 message：

import { useEventStream } from "@laravel/stream-react";

function App() {
  const { message } = useEventStream("/chat");

  return <div>{message}</div>;
}

<script setup lang="ts">
import { useEventStream } from "@laravel/stream-vue";

const { message } = useEventStream("/chat");
</script>

<template>
  <div>{{ message }}</div>
</template>

提供给 useEventStream 的第二个参数是一个选项对象，您可以使用它来自定义流消费行为。此对象的默认值如下所示：

import { useEventStream } from "@laravel/stream-react";

function App() {
  const { message } = useEventStream("/stream", {
    eventName: "update",
    onMessage: (message) => {
      //
    },
    onError: (error) => {
      //
    },
    onComplete: () => {
      //
    },
    endSignal: "</stream>",
    glue: " ",
  });

  return <div>{message}</div>;
}

<script setup lang="ts">
import { useEventStream } from "@laravel/stream-vue";

const { message } = useEventStream("/chat", {
  eventName: "update",
  onMessage: (message) => {
    // ...
  },
  onError: (error) => {
    // ...
  },
  onComplete: () => {
    // ...
  },
  endSignal: "</stream>",
  glue: " ",
});
</script>

事件流也可以通过应用程序的前端通过 EventSource 对象手动消费。当流完成时，eventStream 方法将自动向事件流发送 </stream> 更新：

const source = new EventSource('/chat');

source.addEventListener('update', (event) => {
  if (event.data === '</stream>') {
    source.close();

    return;
  }

  console.log(event.data);
});

要自定义发送到事件流的最终事件，您可以将 StreamedEvent 实例提供给 eventStream 方法的 endStreamWith 参数：

return response()->eventStream(function () {
    // ...
}, endStreamWith: new StreamedEvent(event: 'update', data: '</stream>'));

流式下载

有时您可能希望将给定操作的字符串响应转换为可下载的响应，而无需将操作内容写入磁盘。您可以在此场景中使用 streamDownload 方法。此方法接受一个回调、文件名和一个可选的头数组作为其参数：

use App\Services\GitHub;

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

响应宏

如果您想定义一个可以在多个路由和控制器中重用的自定义响应，您可以使用 Response facade 上的 macro 方法。通常，您应该从应用程序的一个服务提供者的 boot 方法中调用此方法，例如 App\Providers\AppServiceProvider 服务提供者：

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Response;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Response::macro('caps', function (string $value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro 函数接受一个名称作为其第一个参数，一个闭包作为其第二个参数。当从 ResponseFactory 实现或 response 助手调用宏名称时，宏的闭包将被执行：

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

Http请求

视图