Eloquent: 시작하기

업데이트됨

번역일: 2026년 10월 3일

이 페이지는 원문이 업데이트되어 번역이 갱신되었습니다.

원문 수정: 2026년 10월 3일
번역 갱신: 2026년 10월 3일

Eloquent: 시작하기

소개
모델 클래스 생성하기
Eloquent 모델 컨벤션
모델 조회하기
단일 모델 / 집계 값 조회하기
- 모델 조회 또는 생성하기
- 집계 값 조회하기
모델 삽입 및 수정하기
- 삽입
- 수정
- 대량 할당
- Upsert
모델 삭제하기
- 소프트 삭제
- 소프트 삭제된 모델 조회하기
모델 정리하기
모델 복제하기
쿼리 스코프
모델 비교하기
이벤트

Eloquent ORM

소개

Laravel에는 데이터베이스와 상호작용하는 과정을 즐겁게 만들어주는 객체 관계 매퍼(ORM)인 Eloquent가 포함되어 있습니다. Eloquent를 사용하면 데이터베이스의 각 테이블마다 해당 테이블과 상호작용하는 데 사용되는 "모델"이 존재하게 됩니다. Eloquent 모델을 이용하면 테이블에서 레코드를 조회하는 것뿐만 아니라, 레코드를 추가(insert), 수정(update), 삭제(delete)하는 작업도 수행할 수 있습니다.

NOTE

시작하기 전에 애플리케이션의 config/database.php 설정 파일에서 데이터베이스 연결을 먼저 구성해야 합니다. 데이터베이스 설정에 대한 자세한 내용은 데이터베이스 설정 문서를 참고하세요.

Eloquent ORM

모델 클래스 생성하기

먼저 Eloquent 모델을 하나 만들어 보겠습니다. 모델은 보통 app\Models 디렉터리에 위치하며, Illuminate\Database\Eloquent\Model 클래스를 상속받습니다. 새로운 모델을 생성할 때는 make:model Artisan 명령어를 사용하면 됩니다:

php artisan make:model Flight

모델을 생성하면서 동시에 데이터베이스 마이그레이션 파일도 함께 만들고 싶다면, --migration 또는 -m 옵션을 사용하세요:

php artisan make:model Flight --migration

모델을 생성할 때 팩토리, 시더, 정책(policy), 컨트롤러, 폼 리퀘스트 등 다양한 관련 클래스도 함께 생성할 수 있습니다. 또한 아래처럼 여러 옵션을 조합해서 한 번에 여러 클래스를 만드는 것도 가능합니다:

# 모델과 FlightFactory 클래스를 함께 생성...
php artisan make:model Flight --factory
php artisan make:model Flight -f

# 모델과 FlightSeeder 클래스를 함께 생성...
php artisan make:model Flight --seed
php artisan make:model Flight -s

# 모델과 FlightController 클래스를 함께 생성...
php artisan make:model Flight --controller
php artisan make:model Flight -c

# 모델, FlightController 리소스 클래스, 폼 리퀘스트 클래스를 함께 생성...
php artisan make:model Flight --controller --resource --requests
php artisan make:model Flight -crR

# 모델과 FlightPolicy 클래스를 함께 생성...
php artisan make:model Flight --policy

# 모델, 마이그레이션, 팩토리, 시더, 컨트롤러를 함께 생성...
php artisan make:model Flight -mfsc

<h1 id="inspecting-models">모델, 마이그레이션, 팩토리, 시더, 정책, 컨트롤러, 폼 리퀘스트를 한 번에 생성하는 단축 옵션...</h1>
php artisan make:model Flight --all
php artisan make:model Flight -a

<h1 id="eloquent-model-conventions">피벗(pivot) 모델 생성...</h1>
php artisan make:model Member --pivot
php artisan make:model Member -p

NOTE

옵션이 많아서 처음에는 외우기 어려울 수 있습니다. php artisan make:model --help 명령어로 언제든 전체 옵션 목록을 확인할 수 있으니, 필요할 때마다 참고하는 것을 추천합니다.

모델 살펴보기

코드만 훑어봐서는 모델이 어떤 속성(attribute)과 연관관계(relationship)를 갖고 있는지 한눈에 파악하기 어려운 경우가 많습니다. 이럴 때는 model:show Artisan 명령어를 사용해 보세요. 모델의 속성과 연관관계를 한눈에 정리해서 보여줍니다:

php artisan model:show Flight

Eloquent 모델 규칙

make:model 명령어로 생성된 모델은 app/Models 디렉터리에 위치합니다. 기본적인 모델 클래스를 살펴보면서 Eloquent의 핵심 규칙들을 하나씩 짚어보겠습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    // ...
}

테이블 이름

위 예제를 보면 Flight 모델이 어떤 데이터베이스 테이블과 연결되는지 따로 지정하지 않았다는 걸 눈치채셨을 겁니다. Eloquent는 관례적으로 클래스 이름을 "스네이크 케이스(snake_case)"로 바꾸고 복수형으로 만든 이름을 테이블명으로 사용합니다. 즉, Flight 모델은 별도 설정이 없다면 flights 테이블을 사용한다고 가정하며, AirTrafficController 모델이라면 air_traffic_controllers 테이블을 사용한다고 가정합니다.

NOTE

예를 들어 Category라는 모델을 만들면 Eloquent는 자동으로 categories 테이블을 찾습니다. 이런 네이밍 규칙 덕분에 별도의 설정 없이도 모델과 테이블이 자연스럽게 연결됩니다.

모델에 대응하는 테이블 이름이 이 규칙과 다르다면, Table 속성(attribute)을 사용해 테이블 이름을 직접 지정할 수 있습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Model;

#[Table('my_flights')]
class Flight extends Model
{
    // ...
}

기본 키(Primary Key)

Eloquent는 또한 각 모델의 테이블에 id라는 이름의 기본 키 컬럼이 있다고 가정합니다. 필요하다면 Table 속성의 key 인자를 사용해 기본 키로 사용할 컬럼을 다르게 지정할 수 있습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Model;

#[Table(key: 'flight_id')]
class Flight extends Model
{
    // ...
}

또한 Eloquent는 기본 키가 자동 증가하는 정수값이라고 가정하기 때문에, 기본 키 값을 자동으로 정수로 캐스팅합니다. 자동 증가가 아니거나 숫자가 아닌 기본 키를 사용하려면 Table 속성의 keyType과 incrementing 인자를 지정해야 합니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Model;

#[Table(key: 'uuid', keyType: 'string', incrementing: false)]
class Flight extends Model
{
    // ...
}

자동 증가 ID만 비활성화하면 된다면 WithoutIncrementing 속성을 사용할 수 있습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\WithoutIncrementing;
use Illuminate\Database\Eloquent\Model;

#[WithoutIncrementing]
class Flight extends Model
{
    // ...
}

"복합(Composite)" 기본 키

Eloquent 모델은 기본 키로 사용할 수 있는 고유 식별자("ID")를 반드시 하나는 가지고 있어야 합니다. 여러 컬럼을 조합한 "복합" 기본 키는 Eloquent 모델에서 지원하지 않습니다. 다만 테이블의 기본 키와는 별개로, 여러 컬럼을 묶은 고유(unique) 인덱스를 추가하는 것은 자유롭게 가능합니다.

UUID와 ULID 키

Eloquent 모델의 기본 키로 자동 증가하는 정수 대신 UUID를 사용할 수도 있습니다. UUID는 36자리 길이의 전역적으로 고유한 영숫자 식별자입니다.

모델에서 자동 증가 정수 키 대신 UUID 키를 사용하고 싶다면, 모델에 Illuminate\Database\Eloquent\Concerns\HasUuids 트레이트를 사용하면 됩니다. 이때 모델의 테이블에는 UUID에 대응하는 기본 키 컬럼이 있어야 합니다.

use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
    use HasUuids;

    // ...
}

$article = Article::create(['title' => '유럽 여행기']);

$article->id; // "018f2b5c-6a7f-7b12-9d6f-2f8a4e0c9c11"

HasUuids 트레이트는 기본적으로 UUIDv7 식별자를 생성합니다. UUIDv7은 사전순(lexicographic)으로 정렬이 가능하기 때문에, 인덱싱된 데이터베이스 저장 방식에서 더 효율적입니다.

모델에 newUniqueId 메서드를 정의하면 UUID 생성 방식을 직접 재정의할 수 있습니다. 또한 uniqueIds 메서드를 정의하면 어떤 컬럼에 UUID를 적용할지도 지정할 수 있습니다.

use Ramsey\Uuid\Uuid;

/**
 * 모델을 위한 새로운 UUID를 생성합니다.
 */
public function newUniqueId(): string
{
    return (string) Uuid::uuid4();
}

/**
 * 고유 식별자를 적용할 컬럼 목록을 가져옵니다.
 *
 * @return array<int, string>
 */
public function uniqueIds(): array
{
    return ['id', 'discount_code'];
}

UUID 대신 "ULID"를 사용하고 싶다면 그렇게 할 수도 있습니다. ULID는 UUID와 비슷하지만 길이가 26자로 더 짧습니다. 정렬 가능한 UUID와 마찬가지로 ULID도 사전순 정렬이 가능해 데이터베이스 인덱싱에 효율적입니다. ULID를 사용하려면 모델에 Illuminate\Database\Eloquent\Concerns\HasUlids 트레이트를 사용하면 됩니다. 이때도 모델 테이블에 ULID에 대응하는 기본 키 컬럼이 있어야 합니다.

