Flutter数据库ORM管理插件elite_orm_editor的使用

elite_orm_editor

elite_orm_editor 是一组专门设计用于与 elite_orm 配合使用的小组件。

开始使用

在您的 Flutter 项目中添加依赖项：

dependencies:
  ...
  elite_orm_editor:

使用示例

导入 elite_orm_editor.dart

import 'package:elite_orm_editor/elite_orm_editor.dart';

创建一个编辑器小部件

您的小部件类需要继承自 EliteORMEditor。

class TeamEdit extends EliteORMEditor {
  final Team? team;
  const TeamEdit({super.key, this.team});

  [@override](/user/override)
  State<TeamEdit> createState() => _TeamEditState();
}

创建编辑器小部件的状态

此类将处理大部分编辑器逻辑。

class _TeamEditState extends EliteORMEditorState<TeamEdit> {
  Team storage = Team();
  final List<ControlGroup> _groups = [];

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化默认控件
    createDefaultControls(storage);

    // 如果有初始数据，则填充控件
    if (widget.team != null) {
      initializeControlValues(widget.team!);
    }
  }

  // 保存团队信息
  void _saveTeam() async {
    try {
      final SaveStatus status = await save(teamBloc, widget.team, storage);
      String message;
      switch (status) {
        case SaveStatus.created:
          message = "Team Saved";
          modified = false;
          break;
        case SaveStatus.updated:
          message = "Team Updated";
          modified = false;
          break;
        case SaveStatus.invalid:
          message = "Invalid Team";
          break;
      }

      // 确保小部件仍然挂载后显示消息
      if (!modified && mounted) {
        Navigator.pop(context);
      }

      if (mounted) {
        ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: Text(message)),
        );
      }
    } catch (err) {
      ErrorDialog.show(context, err.toString());
    }
  }

  [@override](/user/override)
  List<Widget> buildGroups() {
    // 在 initState 中初始化控件组，避免在使用 AppLocalizations 时出现问题
    if (_groups.isEmpty) {
      _groups.add(ControlGroup(title: "Team Name", items: [controls[0]]));
      _groups.add(ControlGroup(title: "Schedule Website", items: [controls[1]]));
      _groups.add(ControlGroup(title: "Teammates", items: [controls[2]]));
    }
    return translateGroups(_groups);
  }

  [@override](/user/override)
  String get title => "Edit Team";
}

完整示例代码

以下是一个完整的示例代码，展示如何使用 elite_orm_editor 创建一个团队编辑页面。

import 'package:flutter/material.dart';
import 'package:elite_orm_editor/elite_orm_editor.dart';

// 定义团队实体
class Team {
  String name;
  String website;
  List<String> teammates;

  Team({
    required this.name,
    required this.website,
    required this.teammates,
  });
}

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: TeamEditPage(),
    );
  }
}

class TeamEditPage extends StatefulWidget {
  [@override](/user/override)
  _TeamEditPageState createState() => _TeamEditPageState();
}

class _TeamEditPageState extends State<TeamEditPage> {
  final Team _team = Team(
    name: "Example Team",
    website: "https://example.com",
    teammates: ["Alice", "Bob"],
  );

  [@override](/user/override)
  Widget build(BuildContext context) {
    return TeamEdit(team: _team);
  }
}