Flutter数据操作插件airtable_crud的使用

Airtable CRUD Flutter Plugin

Airtable CRUD Flutter Plugin 是一个强大的解决方案，用于将 Airtable 的 API 与您的 Flutter 应用程序集成。它使开发人员能够无缝地执行基本的 CRUD 操作和过滤记录。

Features

• Fetch Records: 从指定表中检索所有记录。
• Fetch Records with Filter: 使用 Airtable 的 filterByFormula 根据条件检索特定记录。
• Create Records: 轻松添加新记录到您的 Airtable 表。
• Bulk Create Records: 批量创建多个记录，提高效率。
• Update Records: 修改现有记录。
• Delete Records: 从您的 Airtable 表中删除记录。
• Pagination Support: 使用分页选项检索记录。
• View Selection: 在检索记录时选择视图，默认设置为 Grid View。

Getting Started

Installation

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  airtable_crud: ^1.0.0  # Replace with the latest version from pub.dev

然后运行 flutter pub get 来安装该包。

Usage

1. Import the plugin:

   import 'package:airtable_plugin/airtable_crud.dart';
   

2. Initialize the Airtable CRUD:

   final airtableCrud = AirtableCrud('YOUR_AIRTABLE_API_KEY', 'YOUR_BASE_ID');
   

3. Fetch Records:

   // Fetch all records with optional pagination and view selection
   final records = await airtableCrud.fetchRecords('your_table_name', view: 'your_view_name');
   

   Example:

   final records = await airtableCrud.fetchRecords('Contacts', view: 'All Contacts');
   

4. Fetch Records with Filter:

   final filteredRecords = await airtableCrud.fetchRecordsWithFilter(
     'your_table_name',
     "AND({lastname} = 'Smith', {status} = 'Active')",
     view: 'Active Contacts',
   );
   

   Example:

   final filteredRecords = await airtableCrud.fetchRecordsWithFilter(
     'Contacts',
     "AND({lastname} = 'Smith', {status} = 'Active')",
     view: 'Active Contacts',
   );
   

5. Create a Record:

   final newRecord = {
     'firstname': 'Jane',
     'lastname': 'Doe',
     'email': 'jane.doe@example.com',
   };
   final createdRecord = await airtableCrud.createRecord('Contacts', newRecord);
   

6. Bulk Create Records:

   final dataList = [
     {
       'firstname': 'Charlie',
       'lastname': 'Brown',
       'email': 'charlie.brown@example.com',
     },
     {
       'firstname': 'Diana',
       'lastname': 'Prince',
       'email': 'diana.prince@example.com',
     },
   ];
   final createdRecords = await airtableCrud.createBulkRecords('Contacts', dataList);
   

7. Update a Record:

   recordToUpdate.fields['email'] = 'new.email@example.com';
   await airtableCrud.updateRecord('Contacts', recordToUpdate);
   

8. Delete a Record:

   await airtableCrud.deleteRecord('Contacts', 'rec1234567890ABC');
   

Error Handling

try {
  final records = await airtableCrud.fetchRecords('your_table_name');
} on AirtableException catch (e) {
  print('Error: ${e.message}');
  print('Details: ${e.details}');
}

Query Builder

使用 AirtableQueryBuilder 动态构建复杂的查询公式：

final queryBuilder = AirtableQueryBuilder()
    .where({'Status': 'Pending'})
    .and({'Priority': 'High'})
    .or({'Assignee': 'John Doe'})
    .and({'Category': 'Development'})
    .or({'DueDate': '2024-01-01'});

final records = await airtableCrud.fetchRecordsWithQueryBuilder(
  'Tasks',
  queryBuilder,
  view: 'Grid view',
);

示例代码

下面是一个完整的示例应用，展示了如何使用 airtable_crud 插件进行数据操作：

import 'package:flutter/material.dart';
import 'package:airtable_crud/airtable_crud.dart';
import 'package:airtable_crud/models/airtable_record.dart';

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

class AirtableExampleApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Airtable CRUD Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: AirtableHomePage(),
    );
  }
}

class AirtableHomePage extends StatefulWidget {
  @override
  _AirtableHomePageState createState() => _AirtableHomePageState();
}