use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
    use HasUlids;

    // ...
}

$article = Article::create(['title' => '아시아 여행기']);

$article->id; // "01gd4d3tgrrfqeda94gdbtdk5c"

타임스탬프

Eloquent는 기본적으로 모델이 연결된 테이블에 created_at과 updated_at 컬럼이 존재한다고 가정합니다. 모델이 생성되거나 수정될 때 Eloquent가 이 컬럼의 값을 자동으로 채워줍니다. 이 컬럼들을 Eloquent가 자동으로 관리하지 않길 원한다면, 모델의 Table 속성에서 timestamps를 false로 설정하면 됩니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Model;

#[Table(timestamps: false)]
class Flight extends Model
{
    // ...
}

타임스탬프만 비활성화하면 된다면 WithoutTimestamps 속성을 사용할 수 있습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\WithoutTimestamps;
use Illuminate\Database\Eloquent\Model;

#[WithoutTimestamps]
class Flight extends Model
{
    // ...
}

모델의 타임스탬프 형식을 커스터마이징해야 한다면, Table 속성의 dateFormat 인자를 사용하세요. 이 값은 날짜 속성이 데이터베이스에 저장되는 형식을 결정합니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Model;

#[Table(dateFormat: 'U')]
class Flight extends Model
{
    // ...
}

날짜 형식만 따로 지정하면 된다면 DateFormat 속성을 사용할 수 있습니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\DateFormat;
use Illuminate\Database\Eloquent\Model;

#[DateFormat('U')]
class Flight extends Model
{
    // ...
}

타임스탬프를 저장하는 컬럼명 자체를 변경해야 한다면, 모델에 CREATED_AT과 UPDATED_AT 상수를 정의하면 됩니다.

<?php

class Flight extends Model
{
    /**
     * "생성일시" 컬럼의 이름
     *
     * @var string|null
     */
    public const CREATED_AT = 'creation_date';

    /**
     * "수정일시" 컬럼의 이름
     *
     * @var string|null
     */
    public const UPDATED_AT = 'updated_date';
}

모델의 updated_at 타임스탬프를 변경하지 않으면서 모델 작업을 수행하고 싶다면, withoutTimestamps 메서드에 클로저를 전달해 그 안에서 작업을 수행할 수 있습니다.

Model::withoutTimestamps(fn () => $post->increment('reads'));

데이터베이스 커넥션

기본적으로 모든 Eloquent 모델은 애플리케이션에 설정된 기본 데이터베이스 커넥션을 사용합니다. 특정 모델에 대해 다른 커넥션을 사용하고 싶다면 Connection 속성을 사용하면 됩니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Connection;
use Illuminate\Database\Eloquent\Model;

#[Connection('mysql')]
class Flight extends Model
{
    // ...
}

속성 기본값

기본적으로 새로 생성한 모델 인스턴스에는 어떤 속성 값도 들어있지 않습니다. 모델의 일부 속성에 기본값을 지정하고 싶다면 모델에 $attributes 프로퍼티를 정의하면 됩니다. $attributes 배열에 넣는 값은 데이터베이스에서 막 읽어온 것처럼, 가공되지 않은 "저장 가능한" 원본 형식이어야 합니다.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * 모델 속성의 기본값
     *
     * @var array<string, mixed>
     */
    protected $attributes = [
        'options' => '[]',
        'delayed' => false,
    ];
}

저장 후 속성 새로고침

데이터베이스에 생성된(generated) 컬럼이 있는 경우, 모델을 삽입하거나 수정한 뒤 특정 속성을 데이터베이스 값으로 다시 새로고침하도록 Eloquent를 설정할 수 있습니다. 이를 위해 모델에 Refreshes 속성을 정의하세요.

use Illuminate\Database\Eloquent\Attributes\Refreshes;

#[Refreshes('name')]
class User extends Model
{
    // ...
}

여러 속성을 배열로 지정할 수도 있습니다.

#[Refreshes(['name', 'slug'])]

모델이 저장(write)된 이후, 설정된 속성들은 데이터베이스로부터 값을 다시 읽어와 새로고침됩니다.

Eloquent 엄격성(Strictness) 설정

Laravel은 다양한 상황에서 Eloquent의 동작과 "엄격함" 수준을 조정할 수 있는 여러 메서드를 제공합니다.

먼저 preventLazyLoading 메서드는 지연 로딩(lazy loading)을 막을지 여부를 나타내는 boolean 인자를 선택적으로 받습니다. 예를 들어 운영 환경이 아닌 곳에서만 지연 로딩을 비활성화하고 싶을 수 있는데, 이렇게 하면 운영 환경 코드에 실수로 지연 로딩 관계가 남아 있더라도 애플리케이션이 정상적으로 동작하게 할 수 있습니다. 이 메서드는 보통 애플리케이션의 AppServiceProvider의 boot 메서드에서 호출합니다.

use Illuminate\Database\Eloquent\Model;

