понедельник, 11 ноября 2019 г.

Хорошие практики Laravel

Принцип единственной ответственности (Single responsibility principle)
Каждый класс и метод должны выполнять лишь одну функцию.

Плохо:

public function getFullNameAttribute()
{
    if (auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified()) {
        return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
    } else {
        return $this->first_name[0] . '. ' . $this->last_name;
    }
}
Хорошо:

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

public function isVerifiedClient()
{
    return auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified();
}

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

public function getFullNameShort()
{
    return $this->first_name[0] . '. ' . $this->last_name;
}
🔝 Наверх

Тонкие контроллеры, толстые модели
По своей сути, это лишь один из частных случаев принципа единой ответственности. Выносите работу с данными в модели при работе с Eloquent или в репозитории при работе с Query Builder или "сырыми" SQL запросами.

Плохо:

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

    return view('index', ['clients' => $clients]);
}
Хорошо:

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();
    }
}
🔝 Наверх

Валидация
Следуя принципам тонкого контроллера и SRP, выносите валидацию из контроллера в Request классы.

Плохо:

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

    ....
}
Хорошо:

public function store(PostRequest $request)

    ....
}

class PostRequest extends Request
{
    public function rules()
    {
        return [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
            'publish_at' => 'nullable|date',
        ];
    }
}
🔝 Наверх

Бизнес логика в сервис-классах
Контроллер должен выполнять только свои прямые обязанности, поэтому выносите всю бизнес логику в отдельные классы и сервис классы.

Плохо:

public function store(Request $request)
{
    if ($request->hasFile('image')) {
        $request->file('image')->move(public_path('images') . 'temp');
    }
 
    ....
}
Хорошо:

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');
        }
    }
}
🔝 Наверх

Не повторяйся (DRY)
Этот принцип призывает вас переиспользовать код везде, где это возможно. Если вы следуете принципу SRP, вы уже избегаете повторений, но Laravel позволяет вам также переиспользовать представления, части Eloquent запросов и т.д.

Плохо:

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();
}
Хорошо:

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();
}
🔝 Наверх

Предпочитайте Eloquent конструктору запросов (query builder) и сырым запросам в БД. Предпочитайте работу с коллекциями работе с массивами
Eloquent позволяет писать максимально читаемый код, а изменять функционал приложения несоизмеримо легче. У Eloquent также есть ряд удобных и мощных инструментов.

Плохо:

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
Хорошо:

Article::has('user.profile')->verified()->latest()->get();
🔝 Наверх

Используйте массовое заполнение (mass assignment)
Плохо:

$article = new Article;
$article->title = $request->title;
$article->content = $request->content;
$article->verified = $request->verified;
// Привязать статью к категории.
$article->category_id = $category->id;
$article->save();
Хорошо:

$category->article()->create($request->validated());
🔝 Наверх

Не выполняйте запросы в представлениях и используйте нетерпеливую загрузку (проблема N + 1)
Плохо (будет выполнен 101 запрос в БД для 100 пользователей):

@foreach (User::all() as $user)
    {{ $user->profile->name }}
@endforeach
Хорошо (будет выполнено 2 запроса в БД для 100 пользователей):

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

...

@foreach ($users as $user)
    {{ $user->profile->name }}
@endforeach
🔝 Наверх

Комментируйте код, предпочитайте читаемые имена методов комментариям
Плохо:

if (count((array) $builder->getQuery()->joins) > 0)
Лучше:

// Determine if there are any joins.
if (count((array) $builder->getQuery()->joins) > 0)
Хорошо:

if ($this->hasJoins())
🔝 Наверх

Выносите JS и CSS из шаблонов Blade и HTML из PHP кода
Плохо:

let article = `{{ json_encode($article) }}`;
Лучше:

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

Или

<button class="js-fav-article" data-article='@json($article)'>{{ $article->name }}<button>
В Javascript файле:

let article = $('#article').val();
Еще лучше использовать специализированный пакет для передачи данных из бэкенда во фронтенд.

🔝 Наверх

Конфиги, языковые файлы и константы вместо текста в коде
Непосредственно в коде не должно быть никакого текста.

Плохо:

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

return back()->with('message', 'Ваша статья была успешно добавлена');
Хорошо:

public function isNormal()
{
    return $article->type === Article::TYPE_NORMAL;
}

return back()->with('message', __('app.article_added'));
🔝 Наверх

Используйте инструменты и практики принятые сообществом

