algolia search

Tìm thấy x bài viết trong xms.

Code Laravel làm sao cho chuẩn?

Code Laravel làm sao cho chuẩn?


Khi ta mới bắt đầu code, việc ta quan tâm là code làm sao chạy được 😆. Chấm hết 😜 đúng không nào, theo thời gian bạn sẽ tiến lên level cao hơn, bạn không còn code một mình nữa, bạn phải code theo team vì dự án trăm ngàn đô, triệu đô... không thể 1 người code mà được. Còn nếu bạn vẫn lủi hủi code một mình thì bài viết này không dành cho bạn.

Khi làm team bạn phải đối mặt với nhiều thứ, trong đó có việc code làm sao cho mọi người trong team đọc hiểu, không phải bỏ chạy mấy trăm mét vì mùi code thối của bạn gây ra. Vậy thì code Laravel làm sao cho chuẩn, hãy đọc hết bài viết này nhé 🤤

1. Nguyên tắc ĐƠN TRÁCH NHIỆM - Single responsibility principle (SRP)

Một lớp và một phương thức nên chỉ có một trách nhiệm và nên chỉ có một trách nhiệm mà thôi, cái này là nguyên tắc của SOLID trong hướng đối tượng PHP mình sẽ có một bài nói rõ hơn về nguyên tắc SOLID trong PHP nhé.

Giả sử như bẳng user của bạn có các trường là first_name, middle_name, last_name, gender và bạn muốn lấy ra full_name. Nhưng nếu user đã đăng nhập, đã được xác nhận và user đó là khách hàng của công ty bạn, bạn phải xưng hô Ông/Bà ở đằng trước tên. Sử dụng Accessors trong Laravel ta làm như sau:

Coder Laravel gà sẽ viết:

public function getFullNameAttribute()
{
	if ($this->gender) {
		$genderText = 'Mr. ';
	} else {
		$genderText = 'Mrs. ';
	}
	
	if (auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified()) {
		return $genderText . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
	} else {
		return $this->first_name . ' ' . $this->last_name;
	}
}

Coder Laravel chuẩn sẽ viết:

public function getFullNameAttribute()
{
    return $this->isVerifiedClient() ? $this->getFullNameLong() : $this->getFullNameShort();
}

public function isVerifiedClient()
{
	// Trả về true or false
    return auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified();
}

public function getFullNameLong()
{
    return $this->gender_text . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
}

public function getFullNameShort()
{
    return $this->first_name . ' ' . $this->last_name;
}

public function getGenderTextAttribute()
{
	// Nếu là nam
	if ($this->gender) {
		return 'Mr. ';
	}
	return 'Mrs. ';
}

Tách bạch mọi thứ ra hết, mỗi hàm chỉ đảm nhận 1 nhiệm vụ xử lý duy nhất.

2. Models thì mập, Controllers thì gầy - Fat models, skinny controllers

Đặt tất cả các logic liên quan đến DB vào các Eloquent model hoặc vào các lớp Repository nếu bạn đang sử dụng Query Builder hoặc raw Query.

Coder Laravel gà sẽ viết:

public function index()
{
    $clients = Client::verified()
        ->with(['orders' => function ($q) {
            $q->where('created_at', '>', Carbon::today()->subWeek());
        }])
        ->get();

    return view('index', ['clients' => $clients]);
}

Về logic chả có gì sai, mình mà nói nó sai có khi nó táng vỡ alo mình. Nhưng nếu mình là coder Laravel chuẩn mình sẽ viết sao:

public function index()
{
    return view('index', ['clients' => $this->client->getWithNewOrders()]);
}

class Client extends Model
{
    public function getWithNewOrders()
    {
        return $this->verified()
            ->with(['orders' => function ($q) {
                $q->where('created_at', '>', Carbon::today()->subWeek());
            }])
            ->get();
    }
}

đặt một phương thức getWithNewOrders() viết tất tần tật Query trong đó và ngoài controller chỉ gọi 1 dòng duy nhất. Giả sử như có 10 chỗ xài getWithNewOrders() chỗ nào bạn cũng phang thẳng vào controller, chẳng may logic đó cần chỉnh sửa, bạn phải chỉnh 10 chỗ. Nếu không phải bạn chỉnh sửa mà là đồng đội của bạn, nó sẽ tẩn cho bạn 1 trận ngay cho mà xem.

3. Validation - Kiểm tra dữ liệu đầu vào

Hãy duy chuyển đoạn code validate vào trong Request.

Laravel cung cấp linh hoạt nhiều cách để validate. Ok, ổn cả thôi. Coder Laravel gà chắc chắn sẽ chọn cách đơn giản nhứt:

public function store(Request $request)
{
    $request->validate([
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
        'publish_at' => 'nullable|date',
    ]);

    ....
}

