Flutter对象关系映射插件orm的使用

Prisma Client Dart

Prisma Client Dart 是一个自动生成类型安全的ORM（对象关系映射）。它使用Prisma Engine作为数据访问层，并尽可能与Prisma Client JS/TS API保持一致。

👉 了解如何在您的项目中使用Prisma ORM for Dart。

示例代码

import 'package:orm/orm.dart';

final client = PrismaClient();

main() async {
  final users = await client.user.findMany();
  print(users);
}

安装

这将添加如下内容到你的pubspec.yaml文件（并隐式运行dart pub get）：

dependencies:
  orm: latest

或者你可以运行以下命令：

dart pub add orm

文档

你可以在网站上找到Prisma Client Dart的文档。

文档分为以下几个部分：

• 开始使用
  • 设置和配置
  • Prisma Schema
• 查询
  • CRUD
  • 选择字段
  • 关系查询
  • 过滤和排序
  • 分页
  • 聚合、分组和汇总
  • 事务
  • 原始数据库访问

你可以通过向main分支的docs文件夹发送pull请求来改进文档。

示例

你还可以在main分支的example文件夹中找到示例。

Query Engine 支持矩阵

贡献

我们欢迎贡献！请阅读我们的贡献指南，以了解我们的开发过程、如何提出bug修复和改进建议，以及如何构建和测试你对Prisma的更改。

感谢所有已经为Prisma Dart做出贡献的人！

行为准则

本项目已采用贡献者契约行为准则。更多信息请参阅行为准则FAQ，或联系hello@odroe.com以获取更多问题或评论。

完整示例Demo

下面是一个完整的示例demo，展示了如何在Flutter项目中使用Prisma Client Dart进行基本的CRUD操作。

1. 创建一个新的Flutter项目

flutter create prisma_example
cd prisma_example

2. 添加依赖

在pubspec.yaml中添加Prisma Client Dart依赖：

dependencies:
  flutter:
    sdk: flutter
  orm: latest

然后运行dart pub get以安装依赖。

3. 配置Prisma Schema

创建一个名为schema.prisma的文件，并添加以下内容：

generator client {
  provider = "prisma-client-dart"
}

datasource db {
  provider = "sqlite"
  url      = "file:./dev.db"
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

4. 生成Prisma Client

运行以下命令以生成Prisma Client：

npx prisma generate

5. 编写Flutter代码

在lib/main.dart中编写以下代码：

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

void main() async {
  final client = PrismaClient();
  runApp(MyApp(client));
}

class MyApp extends StatelessWidget {
  final PrismaClient client;

  MyApp(this.client);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Prisma Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(client),
    );
  }
}

class MyHomePage extends StatefulWidget {
  final PrismaClient client;

  MyHomePage(this.client);

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  List<User> users = [];

  @override
  void initState() {
    super.initState();
    _fetchUsers();
  }

  Future<void> _fetchUsers() async {
    final fetchedUsers = await widget.client.user.findMany();
    setState(() {
      users = fetchedUsers;
    });
  }

  Future<void> _addUser(String email, String name) async {
    await widget.client.user.create(
      data: UserCreateInput(email: email, name: name),
    );
    _fetchUsers();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Prisma Example'),
      ),
      body: ListView.builder(
        itemCount: users.length,
        itemBuilder: (context, index) {
          final user = users[index];
          return ListTile(
            title: Text(user.name ?? 'No Name'),
            subtitle: Text(user.email),
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          showDialog(
            context: context,
            builder: (context) => AlertDialog(
              title: Text('Add User'),
              content: Column(
                mainAxisSize: MainAxisSize.min,
                children: [
                  TextField(
                    decoration: InputDecoration(labelText: 'Email'),
                    onChanged: (value) => email = value,
                  ),
                  TextField(
                    decoration: InputDecoration(labelText: 'Name'),
                    onChanged: (value) => name = value,
                  ),
                ],
              ),
              actions: [
                TextButton(
                  child: Text('Cancel'),
                  onPressed: () => Navigator.pop(context),
                ),
                TextButton(
                  child: Text('Add'),
                  onPressed: () {
                    _addUser(email, name);
                    Navigator.pop(context);
                  },
                ),
              ],
            ),
          );
        },
        child: Icon(Icons.add),
      ),
    );
  }
}

6. 运行应用程序

确保你已经安装了SQLite，并且数据库文件路径正确。然后运行以下命令启动应用程序：

flutter run

现在你应该可以看到一个简单的用户管理界面，可以添加和查看用户。

希望这个示例能帮助你更好地理解和使用Prisma Client Dart。如果你有任何问题或需要进一步的帮助，请随时参考官方文档或加入社区讨论。