Quảng cáo

Request trong Laravel

Tiếp tục với series học Laravel 8. Trong hướng dẫn này chúng ta sẽ cùng nhau đi tìm hiểu về Request trong Laravel

Trong bài này chúng ta sẽ cùng đi tìm hiểu về Request trong Laravel.

Request Trong Laravel là gì?

Request trong Laravel là một object chưa các thông tin liên quan đến HTTP request hiện tại. Dựa vào object này chúng ta có thể lấy được các thông tin như input, cookie, file,...

Class Request này nằm trong Illuminate\Http\Request core của Laravel. Object này được base trên http-foundation package của Symfony Laravel chỉ custom lại một chút và thêm một số phương thức.

Tương tác với Request trong Laravel.

Mặc định Request object đã được binding vào service container của Laravel rồi, nên chúng ta muốn dùng nó thì có thể binding trực tiếp vào trong argument khi cần.

VD: Inject trong Route.

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    // code
});

VD: Inject trong Controller

Ví dụ

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

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

        //
    }
}

Lúc này ở route bạn sẽ không cần phải khai báo param $request nữa.

Ví dụ

use App\Http\Controllers\UserController;

Route::post('/user', [UserController::class, 'store']);

Truy vấn thông tin URL/PATH

Để lấy path của request các bạn sử dụng method path.

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return "Path: " . $request->path();
});

Kết quả:

Path: /

Trong trường hợp bạn muốn lấy ra URL của request các bạn có thể sử dụng phương thức url.

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return "Path: " . $request->url();
});

Kết quả:

Path: https://demolaravel.vn

Trong trường hợp các bạn muốn lấy ra full URL của request các bạn có thể sử dụng phương thức fullUrl.

VD: truy cập đường dẫn https://localhost/?q=abc

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return "Path: " . $request->fullUrl();
});

Kết quả:

Path: https://localhost/?q=abc

Trong trường hợp bạn muốn add thêm query vào trong path các bạn có thể sử dụng phương thức fullUrlWithQuery.

VD: truy cập đường dẫn https://localhost/?q=abc

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return "Path: " . $request->fullUrlWithQuery(['name' => 'VZN.vn']);
});

Kết quả:

Path: https://localhost/?q=abc&name=VZN.vn

Để kiểm tra path hiện tại có match với một path rule nào đó hay không các bạn có thể sử dụng phương thức is.

VD: Kiểm tra xem path hiện tại có phải bắt đầu bằng admin hay không?

Ví dụ

if ($request->is('admin/*')) {
    //
}

Bạn cũng có thể sử dụng phương thức routeIs để kiểm tra tương tự như phương thức is, nhưng là check qua route name.

VD: Kiểm tra xem path hiện tại có phải nằm trong route name bắt đầu bằng admin không?

Ví dụ

if ($request->routeIs('admin.*')) {
    //
}

Truy vấn method của request

Để lấy ra method của request các bạn có thể sử dụng phương thức method.

Ví dụ

$request->method();

Bạn cũng có thể sử dụng phương thức isMethod để kiểm tra phương thức của request.

VD: Kiểm tra xem request có phải POST request không?

Ví dụ

if ($request->isMethod('post')) {
    //
}

Truy vấn thông tin headers

Nếu muốn truy vấn thông tin liên quan đến header của request các bạn có thể sử dụng phương thức header.

VD: Lấy ra user-agent của reuquest.

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return 'User Agent: ' . $request->header('user-agent');
});

Kết quả:

User Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36

Trong trường hợp request header cần lấy ra không tồn tại thì phương thức header sẽ trả về null. Nếu muốn thay đổi giá trị default này bạn có thể truyền thêm tham số thứ 2 vào hàm header.

Ví dụ

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {
    return 'Header: ' . $request->header('vzn.vn', 'Không có header này');
});

Kết quả:

Header: Không có header này

Bạn cũng có thể lấy ra bearer token của request bằng cách sử dụng phương thức bearerToken.

Ví dụ

$token = $request->bearerToken();

Cách viết trên tương tự với:

Ví dụ

$token = $request->header('Authorization', '');

Lấy ra IP của người dùng.

Để lấy ra địa chỉ ip address của người dùng các bạn sử dụng phương thức ip.

Ví dụ

$ipAddress = $request->ip();

Nhận dữ liệu input.

Để nhận tất cả dữ liệu input gửi lên request, các bạn sử dụng phương thức all.

Ví dụ

$input = $request->all();

Trong trường hợp bạn muốn lấy ra dữ liệu của một input cụ thể (bao gồm payload và query string) bạn có thể sử dụng phương thức input.

Ví dụ

$name = $request->input('name');