Pro thì sao:

public function store(PostRequest $request)
{    
    ....
}

// chạy lệnh: php artisan make:request PostRequest
class PostRequest extends Request
{
    public function authorize()
    {
        true;
    }

    public function rules()
    {
        return [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
            'publish_at' => 'nullable|date',
        ];
    }
}

4. Logic nghiệp vụ (Business) phải ở trong lớp dịch vụ (Service)

Giả sử như bạn có 1 form trong đó có mục upload hình, dữ liệu sẽ được gửi lên "ArticleController@store" và bạn lưu hình upload lên vào một thư mục nào đó trên server. Ta cùng coi coder Laravel gà sẽ viết gì nào:

public function store(Request $request)
{
    if ($request->hasFile('image')) {
        // move file vào 1 thư mục nào đó
        $request->file('image')->move(public_path('images') . 'temp');
    }
    
    ....
}

Version Pro

public function store(Request $request)
{
    $this->articleService->handleUploadedImage($request->file('image'));

    ....
}

class ArticleService
{
    public function handleUploadedImage($image)
    {
        if (!is_null($image)) {
            $image->move(public_path('images') . 'temp');
        }
    }
}

Bạn thấy gì không? NGUYÊN TẮC THỨ NHẤT LUÔN ĐÚNG! Vì sao? Hàm store ý nghĩa của nó là store dữ liệu người dùng gửi lên vào database, nếu kiêm luôn cả việc move hình đi đâu nữa thì há chẳng phải vi phạm nguyên tắc thứ nhất rồi sao? Việc lưu hình đi đâu có phải là 1 nghiệp vụ không ❓ Quá phải y chứ lị, những thứ gì mang tính đặc thù hãy đưa nó cho Service class xử lý nhé.

5. Don't repeat yourself (DRY) - Đừng tự lặp lại (bóp dái) chính mình

Tái sử dụng code của bạn bất cứ khi nào có thể. Hãy áp dụng nguyên tắc thứ nhất ở trên, chắc chắn bạn sẽ không vi phạm nguyên tắc số 5 này. Hễ bạn thấy đoạn code nào được viết từ 2 lần trở lên, hãy nghiên cứu đưa nó về 1 hàm và gọi đến, nhiều hàm có cùng điểm giống nhau thì tổ chức thành class. Đấy là cách mà pro đã làm. Ta hãy xem bạn tự bóp dái mình như thế nào bằng cách xem ví dụ dưới đây nhé

public function getActive()
{
    return $this->where('verified', 1)->whereNotNull('deleted_at')->get();
}

public function getArticles()
{
    return $this->whereHas('user', function ($q) {
            $q->where('verified', 1)->whereNotNull('deleted_at');
        })->get();
}

Bạn thấy gì không where('verified', 1)->whereNotNull('deleted_at') được viết ở 2 nơi. Coder có kinh nghiệm sẽ viết:

public function scopeActive($q)
{
    return $q->where('verified', 1)->whereNotNull('deleted_at');
}

public function getActive()
{
    return $this->active()->get();
}

public function getArticles()
{
    return $this->whereHas('user', function ($q) {
            $q->active();
        })->get();
}

Easy, đưa phần giống nhau vào scope query trong Laravel, sau này có thêm điều kiện active là sms verify chẳng hạn, bạn có phải mất công đi sửa code ở N chỗ hay không ❓

6. Ưu tiên dùng Eloquent hơn Query Builder, raw SQL. Ưu tiên Collection hơn là array.

Eloquent cho phép bạn viết mã có thể đọc và duy trì được sau này. Eloquent có quá trời built-in tools như scope, soft deletes, events, relationship, ...

Nhiều bạn sẽ đặt tốc độ lên bàn cân để so sánh, đặt hoài nghi về Eloquent hãy xem biết bao nhiêu ưu điểm đổi lấy vài phần trăm speed là quá đáng để hi sinh.

SELECT *
FROM `articles`
WHERE EXISTS (SELECT *
              FROM `users`
              WHERE `articles`.`user_id` = `users`.`id`
              AND EXISTS (SELECT *
                          FROM `profiles`
                          WHERE `profiles`.`user_id` = `users`.`id`) 
              AND `users`.`deleted_at` IS NULL)
AND `verified` = '1'
AND `active` = '1'
ORDER BY `created_at` DESC

wow, tôi - Chung Nguyễn phải có kiến thức về mysql, Chung đọc cái đoạn EXITS loằng ngoằng kia chỉ để mất 3 tiếng để hiểu và 5 phút để chỉnh sửa, thất là quá đáng lắm luôn á 😱😱😭😭

Coder Laravel pro ơi, viết Eloquent em coi thử đi:

Article::has('user.profile')->verified()->latest()->get();

