Flutter Firebase集成插件ap_common_firebase的使用

校務通系列 Firebase 共用

基于应用校务通系列使用到 Firebase 的功能制作的函数库。

套件使用要求

• Flutter: v3.10 以上

Firebase 支援列表

以下为支持的 Firebase 插件及其平台兼容性：

Getting Started

1. 在 pubspec.yaml 中加入 package

dependencies:
  ap_common_firebase: ^0.15.0

执行添加依赖：

$ flutter pub get

2. 初始化 Firebase

首先，确保已经在 Firebase 控制台创建了项目，并下载了 google-services.json（Android）或 GoogleService-Info.plist（iOS）。然后将其分别放入对应的项目目录中：

• Android: android/app/google-services.json
• iOS: ios/Runner/GoogleService-Info.plist

接下来，在 Flutter 应用的主入口文件中初始化 Firebase。例如：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized(); // 确保 Flutter 绑定初始化完成
  await ApCommonFirebase.initializeApp(); // 初始化 Firebase
  runApp(MyApp());
}

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

示例代码：使用 Firebase Analytics

以下是一个简单的示例，展示如何使用 firebase_analytics 插件记录用户事件。

import 'package:flutter/material.dart';
import 'package:ap_common_firebase/analytics/firebase_analytics.dart';

class HomePage extends StatefulWidget {
  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  final FirebaseAnalytics analytics = FirebaseAnalytics();

  void _logEvent(String eventName) {
    analytics.logEvent(name: eventName);
    print('已记录事件: $eventName');
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Firebase Analytics 示例')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () => _logEvent('login_event'),
              child: Text('记录登录事件'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => _logEvent('purchase_event'),
              child: Text('记录购买事件'),
            ),
          ],
        ),
      ),
    );
  }
}

示例代码：使用 Firebase Messaging

以下是一个简单的示例，展示如何接收 Firebase 推送通知。

import 'package:flutter/material.dart';
import 'package:ap_common_firebase/messaging/firebase_messaging.dart';

class NotificationPage extends StatefulWidget {
  [@override](/user/override)
  _NotificationPageState createState() => _NotificationPageState();
}

class _NotificationPageState extends State<NotificationPage> {
  late FirebaseMessaging messaging;

  [@override](/user/override)
  void initState() {
    super.initState();
    messaging = FirebaseMessaging();
    _setupNotifications();
  }

  void _setupNotifications() async {
    // 请求通知权限
    await messaging.requestPermission();

    // 监听消息
    messaging.onMessage.listen((RemoteMessage message) {
      print('收到推送消息: ${message.data}');
      showDialog(
        context: context,
        builder: (context) => AlertDialog(
          title: Text('推送通知'),
          content: Text(message.notification?.body ?? ''),
        ),
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Firebase Messaging 示例')),
      body: Center(
        child: Text('等待推送消息...'),
      ),
    );
  }
}