Flutter深度链接管理插件legato_centralize_deep_link的使用

Flutter深度链接管理插件legato_centralize_deep_link的使用

特点

• 生成集中式深度链接URL：创建一个链接到应用程序特定内容或功能的URL。
• 从深度链接URL提取令牌：从深度链接URL中检索唯一的令牌，然后可以用来查询元数据并执行其他操作。

安装

在pubspec.yaml文件中添加依赖：

dependencies:
  legato_centralize_deep_link: ^1.0.0

然后运行以下命令安装：

flutter pub get

使用方法

导入库：

import 'package:legato_centralize_deep_link/legato_centralize_deep_link.dart';

生成集中式深度链接URL

要创建一个集中式的深度链接URL，可以使用generateDeepLink方法。此方法接受一个令牌，并返回一个可以共享或用于导航到应用程序内特定内容的URL。

final _config = const DeepLinkConfiguration(
    projectId: '{PROJECT_ID}',
    apiKey: '{API_KEY}',
    secret: '{SECRET}');

final _env = DeepLinkEnvironment.dev;

Future<void> _generateDeepLink() async {
  String generateLink;
  
  try {
    generateLink = await DeepLink().generateDeepLink(
        _config,
        _env,
        const GenerateLinkRequest(metadata: {
          "page_type": "product",
          "page_id": 1,
          "page_title": "Aliquam erat volutpat."
        }, pageUrl: 'https://placeholder.com/'));
  } on PlatformException {
    generateLink = 'Failed to generate deep link';
  } on Exception {
    generateLink = 'On Exception';
  }

  if (!mounted) return;
  setState(() {
    _deepLink = generateLink;
  });
}

从深度链接URL中提取令牌

要从深度链接URL中提取令牌，可以使用extractTokenFromUrl方法。这将返回元数据，可以用来查询或其他操作。

import 'package:legato_centralize_deep_link/legato_centralize_deep_link.dart';

final _config = const DeepLinkConfiguration(
    projectId: '{PROJECT_ID}',
    apiKey: '{API_KEY}',
    secret: '{SECRET}');

final _env = DeepLinkEnvironment.dev;

Future<void> _extraMetadata(String token) async {
  Map<String, dynamic> metaData = {};

  try {
    final metaRequest = {
      'is_click': false,
      'is_redirect': true,
      'is_flutter': true
    };
    metaData = await DeepLink().extractLinkMetaData(_config, _env, token,
        metaData: metaRequest);
  } on PlatformException {
    _metaData = 'Failed to generate deep link';
  } on Exception {
    _metaData = 'On Exception';
  }

  if (!mounted) return;
  setState(() {
    _metaData = jsonEncode(metaData);
  });
}

Android配置

要在Android上处理深度链接，需要在AndroidManifest.xml文件中为主活动的<activity>标签下添加以下意图过滤器。

步骤1：添加深度链接配置

<intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />

    <data android:scheme="https" />
    <data android:host="@string/centralize_host" />
</intent-filter>

<intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />

    <data android:scheme="https" />
    <data android:host="@string/centralize_host" />
    <data android:pathPrefix="/token" />
</intent-filter>

步骤2：在res/values/strings.xml中定义centralize_host

打开res/values/strings.xml文件并添加以下行：

<string name="centralize_host">deeplinkdev-dynamic-{name}.legato.co</string>

示例代码

import 'dart:developer';

import 'package:legato_centralize_deep_link/legato_centralize_deep_link.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  return runApp(MainBody());
}

class MainBody extends StatelessWidget {
  final router = AppRouter(); // 假设有一个AppRouter类

  MainBody({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp.router(
      title: 'Centralize DeepLinks Example',
      routerConfig: router.config(deepLinkTransformer: _transformDeepLink),
    );
  }

  Future<Uri> _transformDeepLink(Uri uri) async {
    log('_transformDeepLink: $uri');
    if ('deeplinkdev-dynamic-{name}.legato.co' == uri.host) {
      log('_transformDeepLink onDeeplink: $uri');
      final segments = uri.pathSegments;
      if (segments.isNotEmpty && segments.last.isNotEmpty) {
        final token = segments.last;
        final metadata = await HandleDeepLinks.instance.extraMetadata(token);
        final referralCode = metadata['referral_code'];
        if (referralCode != null && referralCode is String && referralCode.isNotEmpty) {
          final transform = uri.replace(
              path: '/location',
              queryParameters: {'referral_code': referralCode});
          log('_transformDeepLink onDeeplink transform: $transform');
          return SynchronousFuture(transform);
        }
      }
    }
    return SynchronousFuture(uri);
  }
}