Flutter应用链接处理插件app_links的使用

app_links简介

app_links 是一个用于处理Android App Links、Deep Links、iOS Universal Links以及自定义URL方案（包括Linux、macOS和Windows桌面平台）的Flutter插件。它允许你的应用程序从以下方式打开：

• HTTPS URL，而不是在浏览器中打开。
• 自定义方案。

开始使用

在使用插件之前，需要为每个目标平台进行设置。所有配置都可以在示例项目中找到。具体配置文档如下：

• Android
• iOS
• Linux
• macOS
• Windows

对于Web平台，无需特别设置，仅提供初始链接。

使用AppLinks

确保在应用程序早期实例化 AppLinks 以捕获冷启动时的第一个链接。

final appLinks = AppLinks(); // AppLinks是单例

// 订阅所有事件（初始链接和后续链接）
final sub = appLinks.uriLinkStream.listen((uri) {
    // 执行某些操作（导航等）
});

特性矩阵

• : Web平台仅提供首次调用。主要是为了简化特定设置的需求。

示例代码

以下是完整的示例代码，展示了如何使用 app_links 插件来处理深度链接和自定义URL方案。

import 'dart:async';

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

const kWindowsScheme = 'sample';

void main() {
  // 注册我们的协议仅在Windows平台上
  // registerProtocolHandler(kWindowsScheme);

  runApp(const MyApp());
}

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _navigatorKey = GlobalKey<NavigatorState>();
  late AppLinks _appLinks;
  StreamSubscription<Uri>? _linkSubscription;

  @override
  void initState() {
    super.initState();

    initDeepLinks();
  }

  @override
  void dispose() {
    _linkSubscription?.cancel();

    super.dispose();
  }

  Future<void> initDeepLinks() async {
    _appLinks = AppLinks();

    // 处理链接
    _linkSubscription = _appLinks.uriLinkStream.listen((uri) {
      debugPrint('onAppLink: $uri');
      openAppLink(uri);
    });
  }

  void openAppLink(Uri uri) {
    _navigatorKey.currentState?.pushNamed(uri.fragment);
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: _navigatorKey,
      initialRoute: "/",
      onGenerateRoute: (RouteSettings settings) {
        Widget routeWidget = defaultScreen();

        // 模拟Web路由
        final routeName = settings.name;
        if (routeName != null) {
          if (routeName.startsWith('/book/')) {
            // 导航到 /book/:id
            routeWidget = customScreen(
              routeName.substring(routeName.indexOf('/book/')),
            );
          } else if (routeName == '/book') {
            // 导航到 /book 无其他参数
            routeWidget = customScreen("None");
          }
        }

        return MaterialPageRoute(
          builder: (context) => routeWidget,
          settings: settings,
          fullscreenDialog: true,
        );
      },
    );
  }

  Widget defaultScreen() {
    return Scaffold(
      appBar: AppBar(title: const Text('Default Screen')),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            const SelectableText('''
            Launch an intent to get to the second screen.

            On web:
            http://localhost:<port>/#/book/1 for example.

            On windows & macOS, open your browser:
            sample://foo/#/book/hello-deep-linking

            This example code triggers new page from URL fragment.
            '''),
            const SizedBox(height: 20),
            buildWindowsUnregisterBtn(),
          ],
        ),
      ),
    );
  }

  Widget customScreen(String bookId) {
    return Scaffold(
      appBar: AppBar(title: const Text('Second Screen')),
      body: Center(child: Text('Opened with parameter: $bookId')),
    );
  }

  Widget buildWindowsUnregisterBtn() {
    if (defaultTargetPlatform == TargetPlatform.windows) {
      return TextButton(
          onPressed: () => unregisterProtocolHandler(kWindowsScheme),
          child: const Text('Remove Windows protocol registration'));
    }

    return const SizedBox.shrink();
  }
}

注意事项

• 确保按照各平台的配置文档完成必要的设置。
• 在测试时，可以通过不同的方式触发链接，例如：
  • 在Android模拟器上使用ADB命令：adb shell am start -a android.intent.action.VIEW -d "sample://open.my.app/#/book/hello-world"
  • 在Windows和macOS上，通过浏览器打开：sample://foo/#/book/hello-world2
  • 在Windows上，通过邮件或其他应用打开：https://example.com/#/book/hello-world2

希望这个示例能帮助你更好地理解和使用 app_links 插件！