Flutter安装来源追踪插件flutter_install_referrer的使用

flutter_install_referrer 是一个Flutter插件，允许你检测你的应用程序是如何被安装的。

该插件最初由 daad.mobi 开发，你可以在这里找到上游仓库 g123k/flutter_plugin_install_referrer。然而，该项目已经停止维护并且两年没有更新。这个新的包 fork 并重写了项目，将旧的 Java/Objective-C 代码迁移到现代的 Kotlin 和 Swift，并且增加了对 Swift Package Manager 的支持。

支持的平台

• Android: ✅
• iOS: ✅

欢迎提交 PR 来添加对新平台的支持或建议更改。

安装

1. 在 pubspec.yaml 文件中添加 flutter_install_referrer: ^2.0.1。
2. 导入 import 'package:flutter_install_referrer/flutter_install_referrer.dart';
3. 通过调用 Future InstallReferrer.referrer 获取值。

可能的值

Android

如果应用是从第三方应用（如 GMail、Google Drive、Chrome 等）安装的，它将被视为 手动安装 (InstallationAppReferrer.androidManually)。

如果应用是从设备上未预安装的应用商店（如 FDroid、Amazon App Shop 等）安装的，也将被视为 手动安装 (InstallationAppReferrer.androidManually)。

如果 Android 应用处于调试模式，它将被标记为 InstallationAppReferrer.androidDebug。

iOS

如果 iOS 应用处于调试模式（例如：从模拟器），它将被标记为 InstallationAppReferrer.iosDebug。

包名

你还可以通过调用 InstallReferrer.app 获取包名（Android）或应用 ID（iOS）。

Widgets

如果你想在 Widget 中直接接收结果，有两种选择：InstallReferrerDetectorListener 和 InstallReferrerDetectorBuilder。

InstallReferrerDetectorBuilder(
  builder: (BuildContext context, InstallationApp? app) {
    if (app == null) {
      return const CircularProgressIndicator.adaptive();
    } else {
      return Text(
        'Package name:\n${app.packageName ?? 'Unknown'}\n'
        'Referrer:\n${referrerToReadableString(app.referrer)}',
        textAlign: TextAlign.center,
      );
    }
  },
);

InstallReferrerDetectorListener(
  child: YourWidget(),
  onReferrerAvailable: (InstallationApp? app) {
    // TODO
  },
);

示例代码

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

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Installation Referrer plugin example app'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.spaceAround,
            children: [
              FutureBuilder(
                future: InstallReferrer.app,
                builder: (BuildContext context, AsyncSnapshot<InstallationApp> result) {
                  if (!result.hasData) {
                    return const CircularProgressIndicator.adaptive();
                  } else if (result.hasError) {
                    return const Text('Unable to detect your referrer');
                  } else {
                    return Text(
                      'Package name:\n${result.data!.packageName ?? 'Unknown'}\n'
                      'Referrer:\n${referrerToReadableString(result.data!.referrer)}',
                      textAlign: TextAlign.center,
                    );
                  }
                },
              ),
              InstallReferrerDetectorBuilder(
                builder: (BuildContext context, InstallationApp? app) {
                  if (app == null) {
                    return const CircularProgressIndicator.adaptive();
                  } else {
                    return Text(
                      'Package name:\n${app.packageName ?? 'Unknown'}\n'
                      'Referrer:\n${referrerToReadableString(app.referrer)}',
                      textAlign: TextAlign.center,
                    );
                  }
                },
              ),
              InstallReferrerDetectorListener(
                child: const Text('Listener'),
                onReferrerAvailable: (InstallationApp? app) {
                  // ignore: avoid_print
                  print(app?.referrer);
                },
              ),
            ],
          ),
        ),
      ),
    );
  }

  String referrerToReadableString(InstallationAppReferrer referrer) {
    switch (referrer) {
      case InstallationAppReferrer.iosAppStore:
        return "Apple - App Store";
      case InstallationAppReferrer.iosTestFlight:
        return "Apple - Test Flight";
      case InstallationAppReferrer.iosDebug:
        return "Apple - Debug";
      case InstallationAppReferrer.androidGooglePlay:
        return "Android - Google Play";
      case InstallationAppReferrer.androidAmazonAppStore:
        return "Android - Amazon App Store";
      case InstallationAppReferrer.androidHuaweiAppGallery:
        return "Android - Huawei App Gallery";
      case InstallationAppReferrer.androidOppoAppMarket:
        return "Android - Oppo App Market";
      case InstallationAppReferrer.androidSamsungAppShop:
        return "Android - Samsung App Shop";
      case InstallationAppReferrer.androidVivoAppStore:
        return "Android - Vivo App Store";
      case InstallationAppReferrer.androidXiaomiAppStore:
        return "Android - Xiaomi App Store";
      case InstallationAppReferrer.androidManually:
        return "Android - Manual installation";
      case InstallationAppReferrer.androidDebug:
        return "Android - Debug";
    }
  }
}

以上代码展示了如何使用 flutter_install_referrer 插件来检测应用的安装来源，并在界面上显示相关信息。希望这对你的项目有所帮助！