Flutter模型序列化插件serializable_models的使用

Flutter模型序列化插件serializable_models的使用

特性

• 创建一个基于你模型的可序列化的扩展模型。

可能还会有与之配套的库，例如serializable_models_rest 和 serializable_models_sqlite。

开始使用

在你的pubspec.yaml文件中添加serializable_models包，并将build_runner添加到开发依赖项中。

运行以下命令来生成代码：

flutter pub run build_runner build

使用方法

1. 当需要在生成的代码中使用构造函数时，第一个构造函数会被使用。确保你创建了一个。
2. 类必须是私有的，声明一个部分，抽象并扩展SerializableModelBase。
3. 如果你需要更改字段的序列化方式，你必须直接修改库。这在未来可能会改变。

以下是最简单的示例。要查看更多，可以查看example/lib/models目录下的文件，展示了一些不带生成代码的模型，以及所有生成时的选项。

示例代码

import 'package:serializable_models/annotations.dart';
import 'package:serializable_models/model_base.dart';

part 'item.o.dart';

@SerializableModel()
abstract class _Item extends SerializableModelBase {
  @Pk()
  int id;
  String name;

  _Item({
    required this.id,
    required this.name,
  });
}

运行构建后，会生成以下内容： lib/models/item.o.dart

// Source library: package:example/models/item.dart

part of 'item.dart';

class Item extends _Item {
  [@override](/user/override)
  get pk => id;

  Item({
    required int id,
    required String name,
  }) : super(
    id: id,
    name: name,
  );

  factory Item.fromSerializable(Map<String, dynamic> from) {
    var instance = Item(
      id: from["id"],
      name: from["name"],
    );

    return instance;
  }

  [@override](/user/override)
  Item clone() {
    return Item(
      id: id,
      name: name,
    );
  }

  [@override](/user/override)
  void loadSerializable(Map<String, dynamic> from) {
    id = from["id"];
    name = from["name"];
  }

  [@override](/user/override)
  Map<String, dynamic> toSerializable() {
    return {
      "id": id,
      "name": name,
    };
  }
}

完整示例

import 'package:flutter/material.dart';
import 'package:your_package_name/models/item.dart'; // 假设你的模型类位于此路径下

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  Item item = Item(id: 1, name: "Test Item");

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            Text(
              'Item ID: ${item.id}',
              style: Theme.of(context).textTheme.headline4,
            ),
            Text(
              'Item Name: ${item.name}',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}