json_model 
Gernerating Dart model class from Json file.
Installing
dev_dependencies:
json_model: #latest version
build_runner: ^1.8.0
json_serializable: ^3.2.5Getting Started
- Create a "jsons" directory in the root of your project;
- Create a Json file under "jsons" dir ;
- Run
flutter packages pub run hf_json_model(in Flutter) orpub run hf_json_model(in Dart VM)
Examples
File: jsons/user.json
{
"name":"wendux",
"father":"$user", //Other class model
"friends":"$[]user", // Array
"keywords":"$[]String", // Array
"age":20
}Run pub run hf_json_model, then you'll see the generated json file under lib/models/ dir:
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
User();
String name;
User father;
List<User> friends;
List<String> keywords;
num age;
factory User.fromJson(Map<String,dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}
@JsonKey
You can also use “@JsonKey” annotation from json_annotation package.
{
"@JsonKey(ignore: true) dynamic":"md",
"@JsonKey(name: '+1') int": "loved",
"name":"wendux",
"age":20
}The generated class is:
import 'package:json_annotation/json_annotation.dart';
part 'user.g.dart';
@JsonSerializable()
class User {
User();
@JsonKey(ignore: true) dynamic md;
@JsonKey(name: '+1') int loved;
String name;
num age;
factory User.fromJson(Map<String,dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}Test:
import 'models/index.dart';
void main() {
var u = User.fromJson({"name": "Jack", "age": 16, "+1": 20});
print(u.loved); // 20
}@Import
{
"@import":"test_dir/profile.dart", //import file for model class
"@JsonKey(ignore: true) Profile":"profile",
"name":"wendux",
"age":20
}The generated class:
import 'package:json_annotation/json_annotation.dart';
import 'test_dir/profile.dart'; // import file
part 'user.g.dart';
@JsonSerializable()
class User {
User();
@JsonKey(ignore: true) Profile profile; //file
String name;
num age;
factory User.fromJson(Map<String,dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}For completed examples see here .
Command arguments
The default json source file directory is project_root/jsons; you can custom the src file directory by src argument, for example:
pub run json_model src=json_files You can also custom the dist directory by dist argument:
pub run json_model src=json_files dist=data # will save in lib/data dirThe
distroot islib
Run by code
If you want to run json_model by code instead command line, you can:
import 'package:hf_json_model/hf_json_model.dart';
void main() {
run(['src=jsons']); //run
}