🛢️ Hive(NoSQL) 사용해 보기

hive | Dart Package
Hive Docs

이번 글에서는 Flutter에서 가장 인기가 좋은 로컬 저장소인 Hive에 대해서 다뤄보도록 하겠다.

Hive 사용에 앞서 로컬 저장소가 왜 필요할까 ? 로컬 저장소를 자주 사용하지 않는 개발자 분들도 있겠지만 거의 대부분은 폭 넓게 사용하고 있을거라 생각한다.

저도 앱 개발을 진행할 때 손쉽게 Firebase를 사용해 Fiestore DB를 사용하고 있지만, 무료 티어가 지나고 나면 과금이 되기에 로컬 저장소를 함께 사용해 이러한 리소스를 줄이는데 도움이 되고 있다.

모든 데이터를 로컬 저장소 만으로 사용할 수는 없지만 알아두면 꼭 사용할 일이 생길 것이다.

Hive는 NoSQL DB인데, 로컬 저장소를 복잡한 관계형 구조로는 구축하지 않기에 저는 Hive가 가장 좋은 선택지라고 본다.
Hive가 아니더라도 SQLite, Sembast, Floor, Drift 등 다양한 로컬 저장소 형태를 제공하고 있다.

NoSQL 구조또한 익숙한 key-value 구조이기에, 데이터베이스를 처음 다뤄보는 개발자 분들도 손쉽게 사용해 볼 수 있을 것 같다. NoSQL에 대해서 잘 모르시면 CRUD의 개념만 파악하셔도 간단하게 사용하는데 문제는 없다.

Hive

Dependencies

dependencies에 hive package 들을 추가해 주도록 하자.

먼저 hive 사용을 위해 hive 패키지는 당연히 추가되어야 하고, hive_flutter도 hive 데이터베이스를 flutter에서 사용하기 위해 꼭 추가되어야 하는 확장 패키지이다.

hive는 Hive 데이터베이스 패키지이고, hive_flutter 패키지가 바로 flutter에서 hive 사용을 도와주는 거라고 생각하면 된다.

dev_dependencies에 hive_generator, build_runner 패키지가 추가되어야 하는데, 이 부분은 선택 사항이다.

hive에서 객체를 이용한 데이터 관리를 하고 싶다면 hive에서 지원하는 객체 지원 기능인 TypeAdapter를 사용하면 된다.
TypeAdapter는 code generator로 생성되기 때문에, build_runner, hive_generator를 추가해 주어야 한다.

객체 사용이 필요 없다면 굳이 추가하지 않아도 됩니다.

dependencies:
	hive: ^2.2.3
    hive_flutter: ^1.1.0

dev_dependencies:
	build_runner: ^2.4.7
    hive_generator: ^2.0.1

Initalization

이제 본격적으로 hive 사용을 해보도록 하자. hive 사용을 위해 가장 먼저 해야 하는 부분은 당연히 hive 초기화를 진행해 주어야 한다.

Flutter Applications

await Hive.initFlutter();

Non Flutter Applications

await Hive.init();

main()

void main() async {
  await Hive.initFlutter();
  runApp(const MyApp());
}

openBox

hive 사용시 알아두어야 하는 개념이 box이다. 데이터를 저장하는 하나의 공간을 box라고 하는데, 관계형 데이터베이스의 Table, NoSQL 구조의 collection이라고 이해하면 쉬울 것 같다.

box는 키 값을 지정하여 접근해 사용하는데, box를 사용하기 전에 먼저 box를 열고 있어야만 접근이 가능하게 된다.

box를 오픈하는 방법은 간단하다. 아래 코드를 사용해서 호출하면 되는데, 호출시 box를 생성할 때 지정한 키 값으로 호출하면 된다.

만일 해당하는 키 값에 생성한 box가 없다면 새로운 box를 생성하게 되고, 존재 한다면 일치하는 box를 열어준다.

await Hive.openBox("openBox");

만일 box를 오픈하지 않고 접근하게 되면 어떻게 될까 ? 아래와 같은 에러가 발생하게 된다.

