Flutter集成Branch深度链接插件flutter_branch_sdk的使用

Branch SDK Plugin

Branch 是一个帮助移动应用通过深度链接实现增长的工具，支持引荐系统、分享链接和邀请，并提供完整的归因和分析。Flutter插件flutter_branch_sdk实现了Branch SDK的功能，支持Android、iOS和Web平台。

功能列表

Getting Started

配置Branch Dashboard

1. 注册您的应用程序。
2. 配置Branch仪表板。

平台项目配置

Android集成

• 配置App
• 配置ProGuard

iOS集成

• 配置Bundle Identifier
• 配置Associated Domains
• 配置Info.plist

禁用NativeLink™ Deferred Deep Linking

在ios/Runner/Info.plist文件中添加：

<key>branch_disable_nativelink</key>
<true/>

更改Flutter Deep link标志（Android/iOS）

对于iOS，在ios/Runner/Info.plist文件中添加：

<key>FlutterDeepLinkingEnabled</key>
<false/>

对于Android，在android/app/src/main/AndroidManifest.xml文件中添加：

<meta-data android:name="flutter_deeplinking_enabled" android:value="false" />

Web集成

在web/index.html中添加Branch JavaScript：

<script>
  // load Branch
  (function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setAPIUrl getAPIUrl setDMAParamsForEEA".split(" "), 0);
  // init Branch
  branch.init('key_live_or_test_YOUR_KEY_GOES_HERE');
</script>

安装

在pubspec.yaml文件中添加flutter_branch_sdk作为依赖项。

使用方法

初始化

import 'package:flutter_branch_sdk/flutter_branch_sdk.dart';

await FlutterBranchSdk.init(enableLogging: false, disableTracking: false);

测试Branch集成

FlutterBranchSdk.validateSDKIntegration();

读取深度链接

StreamSubscription<Map> streamSubscription = FlutterBranchSdk.listSession().listen((data) {
  if (data.containsKey("+clicked_branch_link") && data["+clicked_branch_link"] == true) {
    print('Custom string: ${data["custom_string"]}');
  }
}, onError: (error) {
  print('listSession error: ${error.toString()}');
});

创建内容引用（Branch Universal Object）

BranchUniversalObject buo = BranchUniversalObject(
  canonicalIdentifier: 'flutter/branch',
  title: 'Flutter Branch Plugin',
  imageUrl: 'https://raw.githubusercontent.com/RodrigoSMarques/flutter_branch_sdk/master/assets/branch_logo_qrcode.jpeg',
  contentDescription: 'Flutter Branch Description',
  keywords: ['Plugin', 'Branch', 'Flutter'],
  publiclyIndex: true,
  locallyIndex: true,
  contentMetadata: BranchContentMetaData()
    ..addCustomMetadata('custom_string', 'abc')
    ..addCustomMetadata('custom_number', 12345)
    ..addCustomMetadata('custom_bool', true)
    ..addCustomMetadata('custom_list_number', [1,2,3,4,5 ])
    ..addCustomMetadata('custom_list_string', ['a', 'b', 'c']),
);

创建链接引用（BranchLinkProperties）

BranchLinkProperties lp = BranchLinkProperties(
  channel: 'facebook',
  feature: 'sharing',
  stage: 'new share',
  tags: ['one', 'two', 'three']
);
lp.addControlParam('url', 'http://www.google.com');
lp.addControlParam('url2', 'http://flutter.dev');

创建深度链接

BranchResponse response = await FlutterBranchSdk.getShortUrl(buo: buo, linkProperties: lp);
if (response.success) {
  print('Link generated: ${response.result}');
} else {
  print('Error : ${response.errorCode} - ${response.errorMessage}');
}

显示带有深度链接的分享表单

BranchResponse response = await FlutterBranchSdk.showShareSheet(
  buo: buo,
  linkProperties: lp,
  messageText: 'My Share text',
  androidMessageTitle: 'My Message Title',
  androidSharingTitle: 'My Share with');

if (response.success) {
  print('showShareSheet Sucess');
} else {
  print('Error : ${response.errorCode} - ${response.errorMessage}');
}

示例代码

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await FlutterBranchSdk.init(
      enableLogging: true, branchAttributionLevel: BranchAttributionLevel.FULL);
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  void initState() {
    super.initState();
    FlutterBranchSdk.listSession().listen((data) {
      if (data.containsKey("+clicked_branch_link") && data["+clicked_branch_link"] == true) {
        print('Custom string: ${data["custom_string"]}');
      }
    }, onError: (error) {
      print('listSession error: ${error.toString()}');
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

这个示例展示了如何初始化Branch SDK并处理深度链接事件。您可以在initState方法中监听深度链接点击事件，并根据需要处理接收到的数据。