HTTP Responses

Creating Responses

Strings and Arrays

모든 라우트와 컨트롤러는 사용자 브라우저로 전송할 응답을 반환해야 합니다. Laravel에서는 다양한 방식으로 응답을 반환할 수 있습니다. 가장 기본적인 방법은 라우트나 컨트롤러에서 문자열을 반환하는 것입니다. 프레임워크가 이 문자열을 자동으로 완전한 HTTP 응답으로 변환해줍니다.

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

라우트와 컨트롤러에서 문자열뿐만 아니라 배열도 반환할 수 있습니다. 배열을 반환하면 프레임워크가 자동으로 해당 배열을 JSON 응답으로 변환합니다.

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

라우트나 컨트롤러에서 Eloquent collections도 반환할 수 있다는 사실을 알고 계셨나요? 이 컬렉션 역시 자동으로 JSON으로 변환됩니다. 한 번 사용해보세요!

Response Objects

일반적으로 라우트 액션에서는 단순 문자열이나 배열만 반환하는 것은 드물고, 보통 전체 Illuminate\Http\Response 인스턴스 또는 views를 반환하게 됩니다.

전체 Response 인스턴스를 반환하면, 응답의 HTTP 상태 코드와 헤더를 자유롭게 커스터마이즈(설정)할 수 있습니다. Response 인스턴스는 Symfony\Component\HttpFoundation\Response 클래스를 상속하여, 다양한 HTTP 응답 구성을 위한 메서드를 제공합니다.

Route::get('/home', function () {
    return response('Hello World', 200)
                  ->header('Content-Type', 'text/plain');
});

Eloquent Models and Collections

Eloquent ORM의 모델이나 컬렉션을 라우트나 컨트롤러에서 직접 반환할 수도 있습니다. 이 경우에도 Laravel이 자동으로 해당 모델 또는 컬렉션을 JSON 응답으로 변환해주며, 모델의 hidden attributes은 자동으로 제외됩니다.

use App\Models\User;

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

Attaching Headers to Responses

대부분의 응답 관련 메서드는 메서드 체이닝이 가능하므로(즉, 연결해서 연달아 호출할 수 있으므로) 응답 객체를 유연하게 구성할 수 있습니다. 예를 들어, 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',
            ]);

Cache Control Middleware

Laravel에는 cache.headers 미들웨어가 내장되어 있어, 여러 라우트 그룹에 대해 Cache-Control 헤더를 빠르게 설정할 수 있습니다. 디렉티브(directive)는 해당 캐시-컨트롤 지시어와 동일한 역할을 하는 "스네이크 케이스"로 작성해야 하며, 각 지시어는 세미콜론으로 구분합니다. 만약 지시어 목록에 etag를 포함하면, 응답 콘텐츠의 MD5 해시가 자동으로 ETag 식별자로 지정됩니다.

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

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

Attaching Cookies to Responses

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 파사드를 이용해서 나중에 전송될 응답에 미리 쿠키를 "큐(Queue)"에 등록해둘 수 있습니다. queue 메서드는 쿠키 인스턴스를 만들 때 필요한 인자들을 받습니다. 이렇게 큐에 올린 쿠키는 실제 응답이 전송될 때 자동으로 첨부됩니다.

use Illuminate\Support\Facades\Cookie;

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

Generating Cookie Instances

나중에 응답에 첨부할 목적으로만 Symfony\Component\HttpFoundation\Cookie 인스턴스를 만들고 싶다면, 글로벌 cookie 헬퍼를 사용할 수 있습니다. 이렇게 만든 쿠키 인스턴스는 직접 응답에 첨부하지 않는 이상, 클라이언트에게 전송되지 않습니다.

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

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

Expiring Cookies Early

응답에서 withoutCookie 메서드를 사용하여 특정 쿠키를 만료(삭제)시킬 수 있습니다.

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

아직 응답 인스턴스가 없다면, Cookie 파사드의 expire 메서드를 이용해 쿠키를 만료시킬 수도 있습니다.

Cookie::expire('name');

Cookies and Encryption

기본적으로 Laravel에서 생성되는 모든 쿠키는 암호화되고 서명 처리되어, 클라이언트 측에서 내용을 변경하거나 읽을 수 없습니다. 만약 애플리케이션에서 생성되는 일부 쿠키의 암호화를 비활성화하고 싶다면, app/Http/Middleware 디렉터리에 위치한 App\Http\Middleware\EncryptCookies 미들웨어의 $except 프로퍼티를 사용하면 됩니다.

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

Redirects

리다이렉트 응답은 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();
});

Redirecting to Named Routes

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]);

