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

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

json2dart_dbffi 的数据库支持

json2dart_dbffi 是一个用于生成 Dart 模型类的插件，同时支持 SQLite 数据库的表结构生成和升级。以下是其主要特点：

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

一. 模型以及表的生成

在使用 json2dart_dbffi 插件时，首先需要选择一个 JSON 模型，并将其复制到插件中。

根据上方图片显示：

• ClassName：只需填写下划线形式的文件名（插件会自动生成与模型名称对应的驼峰式类名）。
• 勾选 Sqlite Support：可以在右侧输入框中定义主键（primaryKey）。如果主键在 JSON 中已存在，则仅添加 PRIMARY KEY 属性；如果不存在，则会自动新增一个带 PRIMARY KEY 和 AUTOINCREMENT 的属性。
• JSON 模型可以选择任意目录，生成的模型会保存在指定的文件夹中，而 DAO 类会生成在 lib/database 目录下，并且在新增表时会自动插入生成的 SQL 语句到相应方法中。

1. JSON 示例

下面是一个简单的 JSON 示例：

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

2. 调用插件生成模型和 DAO 类

调用插件后，生成的模型类和 DAO 类如下所示。

生成的模型类

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);
}