padrões-laravel

Padrões de Desenvolvimento Laravel

Padrões de arquitetura Laravel de nível de produção para aplicações escaláveis e sustentáveis.

Quando Usar

• Construindo aplicações web Laravel ou APIs
• Estruturando controladores, serviços e lógica de domínio
• Trabalhando com modelos Eloquent e relacionamentos
• Projetando APIs com recursos e paginação
• Adicionando filas, eventos, cache e jobs em segundo plano

Como Funciona

• Estruture o aplicativo em torno de limites claros (controladores -> serviços/ações -> modelos).
• Use bindings explícitos e com escopo para manter o roteamento previsível; ainda assim, aplique autorização para controle de acesso.
• Prefira modelos tipados, casts e escopos para manter a lógica de domínio consistente.
• Mantenha trabalhos pesados de I/O em filas e armazene em cache leituras caras.
• Centralize a configuração em config/* e mantenha os ambientes explícitos.

Exemplos

Estrutura do Projeto

Use um layout Laravel convencional com limites de camada claros (HTTP, serviços/ações, modelos).

Layout Recomendado

app/
├── Actions/            # Casos de uso de propósito único
├── Console/
├── Events/
├── Exceptions/
├── Http/
│   ├── Controllers/
│   ├── Middleware/
│   ├── Requests/       # Validação de Form Request
│   └── Resources/      # Recursos de API
├── Jobs/
├── Models/
├── Policies/
├── Providers/
├── Services/           # Serviços de coordenação de domínio
└── Support/
config/
database/
├── factories/
├── migrations/
└── seeders/
resources/
├── views/
└── lang/
routes/
├── api.php
├── web.php
└── console.php

Controladores -> Serviços -> Ações

Mantenha os controladores enxutos. Coloque a orquestração em serviços e a lógica de propósito único em ações.

final class CreateOrderAction
{
    public function __construct(private OrderRepository $orders) {}

    public function handle(CreateOrderData $data): Order
    {
        return $this->orders->create($data);
    }
}

final class OrdersController extends Controller
{
    public function __construct(private CreateOrderAction $createOrder) {}

    public function store(StoreOrderRequest $request): JsonResponse
    {
        $order = $this->createOrder->handle($request->toDto());

        return response()->json([
            'success' => true,
            'data' => OrderResource::make($order),
            'error' => null,
            'meta' => null,
        ], 201);
    }
}

Roteamento e Controladores

Prefira route-model binding e controladores de recurso para clareza.

use Illuminate\Support\Facades\Route;

Route::middleware('auth:sanctum')->group(function () {
    Route::apiResource('projects', ProjectController::class);
});

Route Model Binding com Escopo

Use bindings com escopo para evitar acesso cross-tenant.

Route::scopeBindings()->group(function () {
    Route::get('/accounts/{account}/projects/{project}', [ProjectController::class, 'show']);
});

Rotas Aninhadas e Nomes de Binding

• Mantenha prefixos e caminhos consistentes para evitar dupla aninhamento (ex.: conversation vs conversations).
• Use um único nome de parâmetro que corresponda ao modelo vinculado (ex.: {conversation} para Conversation).
• Prefira bindings com escopo ao aninhar para reforçar relacionamentos pai-filho.

use App\Http\Controllers\Api\ConversationController;
use App\Http\Controllers\Api\MessageController;
use Illuminate\Support\Facades\Route;

Route::middleware('auth:sanctum')->prefix('conversations')->group(function () {
    Route::post('/', [ConversationController::class, 'store'])->name('conversations.store');

    Route::scopeBindings()->group(function () {
        Route::get('/{conversation}', [ConversationController::class, 'show'])
            ->name('conversations.show');

        Route::post('/{conversation}/messages', [MessageController::class, 'store'])
            ->name('conversation-messages.store');

        Route::get('/{conversation}/messages/{message}', [MessageController::class, 'show'])
            ->name('conversation-messages.show');
    });
});

Se você quiser que um parâmetro resolva para uma classe de modelo diferente, defina um binding explícito. Para lógica de binding personalizada, use Route::bind() ou implemente resolveRouteBinding() no modelo.

use App\Models\AiConversation;
use Illuminate\Support\Facades\Route;

Route::model('conversation', AiConversation::class);

Bindings do Service Container

Vincule interfaces a implementações em um service provider para uma clara fiação de dependências.

use App\Repositories\EloquentOrderRepository;
use App\Repositories\OrderRepository;
use Illuminate\Support\ServiceProvider;

final class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->bind(OrderRepository::class, EloquentOrderRepository::class);
    }
}

Padrões de Modelo Eloquent

Configuração do Modelo

final class Project extends Model
{
    use HasFactory;

    protected $fillable = ['name', 'owner_id', 'status'];

    protected $casts = [
        'status' => ProjectStatus::class,
        'archived_at' => 'datetime',
    ];

    public function owner(): BelongsTo
    {
        return $this->belongsTo(User::class, 'owner_id');
    }

    public function scopeActive(Builder $query): Builder
    {
        return $query->whereNull('archived_at');
    }
}

Casts Personalizados e Objetos de Valor

Use enums ou objetos de valor para tipagem estrita.

use Illuminate\Database\Eloquent\Casts\Attribute;

protected $casts = [
    'status' => ProjectStatus::class,
];

protected function budgetCents(): Attribute
{
    return Attribute::make(
        get: fn (int $value) => Money::fromCents($value),
        set: fn (Money $money) => $money->toCents(),
    );
}

Eager Loading para Evitar N+1

$orders = Order::query()
    ->with(['customer', 'items.product'])
    ->latest()
    ->paginate(25);

Objetos de Consulta para Filtros Complexos

final class ProjectQuery
{
    public function __construct(private Builder $query) {}

    public function ownedBy(int $userId): self
    {
        $query = clone $this->query;

        return new self($query->where('owner_id', $userId));
    }

    public function active(): self
    {
        $query = clone $this->query;

        return new self($query->whereNull('archived_at'));
    }

    public function builder(): Builder
    {
        return $this->query;
    }
}

Escopos Globais e Soft Deletes

Use escopos globais para filtragem padrão e SoftDeletes para registros recuperáveis. Use um escopo global ou um escopo nomeado para o mesmo filtro, não ambos, a menos que você pretenda um comportamento em camadas.

use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Database\Eloquent\Builder;

final class Project extends Model
{
    use SoftDeletes;

    protected static function booted(): void
    {
        static::addGlobalScope('active', function (Builder $builder): void {
            $builder->whereNull('archived_at');
        });
    }
}

Escopos de Consulta para Filtros Reutilizáveis

use Illuminate\Database\Eloquent\Builder;

final class Project extends Model
{
    public function scopeOwnedBy(Builder $query, int $userId): Builder
    {
        return $query->where('owner_id', $userId);
    }
}

// Em serviço, repositório etc.
$projects = Project::ownedBy($user->id)->get();

Transações para Atualizações Multi-etapas

use Illuminate\Support\Facades\DB;

DB::transaction(function (): void {
    $order->update(['status' => 'paid']);
    $order->items()->update(['paid_at' => now()]);
});

Migrações

Convenção de Nomenclatura

• Nomes de arquivos usam timestamps: YYYY_MM_DD_HHMMSS_create_users_table.php
• Migrações usam classes anônimas (sem classe nomeada); o nome do arquivo comunica a intenção
• Nomes de tabela são snake_case e no plural por padrão

Exemplo de Migração

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('orders', function (Blueprint $table): void {
            $table->id();
            $table->foreignId('customer_id')->constrained()->cascadeOnDelete();
            $table->string('status', 32)->index();
            $table->unsignedInteger('total_cents');
            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('orders');
    }
};

Form Requests e Validação

Mantenha a validação em form requests e transforme entradas em DTOs.

use App\Models\Order;

final class StoreOrderRequest extends FormRequest
{
    public function authorize(): bool
    {
        return $this->user()?->can('create', Order::class) ?? false;
    }

    public function rules(): array
    {
        return [
            'customer_id' => ['required', 'integer', 'exists:customers,id'],
            'items' => ['required', 'array', 'min:1'],
            'items.*.sku' => ['required', 'string'],
            'items.*.quantity' => ['required', 'integer', 'min:1'],
        ];
    }

    public function toDto(): CreateOrderData
    {
        return new CreateOrderData(
            customerId: (int) $this->validated('customer_id'),
            items: $this->validated('items'),
        );
    }
}

Recursos de API

Mantenha as respostas da API consistentes com recursos e paginação.

$projects = Project::query()->active()->paginate(25);

return response()->json([
    'success' => true,
    'data' => ProjectResource::collection($projects->items()),
    'error' => null,
    'meta' => [
        'page' => $projects->currentPage(),
        'per_page' => $projects->perPage(),
        'total' => $projects->total(),
    ],
]);

Eventos, Jobs e Filas

• Emita eventos de domínio para efeitos colaterais (emails, analytics)
• Use jobs em fila para trabalhos lentos (relatórios, exportações, webhooks)
• Prefira handlers idempotentes com retentativas e backoff

Cache

• Armazene em cache endpoints com muita leitura e consultas caras
• Invalide caches em eventos de modelo (created/updated/deleted)
• Use tags ao armazenar dados relacionados em cache para invalidação fácil

Configuração e Ambientes

• Mantenha segredos em .env e configuração em config/*.php
• Use sobrescritas de configuração por ambiente e config:cache em produção