Isar 데이터베이스 사용하기 + 안드로이드 에러 해결

Isar

 Isar는 Hive의 뒤를 잇는 로컬 데이터베이스 패키지입니다.

플러터 이자르 데이터베이스 패키지

플러터 이자르 공식 홈페이지


공식 홈페이지에서 한국어를 선택하여 문서를 쉽게 읽을 수 있습니다.


이자르 데이터베이스 사용하기

Pubspec.yaml

dependencies:

  isar: *isar_version

  isar_flutter_libs: *isar_version # contains Isar Core


dev_dependencies:

  isar_generator: *isar_version

  build_runner: any


Code

메인 함수

main.dart의 main 함수에 async를 추가하고 WidgetsFlutterBinding.ensureInitialized()를 추가합니다.

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  runApp(const MyApp());
}

초기화

path provider 패키지의 getApplicationDocumentsDirectory 함수를 호출하여 데이터를 저장할 path를 가져옵니다.

path provider 패키지

파라미터로 넘겨준 리스트의 Schema로 끝나는 객체들은 컬렉션 클래스를 작성한 후 코드 제너레이션으로 생성된 객체들입니다. 컬렉션 클래스를 먼저 생성한 후 추가해주면 됩니다.

final path = await getApplicationDocumentsDirectory();

_isar = await Isar.open(
  [
    GoldRepositorySchema,
    SoundSettingSchema,
    InGameSaveRepositorySchema,
  ],
  directory: path.path,
);


컬렉션 클래스

맨 위에 part를 추가하고 @collection 어노테이션을 붙여서 만듭니다. 컬렉션 클래스 안에 여러 함수도 추가하여 원하는 기능을 구현할 수 있습니다.

int, double, bool, List, Map 등 기본적인 타입의 데이터만 저장이 가능하고, Enum의 경우 @enumerated 어노테이션을 추가해야 합니다.

아래 예시처럼 다른 객체를 추가하고 싶은 경우, 해당 객체에 @embedded 어노테이션을 추가해야 합니다.

저장하고 싶지 않은 데이터가 있다면 필드 바로 위에 @ignore 어노테이션을 추가합니다.

코드 제너레이션을 진행한 후 이자르 데이터베이스 초기화 하는 코드 부분에 스키마 객체를 추가해주세요.

코드 제너레이션은 dev_dependencies에 build_runner가 작성되어 있어야 합니다.

코드 제너레이션: dart run build_runner build

또는 파일을 변경할 때마다 자동으로 실행하고 싶다면: dart run build_runner watch (종료: Ctrl + C)

part 'in_game_save_repository.g.dart';

@collection
final class InGameSaveRepository {
  Id id = Isarbase.fixedId;

  int round = 0;

  int inGameGold = 0;

  List<InGameSaveModel> inGameSaveDataList = [];

  /// 게임 데이터 백업
  void backupInGameData({
    required int round,
    required int inGameGold,
    required List<InGameSaveModel> inGameSaveDataList,
  }) {
    this.round = round;
    this.inGameGold = inGameGold;
    this.inGameSaveDataList = inGameSaveDataList;
  }

  /// 앱 첫 실행시 한 번 호출
  Future<InGameSaveRepository?> readInGameSave() async {
    final result = await Isarbase.read(this);

    return result as InGameSaveRepository?;
  }

  /// 게임 저장 후 종료
  Future<void> writeInGameSave() async {
    await Isarbase.write(this);
  }

  /// 게임 데이터 삭제하기
  Future<void> deleteInGameSave() async {
    await Isarbase.inGameDelete(this);
  }
}


임베드된 객체

임베드할 객체 맨 위에 part 추가 및 @embedded 어노테이션을 추가합니다.

part 'in_game_save_model.g.dart';

@embedded
final class InGameSaveModel {
  /// 기물의 팀 소속
  @enumerated
  final Team team;

  /// 기물 타입
  @enumerated
  final PieceType pieceType;

  /// 기물의 현재 좌표
  final int x;
  final int y;

  const InGameSaveModel({
    this.team = Team.red,
    this.pieceType = PieceType.king,
    this.x = 4,
    this.y = 8,
  });
}


CRUD

쓰기

writeTxn (Txn = Transactions)을 통해 @collection 클래스의 데이터를 저장합니다.