Mặc định, Laravel sẽ trả về null nếu input bạn cần lấy không tồn tại. Bạn cũng có thể xác định giá trị mặc định cho input bằng cách truyền thêm tham số thứ 2 vào phương thức input.

Ví dụ

$name = $request->input('name', 'Khuyết Danh');

Trong trường hợp dữ liệu bạn cần truy xuất là một mảng thì bạn có thể sử dụng "." thay cho cách truy cập mảng.

Ví dụ

$name = $request->input('products.0.name');
// tương đương product[0]['name']

$names = $request->input('products.*.name');
// tương đương với lấy hết ra name của products

Nếu bạn không truyền tham số nào vào phương thức input thì Laravel sẽ trả về tất cả dữ liệu gửi lên request (tương tự như phương thức all).

Ví dụ

$input = $request->input();

// Tương đương với

$input = $request->all();

Trong một số trường hợp bạn có sử dụng các thẻ HTML như checkbok, radio,... Và bạn chỉ cần kiểm tra giá trị của nó là true hay false thôi, thì bạn có thể sử dụng phương thức boolean. Phương thức này sẽ nhận các giá trị 1, "1", true, "true", "on", và "yes" là true, còn ngược lại sẽ là false.

Ví dụ

$archived = $request->boolean('archived');

Laravel cũng có apply magic method vào trong Request, nên bạn hoàn toàn có thể access đến một input dưới dạng property trong object. Đối với cách này thì Laravel sẽ ưu tiên lấy ra giá trị trong payload trước.

VD: Lấy ra dữ liệu của input name.

Ví dụ

$name = $request->name;

Đôi lúc bạn cần lấy ra một số input nhất định nào đó nhưng không phải tất cả thì bạn có thể sử dụng phương thức only.

VD: Chỉ lấy ra giá trị input username, password

Ví dụ

$input = $request->only(['username', 'password']);

// hoặc

$input = $request->only('username', 'password');

Hoặc ngược lại bạn muốn bỏ qua input nào đó còn lại sẽ lấy hết thì bạn có thể sử dụng phương thức except.

VD: Bỏ qua input credit_card còn lại lấy hết.

Ví dụ

$input = $request->except(['credit_card']);

// hoặc

$input = $request->except('credit_card');

Nhận dữ liệu query string.

Trong một số trường hợp bạn chỉ muốn lấy ra query string của dữ liệu gửi lên request. Bạn có thể sử dụng phương thức query. Hàm này sẽ trả về một mảng data chứa các query string gửi lên request.

Ví dụ

$query = $request->query();

Nếu bạn cần lấy giá trị của một query tring cụ thể, bạn có thể truyền query string name vào phương thức query.

Ví dụ

$name = $request->query('name');

Mặc định, Laravel sẽ trả về null nếu query string bạn cần lấy không tồn tại. Bạn cũng có thể xác định giá trị mặc định cho input bằng cách truyền thêm tham số thứ 2 vào phương thức query.

Ví dụ

$name = $request->query('name', 'Khuyết Danh');

Kiểm tra dữ liệu input.

Để kiểm tra dữ liệu gửi lên có input nào đó hay không các bạn sử dụng phương thức has. Phương thức này sẽ trả về true nếu input xuất hiện trong request và ngược lại sẽ là false.

Ví dụ

if ($request->has('name')) {
    //
}

Bạn cũng có thể kiểm tra nhiều input với phương thức has bằng cách truyền vào một mảng các input. Lúc này phương thức sẽ trả về true nếu tất cả các input cần kiểm tra đều xuất hiện trong request, ngược lại nó sẽ trả về false.

Ví dụ

if ($request->has(['name', 'email'])) {
    //
}

Cách viết trên tương tự với:

Ví dụ

if ($request->has('name') && $request->has('email')) {
    //
}

Nếu như bạn cần kiểm tra một mảng các input và sẽ trả về true nếu có một hoặc nhiều input xuất hiện trong danh sách đó. Bạn có thể sử dụng phương thức hasAny.

Ví dụ

if ($request->hasAny(['name', 'email'])) {
    //
}

Cách viết trên tương tự với:

Ví dụ

if ($request->has('name') || $request->has('email')) {
    //
}

Đôi lúc bạn cần xử lí một số hành động, logic khi input có xuất hiện trong request bạn có thể sử dụng hàm whenHas.

Ví dụ

$request->whenHas('name', function ($input) {
    //
});

Lúc này nếu trong request có input name thì callback function sẽ được thực thi.

Đôi lúc bạn cần kiểm tra thêm input nào đó có xuất hiện trong input và phải có giá trị hay không? Bạn có thể sử dụng phương thức filled. Phương thức này sẽ trả về true nếu input có xuất hiện trong input và có giá trị kèm theo.

