json_serializable_ioc_generator 1.0.3 json_serializable_ioc_generator: ^1.0.3 copied to clipboard
json_serializable_ioc_generator simplifies the registration of toJson and fromJson methods for models annotated with @JsonSerializable. This package works in conjunction with json_serializable_ioc to [...]
json_serializable_ioc_generator #
json_serializable_ioc_generator
simplifies the registration of toJson
and fromJson
methods for models annotated with @JsonSerializable
. This package works in conjunction with json_serializable_ioc
to automatically generate the registration method.
Features #
- Automatic Method Registration: Automatically generates code to register factory and converter methods for models.
- Leverages
@JsonSerializable
: Uses thejson_annotation
package for model serialization. - Custom Annotation for Bootstrapping: The
@RegisterJsonSerializable
annotation is applied to the method responsible for app configuration (likemain()
), triggering the generation of the$registerJsonSerializableMethods()
method. - Generated Registration Method: Generates a
$registerJsonSerializableMethods()
function to register serialization methods at runtime.
Installation #
To use json_serializable_ioc_generator
, add the following dependencies to your pubspec.yaml
:
dependencies:
json_annotation: ^4.7.0
json_serializable_ioc: ^1.0.0
dev_dependencies:
build_runner: ^2.1.0
json_serializable_ioc_generator: ^1.0.0
Then run:
flutter pub get
How It Works #
- Model Annotation: Annotate your model classes with
@JsonSerializable
from thejson_annotation
package. This triggers the generation oftoJson
andfromJson
methods. - RegisterJsonSerializable: Use the
@RegisterJsonSerializable
annotation to mark a method responsible for dependency configuration, such as themain
method. This generates the$registerJsonSerializableMethods()
function. - Code Generation: Use the
build_runner
tool to generate the registration method. - Bootstrap Application: Call the generated
$registerJsonSerializableMethods()
method to register the serialization methods in theJsonFactoryIoc
andJsonConverterIoc
containers.
Basic Usage #
1. Annotate Your Model
// user.dart
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
final int id;
final String name;
User({
required this.id,
required this.name,
});
factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}
In this example, the User
model is annotated with @JsonSerializable
from the json_annotation
package. This will generate fromJson
and toJson
methods for this model.
2. Code Generation
Run the following command to trigger code generation:
flutter pub run build_runner build
This will generate the $registerJsonSerializableMethods()
function, which automatically registers the factory and converter methods.
3. Register Serialization Methods
In your main.dart
or another bootstrap method, use the @RegisterJsonSerializable
annotation to mark the method for code generation. After code generation, call the generated $registerJsonSerializableMethods()
function.
// main.dart
import 'dart:convert';
import 'package:json_ioc_example/user.dart';
import 'package:json_ioc_example/main.json_ioc.dart';
import 'package:json_serializable_ioc/json_serializable_ioc.dart';
@RegisterJsonSerializable()
void main(List<String> arguments) {
// Register all annotated models' methods
$registerJsonSerializableMethods();
// Deserialize a User object from JSON
User user = factory<User>({
"id": 55,
"name": "potatoes",
});
// Serialize the User object back to JSON
print(jsonEncode(converter<User>(user))); // Output: {"id":55,"name":"potatoes"}
}
In this example:
- The
@RegisterJsonSerializable
annotation is used on themain()
method, which generates the$registerJsonSerializableMethods()
function. - This function registers the
toJson
andfromJson
methods in theJsonFactoryIoc
andJsonConverterIoc
containers. - You can then use the
factory<T>()
function to dynamically deserialize aUser
instance from JSON and theconverter<T>()
function to serialize it back to JSON.
API Reference #
@RegisterJsonSerializable
This annotation is used to mark a method responsible for dependency configuration, typically the main()
method. It triggers code generation for the $registerJsonSerializableMethods()
function, which registers the toJson
and fromJson
methods of all models annotated with @JsonSerializable
.
Generated Method: $registerJsonSerializableMethods()
This method is generated by the code generator and registers all toJson
and fromJson
methods of models annotated with @JsonSerializable
into the JsonFactoryIoc
and JsonConverterIoc
containers. It must be called at runtime for proper registration.
Example #
// user.dart
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
final int id;
final String name;
User({
required this.id,
required this.name,
});
factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}
// main.dart
import 'dart:convert';
import 'package:json_ioc_example/user.dart';
import 'package:json_ioc_example/main.json_ioc.dart';
import 'package:json_serializable_ioc/json_serializable_ioc.dart';
@RegisterJsonSerializable()
void main(List<String> arguments) {
// Register all annotated models' methods
$registerJsonSerializableMethods();
// Deserialize a User object from JSON
User user = factory<User>({
"id": 55,
"name": "potatoes",
});
// Serialize the User object back to JSON
print(jsonEncode(converter<User>(user))); // Output: {"id":55,"name":"potatoes"}
}
FAQ #
-
Do I have to annotate every model?
Yes, each model must be annotated with@JsonSerializable
to havetoJson
andfromJson
methods generated. -
Where do I use
@RegisterJsonSerializable
?
Use this annotation on a method likemain()
or another initialization method that will trigger the generation of$registerJsonSerializableMethods()
.