[Android] Preloader 预加载框架

简介

Preloader是一个用于异步加载数据的工具。它提供同步或者异步的获取结果回调。 适当地使用可让业务层获取数据的时间点提前。

使用例子

以简单activity跳转的例子为例，从MainActivity跳转到SubActivity。其中SubActivity的完整 显示需要发起一次请求，获取到结果后显示在中央的textView。 利用Preloader，我们可以在MainActivity发起跳转的时候开始请求，在SubActivity需要的时候将结果取出。 这样子可以把获取结果的时间点提前，起到加速显示SubActivity的作用。 代码如下所示：

• MainActivity：

  PreloadTask task = new PreloadTask() {
  
      @Override
      public void run(Preloader.Result result) throws Exception {
          try {
              // 模拟5秒的同步请求
              Thread.sleep(5*1000);
              // 设置请求结果
              result.set("hello world");
          } catch (InterruptedException e) {
              throw e;
          }
      }
  
      @Override
      public void onCancel() {
          Log.d(TAG, "onCancel() called");
      }
  };
  
  // 启动task，获取taskId。
  int taskId = Preloader.start(task);
  // 传递taskId，用于获取结果。
  Intent intent = new Intent(this, SubActivity.class);
  intent.putExtra("preload_task_id", taskId);
  startActivity(intent);
  

• SubActivity：

  mTextView = findViewById(R.id.textView);
  
  // get result
  int preloadTaskId = getIntent().getIntExtra("preload_task_id", -1);
  if (preloadTaskId > 0) {
      // 使用taskId取出Result对象
      Preloader.Result preloadResult = Preloader.getResult(preloadTaskId);
      if (preloadResult != null) {
          // 同步获取结果
          try {
              // 取出结果，设置超时时间，单位毫秒
              String content = preloadResult.get(1000);
              mTextView.setText(content);
          } catch (PreloadException e) {
              mTextView.setText("e=" + e.getMessage());
          }
          // 异步获取结果
          preloadResult.get(new Preloader.ResultListener() {
              @Override
              public void onResult(String result, PreloadException e) {
                  if (e == null) {
                      mTextView.setText(result);
                  } else {
                      mTextView.setText("e=" + e.getMessage());
                  }
              }
          });
      }
      // 取消预加载任务，所有正在等待的get方法都会返回timeout exception
      // Preloader.cancel(preloadTaskId);
      // Preloader.cancelAll();
  }
  

注意事项

• 可通过PreloadTask.setGetResultTimeout设置异步获取结果的超时时间，默认为30秒。
• 如果PreloadTask.isClearWhenGetResult()==false，那么需要使用者自己调用Preloader.clear方法来释放预加载task， 否则预加载task将在第一次成功获取结果后被释放（无法再次通过Preloader.getResult取结果）
• 对于同一个preloadResult对象，可多次调用get()，互不影响。

源码

https://github.com/legendmohe/Preloader

查看原文： http://legendmohe.net/2018/04/03/android-preloader-%e9%a2%84%e5%8a%a0%e8%bd%bd%e6%a1%86%e6%9e%b6/