HTTP Responses

기본적인 Responses
다른 Response 타입들
리다이렉트
Response 매크로

기본적인 Responses

기본적으로 모든 라우터와 컨트롤러는 어떤 종류의 HTTP 응답을 사용자의 브라우저로 반환해야 합니다. 라라벨은 response 를 반환하는 다양한 방법을 제공합니다. 가장 기본적인 response는 라우트나 컨트롤러에서 문자열을 반환하는 것입니다.

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

주어진 문자열은 프레임워크에 의해서 자동으로 HTTP response 로 변환되어질 것입니다.

Response 객체

대부분의 라우트나 컨트롤러 액션에서는 Illuminate\Http\Response의 인스턴스나 뷰를 반환합니다. Response 인스턴스를 반환하는 것은 여러분이 response 의 HTTP 상태 코드나 헤더를 변경할 수 있도록 지원합니다. Response 는 Symfony\Component\HttpFoundation\Response 클래스를 상속받고 있으며 HTTP response 를 만들기 위한 다양한 메소드를 제공합니다.

use Illuminate\Http\Response;

Route::get('home', function () {
    return (new Response($content, $status))
                  ->header('Content-Type', $value);
});

좀 더 쉬운 방법으로 response 헬퍼 함수를 사용할 수 있습니다.

Route::get('home', function () {
    return response($content, $status)
                  ->header('Content-Type', $value);
});

참고: Response 객체의 사용가능한 전체 메소드 목록은 API 문서와 Symfony API 문서 를 참고하십시오.

대부분의 response 메소드는 유연한 구성을 위해서 체이닝이 가능합니다. 예를 들어서 사용자에게 response를 되돌려 주기 전에 header 메소드를 통해서 header를 추가할 수 있습니다.

return response($content)
            ->header('Content-Type', $type)
            ->header('X-Header-One', 'Header Value')
            ->header('X-Header-Two', 'Header Value');

또는, response 에 추가하고자 하는 헤더의 배열을 지정하기 위해서 withHeaders 메소드를 사용할 수 있습니다.

return response($content)
            ->withHeaders([
                'Content-Type' => $type,
                'X-Header-One' => 'Header Value',
                'X-Header-Two' => 'Header Value',
            ]);

Responses에 Cookies 추가하기

response 인스턴스의 cookie 헬퍼 메소드는 response 에 쿠키를 손쉽게 추가할 수 있게 해줍니다. 다음처럼 response 인스턴스에서 cookie 메소드를 사용하여 쿠키를 추가할 수 있습니다.

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

cookie 메소드는 다음처럼 선택적으로 추가 인자를 받아 들일 수 있으며, 쿠키의 속성을 사용자 정의할 수 있도록 합니다.

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

또는 Cookie facade 의 queue 메소드를 사용하여 response에 자동으로 추가되는 쿠키를 만들 수 있습니다.

<?php

namespace App\Http\Controllers;

use Cookie;
use App\Http\Controllers\Controller;

class DashboardController extends Controller
{
    /**
     * Show the application dashboard.
     *
     * @return Response
     */
    public function index()
    {
        Cookie::queue('saw_dashboard', true, 15);

        return view('dashboard');
    }
}

이 예제에서는 별도의 지정된 response 인스턴스에 수동으로 추가하지 않더라도 swa_dashboard 쿠키가 자동으로 response 에 추가되어 질 것입니다.

쿠키 & 암호화

기본적으로, 라라벨에서 생성되는 모든 쿠키는 암호화 되고, 서명이 적용되어 클리이언트에서는 수정하거나 확인할 수 없습니다. 만약 애플리케이션에서 생성하는 특정 쿠키를 암호화 처리 하지 않도록 하고자 한다면, App\Http\Middleware\EncryptCookies 미들웨어의 $except 속성을 사용하면 됩니다.

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

다른 Response 타입들

response 헬퍼 함수는 편리하게 다른 유형의 response 인스턴스를 생성하는 데 사용되어집니다. 전달되는 인자 없이 response 헬퍼가 호출될 때에는 Illuminate\Contracts\Routing\ResponseFactory contract 구현체가 반환될 것입니다. contract 는 response 를 생성하는 데 유용하고 다양한 메소드를 제공합니다.

View Responses

response 의 status 와 header 뿐만 아니라, response 내용으로 view를 반환하고자 한다면, view 메소드를 사용하면 됩니다.

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

사용자가 직접 HTTP 상태 코드나, 특정 헤더 값을 전달할 필요는 없습니다. 간단하게 view 헬퍼 함수를 사용하면 됩니다.

JSON Responses

json 메소드는 자동으로 Content-Type 헤더를 application/json 으로 설정하고, 주어진 배열을 PHP json_encode 함수를 사용하여 JSON으로 변환할 것입니다.

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

JSONP response 를 생성하고자 한다면, json 메소드에 추가적으로 setCallback 사용하면 됩니다.

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

파일 다운로드

download 메소드는 사용자의 브라우저가 주어진 경로에 해당하는 파일을 다운로드 하게 하는 response를 생성하는데 사용됩니다. download 메소드는 사용자가 다운로드 하는 파일의 이름을 두번째 인자로 받습니다. 마지막으로 HTTP 헤더의 배열을 세번째 인자로 전달할 수 있습니다.

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

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