/**
 * 애플리케이션 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    Model::preventLazyLoading(! $this->app->isProduction());
}

또한 preventSilentlyDiscardingAttributes 메서드를 호출하면, 채울 수 없는(unfillable) 속성을 채우려고 할 때 예외를 던지도록 설정할 수 있습니다. 이는 모델의 fillable 배열에 추가되지 않은 속성을 실수로 설정하려고 할 때, 로컬 개발 환경에서 예상치 못한 오류를 미리 발견하는 데 도움이 됩니다.

Model::preventSilentlyDiscardingAttributes(! $this->app->isProduction());

NOTE

preventSilentlyDiscardingAttributes를 켜두면, 오타로 인해 fillable 배열에 없는 필드에 값을 대입하는 실수를 즉시 예외로 알 수 있어 디버깅 시간을 크게 줄여줍니다.

모델 조회하기

모델과 그에 연결된 데이터베이스 테이블을 만들었다면, 이제 데이터베이스에서 데이터를 조회할 준비가 된 것입니다. Eloquent 모델은 모델에 연결된 데이터베이스 테이블을 자유자재로 조회할 수 있는, 강력한 쿼리 빌더라고 생각하면 됩니다. all 메서드를 호출하면 모델에 연결된 테이블의 모든 레코드를 가져올 수 있습니다.

use App\Models\Flight;

foreach (Flight::all() as $flight) {
    echo $flight->name;
}

쿼리 작성하기

all 메서드는 테이블의 모든 결과를 반환합니다. 하지만 Eloquent 모델 자체가 쿼리 빌더 역할을 하기 때문에, 쿼리에 조건을 추가한 뒤 get 메서드를 호출해서 원하는 결과만 가져올 수도 있습니다.

$flights = Flight::where('active', 1)
    ->orderBy('name')
    ->limit(10)
    ->get();

NOTE

Eloquent 모델은 곧 쿼리 빌더이므로, Laravel 쿼리 빌더가 제공하는 모든 메서드를 한 번 훑어보시길 권장합니다. 쿼리 빌더의 메서드는 Eloquent 쿼리를 작성할 때도 그대로 사용할 수 있습니다.

모델 새로고침하기

데이터베이스에서 조회해온 Eloquent 모델 인스턴스를 이미 가지고 있다면, fresh와 refresh 메서드로 모델을 "새로고침"할 수 있습니다. fresh 메서드는 데이터베이스에서 모델을 다시 조회해서 새로운 인스턴스로 반환합니다. 기존 모델 인스턴스는 전혀 영향을 받지 않습니다.

$flight = Flight::where('number', 'FR 900')->first();

$freshFlight = $flight->fresh();

반면 refresh 메서드는 기존 모델 인스턴스 자체를 데이터베이스의 최신 데이터로 다시 채웁니다. 이때 이미 로드된 연관관계도 함께 새로고침됩니다.

$flight = Flight::where('number', 'FR 900')->first();

$flight->number = 'FR 456';

$flight->refresh();

$flight->number; // "FR 900"

트랜잭션 안에서 모델을 새로고침하면서 비관적 락(pessimistic lock)까지 걸어야 한다면 refreshForUpdate 메서드를 사용하세요. 이 메서드는 FOR UPDATE 락을 사용해서 모델을 다시 로드합니다.

DB::transaction(function () use ($flight) {
    $flight->refreshForUpdate();

    // 락이 걸린 모델을 업데이트...
});

컬렉션

지금까지 살펴본 all이나 get처럼 여러 레코드를 조회하는 Eloquent 메서드들은 평범한 PHP 배열을 반환하지 않습니다. 대신 Illuminate\Database\Eloquent\Collection 인스턴스를 반환합니다.

Eloquent의 Collection 클래스는 Laravel의 기본 Illuminate\Support\Collection 클래스를 확장한 것으로, 데이터 컬렉션을 다루는 데 유용한 다양한 메서드를 제공합니다. 예를 들어 reject 메서드를 사용하면 클로저의 실행 결과에 따라 컬렉션에서 특정 모델을 제외할 수 있습니다.

$flights = Flight::where('destination', 'Paris')->get();

$flights = $flights->reject(function (Flight $flight) {
    return $flight->cancelled;
});

Eloquent 컬렉션 클래스는 기본 컬렉션 클래스가 제공하는 메서드 외에도, Eloquent 모델 컬렉션을 다루기 위한 추가 메서드 몇 가지를 더 제공합니다.

Laravel의 모든 컬렉션은 PHP의 반복(iterable) 인터페이스를 구현하므로, 배열처럼 foreach 문으로 순회할 수 있습니다.

foreach ($flights as $flight) {
    echo $flight->name;
}

결과를 청크 단위로 처리하기

all이나 get 메서드로 수만 건에 달하는 Eloquent 레코드를 한 번에 불러오려고 하면 메모리가 부족해질 수 있습니다. 이럴 때는 chunk 메서드를 사용해서 대량의 모델을 훨씬 효율적으로 처리할 수 있습니다.

chunk 메서드는 Eloquent 모델을 일정 단위("청크")로 나눠서 조회한 뒤, 각 청크를 클로저에 전달해서 처리합니다. 한 번에 현재 청크 분량의 모델만 메모리에 올라가기 때문에, 많은 수의 모델을 다룰 때 메모리 사용량을 크게 줄일 수 있습니다.

use App\Models\Flight;
use Illuminate\Database\Eloquent\Collection;

Flight::chunk(200, function (Collection $flights) {
    foreach ($flights as $flight) {
        // ...
    }
});

chunk 메서드의 첫 번째 인자는 한 청크당 가져올 레코드 개수이고, 두 번째 인자로 전달하는 클로저는 데이터베이스에서 청크를 조회할 때마다 호출됩니다. 즉, 청크 하나당 쿼리가 한 번씩 실행됩니다.

만약 반복 처리 중에 업데이트할 컬럼을 기준으로 chunk의 결과를 필터링하고 있다면 chunkById 메서드를 사용해야 합니다. 이런 상황에서 chunk를 그대로 사용하면 예상과 다른 결과나 일관성 없는 결과가 나올 수 있습니다. chunkById는 내부적으로 항상 이전 청크의 마지막 모델보다 id 컬럼 값이 큰 모델들을 조회합니다.

Flight::where('departed', true)
    ->chunkById(200, function (Collection $flights) {
        $flights->each->update(['departed' => false]);
    }, column: 'id');

chunkById와 lazyById 메서드는 실행되는 쿼리에 자체적으로 where 조건을 추가하기 때문에, 여러분이 직접 작성하는 조건은 보통 클로저로 논리적으로 그룹화해주는 것이 좋습니다.

Flight::where(function ($query) {
    $query->where('delayed', true)->orWhere('cancelled', true);
})->chunkById(200, function (Collection $flights) {
    $flights->each->update([
        'departed' => false,
        'cancelled' => true
    ]);
}, column: 'id');

Lazy 컬렉션으로 청크 처리하기

lazy 메서드는 내부적으로 쿼리를 청크 단위로 실행한다는 점에서 chunk 메서드와 비슷하게 동작합니다. 다만 각 청크를 콜백에 바로 전달하는 대신, lazy 메서드는 평탄화된(flattened) LazyCollection을 반환해서 전체 결과를 하나의 스트림처럼 다룰 수 있게 해줍니다.

use App\Models\Flight;

foreach (Flight::lazy() as $flight) {
    // ...
}

반복 처리 중에 업데이트할 컬럼을 기준으로 lazy의 결과를 필터링하고 있다면 lazyById 메서드를 사용해야 합니다. lazyById는 내부적으로 항상 이전 청크의 마지막 모델보다 id 컬럼 값이 큰 모델들을 조회합니다.

Flight::where('departed', true)
    ->lazyById(200, column: 'id')
    ->each->update(['departed' => false]);

id의 내림차순을 기준으로 결과를 필터링하고 싶다면 lazyByIdDesc 메서드를 사용하면 됩니다.

커서(Cursor)

cursor 메서드 역시 lazy와 마찬가지로, 수만 건의 Eloquent 레코드를 순회할 때 애플리케이션의 메모리 사용량을 크게 줄여줍니다.

cursor 메서드는 데이터베이스 쿼리를 단 한 번만 실행합니다. 하지만 개별 Eloquent 모델은 실제로 순회(iterate)되는 시점에야 객체로 생성(hydrate)됩니다. 따라서 커서를 순회하는 동안에는 어느 시점이든 단 하나의 Eloquent 모델만 메모리에 유지됩니다.

WARNING

cursor 메서드는 한 번에 단 하나의 Eloquent 모델만 메모리에 유지하기 때문에 연관관계를 즉시 로딩(eager load)할 수 없습니다. 연관관계를 즉시 로딩해야 한다면 lazy 메서드 사용을 고려하세요.

내부적으로 cursor 메서드는 이러한 동작을 구현하기 위해 PHP의 제너레이터(generator)를 사용합니다.

use App\Models\Flight;

foreach (Flight::where('destination', 'Zurich')->cursor() as $flight) {
    // ...
}

cursor는 Illuminate\Support\LazyCollection 인스턴스를 반환합니다. Lazy 컬렉션을 사용하면 한 번에 모델 하나만 메모리에 로드하면서도, 일반적인 Laravel 컬렉션에서 쓸 수 있는 다양한 메서드를 그대로 활용할 수 있습니다.

use App\Models\User;

$users = User::cursor()->filter(function (User $user) {
    return $user->id > 500;
});

foreach ($users as $user) {
    echo $user->id;
}

cursor 메서드는 한 번에 Eloquent 모델 하나만 메모리에 유지하기 때문에 일반적인 쿼리보다 훨씬 적은 메모리를 사용하지만, 그럼에도 불구하고 결국에는 메모리가 부족해질 수 있습니다. 이는 PHP의 PDO 드라이버가 내부적으로 모든 원시 쿼리 결과를 자체 버퍼에 캐싱하기 때문입니다. 매우 많은 수의 Eloquent 레코드를 다뤄야 한다면 lazy 메서드 사용을 고려해보세요.

고급 서브쿼리

서브쿼리 Select

Eloquent는 고급 서브쿼리 기능도 지원해서, 연관된 테이블의 정보를 단 한 번의 쿼리로 가져올 수 있습니다. 예를 들어 목적지 정보를 담은 destinations 테이블과, 각 목적지로 향하는 항공편 정보를 담은 flights 테이블이 있다고 가정해봅시다. flights 테이블에는 해당 항공편이 목적지에 도착한 시각을 나타내는 arrived_at 컬럼이 있습니다.

쿼리 빌더의 select와 addSelect 메서드에서 제공하는 서브쿼리 기능을 사용하면, 단 한 번의 쿼리로 모든 destinations와 각 목적지에 가장 최근에 도착한 항공편의 이름을 함께 조회할 수 있습니다.

use App\Models\Destination;
use App\Models\Flight;

return Destination::addSelect(['last_flight' => Flight::select('name')
    ->whereColumn('destination_id', 'destinations.id')
    ->orderByDesc('arrived_at')
    ->limit(1)
])->get();

서브쿼리 정렬

이 외에도 쿼리 빌더의 orderBy 함수 역시 서브쿼리를 지원합니다. 앞서의 항공편 예제를 계속 활용해서, 각 목적지에 마지막 항공편이 도착한 시각을 기준으로 모든 목적지를 정렬할 수 있습니다. 이 역시 단 한 번의 데이터베이스 쿼리로 처리됩니다.

return Destination::orderByDesc(
    Flight::select('arrived_at')
        ->whereColumn('destination_id', 'destinations.id')
        ->orderByDesc('arrived_at')
        ->limit(1)
)->get();

Eloquent ORM

단일 모델 / 집계 값 조회하기

조건에 맞는 모든 레코드를 조회하는 것 외에도, find, first, firstWhere 메서드를 사용하면 단일 레코드를 조회할 수 있습니다. 이 메서드들은 컬렉션이 아니라 모델 인스턴스 하나를 반환합니다:

use App\Models\Flight;

// 기본 키로 모델을 조회...
$flight = Flight::find(1);

// 쿼리 조건에 맞는 첫 번째 모델을 조회...
$flight = Flight::where('active', 1)->first();

// 위와 동일한 결과를 얻는 다른 방법...
$flight = Flight::firstWhere('active', 1);

조회 결과가 없을 때 별도의 처리를 하고 싶은 경우도 있을 것입니다. findOr와 firstOr 메서드는 모델 인스턴스를 반환하되, 결과가 없으면 전달된 클로저를 실행합니다. 이때 클로저의 반환 값이 메서드의 최종 결과가 됩니다:

$flight = Flight::findOr(1, function () {
    // ...
});

$flight = Flight::where('legs', '>', 3)->firstOr(function () {
    // ...
});

모델을 찾지 못했을 때 예외 발생시키기

경우에 따라 모델을 찾지 못했을 때 예외를 던지고 싶을 수도 있습니다. 특히 라우트나 컨트롤러에서 유용합니다. findOrFail과 firstOrFail 메서드는 쿼리의 첫 번째 결과를 조회하는데, 결과가 없으면 Illuminate\Database\Eloquent\ModelNotFoundException 예외를 발생시킵니다:

$flight = Flight::findOrFail(1);

$flight = Flight::where('legs', '>', 3)->firstOrFail();

ModelNotFoundException을 별도로 처리(catch)하지 않으면, 클라이언트에게 자동으로 404 HTTP 응답이 전송됩니다:

use App\Models\Flight;

Route::get('/api/flights/{id}', function (string $id) {
    return Flight::findOrFail($id);
});

NOTE

이 동작은 Laravel의 예외 핸들러가 ModelNotFoundException을 404 응답으로 자동 변환해주기 때문에 가능합니다. 별도의 try-catch 처리 없이도 API 라우트에서 깔끔하게 "찾을 수 없음" 응답을 보낼 수 있다는 점을 기억해두면 유용합니다.

모델 조회 후 없으면 생성하기

firstOrCreate 메서드는 주어진 컬럼 / 값 쌍으로 데이터베이스에서 레코드를 찾습니다. 해당 레코드를 찾지 못하면, 첫 번째 배열 인수와 (선택적으로 전달한) 두 번째 배열 인수를 병합한 속성으로 새 레코드를 생성합니다.

firstOrNew 메서드도 firstOrCreate와 마찬가지로 주어진 속성으로 레코드를 찾습니다. 다만 레코드를 찾지 못한 경우, 새로운 모델 인스턴스를 반환만 할 뿐 데이터베이스에 바로 저장하지는 않습니다. 따라서 이 모델을 실제로 저장하려면 save 메서드를 직접 호출해야 합니다:

use App\Models\Flight;

// 이름으로 항공편을 조회하고, 없으면 생성...
$flight = Flight::firstOrCreate([
    'name' => 'London to Paris'
]);

// 이름으로 항공편을 조회하고, 없으면 name, delayed, arrival_time 속성으로 생성...
$flight = Flight::firstOrCreate(
    ['name' => 'London to Paris'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

// 이름으로 항공편을 조회하고, 없으면 새 Flight 인스턴스를 생성(미저장)...
$flight = Flight::firstOrNew([
    'name' => 'London to Paris'
]);

// 이름으로 항공편을 조회하고, 없으면 name, delayed, arrival_time 속성으로 인스턴스 생성(미저장)...
$flight = Flight::firstOrNew(
    ['name' => 'Tokyo to Sydney'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

집계 값 조회하기

Eloquent 모델을 다룰 때도 Laravel 쿼리 빌더가 제공하는 count, sum, max 등의 집계 메서드를 그대로 사용할 수 있습니다. 예상할 수 있듯이, 이 메서드들은 Eloquent 모델 인스턴스가 아니라 단일 스칼라 값을 반환합니다:

$count = Flight::where('active', 1)->count();

$max = Flight::where('active', 1)->max('price');

Model 생성 및 수정

레코드 생성 (Inserts)

Eloquent를 사용할 때는 데이터베이스에서 모델을 조회하는 것뿐만 아니라 새로운 레코드를 추가하는 작업도 필요합니다. 다행히 Eloquent는 이 작업을 매우 간단하게 만들어 줍니다. 새 레코드를 데이터베이스에 추가하려면 새로운 모델 인스턴스를 생성하고 속성(attribute)을 설정한 다음, 모델 인스턴스의 save 메서드를 호출하면 됩니다:

<?php

namespace App\Http\Controllers;

use App\Models\Flight;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class FlightController extends Controller
{
    /**
     * 새로운 항공편을 데이터베이스에 저장합니다.
     */
    public function store(Request $request): RedirectResponse
    {
        // 요청 데이터 검증...

        $flight = new Flight;

        $flight->name = $request->name;

        $flight->save();

        return redirect('/flights');
    }
}

