Flutter实体管理插件entity的使用

Flutter实体管理插件Entity的使用

简介

Entity 是一个非常简单的对象关系映射（ORM）工具，适用于关系型数据库、NoSQL数据库和简单的映射。它专为浏览器环境设计，因此不使用反射或注解。这个插件可以帮助你在Flutter应用中轻松管理实体类，并与各种数据源进行交互。

使用场景

• Quire：一个简单、协作式的多层级任务管理工具。
• Keikai：一个处理大数据的高级电子表格工具。
• Ottava：一个无代码的SaaS平台，简化数据管理、图表创建和数据分析。

完整示例Demo

下面是一个完整的示例，展示了如何在Flutter项目中使用 entity 插件来管理实体类并进行基本的CRUD操作。

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 entity 依赖：

dependencies:
  flutter:
    sdk: flutter
  entity: ^0.6.2  # 请根据最新的版本号进行调整

然后运行 flutter pub get 来安装依赖。

2. 创建实体类

假设我们要创建一个简单的 User 实体类，表示用户信息。我们可以使用 entity 插件来定义这个类。

import 'package:entity/entity.dart';

class User extends Entity {
  // 定义用户属性
  String? name;
  int? age;

  // 构造函数
  User({this.name, this.age});

  // 从Map转换为User对象
  [@override](/user/override)
  void fromMap(Map<String, dynamic> map) {
    super.fromMap(map);
    name = map['name'];
    age = map['age'];
  }

  // 将User对象转换为Map
  [@override](/user/override)
  Map<String, dynamic> toMap() {
    final map = super.toMap();
    map['name'] = name;
    map['age'] = age;
    return map;
  }
}

3. 数据库配置

接下来，我们需要配置数据库连接。entity 插件支持多种数据库类型，例如 SQLite、MySQL、PostgreSQL 等。这里我们以 SQLite 为例。

import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart';

class DatabaseHelper {
  static final DatabaseHelper _instance = DatabaseHelper._internal();
  factory DatabaseHelper() => _instance;

  DatabaseHelper._internal();

  late Database _db;

  Future<void> initDatabase() async {
    final databasesPath = await getDatabasesPath();
    final path = join(databasesPath, 'user.db');

    _db = await openDatabase(
      path,
      version: 1,
      onCreate: (db, version) async {
        await db.execute('''
          CREATE TABLE users (
            id INTEGER PRIMARY KEY AUTOINCREMENT,
            name TEXT,
            age INTEGER
          )
        ''');
      },
    );
  }

  Future<Database> get database async {
    if (_db == null) {
      await initDatabase();
    }
    return _db;
  }
}

4. CRUD操作

现在我们可以编写一些方法来执行常见的CRUD操作（创建、读取、更新、删除）。

class UserService {
  final DatabaseHelper _databaseHelper = DatabaseHelper();

  // 插入新用户
  Future<int> insertUser(User user) async {
    final db = await _databaseHelper.database;
    return await db.insert('users', user.toMap());
  }

  // 查询所有用户
  Future<List<User>> getAllUsers() async {
    final db = await _databaseHelper.database;
    final List<Map<String, dynamic>> maps = await db.query('users');
    return List.generate(maps.length, (i) {
      final user = User();
      user.fromMap(maps[i]);
      return user;
    });
  }

  // 更新用户信息
  Future<int> updateUser(User user) async {
    final db = await _databaseHelper.database;
    return await db.update(
      'users',
      user.toMap(),
      where: 'id = ?',
      whereArgs: [user.id],
    );
  }

  // 删除用户
  Future<int> deleteUser(int id) async {
    final db = await _databaseHelper.database;
    return await db.delete(
      'users',
      where: 'id = ?',
      whereArgs: [id],
    );
  }
}

5. 使用示例

最后，我们可以在Flutter应用中使用这些服务来进行用户管理。以下是一个简单的示例，展示了如何插入和查询用户数据。

import 'package:flutter/material.dart';
import 'package:entity/entity.dart';
import 'user_service.dart';  // 假设上面的UserService已经保存在user_service.dart文件中

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Entity Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: UserManagementPage(),
    );
  }
}

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

class _UserManagementPageState extends State<UserManagementPage> {
  final UserService _userService = UserService();
  final TextEditingController _nameController = TextEditingController();
  final TextEditingController _ageController = TextEditingController();
  List<User> _users = [];

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

  void _loadUsers() async {
    final users = await _userService.getAllUsers();
    setState(() {
      _users = users;
    });
  }

  void _addUser() async {
    final name = _nameController.text;
    final age = int.tryParse(_ageController.text);

    if (name.isNotEmpty && age != null) {
      final user = User(name: name, age: age);
      await _userService.insertUser(user);
      _loadUsers();
      _clearFields();
    }
  }

  void _clearFields() {
    _nameController.clear();
    _ageController.clear();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('用户管理'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _nameController,
              decoration: InputDecoration(labelText: '姓名'),
            ),
            TextField(
              controller: _ageController,
              keyboardType: TextInputType.number,
              decoration: InputDecoration(labelText: '年龄'),
            ),
            ElevatedButton(
              onPressed: _addUser,
              child: Text('添加用户'),
            ),
            Expanded(
              child: ListView.builder(
                itemCount: _users.length,
                itemBuilder: (context, index) {
                  final user = _users[index];
                  return ListTile(
                    title: Text(user.name ?? ''),
                    subtitle: Text('年龄: ${user.age}'),
                  );
                },
              ),
            ),
          ],
        ),
      ),
    );
  }
}