class _AirtableHomePageState extends State<AirtableHomePage> {
  final String apiKey = 'YOUR_AIRTABLE_API_KEY'; 
  final String baseId = 'YOUR_BASE_ID'; 
  final String tableName = 'YOUR_TABLE_NAME'; 

  late AirtableCrud airtableCrud;
  List<AirtableRecord> records = [];
  bool isLoading = true;

  @override
  void initState() {
    super.initState();
    airtableCrud = AirtableCrud(apiKey, baseId);
    fetchRecords();
  }

  Future<void> fetchRecords() async {
    setState(() {
      isLoading = true;
    });

    try {
      List<AirtableRecord> fetchedRecords = await airtableCrud.fetchRecords(tableName);
      setState(() {
        records = fetchedRecords;
        isLoading = false;
      });
    } catch (e) {
      print('Error fetching records: $e');
      setState(() {
        isLoading = false;
      });
    }
  }

  Future<void> createRecord() async {
    final newRecord = {
      'firstname': 'New',
      'lastname': 'User',
      'email': 'new.user@example.com',
    };

    try {
      await airtableCrud.createRecord(tableName, newRecord);
      await fetchRecords();
    } catch (e) {
      print('Error creating record: $e');
    }
  }

  Future<void> bulkCreateRecords() async {
    final dataList = [
      {
        'firstname': 'Bulk',
        'lastname': 'User1',
        'email': 'bulk.user1@example.com',
      },
      {
        'firstname': 'Bulk',
        'lastname': 'User2',
        'email': 'bulk.user2@example.com',
      },
    ];

    try {
      await airtableCrud.bulkCreateRecords(tableName, dataList);
      await fetchRecords();
    } catch (e) {
      print('Error bulk creating records: $e');
    }
  }

  Future<void> updateRecord(AirtableRecord record) async {
    record.fields['lastname'] = 'Updated';

    try {
      await airtableCrud.updateRecord(tableName, record);
      await fetchRecords();
    } catch (e) {
      print('Error updating record: $e');
    }
  }

  Future<void> deleteRecord(String id) async {
    try {
      await airtableCrud.deleteRecord(tableName, id);
      await fetchRecords();
    } catch (e) {
      print('Error deleting record: $e');
    }
  }

  Widget buildRecordList() {
    return ListView.builder(
      itemCount: records.length,
      itemBuilder: (context, index) {
        AirtableRecord record = records[index];
        return ListTile(
          title: Text(record.fields['firstname'] ?? 'No Name'),
          subtitle: Text(record.fields['email'] ?? ''),
          trailing: Row(
            mainAxisSize: MainAxisSize.min,
            children: [
              IconButton(
                icon: Icon(Icons.edit),
                onPressed: () => updateRecord(record),
              ),
              IconButton(
                icon: Icon(Icons.delete),
                onPressed: () => deleteRecord(record.id),
              ),
            ],
          ),
        );
      },
    );
  }

  Widget buildLoading() {
    return Center(child: CircularProgressIndicator());
  }

  Widget buildContent() {
    if (isLoading) {
      return buildLoading();
    } else {
      return buildRecordList();
    }
  }

  void showActionsDialog() {
    showDialog(
      context: context,
      builder: (BuildContext context) {
        return AlertDialog(
          title: Text('Select Action'),
          content: SingleChildScrollView(
            child: ListBody(
              children: <Widget>[
                ElevatedButton(
                  onPressed: () {
                    Navigator.of(context).pop();
                    createRecord();
                  },
                  child: Text('Create Single Record'),
                ),
                ElevatedButton(
                  onPressed: () {
                    Navigator.of(context).pop();
                    bulkCreateRecords();
                  },
                  child: Text('Bulk Create Records'),
                ),
              ],
            ),
          ),
        );
      },
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Airtable CRUD Example'),
      ),
      body: buildContent(),
      floatingActionButton: FloatingActionButton(
        onPressed: () => showActionsDialog(),
        child: Icon(Icons.add),
      ),
    );
  }
}

以上是 airtable_crud 插件的基本使用方法和一个完整的示例应用。希望对您有所帮助！