跳到主要內容

HTTP 回應

📝 此頁面為 Laravel 官方文檔的繁體中文翻譯。查看原始英文版本

HTTP 回應

建立回應

字串與陣列

所有路由和控制器都應返回一個回應,該回應將被傳回使用者的瀏覽器。Laravel 提供了幾種不同的方式來返回回應。最基本的回應是從路由或控制器返回一個字串。框架將自動將字串轉換為完整的 HTTP 回應:

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

除了從路由和控制器返回字串外,您還可以返回陣列。框架將自動將陣列轉換為 JSON 回應:

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

[!NOTE] 您知道嗎?您也可以從路由或控制器返回 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',
    ]);

您可以使用 withoutHeader 方法從傳出回應中移除特定標頭:

return response($content)->withoutHeader('X-Debug');

return response($content)->withoutHeader(['X-Debug', 'X-Powered-By']);

快取控制中介層

Laravel 包含一個 cache.headers 中介層,可用於快速設定一組路由的 Cache-Control 標頭。指令應使用對應快取控制指令的「蛇形命名」等效形式提供,並應以分號分隔。如果在指令列表中指定了 etag,回應內容的 MD5 雜湊值將自動設定為 ETag 標識符:

Route::middleware('cache.headers:public;max_age=30;s_maxage=300;stale_while_revalidate=600;etag')->group(function () {
    Route::get('/privacy', function () {
        // ...
    });

    Route::get('/terms', function () {
        // ...
    });
});

向回應附加 Cookie

您可以使用 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 外觀來「佇列化」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);

提前過期 Cookie

您可以透過傳出回應的 withoutCookie 方法使 Cookie 過期來移除它:

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

如果您還沒有傳出回應的實例,可以使用 Cookie 外觀的 expire 方法使 Cookie 過期:

Cookie::expire('name');

Cookie 與加密

預設情況下,感謝 Illuminate\Cookie\Middleware\EncryptCookies 中介層,Laravel 生成的所有 Cookie 都是加密和簽名的,因此它們無法被客戶端修改或讀取。如果您希望禁用應用程式生成的部分 Cookie 的加密,可以在應用程式的 bootstrap/app.php 檔案中使用 encryptCookies 方法:

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

[!NOTE] 一般來說,不應禁用 Cookie 加密,因為這會使您的 Cookie 暴露於潛在的客戶端資料洩露和篡改風險。

重定向

重定向回應是 Illuminate\Http\RedirectResponse 類別的實例,並包含將使用者重定向到另一個 URL 所需的正確標頭。有多種方式可以生成 RedirectResponse 實例。最簡單的方法是使用全域 redirect 輔助函數:

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

有時您可能希望將使用者重定向到他們之前的位置,例如當提交的表單無效時。您可以使用全域 back 輔助函數來實現。由於此功能使用 Session,請確保呼叫 back 函數的路由正在使用 web 中介層群組:

Route::post('/user/profile', function () {
    // 驗證請求...

    return back()->withInput();
});

重定向到命名路由

當您不帶參數呼叫 redirect 輔助函數時,將返回 Illuminate\Routing\Redirector 的一個實例,允許您在 Redirector 實例上呼叫任何方法。例如,要生成指向命名路由的 RedirectResponse,您可以使用 route 方法:

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

如果您的路由有參數,您可以將它們作為第二個參數傳遞給 route 方法:

// 對於具有以下 URI 的路由:/profile/{id}

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

透過 Eloquent 模型填充參數

如果您正在重定向到具有「ID」參數的路由,且該參數是從 Eloquent 模型填充的,您可以直接傳遞模型本身。ID 將被自動提取:

// 對於具有以下 URI 的路由:/profile/{id}

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

如果您希望自訂放置在路由參數中的值,可以在路由參數定義中指定列(/profile/{id:slug}),或者您可以覆蓋 Eloquent 模型上的 getRouteKey 方法:

/**
 * 獲取模型的路由鍵值。
 */
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 方法來實現,該方法建立一個 RedirectResponse,而不進行任何額外的 URL 編碼、驗證或驗證:

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

帶有閃存 Session 資料的重定向

重定向到新 URL 和將資料閃存到 Session通常是同時完成的。通常,這是在成功執行動作後將成功訊息閃存到 Session 時完成的。為了方便,您可以使用單個流暢的方法鏈建立一個 RedirectResponse 實例並將資料閃存到 Session:

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

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

使用者被重定向後,您可以從 Session 中顯示閃存的訊息。例如,使用 Blade 語法

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

帶有輸入的重定向

您可以使用 RedirectResponse 實例提供的 withInput 方法,在將使用者重定向到新位置之前,將當前請求的輸入資料閃存到 Session。如果使用者遇到驗證錯誤,通常會這樣做。一旦輸入被閃存到 Session,您就可以輕鬆地在下一個請求中檢索它以重新填充表單:

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,並使用 json_encode PHP 函數將給定陣列轉換為 JSON:

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

如果您希望建立 JSONP 回應,可以將 json 方法與 withCallback 方法結合使用:

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

檔案下載