Ví dụ

if ($request->filled('name')) {
    //
}

Tương tự, chúng ta cũng có thể dùng hàm whenFilled để thực thi logic khi input nào đó tồn tại và có giá trị.

Ví dụ

$request->whenFilled('name', function ($input) {
    //
});

Nếu bạn cần check xem một input nào đó không xuất hiện trong request, bạn có thể sử dụng phương thức missing. Phương thức này sẽ trả về true nếu input không xuất hiện trong request.

Ví dụ

if ($request->missing('name')) {
    //
}

Old input.

Mặc định, Laravel sẽ lưu trữ lại giá trị các input của request để phục vụ request tiếp theo như recover lại dữ liệu khi validate sai,... Và quá trình này đã được làm tự động hết rồi. Nhưng ở đây mình muốn giới thiệu với mọi người thêm một số phương thức để sử dụng trong trường hợp cần thiết.

flash: Phương thức này sẽ lưu hết dữ liệu input vào session. Và sẽ được xóa đi nếu bạn request lại lần tiếp theo.
flashOnly: Phương thức này sẽ lưu trữ các input được xác định vào session, còn lại sẽ bỏ qua.
flashExcept: Phương thức này sẽ bỏ qua các input được xác định vào session, còn lại sẽ lưu trữ.

Ví dụ

$request->flash();

$request->flashOnly(['username', 'email']);

$request->flashExcept('password');

Để lấy ra giá trị của input trước đó đã được store các bạn sử dụng phương thức old. Nếu dữ liệu không có giá trị phương thức sẽ trả về null.

Ví dụ

$username = $request->old('username');

Hoặc có thể sử dụng hàm old trong helper.

Ví dụ

old('username')

Bạn cũng có thể xác định thêm giá trị mặc định khi input không có giá trị bằng cách truyền vào tham số thứ 2.

Ví dụ

$username = $request->old('username', 'Không tồn tại');

Input Trimming & Normalization.

Mặc định, Laravel sử dụng 2 middleware App\Http\Middleware\TrimStrings và App\Http\Middleware\ConvertEmptyStringsToNull để làm nhiệm vụ xử lí, chuẩn hóa dữ liệu trước khi đưa vào Request object.

Middleware TrimStrings có tác dụng loại bỏ đi các khoảng trống (white space) ở các input gửi lên request.
Middleware ConvertEmptyStringsToNull có tác dụng chuyển đổi string rỗng thành null.

Nếu như bạn không muốn tắt 2 middleware này đi thì có thể sửa trong app/Http/Kernel.php.

File

Bạn cũng có thể lấy ra được file upload lên trên request qua phương thức file. Phương thức này sẽ trả về một Object UploadedFile (Illuminate\Http\UploadedFile) nếu file đó tồn tại và null nếu file đó không tồn tại.

Object UploadedFile này được kế thừa từ SplFileInfo mặc định của PHP, nên các bạn có thể sử dụng được các phương thức trong SplFileInfo.

VD: Lấy ra thông tin file photo upload lên request.

Ví dụ

$file = $request->file('photo');

Ngoài ra bạn cũng có thể trỏ trực tiếp đến file name qua property.

Ví dụ

$file = $request->photo;

Trong trường hợp bạn cần kiểm tra xem một file nào đó có xuất hiện trong request hay không thì bạn có thể sử dụng phương thức hasFile.

VD: Kiểm tra xem request gửi lên có file photo không?

Ví dụ

if ($request->hasFile('photo')) {
    //
}

Ngoài ra bạn cũng có thể kiểm tra xem file được upload lên có thành công hay không. Bằng cách sử dụng phương thức isValid.

Ví dụ

if ($request->file('photo')->isValid()) {
    //
}

Về request trong Laravel tạm thời mình sẽ dừng ở đây thôi, các phần sau có phần nào liên quan đến các khái niệm nâng cao mình sẽ giải thích sau.

Bài viết này đã giúp ích cho bạn?

Trang trước Trang sau

Request trong Laravel

Request Trong Laravel là gì?

Tương tác với Request trong Laravel.

Ví dụ

Ví dụ

Ví dụ

Truy vấn thông tin URL/PATH

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Truy vấn method của request

Ví dụ

Ví dụ

Truy vấn thông tin headers

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Lấy ra IP của người dùng.

Ví dụ

Nhận dữ liệu input.

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Nhận dữ liệu query string.

Ví dụ

Ví dụ

Ví dụ

Kiểm tra dữ liệu input.

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Old input.

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Input Trimming & Normalization.

File

Ví dụ

Ví dụ

Ví dụ

Ví dụ

Bài viết này đã giúp ích cho bạn?

Về chúng tôi

Liên hệ

Các công cụ