Unhandled Exception: HiveError: Box not found. Did you forget to call Hive.openBox()?

openBox()를 하게되면, box를 메모리 공간에 올려두게 되는데, openBox를 호출한 시점이 아닌 box에 접근하는 시점에 box를 열고 싶다면 lazy하게 처리해 주면 된다.

Hive.openLazyBox("openBox");

이미 오픈된 box를 반복해서 오픈하는 부분에 대해서는 해당 기능이 싱글톤으로 생성 되었기 때문에, 기존 box를 리턴하게 되어 있어 신경쓰지 않아도 된다고 한다.

Create

오픈된 box에 접근해서 데이터를 실제로 저장해보도록 하자.

hive에 데이터를 저장하는 방법은 2가지 방법이 있는데, 먼저 key-value 구조로 데이터를 저장하는 방법이 있고, key 없이 value만 저장하는 방법이 있다.

put

person box를 하나 만들어서 put 함수를 사용해 key: "name", value: "tyger"로 데이터를 저장해보도록 하자.

Hive.openBox("person");
Box box = Hive.box("person");
box.put("name", "tyger");

저장된 값을 확인하고 싶다면 로그를 찍어보면 된다.

print(box.values);

name으로 tyger 값이 잘 저장된 것을 확인할 수 있다.

이번엔 age 값도 저장해보자. 저장 후 출력해보면 (20, tyger) 이렇게 값이 출력되는 것을 확인할 수 있다.

box.put("age", 20);

add

이번엔 add() 함수를 사용해서 데이터를 저장해보자. 키 값이 따로 없기 때문에, value만 넣어주면 된다.

Box box = Hive.box("person");
box.add("tyger1");

자 우선 저장하는 방법은 간단하게 사용 가능한 것을 확인했다. 이제 저장한 데이터를 읽어 오면서 put(), add() 저장 방식의 차이점과 어떻게 사용해야 하는지를 살펴보도록 하자.

Read

지금까지 저장한 person box의 value들을 호출해보면, 문제 없이 출력이 된다.

Box box = Hive.box("person");
print(box.values);
// (tyger1, 20, tyger)

이번엔 person box의 key들을 호출해보자.

출력해 보면 "(0, age, name)" 이렇게 출력이 되는 것을 확인할 수 있다.

add로 데이터를 저장하게 되면, 키 값이 인덱스 순서로 자동으로 지정되어서 키에 0이라는 값이 지정된 것이다.

Box box = Hive.box("person");
print(box.keys);
// (0, age, name)

이번에 key 값으로 데이터를 조회해 보자.

print(box.get("name"));
// tyger
print(box.get("age"));
// 20

add를 사용해 저장된 데이터는 키 값으로 조회를 할 수 없다. 물론 키 값을 찾아 조회를 하려면 할 수는 있겠지만 좋은 방식은 아니다.

add()와 put()에 대해서는 아래에서 TypeAdapter 부분을 배우면서 더 자세히 다루도록 하겠다.

이어서 데이터 조회시 존재하지 않는 키 값으로 조회를 하게 되는 경우 null을 리턴하기에 nullable 타입으로 데이터를 조회하면 되고, default 값을 지정하여 조회하고 싶다면 기본 값 지정 기능을 사용하면 된다.

print(box.get("birthday"));
// null

print(box.get("birthday", defaultValue: 20230101));
// 20230101

Delete

이번엔 데이터를 삭제하도록 하자. 데이터를 삭제하는 방법은 키 값을 사용해 삭제하는 방법이 있고, box 자체를 지우는 방법이 있다.

delete()를 사용하는 경우 지정된 key 값의 데이터를 삭제하게 된다.

Box box = Hive.box("person");
box.delete("name");

deleteAll()은 키 값들을 배열로 받아 존재하는 키 값들의 데이터를 전부 삭제하는 방법이다.

Box box = Hive.box("person");
box.deleteAll(["name", "age"]);

box 자체를 아무것도 없는 빈 박스로 만들고 싶다면, clear() 기능을 사용하면 된다.

clear()는 box안에 데이터를 전부 지워버려 빈 상태로 만들기 때문에 주의하여 사용해야 한다.