이 예시에서는 들어온 HTTP 요청의 name 필드 값을 App\Models\Flight 모델 인스턴스의 name 속성에 할당하고 있습니다. save 메서드를 호출하면 데이터베이스에 레코드가 추가됩니다. 이때 모델의 created_at과 updated_at 타임스탬프는 save 메서드 호출 시 자동으로 설정되므로 직접 값을 지정할 필요가 없습니다.

모델을 데이터베이스 트랜잭션 내에서 저장하고 싶다면 saveOrFail 메서드를 사용할 수 있습니다. 저장 중 예외가 발생하면 트랜잭션은 자동으로 롤백됩니다:

$flight->saveOrFail();

또는 create 메서드를 사용해 PHP 구문 한 줄로 새 모델을 "저장"할 수도 있습니다. create 메서드는 새로 생성된 모델 인스턴스를 반환해 줍니다:

use App\Models\Flight;

$flight = Flight::create([
    'name' => 'London to Paris',
]);

다만, create 메서드를 사용하려면 모델 클래스에 Fillable 또는 Guarded 속성을 지정해야 합니다. 모든 Eloquent 모델은 기본적으로 대량 할당(mass assignment) 취약점으로부터 보호되고 있기 때문에 이런 지정이 필요합니다. 대량 할당에 대해 더 자세히 알아보려면 대량 할당 문서를 참고하세요.

레코드 수정 (Updates)

save 메서드는 이미 데이터베이스에 존재하는 모델을 수정하는 데도 사용할 수 있습니다. 모델을 수정하려면 먼저 해당 모델을 조회한 뒤 원하는 속성 값을 설정하고, 모델의 save 메서드를 호출하면 됩니다. 이 경우에도 updated_at 타임스탬프가 자동으로 갱신되므로 직접 값을 지정할 필요가 없습니다:

use App\Models\Flight;

$flight = Flight::find(1);

$flight->name = 'Paris to London';

$flight->save();

모델을 데이터베이스 트랜잭션 내에서 수정하고 싶다면 updateOrFail 메서드를 사용할 수 있습니다. 수정 중 예외가 발생하면 트랜잭션은 자동으로 롤백됩니다:

$flight->updateOrFail(['name' => 'Paris to London']);

때로는 기존 모델을 수정하거나, 일치하는 모델이 없으면 새로 생성해야 하는 경우가 있습니다. firstOrCreate 메서드와 마찬가지로 updateOrCreate 메서드도 모델을 즉시 저장하므로 별도로 save 메서드를 호출할 필요가 없습니다.

아래 예시에서는 출발지(departure)가 Oakland이고 도착지(destination)가 San Diego인 항공편이 존재하면 해당 레코드의 price와 discounted 컬럼을 수정합니다. 만약 그런 항공편이 없다면, 첫 번째 인수 배열과 두 번째 인수 배열을 합친 속성을 가진 새 항공편이 생성됩니다:

$flight = Flight::updateOrCreate(
    ['departure' => 'Oakland', 'destination' => 'San Diego'],
    ['price' => 99, 'discounted' => 1]
);

firstOrCreate나 updateOrCreate 같은 메서드를 사용할 때는 새 모델이 생성된 것인지 기존 모델이 수정된 것인지 알기 어려울 수 있습니다. 이럴 때 wasRecentlyCreated 속성을 확인하면 모델이 현재 라이프사이클 동안 새로 생성되었는지 알 수 있습니다:

$flight = Flight::updateOrCreate(
    // ...
);

if ($flight->wasRecentlyCreated) {
    // 새로운 항공편 레코드가 추가된 경우...
}

대량 수정 (Mass Updates)

특정 조건에 맞는 모델들을 한 번에 수정할 수도 있습니다. 다음 예시에서는 active 상태이고 도착지가 San Diego인 모든 항공편을 지연(delayed) 상태로 표시합니다:

Flight::where('active', 1)
    ->where('destination', 'San Diego')
    ->update(['delayed' => 1]);

update 메서드는 수정할 컬럼과 값의 쌍으로 이루어진 배열을 인수로 받으며, 영향을 받은 행(row)의 개수를 반환합니다.

WARNING

Eloquent로 대량 수정을 실행할 때는 수정 대상 모델에 대해 saving, saved, updating, updated 모델 이벤트가 발생하지 않습니다. 대량 수정 시에는 모델이 실제로 조회되는 과정 자체가 없기 때문입니다.

속성 변경 여부 확인

Eloquent는 모델의 내부 상태를 확인하여 모델을 처음 조회했을 때와 비교해 속성이 어떻게 변경되었는지 파악할 수 있는 isDirty, isClean, wasChanged 메서드를 제공합니다.

isDirty 메서드는 모델을 조회한 이후 속성 값이 변경되었는지 확인합니다. 특정 속성 이름이나 속성 이름 배열을 인수로 전달하면 해당 속성들이 "dirty"(변경됨) 상태인지 확인할 수 있습니다. 반대로 isClean 메서드는 모델을 조회한 이후 속성이 변경되지 않은 상태로 유지되고 있는지 확인하며, 역시 선택적으로 속성 인수를 받을 수 있습니다:

use App\Models\User;

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';

$user->isDirty(); // true
$user->isDirty('title'); // true
$user->isDirty('first_name'); // false
$user->isDirty(['first_name', 'title']); // true

$user->isClean(); // false
$user->isClean('title'); // false
$user->isClean('first_name'); // true
$user->isClean(['first_name', 'title']); // false

$user->save();

$user->isDirty(); // false
$user->isClean(); // true

wasChanged 메서드는 현재 요청 사이클 내에서 모델이 마지막으로 저장될 때 속성이 변경되었는지 확인합니다. 필요하다면 특정 속성 이름을 전달하여 해당 속성이 변경되었는지도 확인할 수 있습니다:

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';

