Flutter摇动手势识别插件shake_gesture的使用

shake_gesture 是一个用于检测 Android 和 iOS 上摇动手势的 Flutter 插件。该插件没有任何依赖项，并且可以在模拟器上正常工作。

使用方法

声明式（Imperatively）

void main() {
  void myCallback() {}

  // 注册回调函数
  ShakeGesture.registerCallback(onShake: myCallback);

  // 在dispose函数中，不要忘记清理
  ShakeGesture.unregisterCallback(onShake: myCallback);
}

组件（Widget）

在Flutter应用中，可以通过 ShakeGesture 组件来监听摇动手势。下面是一个完整的示例代码：

import 'package:flutter/material.dart';
import 'package:shake_gesture/shake_gesture.dart';
import 'package:shake_gesture_test_helper/shake_gesture_test_helper.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(home: HomePage());
  }
}

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('ShakeGesture Example')),
      body: Center(
        child: ShakeGesture(
          onShake: () {
            ScaffoldMessenger.of(context).showSnackBar(
              const SnackBar(content: Text('Shake!')),
            );
          },
          child: const Center(
            child: OutlinedButton(
              onPressed: ShakeGestureTestHelperExtension.simulateShake,
              child: Text('Simulate Shake'),
            ),
          ),
        ),
      ),
    );
  }
}

在这个例子中，当用户摇动设备时，会弹出一个Snackbar提示“Shake!”。此外，还有一个按钮可以模拟摇动事件，方便在没有物理设备的情况下进行测试。

模拟器支持

这个包可以在iOS模拟器中正常工作。对于Android模拟器，你可以通过以下两种方式之一来模拟摇动事件：

1. 使用传感器管理器：调整模拟器中的传感器设置。
2. 修改Activity代码：添加如下代码到你的Activity中，然后使用快捷键（如Ctrl+M或Cmd+M）来模拟摇动。

import android.view.KeyEvent
import dev.fluttercommunity.shake_gesture_android.ShakeGesturePlugin

class MainActivity: FlutterActivity() {

    override fun onKeyDown(keyCode: Int, event: KeyEvent?): Boolean {
        if (keyCode == KeyEvent.KEYCODE_MENU) {
            this.flutterEngine?.plugins?.get(ShakeGesturePlugin::class.java).let { plugin ->
                if (plugin is ShakeGesturePlugin)
                    plugin.onShake()
            }
        }

        return super.onKeyDown(keyCode, event)
    }

}

测试助手

为了在测试中模拟摇动手势，可以添加 shake_gesture_test_helper 包，并调用 widgetTester.shake() 方法：

testWidgets('it detects shakes', (widgetTester) async {
  var shakeDetected = false;
  await widgetTester.pumpWidget(
    ShakeGesture(
      onShake: () {
        shakeDetected = true;
      },
      child: Container(),
    ),
  );
  await widgetTester.shake();
  expect(shakeDetected, true);
});

自定义摇动手势

• iOS: 目前无法自定义iOS上的摇动手势，因为它依赖于Apple SDK中的 motionShake。
• Android: 可以通过在 AndroidManifest.xml 文件中添加元数据来自定义所需的摇动强度和次数。例如：

<manifest ...>
    <application ...>
        <meta-data
            android:name="dev.fluttercommunity.shake_gesture_android.SHAKE_FORCE"
            android:value="4" />
        <meta-data
            android:name="dev.fluttercommunity.shake_gesture_android.MIN_NUM_SHAKES"
            android:value="3" />
    </application>
</manifest>

默认情况下，摇动强度为6牛顿，最少需要6次摇动。

贡献

如果你想要为这个项目做出贡献，请运行单元测试和集成测试以确保一切正常：

cd shake_gesture/example
flutter test
flutter test integration_test

希望这些信息能够帮助你更好地理解和使用 shake_gesture 插件！如果有任何问题，欢迎随时提问。