Box box = Hive.box("person");
box.clear();

Update

저장된 데이터를 변경하는 방법에 대해서 살펴보도록 하자.

사실 Update는 hive에서는 Create와 크게 다른게 없는 부분이긴 하다.

Box box = Hive.box("person");
box.put("name", "tyger");
print(box.get("name"));
// tyger

이번에는 소문자로 저장한 name을 대문자로 변경해보도록 하겠다.

Box box = Hive.box("person");
box.put("name", "TYGER");
print(box.get("name"));
// TYGER

이렇게 hive는 동일 키 값에 대해 데이터를 업데이트 시키고 있다.

---

Details

지금까지 hive에 기본 적인 사용 방법에 대해서 살펴 봤다. 사실 key-value 형태의 저장소로 사용 한다면, shared_preferences와 사용 방법은 동일하다고 볼 수 있다.

이번에는 위에서 자세히 다루지 못한 put(), add()에 대해서 차이점을 살펴보고 적절하게 사용해야 하는 부분에 대해서도 다뤄보도록 하자.

위에서 사용한 person 박스는 name, age 를 키 값으로 가지고 있어, 하나의 person 만 생성할 수 있었다.

여러 명의 person을 저장하고 싶다면 어떻게 해야할까 ? person 박스를 person1, person2 ... 이런식으로 추가해줘야 할까 ? .. 아니다

hive 에서는 box가 호출될 때, 메모리 한 영역의 공간을 차지하고 있기에 쓸데없이 box가 생성되는 것도 비효율 적일 수 있다.

여러 개의 동일한 데이터를 저장하는 방법은 객체를 생성하여 배열에 담아주는 방법이 더 좋은 방법일 것이다.

데이터를 좀 더 복잡한 구조로 저장해 보도록 하자. 키를 person으로 데이터를 Map 구조로 넣어서 저장하였다.

Box box = Hive.box("person");
box.put("person", {
	"name": "tyger",
	"age": 20,
});
final person = box.get("person");
print(person);
print(person["name"]);

// {name: tyger, age: 20}
// tyger

해당 구조에서 person1, person2 를 추가하도록 하자. 한 번에 데이터를 추가하고 싶다면 putAll() 기능을 사용할 수 있다.

box.putAll({
	"person1": {
		"name": "tyger1",
		"age": 30,
	},
	"person2": {
		"name": "tyger2",
		"age": 40,
	},
});
print(box.values);

// {name: tyger, age: 20}, {name: tyger1, age: 30}, {name: tyger2, age: 40}

위의 방법이 효율적인 방법일까 ? 물론 저렇게 저장해서 사용해도 된다. 하지만 키 값을 따로 주지 않고, mapIndexed 형태에 의해 자동으로 키 값이 부여 되게 저장해주는 방법이 더 좋을 것이다.

person box를 위에서 배운 clear() 함수를 사용해 전부 비워주고 이번에는 addAll() 기능을 사용해서 데이터를 저장해 보도록 하자.

Box box = Hive.box("person");
box.addAll([
	{
		"name": "tyger",
		"age": 20,
	},
	{
		"name": "tyger1",
		"age": 30,
	},
	{
		"name": "tyger2",
		"age": 40,
	},
]);
print(box.values);
print(box.getAt(2));

// ({name: tyger, age: 20}, {name: tyger1, age: 30}, {name: tyger2, age: 40})
// {name: tyger2, age: 40}

위의 방식을 사용해서 동일한 구조의 데이터를 더 손쉽게 저장할 수 있게 됬다.

해당 데이터를 읽어올 때에 새로운 방법이 사용 됬는데, 바로 getAt(index) 기능이다. 배열의 인덱스 값을 조회할 때 사용하는 방법과 완전히 동일하며, 배열의 인덱스 값보다 큰 범위를 조회하게 되면 당연히 에러가 발생한다.

위의 방식에서 데이터를 업데이트 하고 싶다면 어떻게 하면 될까 ? 키 값을 모르는 상태에서 데이터를 변경하려면 쿼리를 통해 키 값을 찾아올 수 있다.

