Flutter如何正确对FutureBuilder内部组件进行单元测试

问题根因 #

CameraController.initialize()返回的Future始终处于pending状态，原因是Flutter单元测试环境默认不会加载相机插件的原生端实现，真实的初始化逻辑不会执行，因此Future永远不会完成，pumpAndSettle会因持续等待帧稳定触发超时，snapshot.connectionState也会一直停留在waiting状态。

解决方案 #

提供两种可落地的方案，优先推荐第一种，可维护性更高。

方案一：依赖注入Mock实例（推荐） #

步骤1：调整业务代码支持测试

将CameraController的实例创建逻辑从组件内部抽离，支持外部传入，方便测试时替换为模拟实现：

class CameraScreen extends StatefulWidget {
  final CameraDescription camera;
  // 新增可选参数，测试时传入Mock实例，生产环境留空用内部创建的实例
  final CameraController? controller;
  const CameraScreen({super.key, required this.camera, this.controller});

  @override
  State<CameraScreen> createState() => _CameraScreenState();
}

class _CameraScreenState extends State<CameraScreen> {
  late Future<void> _initializeControllerFuture;
  late CameraController _controller;

  @override
  void initState() {
    super.initState();
    // 优先用外部传入的controller，没有再自己创建
    _controller = widget.controller ?? CameraController(
      widget.camera,
      ResolutionPreset.medium,
    );
    _initializeControllerFuture = _controller.initialize();
  }
  // 其余原有业务逻辑保持不变
}

步骤2：创建模拟CameraController

借助mockito工具创建Mock类，让初始化方法返回立即完成的Future：

import 'package:mockito/mockito.dart';
import 'package:camera/camera.dart';

class MockCameraController extends Mock implements CameraController {
  @override
  Future<void> initialize() async {
    // 直接返回已完成的Future，模拟初始化成功
    return Future.value();
  }
}

步骤3：编写测试用例

测试时传入模拟的控制器实例，直接验证逻辑：

testWidgets('Camera preview is available',
    (WidgetTester tester) async {
  // 创建Mock实例
  final mockController = MockCameraController();
  // 构建测试页面
  await tester.pumpWidget(MaterialApp(
    home: CameraScreen(
      camera: CameraDescription(
        name: 'test',
        lensDirection: CameraLensDirection.back,
        sensorOrientation: 0,
      ),
      controller: mockController,
    ),
  ));
  // 等待Future完成后的帧更新
  await tester.pump();

  expect(find.byType(CameraPreview), findsOneWidget,
      reason: 'Camera preview should be visible.');
});

方案二：拦截原生方法调用（无需改业务代码） #

如果不想调整现有业务代码，可以直接在测试中拦截相机插件的方法调用，模拟初始化成功的返回结果：

testWidgets('Camera preview is available',
    (WidgetTester tester) async {
  // 注册相机插件的Mock方法处理
  TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
      .setMockMethodCallHandler(const MethodChannel('plugins.flutter.io/camera'),
      (MethodCall methodCall) async {
    if (methodCall.method == 'initialize') {
      return null; // 模拟初始化成功
    }
    if (methodCall.method == 'availableCameras') {
      // 返回测试用的相机列表
      return [
        {
          'name': 'test',
          'lensFacing': 'back',
          'sensorOrientation': 0,
        }
      ];
    }
    return null;
  });

  await _buildCameraScreenPage(tester);
  await tester.pump();

  expect(find.byType(CameraPreview), findsOneWidget,
      reason: 'Camera preview should be visible.');
});

注意：此方案需要匹配你使用的camera插件版本，不同版本的通道名、方法名和返回结构可能存在差异，需要对应调整。

内容的提问来源于stack exchange，提问作者Daniel