Flutter JSON5数据模型解析插件json5_model的使用

Flutter JSON5数据模型解析插件json5_model的使用

json5_model 是一个用于将JSON文件转换为Dart模型类的工具，支持解析嵌套的JSON和JSON5文件。它简化了从JSON生成Dart模型类的过程，并且可以轻松集成到Flutter项目的构建流程中。

安装

在 pubspec.yaml 文件中添加以下依赖：

dev_dependencies:
  json_serializable: ^6.7.1
  json5_model: ^2.0.3

使用步骤

1. 创建JSON目录：在项目根目录下创建一个名为 jsons 的目录。

   mkdir jsons
   

2. 添加JSON文件：将需要解析的JSON文件放入 jsons 目录中。例如，创建一个 response.json 文件，内容如下：

   {
     "id": 1296269,
     "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
     "owner": {
       "login": "octocat"
     },
     "private": false,
     "topics": [
       "octocat",
       "atom",
       "electron",
       "api"
     ],
     "permissions": {
       "admin": false,
       "push": false,
       "pull": true
     },
     "security_and_analysis": {
       "advanced_security": {
         "status": "enabled"
       },
       "secret_scanning": {
         "status": "enabled"
       },
       "secret_scanning_push_protection": {
         "status": "disabled"
       }
     }
   }
   

3. 生成Dart模型类：在终端中运行以下命令来生成Dart模型类。生成的文件将默认保存在 lib/models 目录下。

   flutter packages pub run json5_model
   

   如果你想自定义输入和输出目录，可以使用 --src 和 --dist 参数。例如：

   flutter pub run json5_model --src=lib/data/json --dist=lib/data/model
   

示例代码

假设我们有一个 response.json 文件，内容如上所示。运行 flutter packages pub run json5_model 后，json5_model 会自动生成相应的Dart模型类。生成的代码如下：

import 'package:json_annotation/json_annotation.dart';

part 'github.g.dart';

@JsonSerializable(explicitToJson: true)
class Github {
  Github({
    required this.id,
    required this.nodeId,
    required this.owner,
    required this.private,
    required this.topics,
    required this.permissions,
    required this.securityAndAnalysis,
  });

  @JsonKey(name: "id", defaultValue: 0)
  int id;

  @JsonKey(name: "node_id", defaultValue: "")
  String nodeId;

  @JsonKey(name: "owner")
  Owner owner;

  @JsonKey(name: "private", defaultValue: false)
  bool private;

  @JsonKey(name: "topics", defaultValue: [])
  List<String> topics;

  @JsonKey(name: "permissions")
  Permissions permissions;

  @JsonKey(name: "security_and_analysis")
  SecurityAndAnalysis securityAndAnalysis;

  factory Github.fromJson(Map<String, dynamic> json) => _$GithubFromJson(json);

  Map<String, dynamic> toJson() => _$GithubToJson(this);
}

@JsonSerializable(explicitToJson: true)
class Owner {
  Owner({required this.login});

  @JsonKey(name: "login", defaultValue: "")
  String login;

  factory Owner.fromJson(Map<String, dynamic> json) => _$OwnerFromJson(json);

  Map<String, dynamic> toJson() => _$OwnerToJson(this);
}

@JsonSerializable(explicitToJson: true)
class Permissions {
  Permissions({
    required this.admin,
    required this.push,
    required this.pull,
  });

  @JsonKey(name: "admin", defaultValue: false)
  bool admin;

  @JsonKey(name: "push", defaultValue: false)
  bool push;

  @JsonKey(name: "pull", defaultValue: false)
  bool pull;

  factory Permissions.fromJson(Map<String, dynamic> json) => _$PermissionsFromJson(json);

  Map<String, dynamic> toJson() => _$PermissionsToJson(this);
}

@JsonSerializable(explicitToJson: true)
class AdvancedSecurity {
  AdvancedSecurity({required this.status});

  @JsonKey(name: "status", defaultValue: "")
  String status;

  factory AdvancedSecurity.fromJson(Map<String, dynamic> json) => _$AdvancedSecurityFromJson(json);

  Map<String, dynamic> toJson() => _$AdvancedSecurityToJson(this);
}

@JsonSerializable(explicitToJson: true)
class SecretScanning {
  SecretScanning({required this.status});

  @JsonKey(name: "status", defaultValue: "")
  String status;

  factory SecretScanning.fromJson(Map<String, dynamic> json) => _$SecretScanningFromJson(json);

  Map<String, dynamic> toJson() => _$SecretScanningToJson(this);
}

@JsonSerializable(explicitToJson: true)
class SecretScanningPushProtection {
  SecretScanningPushProtection({required this.status});

  @JsonKey(name: "status", defaultValue: "")
  String status;

  factory SecretScanningPushProtection.fromJson(Map<String, dynamic> json) => _$SecretScanningPushProtectionFromJson(json);

  Map<String, dynamic> toJson() => _$SecretScanningPushProtectionToJson(this);
}

@JsonSerializable(explicitToJson: true)
class SecurityAndAnalysis {
  SecurityAndAnalysis({
    required this.advancedSecurity,
    required this.secretScanning,
    required this.secretScanningPushProtection,
  });

  @JsonKey(name: "advanced_security")
  AdvancedSecurity advancedSecurity;

  @JsonKey(name: "secret_scanning")
  SecretScanning secretScanning;

  @JsonKey(name: "secret_scanning_push_protection")
  SecretScanningPushProtection secretScanningPushProtection;

  factory SecurityAndAnalysis.fromJson(Map<String, dynamic> json) => _$SecurityAndAnalysisFromJson(json);

  Map<String, dynamic> toJson() => _$SecurityAndAnalysisToJson(this);
}

避免覆盖

版本大于2.0.0的 json5_model 在成功转换后会自动将JSON文件重命名为以 _ 开头的文件名（例如 response.json 会被重命名为 _response.json），以便在重新执行自动生成功能时跳过这些文件。如果你不希望自动重命名，可以在命令中添加 --once=false 参数。

flutter pub run json5_model --once=false

全局命令参数

• 源JSON文件目录：默认是项目根目录下的 jsons 文件夹。你可以通过 --src 参数自定义源文件夹路径。例如：

  flutter pub run json5_model --src=lib/data/json
  

• 输出目录：默认是 lib/models 文件夹。你可以通过 --dist 参数自定义输出路径。例如：

  flutter pub run json5_model --src=lib/data/json --dist=lib/data/model
  

代码调用

如果你正在开发一个工具并希望在代码中使用 json5_model，可以通过代码调用 run 方法来生成模型类：

import 'package:json5_model/json5_model.dart';

void main() {
  run(['src=jsons']);  // 调用 json5_model 的 run 方法
}

运行示例

1. 进入 example 目录：

   cd example
   

2. 运行 json5_model：

   flutter packages pub run json5_model
   

3. 自定义输入和输出目录：

   flutter pub run json5_model --src=jsons --dist=lib/test/json