테마 글에서 앱 안의 스위치로 다크 모드를 바꿨는데, 앱을 껐다 켜면 다시 처음 상태로 돌아간다고 했다. 값을 변수에 담아뒀기 때문이다. 변수는 앱이 실행되는 동안만 메모리에 있다.

class _MyAppState extends State<MyApp> {
  ThemeMode themeMode = ThemeMode.system; // 앱을 끄면 사라짐

  void toggle(bool isDark) {
    setState(() {
      themeMode = isDark ? ThemeMode.dark : ThemeMode.light;
    });
  }
}

스위치를 켜고 앱을 완전히 종료한 뒤 다시 실행하면 ThemeMode.system으로 돌아간다. 사용자 입장에서는 "설정이 저장이 안 되는" 앱이다. 앱을 꺼도 남아야 하는 값은 기기의 저장소에 써야 한다.

원인: 메모리에 있는 값은 앱이 죽으면 같이 사라진다

저장소는 크게 두 가지로 나뉜다. 설정값 몇 개처럼 작고 단순한 값은 키-값 저장소(shared_preferences), 목록처럼 여러 줄의 데이터를 조건으로 찾아야 하면 데이터베이스(sqflite, drift)를 쓴다.

해결 1: shared_preferences로 설정값 저장하기

flutter pub add shared_preferences

shared_preferences는 int, double, bool, String, 문자열 리스트를 키와 함께 저장한다. 새로 시작한다면 공식 문서가 권하는 SharedPreferencesAsync를 쓴다.

import 'package:shared_preferences/shared_preferences.dart';

final prefs = SharedPreferencesAsync();

// 저장
await prefs.setBool('isDark', true);

// 읽기
final isDark = await prefs.getBool('isDark') ?? false;

• setBool('키', 값): 키에 값을 저장한다. setString, setInt도 있다
• getBool('키'): 키의 값을 읽는다. 저장된 적이 없으면 null이라서 Future<bool?> 를 돌려준다
• ?? false: 처음 실행처럼 값이 없을 때를 대비한 기본값이다. null safety 글의 ??가 그대로 쓰인다

저장과 읽기 모두 Future라서 await를 붙여야 한다. 빼먹으면 Future<bool?>를 bool처럼 쓰려다 타입 에러가 난다.

앱이 시작할 때 저장된 값을 읽어서 넘겨주면 껐다 켜도 설정이 유지된다.

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final prefs = SharedPreferencesAsync();
  final isDark = await prefs.getBool('isDark') ?? false;

  runApp(MyApp(isDark: isDark));
}

값을 바꿀 때는 setState와 함께 저장도 한다.

void toggle(bool isDark) async {
  setState(() {
    themeMode = isDark ? ThemeMode.dark : ThemeMode.light;
  });
  await SharedPreferencesAsync().setBool('isDark', isDark);
}

삽질 포인트 1: main에서 await를 쓰려는데 바인딩 에러가 난다

runApp 전에 플러그인을 쓰면 Flutter가 아직 준비되지 않았다는 취지의 에러가 난다. main을 async로 바꾸고 맨 위에 WidgetsFlutterBinding.ensureInitialized();를 넣는다. shared_preferences처럼 기기 기능을 쓰는 플러그인을 앱 시작 전에 부를 때 필요한 한 줄이다.

삽질 포인트 2: 옛 방식과 새 방식은 데이터를 공유하지 않는다

예전 글에는 SharedPreferences.getInstance()가 많이 보인다. 이 방식도 아직 있지만, 새 API(SharedPreferencesAsync, SharedPreferencesWithCache)는 저장 위치가 달라서 옛 방식으로 저장한 데이터를 자동으로 읽지 못한다. 공식 문서가 직접 옮기는 과정이 필요하다고 경고한다. 이미 배포한 앱을 바꿀 때는 이전 데이터를 옮기는 코드를 먼저 확인해야 하고, 새 앱이라면 처음부터 새 API로 시작하면 된다.

삽질 포인트 3: 객체나 비밀번호를 넣고 싶어진다

shared_preferences는 위에 적은 몇 가지 타입만 저장한다. User 같은 객체를 저장하려면 앞 글에서 만든 toJson으로 JSON 문자열로 바꿔 setString에 넣는 방법이 있다. 하지만 항목이 여러 개로 늘고 "조건으로 찾기"가 필요해지면 데이터베이스로 가는 게 맞다. 또 shared_preferences는 암호화되지 않은 평범한 저장소라서 로그인 토큰이나 비밀번호를 넣으면 안 된다. 그런 값은 보안 저장소 패키지(flutter_secure_storage)를 쓴다.

해결 2: 여러 줄의 데이터는 데이터베이스에

할 일 목록처럼 항목이 늘어나고, "완료 안 된 것만", "제목으로 검색" 같은 조건이 필요하면 SQLite 기반 데이터베이스를 쓴다. 선택지는 둘이다.

• sqflite: SQL 문자열을 직접 써서 실행하는 저수준 라이브러리다. db.insert('todos', {'title': '우유 사기'})처럼 쓰고, 결과는 Map의 목록으로 받는다. 간단하지만 SQL 문자열과 컬럼 이름의 오타를 컴파일러가 못 잡는다
• drift: 테이블을 Dart 클래스로 정의하고 타입이 있는 코드로 질의한다. 앞 글에서 본 코드 생성(build_runner)을 쓴다. 이 글은 이쪽으로 간다

flutter pub add drift drift_flutter
flutter pub add dev:drift_dev
flutter pub add dev:build_runner

테이블과 데이터베이스를 정의한다.

