Flutter快递物流查询插件courier_flutter的使用

需求和支持

安装

在项目根目录下运行以下命令：

flutter pub add courier_flutter

iOS设置

1. 支持iOS 15.0+

更新你的部署目标到iOS 15。

2. 安装CocoaPods

从项目的根目录运行：

cd ios && pod install

Android设置

1. 添加Jitpack仓库

在android/build.gradle文件中确保你的构建和仓库值如下：

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // 添加这一行
    }
}

2. 支持合适的SDK版本

在app/build.gradle文件中更新这些值：

minSdkVersion 23
targetSdkVersion 33+
compileSdkVersion 33+

3. 同步Gradle

你的应用必须支持至少Gradle 8.4。

开始使用

以下是SDK的所有可用功能。

示例项目

分享反馈

我们希望让这个SDK成为管理通知的最佳工具！如果有任何想法或反馈，请联系我们：

• Courier Flutter Issues

示例代码

以下是完整的示例代码，展示了如何使用courier_flutter插件。

import 'env.dart';
import 'example_server.dart';
import 'firebase_options.dart';
import 'package:courier_flutter/courier_provider.dart';
import 'package:courier_flutter/models/courier_inbox_listener.dart';
import 'package:courier_flutter/models/courier_push_listener.dart';
import 'package:courier_flutter_sample/pages/auth.dart';
import 'package:courier_flutter_sample/pages/inbox.dart';
import 'package:courier_flutter_sample/pages/prefs.dart';
import 'package:courier_flutter_sample/pages/push.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:courier_flutter/courier_flutter.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 这是为了处理FCM令牌
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );

  runApp(
    MaterialApp(
      theme: ThemeData(
          // primaryColor: Colors.pink,
          // TODO: 如果你想让收件箱自动继承样式，可以在这里添加更多主题颜色
      ),
      home: const MyApp(),
    ),
  );
}

class Tab {
  NavigationDestination tab;
  Widget page;

  Tab({
    required this.tab,
    required this.page,
  });
}

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

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

class _MyAppState extends State<MyApp> {
  late CourierInboxListener _inboxListener;
  late CourierPushListener _pushListener;

  int _unreadMessageCount = 0;
  int _currentPageIndex = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _start();
  }

  Future _refreshJwt() async {
    final currentUserId = await Courier.shared.userId;

    if (currentUserId != null) {
      try {
        // 获取新的令牌
        final token = await ExampleServer.generateJwt(
            authKey: Env.authKey,
            userId: currentUserId
        );

        // 使用新令牌登录
        await Courier.shared.signIn(
            accessToken: token,
            userId: currentUserId
        );
      } catch (error) {
        print(error);
        await Courier.shared.signOut();
      }
    }
  }

  Future _start() async {
    await _refreshJwt();

    _inboxListener = await Courier.shared.addInboxListener(
      onUnreadCountChanged: (unreadCount) {
        setState(() => _unreadMessageCount = unreadCount);
      }
    );

    _pushListener = await Courier.shared.addPushListener(
      onPushDelivered: (push) => showAlert(context, 'Push Delivered', push.toString()),
      onPushClicked: (push) => showAlert(context, 'Push Clicked', push.toString()),
    );

    try {
      final token = await FirebaseMessaging.instance.getToken();
      if (token != null) {
        Courier.shared.setTokenForProvider(provider: CourierPushProvider.firebaseFcm, token: token);
      }
    } catch (e) {
      print(e);
    }

    // 监听Firebase令牌刷新
    FirebaseMessaging.instance.onTokenRefresh.listen((fcmToken) {
      Courier.shared.setTokenForProvider(provider: CourierPushProvider.firebaseFcm, token: fcmToken);
    }).onError((error) {
      print(error);
    });
  }

  List<Tab> _getTabs(int unreadCount) {
    return [
      Tab(
          tab: const NavigationDestination(
            selectedIcon: Icon(Icons.person_2_sharp),
            icon: Icon(Icons.person_2_outlined),
            label: 'Auth',
          ),
          page: const AuthPage()),
      Tab(
        tab: const NavigationDestination(
          selectedIcon: Icon(Icons.message_sharp),
          icon: Icon(Icons.message_outlined),
          label: 'Push',
        ),
        page: const PushPage(),
      ),
      Tab(
        tab: NavigationDestination(
          selectedIcon: unreadCount > 0 ? Badge(label: Text(unreadCount.toString()), child: const Icon(Icons.inbox_sharp)) : const Icon(Icons.inbox_sharp),
          icon: unreadCount > 0 ? Badge(label: Text(unreadCount.toString()), child: const Icon(Icons.inbox_outlined)) : const Icon(Icons.inbox_outlined),
          label: 'Inbox',
        ),
        page: const InboxPage(),
      ),
      Tab(
        tab: const NavigationDestination(
          selectedIcon: Icon(Icons.room_preferences_sharp),
          icon: Icon(Icons.room_preferences_outlined),
          label: 'Preferences',
        ),
        page: const PrefsPage(),
      )
    ];
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: _getTabs(_unreadMessageCount).map((tab) => tab.page).toList()[_currentPageIndex],
      bottomNavigationBar: NavigationBar(
        onDestinationSelected: (int index) {
          setState(() {
            _currentPageIndex = index;
          });
        },
        selectedIndex: _currentPageIndex,
        destinations: _getTabs(_unreadMessageCount).map((tab) => tab.tab).toList(),
      ),
    );
  }

  void _removeListeners() {
    _pushListener.remove();
    _inboxListener.remove().catchError((error) {
      Courier.log('Failed to remove inbox listener: $error');
    });
  }

  [@override](/user/override)
  void dispose() {
    _removeListeners();
    super.dispose();
  }
}

// 显示对话框
showAlert(BuildContext context, String title, String body) {
  showDialog(
    context: context,
    builder: (context) => AlertDialog(
      title: Text(title),
      content: Scrollbar(
        child: SingleChildScrollView(
          scrollDirection: Axis.vertical,
          child: Text(body),
        ),
      ),
      actions: [
        TextButton(
          child: const Text('OK'),
          onPressed: () => Navigator.pop(context),
        )
      ],
    ),
  );
}