Oh, ACTICLE ⇒ HAS ⇒ USER ⇒ PROFILE ⇒ VERIFIED ⇒ LATEST ⇒ GET. Ôi mẹ ơi, không khác gì bài văn tiếng Anh 🤩🤩🌺🌺

Collection trong Laravel phải nói là kì quan thiên nhiên vĩ đại, nó bao hàm cả array trong đó và còn plus thêm gần cả trăm function hỗ trợ hiện đại, bạn đã bao giờ dùng map, chunk, pop, push, pipe,... chưa 😵 

Chẳng hạn bạn muốn lấy ra user có tuổi lớn hơn 18:

$usersOver18 = User::where('age', '>=' 18)->get();

Bây giờ bạn muốn lọc thêm là ở Hà Nội, có mã province_id là 4. Thay vì tốn thêm 1 query vào db như cách viết dưới đây:

$usersOver18LiveInHaNoi = User::where('age', '>=' 18)->where('province_id', 4)->get();

Bạn có thể tận dụng kết quả đã lấy ở trên

$usersOver18LiveInHaNoi = $usersOver18->where('province_id', 4);

7. Mass assignment - Gán giá trị hàng loạt

Khi tạo một bài viết mới, code sẽ như thế này:

$article = new Article;
$article->title = $request->title;
$article->content = $request->content;
$article->verified = $request->verified;
// Add category to article
$article->category_id = $category->id;
$article->save();

nếu database có 50 cột, okey fine 🤣🤣

Hãy dùng tính năng Mass assignment đưa Laravel kế thừa từ Ruby đi

$category->article()->create($request->all());

8. Không thực hiện truy vấn trong Blade view và sử dụng eager loading (N + 1 query)

Giả sử trong Blade bạn thực hiện show danh sách all user, đi kèm với profile.

@foreach (User::all() as $user)
    {{ $user->profile->name }}
@endforeach

Bạn thấy đấy, profile chính là mối quan hệ và Laravel sẽ truy vấn Query đó sau mỗi vòng lặp, giả sử có 100 user thì đoạn code trên sẽ thực hiện 101 truy vấn lên db 😐😐

Coder Laravel chuẩn phải viết

// trong controller
$users = User::with('profile')->get();


// ngoài blade view
@foreach ($users as $user)
    {{ $user->profile->name }}
@endforeach

9. Ghi chú cho đoạn code của bạn, nhưng hơn hết hãy đặt tên hàm và biến có ý nghĩa

Bad:

if (count((array) $builder->getQuery()->joins) > 0)

Tốt hơn xíu là có comment lại code:

// Determine if there are any joins.
if (count((array) $builder->getQuery()->joins) > 0)

Tốt hơn hết là phải thế này:

if ($this->hasJoins())

Tên hàm đã rõ nghĩa quá rồi, không cần phải comment. Trong hàm hasJoins bạn viết logic cho nó là ok 😎

10. Đừng bỏ code JS, CSS vào blade view, đừng bỏ HTML vào class PHP

Css thì bỏ vào file css thì không nói gì rồi, trường hợp hay gặp nhất là push dữ liệu PHP vào JS. Gà mờ sẽ viết như sau

let article = `{{ json_encode($article) }}`;

Nạp thẳng json_encode vào javascript ngay trong file blade view.

Cách tốt hơn là put giá trị vào 1 nơi nào đó trong blade view

<input id="article" type="hidden" value="@json($article)">

<!-- hoặc -->

<button class="js-fav-article" data-article="@json($article)">{{ $article->name }}<button>

Rồi lấy giá trị đó ra ở file JS:

let article = $('#article').val();

// hoặc

let article = $('#article').data('article');

Có trường output form bằng php code echo trong class, hãy bỏ chúng ngoài blade view nhé.

11. Sử dụng các files config và language, hằng số thay vì văn bản trong code

Nguyên tắc khi code là những thứ có khả năng thay đổi linh hoạt thì k fix cứng vào 1 chỗ. Giả dụ, kiểm tra bài viết này có phải là normal hay không?

public function isNormal()
{
    return $article->type === 'normal';
}

Thay vì gõ normal trực tiếp trong code, ta định nghĩa 1 lớp ArticleType hoặc bỏ luôn trong Article Eloquent Model luôn:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
    const TYPE_NORMAL = 'normal';
    
    public function isNormal()
    {
        return $article->type === Article::TYPE_NORMAL;
    }
}

Hoặc như trong trường hợp controller xử lý thành công và trả về một message cho người dùng, coder mới thường hay viết thế này

public function store(Request $request)
{
    # lưu bài viết vào db
    return back()->with('message', 'Thêm bài viết thành công!');
}

