Flutter测试中SharedPreferences未初始化问题求助

问题根源 #

你的ThreadService大概率是直接在内部调用SharedPreferences.getInstance()，而测试环境中，即便你初始化了全局的prefs变量，服务本身也没有使用这个测试初始化的实例；或者是异步初始化时机不匹配——setUp的异步逻辑还没执行完，测试用例就已经开始运行了。

修复步骤 #

1. 给ThreadService添加依赖注入 #

修改ThreadService的构造函数，允许外部传入SharedPreferences实例，替代内部直接获取的逻辑：

class ThreadService {
  final SharedPreferences prefs;
  final String boardTag;
  final int threadId;

  // 构造函数接收prefs参数，方便测试时注入实例
  ThreadService({
    required this.boardTag,
    required this.threadId,
    required this.prefs,
  });

  Future<void> getRoots() async {
    // 使用类内的prefs实例操作，不再重新调用getInstance
    final cacheData = prefs.getString('thread_${threadId}_roots');
    // ...其他业务逻辑
  }
}

2. 调整测试代码，注入初始化完成的prefs #

确保测试用例中把初始化好的prefs实例传入ThreadService，同时去掉main函数的async修饰（测试框架会自动等待setUp的异步逻辑执行完毕）：

void main() {
  late SharedPreferences prefs;

  setUp(() async {
    WidgetsFlutterBinding.ensureInitialized();
    // 设置测试所需的mock初始值
    SharedPreferences.setMockInitialValues({
      'thread_1008826_roots': 'test_cache_data',
      // 其他需要的键值对
    });
    prefs = await SharedPreferences.getInstance();
  });

  test('测试getRoots方法', () async {
    // 传入测试用的prefs实例
    final threadService = ThreadService(
      boardTag: 'pr',
      threadId: 1008826,
      prefs: prefs,
    );

    await threadService.getRoots();
    // 添加断言验证逻辑，比如检查缓存是否被正确读取/修改
    expect(prefs.getString('thread_1008826_roots'), equals('test_cache_data'));
  });
}

3. 特殊场景处理 #

如果无法修改ThreadService的构造函数，可以用依赖注入容器（比如get_it）：

• 在测试前注册mock的SharedPreferences实例
• 让ThreadService从容器中获取实例，而非直接调用getInstance

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