download 方法可用於生成一個回應,強制使用者的瀏覽器下載給定路徑的檔案。此方法接受一個檔案名作為方法的第二個參數,這將決定下載檔案的使用者看到的檔案名。最後,您可以傳遞一個 HTTP 標頭陣列作為方法的第三個參數:

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

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

[!WARNING] 管理檔案下載的 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); // 模擬區塊之間的延遲...
        }
    }, 200, ['X-Accel-Buffering' => 'no']);
});

為了方便,如果您傳遞給 stream 方法的閉包返回一個生成器,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 套件來使用,該套件提供了一個便利的 API 來與 Laravel 回應和事件串流互動。要開始,請安裝 @laravel/stream-react@laravel/stream-vue@laravel/stream-svelte 套件:

npm install @laravel/stream-react
npm install @laravel/stream-vue
npm install @laravel/stream-svelte

然後,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>
<script>
import { useStream } from "@laravel/stream-svelte";

const stream = useStream("chat");

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

<div>
    <div>{$stream.data}</div>
    {#if $stream.isFetching}
        <div>Connecting...</div>
    {/if}
    {#if $stream.isStreaming}
        <div>Generating...</div>
    {/if}
    <button onclick={sendMessage}>Send Message</button>
</div>

透過 send 將資料傳回串流時,與串流的活動連接會在發送新資料之前被取消。所有請求都以 JSON POST 請求的形式發送。

[!WARNING] 由於 useStream 鉤子向您的應用程式發送 POST 請求,因此需要有效的 CSRF 令牌。提供 CSRF 令牌的最簡單方法是透過應用程式佈局的 head 中的 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>
<script>
import { useStream } from "@laravel/stream-svelte";

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

<div>{$stream.data}</div>

onResponse 在從串流收到成功的初始回應後觸發,原始的回應被傳遞給回呼。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>
<script>
import { useStream } from "@laravel/stream-svelte";

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

<div>{$stream.data}</div>

要手動取消串流,您可以使用鉤子返回的 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>
<script>
import { useStream } from "@laravel/stream-svelte";

const stream = useStream("chat");
</script>

<div>
    <div>{$stream.data}</div>
    <button onclick={() => stream.cancel()}>Cancel</button>
</div>

每次使用 useStream 鉤子時,都會生成一個隨機 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>
<!-- App.svelte -->
<script>
import { useStream } from "@laravel/stream-svelte";
import StreamStatus from "./StreamStatus.svelte";

const stream = useStream("chat");
</script>

<div>
    <div>{$stream.data}</div>
    <StreamStatus id={stream.id} />
</div>

<!-- StreamStatus.svelte -->
<script>
import { useStream } from "@laravel/stream-svelte";

let { id } = $props();

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

<div>
    {#if $stream.isFetching}
        <div>Connecting...</div>
    {/if}
    {#if $stream.isStreaming}
        <div>Generating...</div>
    {/if}
</div>

串流 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>
<script>
import { useJsonStream } from "@laravel/stream-svelte";

const stream = useJsonStream("users");

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

<div>
    <ul>
        {#if $stream.data?.users}
            {#each $stream.data.users as user (user.id)}
                <li>{user.id}: {user.name}</li>
            {/each}
        {/if}
    </ul>
    <button onclick={loadUsers}>Load Users</button>
</div>

事件串流 (SSE)

eventStream 方法可用於使用 text/event-stream 內容類型返回伺服器發送事件 (SSE) 串流回應。eventStream 方法接受一個閉包,該閉包應在回應可用時產生回應到串流:

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

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

如果您希望自訂發送到事件串流的事件名稱,可以產生 StreamedEvent 類別的一個實例:

use Illuminate\Http\StreamedEvent;

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

使用事件串流

事件串流可以使用 Laravel 的 stream npm 套件來使用,該套件提供了一個便利的 API 來與 Laravel 事件串流互動。要開始,請安裝 @laravel/stream-react@laravel/stream-vue@laravel/stream-svelte 套件:

npm install @laravel/stream-react
npm install @laravel/stream-vue
npm install @laravel/stream-svelte

然後,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>
<script>
import { useEventStream } from "@laravel/stream-svelte";

const eventStream = useEventStream("/chat");
</script>

<div>{$eventStream.message}</div>

傳遞給 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>
<script>
import { useEventStream } from "@laravel/stream-svelte";

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

事件串流也可以透過應用程式前端的 EventSource 物件手動使用。當串流完成時,eventStream 方法將自動向事件串流發送 </stream> 更新:

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

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

        return;
    }

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

要自訂發送到事件串流的最後一個事件,您可以向 eventStream 方法的 endStreamWith 參數提供一個 StreamedEvent 實例:

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 外觀上的 macro 方法。通常,您應該從應用程式的其中一個服務提供者boot 方法中呼叫此方法,例如 App\Providers\AppServiceProvider 服務提供者:

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * 啟動任何應用程式服務。
     */
    public function boot(): void
    {
        Response::macro('caps', function (string $value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro 函數接受一個名稱作為其第一個參數,一個閉包作為其第二個參數。當從 ResponseFactory 實現或 response 輔助函數呼叫巨集名稱時,將執行巨集的閉包:

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