Flutter对话框服务插件dialog_service的使用

本文档描述了 dialog_service 包的功能。如果您将此包发布到 pub.dev，此文档的内容将出现在您的包的首页。

特性

通过 Controller 类或没有上下文访问的类推送对话框。这对于错误对话框非常有用。

使用方法

以下是一个完整的示例，展示如何在 Flutter 应用中使用 dialog_service 插件。

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 dialog_service 依赖：

dependencies:
  dialog_service: ^1.0.0

然后运行 flutter pub get 安装依赖。

2. 创建应用入口

在 MyApp 中，使用 DialogNavigator 包裹你的应用，以便处理对话框导航。

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: (context, child) => DialogNavigator(child),
      // 添加你的路由或主页
      home: MyHomePage(),
    );
  }
}

3. 创建控制器类

在控制器类中，使用 DialogService 来推送对话框。例如，当发生错误时，我们可以推送一个错误对话框。

class AppController {
  final DialogService _dialogService = DialogService();

  void doSomething() {
    try {
      didSomethingWithError(); // 模拟可能会抛出异常的操作
    } catch (e) {
      // 推送错误对话框
      _dialogService.pushDialog(
        builder: (context) => ErrorDialog(message: e.toString()),
      );
    }
  }

  void didSomethingWithError() {
    throw Exception("模拟错误"); // 模拟一个错误
  }
}

4. 创建自定义对话框

创建一个自定义的错误对话框组件 ErrorDialog，用于显示错误信息。

class ErrorDialog extends StatelessWidget {
  final String message;

  const ErrorDialog({required this.message});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return AlertDialog(
      title: Text("错误"),
      content: Text(message),
      actions: [
        TextButton(
          onPressed: () => Navigator.of(context).pop(), // 关闭对话框
          child: Text("确定"),
        ),
      ],
    );
  }
}

5. 运行应用

现在，您可以运行应用，并测试当发生错误时是否正确显示了对话框。

class MyHomePage extends StatelessWidget {
  final AppController _appController = AppController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Dialog Service 示例"),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            _appController.doSomething(); // 触发操作
          },
          child: Text("触发错误"),
        ),
      ),
    );
  }
}

完整代码示例

以下是完整的代码示例：

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: (context, child) => DialogNavigator(child),
      home: MyHomePage(),
    );
  }
}

class AppController {
  final DialogService _dialogService = DialogService();

  void doSomething() {
    try {
      didSomethingWithError(); // 模拟可能会抛出异常的操作
    } catch (e) {
      // 推送错误对话框
      _dialogService.pushDialog(
        builder: (context) => ErrorDialog(message: e.toString()),
      );
    }
  }

  void didSomethingWithError() {
    throw Exception("模拟错误"); // 模拟一个错误
  }
}

class ErrorDialog extends StatelessWidget {
  final String message;

  const ErrorDialog({required this.message});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return AlertDialog(
      title: Text("错误"),
      content: Text(message),
      actions: [
        TextButton(
          onPressed: () => Navigator.of(context).pop(), // 关闭对话框
          child: Text("确定"),
        ),
      ],
    );
  }
}

class MyHomePage extends StatelessWidget {
  final AppController _appController = AppController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Dialog Service 示例"),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            _appController.doSomething(); // 触发操作
          },
          child: Text("触发错误"),
        ),
      ),
    );
  }
}