goldRepositorys는 코드 제너레이션을 통해 생성된 인스턴스입니다. 컬렉션 클래스 이름의 camel case + 끝에 s를 붙여서 만들어집니다.

put 함수의 파라미터로 컬렉션 클래스의 인스턴스를 주면 됩니다.

static Future<void> write(Object data) async {
  await _isar!.writeTxn(() async {
    switch (data.runtimeType.toString()) {
      case 'GoldRepository':
        await _isar!.goldRepositorys.put(data as GoldRepository);
      case 'SoundSetting':
        await _isar!.soundSettings.put(data as SoundSetting);
      case 'InGameSaveRepository':
        await _isar!.inGameSaveRepositorys.put(data as InGameSaveRepository);
      default:
        return;
    }
  });
}


읽기

읽을 데이터의 id를 반드시 넘겨줘야 하는데, 저는 하나의 Row만 저장해두면 돼서 아이디를 1로 고정했습니다. (fixedId = 1)

static Future<Object?> read(Object data) async {
  Object? result;

  switch (data.runtimeType.toString()) {
    case 'GoldRepository':
      result = await _isar!.goldRepositorys.get(fixedId);
    case 'SoundSetting':
      result = await _isar!.soundSettings.get(fixedId);
    case 'InGameSaveRepository':
      result = await _isar!.inGameSaveRepositorys.get(fixedId);
    default:
      return null;
  }

  return result;
}


삭제

await Isarbase._isar!.writeTxn(() async {
  await _isar!.inGameSaveRepositorys.delete(fixedId);
});


Isar 데이터베이스 안드로이드 에러

이자르 패키지 3.0.0 버전 이후부터 안드로이드 그레이들 8.x 버전을 지원하지 않는다고 합니다. 안드로이드에서 실행시키면 에러가 발생할 겁니다.

디버그 모드, 릴리즈 모드 둘다 각각 다른 에러가 납니다. android/build.gradle 파일을 다음과 같이 수정해보세요.

rootProject.buildDir = "../build"
subprojects {
    project.buildDir = "${rootProject.buildDir}/${project.name}"
}
subprojects {
    //  fix for verifyReleaseResources
    // ============
    afterEvaluate { project ->
        if (project.plugins.hasPlugin("com.android.application") ||
                project.plugins.hasPlugin("com.android.library")) {
            project.android {
                compileSdkVersion 34
                buildToolsVersion "34.0.0"
            }
        }
        if (project.hasProperty("android")) {
            project.android {
                if (namespace == null) {
                    namespace project.group
                }
            }
        }
    }
    // ============
    project.buildDir = "${rootProject.buildDir}/${project.name}"
    project.evaluationDependsOn(':app') // add this also
}
subprojects {
    project.evaluationDependsOn(":app")
}

다른 부분인 두 번째 subprojects 부분을 업데이트 해주세요.


죽은 프로젝트?


Published 20 months ago...

이제 곧 2년이 다 되어 가네요.. 정말 훌륭한 로컬 데이터베이스인데 제발 버리지 않았기를 빕니다...


전체 코드

import 'package:isar/isar.dart';
import 'package:path_provider/path_provider.dart';
import 'package:samyeonchoga/repository/gold/gold_repository.dart';
import 'package:samyeonchoga/repository/in_game/in_game_save_repository.dart';
import 'package:samyeonchoga/repository/sound/sound_setting.dart';

sealed class Isarbase {
  static Isar? _isar;

  static const int fixedId = 1;

  static Future<void> initIsarbase() async {
    final path = await getApplicationDocumentsDirectory();

    _isar = await Isar.open(
      [
        GoldRepositorySchema,
        SoundSettingSchema,
        InGameSaveRepositorySchema,
      ],
      directory: path.path,
    );
  }

  static Future<void> write(Object data) async {
    await _isar!.writeTxn(() async {
      switch (data.runtimeType.toString()) {
        case 'GoldRepository':
          await _isar!.goldRepositorys.put(data as GoldRepository);
        case 'SoundSetting':
          await _isar!.soundSettings.put(data as SoundSetting);
        case 'InGameSaveRepository':
          await _isar!.inGameSaveRepositorys.put(data as InGameSaveRepository);
        default:
          return;
      }
    });
  }