주의: 파일 다운로드를 관리하는 Symfony HttpFoundation 클래스는 ASCII 형식의 파일 이름을 지정해야 합니다.

파일 Responses

file 메소드는 파일을 다운로드 하는 대신에, 브라우저에 이미지나 PDF 와 같은 파일을 표시하는데 사용되어 집니다. 이 메소드는 첫번째 인자로 파일의 경로를, 두번째 인자롣 헤더의 배열을 전달 받습니다:

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

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

리다이렉트

리다이렉트 Response 는 Illuminate\Http\RedirectResponse 클래스의 인스턴스이며, 사용자를 다른 URL로 리다이렉트하는데 필요한 적절한 헤더를 포함하고 있습니다. RedirectResponse 인스턴스를 생성하려면 여러가지 방법이 있습니다. 가장 쉬운 방법은 글로벌 redirect 헬퍼 메소드를 사용하는 것입니다.

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

예를 들어서, form 의 submit 을 처리하는데 검증이 일치하지 않아 사용자를 이전 위치로 리다이렉트 시키고자 할 수 있습니다. 이 경우에는 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]);

라우트에 “ID” 파라미터를 따라 Eloquent 모델을 획득하는 라우트로 리디렉션하는 경우, 모델 그 자신을 그대로 전달할 수도 있습니다. ID는 자동으로 추출되어 질것입니다.

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

컨트롤러 액션으로 리다이렉트 하기

또한 [컨트롤러 액션]으로 리다이렉트하는 응답을 생성할 수도 있습니다. 이렇게 하기 위해서는, 간단하게 컨트로러와 액션의 이름을 action 메소드에 전달하면 됩니다. 주의할 것은 라라벨이 자동으로 기본 컨트롤러 네임스페이스를 설정하기 때문에 전체 네임스페이스를 지정할 필요가 없다는 것입니다.

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

컨트롤러 라우트에 파라미터가 필요한 경우, action 메소드의 두번째 인자로 전달하면 됩니다:

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

세션의 임시 데이터와 함께 리다이렉트 하기

새로운 URL로 리다이렉트 이동하고 플래시 데이터를 세션에 저장 하는 것은 일반적으로 동시에 진행됩니다. 따라서 편의성을 높이기 위해 RedirectResponse 인스턴스를 생성하고 동시에 메소드 체인을 통해 플래시 데이터를 세션에 저장할 수 있습니다. 주로 어떤 동작을 수행하고 상태 메세지를 저장할 때 편리합니다.

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

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

새로운 페이지로 리다이렉트 되고 난 뒤에, 임시 저장된 메세지를 세션 에서 찾아 표시할 수 있습니다. 다음은 블레이드 문법을 사용한 방법입니다.

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

Response 매크로

다양한 라우트와 컨트롤러에서 재사용할 수 있는 사용자 정의 Response를 정의하려면 Illuminate\Contracts\Routing\ResponseFactory 구현 클래스나 Response 파사드의 macro 메소드를 사용할 수 있습니다.

다음은 서비스 프로바이더의 boot 메소드에서 정의하는 예제입니다.

<?php

namespace App\Providers;

use Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro 메소드는 매크로로 지정할 이름을 첫 번째 인자로, 클로저를 두 번째 인자로 전달 받습니다. 매크로로 등록된 클로저는 response 헬퍼 함수를 통해서 ResponseFactory 구현 객체에서 호출될것 입니다.

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

HTTP Responses

Basic Responses
Other Response Types
Redirects
Response Macros

Basic Responses

Of course, all routes and controllers should return some kind of response to be sent back to the user's browser. Laravel provides several different ways to return responses. The most basic response is simply returning a string from a route or controller:

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

The given string will automatically be converted into an HTTP response by the framework.

Response Objects

However, for most routes and controller actions, you will be returning a full Illuminate\Http\Response instance or a view. Returning a full Response instance allows you to customize the response's HTTP status code and headers. A Response instance inherits from the Symfony\Component\HttpFoundation\Response class, providing a variety of methods for building HTTP responses:

use Illuminate\Http\Response;

Route::get('home', function () {
    return (new Response($content, $status))
                  ->header('Content-Type', $value);
});

For convenience, you may also use the response helper:

Route::get('home', function () {
    return response($content, $status)
                  ->header('Content-Type', $value);
});

Note: For a full list of available Response methods, check out its API documentation and the Symfony API documentation.

Attaching Headers To Responses

Keep in mind that most response methods are chainable, allowing for the fluent building of responses. For example, you may use the header method to add a series of headers to the response before sending it back to the user:

return response($content)
            ->header('Content-Type', $type)
            ->header('X-Header-One', 'Header Value')
            ->header('X-Header-Two', 'Header Value');

Or, you may use the withHeaders method to specify an array of headers to be added to the response:

return response($content)
            ->withHeaders([
                'Content-Type' => $type,
                'X-Header-One' => 'Header Value',
                'X-Header-Two' => 'Header Value',
            ]);

Attaching Cookies To Responses

