Drift (Moor) — 그것이 뭐인가, 리액티브 ORM과 데이터베이스 작업

Drift란 뭐인가?

Drift는 Dart와 Flutter용 ORM으로, 이전에는 Moor라고 알려졌습니다. 2019년 Simon Binder가 개발하였으며, 그 이후 여러 메이저 버전을 거쳐왔습니다. Drift는 drift_dev와 build_runner를 사용하여 빌드 시에 Dart 쿼리를 SQL로 컴파일하여 완전한 타입 안전성을 제공하고 런타임에서 SQL 구문 오류를 제거합니다.

Floor와 달리, Drift는 쿼리 구축을 위해 자체 DSL(도메인 특화 언어)을 사용합니다 — 개발자는 Dart로 작성하고 생성기가 그것을 SQL로 번역합니다. 이를 통해 IDE가 구문을 확인하고, 테이블 필드를 자동 완성하며, 쿼리를 깨뜨리지 않고 데이터 모델을 리팩토링할 수 있습니다.

Drift(2024)에 따르면, 이 라이브러리는 8000개 이상의 Flutter 프로젝트에서 사용됩니다. 다음을 지원합니다: Android(sqflite), iOS(sqflite), Web(sqlite3 WASM), 데스크탑(sqlite3 네이티브 드라이버).

이름 변경 역사: Moor → Drift

Moor는 버전 2.0(2022)에서 Drift로 개명되었습니다. 이유는 다른 프로젝트와의 이름 충돌과 고전 코드와의 거리둈입니다. API는 호환이 유지되었습니다: 마이그레이션하려면 import를 moor에서 drift로 바꾸고 의존성을 업데이트하면 됩니다.

주요 기능

Drift가 제공하는 기능: 데이터 변경 시 자동 업데이트되는 내장 Stream 쿼리, 롤백 가능한 트랜잭션 지원, rawQuery를 통한 사용자 정의 SQL 쿼리, 로직 캡슐화를 위한 DAO 패턴, 크로스 플랫폼 마이그레이션, 그리고 drift_riverpod과 drift_bloc 패키지를 통한 Riverpod 및 BLoC와의 연동.

Drift는 어떻게 작동하는가?

Drift는 컴파일 시점에 코드 생성을 사용합니다. 개발자는 @DataClass 어노테이션이나 Table을 확장하는 Dart 클래스를 통해 테이블을 설명합니다. 생성기는 보조 클래스를 만듭니다: Companion(삽입/업데이트 시 null 가능 필드용), DriftDatabase(입구 점), 그리고 DAO 구현.

Drift는 SQLite 쿼리를 직접 실행하지 않습니다. 대신 개발자가 Dart로 작성합니다: select(tasks).where(tasks.priority.greaterThan(3)).build(). 생성기가 이를 SQL로 번역하고, 런타임에서 Drift는 준비된 SQL 쿼리를 SQLite로 보냅니다. 이는 Dart 구문의 편의성과 고유 SQL 성능을 결합합니다.

쿼리 아키텍처

Drift는 두 가지 쿼리 모드를 지원합니다: DSL(권장) 및 고유 SQL. DSL 쿼리가 작성하기 더 안전합니다 — 컴파일러가 필드 이름, 타입 및 호환성을 확인합니다. 고유 SQL은 DSL이 다루지 못하는 복잡한 쿼리(윈도우 함수, 재귀 CTE, 특정 SQLite 확장)에 필요합니다.

Drift DSL vs SQL: 접근 방식 비교

Drift는 쿼리 작성 방법을 두 가지 제공합니다: Dart DSL(고유) 및 고유 SQL(복잡한 경우). 90% 시나리오에서 DSL이 더 좋습니다: 더 안전하고, 읽기 쉽고, 리팩토링을 지원합니다. 고유 SQL은 DSL이 필요한 구조를 다루지 못하는 경우에만 사용됩니다.

DSL을 사용할 때

Drift DSL은 주요 작업 방식입니다. SELECT, INSERT, UPDATE, DELETE, WHERE, ORDER BY, LIMIT, JOIN 그리고 그룹화를 다룹니다. 모든 일반적인 CRUD 쿼리에서 DSL을 사용하세요: 더 빠르고, 안전하고, 변경 시 Stream을 자동 업데이트합니다.

고유 SQL을 사용할 때

Drift에서 고유 SQL은 다음에 필요합니다: 사용자 정의 SQLite 함수(FTS5, JSON1), EXISTS를 사용한 복잡한 서브쿼리, INSERT OR REPLACE, CASE를 사용한 대량 UPDATE, 그리고 성능이 중요하고 DSL이 최적의 실행 계획을 생성하지 못하는 쿼리. 고유 SQL은 drift_dev를 통한 타입 지원과 함께 .sql 파일에 작성할 수 있습니다.

Drift 코드 예시

Drift는 Table을 확장하거나 @DataClass 어노테이션을 사용하는 클래스를 사용합니다. 아래는 DSL, 고유 SQL, 그리고 리액티브 업데이트를 통한 쿼리가 있는 Task 모델의 완전한 예입니다. build_runner를 실행하면 생성된 모든 클래스가 준비됩니다.

