get_rx_persist 0.1.0

Get Rx Lite-weight Persist

get_rx_persist

A flutter project makes your Rx value auto restore and persist.

Features

• ✅ Easy to use
• ✅ Using in multiple real world projects
• ✅ Support all platform
• ✅ Support various and customized storage

Supported Types

int, num, double, String, bool, Null, Object, List, Set, Map

Maintenance

This project is maintaining.

Install

flutter pub add get_rx_persist

Usage

Setup

import 'package:get_rx_persist/get_rx_persist.dart';

void main() async {
  await GetRxPersist.init(); // one step: call and await fully restore
  runApp(const App());
}

Rx Primitive Value

class Profile {
  final name = 'Hello World'.obs.persist('profile.name');
  final age = 20.obs.persist('profile.age');
  final height = 70.1.obs.persist('profile.height');
  final male = true.obs.persist('profile.male');
}

Object Value

There are two ways to persist object value.

Method 1: Serializable Object

class Profile {
  String? name;

  Profile({this.name});

  Profile.fromJson(Map<String, dynamic> json) {
    name = json['name'];
  }

  // REQUIRED: this is automatically used by [get_rx_persist]
  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = new Map<String, dynamic>();
    data['name'] = this.name;
    return data;
  }
}

class User {
  final profile = Profile().obs.persist(
  	'user.profile',
    serializer: null, // you don't need it when you provided [.toJson()] method on Profile.
    deserializer: Profile.fromJson, // you NEED provide deserializer when you persist a object value.
  );
}

Method 2: Serializer and Deserializer

class Profile {
  String? name;
  Profile({this.name});
}

class user {
  final profile = Profile().obs.persist(
  	'user.profile',
    serializer: (obj) => {'name': obj.name}, // REQUIRED
    deserializer: (jsonMap) => Profile({name: jsonMap['name']}), // REQUIRED
  );
}

List & Set & Map

Nested Rx Value

Modify your deserializer

class Profile {
  Rx<String?> name;

  Profile({this.name});

  Profile.fromJson(Map<String, dynamic> json) {
    name = (json['name'] as String?).obs; // LOOK AT HERE!!!!!!!!!!!!!!
  }

  // REQUIRED: this is automatically used by [get_rx_persist]
  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = new Map<String, dynamic>();
    data['name'] = this.name;
    return data;
  }
}

Storage

Provided Storage

• DefaultStorageProvider/GetStorageProvider: use GetStorage as storage
• MemoryStorageProvider: use memory as storage
• MockStorageProvider: used for test, provide some test helper methods, check source code for more info

Customize Storage

Create a customized class that extends StorageProvider

import 'package:get_rx_persist/src/storage_provider.dart';

// your customized storage provider
class CustomizedStorageProvider extends StorageProvider {
	// implements all abstract methods here
}