$user->save();

$user->wasChanged(); // true
$user->wasChanged('title'); // true
$user->wasChanged(['title', 'slug']); // true
$user->wasChanged('first_name'); // false
$user->wasChanged(['first_name', 'title']); // true

getOriginal 메서드는 모델이 조회된 이후 변경 사항과 관계없이 원래의 속성 값을 담은 배열을 반환합니다. 특정 속성 이름을 전달하면 해당 속성의 원래 값만 가져올 수도 있습니다:

$user = User::find(1);

$user->name; // John
$user->email; // john@example.com

$user->name = 'Jack';
$user->name; // Jack

$user->getOriginal('name'); // John
$user->getOriginal(); // 원래 속성들의 배열...

getChanges 메서드는 모델이 마지막으로 저장될 때 변경된 속성들을 담은 배열을 반환하며, getPrevious 메서드는 마지막 저장 직전의 원래 속성 값을 담은 배열을 반환합니다:

$user = User::find(1);

$user->name; // John
$user->email; // john@example.com

$user->update([
    'name' => 'Jack',
    'email' => 'jack@example.com',
]);

$user->getChanges();

/*
    [
        'name' => 'Jack',
        'email' => 'jack@example.com',
    ]
*/

$user->getPrevious();

/*
    [
        'name' => 'John',
        'email' => 'john@example.com',
    ]
*/

대량 할당 (Mass Assignment)

앞서 살펴본 것처럼 create 메서드를 사용하면 PHP 구문 한 줄로 새 모델을 "저장"할 수 있으며, 메서드는 새로 생성된 모델 인스턴스를 반환합니다:

use App\Models\Flight;

$flight = Flight::create([
    'name' => 'London to Paris',
]);

다만 create 메서드를 사용하려면 모델 클래스에 Fillable 또는 Guarded 속성을 지정해야 합니다. 모든 Eloquent 모델은 기본적으로 대량 할당 취약점으로부터 보호되고 있기 때문입니다.

대량 할당 취약점이란, 사용자가 예상치 못한 HTTP 요청 필드를 전송했을 때 그 필드가 의도하지 않은 데이터베이스 컬럼을 변경해 버리는 문제를 말합니다. 예를 들어 악의적인 사용자가 HTTP 요청에 is_admin 파라미터를 몰래 끼워 넣고, 이 값이 그대로 모델의 create 메서드에 전달된다면 자기 자신을 관리자 권한으로 승격시켜 버릴 수도 있습니다.

따라서 먼저 어떤 모델 속성을 대량 할당 가능하도록 허용할지 정의해야 합니다. 이는 모델에 Fillable 속성을 선언하는 방식으로 할 수 있습니다. 예를 들어 Flight 모델의 name 속성을 대량 할당 가능하도록 설정해 보겠습니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Model;

#[Fillable(['name'])]
class Flight extends Model
{
    // ...
}

대량 할당이 가능한 속성을 지정했다면, create 메서드를 사용해 데이터베이스에 새 레코드를 추가할 수 있습니다. create 메서드는 새로 생성된 모델 인스턴스를 반환합니다:

$flight = Flight::create(['name' => 'London to Paris']);

이미 모델 인스턴스를 가지고 있다면, fill 메서드를 사용해 속성 배열로 값을 채울 수도 있습니다:

$flight->fill(['name' => 'Amsterdam to Frankfurt']);

대량 할당과 JSON 컬럼

JSON 컬럼에 값을 대량 할당하려면 각 컬럼에서 대량 할당을 허용할 키를 모델의 Fillable 속성에 명시해야 합니다. 보안을 위해 Laravel은 Guarded 속성을 사용하는 경우 중첩된 JSON 속성에 대한 수정을 지원하지 않습니다:

use Illuminate\Database\Eloquent\Attributes\Fillable;

#[Fillable(['options->enabled'])]
class Flight extends Model
{
    // ...
}

모든 속성을 대량 할당 허용하기

모델의 모든 속성을 대량 할당 가능하도록 만들고 싶다면 모델에 Unguarded 속성을 사용할 수 있습니다. 다만 모델의 보호 기능을 해제(unguard)할 경우에는, fill, create, update 메서드에 전달하는 배열을 항상 직접 세심하게 구성해야 한다는 점에 각별히 주의해야 합니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Unguarded;
use Illuminate\Database\Eloquent\Model;

#[Unguarded]
class Flight extends Model
{
    // ...
}

대량 할당 예외 처리

기본적으로 Fillable 속성에 포함되지 않은 속성은 대량 할당 작업 시 조용히 무시(discard)됩니다. 운영 환경에서는 이 동작이 자연스럽지만, 로컬 개발 환경에서는 왜 모델 변경 사항이 반영되지 않는지 헷갈리는 원인이 되기도 합니다.

원한다면 preventSilentlyDiscardingAttributes 메서드를 호출하여, 대량 할당이 불가능한 속성을 채우려고 할 때 예외가 발생하도록 Laravel에 지시할 수 있습니다. 일반적으로 이 메서드는 애플리케이션의 AppServiceProvider 클래스의 boot 메서드 안에서 호출합니다:

use Illuminate\Database\Eloquent\Model;

