Implement Get storage in Flutter

Nausheen Siddiqui

20 December 2023

Get Storage in Flutter is a very fast, extra lightweight & synchronous key-value pair package that will help you to store app data in memory. It is written entirely in Dart and easily integrates with the Get framework of Flutter. Generally, in Flutter, we use Shared preference to store app data. It is an alternative to app-shared preference.

For more, please check out our Flutter app development page.

Feature of Get storage:

GetStorage is not fast, it is absurdly fast for being memory-based.

All of its operations are instantaneous.

A backup of each operation is placed in a Container on the disk. Each container has its file.

We have multiple benefits of using Get Storage in Flutter. Now, let’s check how can we implement Get Storage in Flutter.

Step 1: Create a flutter project.

Step 2: Add dependency in your pubspec file.

Step 3: Initialize Get Storage.

To initialize get storage, we need to call GetStorage().init in the main function.

void main() async{
  await GetStorage.init();
  runApp(const MyApp());
}

void main() async{

await GetStorage.init();

runApp(const MyApp());

}

Step 4: How to use the Get storage package.

Create an Instance of the Storage object.

 final box = GetStorage();

1	final box = GetStorage();

Read and write data using Get storage.

//write data
box.write('finalCount', _counter);

// read data
box.read('finalCount')

//write data

box.write('finalCount', _counter);

// read data

box.read('finalCount')

We write data in key-pair value using the write function and we read data using the read function with the help of key.

Get storage has multiple functions for multiple uses. Let’s check other functions.

Remove the data from get_storage object.

box.remove('finalCount')

1	box.remove('finalCount')

Listen to changes.

box.listen(() => print('box changed'));

1	box.listen(() => print('box changed'));

Stop listening to changes.

box.removeListen(listen);

1	box.removeListen(listen);

Erase your container

box.erase();

1	box.erase();

Get Storage Example:

import 'package:flutter/material.dart';
import 'package:get_storage/get_storage.dart';

void main() async{
  await GetStorage.init();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  final box = GetStorage();

  void _incrementCounter() {
    setState(() {
      _counter++;
      box.write('finalCount', _counter);
    });
  }

  @override
  Widget build(BuildContext context) {
    box.writeIfNull('finalCount', 0);
    return Scaffold(
      appBar: AppBar(
        title: const Text("Get storage demo"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '${box.read('finalCount')}',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}

import 'package:flutter/material.dart';

import 'package:get_storage/get_storage.dart';

void main() async{

await GetStorage.init();

runApp(const MyApp());

}

class MyApp extends StatelessWidget {

const MyApp({Key? key}) : super(key: key);

@override

Widget build(BuildContext context) {

return MaterialApp(

title: 'Flutter Demo',

theme: ThemeData(

primarySwatch: Colors.blue,

home: const MyHomePage(),

);

}

class MyHomePage extends StatefulWidget {

const MyHomePage({Key? key}) : super(key: key);

@override

State<MyHomePage> createState() => _MyHomePageState();

}

class _MyHomePageState extends State<MyHomePage> {

int _counter = 0;

final box = GetStorage();

void _incrementCounter() {

setState(() {

_counter++;

box.write('finalCount', _counter);

});

}

@override

Widget build(BuildContext context) {

box.writeIfNull('finalCount', 0);

return Scaffold(

appBar: AppBar(

title: const Text("Get storage demo"),

body: Center(

child: Column(

mainAxisAlignment: MainAxisAlignment.center,

children: <Widget>[

const Text(

'You have pushed the button this many times:',

Text(

'${box.read('finalCount')}',

style: Theme.of(context).textTheme.headline4,

floatingActionButton: FloatingActionButton(

onPressed: _incrementCounter,

tooltip: 'Increment',

child: const Icon(Icons.add),

), // This trailing comma makes auto-formatting nicer for build methods.

);

}

Output:

Thanks for reading this article.

If I got something wrong, let me know in the comments. I would love to improve.

For more interesting blogs check out here – https://mobikul.com/blog/

Reference link: https://pub.dev/packages/get_storage