Hãy dùng Laravel Localization đi nhé, chả phức tạp như bạn nghĩ. Nhiều bạn cho là rắc rối vì phải định nghĩa trong language file, nhưng thực ra các bạn chưa biết 🧐. Laravel cung cấp 2 hình thức đọc file đa ngôn ngữ là từ file .php và .json. Trường hợp ở trên sẽ viết lại như sau:

public function store(Request $request)
{
    # lưu bài viết vào db
    // đọc từ file php
    return back()->with('message', __('app.article_added'));
    // đọc từ file json
    return back()->with('message', __('Thêm bài viết thành công!'));
}

Cách đọc từ file json rất tiện cho bạn nào lười, Laravel sẽ hiện thị nguyên chuỗi gốc nếu k tìm thấy bản dịch tương ứng, thay vì show đoạn text 'app.article_add' vô nghĩa với người dùng khi không tìm thấy.

12. Sử dụng các công cụ chuẩn của Laravel được cộng đồng chấp nhận

Laravel tích hợp cực kì nhiều chức năng và gói, đã được cộng đồng đón nhận và sử dụng, thay vì phải sử dụng gói và công cụ của bên thứ 3. Trừ khi khách hàng yêu cầu, và tính chất dự án yêu cầu phải có.

Tại sao:

  • DEV LARAVEL sẽ cần phải tìm hiểu các công cụ thứ 3 này.
  • cơ hội nhận trợ giúp từ cộng đồng Laravel thấp hơn đáng kể
  • Khách hàng của bạn cũng sẽ không trả tiền cho cho điều đó
Yêu cầu Công cụ của Laravel Công cụ của bên thứ 3
Authorization - Quyền hạn Policies Entrust, Sentinel, ...
Compiling assets - biên dịch tài nguyên Laravel Mix Grunt, Gulp,...
Development Environment - Môi trường DEV Homestead Docker
Deployment - Triển khai Laravel Forge Deployer...
Unit testing PHPUnit, Mockery Phpspec
Browser testing Laravel Dusk Codeception
DB Eloquent SQL, Doctrine
Templates Engineer Blade Twig
Làm việc với dữ liệu Laravel collections Arrays
Form validation Request classes bên thứ 3, validation in controller
Authentication - Chứng thực Built-in (có sẵn) bên thứ 3, giải pháp của bạn
API authentication Laravel Passport bên thứ 3 JWT và OAuth packages
Creating API Built-in (có sẵn) Dingo API và gói tương tự
Working with DB structure Migrations Thao tác trực tiếp trên DB
Localization - Đa ngôn ngữ Built-in (có sẵn) bên thứ 3
Realtime user interfaces Laravel Echo, Pusher bên thứ 3 làm việc trực tiếp với WebSockets
Generating testing data - Tạo dữ liệu test Seeder classes, Model Factories, Faker Làm tay
Task scheduling - Lịch công việc Laravel Task Scheduler Scripts và bên thứ 3
DB MySQL, PostgreSQL, SQLite, SQL Server MongoDB

13. Tuân theo quy ước đặt tên của Laravel

Đặt tên trong Laravel trước tiên phải tuân thủ quy cách đặt tên của PHP, đó là chuẩn PSR-2 Chung Nguyễn Blog sẽ viết sau

Ngoài ra, hãy làm theo các quy ước đặt tên được chấp nhận bởi cộng đồng Laravel như sau:

What How Good Bad
Controller số ít ArticleController ArticlesController
Route số nhiều articles/1 article/1
Named route snake_case (kiểu rắn 🐍) với dấu chấm users.show_active users.show-active, show-active-users
Model số ít User Users
hasOne hoặc belongsTo relationship số ít articleComment articleComments, article_comment
Tất cả các relationships khác số nhiều articleComments articleComment, article_comments
Table - bảng số nhiều article_comments article_comment, articleComments
Bảng Pivot gồm tên 2 bảng số ít, xếp theo an pha bét 🤣 article_user user_article, articles_users
tên cột trong bảng snake_case (kiểu rắn 🐍) không bao gồm tên bảng meta_title MetaTitle; article_meta_title
Thuộc tính của Model snake_case (kiểu rắn 🐍) $model->created_at $model->createdAt
Foreign key - khóa ngoại tên model số ít, kèm _id đằng sau article_id ArticleId, id_article, articles_id
Primary key - id custom_id
Migration - 2017_01_01_000000_create_articles_table 2017_01_01_000000_articles
Method camelCase (kiểu lạc đà 🐫) getAll get_all
Method trong resource controller xem tài liệu store saveArticle
Method in test class camelCase (kiểu lạc đà 🐫) testGuestCannotSeeArticle test_guest_cannot_see_article
Variable camelCase (kiểu lạc đà 🐫) $articlesWithAuthor $articles_with_author
Collection có nghĩa mô tả, số nhiều $activeUsers = User::active()->get() $active, $data
Object có nghĩa mô tả, số ít $activeUser = User::active()->first() $users, $obj
Config and language files index snake_case (kiểu rắn 🐍) articles_enabled ArticlesEnabled; articles-enabled
View kebab_case show-filtered.blade.php showFiltered.blade.php, show_filtered.blade.php
Config snake_case (kiểu rắn 🐍) google_calendar.php googleCalendar.php, google-calendar.php
Contract (interface) tính từ hoặc danh từ Authenticatable AuthenticationInterface, IAuthentication
Trait tính từ Notifiable NotificationTrait