  static Future<Object?> read(Object data) async {
    Object? result;

    switch (data.runtimeType.toString()) {
      case 'GoldRepository':
        result = await _isar!.goldRepositorys.get(fixedId);
      case 'SoundSetting':
        result = await _isar!.soundSettings.get(fixedId);
      case 'InGameSaveRepository':
        result = await _isar!.inGameSaveRepositorys.get(fixedId);
      default:
        return null;
    }

    return result;
  }

  static Future<void> inGameDelete(InGameSaveRepository inGamaData) async {
    await Isarbase._isar!.writeTxn(() async {
      await _isar!.inGameSaveRepositorys.delete(fixedId);
    });
  }
}

댓글

댓글 쓰기

이 블로그의 인기 게시물

카트라이더 개선 방안

이미지
카트라이더: 드리프트 서비스 종료 2025년 6월 16일, 디렉터 님께서 카트라이더: 드리프트 서비스 종료를 공지하셨습니다. 유저들의 많은 불만을 잠재우지 못하고 결국 좋지 않은 결과를 초래하였습니다. 카트라이더: 드리프트의 실패 요인은 여러 가지가 있지만, 제 생각에는 승부에 걸맞지 않는 게임의 가벼운 분위기 가 가장 크다고 생각합니다. 카트라이더는 캐주얼한 분위기와 함께 남녀노소 모두가 가볍게 즐길 수 있는 쉬운 게임이지만, 결국 메인이 되는 컨텐츠는  실력을 통한 경쟁 입니다. 다양한 카트바디와 함께 각자의 전략을 통해 상대를 이겨서 만족감을 얻는 게임입니다. 원작 카트에서는 카트바디가 다양했고, 성능도 각각 달라서 전술에 맞게 카트를 선택하고 상대방과의 심리전과 고도의 집중력을 필요로하는 피지컬이 요구되어서 승부를 보는 맛이 있었습니다. 이와 반대로 카트라이더: 드리프트의 카트바디 대부분의 성능이 비슷비슷하고 큰 차별점이 없었습니다. 최근엔 기어를 통한 업그레이드로 카트바디 마다 능력치는 다르게 할 수 있었지만 카트바디의 개성이 업그레이드 되진 않았다고 생각합니다. 특히 아이템전의 경우 원작 카트에서는 황금 미사일, 얼음 물폭탄 등 카트바디 마다 특수 기능이 존재했지만 카드맆에서는 그렇지 않기 때문에 게임 플레이의 다양성이 부족하고 다이나믹한 장면을 연출할 수 없었습니다.(캐릭터 스킬 패치가 있긴 했지만...) (또한 개인적으로 아쉬웠던건 부스터 디자인이 모두 변신 없이 단번에 출력되는 형식이었고 카트가 다 비슷비슷하게 생겼던 것 같습니다.) 게임 구성이 전반적으로 심플하고, 가벼웠습니다. 이것이 실패 요인이라고 생각합니다. 개인적인 생각으로, 디렉터님은 폴 가이즈 게임을 본받아 카트라이더: 드리프트의 방향성을 정한 것이 아닌가 싶습니다.(업 앤 다운 패치를 통해 더욱 확신을 가진 생각입니다) 게임 자체를 심플하게 만들어 누구나 접근성이 좋게 만들려고 하셨던 것 같습니다. 그래서 페이투윈 문화 지양, 게임 초반 당시 채팅 기능의 부재를 조금은 ...
자세한 내용 보기

팩토리 패턴을 응용한 플러터의 클린 아키텍처

