Mac端Flutter单元测试报错：找不到getApplicationDocumentsDirectory实现

问题根源 #

单元测试默认运行在纯Dart虚拟机环境中，不会加载Flutter平台插件的原生实现，因此调用依赖平台通道的getApplicationDocumentsDirectory()会抛出该异常。结合你升级后出现故障的情况，以下是针对Mac端场景的可行解决方案：

方案1：手动Mock路径返回 #

无需额外依赖，直接在测试中模拟路径提供逻辑：

import 'dart:io';
import 'package:path_provider/path_provider.dart';
import 'package:test/test.dart';

// 手动替换全局方法，测试后恢复
void mockDocumentsDir(String mockPath) {
  final originalMethod = getApplicationDocumentsDirectory;
  getApplicationDocumentsDirectory = () async => Directory(mockPath);
  addTearDown(() => getApplicationDocumentsDirectory = originalMethod);
}

void main() {
  test('测试依赖文档目录的功能', () async {
    // 设置Mac端测试用的mock路径
    mockDocumentsDir('/Users/your-username/Documents/flutter-test');
    
    // 执行你的测试逻辑，此时调用getApplicationDocumentsDirectory会返回mock路径
    final dir = await getApplicationDocumentsDirectory();
    expect(dir.path, '/Users/your-username/Documents/flutter-test');
    // ... 其他测试断言
  });
}

方案2：用Mockito生成Mock对象 #

如果项目已使用Mockito，可生成PathProvider的Mock实例拦截调用：

import 'dart:io';
import 'package:mockito/mockito.dart';
import 'package:path_provider/path_provider.dart';
import 'package:test/test.dart';

class MockPathProvider extends Mock {
  Future<Directory> getApplicationDocumentsDirectory() => super.noSuchMethod(
        Invocation.method(#getApplicationDocumentsDirectory, []),
        returnValue: Future.value(Directory('/Users/your-username/Documents/test')),
      );
}

void main() {
  late MockPathProvider mockPathProvider;

  setUp(() {
    mockPathProvider = MockPathProvider();
    when(mockPathProvider.getApplicationDocumentsDirectory())
        .thenAnswer((_) async => Directory('/Users/your-username/Documents/test'));
  });

  test('测试依赖文档目录的功能', () async {
    final dir = await mockPathProvider.getApplicationDocumentsDirectory();
    expect(dir.path, '/Users/your-username/Documents/test');
    // ... 其他测试逻辑
  });
}

方案3：初始化Flutter绑定（需真实平台环境） #

若测试需要访问真实的Mac系统路径，可初始化Flutter绑定加载插件：

import 'package:flutter_test/flutter_test.dart';
import 'package:path_provider/path_provider.dart';

void main() {
  setUpAll(() {
    // 初始化Flutter绑定，确保平台插件被加载
    WidgetsFlutterBinding.ensureInitialized();
  });

  test('获取真实的应用文档目录', () async {
    final dir = await getApplicationDocumentsDirectory();
    expect(dir.exists(), completes);
    // ... 其他测试断言
  });
}

额外排查步骤 #

• 执行flutter pub get重新安装依赖，必要时删除.dart_tool目录后重试
• 尝试升级path_provider到最新稳定版（当前最新为^2.1.3），确保与Flutter 3.29.0兼容
• 检查测试配置文件，确认没有禁用Flutter插件加载的相关设置

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