flutter开发实战-Completer实现将回调Callback转换成Future返回结果

flutter开发实战-Completer实现将回调Callback转换成Future返回结果

一、Future

Dart是单线程模型语言，如果需要执行一些延迟的操作或者IO操作，默认采用单线程同步的方式就有可能会造成主isolate阻塞，从而导致渲染卡顿。基于这一点我们需要实现单线程的异步方式，基于Dart内置的非阻塞API实现，那么其中「Future就是异步中非常重要的角色。Future表示异步返回的结果，当执行一个异步延迟的计算时候，首先会返回一个Future结果，后续代码可以继续执行不会阻塞主isolate，当Future中的计算结果到达时，如果注册了 then 函数回调，对于返回成功的回调就会拿到最终计算的值，对于返回失败的回调就会拿到一个异常信息」。

这部分参考https://zhuanlan.zhihu.com/p/353578352

当然这里并不是介绍Future，我们下面使用Completer实现将回调Callback转换成Future返回结果

二、Completer

Completer是一种生成Future对象并稍后返回一个value或者error来完成他们的方法。
大多数情况下，创建一个Future最简单的方式，就是使用Future构造方法，来捕获单个异步计算。

例如

Future doStuff(){
   return someAsyncOperation().then((result) {
     return someOtherAsyncOperation(result);
   });
}
    
1
2
3
4
5
6

但是，当你需要将基于回调的API转换为基于Future的API时，这时候就需要使用Completer

例如

 class AsyncOperation {
   final Completer _completer = new Completer();

   Future doOperation() {
     _startOperation();
     return _completer.future; // Send future object back to client.
   }

   // Something calls this when the value is ready.
   void _finishOperation(T result) {
     _completer.complete(result);
   }

   // If something goes wrong, call this.
   void _errorHappened(error) {
     _completer.completeError(error);
   }
 }
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

三、Completer实现Callback转换Future

在上面中的AsyncOperation，可以使用Completer来将回调的API转换成Future的API，下面列出一个具体的实例。

代码中有一个获取用户签名的Api，通过封装的Callback来获得具体的userSign，在需要使用的方法中需要返回一个Future。

这里就用到了Completer

具体代码如下

// userSign过期获取接口
class UserSignFetcherImpl implements UserSignFetcher {
  @override
  Future getUserSign(String userId) {
    // TODO: implement getUserSign

    Completer completer = Completer();
    UserSignReq req = UserSignReq();
    req.userId = userId;

    ApiRepository.getUserSign(DFaceApiConstant.kGetByUserId, req: req)
        .then((value) {
      print("getUserSign value:${value}");
      completer.complete(value);
    }).whenComplete(() {
      print("whenComplete");
    }).catchError((e) {
      print("catchError e:${e}");
      completer.completeError(e);
    });

    return completer.future;
  }
}
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

这里就可以将接口Callback的结果，通过completer.complete与completer.completeError将结果转换为基于Future的返回的方法了。

四、小结

flutter开发实战-Completer实现将回调Callback转换成Future返回结果

学习记录，每天不停进步。