Query

hive 저장소의 쿼리 지원 방식은 키 값을 사용해 데이터를 조회하는 방법을 사용해도 되고, add 함수를 사용해 자동 키를 생성한 경우라면, Flutter의 리스트 조회 기능을 사용하여 쿼리를 사용할 수 있다.

hive 공식 문서에도 쿼리를 지원하지 않는게 단점은 아니라고 나와있다. 실제로 데이터를 읽어와 Flutter에서 직접 처리하는게 속도면에서는 더 좋다.

Hive does not have a query language and only has limited support for sorting, which is not necessarily a disadvantage, as you can see in the benchmark. Sorting and filtering are much faster if you do it yourself in Dart.

age가 30인 데이터를 조회해 오도록 하자. 간단하다. 기존 배열 사용 방법과 완전히 동일하기 때문에 손쉽게 사용할 수 있다.

List<dynamic> query = box.values.where((e) => e["age"] == 30).toList();
print(query);

// [{name: tyger1, age: 30}]

조회한 데이터의 age를 25로 변경해 보도록 하자.

조회한 데이터의 배열 index 값을 찾아 해당 index에 접근하여 데이터를 수정해 오도록 하자. 이 때 사용할 수 있는 기능이 바로 putAt(index) 기능이다.

print(box.values);

// ({name: tyger, age: 20}, {name: tyger1, age: 30}, {name: tyger2, age: 40})

List<dynamic> query = box.values.where((e) => e["age"] == 30).toList();
int index = query.map((e) => box.values.toList().indexOf(e)).first;
box.putAt(index, {
		"name": query.first["name"],
		"age": 25,
	});
    
print(box.values);

// ({name: tyger, age: 20}, {name: tyger1, age: 25}, {name: tyger2, age: 40})

이제 마지막으로 좀 더 디테일하게 데이터베이스를 다루기 위해서 hive의 중요한 기능인 TypeAdapter에 대해서 살펴보도록 하겠다.

TypeAdapter

TypeAdapter는 hive 데이터베이스에서 객체를 다룰 수 있도록 해주는 기능이다.

지금까지는 객체를 생성하지 않고 Map 구조로만 데이터를 다뤄봤는데, 불편하고 위험하다.

복잡한 구조의 데이터를 저장하고 싶다면 TypeAdapter는 필수적으로 사용해야 하는 기능일 것이다.

이번에는 자동차 공장에서 생산할 수 있는 데이터를 hive에 저장하고 수정하고 삭제해 보면서 사용해 보도록 하겠다.

먼저, 공장에서 생산할 수 있는 모델을 생성해주기 위해 Car 모델을 생성해 주도록 하자.

class

Code Generator는 생성되는 정해진 규칙을 반드시 따라야만 제대로 코드가 생성이 된다.

hive_generator에서는 annotation으로 객체에 HiveType(typeId: id)을 각 필드에 HiveField(id)를 넣어주게 되어있다.

객체간 HiveType의 id는 중복될 수 없으며, 1~222 범위 내에서만 사용해야 한다.

각 필드는 객체 내에서는 중복될 수 없으며, 0~255 범위 내로만 사용할 수 있다.

255번이면 필드 생성에는 아무런 문제가 없기에 참고만 하면 될 것 같다.

변수 타입으로는 Flutter의 기본 타입은 지원하지만, 만일 MaterialColor를 저장하고 싶다면 MatrialColor 객체를 상속받아 새롭게 만들어주고 사용해야 한다.

part 'car.g.dart';

@HiveType(typeId: 1)
class Car {
  @HiveField(0)
  int number;

  @HiveField(1)
  Brand type;

  @HiveField(2)
  String name;

  @HiveField(3)
  List<String> colors;

  @HiveField(4)
  bool isRoof;

  Car({
    required this.number,
    required this.brand,
    required this.name,
    required this.colors,
    required this.isRoof,
  });

  @override
  String toString() =>
      "Car(number: $number, brand: $brand, name: $name, colors: $colors, isRoof: $isRoof)";
}

enum

enum 객체도 생성하여 사용할 수 있다.