Populating Parameters via Eloquent Models

ID 파라미터가 필요한 라우트로 리다이렉트할 때, Eloquent 모델 자체를 전달할 수도 있습니다. Laravel이 해당 모델 인스턴스에서 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;
}

Redirecting to Controller Actions

controller actions으로 리다이렉트도 할 수 있습니다. 이럴 땐 해당 컨트롤러와 액션명을 action 메서드에 전달하세요.

use App\Http\Controllers\UserController;

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

컨트롤러 라우트가 파라미터를 요구할 경우, action 메서드의 두 번째 인자로 파라미터 배열을 전달하면 됩니다.

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

Redirecting to External Domains

간혹 애플리케이션 외부의 다른 도메인으로 리다이렉트할 필요가 있을 수 있습니다. 이럴 때는 URL 인코딩이나 검증·확인 없이 RedirectResponse를 생성하는 away 메서드를 사용할 수 있습니다.

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

Redirecting With Flashed Session Data

새 URL로 리다이렉트하면서 flashing data to the session하는 경우가 많습니다. 보통 어떤 동작을 성공적으로 수행한 뒤, 성공 메시지를 세션에 플래시 방식으로 전달할 때 사용합니다. 편의를 위해, RedirectResponse 인스턴스를 생성하고 체이닝으로 세션 데이터를 플래시할 수 있습니다.

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

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

사용자가 리다이렉트된 후에는, session에서 플래시 메시지를 꺼내서 화면에 출력할 수 있습니다. 예를 들어 Blade syntax으로 다음과 같이 작성할 수 있습니다.

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

Redirecting With Input

사용자를 새로운 위치로 리다이렉트하기 전에 현재 요청의 입력값을 세션에 플래시하고 싶다면, RedirectResponse 인스턴스의 withInput 메서드를 사용할 수 있습니다. 이 방식은 보통 유효성 검증에서 에러가 발생했을 때 입력값을 다시 채워줄 때 사용합니다. 입력값이 세션에 플래시된 뒤에는, 다음 요청에서 쉽게 가져와(retrieve it) 폼을 다시 채워줄 수 있습니다.

return back()->withInput();

Other Response Types

response 헬퍼를 사용하면 다양한 타입의 응답 인스턴스를 생성할 수 있습니다. 인자가 없이 response 헬퍼를 호출하면 Illuminate\Contracts\Routing\ResponseFactory contract 구현체가 반환됩니다. 이 계약에는 다양한 응답 생성을 위한 여러 유용한 메서드가 포함되어 있습니다.

View Responses

응답의 상태 코드와 헤더를 설정하면서 view를 응답 내용으로 반환하고 싶다면 view 메서드를 사용할 수 있습니다.

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

상태 코드나 커스텀 헤더를 지정할 필요 없다면, 전역 view 헬퍼 함수를 바로 사용해도 무방합니다.

JSON Responses

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'));

File Downloads

download 메서드를 사용하면 지정한 경로의 파일을 사용자의 브라우저에서 강제로 다운로드하게 만들 수 있습니다. download 메서드는 두 번째 인자로 파일명을 지정할 수 있는데, 이 값이 실사용자에게 다운로드 파일명으로 표시됩니다. 마지막 세 번째 인자로는 HTTP 헤더 배열을 전달할 수 있습니다.

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

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

파일 다운로드를 관리하는 Symfony HttpFoundation은, 다운로드되는 파일명이 반드시 ASCII 문자로만 이루어져 있어야 함을 요구합니다.

Streamed Downloads

작업 결과를 파일로 저장하지 않고 바로 문자열 형태로 다운로드 응답으로 만들고 싶을 때는, streamDownload 메서드를 사용할 수 있습니다. 이 메서드는 콜백, 파일명, 그리고 선택적으로 헤더 배열을 인자로 받습니다.

use App\Services\GitHub;

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

File Responses

file 메서드를 사용하면, 사용자 브라우저에서 이미지나 PDF 등의 파일을 바로 표시할 수 있습니다. 다운로드가 아니라 브라우저에서 직접 보여주고 싶은 경우 사용할 수 있습니다. 첫 번째 인자는 파일의 절대 경로이고, 두 번째 인자는 헤더 배열입니다.

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

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

Response Macros

여러 라우트 및 컨트롤러에서 재사용할 커스텀 응답을 정의하고 싶다면, Response 파사드의 macro 메서드를 사용할 수 있습니다. 일반적으로 응용 프로그램의 service providers 중 하나(예: App\Providers\AppServiceProvider)의 boot 메서드에서 등록하는 것이 좋습니다.

<?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');