테이블 및 데이터베이스 정의

Tasks 클래스는 Table을 확장하고 열을 정의합니다. 각 열은 Column<T> 타입의 식입니다. 매개변수: withDefault()는 기본값을 설정하고, autoIncrement()는 자동 증가를 설정합니다. 데이터베이스는 $DriftDatabase를 확장하는 추상 클래스입니다.

class Tasks extends Table {
    IntColumn get id => integer().autoIncrement();
    TextColumn get title => text().withDefault(const Constant(''))();
    BoolColumn get isCompleted => boolean().withDefault(const Constant(false))();
    IntColumn get priority => integer().withDefault(const Constant(0))();
}

@DriftDatabase(tables: [Tasks])
class AppDatabase extends $AppDatabase {
    AppDatabase(QueryExecutor e) : super(e);
}

DSL을 통한 CRUD 작업

Drift는 테이블에 대한 메서드 into(tasks).insert(), select(tasks), update(tasks) 그리고 delete(tasks)를 생성합니다. 모든 작업은 Future를 반환합니다 — SQLite 작업은 비동기적입니다. 변경사항을 추적하려면 .get() 대신 .watch()를 사용하세요.

// 삽입
await into(tasks).insert(TasksCompanion.insert(
    title: Value('식륜구매'),
    priority: Value(3),
));

// 필터로 읽기
final highPriority = await (select(tasks)
    ..where((t) => t.priority.greaterThan(2))
    ..orderBy([(t) => OrderingTerm(expression: t.priority, mode: OrderingMode.desc)]))
    .get();

// 리액티브 관찰
select(tasks).watch().listen((tasksList) {
    // tasksList — List, 테이블이 변경될 때마다 업데이트됨
    updateUi(tasksList);
});

타입화된 결과를 가진 고유 SQL

복잡한 쿼리의 경우, Drift는 타입을 유지하면서 고유 SQL을 작성할 수 있습니다. customSelect 메서드는 쿼리 문자열을 받아 코드 생성기를 통해 타입화된 결과를 반환합니다. 이 접방식은 SQL의 유연성과 Drift의 타입 안전성을 결합합니다.

final result = await customSelect(
    'SELECT title, COUNT(*) as cnt FROM tasks GROUP BY title',
    readsFrom: { tasks },
).get();

for (final row in result) {
    print('${row.readString("title")}: ${row.readInt("cnt")}');
}

Drift에서의 마이그레이션과 버전 관리

Drift는 간단한 변경에 대한 자동 마이그레이션과 복잡한 변환에 대한 수동 마이그레이션을 모두 지원합니다. 데이터베이스 버전은 AppDatabase 생성자에서 설정됩니다. 버전이 일치하지 않으면 Drift는 모든 미루 마이그레이션을 순차적으로 적용합니다.

자동 마이그레이션

기본값이 있는 열을 추가하려면 Drift가 MigrationStrategy를 통해 자동으로 마이그레이션을 생성할 수 있습니다. 변경이 기존 데이터를 깨지 않는 경우(null 가능 필드 추가), 버전 확인과 ALTER TABLE 실행이 있는 beforeOpen을 사용할 수 있습니다.

수동 마이그레이션

복잡한 변경(테이블 이름 변경, 데이터 병합, 열 타입 변경)은 Drift에서 수동 SQL 마이그레이션이 필요합니다. 마이그레이션은 데이터베이스 클래스의 migrations 매개변수를 통해 지정됩니다. 각 마이그레이션은 from/to 번호와 SQL 쿼리가 있는 객체입니다.

Drift와 테스팅

Drift는 NativeDatabase.memory()를 통한 테스트 모드 실행을 지원합니다. 메모리 내 데이터베이스는 각 테스트 전에 처음부터 생성되고 테스트 후 삭제됩니다. 목업을 위해 목업된 QueryExecutor와 함께 mocktail 패키지를 사용하세요. Drift는 마이그레이션과 쿼리 검증을 통한 통합 테스트를 위한 DatabaseTestHelper도 제공합니다.

Drift에서의 DAO 패턴

Drift는 @DriftAccessor 어노테이션이 있는 추상 클래스를 통해 DAO(데이터 액세스 객체)를 지원합니다. DAO는 하나 이상의 테이블에 대한 쿼리를 캡슐화하고 데이터베이스와 별도로 테스트할 수 있습니다. Database를 통한 직접 쿼리와 달리 DAO를 통해 애플리케이션의 다른 부분간에 쿼리 로직을 재사용할 수 있고 단위 테스트가 간소화됩니다.

@DriftDatabase(tables: [Tasks])
class AppDatabase extends $AppDatabase {
    AppDatabase(QueryExecutor e) : super(e) {
        migrations.add(Migration(1, 2, (m) async {
            await m.addColumn(tasks, tasks.dueDate);
            await m.createIndex(tasks.idxPriority);
        }));
    }
}