14. Sử dụng cú pháp ngắn hơn và dễ đọc hơn nếu có thể

Laravel hỗ trợ rất nhiều helpers method để tạo nên những đoạn code ngắn và rõ ngữ nghĩa. Danh sách helpers method xem ở đây nhé 

Bad:

$request->session()->get('cart');
$request->input('name');

Good:

session('cart');
$request->name;

Nhiều ví dụ hơn

Cú pháp thông thường Cú pháp ngắn và rõ nghĩa hơn
Session::get('cart') session('cart')
$request->session()->get('cart') session('cart')
Session::put('cart', $data) session(['cart' => $data])
$request->input('name'), Request::get('name') $request->name, request('name')
return Redirect::back() return back()
is_null($object->relation) ? $object->relation->id : null optional($object->relation)->id
return view('index')->with('title', $title)->with('client', $client) return view('index', compact('title', 'client'))
$request->has('value') ? $request->value : 'default'; $request->get('value', 'default')
Carbon::now(), Carbon::today() now(), today()
App::make('Class') app('Class')
->where('column', '=', 1) ->where('column', 1)
->orderBy('created_at', 'desc') ->latest()
->orderBy('age', 'desc') ->latest('age')
->orderBy('created_at', 'asc') ->oldest()
->select('id', 'name')->get() ->get(['id', 'name'])
->first()->name ->value('name')

15. Sử dụng IoC container hoặc facades thay vì new Class

Chả biết nói sao với cái này, vì nó hơi hướng trừu tượng khó hiểu. Đại loại object của class phải được khởi tạo qua IoC container hoặc facade trong Laravel. Khởi tạo ở __construct

Coder mới vào Laravel sẽ viết

public function store(Request $request)
{
    $user = new User;
    $user->create($request->all());
}

Còn áp dụng nguyên tắc 15 trên thì viết lại như sau:

protected $user;

public function __construct(User $user)
{
    $this->user = $user;
}

public function store(Request $request)
{
    $this->user->create($request->all());
}

16. Không lấy dữ liệu trực tiếp từ tệp .env

Đây là lỗi phổ biến khá nhiều bạn mắc phải nè, mục đích ENV sinh ra là để cá nhân hóa môi trường (env trong environment) để làm việc tập thể, ngoài ra còn để chứa 1 số dữ liệu nhạy cảm như mật khẩu, ... khi share, public code.

Quy trình chuẩn phải là như sau: khai báo trong .env ⏩ nạp vào config ⏩ lấy ra dữ liệu.

Gà thì viết như vầy:

public function index()
{
    $apiKey = env('API_KEY');
}

Còn ... à mà thôi

// config/api.php
<?php

return [
    ...
    'key' => env('API_KEY'),
    ...
]

// lấy API_KEY ở controller
public function index()
{
    $apiKey = config('api.key');
}

17. Lưu trữ ngày theo định dạng chuẩn. Sử dụng accessors and mutators để sửa đổi định dạng ngày

Chung hay nhận được nhiều inbox về vấn đề này, cũng như gặp các câu hỏi dạng như thế này trên các group về việc lưu vào db định dạng theo ý muốn cá nhân.

Bad

// lưu vào db định dạng cá nhân mong muốn
{{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->toDateString() }}
{{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->format('m-d') }}

Good:

// trong Eloquent Model
protected $dates = ['ordered_at', 'created_at', 'updated_at']
public function getSomeDateAttribute($date)
{
    return $date->format('m-d');
}

// hiển thị ra ngoài View
{{ $object->ordered_at->toDateString() }}
{{ $object->ordered_at->some_date }}

18. Khác

  1. Không bao giờ đặt bất kỳ logic nào trong các tệp routes (web.php, api.php, ...).
  2. Giảm thiểu việc sử dụng Vanilla PHP trong Blade templates. (Thay vì viết {{ csrf_token() }} hoặc @csrf bạn lại đi viết <?php echo csrf_field(); ?>)

Tổng kết