The cookie helper method on the response instance allows you to easily attach cookies to the response. For example, you may use the cookie method to generate a cookie and attach it to the response instance:

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

The cookie method accepts additional optional arguments which allow you to further customize your cookie's properties:

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

Alternatively, you may use the queue method on the Cookie facade to create a cookie that will be automatically added to the outgoing response:

<?php

namespace App\Http\Controllers;

use Cookie;
use App\Http\Controllers\Controller;

class DashboardController extends Controller
{
    /**
     * Show the application dashboard.
     *
     * @return Response
     */
    public function index()
    {
        Cookie::queue('saw_dashboard', true, 15);

        return view('dashboard');
    }
}

In this example, the saw_dashboard cookie will automatically be added to the outgoing response without forcing you to manually attach the cookie to a specific response instance.

Cookies & Encryption

By default, all cookies generated by Laravel are encrypted and signed so that they can't be modified or read by the client. If you would like to disable encryption for a certain subset of cookies generated by your application, you may use the $except property of the App\Http\Middleware\EncryptCookies middleware:

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

Other Response Types

The response helper may be used to conveniently generate other types of response instances. When the response helper is called without arguments, an implementation of the Illuminate\Contracts\Routing\ResponseFactory contract is returned. This contract provides several helpful methods for generating responses.

View Responses

If you need control over the response status and headers, but also need to return a view as the response content, you may use the view method:

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

Of course, if you do not need to pass a custom HTTP status code or custom headers, you should simply use the global view helper function.

JSON Responses

The json method will automatically set the Content-Type header to application/json, as well as convert the given array into JSON using the json_encode PHP function:

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

If you would like to create a JSONP response, you may use the json method in addition to setCallback:

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

File Downloads

The download method may be used to generate a response that forces the user's browser to download the file at the given path. The download method accepts a file name as the second argument to the method, which will determine the file name that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method:

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

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

Note: Symfony HttpFoundation, which manages file downloads, requires the file being downloaded to have an ASCII file name.

File Responses

The file method can be used to display a file, such as an image or PDF, directly in the user's browser instead of initiating a download. This method accepts the path to the file as its first argument and an array of headers as its second argument:

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

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

Redirects

Redirect responses are instances of the Illuminate\Http\RedirectResponse class, and contain the proper headers needed to redirect the user to another URL. There are several ways to generate a RedirectResponse instance. The simplest method is to use the global redirect helper method:

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

Sometimes you may wish to redirect the user to their previous location, for example, after a form submission that is invalid. You may do so by using the global back helper function. However, make sure the route using the back function is using the web middleware group or has all of the session middleware applied:

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

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

Redirecting To Named Routes

When you call the redirect helper with no parameters, an instance of Illuminate\Routing\Redirector is returned, allowing you to call any method on the Redirector instance. For example, to generate a RedirectResponse to a named route, you may use the route method:

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

If your route has parameters, you may pass them as the second argument to the route method:

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

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

If you are redirecting to a route with an "ID" parameter that is being populated from an Eloquent model, you may simply pass the model itself. The ID will be extracted automatically:

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

Redirecting To Controller Actions

You may also generate redirects to controller actions. To do so, simply pass the controller and action name to the action method. Remember, you do not need to specify the full namespace to the controller since Laravel's RouteServiceProvider will automatically set the default controller namespace:

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

Of course, if your controller route requires parameters, you may pass them as the second argument to the action method:

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

Redirecting With Flashed Session Data

Redirecting to a new URL and flashing data to the session are typically done at the same time. So, for convenience, you may create a RedirectResponse instance and flash data to the session in a single method chain. This is particularly convenient for storing status messages after an action:

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

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

Of course, after the user is redirected to a new page, you may retrieve and display the flashed message from the session. For example, using Blade syntax:

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

Response Macros

If you would like to define a custom response that you can re-use in a variety of your routes and controllers, you may use the macro method on the Response facade or the implementation of Illuminate\Contracts\Routing\ResponseFactory.

For example, from a service provider's boot method:

<?php

namespace App\Providers;

use Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

The macro function accepts a name as its first argument, and a Closure as its second. The macro's Closure will be executed when calling the macro name from a ResponseFactory implementation or the response helper:

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

Requests 뷰-Views

이 문서의 번역에 기여해주신 분들

기여에 참여하기

HTTP Responses

기본적인 Responses

Response 객체

Response 에 Header 추가하기

Responses에 Cookies 추가하기

쿠키 & 암호화

다른 Response 타입들

View Responses

JSON Responses

파일 다운로드

파일 Responses

리다이렉트

이름이 지정된 라우트로 리다이렉트 하기

컨트롤러 액션으로 리다이렉트 하기

세션의 임시 데이터와 함께 리다이렉트 하기

Response 매크로

HTTP Responses

Basic Responses

Response Objects

Attaching Headers To Responses

Attaching Cookies To Responses

Cookies & Encryption

Other Response Types

View Responses

JSON Responses

File Downloads

File Responses

Redirects

Redirecting To Named Routes

Redirecting To Controller Actions

Redirecting With Flashed Session Data

Response Macros

이 문서의 번역에 기여해주신 분들