Laravel Best Practices

作者 asyrafhussin1aa0ff717c10MIT86 个星标收录于 2026年10月8日更新于 2026年10月8日仓库6周前更新

Laravel 13 conventions and best practices. Use when creating controllers, models, migrations, validation, services, or structuring Laravel applications. Triggers on tasks involving Laravel architecture, Eloquent, database, API development, or PHP patterns.

AI 生成的概览

Laravel 13 编码约定与最佳实践,按架构、Eloquent、控制器、验证、安全、性能和 API 设计整理为 31 条规则。

功能
提供 Laravel 13 最佳实践的结构化参考,按规则文件划分,涵盖架构与结构、Eloquent 与数据库、控制器与路由、验证与表单请求、安全、性能以及 API 设计。每个规则文件用于包含元数据、该实践为何重要的说明,以及反例和正例代码。技能还包含一份汇总文档和按优先级排列的规则名称速查表。
适用场景
适用于编写或审查 Laravel 应用代码的场景,例如创建控制器、模型、迁移、服务或表单请求,构建 API,或决定 Laravel 项目的结构。它面向框架约定的应用,而非一般性的 PHP 问题。
运行要求
无需脚本或运行时,技能仅包含说明与规则文档。内容参照 Laravel 13 与 PHP 8.3+ 的约定,但不执行代码。

Laravel 13 Best Practices

Comprehensive best practices guide for Laravel 13 applications. Contains 31 rules across 7 categories for building scalable, maintainable Laravel applications.

When to Apply

Reference these guidelines when:

  • Creating controllers, models, and services
  • Writing migrations and database queries
  • Implementing validation and form requests
  • Building APIs with Laravel
  • Structuring Laravel applications

Rule Categories by Priority

PriorityCategoryImpactPrefix
1Architecture & StructureCRITICALarch-
2Eloquent & DatabaseCRITICALeloquent-
3Controllers & RoutingHIGHcontroller-, ctrl-
4Validation & RequestsHIGHvalidation-, valid-
5SecurityHIGHsec-
6PerformanceMEDIUMperf-
7API DesignMEDIUMapi-

Quick Reference

1. Architecture & Structure (CRITICAL)

  • arch-service-classes - Extract business logic to services
  • arch-action-classes - Single-purpose action classes
  • arch-repository-pattern - When to use repositories
  • arch-dto-pattern - Data transfer objects
  • arch-value-objects - Encapsulate domain concepts
  • arch-event-driven - Decouple with events and listeners
  • arch-feature-folders - Organize by domain/feature
  • arch-queue-routing - Centralized job queue routing (Laravel 13+)

2. Eloquent & Database (CRITICAL)

  • eloquent-eager-loading - Prevent N+1 queries
  • eloquent-chunking - Process large datasets
  • eloquent-query-scopes - Reusable query logic
  • eloquent-model-events - Use observers for side effects
  • eloquent-relationships - Define relationships properly
  • eloquent-casts - Automatic attribute casting
  • eloquent-accessors-mutators - Transform attributes
  • eloquent-soft-deletes - Safe deletion with recovery
  • eloquent-pruning - Automatic cleanup of old records
  • eloquent-vector-search - Semantic search with pgvector (Laravel 13+)

3. Controllers & Routing (HIGH)

  • controller-resource-controllers - Use resource controllers
  • controller-single-action - Single action invokable controllers
  • controller-resource-methods - RESTful resource methods
  • controller-form-requests - Use form requests
  • controller-api-resources - Transform API responses
  • controller-middleware - Apply middleware properly
  • controller-dependency-injection - Inject dependencies

4. Validation & Requests (HIGH)

  • validation-form-requests - Use form request classes
  • validation-custom-rules - Create custom rules
  • validation-conditional-rules - Conditional validation
  • validation-array-validation - Validate nested arrays
  • validation-after-hooks - Complex validation logic

5. Security (HIGH)

  • sec-mass-assignment - Protect against mass assignment

6. Performance (MEDIUM)

No rule files exist yet for this category.

7. API Design (MEDIUM)

No rule files exist yet for this category.

Essential Patterns

Controller with Form Request

php
<?php
namespace App\Http\Controllers;
use App\Http\Requests\StorePostRequest;use App\Http\Requests\UpdatePostRequest;use App\Models\Post;use Illuminate\Http\RedirectResponse;
class PostController extends Controller{    public function store(StorePostRequest $request): RedirectResponse    {        // Validation happens automatically        $validated = $request->validated();
        $post = Post::create($validated);
        return redirect()            ->route('posts.show', $post)            ->with('success', 'Post created successfully.');    }
    public function update(UpdatePostRequest $request, Post $post): RedirectResponse    {        $post->update($request->validated());
        return redirect()            ->route('posts.show', $post)            ->with('success', 'Post updated successfully.');    }}