Ai cũng một thời trẻ trâu 🤔🤔, và cũng một thời từ gà 🐤🐓 đi lên. Quan trọng ai trở nên pro trước, code cũng như võ công 🤸🏻, phụ thuộc vào sự lĩnh hội của người tập, sự kiên trì khổ luyện 💪. Cộng đồng đã đúc kết thành 1 quyển chân kinh, được Chung Nguyễn Blog mang về dịch, phơi rành rành ra trước mắt cho mọi người đọc.

Kẻ sĩ tất thảy đều nhìn qua, người sáng mắt như vớ được vàng. Kẻ thịnh nộ tìm coi có điểm gì sai mà trách móc, chỉ có đấng anh hùng, quang minh chính đại, giơ tay thật cao những khẽ nhẹ nhàng góp ý cho bài viết hoàn thiện hơn. Kết quả như thế nào âu là phúc phần ăn ở của tại hạ.

Nhân tiện, bạn có những đứa bạn vỗ ngực xưng danh code Laravel nhiều năm, hãy táng vào mặt nó cuốn chân kinh này, coi thử nó luyện được bao nhiêu trong 18 tầng 😆😆 võ học này, tầng 19, 20.. sâu quá tại hạ chưa xuống tới. Cần lắm một cao nhân chỉ điểm.

Chung Nguyễn kính bút!

Nguồn alexeymezenin dịch và chém bởi Chung Nguyễn

If you like this article, please star the original repository: https://github.com/alexeymezenin/laravel-best-practices

Bạn luyện được mấy tầng ?/18 hãy để lại bình luận nhé 😍.

Đánh giá bài viết

Thích thì like
Code Laravel làm sao cho chuẩn?
4.1666666666667/5 6 votes

Bình luận

Công Nguyễn Chí avatar
Công Nguyễn Chí
{{ $object->ordered_at->toDateString() }}
{{ $object->ordered_at->some_date }}
BKAP SV avatar
BKAP SV
em mới học mà các anh chị viết code trông lạ quá...Cần người giúp đỡ ạ

Đoàn Đức avatar
Đoàn Đức
Cái mục số 4 service của a có phải là service provider (design pattern laravel) ko?
E thấy trait cũng làm được upload ảnh như thế này, chỉ khác service provider thì inject dependency. A có thể giải thích rõ đoạn này giúp e đươc ko?
Chung Nguyễn avatar
Chung Nguyễn
Không phải em nha, service ở đây là em tự viết. Chẳng hạn mình có nghiệp vụ xử lý upload ảnh cho bài viết như ở trên mình tạo ArticleService ở trong app\Services\ArticleService.php
Sau đó viết code xử lý vào, sau này bảo trì dự án, mình chỉ tập trung vào service vì business thường thay đổi nhiều nhất, đó là lí do chính.
Đoàn Đức avatar
Đoàn Đức
Còn câu hỏi thứ 2 a, service này nên dùng trait hay viết class bình thường rồi inject vào controller a?
E thấy trait có vẻ hợp với trường hợp này hơn.
Chung Nguyễn avatar
Chung Nguyễn
hiện tại thì a viết class bình thường

class XxxxService
{
    public static function create() { return new static();
}

public function yyy()
{
// logic
}
}
Sau đó trong controller a sẽ sử dụng
$xxxxService = XxxxService::create();
$xxxxService->yyy();

hoặc
XxxxService::create()->yyy();

Minh Nguyễn avatar
Minh Nguyễn
Em có tý thắc mắc bác ơi

Nếu theo bác thì tất cả controller sẽ đều có service riêng để xử lý 

Thì cá nhân em thấy việc này hơi tốn effort 

Chả hạn như khi mà tác vụ của action này hết sức simple như này và trả về view luôn:

$xxxx = $this->_repository->first($id);
return view('yyy', compact('xxxx'));

Thì có thực sự nên viết luôn service cho nó hay không hay là chờ đến khi nào requirement thay đổi và phình ra thì mình mới nên tạo service cho nó nhỉ
Đạt Đỗ avatar
Đạt Đỗ
Cho em hỏi cái thứ 5 . $q->active() là sao ạ. Cái active() lấy ở đâu ạ. Em mới học anh có thể nói rõ hơn không ạ.Em cảm ơn!
Chung Nguyễn avatar
Chung Nguyễn
Đây là tính năng Query Scope trong Laravel. Tham khảo ở đây em nhé https://laravel.com/docs/master/eloquent#query-scopes
Chuong Le avatar
Chuong Le
Hay lam... a ma thoi. Thx bro.
Truyen Hay 24H avatar
Truyen Hay 24H
cái số 6 chính tỏ chủ thớt chưa làm DB trên 10gb. Eloquent và Query Builder khác nhau cực lớn về mặt tốc độ đối với table trên 10m record nhe.
Minh Nguyễn avatar
Minh Nguyễn
Mình thấy ở trên chủ thớt đã nói rõ về vấn đề viết như vậy để maintain tốt hơn rồi 

