Flutter Local Storage Clean Architecture

In this project we will use trending local storage packages we will determine how long it takes each option below to perform the operations, so we can have a clear understanding of which is the best choice for us. The project is implementing a clean architecture & bloc for state management so that it’s easy to understand and easy to change as the project grows in the future and implement new technologies or packages.

• hive
• sembast
• sqflite
• shared_preferences
• isar

Table of Contents

• Setup
• Modules
• Implementation
  • Hive
  • Sembast

Setup

• State Management: bloc
• Navigation: go_router
• Service Locator: get_it
• Data Classes: freezed
• Packages
  • dartz
  • logger

Modules

Modules	Progress
Data	✅
Domain	✅
Presentation	✅

Implementation

Hive

is a lightweight and blazing fast key-value database written in pure Dart. Hive having the idea of boxes (which store data).

Hive stores its data in boxes containing key-value sets Hive.box You can call

Hive.openBox(‘name’) 

regardless of whether you as of now have the box opened elsewhere.

Let’s implement the model class

import 'package:hive/hive.dart';
part 'tasks.g.dart';

@HiveType(typeId: 0)
class Tasks{
  @HiveField(0)
  final String name;
  @HiveField(1)
  final String content;
  @HiveField(2)
  final bool isDone;

   Tasks({
    required this.name,
    required this.content,
    required this.isDone
  });
}

Then run a code generator by typing the following command in the terminal which will automatically generate database and Adapters for us.

$ flutter packages pub run build_runner build

Note: Dart File name is tasks.dart so i will add part tasks.g.dart. g stands for generated. Thus new generated file would be tasks.g.dart

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'tasks.dart';

// **************************************************************************
// TypeAdapterGenerator
// **************************************************************************

class TasksAdapter extends TypeAdapter<Tasks> {
  @override
  final int typeId = 0;

  @override
  Tasks read(BinaryReader reader) {
    final numOfFields = reader.readByte();
    final fields = <int, dynamic>{
      for (int i = 0; i < numOfFields; i++) reader.readByte(): reader.read(),
    };
    return Tasks(
      name: fields[0] as String,
      content: fields[1] as String,
      isDone: fields[2] as bool,
    );
  }

  @override
  void write(BinaryWriter writer, Tasks obj) {
    writer
      ..writeByte(3)
      ..writeByte(0)
      ..write(obj.name)
      ..writeByte(1)
      ..write(obj.content)
      ..writeByte(2)
      ..write(obj.isDone);
  }

  @override
  int get hashCode => typeId.hashCode;

  @override
  bool operator ==(Object other) =>
      identical(this, other) ||
      other is TasksAdapter &&
          runtimeType == other.runtimeType &&
          typeId == other.typeId;
}

Sembast

is database stands for Simple Embedded Application Store database NoSQL persistent store database solution for single process io applications.

final _kDbFileName = 'sembast_tasks.db';
final _kTasksStore = 'tasks_store';

late Database _database;

StoreRef<int, Map<String, dynamic>> _tasksStore;

appDocumentDir = await getApplicationDocumentsDirectory();

dbPath = join(appDocumentDir.path, _kDbFileName);

_database = await databaseFactoryIo.openDatabase(dbPath);

_tasksStore = intMapStoreFactory.store(_kTasksStore);