import 'package:drift/drift.dart';
import 'package:drift_flutter/drift_flutter.dart';

part 'database.g.dart';

class Todos extends Table {
  IntColumn get id => integer().autoIncrement()();
  TextColumn get title => text()();
  BoolColumn get done => boolean().withDefault(const Constant(false))();
}

@DriftDatabase(tables: [Todos])
class AppDatabase extends _$AppDatabase {
  AppDatabase() : super(driftDatabase(name: 'app_db'));

  @override
  int get schemaVersion => 1;

  Future<List<Todo>> getAll() => select(todos).get();

  Stream<List<Todo>> watchAll() => select(todos).watch();

  Future<int> add(String title) =>
      into(todos).insert(TodosCompanion.insert(title: title));

  Future<int> remove(int id) =>
      (delete(todos)..where((t) => t.id.equals(id))).go();
}

• class Todos extends Table: 표의 컬럼을 Dart로 적는다. id는 자동 증가, title은 글자, done은 기본값이 false인 참/거짓이다
• @DriftDatabase(tables: [Todos]): 이 데이터베이스가 어떤 표를 쓰는지 알려준다. _$AppDatabase, Todo, TodosCompanion은 생성기가 만들어주는 코드다
• schemaVersion: 표 구조의 버전이다. 구조를 바꿀 때마다 올린다
• select(todos).get(): 전체를 한 번 읽는다
• select(todos).watch(): 값이 바뀔 때마다 새 목록을 흘려주는 Stream 이다
• into(todos).insert(TodosCompanion.insert(title: title)): 한 줄 추가한다. Companion은 "아직 id가 없는 새 항목"을 담는 생성된 클래스다
• (delete(todos)..where(...)).go(): 조건에 맞는 줄을 지운다. ..는 앞의 객체에 조건을 붙이고 그 객체를 그대로 이어가는 문법이다

정의를 쓴 뒤 dart run build_runner build로 database.g.dart를 생성한다. 이 글의 watchAll()이 돌려주는 Stream은 다음 글의 StreamBuilder에서 바로 화면에 연결한다. 항목을 추가하거나 지우면 목록이 자동으로 갱신된다.

삽질 포인트: 표를 고쳤더니 기존 사용자 앱이 죽는다

개발 중에는 앱을 지우고 다시 설치하면 되지만, 이미 설치한 사용자에게는 이전 구조의 데이터베이스 파일이 남아 있다. 표에 컬럼을 추가하고 schemaVersion만 올리고 옮기는 방법(마이그레이션)을 안 적으면 기존 사용자에게서 문제가 생긴다. 구조를 바꿀 때는 버전을 올리고 이전 버전에서 새 구조로 바꾸는 코드를 함께 작성해야 한다.

또 part 'database.g.dart'가 없거나 생성기를 다시 안 돌리면 _$AppDatabase를 찾을 수 없다는 에러가 난다. JSON 글에서 본 것과 같은 상황이다.

Android, iOS와 비교하면

// Kotlin - DataStore, Room
val isDark = dataStore.data.map { it[DARK_KEY] ?: false }

@Entity data class Todo(@PrimaryKey(autoGenerate = true) val id: Int, val title: String)
@Dao interface TodoDao { @Query("SELECT * FROM todo") fun watchAll(): Flow<List<Todo>> }

// Swift - UserDefaults, SwiftData
UserDefaults.standard.set(true, forKey: "isDark")

@Model class Todo { var title: String; init(title: String) { self.title = title } }

• 간단한 설정값: Flutter shared_preferences / Android DataStore (옛 SharedPreferences) / iOS UserDefaults
• 표 정의: Flutter Table 클래스 / Room @Entity / SwiftData @Model, Core Data 엔티티
• 질의: Flutter는 select(todos) 같은 Dart 코드 / Room은 @Dao의 SQL / SwiftData는 @Query
• 변경 알림: Flutter watch()의 Stream / Room의 Flow / SwiftData는 @Query가 자동
• 코드 생성: Flutter build_runner, Room은 kapt/KSP

Room과 가장 닮았다. Table이 @Entity, AppDatabase가 @Database, 질의 메서드가 @Dao, watch()의 Stream이 Flow에 해당한다. 안드로이드 이름과 같은 SharedPreferences도 있는데, 옛 안드로이드 SharedPreferences와 같은 계열이다.

정리

• 변수에 담은 값은 앱이 꺼지면 사라지므로, 남겨야 하는 값은 기기의 저장소에 쓴다
• 설정값 몇 개는 shared_preferences의 SharedPreferencesAsync로 저장하고, 읽을 때는 값이 없을 수 있어 ??로 기본값을 준다
• main에서 await로 플러그인을 쓰려면 WidgetsFlutterBinding.ensureInitialized()가 필요하다
• 옛 SharedPreferences와 새 API는 데이터를 자동으로 공유하지 않고, 비밀번호나 토큰은 shared_preferences에 넣지 않는다
• 여러 줄의 데이터를 조건으로 찾아야 하면 데이터베이스를 쓰고, sqflite는 SQL을 직접 쓰는 방식, drift는 Dart 코드로 질의하는 방식이다
• drift는 Table, @DriftDatabase로 정의하고 build_runner로 생성하며, watch()는 값이 바뀔 때마다 알려주는 Stream이다
• 표 구조를 바꿀 때는 schemaVersion을 올리고 기존 데이터를 옮기는 마이그레이션도 함께 쓴다

다음 글에서는 Future와 Stream을 화면에 연결하는 FutureBuilder, StreamBuilder, AsyncValue를 다뤄보겠다.