hadss_knock_share #

介绍 #

为 Flutter 提供“碰一碰”分享能力，当前支持手机与手机之间的碰一碰分享。该库封装了鸿蒙原生能力，开发者可通过简洁接口在Flutter中实现原生的碰一碰分享功能。

提供鸿蒙碰一碰分享能力flutter插件库，目前库提供的api能力如下：

1. 碰一碰分享能力的检测
2. 设置碰一碰分享数据
3. 开启碰一碰能力
4. 关闭碰一碰能力

API #

KnockShare #

碰一碰分享

SharedData #

表示分享数据对象，提供封装一组数据记录的方法。

SharedRecord属性 #

用于构造一条分享数据记录。包含数据类型、数据内容及描述等信息。

工程目录 #

knock_share
├─lib/src                                       // flutter代码实现
└─ohos/src/main/ets/components/plugin           // harmony代码实现

安装和使用 #

在生成的项目中添加hadss_knock_share库的依赖，在pubspec.yaml文件中的依赖项中添加

dependencies:  
  hadss_knock_share:
    path: ../  

然后执行以下命令，用于更新package依赖

flutter pub get

在项目目录中通过以下命令编译hap包

flutter build hap --release

命令执行完成后会生成hap包，并显示hap包路径

在hap的文件夹中如下命令使用hdc来安装应用

hdc install .\entry-default-signed.hap

示例代码 #

void main() {
  runApp(const MaterialApp(
    home: MyApp(),
  ));
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

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

class _MyAppState extends State<MyApp> {
  bool canUseKnockShareState = false;
  bool isOpenShare = false;
  final knockSharePlugin = KnockShare();

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

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: SizedBox(
          width: double.infinity,
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              const Padding(padding: EdgeInsets.only(top: 20)),
              Text(canUseKnockShareState ? "该设备支持碰一碰" : "请检测设备是否支持碰一碰"),
              const Padding(padding: EdgeInsets.only(top: 20)),
              TextButton(
                onPressed: () async {
                  bool canUseKnockShare = false;
                  canUseKnockShare =
                      await knockSharePlugin.canUseKnockShare() ?? false;
                  setState(() {
                    canUseKnockShareState = canUseKnockShare;
                  });
                },
                style: const ButtonStyle(
                  backgroundColor: MaterialStatePropertyAll(Colors.blue),
                ),
                child: const Text(
                  "canUseKnockShare",
                  style: TextStyle(color: Colors.white),
                ),
              ),
              const Padding(padding: EdgeInsets.only(top: 20)),
              Text(
                isOpenShare ? "监听中" : "未监听",
                style: const TextStyle(fontSize: 20),
              ),
              const Padding(padding: EdgeInsets.only(top: 20)),
              const Text("纯图片"),
              Row(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  TextButton(
                    onPressed: () {
                      if (isOpenShare) {
                        showAlert(context);
                      } else {
                        var shareBean = SharedRecord(UniformDataType.jpeg);
                        shareBean.thumbnailUri =
                            ShareConstants.exampleKnockUrl3;
                        shareBean.uri = ShareConstants.exampleKnockUrl3;
                        addKnockShareListener(shareBean);
                      }
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.addKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                  const Padding(padding: EdgeInsets.all(5)),
                  TextButton(
                    onPressed: () {
                      removeKnockShareListener();
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.removeKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                ],
              ),
              const Padding(padding: EdgeInsetsDirectional.only(top: 20)),
              const Text("沉浸式卡片"),
              Row(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  TextButton(
                    onPressed: () {
                      if (isOpenShare) {
                        showAlert(context);
                      } else {
                        var shareBean = SharedRecord(UniformDataType.hyperlink);
                        shareBean.content = ShareConstants.hyperlinkUrl;
                        shareBean.thumbnailUri =
                            ShareConstants.exampleKnockUrl1;
                        shareBean.description = ShareConstants.description;
                        shareBean.title = "我看到了中国唯一没有的地貌，峡湾地貌";
                        addKnockShareListener(shareBean);
                      }
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.addKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                  const Padding(padding: EdgeInsets.all(5)),
                  TextButton(
                    onPressed: () {
                      removeKnockShareListener();
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.removeKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                ],
              ),
              const Padding(padding: EdgeInsetsDirectional.only(top: 20)),
              const Text("白卡上下布局"),
              Row(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  TextButton(
                    onPressed: () {
                      if (isOpenShare) {
                        showAlert(context);
                      } else {
                        var shareBean = SharedRecord(UniformDataType.hyperlink);
                        shareBean.content = ShareConstants.hyperlinkUrl;
                        shareBean.thumbnailUri =
                            ShareConstants.exampleKnockUrl2;
                        shareBean.description = ShareConstants.description;
                        shareBean.title = "海岸风光·天气晴朗";
                        addKnockShareListener(shareBean);
                      }
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.addKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                  const Padding(padding: EdgeInsets.all(5)),
                  TextButton(
                    onPressed: () {
                      removeKnockShareListener();
                    },
                    style: const ButtonStyle(
                      backgroundColor: MaterialStatePropertyAll(Colors.blue),
                    ),
                    child: const Text(
                      ShareConstants.removeKnockShareListener,
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                ],
              ),
            ],
          ),
        ),
      ),
    );
  }

  void addKnockShareListener(SharedRecord shareBean) {
    knockSharePlugin.setKnockShareData(SharedData(shareBean),
        isAutoClean: true);
    knockSharePlugin.onKnockShare();
    setState(() {
      isOpenShare = true;
    });
  }

  void removeKnockShareListener() {
    knockSharePlugin.offKnockShare();
    setState(() {
      isOpenShare = false;
    });
  }

  void showAlert(BuildContext context) {
    var alert = AlertDialog(
      title: const Text("提示"),
      content: const Text("请先停止当前监听再开启新监听"),
      actions: [
        TextButton(
            onPressed: () {
              Navigator.of(context).pop();
            },
            child: const Text("OK"))
      ],
    );

    showDialog(
        context: context,
        builder: (BuildContext context) {
          return alert;
        }).then((value) => {removeKnockShareListener()});
  }
}

约束与限制 #

本示例仅支持标准系统上运行，支持设备：Phone

地区限制：仅支持中国境内（不包含中国香港、中国澳门、中国台湾）提供服务。

DevEco Studio版本：DevEco Studio 5.0.0 Release及以上。

OpenHarmony SDK: >= API 12.

flutter sdk 版本要求：>= 3.7.12

使用过程中发现任何问题都可以提 Issue。

同时，也非常欢迎您提交 PR。

开源协议 #

本项目基于Apache License 2.0，请自由地享受和参与开源。