/**
 * 애플리케이션 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    Model::preventSilentlyDiscardingAttributes($this->app->isLocal());
}

Upsert (삽입 또는 수정)

Eloquent의 upsert 메서드를 사용하면 하나의 원자적(atomic) 연산으로 레코드를 수정하거나 생성할 수 있습니다. 메서드의 첫 번째 인수는 삽입하거나 수정할 값들이고, 두 번째 인수는 테이블 내에서 레코드를 고유하게 식별할 컬럼(들)의 목록입니다. 세 번째이자 마지막 인수는 일치하는 레코드가 이미 존재할 경우 수정해야 할 컬럼들의 배열입니다. 모델에서 타임스탬프 기능이 활성화되어 있다면 upsert 메서드는 created_at과 updated_at 타임스탬프를 자동으로 설정합니다:

Flight::upsert([
    ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
    ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
], uniqueBy: ['departure', 'destination'], update: ['price']);

WARNING

SQL Server를 제외한 모든 데이터베이스에서는 upsert 메서드의 두 번째 인수로 전달하는 컬럼에 "primary" 또는 "unique" 인덱스가 설정되어 있어야 합니다. 또한 MariaDB와 MySQL 데이터베이스 드라이버는 upsert 메서드의 두 번째 인수를 무시하고, 테이블에 설정된 "primary"와 "unique" 인덱스를 기준으로 기존 레코드를 항상 자동으로 판별합니다.

모델 삭제하기

모델을 삭제하려면 모델 인스턴스에서 delete 메서드를 호출하면 됩니다:

use App\Models\Flight;

$flight = Flight::find(1);

$flight->delete();

데이터베이스 트랜잭션 안에서 모델을 삭제하고 싶다면 deleteOrFail 메서드를 사용할 수 있습니다. 삭제 과정에서 예외가 발생하면 트랜잭션은 자동으로 롤백됩니다:

$flight->deleteOrFail();

기본 키로 기존 모델 삭제하기

위 예제에서는 모델을 먼저 조회한 뒤 delete 메서드를 호출했습니다. 하지만 모델의 기본 키 값을 이미 알고 있다면, 굳이 모델을 조회하지 않고도 destroy 메서드로 바로 삭제할 수 있습니다. destroy 메서드는 단일 기본 키뿐만 아니라 여러 개의 기본 키, 기본 키 배열, 또는 기본 키로 구성된 컬렉션도 인자로 받을 수 있습니다:

Flight::destroy(1);

Flight::destroy(1, 2, 3);

Flight::destroy([1, 2, 3]);

Flight::destroy(collect([1, 2, 3]));

소프트 삭제(soft delete)를 사용하는 모델이라면, forceDestroy 메서드로 완전히(영구적으로) 삭제할 수도 있습니다:

Flight::forceDestroy(1);

WARNING

destroy 메서드는 각 모델을 개별적으로 로드한 뒤 delete 메서드를 호출하는 방식으로 동작합니다. 이는 모델별로 deleting, deleted 이벤트가 정상적으로 발생하도록 하기 위함입니다.

쿼리를 이용해 모델 삭제하기

물론 조건에 맞는 모든 모델을 한 번에 삭제하는 Eloquent 쿼리를 작성할 수도 있습니다. 아래 예제는 비활성 상태(active가 0)인 모든 항공편(flight)을 삭제합니다. 대량 수정(mass update)과 마찬가지로, 대량 삭제(mass delete) 역시 삭제되는 모델에 대한 모델 이벤트를 발생시키지 않습니다:

$deleted = Flight::where('active', 0)->delete();

테이블의 모든 모델을 삭제하려면 아무런 조건 없이 쿼리를 실행하면 됩니다:

$deleted = Flight::query()->delete();

WARNING

Eloquent를 통해 대량 삭제 구문을 실행하면, 삭제되는 모델에 대해 deleting, deleted 모델 이벤트가 발생하지 않습니다. 삭제 쿼리를 실행할 때 실제로 모델 인스턴스를 조회하는 과정이 없기 때문입니다.

소프트 삭제(Soft Delete)

Eloquent는 데이터베이스에서 레코드를 실제로 삭제하는 것 외에도, 모델을 "소프트 삭제"하는 기능을 제공합니다. 소프트 삭제된 모델은 실제로 데이터베이스에서 제거되지 않습니다. 대신 deleted_at 속성에 모델이 "삭제"된 날짜와 시간이 기록됩니다. 모델에 소프트 삭제 기능을 적용하려면 Illuminate\Database\Eloquent\SoftDeletes 트레이트를 모델에 추가하면 됩니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Flight extends Model
{
    use SoftDeletes;
}

NOTE

SoftDeletes 트레이트는 deleted_at 속성을 자동으로 DateTime / Carbon 인스턴스로 캐스팅해 줍니다.

데이터베이스 테이블에도 deleted_at 컬럼을 추가해야 합니다. Laravel의 스키마 빌더는 이 컬럼을 손쉽게 생성할 수 있는 헬퍼 메서드를 제공합니다:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::table('flights', function (Blueprint $table) {
    $table->softDeletes();
});

Schema::table('flights', function (Blueprint $table) {
    $table->dropSoftDeletes();
});

이제 모델 인스턴스에서 delete 메서드를 호출하면, deleted_at 컬럼에 현재 날짜와 시간이 설정됩니다. 단, 해당 레코드 자체는 테이블에 그대로 남아 있습니다. 소프트 삭제를 사용하는 모델을 조회할 때는, 소프트 삭제된 모델이 모든 쿼리 결과에서 자동으로 제외됩니다.

NOTE

예를 들어 회원 탈퇴 기능을 구현할 때, 탈퇴한 회원의 데이터를 즉시 지우지 않고 deleted_at만 기록해 두면 이후 복구나 통계 처리에 유용하게 활용할 수 있습니다. 실제로 많은 서비스에서 "탈퇴 회원"을 이런 방식으로 관리합니다.

특정 모델 인스턴스가 소프트 삭제되었는지 확인하려면 trashed 메서드를 사용하면 됩니다:

if ($flight->trashed()) {
    // ...
}

소프트 삭제된 모델 복구하기

때로는 소프트 삭제된 모델을 다시 "복구"하고 싶을 수 있습니다. 모델 인스턴스에서 restore 메서드를 호출하면 소프트 삭제된 모델을 복구할 수 있는데, 이때 deleted_at 컬럼 값이 null로 설정됩니다:

$flight->restore();

여러 모델을 한 번에 복구하고 싶다면 쿼리에서 restore 메서드를 사용할 수도 있습니다. 다른 "대량(mass)" 작업과 마찬가지로, 이 경우에도 복구되는 모델에 대한 모델 이벤트는 발생하지 않습니다:

Flight::withTrashed()
    ->where('airline_id', 1)
    ->restore();

restore 메서드는 연관관계(relationship) 쿼리를 작성할 때도 사용할 수 있습니다:

$flight->history()->restore();

모델 영구 삭제하기

경우에 따라 모델을 데이터베이스에서 완전히 제거해야 할 때도 있습니다. 소프트 삭제된 모델을 테이블에서 영구적으로 삭제하려면 forceDelete 메서드를 사용하세요:

$flight->forceDelete();

Eloquent 연관관계 쿼리를 작성할 때도 forceDelete 메서드를 사용할 수 있습니다:

$flight->history()->forceDelete();

소프트 삭제된 모델 조회하기

소프트 삭제된 모델 포함해서 조회하기

앞서 설명했듯이 소프트 삭제된 모델은 기본적으로 쿼리 결과에서 자동으로 제외됩니다. 하지만 쿼리에 withTrashed 메서드를 추가하면 소프트 삭제된 모델도 결과에 포함되도록 강제할 수 있습니다:

use App\Models\Flight;

$flights = Flight::withTrashed()
    ->where('account_id', 1)
    ->get();

withTrashed 메서드는 연관관계 쿼리를 작성할 때도 사용할 수 있습니다:

$flight->history()->withTrashed()->get();

소프트 삭제된 모델만 조회하기

onlyTrashed 메서드를 사용하면 소프트 삭제된 모델만 조회할 수 있습니다:

$flights = Flight::onlyTrashed()
    ->where('airline_id', 1)
    ->get();

모델 가지치기 (Pruning)

더 이상 필요하지 않은 모델을 주기적으로 삭제하고 싶을 때가 있습니다. 예를 들어 1년 지난 로그 데이터나 만료된 임시 알림처럼, 시간이 지나면 의미가 없어지는 데이터를 테이블에 계속 쌓아두면 쿼리 성능이 저하되고 저장 공간도 낭비됩니다.

Laravel은 이런 작업을 위해 Illuminate\Database\Eloquent\Prunable과 Illuminate\Database\Eloquent\MassPrunable 트레이트를 제공합니다. 가지치기 대상 모델에 둘 중 하나를 추가한 후, 삭제 대상을 조회하는 Eloquent 쿼리 빌더를 반환하는 prunable 메서드를 구현하면 됩니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Prunable;

class Flight extends Model
{
    use Prunable;

    /**
     * 가지치기 대상 모델을 조회하는 쿼리
     */
    public function prunable(): Builder
    {
        return static::where('created_at', '<=', now()->minus(months: 1));
    }
}

Prunable 트레이트를 사용하는 모델에는 pruning 메서드도 정의할 수 있습니다. 이 메서드는 모델이 삭제되기 직전에 호출되며, 모델과 연관된 저장 파일 등 부가 리소스를 함께 정리할 때 유용합니다:

/**
 * 가지치기를 위해 모델을 준비합니다.
 */
protected function pruning(): void
{
    // ...
}

가지치기 대상 모델을 설정했다면, routes/console.php 파일에 model:prune Artisan 명령어를 스케줄링해야 합니다. 실행 주기는 애플리케이션 특성에 맞게 자유롭게 정하면 됩니다:

use Illuminate\Support\Facades\Schedule;

Schedule::command('model:prune')->daily();

model:prune 명령어는 내부적으로 애플리케이션의 app/Models 디렉터리를 스캔해서 "Prunable" 트레이트가 적용된 모델을 자동으로 탐지합니다. 모델이 다른 위치에 있다면 --model 옵션으로 직접 클래스를 지정할 수 있습니다:

Schedule::command('model:prune', [
    '--model' => [Address::class, Flight::class],
])->daily();

반대로 자동 탐지된 모델 중 특정 모델만 가지치기에서 제외하고 싶다면 --except 옵션을 사용하세요:

Schedule::command('model:prune', [
    '--except' => [Address::class, Flight::class],
])->daily();

실제로 삭제를 실행하기 전에 prunable 쿼리가 의도한 대로 동작하는지 미리 확인하고 싶다면, --pretend 옵션을 붙여서 실행해보세요. 이 옵션을 사용하면 실제 삭제는 수행하지 않고 몇 건이 삭제 대상인지만 보고합니다:

php artisan model:prune --pretend

WARNING

소프트 삭제(Soft Delete)가 적용된 모델이라도 prunable 쿼리 조건에 해당하면 forceDelete를 통해 완전히 삭제됩니다.

대량 가지치기(Mass Pruning)

Illuminate\Database\Eloquent\MassPrunable 트레이트를 사용하면, 모델은 대량 삭제(mass-deletion) 쿼리를 통해 데이터베이스에서 바로 삭제됩니다. 이 방식에서는 pruning 메서드가 호출되지 않으며, deleting과 deleted 모델 이벤트도 발생하지 않습니다.

이는 삭제 전에 모델을 하나하나 실제로 조회(hydrate)하지 않고 쿼리만으로 바로 삭제를 처리하기 때문입니다. 즉, 대상 레코드가 아무리 많아도 메모리에 모델 객체를 전부 올리지 않으므로 Prunable보다 훨씬 효율적으로 동작합니다. 다만 그 대가로 모델별 후처리 로직(pruning 메서드나 이벤트 리스너)은 실행되지 않는다는 점을 기억해두세요:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\MassPrunable;

class Flight extends Model
{
    use MassPrunable;

    /**
     * 가지치기 대상 모델을 조회하는 쿼리
     */
    public function prunable(): Builder
    {
        return static::where('created_at', '<=', now()->minus(months: 1));
    }
}

Eloquent ORM

모델 복제하기

replicate 메서드를 사용하면 기존 모델 인스턴스를 저장되지 않은 상태로 복사할 수 있습니다. 이 기능은 많은 속성을 공유하는 모델 인스턴스를 다룰 때 특히 유용합니다:

use App\Models\Address;

$shipping = Address::create([
    'type' => 'shipping',
    'line_1' => '123 Example Street',
    'city' => 'Victorville',
    'state' => 'CA',
    'postcode' => '90001',
]);

$billing = $shipping->replicate()->fill([
    'type' => 'billing'
]);

$billing->save();

예를 들어 배송지(shipping) 주소를 복제해서 청구지(billing) 주소를 만들 때처럼, 거의 동일한 데이터를 가진 레코드를 새로 만들어야 할 때 매번 모든 속성을 다시 입력할 필요 없이 기존 인스턴스를 복제한 뒤 바뀐 부분만 fill로 덮어쓰면 됩니다.

