Flutter模型生成插件binta_model_generator的使用

Flutter模型生成插件binta_model_generator的使用

简介

Easy Generate Model Class

概述

binta_model_generator 是一个用于在Dart语言中生成响应模型的库。

开发人员可以通过配置后运行任何需要的功能来轻松生成模型。

只需先配置，然后运行任何你想要的操作。

使用方法

首先，我们需要将 <code>binta_model_generator</code> 添加到 pubspec.yaml 文件的依赖项中：

dependencies:
  binta_model_generator: ^0.1.1

接下来，我们需要创建一个新的 Dart 文件，并使用以下代码（如果你使用的是 Dio 或其他 HTTP 包）：

import 'package:binta_model_generator/binta_model_generator.dart';
import 'package:dio/dio.dart';

main() async {
  final response = await hitService();
  BintaModelGenerator.generateResponseModel(
    parentModelName: "YourParentClassNameOfModel",
    yourJson: response,
    outputFile: "example/",
  );
}

Future<dynamic> hitService() async {
  final Dio dio = Dio();
  try {
    final response = await dio.get("https://your_services.example/example");
    return response;
  } on DioException catch (e) {
    throw Exception(
      e.error,
    );
  }
}

我们有一个示例 JSON 响应 API：

{
  "status": 200,
  "data": {
    "person": [
      {
        "name": "binta",
        "age": 22
      },
      {
        "name": "reza",
        "age": 24
      }
    ],
    "info": {
      "code": "EXAMPLE_CODE_001",
      "message": "success to show data person"
    }
  }
}

不要忘记运行你的 Dart 文件：

dart run your_dart_file.dart

最后，我们会看到在输出文件夹中生成了新的文件：

📦example/
┣ 📜data_model.dart
┣ 📜info_model.dart
┣ 📜person_model.dart
┗ 📜person_model_model.dart

生成的文件内容如下：

// 在 example/person_model_model.dart 中
import 'package:equatable/equatable.dart';
import 'data_model.dart';

class PersonModelModel extends Equatable {
  final int? status;
  final DataModel? data;

  const PersonModelModel({
    this.status,
    this.data,
  });

  factory PersonModelModel.fromJson(Map<String, dynamic> json) => 
      PersonModelModel(
        status : json['status'],
        data: json['data'] != null ? DataModel.fromJson(json['data']) : null,
      );

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> json = {};
    json['status'] = status;
    if(json['data'] != null) {
      json['data'] = data!.toJson();
    }
    return json;
  }

  [@override](/user/override)
  List<Object?> get props =>[
    status,
    data,
  ];
}

// 在 example/person_model.dart 中
class PersonModel extends Equatable {
  final String? name;
  final int? age;

  const PersonModel({
    this.name,
    this.age,
  });

  factory PersonModel.fromJson(Map<String, dynamic> json) => 
      PersonModel(
        name : json['name'],
        age : json['age'],
      );

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> json = {};
    json['name'] = name;
    json['age'] = age;
    return json;
  }

  [@override](/user/override)
  List<Object?> get props =>[
    name,
    age,
  ];
}

// 在 example/data_model.dart 中
import 'package:equatable/equatable.dart';
import 'info_model.dart';
import 'person_model.dart';

class DataModel extends Equatable {
  final List<PersonModel>? person;
  final InfoModel? info;

  const DataModel({
    this.person,
    this.info,
  });

  factory DataModel.fromJson(Map<String, dynamic> json) => 
      DataModel(
        person: json['person'] != null ? List<PersonModel>.from(json['person']?.map((x) => PersonModel.fromJson(x)),) : [],
        info: json['info'] != null ? InfoModel.fromJson(json['info']) : null,
      );

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> json = {};
    if (person != null) {
      json['person'] = person!.map((v) => v.toJson()).toList();
    }
    if(json['info'] != null) {
      json['info'] = info!.toJson();
    }
    return json;
  }

  [@override](/user/override)
  List<Object?> get props =>[
    person,
    info,
  ];
}

// 在 example/info_model.dart 中
import 'package:equatable/equatable.dart';

class InfoModel extends Equatable {
  final String? code;
  final String? message;

  const InfoModel({
    this.code,
    this.message,
  });

  factory InfoModel.fromJson(Map<String, dynamic> json) => InfoModel(
    code: json['code'],
    message: json['message'],
  );

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> json = {};
    json['code'] = code;
    json['message'] = message;
    return json;
  }

  [@override](/user/override)
  List<Object?> get props => [
    code,
    message,
  ];
}