이미지
클린 아키텍처 전 아직도 이 그림이 뭔지 하나도 모르겠습니다. 그럼에도 불구하고 여러 블로그를 탐방하며 클린 아키텍처를 최대한 이해하려고 했고, 저만의 클린 코드를 작성해 보았습니다. 클린 아키텍처를 공부하면서 맘에 안들었던 점 폴더 구조가 크게 두가지가 있습니다. Feature-first와 Layer-first 입니다. 최상위에 위치하는 폴더가 앱의 기능 단위인 것과 클린 아키텍처의 Data, Domain, Presentation 계층인 것입니다. 그런데 전... 둘 다 썩 맘에 들지 않았습니다. Feature-first는 기능 단위로 코드 구조가 눈에 확 들어와서 좋긴 한데, 둘 이상의 Feature가 공유하는 코드가 있다면 그게 전부 common 폴더로 모이게 됩니다. 그러면 common 폴더가 비대해지면서 폴더 구조의 체계가 모호해지는 부분이 있습니다. Layer-first는 기능을 수정해야 할 때 폴더를 이리 저리 돌아다녀야 하고... 좀 난잡한 느낌이 듭니다. 그리고 클린 아키텍처를 공부하면서 새롭게 배운 단어들이 생소했습니다. Entity, DTO, Domain, Presentation... 이 단어들을 쓰고 싶지 않았습니다. 뭐 얼마든지 바꾸면 되겠지만, 네이밍 관련해서도 깊게 고민했습니다. 실제로 저와 같이 사이드 프로젝트 진행하는 동료들이 제 프로젝트를 보고 원하는 코드를 찾는 데 좀 어려웠다고 전했습니다. 클린 아키텍처를 잘 모르는 개발자라면 entity가 뭐고, domain이 뭔지 잘 모릅니다. 또한 DTO 클래스의 필요성을 전혀 느끼지 못했습니다. 왜냐하면 Dart에는 factory 생성자가 있기 때문입니다. 굳이 DTO 클래스를 만들지 않더라도 충분히 외부 환경에 유연하게 대응할 수 있겠다고 생각했습니다. 그렇게 고민을 하면서 저만의 클린 코드를 만들게 되었습니다. 먼저, 코드의 세부 구성부터 보여드리겠습니다. 외부 모델 DTO와 내부 모델 Entity -> Model로 통일 데이터 모델의 경우, DTO와 Entity로 나눕니다....
자세한 내용 보기

프로젝트 사면초가

이미지
드디어 저의 사면초가 프로젝트가 완성되었습니다. 군복무 시절, 일이 없어 잔류로 남아있는 일과 시간에는 시간이 잘 가지 않고 심심하기도 해서 보드게임을 즐기곤 했습니다. 각종 보드 게임, 체스, 오목, 장기 등 여러 게임들을 했는데, 저는 그 중 장기가 가장 재미있었습니다. 체스나 오목은 어렸을 때에도 많이 해봤는데, 장기는 태어나서 처음 해봤습니다. 규칙을 아예 모르고 있었습니다. 처음 장기판과 기물들을 자세히 보았더니 예전에 넷마블 알까기 게임이 생각났습니다. 그 게임은 알고 보니 장기판과 장기 기물들을 빌린 거였네요. 전역 후 지금까지도 온라인 게임으로 장기를 두고 있습니다. 장기는 저의 취미로 깊게 자리 잡았습니다. 사면초가( 四面楚歌) '사방에서 초나라 노래가 흘러나온다는 뜻으로, 적에게 완전히 포위되어 희망이 없는 고립무원(孤立無援)의 상태를 이르는 말' 장기는 초한전쟁을 배경으로 만들어진 게임이라고 합니다. 초나라가 한나라와의 전투에서 패배하였고, 한나라가 초나라의 사기를 꺾기 위해서 항복한 초나라 병사들에게 노래를 부르게 했습니다. 초나라의 패왕인 항우가 사방에서 들려오는 초나라의 노래를 듣고  ‘초는 이미 유방에게 넘어간 것인가? 어떻게 포로의 수가 저렇게 많은가!’ 라며  탄식을 하였다고 합니다. 사면초가의 상황을 맞이한거죠. 저의 프로젝트는 한나라의 기물이 지속적으로 부활하면서 초나라의 왕을 노립니다. 유저는 초나라 진영에서 플레이 하고, 초나라는 끊임없이 쳐들어오는 한나라의 공격을 막으면서 최대한 오래 버티는 게임입니다. 그렇게 결국 초나라는 힘이 빠지면서 사방의 한나라 기물들에게 위협받을 것이고, 사면초가의 상황을 맞이한 초나라의 왕은 결국 죽게 됩니다. 메인 스크린 홈 게임 시작, 도움말, 환경 설정으로 이루어진 홈 스크린입니다. 대국에서 사용할 골드를 정하고 포진을 선택하여 게임을 시작할 수 있습니다. 도움말을 통해 게임에 대한 상세한 설명을 참고할 수 있습니다. 환경설정을 통해 효과음 볼륨 조절을 할 수 있습니다. ...
자세한 내용 보기