특정 속성을 복제 대상에서 제외하고 싶다면, replicate 메서드에 제외할 속성명을 배열로 전달하면 됩니다:

$flight = Flight::create([
    'destination' => 'LAX',
    'origin' => 'LHR',
    'last_flown' => '2020-03-04 11:00:00',
    'last_pilot_id' => 747,
]);

$flight = $flight->replicate([
    'last_flown',
    'last_pilot_id'
]);

위 예시에서는 운항 기록을 복제하면서 last_flown(마지막 운항 시각)과 last_pilot_id(마지막 조종사 ID)는 새 레코드에 복사되지 않도록 제외했습니다. 이런 식으로 복제 시점마다 새로 채워져야 하는 속성들은 제외 목록에 넣어주는 것이 좋습니다.

쿼리 스코프

전역 스코프 (Global Scopes)

전역 스코프를 사용하면 특정 모델에 대한 모든 쿼리에 공통 제약 조건을 추가할 수 있습니다. 실제로 Laravel의 소프트 삭제(soft delete) 기능도 전역 스코프를 활용해서 "삭제되지 않은" 모델만 조회하도록 구현되어 있습니다. 직접 전역 스코프를 작성하면, 특정 모델을 조회하는 모든 쿼리에 원하는 제약 조건을 손쉽게 적용할 수 있습니다.

스코프 생성하기

새로운 전역 스코프를 만들려면 make:scope Artisan 명령어를 실행하면 됩니다. 생성된 스코프 클래스는 애플리케이션의 app/Models/Scopes 디렉터리에 위치합니다:

php artisan make:scope AncientScope

전역 스코프 작성하기

전역 스코프를 작성하는 방법은 간단합니다. 먼저 make:scope 명령어로 Illuminate\Database\Eloquent\Scope 인터페이스를 구현하는 클래스를 생성합니다. Scope 인터페이스는 apply 메서드 하나만 구현하면 됩니다. apply 메서드 안에서 필요에 따라 where 조건이나 다른 종류의 쿼리 절을 추가할 수 있습니다:

<?php

namespace App\Models\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class AncientScope implements Scope
{
    /**
     * 주어진 Eloquent 쿼리 빌더에 스코프를 적용합니다.
     */
    public function apply(Builder $builder, Model $model): void
    {
        $builder->where('created_at', '<', now()->minus(years: 2000));
    }
}

NOTE

전역 스코프에서 쿼리의 select 절에 컬럼을 추가하고 싶다면 select 대신 addSelect 메서드를 사용해야 합니다. 그렇지 않으면 기존 select 절이 의도치 않게 교체될 수 있습니다.

전역 스코프 적용하기

모델에 전역 스코프를 지정하려면 모델 클래스에 ScopedBy 속성(attribute)을 추가하기만 하면 됩니다:

<?php

namespace App\Models;

use App\Models\Scopes\AncientScope;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;

#[ScopedBy([AncientScope::class])]
class User extends Model
{
    //
}

또는, 모델의 booted 메서드를 오버라이드하고 그 안에서 addGlobalScope 메서드를 호출하여 수동으로 전역 스코프를 등록할 수도 있습니다. addGlobalScope 메서드는 작성한 스코프 클래스의 인스턴스를 인자로 받습니다:

<?php

namespace App\Models;

use App\Models\Scopes\AncientScope;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 모델의 "booted" 메서드.
     */
    protected static function booted(): void
    {
        static::addGlobalScope(new AncientScope);
    }
}

위 예제처럼 App\Models\User 모델에 스코프를 추가하면, User::all()을 호출할 때 다음과 같은 SQL 쿼리가 실행됩니다:

select * from `users` where `created_at` < 0021-02-18 00:00:00

클로저를 이용한 익명 전역 스코프

Eloquent에서는 클로저를 사용해서도 전역 스코프를 정의할 수 있습니다. 별도의 클래스를 만들 정도는 아닌 간단한 스코프를 정의할 때 유용합니다. 클로저로 전역 스코프를 정의할 때는, addGlobalScope 메서드의 첫 번째 인자로 원하는 스코프 이름을 직접 지정해 주어야 합니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 모델의 "booted" 메서드.
     */
    protected static function booted(): void
    {
        static::addGlobalScope('ancient', function (Builder $builder) {
            $builder->where('created_at', '<', now()->minus(years: 2000));
        });
    }
}

전역 스코프 제거하기

특정 쿼리에서 전역 스코프를 제외하고 싶다면 withoutGlobalScope 메서드를 사용하면 됩니다. 이 메서드는 전역 스코프의 클래스명을 인자로 받습니다:

User::withoutGlobalScope(AncientScope::class)->get();

클로저로 전역 스코프를 정의했다면, 해당 스코프에 부여했던 문자열 이름을 전달하면 됩니다:

User::withoutGlobalScope('ancient')->get();

쿼리에 적용된 여러 전역 스코프를 한꺼번에 제거하거나 전부 제거하고 싶다면 withoutGlobalScopes, withoutGlobalScopesExcept 메서드를 사용할 수 있습니다:

// 모든 전역 스코프를 제거합니다...
User::withoutGlobalScopes()->get();

// 일부 전역 스코프만 제거합니다...
User::withoutGlobalScopes([
    FirstScope::class, SecondScope::class
])->get();

// 지정한 스코프를 제외한 나머지 모든 전역 스코프를 제거합니다...
User::withoutGlobalScopesExcept([
    SecondScope::class,
])->get();

로컬 스코프 (Local Scopes)

로컬 스코프를 사용하면 애플리케이션 전반에서 반복적으로 사용하는 쿼리 조건을 정의해두고 재사용할 수 있습니다. 예를 들어 "인기 있는(popular)" 사용자를 자주 조회해야 한다고 가정해봅시다. 스코프를 정의하려면 Eloquent 메서드에 Scope 속성(attribute)을 추가하면 됩니다.

스코프 메서드는 항상 동일한 쿼리 빌더 인스턴스를 반환하거나 void를 반환해야 합니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 쿼리 결과를 인기 있는 사용자로만 한정하는 스코프입니다.
     */
    #[Scope]
    protected function popular(Builder $query): void
    {
        $query->where('votes', '>', 100);
    }

    /**
     * 쿼리 결과를 활성화된 사용자로만 한정하는 스코프입니다.
     */
    #[Scope]
    protected function active(Builder $query): void
    {
        $query->where('active', 1);
    }
}

로컬 스코프 사용하기

스코프를 정의한 뒤에는 모델을 조회할 때 해당 스코프 메서드를 호출하기만 하면 됩니다. 여러 스코프를 체이닝해서 호출할 수도 있습니다:

use App\Models\User;

$users = User::popular()->active()->orderBy('created_at')->get();

여러 Eloquent 모델 스코프를 or 연산자로 결합하려면, 올바른 논리적 그룹화를 위해 클로저를 사용해야 할 수도 있습니다:

$users = User::popular()->orWhere(function (Builder $query) {
    $query->active();
})->get();

하지만 이 방식은 다소 번거로울 수 있습니다. Laravel은 클로저 없이도 스코프를 유연하게 체이닝할 수 있도록 "고차(higher order)" orWhere 메서드를 제공합니다:

$users = User::popular()->orWhere->active()->get();

동적 스코프

때로는 매개변수를 받는 스코프를 정의하고 싶을 수 있습니다. 이럴 때는 스코프 메서드의 시그니처에 추가 매개변수를 선언하면 됩니다. 스코프 매개변수는 $query 매개변수 다음에 정의해야 합니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 쿼리 결과를 지정한 타입의 사용자로만 한정하는 스코프입니다.
     */
    #[Scope]
    protected function ofType(Builder $query, string $type): void
    {
        $query->where('type', $type);
    }
}

스코프 메서드의 시그니처에 필요한 인자를 추가했다면, 스코프를 호출할 때 해당 인자를 전달하면 됩니다:

$users = User::ofType('admin')->get();

속성(attribute)으로 정의한 스코프 메서드는 protected로 선언해야 합니다. 모델 클래스 내부에서 속성 기반 스코프를 호출할 때는 static::query()->ofType('admin')처럼 쿼리 빌더 인스턴스를 통해 호출해야, Eloquent의 스코프 처리 로직을 제대로 거치게 됩니다.

대기 속성 (Pending Attributes)

스코프로 제약을 건 조건과 동일한 속성 값을 가진 모델을 바로 생성하고 싶다면, 스코프 쿼리를 구성할 때 withAttributes 메서드를 사용할 수 있습니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Attributes\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    /**
     * 쿼리 결과를 임시 저장(draft) 글로만 한정하는 스코프입니다.
     */
    #[Scope]
    protected function draft(Builder $query): void
    {
        $query->withAttributes([
            'hidden' => true,
        ]);
    }
}

withAttributes 메서드는 전달받은 속성 값을 기준으로 쿼리에 where 조건을 추가하며, 동시에 이 스코프를 통해 생성되는 모델에도 해당 속성 값을 자동으로 적용합니다:

$draft = Post::draft()->create(['title' => 'In Progress']);

$draft->hidden; // true

withAttributes 메서드가 쿼리에 where 조건을 추가하지 않도록 하려면 asConditions 인자를 false로 지정하면 됩니다:

$query->withAttributes([
    'hidden' => true,
], asConditions: false);