Cái này mình nghĩ là sự đánh đổi thôi, dễ maintain thì performance giảm.

Hoặc không thì phải viết 1 eloquent tối ưu riêng theo cách của bạn thôi. 

Chứ mình thực sự dị ứng viết query trong
Chứ còn chuyện bạn muốn chơi với 10 củ record thì mình nghĩ nên chuyển sang xài elasticsearch hoặc nosql nào đi thì hơn

Chứ bố mysql mà tầm 2 3 củ là đã loạng choạng lắm rồi


Hikigaya Hachiman avatar
Hikigaya Hachiman
Việc khác biệt cực lớn về tốc độ ở đây là sao nhỉ? Mình ko nghĩ việc render ra collection của Eloquent lại chậm hơn nhiều so với 1 truy vấn sql nếu Eloquent và QB có cùng truy vấn.
trungld avatar
trungld

có thấy chữ ƯU TIÊN k?

Đoàn Đức avatar
Đoàn Đức
E có băn khoăn nữa, a cho e hỏi chút, theo như quy luật mỗi method 1 nhiệm vụ, giả sử trang chủ vừa lấy tất cả bài posts, vừa lấy danh sách user chả hạn thì trong PostsController, hàm index sẽ phải vừa lấy Post::aall() và User::all(), vậy có vi phạm quy tắc này ko ạ?
Chung Nguyễn avatar
Chung Nguyễn
PostController là 1 bộ điều khiển, nó xử lý các case theo yêu cầu nên không vấn đề gì, có thể tạo 1 class Service để xử lý những nghiệp vụ trong controller, vừa clean vừa tái sử dụng được
Đoàn Đức avatar
Đoàn Đức
Tks a, E đã hiểu. Sử dụng Service khá hay.
Đoàn Đức avatar
Đoàn Đức
Giả sử fillable của mình có name, email, pasword
Trong hàm update(), chỉ update mỗi name. Nếu người dùng chèn code html
<input type="hidden" name="email" value="[email protected]">
thì $request->all() sẽ update cả $email nữa. Vậy phải xử lý sao ạ
Chung Nguyễn avatar
Chung Nguyễn
  1. Filter request bằng cách dùng FormRequest
  2. Dùng $request->only()
Đoàn Đức avatar
Đoàn Đức
Sao e thấy laravel hay dùng static method khi cần gọi nó ngay trong class. A có thể giải thích cho e khi nào cần dùng static method đc ko ạ

Chung Nguyễn avatar
Chung Nguyễn
Việc sử dụng các hàm và thuộc tính ở dạng tĩnh có ưu điểm là ta có thể không cần khởi tạo đối tượng mới vẫn sử dụng được. Tuy nhiên nó có khuyết điểm là nếu ta khai báo tĩnh thì chương trình sẽ xử lý lưu trữ toàn cục các static method đó nên sẽ tốn bộ nhớ hơn.
Rybak Alexander avatar
Rybak Alexander
Phần đặt tên của View thì tác giả đã đổi rồi anh ơi, 
Viewsnake_caseshow_filtered.blade.phpshowFiltered.blade.php, show-filtered.blade.php
Nguyễn Duy Nguyên avatar
Nguyễn Duy Nguyên
Tuyệt vời, tks pro :D
Minh Hoàng Dương avatar
Minh Hoàng Dương
Thanks bro.
Đoàn Quốc Nam avatar
Đoàn Quốc Nam
Bài viết của bác thật sự rất hữu ích, cơ mà em muốn hỏi tại sao nên tách Validate ra thành 1 file vậy, Em nghĩ làm vậy nó sẽ chậm đi đôi chút, và tại sao ko nên gán trực tiếp biến PHP vào code JS.
Bách Nguyễn avatar
Bách Nguyễn
thả tim
Diep Nguyen avatar
Diep Nguyen

Bài viết hay quá..

Chung Nguyễn avatar
Chung Nguyễn

Cảm ơn bạn nhé!

Chung Nguyễn avatar
Chung Nguyễn

2018/11/28 update mục 15

Blade View trong Laravel phải là kebab_case (new-comment.blade.php)

あひひ avatar
あひひ

Bài viết hay lắm anh!

あひひ avatar
あひひ

