Giới thiệu

Thay vì định nghĩa tất cả các logic xử lý cho request trong file route với Closures, thì bạn có thể muốn tổ chức các hành vi này bằng cách sử dụng class Controller. Các controller có thể nhóm các logic xử lý request có liên quan đến nhau thành một class duy nhất. Các controller sẽ được lưu trữ trong thư mục app/Http/Controllers.

Controller cơ bản

Định nghĩa Controller

Dưới đây là một ví dụ về một class controller cơ bản. Lưu ý rằng controller được extend từ một class controller cơ sở đã được đi kèm với Laravel. Class cơ sở cung cấp một vài phương thức tiện lợi, như phương thức middleware, có thể được sử dụng để gắn middleware vào các controller action:

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

Bạn có định nghĩa một route tới một controller này như sau:

Route::get('user/{id}', 'UserController@show');

Bây giờ, khi một request khớp với URI route mà đã được đinh nghĩa, phương thức show trong class UserController sẽ được thực thi. Dĩ nhiên, các tham số route cũng sẽ được truyền đến phương thức này.

{tip} Các controller không yêu cầu bạn phải extend từ một class cơ sở. Nhưng, bạn sẽ không thể truy cập vào một số phương thức tiện lợi như các phương thức middleware, validate và dispatch.

Controllers và Namespaces

Đây là một điều rất quan trọng cần chúng ta lưu ý là: không cần khai báo toàn bộ namespace đến controller khi định nghĩa controller cho route. Vì RouteServiceProvider sẽ tải các file route của bạn vào trong một group route có chứa namespace, nên chúng ta chỉ khai báo phần tên class xuất hiện sau phần App\Http\Controllers của namespace.

Nếu bạn có một controller ở trong thư mục con của thư mục App\Http\Controllers, hãy khai báo tên class bắt đầu từ sau namespace App\Http\Controllers. Vì thế, nếu path đầy đủ của controller của bạn là App\Http\Controllers\Photos\AdminController, thì bạn nên đăng ký route đến controller đó như sau:

Route::get('foo', 'Photos\AdminController@method');

Single Action Controllers