Eloquent ORM

모델 비교하기

두 모델이 서로 "같은" 모델인지 확인해야 할 때가 있습니다. is 메서드와 isNot 메서드를 사용하면 두 모델이 동일한 기본 키, 테이블, 데이터베이스 커넥션을 가지고 있는지 빠르게 확인할 수 있습니다:

if ($post->is($anotherPost)) {
    // ...
}

if ($post->isNot($anotherPost)) {
    // ...
}

is와 isNot 메서드는 belongsTo, hasOne, morphTo, morphOne 관계에서도 사용할 수 있습니다. 이 메서드는 특히 연관된 모델을 조회하기 위한 쿼리를 따로 실행하지 않고도 비교하고 싶을 때 유용합니다:

if ($post->author()->is($user)) {
    // ...
}

NOTE

예를 들어 게시글($post)의 작성자가 현재 로그인한 사용자와 같은지 확인하고 싶다면, $post->author 처럼 관계를 직접 호출해 모델을 가져온 뒤 비교하는 대신 $post->author()->is($user)를 사용하는 것이 좋습니다. 전자는 관계를 조회하기 위해 추가 쿼리를 실행하지만, 후자는 쿼리 없이 외래 키 값만으로 비교를 수행하기 때문입니다.

이벤트

NOTE

Eloquent 이벤트를 클라이언트 애플리케이션으로 직접 브로드캐스팅하고 싶으신가요? Laravel의 모델 이벤트 브로드캐스팅을 확인해보세요.

Eloquent 모델은 모델의 생명주기 중 여러 시점에 훅(hook)을 걸 수 있도록 다양한 이벤트를 발생시킵니다. 발생 가능한 이벤트는 retrieved, creating, created, updating, updated, saving, saved, deleting, deleted, trashed, forceDeleting, forceDeleted, restoring, restored, replicating입니다.

retrieved 이벤트는 데이터베이스에서 기존 모델을 조회할 때 발생합니다. 새로운 모델을 처음 저장할 때는 creating과 created 이벤트가 발생합니다. 기존 모델을 수정한 후 save 메서드를 호출하면 updating / updated 이벤트가 발생합니다. saving / saved 이벤트는 모델의 속성이 변경되지 않았더라도 모델을 생성하거나 수정할 때마다 발생합니다. -ing으로 끝나는 이벤트명은 모델의 변경 사항이 데이터베이스에 반영되기 전에 발생하고, -ed로 끝나는 이벤트명은 변경 사항이 반영된 후에 발생합니다.

모델 이벤트를 수신하려면 Eloquent 모델에 $dispatchesEvents 속성을 정의하면 됩니다. 이 속성은 Eloquent 모델 생명주기의 각 시점을 여러분이 직접 작성한 이벤트 클래스에 매핑합니다. 각 모델 이벤트 클래스는 생성자를 통해 영향을 받은 모델 인스턴스를 전달받도록 작성해야 합니다:

<?php

namespace App\Models;

use App\Events\UserDeleted;
use App\Events\UserSaved;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 모델의 이벤트 맵
     *
     * @var array<string, string>
     */
    protected $dispatchesEvents = [
        'saved' => UserSaved::class,
        'deleted' => UserDeleted::class,
    ];
}

이렇게 Eloquent 이벤트를 정의하고 매핑한 후에는 이벤트 리스너를 사용해 해당 이벤트를 처리할 수 있습니다.

WARNING

Eloquent를 통해 대량 업데이트(mass update)나 대량 삭제(mass delete) 쿼리를 실행하는 경우, 영향을 받는 모델들에 대해 saved, updated, deleting, deleted 이벤트가 발생하지 않습니다. 대량 업데이트나 삭제를 수행할 때는 모델 인스턴스가 실제로 조회되는 과정 자체가 없기 때문입니다.

클로저 사용하기

별도의 이벤트 클래스를 만드는 대신, 다양한 모델 이벤트가 발생할 때 실행할 클로저를 등록할 수도 있습니다. 일반적으로 이러한 클로저는 모델의 booted 메서드 안에 등록합니다:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 모델의 "booted" 메서드
     */
    protected static function booted(): void
    {
        static::created(function (User $user) {
            // ...
        });
    }
}

필요하다면 모델 이벤트를 등록할 때 큐로 처리되는 익명 이벤트 리스너를 사용할 수도 있습니다. 이렇게 하면 Laravel이 애플리케이션의 큐를 이용해 해당 이벤트 리스너를 백그라운드에서 실행합니다:

use function Illuminate\Events\queueable;

static::created(queueable(function (User $user) {
    // ...
}));

옵저버(Observer)

옵저버 정의하기

하나의 모델에서 여러 이벤트를 동시에 수신해야 한다면, 옵저버(observer)를 사용해 모든 리스너를 하나의 클래스로 묶어서 관리할 수 있습니다. 옵저버 클래스는 수신하고자 하는 Eloquent 이벤트 이름과 동일한 이름의 메서드를 가지며, 각 메서드는 영향을 받은 모델을 유일한 인자로 전달받습니다. make:observer Artisan 명령어를 사용하면 새 옵저버 클래스를 가장 손쉽게 생성할 수 있습니다:

php artisan make:observer UserObserver --model=User

이 명령어를 실행하면 새 옵저버가 app/Observers 디렉터리에 생성됩니다. 만약 이 디렉터리가 존재하지 않는다면 Artisan이 자동으로 생성해줍니다. 새로 생성된 옵저버는 다음과 같은 모습입니다:

<?php

namespace App\Observers;

use App\Models\User;

class UserObserver
{
    /**
     * User "created" 이벤트를 처리합니다.
     */
    public function created(User $user): void
    {
        // ...
    }

    /**
     * User "updated" 이벤트를 처리합니다.
     */
    public function updated(User $user): void
    {
        // ...
    }

    /**
     * User "deleted" 이벤트를 처리합니다.
     */
    public function deleted(User $user): void
    {
        // ...
    }

    /**
     * User "restored" 이벤트를 처리합니다.
     */
    public function restored(User $user): void
    {
        // ...
    }

    /**
     * User "forceDeleted" 이벤트를 처리합니다.
     */
    public function forceDeleted(User $user): void
    {
        // ...
    }
}

옵저버를 등록하려면 대상 모델에 ObservedBy 속성(attribute)을 지정하면 됩니다:

use App\Observers\UserObserver;
use Illuminate\Database\Eloquent\Attributes\ObservedBy;

#[ObservedBy([UserObserver::class])]
class User extends Authenticatable
{
    //
}

또는 옵저버로 지정할 모델에서 observe 메서드를 직접 호출해 수동으로 등록할 수도 있습니다. 이 경우 애플리케이션의 AppServiceProvider 클래스에 있는 boot 메서드에서 등록하는 것이 일반적입니다:

use App\Models\User;
use App\Observers\UserObserver;

/**
 * 애플리케이션 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    User::observe(UserObserver::class);
}

NOTE

옵저버는 saving, retrieved와 같은 추가 이벤트도 수신할 수 있습니다. 이러한 이벤트들에 대한 자세한 내용은 이벤트 문서를 참고하세요.

옵저버와 데이터베이스 트랜잭션

데이터베이스 트랜잭션 안에서 모델이 생성되는 경우, 트랜잭션이 커밋된 이후에만 옵저버의 이벤트 핸들러가 실행되도록 하고 싶을 수 있습니다. 이럴 때는 옵저버에 ShouldHandleEventsAfterCommit 인터페이스를 구현하면 됩니다. 만약 진행 중인 트랜잭션이 없다면 이벤트 핸들러는 즉시 실행됩니다:

<?php

namespace App\Observers;

use App\Models\User;
use Illuminate\Contracts\Events\ShouldHandleEventsAfterCommit;

class UserObserver implements ShouldHandleEventsAfterCommit
{
    /**
     * User "created" 이벤트를 처리합니다.
     */
    public function created(User $user): void
    {
        // ...
    }
}

이벤트 음소거하기

경우에 따라 모델이 발생시키는 모든 이벤트를 일시적으로 "음소거(mute)"해야 할 때가 있습니다. 이럴 때는 withoutEvents 메서드를 사용하면 됩니다. withoutEvents 메서드는 클로저 하나를 인자로 받으며, 이 클로저 내부에서 실행되는 모든 코드는 모델 이벤트를 발생시키지 않습니다. 또한 클로저가 반환하는 값은 그대로 withoutEvents 메서드의 반환값이 됩니다:

use App\Models\User;

$user = User::withoutEvents(function () {
    User::findOrFail(1)->delete();

    return User::find(2);
});

이벤트 없이 단일 모델 저장하기

때로는 특정 모델을 이벤트 발생 없이 "저장"하고 싶을 수 있습니다. 이럴 때는 saveQuietly 메서드를 사용하면 됩니다:

$user = User::findOrFail(1);

$user->name = 'Victoria Faith';

$user->saveQuietly();

이 외에도 "수정(update)", "삭제(delete)", "소프트 삭제(soft delete)", "복원(restore)", "복제(replicate)" 작업을 이벤트 발생 없이 수행할 수 있습니다:

$user->deleteQuietly();
$user->forceDeleteQuietly();
$user->restoreQuietly();