[flutter] 플러터 objectbox에서 데이터를 백업하는 방법은?

05 Dec 2023

flutter

ObjectBox는 효율적으로 데이터를 저장하고 관리할 수 있는 Flutter용 데이터베이스입니다. 데이터를 안전하게 보호하기 위해 데이터의 백업은 중요한 요소입니다. 이 문서에서는 ObjectBox에서 데이터를 백업하는 방법에 대해 알아보겠습니다.

1. 백업 스킬

1.1. JSON 백업

ObjectBox는 데이터를 JSON 형식으로 백업하는 기능을 제공합니다. 이 기능을 사용하려면 backupToJson() 메서드를 사용하면 됩니다. 해당 메서드는 ObjectBox 데이터베이스 인스턴스에서 호출되어 데이터를 JSON 파일로 내보냅니다.

다음은 ObjectBox로 생성된 데이터베이스를 JSON 파일로 백업하는 예제 코드입니다.

import 'dart:io';
import 'package:objectbox/objectbox.dart';

Future<void> backupData() async {
  // ObjectBox 데이터베이스 디렉토리 경로를 얻어옵니다.
  final directory = Directory(await getApplicationDocumentsDirectory());
  final dbPath = directory.path + '/objectbox';
  
  // ObjectBox 데이터베이스 인스턴스를 생성합니다.
  final store = await Store(getObjectBoxModel(), directory: dbPath);
  
  try {
    // 데이터를 JSON 파일로 백업합니다.
    final backupFile = File(directory.path + '/backup.json');
    store.backupToJson(backupFile);
    print('데이터 백업이 완료되었습니다.');
  } finally {
    // ObjectBox 데이터베이스 인스턴스를 닫습니다.
    await store.close();
  }
}

1.2. 클라우드 백업

데이터의 복구 가능성을 높이기 위해 ObjectBox 데이터를 클라우드 서비스(예: AWS S3, Google Cloud Storage)에 백업하는 것도 좋은 방법입니다. 클라우드 백업은 보다 안전하고 손쉬운 방식입니다.

아래 예제 코드는 Google Cloud Storage를 사용하여 ObjectBox 데이터베이스를 백업하는 방법을 보여줍니다. Google Cloud Storage SDK를 사용하려면 프로젝트에 해당 SDK를 추가해야 합니다.

import 'dart:io';
import 'package:objectbox/objectbox.dart';
import 'package:path/path.dart' as path;
import 'package:googleapis_auth/auth_io.dart' as auth;
import 'package:googleapis/storage/v1.dart';

Future<void> backupData() async {
  // Google Cloud Storage 인증을 위한 서비스 계정 키 파일을 로드합니다.
  final credentials = auth.ServiceAccountCredentials.fromJson({
    "private_key": "<YOUR_PRIVATE_KEY>",
    "client_email": "<YOUR_CLIENT_EMAIL>",
  });

  // 스토리지 클라이언트를 인스턴스화합니다.
  final client =  await auth.clientViaServiceAccount(credentials, [StorageApi.devstorageReadOnlyScope]);
  final storage = StorageApi(client);

  // ObjectBox 데이터베이스 디렉터리 경로를 얻어옵니다.
  final directory = Directory(await getApplicationDocumentsDirectory());
  final dbPath = directory.path + '/objectbox';

  try {
    // ObjectBox 데이터베이스 인스턴스를 생성합니다.
    final store = await Store(getObjectBoxModel(), directory: dbPath);

    // 데이터베이스 파일을 업로드할 버킷을 지정합니다.
    final bucket = '<YOUR_BUCKET_NAME>';
    final objectName = path.basename(dbPath);
    final uploadData = await File(dbPath).readAsBytes();

    // 클라우드에 ObjectBox 데이터베이스 파일을 업로드합니다.
    await storage.objects.insert(
      storage.Object()
        ..bucket = bucket
        ..name = objectName,
      uploadMedia: storage.Media(
        new Stream<List<int>>.fromIterable([uploadData]),
        uploadData.length,
      ),
    );

    print('데이터 백업이 완료되었습니다.');
  } finally {
    // ObjectBox 데이터베이스 인스턴스를 닫습니다.
    await store.close();
  }
}

2. 데이터 복구

ObjectBox에서 데이터의 백업은 매우 중요하지만, 복구 가능한 백업이 비로소 백업의 가치를 실현합니다. 백업 파일을 안전한 위치에 보관해야 합니다. 백업된 데이터를 복구하려면, 백업 파일을 사용하여 restoreFromJson() 또는 클라우드에서 데이터를 다운로드한 뒤 ObjectBox에 복원하는 방법을 사용할 수 있습니다.

import 'dart:io';
import 'package:objectbox/objectbox.dart';

Future<void> restoreData() async {
  // ObjectBox 데이터베이스 디렉토리 경로를 얻어옵니다.
  final directory = Directory(await getApplicationDocumentsDirectory());
  final dbPath = directory.path + '/objectbox';

  // ObjectBox 데이터베이스 인스턴스를 생성합니다.
  final store = await Store(getObjectBoxModel(), directory: dbPath);

  try {
    // 복원할 데이터가 포함된 JSON 파일을 로드합니다.
    final backupFile = File(directory.path + '/backup.json');

    // JSON 파일로부터 데이터를 복원합니다.
    store.restoreFromJson(backupFile);
    print('데이터 복원이 완료되었습니다.');
  } finally {
    // ObjectBox 데이터베이스 인스턴스를 닫습니다.
    await store.close();
  }
}

위 예제에서는 restoreFromJson() 메서드를 사용하여 JSON 파일에서 데이터를 복원합니다. restoreFromJson() 메서드를 호출하기 전에 ObjectBox 데이터베이스 인스턴스를 생성해야 합니다.

3. 결론

ObjectBox에서 데이터를 백업하고 복원하는 방법을 알아보았습니다. backupToJson() 메서드를 사용하여 데이터를 JSON 파일로 백업하거나, 클라우드와 같은 안전한 위치에 데이터를 백업할 수 있습니다. 데이터 복구는 restoreFromJson() 메서드를 사용하여 JSON 파일을 복원하거나, 클라우드에서 데이터를 다운로드할 수 있습니다. 데이터의 백업과 복구는 데이터의 안전성과 중요성을 보장하기 위해 권장되는 작업입니다.