Nếu bạn muốn định nghĩa một controller chỉ xử lý cho một hành động, bạn có thể đặt một single phương thức __invoke trên controller:

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class ShowProfile extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function __invoke($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

Khi đăng ký route cho một single action controller, bạn sẽ không cần khai báo tên phương thức nữa:

Route::get('user/{id}', 'ShowProfile');

Bạn có thể tạo một controller chỉ có một action duy nhất bằng cách sử dụng tùy chọn --invokable trong lệnh Artisan make:controller:

php artisan make:controller ShowProfile --invokable

Controller Middleware

Middleware có thể được gán vào route của controller trong file route của bạn:

Route::get('profile', 'UserController@show')->middleware('auth');

Tuy nhiên, sẽ thuận tiện hơn khi khai báo middleware đó trong hàm khởi tạo của controller của bạn. Sử dụng phương thức middleware từ hàm khởi tạo của controller, bạn có thể dễ dàng gán middleware vào các action của controller. Bạn thậm chí có thể giới hạn middleware chỉ chạy cho một số phương thức nhất định có trong class controller:

class UserController extends Controller
{
    /**
     * Instantiate a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');

        $this->middleware('log')->only('index');

        $this->middleware('subscribed')->except('store');
    }
}

Controller cũng cho phép bạn đăng ký các middleware bằng cách sử dụng một Closure. Điều này cung cấp một cách thuận tiện để định nghĩa middleware cho một single Controller mà không cần phải định nghĩa thêm một class middleware:

$this->middleware(function ($request, $next) {
    // ...

    return $next($request);
});

{tip} Bạn có thể gán middleware cho một số action có trong controller; tuy nhiên, nó có thể làm cho controller của bạn bị phát triển quá lớn. Thay vào đó, hãy xem xét việc chia controller của bạn ra thành nhiều controller nhỏ hơn.

Resource Controllers

Laravel resource routing sẽ gán một loạt route theo kiểu "CRUD" vào một controller với chỉ một dòng code. Ví dụ: bạn muốn tạo một controller xử lý tất cả các request HTTP cho các "photos" được lưu trữ trong ứng dụng của bạn. Sử dụng lệnh Artisan make:controller, chúng ta có thể nhanh chóng tạo ra một controller như vậy:

php artisan make:controller PhotoController --resource

Lệnh này sẽ tạo ra một controller tại app/Http/Controllers/PhotoController.php. Controller này sẽ chứa một phương thức cho mỗi hành động resource có sẵn.

Tiếp theo, bạn có thể đăng ký một resourceful route tới controller:

Route::resource('photos', 'PhotoController');

Khai báo một single route như ở trên sẽ tạo ra một loạt route để xử lý một loạt các hành động khác nhau trên resource. Controller đã được tạo sẽ có sẵn luôn các phương thức cho từng hành động này, bao gồm các note thông báo cho bạn về các method HTTP và URI mà chúng xử lý.

Bạn có thể đăng ký nhiều resource controller cùng một lúc bằng cách truyền vào một mảng cho phương thức resources:

Route::resources([
    'photos' => 'PhotoController',
    'posts' => 'PostController'
]);

Các hành động được xử lý bởi Resource Controller

Khai báo Resource Model

Nếu bạn đang sử dụng liên kết model route và muốn các phương thức của resource controller khai báo sẵn một tham số đầu vào là một model instance, bạn có thể sử dụng tùy chọn --model khi tạo controller:

php artisan make:controller PhotoController --resource --model=Photo

Form Method giả

Vì HTML form không thể tạo các request mà có method là PUT, PATCH, hoặc DELETE, nên bạn cần phải thêm một hidden field _method để giả method HTTP. Lệnh @method của Blade có thể tạo field này cho bạn:

<form action="/foo/bar" method="POST">
    @method('PUT')
</form>

Partial Resource Routes

Khi khai báo một resource route, bạn có thể chỉ định một tập hợp các hành động mà được controller xử lý thay vì toàn bộ các hành động mặc định:

Route::resource('photos', 'PhotoController')->only([
    'index', 'show'
]);

Route::resource('photos', 'PhotoController')->except([
    'create', 'store', 'update', 'destroy'
]);

API Resource Routes

Khi khai báo một resource route mà sẽ được sử dụng bởi các API, bạn sẽ muốn loại bỏ các route mà phải nhập form HTML như create vàedit. Để thuận tiện, bạn có thể sử dụng phương thức apiResource để tự động loại bỏ hai route trên:

Route::apiResource('photos', 'PhotoController');

Bạn có thể đăng ký nhiều resource controller cho API cùng một lúc bằng cách truyền một mảng vào phương thức apiResources:

Route::apiResources([
    'photos' => 'PhotoController',
    'posts' => 'PostController'
]);

Để tạo nhanh một API resource controller mà không chứa các phương thức create hoặc edit, hãy sử dụng switch --api khi chạy lệnh make:controller:

php artisan make:controller API/PhotoController --api

Naming Resource Routes

Mặc định, tất cả các hành động của resource controller đều có đi kèm với một tên route; tuy nhiên, bạn có thể ghi đè các tên này bằng cách truyền vào một mảng names cùng với các tên mà bạn muốn ghi đè:

Route::resource('photos', 'PhotoController')->names([
    'create' => 'photos.build'
]);

Naming Resource Route Parameters

Mặc định, Route::resource sẽ tạo các tham số route cho các resource route dựa trên tên "số ít" của các resource. Bạn có thể dễ dàng ghi đè điều này trên từng resource bằng cách sử dụng phương thức parameters. Mảng được truyền cho phương thức parameters này phải là một mảng kết hợp giữa tên resource và tên tham số:

Route::resource('users', 'AdminUserController')->parameters([
    'users' => 'admin_user'
]);

Ví dụ ở trên sẽ tạo ra một URI như ở dưới cho một route show của resource:

/users/{admin_user}

Localizing Resource URIs

Mặc định, Route::resource sẽ tạo các URI resource bằng các động từ tiếng Anh. Nếu bạn cần bản địa hóa các động từ này như create và edit, bạn có thể sử dụng phương thức Route::resourceVerbs. Điều này có thể được thực hiện trong phương thức boot của AppServiceProvider:

use Illuminate\Support\Facades\Route;

/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

Khi các động từ đã được tùy biến xong, nếu bạn đăng ký resource route là Route::resource('fotos', 'PhotoController') thì sẽ tạo ra các URI như sau:

/fotos/crear

/fotos/{foto}/editar

Supplementing Resource Controllers

Nếu bạn cần thêm các route vào các resource controller ngoài các route mặc định, bạn nên định nghĩa các route đó trước khi gọi tới Route::resource; mặt khác, các route được định nghĩa bởi phương thức resource có thể vô tình được ưu tiên hơn các route vừa được thêm của bạn:

Route::get('photos/popular', 'PhotoController@method');

Route::resource('photos', 'PhotoController');

{tip} Hãy nhớ giữ cho controller của bạn được tập trung. Nếu bạn cảm thấy bạn thường xuyên cần phải thêm các phương thức bên ngoài bộ resource action mặc định, hãy xem xét việc chia controller của bạn thành hai controller nhỏ hơn.

Dependency Injection và Controllers

Constructor Injection

Laravel service container sẽ được sử dụng để resolve tất cả các controller của Laravel. Kết quả là, bạn có thể khai báo cho bất kỳ phụ thuộc nào mà controller của bạn cần trong hàm khởi tạo của nó. Các phụ thuộc được khai báo sẽ tự động được resolve và được đưa vào trong controller instance:

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * The user repository instance.
     */
    protected $users;

    /**
     * Create a new controller instance.
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }
}

Và dĩ nhiên, bạn cũng có thể khai báo bất kỳ Laravel contract nào bạn muốn. Nếu container có thể resolve nó, bạn có thể khai báo nó. Tùy thuộc vào ứng dụng của bạn, việc đưa các phụ thuộc của bạn vào controller có thể cung cấp khả năng kiểm tra tốt hơn.

Method Injection

Ngoài việc khai báo vào hàm khởi tạo class, bạn cũng có thể khai báo sự phụ thuộc vào trực tiếp các phương thức của controller. Một trường hợp được sử dụng phổ biến cho việc khai báo theo kiểu này là việc khai báo instance Illuminate\Http\Request cho các phương thức controller của bạn:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Store a new user.
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        $name = $request->name;

        //
    }
}

Nếu phương thức controller của bạn cũng đang sử dụng các tham số route, bạn có thể liệt kê các tham số đó sau các phụ thuộc của bạn. Ví dụ: nếu route của bạn đang được định nghĩa như sau:

Route::put('user/{id}', 'UserController@update');

Thì bạn vẫn có thể khai báo Illuminate\Http\Request và truy cập tham số id của bạn bằng cách định nghĩa phương thức controller của bạn như thế này:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Update the given user.
     *
     * @param  Request  $request
     * @param  string  $id
     * @return Response
     */
    public function update(Request $request, $id)
    {
        //
    }
}

Route Caching

{note} Các route mà được dựa trên Closure thì sẽ không thể cache. Để sử dụng route caching, bạn phải chuyển đổi hết các Closure route thành các class controller.

Nếu ứng dụng của bạn chỉ sử dụng các route mà được dựa trên controller, bạn nên tận dụng cache route của Laravel. Sử dụng cache route sẽ giảm đáng kể thời gian cần thiết để đăng ký tất cả các route cho ứng dụng của bạn. Trong một số trường hợp, việc đăng ký route thậm chí có thể nhanh hơn tới 100 lần. Để tạo cache route, bạn chỉ cần thực hiện lệnh Artisan route:cache:

php artisan route:cache

Sau khi chạy lệnh trên, file route sẽ được lưu trong bộ nhớ cache của bạn và sẽ được load theo mỗi khi request được gửi lên. Hãy nhớ rằng, nếu bạn thêm bất kỳ route mới nào, bạn cũng sẽ cần phải tạo mới lại bộ cache route. Vì thế, bạn chỉ nên chạy lệnh route:cache trong quá trình deploy dự án của bạn.

Bạn có thể dùng lệnh route:clear để xoá route cache:

php artisan route:clear