Flutter异常处理插件api_exception的使用

Flutter异常处理插件api_exception的使用

特性

• 处理400 - 500状态码的正常消息错误。
• 可以自定义错误信息。

平台支持

入门指南

要使用此插件，在pubspec.yaml文件中添加api_exception作为依赖项。

dependencies:
  api_exception: ^x.x.x

使用方法

导入库

在需要使用的Dart文件中导入库：

import 'package:api_exception/api_exception.dart';

处理异常

在服务层中添加以下代码来处理异常。不要忘记添加catch（捕获AppException）以便将错误重新抛出到逻辑层等。

ExceptionHandling.handelAPIError(
  desireStatusCode: 200, // 期望的状态码
  response: response, // 响应数据
);

示例

在业务逻辑层中处理API请求并捕获异常：

[@override](/user/override)
Future<List<VideoTypesData>> getData() async {
  try {
    final url = _appEndpoint.getData();
    final response = await _httpClient.get(url, {});
    ExceptionHandling.handelAPIError(
      desireStatusCode: 200,
      response: response,
    );
    return VideoTypes.fromJson(response.body).data;
  } on AppException {
    rethrow;
  }
}

处理错误信息

在视图层中可以这样处理错误信息：

Text(exception?.errorMessage(context) ?? '未知错误')

示例

在状态管理中显示错误信息：

if (state.status.isFailure) {
  ScaffoldMessenger.of(context)
    ..hideCurrentSnackBar
    ..showSnackBar(
      SnackBar(
        backgroundColor: Colors.red,
        content: Text(
          state.exception?.errorMessage(context) ?? '未知错误',
          style: const TextStyle(
            color: Colors.white,
            fontWeight: FontWeight.bold,
          ),
        ),
      ),
    );
}

自定义错误信息

可以通过传递参数来自定义错误信息：

// 示例错误码状态 = 404
Text(exception?.errorMessage(context, notFoundMessage: "抱歉，我们找不到您的数据") ?? '未知错误')

对于未知错误，包会从JSON响应体中获取错误信息（“message” || “error”），或者你可以修改错误信息。

错误类型列表

case ErrorType.badRequest:
  return "Bad Request";

case ErrorType.unauthorized:
  return "Unauthorized";

case ErrorType.paymentRequired:
  return "Payment Required";

case ErrorType.loginFailed:
  return "登录失败";

case ErrorType.unauthenticated:
  return "未认证";

case ErrorType.unknown:
  return "未知错误";

case ErrorType.forbidden:
  return "禁止";

case ErrorType.notFound:
  return "未找到";

case ErrorType.methodNotAllowed:
  return "方法不允许";

case ErrorType.notAcceptable:
  return "不可接受";

case ErrorType.internalServerError:
  return "内部服务器错误";

case ErrorType.notImplemented:
  return "未实现";

case ErrorType.badGateway:
  return "坏网关";

完整示例代码

以下是完整的示例代码：

import 'package:api_exception_example/cubit/home_cubit.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:api_exception/exception.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return BlocProvider(
      create: (context) => HomeCubit()..onInitData(),
      child: BlocConsumer<HomeCubit, HomeState>(
        listener: (context, state) {
          if (state.status.isFailure) {
            ScaffoldMessenger.of(context)
              ..hideCurrentSnackBar
              ..showSnackBar(
                SnackBar(
                  backgroundColor: Colors.red,
                  content: Text(
                    state.exception?.errorMessage(context) ?? "未知错误",
                    style: const TextStyle(
                      color: Colors.white,
                      fontWeight: FontWeight.bold,
                    ),
                  ),
                ),
              );
          }
        },
        builder: (context, state) {
          return Scaffold(
            appBar: AppBar(
              title: const Text("示例获取数据"),
            ),
            body: state.status.isLoading || state.status.isFailure
                ? const Center(
                    child: CircularProgressIndicator(),
                  )
                : const Text("成功获取数据"),
          );
        },
      ),
    );
  }
}