Flutter协议客户端插件proto_base_client的使用

Flutter协议客户端插件proto_base_client的使用

标题

ProtoBase Client

内容

ProtoBase Client 是一个简单且轻量级的 Dart 包，旨在帮助开发者轻松地将认证和数据库功能集成到应用中。它提供了通过 ProtoBase API 使用电子邮件或用户名进行注册和登录的方法，以及数据库操作方法。

特性

• 基于电子邮件的认证：

  • 使用电子邮件、密码和用户名注册。
  • 使用电子邮件、密码和用户名登录。

• 基于用户名的认证：

  • 使用用户名和密码注册。
  • 使用用户名和密码登录。

• API Token 使用：

  • 从 官方网站 获取您的 API 密钥。
  • 使用 API 密钥来验证请求。

• 数据库操作：

  • 创建表。
  • 插入数据到表。
  • 读取表中的数据。
  • 更新表中的数据。
  • 删除表中的数据。

安装

在 pubspec.yaml 文件中添加以下内容：

dependencies:
  proto_base_client: ^2.1.1-dev

运行 flutter pub get 来安装该包。

使用示例

import 'package:proto_base_client/proto_base_client.dart';

void main() async {
  final client = ProtoBaseApiClient();
  final dbClient = ProtoBaseDatabaseClient();

  // 示例使用：认证
  final signupResponse = await client.signupWithEmail(
    'username',
    'password',
    'email@example.com',
    'api_token',
  );
  print(signupResponse);

  // 示例使用：数据库操作
  final createTableResponse = await dbClient.createTable(
    'api_token',
    'username',
    'project_name',
    'table_name',
    ['column1', 'column2'],
    ['type1', 'type2'],
  );
  print(createTableResponse);
}

API 端点

此包与以下 API 端点交互：

• /auth_api/email-signup/
• /auth_api/email-signin/
• /auth_api/user-signup/
• /auth_api/user-signin/
• /db_api/create_table
• /db_api/insert_data
• /db_api/read_data
• /db_api/update_data
• /db_api/delete_data

许可证

此包遵循 MIT License。 详情请参阅 LICENSE 文件。

示例代码

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

import 'home.dart';

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

class MyApp extends StatefulWidget {
  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final ProtoBaseApiClient client = ProtoBaseApiClient();

  final ProtoBaseDatabaseClient _client = ProtoBaseDatabaseClient();

  final String _apiToken = 'Your Token Here';
  // 替换为您的 API 密钥
  final String _username = 'Your_Username';
  // 替换为您的用户名
  final String _projectName = 'Spendit';
  // 替换为您的项目名称
  String _response = '';

  void _createTable() async {
    try {
      final result = await _client.createTable(
        _apiToken,
        _username,
        _projectName,
        'test_table',
        ['id', 'name', 'age'],
        ['int', 'text', 'int'],
      );
      setState(() {
        _response = result.toString();
      });
    } catch (e) {
      setState(() {
        _response = 'Error: $e';
      });
    }
  }

  void _insertData() async {
    try {
      final result = await _client.insertData(
        _apiToken,
        _username,
        _projectName,
        'test_table',
        {'id': 1, 'name': 'John Doe', 'age': 30},
      );
      setState(() {
        _response = result.toString();
      });
    } catch (e) {
      setState(() {
        _response = 'Error: $e';
      });
    }
  }

  void _readData() async {
    try {
      final result = await _client.readData(
        _apiToken,
        _username,
        _projectName,
        'test_table',
      );
      setState(() {
        _response = result.toString();
      });
    } catch (e) {
      setState(() {
        _response = 'Error: $e';
      });
    }
  }

  void _updateData() async {
    try {
      final result = await _client.updateData(
        _apiToken,
        _username,
        _projectName,
        'test_table',
        'id = 1',
        {'name': 'Jane Doe', 'age': 25},
      );
      setState(() {
        _response = result.toString();
      });
    } catch (e) {
      setState(() {
        _response = 'Error: $e';
      });
    }
  }

  void _deleteData() async {
    try {
      final result = await _client.deleteData(
        _apiToken,
        _username,
        _projectName,
        'test_table',
        'id = 1',
      );
      setState(() {
        _response = result.toString();
      });
    } catch (e) {
      setState(() {
        _response = 'Error: $e';
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ProtoBase Client Demo',
      home: Scaffold(
        appBar: AppBar(title: Text('ProtoBase Client Demo')),
        body: Center(
          child: Column(
            children: [
              ElevatedButton(
                onPressed: () async {
                  await client.signinWithEmail(
                    'Technoblade',
                    'never',
                    'dies@gmail.com',
                    'UOUuh66m6lv1OeChrtuZQLCY0VyLIv6aniI8mJgNun3y2lmK5DhgOgu98K1Ei33Zhm903FHNfCUv03cQKpJ5BXA',
                    context,
                    HomePage(),
                  );
                },
                child: Text('Sign Up'),
              ),
              
              ElevatedButton(
                onPressed: _createTable,
                child: Text('Create Table'),
              ),
              ElevatedButton(
                onPressed: _insertData,
                child: Text('Insert Data'),
              ),
              ElevatedButton(onPressed: _readData, child: Text('Read Data')),
              ElevatedButton(
                onPressed: _updateData,
                child: Text('Update Data'),
              ),
              ElevatedButton(
                onPressed: _deleteData,
                child: Text('Delete Data'),
              ),
              SizedBox(height: 20),
              Expanded(
                child: SingleChildScrollView(
                  child: Text(_response, style: TextStyle(fontSize: 16)),
                ),
              ),
            ],
          ),
        ),
      ),
    );
  }
}