Flutter JSON转Dart模型插件json2dart_db的使用

json2dart_db 的数据库支持

• 1.可根据model生成表结构。
• 2.支持表升级。

一.模型以及表的生成

选择一个json模型，将模型复制到生成的插件中。

根据上方图片显示：

• ClassName 只需要下划线的文件名（会自动生成文件跟对应的模型的驼峰式名字）
• 勾选Sqlite Support,然后可以在右方的输入框中输入primaryKey(Ps:primary key如果是json中已有的，只会有PRIMARY KEY 的属性，如果是json数据中没有的，会根据输入的自动增加一个属性到model的模型类中，并带有PRIMARY KEY 跟AUTOINCREMENT)
• json 模型可以选择lib下的任何目录，生成的模型会在选择的文件夹下，dao类的生成只会生成在lib/database的目录下，并在有新表时，自动插入生成语句到代码的方法中

1.下面简单演示一下生成：取一段json，如下

{
  "name": "default",
  "playlist_count": "",
  "create_time": 0,
  "position": 1,
  "playlist_ids": [
    1
  ]
}

2.调用插件,生成的模型和dao类，分别如下

为了支持数据库以及更好的区分bean，会override以下三个方法：

• hashCode 跟 == (equal) 方法
• 自动with基类（BaseDbModel，不使用extends，方便给其它基类继承），实现primaryKeyAndValue

import 'dart:convert';

import 'package:json2dart_safe/json2dart.dart';

class CategoryDaoTest with BaseDbModel {
  String? playlistCount;
  List<int>? playlistIds;
  int? createTime;
  String? name;
  int? position;
  int? categoryId;

  CategoryDaoTest({
    this.playlistCount,
    this.playlistIds,
    this.createTime,
    this.name,
    this.position,
    this.categoryId,
  });

  [@override](/user/override)
  Map<String, dynamic> toJson() =>
      {
        'playlist_count': playlistCount,
        'playlist_ids': playlistIds,
        'create_time': createTime,
        'name': name,
        'position': position,
        'category_id': categoryId,
      };

  CategoryDaoTest.fromJson(Map json) {
    playlistCount = json.asString('playlist_count');
    playlistIds = json.asList<int>('playlist_ids');
    createTime = json.asInt('create_time');
    name = json.asString('name');
    position = json.asInt('position');
    categoryId = json.asInt('category_id');
  }

  static CategoryDaoTest toBean(Map json) => CategoryDaoTest.fromJson(json);

  [@override](/user/override)
  Map<String, dynamic> primaryKeyAndValue() => {"category_id": categoryId};

  [@override](/user/override)
  int get hashCode => categoryId?.hashCode ?? super.hashCode;

  [@override](/user/override)
  bool operator ==(Object other) {
    if (other is CategoryDaoTest && categoryId != null) {
      return other.categoryId == categoryId;
    }
    return super == other;
  }

  [@override](/user/override)
  String toString() => jsonEncode(toJson());
}

生成的dao类如下，目前可支持多表，但需要手动调用执行表生成的语句：

import 'package:json2dart_safe/json2dart.dart';
import 'package:gesound/common/model/category_dao_test.dart';

class CategoryDaoTestDao extends BaseDao<CategoryDaoTest> {
  static const String _tableName = 'category_dao_test';

  CategoryDaoTestDao() : super(_tableName, 'category_id');

  static String tableSql([String? tableName]) =>
      ""
      "CREATE TABLE IF NOT EXISTS `${tableName ?? _tableName}` ("
      "`playlist_count` TEXT,"
      "`playlist_ids` TEXT,"
      "`create_time` INTEGER,"
      "`name` TEXT,"
      "`position` INTEGER,"
      "`category_id` INTEGER PRIMARY KEY AUTOINCREMENT)";

  [@override](/user/override)
  CategoryDaoTest fromJson(Map json) => CategoryDaoTest.fromJson(json);
}