part 'brand.g.dart';

@HiveType(typeId: 2)
enum Brand {
  @HiveField(0)
  hyundai,

  @HiveField(1)
  kia,

  @HiveField(2)
  genesis,
}

Code Generator

Code Generator를 사용해 코드를 자동으로 생성되도록 하면 된다. 사용 방법은 크게 2가지 방법이 있는데 build_runner를 한 번만 실행하는 방법이 있고, 지속적으로 실행하는 방법이 있다. 편한 방법을 사용해 코드를 생성하면 된다.

Generator가 코드를 생성하고 나면 _.g.dart 라는 파일이 추가로 생성된 것을 확인할 수 있다.

case 1 flutter pub run build_runner build
case 2 flutter pub run build_runner watch --delete-conflicting-outputs

객체를 사용해 데이터를 저장해 보도록 하자.

Box box = Hive.box("car_factory");
box.add(Car(
		number: 0,
		brand: CarType.hyundai,
		name: "name",
		colors: ["red"],
		isRoof: false,
	),
);

에러가 발생했다. 생성한 TypeAdapter를 등록하지 않고 사용해서 발생한 문제이다.

HiveError (HiveError: Cannot write, unknown type: Car. Did you forget to register an adapter?)

registerAdapter

TypeAdapter를 사용하기 위해서는 반드시 등록 과정을 거쳐야 한다.

등록 방법은 사용 전 함수를 호출해 주면 된다. 우리는 Car, CarType 객체 2개를 생성 하였기에, 각각 등록해주면 된다.

Hive.registerAdapter(CarAdapter());
Hive.registerAdapter(BrandAdapter());

데이터를 다시 저장해 보자.

  final List<Car> cars = [
    Car(
        number: 0,
        brand: Brand.hyundai,
        name: "Grandeur",
        colors: ["black", "white", "grey"],
        isRoof: true),
    Car(
        number: 0,
        brand: Brand.hyundai,
        name: "Santafe",
        colors: ["black", "white"],
        isRoof: true),
    Car(
        number: 0,
        brand: Brand.kia,
        name: "Ray",
        colors: ["black", "cyan", "red"],
        isRoof: false),
    Car(
        number: 0,
        brand: Brand.genesis,
        name: "GV80",
        colors: ["black", "khaki", "navy"],
        isRoof: true),
  ];

addAll() 기능을 사용해서 한 번에 데이터를 저장해 주도록 하자.

Box box = Hive.box("car_factory");
box.addAll(cars);
print(box.values);

ValueListenableBuilder

마지막으로 valueListenable 타입을 지원해 주고 있어 데이터베이스의 변경을 즉시 알려줄 수 있다.

ValueListenableBuilder<Box>(
	valueListenable: Hive.box("car_factory").listenable(),
	builder: (BuildContext context, Box value, Widget? child) {
      ...
}),

Example

To-Do 리스트를 관리하는 간단한 앱을 Hive 로컬 데이터베이스를 사용해서 만들었다.

Hive DB를 아직 어떻게 사용해야 하는지 이해가 되지 않으신 분들은 해당 코드를 실행시켜 보면, 쉽게 이해할 수 있을 것 같다.

To-Do 앱은 할 일을 생성하고, 수정하고, 삭제할 수 있다.

Git Repository

마무리

NoSQL 기반의 hive 데이터베이스에 대해서 살펴 봤는데, 사용 방법도 간단하고 속도면에서도 긍정적인 부분이 많은 것 같다. 처음엔 쿼리 지원이 되지 않는 부분이 다소 아쉽다고 생각을 했는데, 데이터를 가져와 flutter에서 가공하여 사용 후 다시 필요한 데이터만 저장하면 되서 더 심플한 것 같다.

매우 복잡한 구조의 로컬 데이터베이스로는 좀 더 사용을 해봐야 알겠지만, 현재까지 사용해본 로컬 저장소 중에는 사용할만 한 것 같다.

급하게 사용해보면서 작성하다 보니 빠진 내용이 있을 수도 있어서, 추가로 궁금하신 분은 언제든 댓글 남겨주세요 !