Form Request Class

php
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class StorePostRequest extends FormRequest{    public function authorize(): bool    {        return $this->user()->can('create', Post::class);    }
    public function rules(): array    {        return [            'title' => ['required', 'string', 'max:255'],            'body' => ['required', 'string', 'min:100'],            'category_id' => ['required', 'exists:categories,id'],            'tags' => ['nullable', 'array'],            'tags.*' => ['exists:tags,id'],            'published_at' => ['nullable', 'date', 'after:now'],        ];    }
    public function messages(): array    {        return [            'body.min' => 'The post body must be at least 100 characters.',        ];    }}

Service Class Pattern

php
<?php
namespace App\Services;
use App\Models\User;use App\Models\Post;use App\Events\PostPublished;use Illuminate\Support\Facades\DB;
class PostService{    public function __construct(        private readonly NotificationService $notifications,    ) {}
    public function publish(Post $post): Post    {        return DB::transaction(function () use ($post) {            $post->update([                'published_at' => now(),                'status' => 'published',            ]);
            event(new PostPublished($post));
            $this->notifications->notifyFollowers($post->author, $post);
            return $post->fresh();        });    }}

Eloquent Model

php
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;use Illuminate\Database\Eloquent\Model;use Illuminate\Database\Eloquent\Relations\BelongsTo;use Illuminate\Database\Eloquent\Relations\BelongsToMany;use Illuminate\Database\Eloquent\Builder;
class Post extends Model{    use HasFactory;
    protected $fillable = [        'title',        'slug',        'body',        'category_id',        'published_at',    ];
    protected $casts = [        'published_at' => 'datetime',    ];
    // Relationships    public function author(): BelongsTo    {        return $this->belongsTo(User::class, 'user_id');    }
    public function category(): BelongsTo    {        return $this->belongsTo(Category::class);    }
    public function tags(): BelongsToMany    {        return $this->belongsToMany(Tag::class)->withTimestamps();    }
    // Scopes    public function scopePublished(Builder $query): Builder    {        return $query->whereNotNull('published_at')            ->where('published_at', '<=', now());    }
    public function scopeByCategory(Builder $query, int $categoryId): Builder    {        return $query->where('category_id', $categoryId);    }
    // Accessors & Mutators    protected function title(): Attribute    {        return Attribute::make(            set: fn (string $value) => ucfirst($value),        );    }}

Migration Best Practices

php
<?php
use Illuminate\Database\Migrations\Migration;use Illuminate\Database\Schema\Blueprint;use Illuminate\Support\Facades\Schema;
return new class extends Migration{    public function up(): void    {        Schema::create('posts', function (Blueprint $table) {            $table->id();            $table->foreignId('user_id')->constrained()->cascadeOnDelete();            $table->foreignId('category_id')->constrained()->cascadeOnDelete();            $table->string('title');            $table->string('slug')->unique();            $table->text('body');            $table->timestamp('published_at')->nullable();            $table->timestamps();
            // Indexes for common queries            $table->index(['user_id', 'published_at']);            $table->index('category_id');        });    }
    public function down(): void    {        Schema::dropIfExists('posts');    }};

Eager Loading

php
// N+1 Problem$posts = Post::all();foreach ($posts as $post) {    echo $post->author->name;  // Query per post}
// Eager loading — only 3 queries total$posts = Post::with(['author', 'category', 'tags'])->get();foreach ($posts as $post) {    echo $post->author->name;  // No additional queries}
// Nested eager loading$posts = Post::with([    'author.profile',    'comments.user',    'tags',])->get();
// Constrained eager loading$posts = Post::with([    'comments' => fn ($query) => $query->latest()->limit(5),])->get();

How to Use

Read individual rule files for detailed explanations and code examples:

rules/arch-service-classes.mdrules/eloquent-eager-loading.mdrules/validation-form-requests.mdrules/_sections.md

Each rule file contains:

  • YAML frontmatter with metadata (title, impact, tags)
  • Brief explanation of why it matters
  • Bad Example with explanation
  • Good Example with explanation
  • Laravel 13 and PHP 8.3 specific context and references

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

来源与署名

来源:asyrafhussin/agent-skills位于skills/laravel-best-practices提交1aa0ff7

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架