Flutter错误处理插件appwrite_error_handling的使用

Flutter错误处理插件appwrite_error_handling的使用

此包提供了一种简单有效的方式来处理来自Appwrite后端服务的错误。通过使用此包，您可以利用一种简单的方式处理Appwrite错误。只需将您的代码包装在handleResponse函数中，它将为您处理所有错误，并返回Either<AppwriteException, T>，其中T是响应的类型。或者，您可以使用handleVoidResponse函数来处理无响应的情况。

特性

• 单例实例： 确保在整个应用程序中仅使用一个AppwriteErrorHandling实例。
• 本地化支持： 包支持10种语言（en, pl, ar, bn, de, es, fr, pt, ru, zh）。
• 动态语言更新： 在运行时更改错误消息的语言。

开始使用

首先，设置应用程序的初始语言。您可以在main.dart文件中完成此操作。

import 'package:appwrite_error_handling/appwrite_error_handling.dart';

void main() async {
  await AppwriteErrorHandling.instance.init(Locale("pl"));
  runApp(const MyApp());
}

在设置界面或其他任何需要更改语言的地方更新语言，例如在bloc或provider中。

import 'package:appwrite_error_handling/appwrite_error_handling.dart';

void updateLanguage(Locale locale) async {
  await AppwriteErrorHandling.instance.updateLanguage(locale);
}

要处理代码中的错误，您可以使用handleResponse函数或handleVoidResponse函数。

/// 数据源类
class DataSource {
  final databases = appwrite.Databases(appwrite.Client());

  Future<List<Todo>> getTodos() async {
    final todos = await databases.listDocuments(
      databaseId: '<DATABASE_ID>',
      collectionId: '[COLLECTION_ID]',
    );
    return todos.documents.map((e) => Todo.fromJson(e.data)).toList();
  }
}

/// 存储库类
class Repository {
  final DataSource dataSource = DataSource();

  Future<Either<AppwriteException, List<Todo>>> getTodos() async {
    return await handleResponse(() async {
      return await DataSource().getTodos();
    });
  }
}

/// 在您希望向用户显示数据或错误信息的代码中，例如在bloc中
class MyBloc {
  final Repository repository = Repository();

  void fetchData() async {
    final result = await repository.getTodos();
    result.fold(
      (failure) => showError(failure.exception.message),
      (success) => showSuccess(success),
    );
  }
}

其他信息

如果您有任何问题或遇到任何问题，请随时在这个仓库中添加问题。

如果您发现任何不良翻译，请随时在这个仓库中添加问题。

贡献

如果您想为该包做出贡献，请随时在此仓库中创建拉取请求或打开一个问题。

完整示例代码

以下是完整的示例代码，展示了如何使用appwrite_error_handling包。

import 'package:appwrite/appwrite.dart' as appwrite;
import 'package:appwrite_error_handling/appwrite_error_handling.dart';
import 'package:appwrite_error_handling/src/appwrite_failures.dart';
import 'package:dartz/dartz.dart' as dartz;
import 'package:flutter/material.dart';

// Todo 类
class Todo {
  final String? $id;
  final String? title;
  final String? description;
  final String? status;
  final String? createdAt;
  final String? updatedAt;

  Todo({
    this.$id,
    this.title,
    this.description,
    this.status,
    this.createdAt,
    this.updatedAt,
  });

  factory Todo.fromJson(Map<String, dynamic> json) => Todo(
        $id: json['\$id'],
        title: json['title'],
        description: json['description'],
        status: json['status'],
        createdAt: json['\$createdAt'],
        updatedAt: json['\$updatedAt'],
      );

  Map<String, dynamic> toJson() => {
        '\$id': $id,
        'title': title,
        'description': description,
        'status': status,
      };
}

// 数据源类
class DataSource {
  final databases = appwrite.Databases(appwrite.Client());

  Future<List<Todo>> getTodos() async {
    final todos = await databases.listDocuments(
      databaseId: '<DATABASE_ID>',
      collectionId: '[COLLECTION_ID]',
    );
    return todos.documents.map((e) => Todo.fromJson(e.data)).toList();
  }
}

// 存储库类
class Repository {
  final DataSource dataSource = DataSource();

  Future<dartz.Either<AppwriteFailure, List<Todo>>> getTodos() async {
    return await handleResponse(() async {
      return await DataSource().getTodos();
    });
  }
}

// 用例类
class UseCase {
  final Repository repository = Repository();

  Future<dartz.Either<AppwriteFailure, List<Todo>>> getTodos() async {
    return await repository.getTodos();
  }
}

Future<void> main() async {
  await AppwriteErrorHandling.instance.init(const Locale("pl"));
  await AppwriteErrorHandling.instance.updateLanguage(const Locale('en'));
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final UseCase useCase = UseCase();
  String text = '';

  [@override](/user/override)
  void initState() {
    // TODO: 实现initState
    super.initState();
    _getTodos();
  }

  _getTodos() async {
    final result = await useCase.getTodos();
    setState(() {
      text = result.fold(
        (failure) => failure.translation,
        (todos) => "TODOS ARE HERE, U can use them",
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Text(text),
      ),
    );
  }
}