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

install_referrer

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

支持的平台

• Android: ✅
• iOS: ✅

如果你想要支持新的平台，请随时打开一个PR。

安装

1. 将 install_referrer: ^1.2.1 添加到你的 pubspec.yaml 文件中。
2. 导入 import 'package:install_referrer/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
    },
);

示例代码

以下是一个完整的示例代码，展示了如何使用 install_referrer 插件来显示应用的安装来源信息：

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

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

class MyApp extends StatelessWidget {
  const MyApp({
    Key? key,
  }) : super(key: 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";
    }
  }
}

这个示例代码展示了如何使用 install_referrer 插件来获取和显示应用的安装来源信息。你可以根据需要进行修改和扩展。