https://github.com/bartektartanus/pref_dessert
Package that allows you persist objects as shared preferences easily.
https://github.com/bartektartanus/pref_dessert
dart flutter persisting-objects sharedpreferences
Last synced: 8 months ago
JSON representation
Package that allows you persist objects as shared preferences easily.
- Host: GitHub
- URL: https://github.com/bartektartanus/pref_dessert
- Owner: bartektartanus
- License: bsd-3-clause
- Created: 2018-06-23T13:19:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-18T09:04:34.000Z (almost 4 years ago)
- Last Synced: 2025-04-07T12:48:32.685Z (9 months ago)
- Topics: dart, flutter, persisting-objects, sharedpreferences
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/pref_dessert
- Size: 65.4 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pref_dessert
[](https://pub.dartlang.org/packages/pref_dessert) [](https://travis-ci.org/bartektartanus/pref_dessert) [](https://codecov.io/gh/bartektartanus/pref_dessert)
Package that allows you persist objects as shared preferences easily. Package name comes from: Shared PREFerences DESerializer/SERializer of T (generic) class.
## Getting Started
To use this package you just need to extend `DesSer` class, replace generic T class with the one you want to save in shared preferences. This class requires you to implement two methods to serialize and deserialize objects. In future releases I'm planning to use JSON serializer so it will be much simpler to use. Then pass this class to `PreferenceRepository` or `FuturePreferencesRepository` and you're good to go!
## Example
`Person` class that you want to serialize:
```dart
class Person {
String name;
int age;
Person(this.name, this.age);
}
```
`PersonDesSer` which extends `DesSer` and implements two methods which serialize this objects using CSV format:
```dart
class PersonDesSer extends DesSer{
@override
Person deserialize(String s) {
var split = s.split(",");
return new Person(split[0], int.parse(split[1]));
}
@override
String serialize(Person t) {
return "${t.name},${t.age}";
}
}
```
You can also do this using JSON with `convert` package:
```dart
import 'dart:convert';
class JsonPersonDesSer extends DesSer{
@override
Person deserialize(String s) {
var map = json.decode(s);
return new Person(map['name'] as String, map['age'] as int);
}
@override
String serialize(Person t) {
var map = {"name":t.name, "age":t.age};
return json.encode(map);
}
}
```
Then create an instance of either class and pass it to the `FuturePreferencesRepository`:
```dart
var repo = new FuturePreferencesRepository(new PersonDesSer());
repo.save(new Person("FooBar", 42));
var list = repo.findAll();
```
### Using `json_serializable` package to generate DesSer
Step 1: import library [json_serializable.](https://pub.dev/packages/json_serializable) in _pubspec.yaml_
```yaml
dependencies:
flutter:
sdk: flutter
pref_dessert: ^0.4.0+1
json_serializable: ^3.2.2
json_annotation: ^3.0.0
dev_dependencies:
flutter_test:
sdk: flutter
build_runner: ^1.0.0
```
Step 2: Create your class with annotation `@JsonSerializable`
```dart
import 'package:pref_dessert/pref_dessert.dart';
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
String uid = "";
String photoUrl = "";
String displayName = "";
String email = "";
User({this.uid, this.photoUrl, this.displayName, this.email});
}
class UserDesSer extends JsonDesSer {
@override
String get key => "PREF_USER";
@override
User fromMap(Map map) => _$UserFromJson(map);
@override
Map toMap(User user) => _$UserToJson(user);
}
```
Step 3: Run command : `flutter pub run build_runner build`