Flutter社交分享插件cobi_flutter_share的使用

Flutter社交分享插件cobi_flutter_share的使用

本插件使Android的分享功能在Flutter中可用。以下是该插件的使用说明。

特性

• 通用分享
• 特定分享目标

使用方法

要使用此插件，你需要在AndroidManifest.xml文件中添加以下配置到主活动中：

<activity
    android:name=".MainActivity"
    android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.SEND" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:mimeType="*/*" />
    </intent-filter>
    <intent-filter>
        <action android:name="android.intent.action.SEND_MULTIPLE" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:mimeType="*/*" />
    </intent-filter>
</activity>

分享目标

对于特定的分享目标（例如特定联系人），你需要在资源文件夹中创建一个XML文件，例如：

<?xml version="1.0" encoding="utf-8"?>
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
    <share-target android:targetClass="com.example.MainActivity">
        <data android:mimeType="text/plain" />
        <category android:name="com.example.CATEGORY_ONE" />
    </share-target>
</shortcuts>

然后在AndroidManifest.xml文件中引用该XML文件：

<meta-data
    android:name="android.app.shortcuts"
    android:resource="@xml/shortcuts" />

更多关于如何编写这些快捷方式XML文件的信息，请参阅Android文档。

完整示例代码

以下是一个完整的示例代码，展示了如何使用cobi_flutter_share插件来处理分享接收事件，并添加和移除分享目标。

import 'package:cobi_flutter_share/cobi_flutter_share.dart';
import "package:flutter/material.dart";
import 'package:flutter/services.dart';

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/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](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  ShareData? _data;
  ShareItem? _currentFetch;

  _MyHomePageState() {
    CobiFlutterShare.instance.onShareReceived.listen((event) async {
      setState(() {
        _data = event;
      });
      for (ShareItem item in event.items) {
        print("receiving item: ${item.basename}, type: ${item.type}, mimeType: ${item.mimeType}, basename: ${item.basename}, absoluteFilename: ${item.absoluteFilename}");
        DateTime start = DateTime.now();
        print("Start: $start");
        setState(() {
          _currentFetch = item;
        });
        item.getContents()?.listen((chunk) {
          print("${item.basename}: received chunk ${chunk.index}");
        },
        onDone: () {
          DateTime end = DateTime.now();
          Duration diff = end.difference(start);
          print("End: $end");
          print("It took $diff");
          setState(() {
            _currentFetch = null;
          });
        },);
      }
    });
  }

  void _addShareTargets() async {
    var data = await rootBundle.load('assets/24.bmp');
    var buffer = data.buffer;
    await CobiFlutterShare.instance.addShareTarget(
      ShareTarget(
        id: "hello",
        categories: ["de.cobinja.CATEGORY_ONE"],
        longLabel: "Hello!",
        shortLabel: "Hello",
        imageBytes: buffer.asUint8List()
      )
    );
    await CobiFlutterShare.instance.addShareTarget(
      ShareTarget(
        id: "world",
        categories: ["de.cobinja.CATEGORY_ONE"],
        longLabel: "World!",
        shortLabel: "World",
        imageBytes: buffer.asUint8List()
      )
    );
  }

  void _addMultipleShareTargets() async {
    var data = await rootBundle.load('assets/24.bmp');
    var buffer = data.buffer;
    var targets = [
      ShareTarget(
        id: "foo",
        categories: ["de.cobinja.CATEGORY_ONE"],
        longLabel: "Foo!",
        shortLabel: "Foo",
        imageBytes: buffer.asUint8List()
      ),
      ShareTarget(
        id: "bar",
        categories: ["de.cobinja.CATEGORY_ONE"],
        longLabel: "Bar!",
        shortLabel: "Bar",
        imageBytes: buffer.asUint8List()
      )
    ];
    await CobiFlutterShare.instance.addShareTargets(targets);
  }

  void _removeSingleShareTarget() async {
    await CobiFlutterShare.instance.removeShareTarget("hello");
    setState(() {
      _data = null;
    });
  }

  void _removeMultipleShareTargets() async {
    await CobiFlutterShare.instance.removeShareTargets(["foo", "bar"]);
    setState(() {
      _data = null;
    });
  }

  void _removeAllShareTargets() async {
    await CobiFlutterShare.instance.removeAllShareTargets();
    setState(() {
      _data = null;
    });
  }

  void _pauseCurrentFetch() {
    _currentFetch?.pauseFetch();
  }

  void _continueCurrentFetch() {
    _currentFetch?.continueFetch();
  }

  void _abortCurrentFetch() {
    _currentFetch?.abortFetch();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: _addShareTargets,
              child: Text("发布分享目标\n'hello' 和 'world'\n分两步", textAlign: TextAlign.center)
            ),
            Divider(),
            ElevatedButton(
              onPressed: _addMultipleShareTargets,
                child: Text("发布分享目标\n'foo' 和 'bar'\n一步完成", textAlign: TextAlign.center)
            ),
            Divider(),
            ElevatedButton(
              onPressed: _removeSingleShareTarget,
              child: Text("移除分享目标 'hello'")
            ),
            Divider(),
            ElevatedButton(
              onPressed: _removeMultipleShareTargets,
              child: Text("移除分享目标 'foo' 和 'bar'")
            ),
            Divider(),
            ElevatedButton(
              onPressed: _removeAllShareTargets,
              child: Text("移除所有分享目标")
            ),
            Divider(),
            ElevatedButton(
              onPressed: _currentFetch != null ? _pauseCurrentFetch : null,
              child: Text("暂停当前获取")
            ),
            ElevatedButton(
              onPressed: _currentFetch != null ? _continueCurrentFetch : null,
              child: Text("继续当前获取")
            ),
            ElevatedButton(
              onPressed: _currentFetch != null ? _abortCurrentFetch : null,
              child: Text("终止当前获取")
            ),
            Divider(),
            Divider(),
            Text("数据:"),
            Text(_data?.toJson().toString() ?? "未接收到数据"),
          ],
        ),
      ),
    );
  }
}