Flutter协议处理插件protocol_handler的使用

简介

protocol_handler 是一个Flutter插件，允许Flutter应用程序注册和处理自定义协议（即深度链接）。通过该插件，开发者可以轻松地让应用响应特定的URL Scheme，从而实现诸如从浏览器打开应用、应用间跳转等功能。

平台支持

快速开始

安装

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

dependencies:
  protocol_handler: ^0.2.0

或者直接从GitHub仓库获取最新版本：

dependencies:
  protocol_handler:
    git:
      url: https://github.com/leanflutter/protocol_handler.git
      ref: main

使用方法

Android配置

编辑 android/app/src/main/AndroidManifest.xml 文件，在 <activity> 标签内添加如下代码：

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <!-- 接受以 myprotocol:// 开头的 URI -->
    <data android:scheme="myprotocol" />
</intent-filter>

iOS配置

编辑 ios/Runner/Info.plist 文件，添加如下内容：

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>myprotocol</string>
    </array>
  </dict>
</array>

macOS配置

编辑 macos/Runner/Info.plist 文件，同样添加上述iOS部分的配置。

Windows配置

对于Windows平台，需要修改 windows/runner/main.cpp 文件。在文件开头添加以下代码：

#include <protocol_handler_windows/protocol_handler_windows_plugin_c_api.h>

并在 wWinMain 函数中加入以下逻辑：

HWND hwnd = ::FindWindow(L"FLUTTER_RUNNER_WIN32_WINDOW", L"protocol_handler_example");
if (hwnd != NULL) {
  DispatchToProtocolHandler(hwnd);
  ::ShowWindow(hwnd, SW_NORMAL);
  ::SetForegroundWindow(hwnd);
  return EXIT_FAILURE;
}

此外，如果你使用MSIX打包工具，则还需要在 msix_config 中添加 protocol_activation 配置：

msix_config:
  protocol_activation: myprotocol

注册并监听协议事件

接下来，在Dart代码中完成协议注册及事件监听：

import 'package:protocol_handler/protocol_handler.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await protocolHandler.register('myprotocol');
  runApp(MyApp());
}

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

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> with ProtocolListener {
  @override
  void initState() {
    protocolHandler.addListener(this);
    super.initState();
  }

  @override
  void dispose() {
    protocolHandler.removeListener(this);
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    // 构建页面UI...
  }

  @override
  void onProtocolUrlReceived(String url) {
    print('接收到的URL为：$url');
  }
}

以上就是关于 protocol_handler 插件的基本用法介绍。更多高级功能和细节，请参考官方文档或示例项目。