Mà sao không có profile của user ạ, em muốn đổi cái ảnh đại diện k được :3 
Mà lại còn dẫn vào trang admin nữa chứ :(
Logout cũng bị lỗi luôn!

Chung Nguyễn avatar
Chung Nguyễn
đang big update system em ạ, lúc viết blog chỉ có giao diện admin thôi à. Có anh báo cho nha :D
Quang Nguyễn avatar
Quang Nguyễn

Cám ơn những chia sẻ bổ ích của anh. 

Anh có thể ns rõ cho em biết tầng số 4 ( class ArticleService

Chung Nguyễn avatar
Chung Nguyễn

Khi em xử lý các nghiệp vụ, em nên đưa vào lớp service. Có rất nhiều lợi ích như sau:

  1. Trong controller sẽ mỏng đi, đáp ứng nguyên lý số 2 (mỏng controller).
  2. Ngoài front em cũng xử lý upload image, trong backend em cũng xử lý upload image, nếu viết thẳng trong controller em sẽ k tái sử dụng được (em sẽ chọn cách copy code - sai từ đây)
    => tái sử dụng
  3. Khi nghiệp vụ quy về cho service xử lý, nghiệp vụ thay đổi em chỉ cần maintain lớp service mà k quan tâm nó được dùng ở đâu
    => dễ maintain
  4. ...
Quang Nguyễn avatar
Quang Nguyễn

Vâng rất hay ạ. Tại bình thường em làm sẽ tạo lớp serviece làm cầu nối giữa controller và lớp repositories( trong đây em viết code làm việc với database )

Hoang Thang avatar
Hoang Thang

Cũng được 15, 16 tầng rồi. Cám ơn bác nhiều nhé, bài viết rất bổ ích.

Chung Nguyễn avatar
Chung Nguyễn

Cảm ơn bạn đã đọc bài nhé, mình sẽ vui hơn nếu bạn vote star cho bài viết này 😍😍

Hoang Thang avatar
Hoang Thang

Đã vote bác ơi, à có 1 chỗ mình cũng muốn góp ý, không biết ý mọi người sao chứ mình thấy dùng

$request->name nó không hay bằng $request->input('name') vì cách thứ 2 này sẽ care được trường hợp khi param đẩy lên nó không tồn tại vẫn ko xảy ra crash. Nhìn chung vẫn bắt qua validatation được nhưng đôi khi là vẫn ko hay.

Nguyễn Tú avatar
Nguyễn Tú

Sau khi đọc xong bài của bác em tự cảm thấy hoang mang :(

Code của em quá lởm đi :(

Xin bác nhận em làm đệ tử.

Chung Nguyễn avatar
Chung Nguyễn

follow page em nhé bác: https://www.facebook.com/chungnguyen.me/ 

Quoc Hoi Dang avatar
Quoc Hoi Dang

Rule số 2 

Đặt tất cả các logic liên quan đến DB vào các Eloquent model hoặc vào các lớp Repository nếu bạn đang sử dụng Query Builder hoặc raw Query.

Mình cần viết 1 cái hàm search dựa theo condition của user. Nếu viết vô repository cũng khó bởi kèm cả điều kiện và quyền access của user nữa

Rất mong cao nhân chỉ giáo thêm...

Chung Nguyễn avatar
Chung Nguyễn

Giả sự bạn search trong model Posts thì chỉ cần viết ntn:

Posts::searchAdvanced($conditions, Auth::user());

Trong đó $conditions là mảng điều kiện, Auth::user() là thông tin user đang đăng nhập, thử bạn nhé!

Bình Phạm avatar
Bình Phạm

Hay quá, phải đăng nhập để bình luận cho bác.

Chung Nguyễn avatar
Chung Nguyễn

thanks bác nhiều nha 😍

Nguyễn Công Sơn avatar
Nguyễn Công Sơn

Thanks, bài viết hay và bổ ích lắm ạ, cơ mà mục số 5 ảnh 2 hình như sai sai cái đoạn gọi rùi ạ :v
là gọi scopeActive() chứ ko phải gọi active() phải không ạ?

Chung Nguyễn avatar
Chung Nguyễn

Không phải nhầm đâu bạn nhé. Đây là tính năng Query Scope trong Laravel. Tài liệu tại đây nè: https://laravel.com/docs/master/eloquent#query-scopes. Ta đặt tên hàm theo quy tắc đặt tên camelCase (kiểu lạc đà). Khi gọi thì bỏ scope đi và gọi cũng theo kiểu camelCase. Ví dụ nhé:
scopePopular() thì sẽ gọi ->popular()
scopeOfType() thì sẽ gọi ->ofType()

Nguyen Le Thanh avatar
Nguyen Le Thanh

Cho mình hỏi mục số 7, có thể nói rõ hơn được không

Chung Nguyễn avatar
Chung Nguyễn

Tính năng mass assignment của Laravel, cho phép bạn insert hàng loạt vào database, chỉ cần bên form phần name giống với cột trong database. Thay vì insert thủ công như ví dụ ở trên

https://laravel.com/docs/master/eloquent#mass-assignment

https://chungnguyen.xyz/laravel/docs/eloquent.md

Hiển thị bình luận Facebook