Laravel имеет встроенные инструменты для решения часто встречаемых задач. Предпочитайте пользоваться ими использованию сторонних пакетов и инструментов. Laravel разработчику, пришедшему в проект после вас, придется изучать и работать с новым для него инструментом, со всеми вытекающими последствиями. Получить помощь от сообщества будет также гораздо труднее. Не заставляйте клиента или работодателя платить за ваши велосипеды.
ЗадачаСтандартные инструментНестандартные инструмент
АвторизацияПолитикиEntrust, Sentinel и др. пакеты, собственное решение
Работа с JS, CSS и пр.Laravel MixGrunt, Gulp, сторонние пакеты
Среда разработкиHomesteadDocker
Разворачивание приложенийLaravel ForgeDeployer и многие другие
ТестированиеPhpunit, MockeryPhpspec
e2e тестированиеLaravel DuskCodeception
Работа с БДEloquentSQL, построитель запросов, Doctrine
ШаблоныBladeTwig
Работа с даннымиКоллекции LaravelМассивы
Валидация формRequest классыСторонние пакеты, валидация в контроллере
АутентификацияВстроенный функционалСторонние пакеты, собственное решение
Аутентификация APILaravel PassportСторонние пакеты, использующие JWT, OAuth
Создание APIВстроенный функционалDingo API и другие пакеты
Работа со структурой БДМиграцииРабота с БД напрямую
ЛокализацияВстроенный функционалСторонние пакеты
Обмен данными в реальном времениLaravel Echo, PusherПакеты и работа с веб сокетами напрямую
Генерация тестовых данныхSeeder классы, фабрики моделей, FakerРучное заполнение и пакеты
Планирование задачПланировщик задач LaravelСкрипты и сторонние пакеты
БДMySQL, PostgreSQL, SQLite, SQL ServerMongoDb

Соблюдайте соглашения сообщества об именовании

Следуйте стандартам PSR при написании кода.
Также, соблюдайте другие cоглашения об именовании:
ЧтоПравилоПринятоНе принято
Контроллеред. ч.ArticleControllerArticlesController
Маршрутымн. ч.articles/1article/1
Имена маршрутовsnake_caseusers.show_activeusers.show-active, show-active-users
Модельед. ч.UserUsers
Отношения hasOne и belongsToед. ч.articleCommentarticleComments, article_comment
Все остальные отношениямн. ч.articleCommentsarticleComment, article_comments
Таблицамн. ч.article_commentsarticle_comment, articleComments
Pivot таблицаимена моделей в алфавитном порядке в ед. ч.article_useruser_article, articles_users
Столбец в таблицеsnake_case без имени моделиmeta_titleMetaTitle; article_meta_title
Внешний ключимя модели ед. ч. и _idarticle_idArticleId, id_article, articles_id
Первичный ключ-idcustom_id
Миграция-2017_01_01_000000_create_articles_table2017_01_01_000000_articles
МетодcamelCasegetAllget_all
Метод в контроллере ресурсовтаблицаstoresaveArticle
Метод в тестеcamelCasetestGuestCannotSeeArticletest_guest_cannot_see_article
ПеременныеcamelCase$articlesWithAuthor$articles_with_author
Коллекцияописательное, мн. ч.$activeUsers = User::active()->get()$active, $data
Объектописательное, ед. ч.$activeUser = User::active()->first()$users, $obj
Индексы в конфиге и языковых файлахsnake_casearticles_enabledArticlesEnabled; articles-enabled
Представлениеsnake_caseshow_filtered.blade.phpshowFiltered.blade.php, show-filtered.blade.php
Конфигурационный файлsnake_casegoogle_calendar.phpgoogleCalendar.php, google-calendar.php
Контракт (интерфейс)прилагательное или существительноеAuthenticatableAuthenticationInterface, IAuthentication
ТрейтприлагательноеNotifiableNotificationTrait

Короткий и читаемый синтаксис там, где это возможно

Плохо:
Хорошо:
Еще примеры:
Часто используемый синтаксисБолее короткий и читаемый синтаксис
Session::get('cart')session('cart')
$request->session()->get('cart')session('cart')
Session::put('cart', $data)session(['cart' => $data])
$request->input('name')$request->name
Request::get('name')request('name')
return Redirect::back()return back()
return view('index')->with('title', $title)->with('client', $client)return view('index', compact('title', 'client'))

Используйте IoC или фасады вместо new Class

Внедрение классов через синтаксис new Class создает сильное сопряжение между частями приложения и усложняет тестирование. Используйте контейнер или фасады.
Плохо:
Хорошо:

Другие советы и практики

Не размещайте логику в маршрутах.
Старайтесь не использовать сырой PHP в шаблонах Blade.

Отблагодарить можно через форму справа "Donate" ... )

To reward you via the form on the right "Donate" ... )

:)

Комментариев нет :

Отправить комментарий

друзья )

Сохраняйте и делитесь желаниями, и не забывайте о важных датах! парсинг центр