Flutter链接管理插件jmlink_flutter_plugin的使用

Flutter链接管理插件jmlink_flutter_plugin的使用

安装

在工程 pubspec.yaml 文件中加入依赖项：

dependencies:
  jmlink_flutter_plugin: 2.1.4

或者，如果你需要从GitHub拉取最新版本：

dependencies:
  jmlink_flutter_plugin:
    git:
      url: git://github.com/jpush/jmlink-flutter-plugin.git
      ref: master

配置

Android

1. 在 /android/app/build.gradle 中添加以下代码：

android: {
  ....
  defaultConfig {
    applicationId "替换成自己应用 ID"
    ...
    ndk {
      // 选择要添加的对应 CPU 类型的 .so 库。
      abiFilters 'armeabi', 'armeabi-v7a', 'x86', 'x86_64', 'mips', 'mips64', 'arm64-v8a'
    }

    manifestPlaceholders = [
        JPUSH_PKGNAME : applicationId,
        JPUSH_APPKEY : "appkey", // NOTE: JPush 上注册的包名对应的 Appkey.
        JPUSH_CHANNEL : "developer-default", // 暂时填写默认值即可.
        JMLINK_SCHEME: "your_scheme", // 设置跳转的scheme
    ]
  }
}

1. 在 /android/app/src/main/AndroidManifest.xml 中配置 scheme：

<!-- 将“your_scheme”替换为后台填写的 URI Scheme。-->

<activity android:name=".WelcomeActivity">
     <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='${JMLINK_SCHEME}' />
     </intent-filter>
</activity>

1. 注意：配置完 scheme 之后，必须在 WelcomeActivity 的 onCreate 方法中执行 JmlinkFlutterPlugin.setData 方法：

public class WelcomeActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        Log.d("| WelcomeActivity | - ", "onCreate:");
        super.onCreate(savedInstanceState);

        JmlinkFlutterPlugin.setData(getIntent().getData());

        Intent intent = new Intent(this, MainActivity.class);
        startActivity(intent);
        finish();
    }

    protected void onDestroy() {
        Log.d("| WelcomeActivity | - ", "onDestroy:");
        super.onDestroy();
    }

    protected void onNewIntent(Intent intent) {
        Log.d("| WelcomeActivity | - ", "onNewIntent:");
        super.onNewIntent(intent);
        setIntent(intent);
    }
}

iOS

详细配置请参考 iOS指南。

1. 配置App的URL Scheme

   在Xcode中选中Target -> Info -> URL Types，配置URL Scheme（例如：jmlink）。

   在Safari中输入 URL Scheme:// （例如：jmlink://），如果能够唤起App，说明该URL Scheme配置成功。

2. 配置Universal Link

   Universal Link是iOS9的一个新特性，通过它，App可以从微信等应用中直接跳转到App，实现一键直达。

示例代码

以下是一个完整的示例代码，展示了如何使用 jmlink_flutter_plugin 插件。

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

import 'package:jmlink_flutter_plugin/jmlink_flutter_plugin.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final JmlinkFlutterPlugin jmlink = new JmlinkFlutterPlugin();

  String _paramString = "param";
  String _defaultMlinkMapString = "default handler";
  String _milinkMapString = "key handler";

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息是异步的，所以我们初始化在异步方法中。
  Future<void> initPlatformState() async {
    JMLConfig config = new JMLConfig();
    config.appKey = "e58a32cb3e4469ebf31867e5";
    config.channel = "devloper-default"; // 初始化sdk,  appKey 和 channel 只对ios设置有效
    config.useIDFA = false;
    config.isProduction = true;
    config.debug = true;

    jmlink.setup(config: config);

    registerDefaultJMLinkHandler();

    if (!mounted) return;
  }

  /// 注册默认的 handler
  registerDefaultJMLinkHandler() {
    // 监听默认的 mLink handler 回调
    jmlink.addDefaultHandlerListener((Map jsonMap) {
      print("监听到默认短链的 mLink handler 回调，回调参数为：${jsonMap.toString()}");
      setState(() {
        _defaultMlinkMapString = jsonMap.toString();
      });
      getJMLinkParam();
    });
    // 注册默认的 handler
    jmlink.registerJMLinkDefaultHandler();
  }

  /// 获取无码邀请返回参数
  getJMLinkParam() {
    jmlink.getJMLinkParam().then((param) {
      print("获取到无码邀请参数为： ${param.toString()}");
      setState(() {
        _paramString = param.toString();
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: <Widget>[
            new Text("默认的 mLink handler 回调:"),
            new Container(
              margin: EdgeInsets.all(5),
              color: Colors.brown,
              child: Text(_defaultMlinkMapString),
              width: double.infinity,
              height: 80,
            ),
            new Text(" mLink handler 回调:"),
            new Container(
              margin: EdgeInsets.all(5),
              color: Colors.brown,
              child: Text(_milinkMapString),
              width: double.infinity,
              height: 80,
            ),
            new Text("无码邀请返回参数:"),
            new Container(
              margin: EdgeInsets.all(5),
              color: Colors.brown,
              child: Text(_paramString),
              width: double.infinity,
              height: 80,
            ),
          ],
        ),
      ),
    );
  }
}