Android图片加载利器之Picasso源码解析

Picasso.with(this).load(imageUrl).into(imageView);

 public static Picasso with(Context context) {  if (singleton == null) {   synchronized (Picasso.class) {    if (singleton == null) {     singleton = new Builder(context).build();    }   }  }  return singleton; }

 public static class Builder {  private final Context context;  private Downloader downloader;  private ExecutorService service;  private Cache cache;  private Listener listener;  private RequestTransformer transformer;  private List<RequestHandler> requestHandlers;  private Bitmap.Config defaultBitmapConfig;  private boolean indicatorsEnabled;  private boolean loggingEnabled;  /**    * 根据context获取Application的context   * 此方式主要是为了避免context和单例模式的生命周期不同而造成内存泄漏的问题    */  public Builder(Context context) {   ...   this.context = context.getApplicationContext();  }   /** 设置图片的像素格式，默认为ARGB_8888 */  public Builder defaultBitmapConfig(Bitmap.Config bitmapConfig) {   ...   this.defaultBitmapConfig = bitmapConfig;   return this;  }  /** 自定义下载器，默认OkHttp，具体的实现类是OkHttpDownloader */  public Builder downloader(Downloader downloader) {   ...   this.downloader = downloader;   return this;  }  /** 自定义线程池，默认的实现是PicassoExecutorService */  public Builder executor(ExecutorService executorService) {   ...   this.service = executorService;   return this;  }  /** 自定义缓存策略，默认实现为LruCache */  public Builder memoryCache(Cache memoryCache) {   ...   this.cache = memoryCache;   return this;  }  /** 图片加载失败的一个回调事件 */  public Builder listener(Listener listener) {   ...   this.listener = listener;   return this;  }  /** 请求的转换，在request被提交之前进行转换 */  public Builder requestTransformer(RequestTransformer transformer) {   ...   this.transformer = transformer;   return this;  }  /** 自定义加载图片的来源 */  public Builder addRequestHandler(RequestHandler requestHandler) {   ...   requestHandlers.add(requestHandler);   return this;  }  //省略调试相关方法  /** Create the {@link Picasso} instance. */  public Picasso build() {   Context context = this.context;   if (downloader == null) {    downloader = Utils.createDefaultDownloader(context);   }   if (cache == null) {    cache = new LruCache(context);   }   if (service == null) {    service = new PicassoExecutorService();   }   if (transformer == null) {    transformer = RequestTransformer.IDENTITY;   }   Stats stats = new Stats(cache);   //得到一个事件的调度器对象，非常重要，后面会讲解到   Dispatcher dispatcher = new Dispatcher(context, service, HANDLER, downloader, cache, stats);   // 返回Picasso的对象   return new Picasso(context, dispatcher, cache, listener, transformer, requestHandlers, stats,     defaultBitmapConfig, indicatorsEnabled, loggingEnabled);  } }

 public RequestCreator load(Uri uri) {  return new RequestCreator(this, uri, 0); }

 RequestCreator(Picasso picasso, Uri uri, int resourceId) {  this.picasso = picasso;  this.data = new Request.Builder(uri, resourceId, picasso.defaultBitmapConfig); }

 public void into(ImageView target, Callback callback) {  long started = System.nanoTime();  // 只能在主线程中调用  checkMain();  // hasImage()的判断逻辑是设置了uri或者resourceId返回true  // 如果都未设置则判断是否设置了placeholder，也就是默认显示的图片  if (!data.hasImage()) {   picasso.cancelRequest(target);   if (setPlaceholder) {    setPlaceholder(target, getPlaceholderDrawable());   }   return;  }  // 当设置了fit()时deferred值为true，也就是完全填充  if (deferred) {   int width = target.getWidth();   int height = target.getHeight();   if (width == 0 || height == 0) {    if (setPlaceholder) {     setPlaceholder(target, getPlaceholderDrawable());    }    picasso.defer(target, new DeferredRequestCreator(this, target, callback));    return;   }   // 根据target也就是ImageView的大小下载图片   data.resize(width, height);  }  // 见下方详解1  Request request = createRequest(started);  // 这个方法的作用就是根据上面的到的Request对象里面绑定的一些参数来生成一个字符串作为key值，  // 逻辑比较清晰，主要包括stableKey（这个是用户自定义的key值，在第二篇文章中有介绍）、uri、旋转角度、大小、填充方式。  String requestKey = createKey(request);  // 根据用户的设置是否从缓存里取图片信息  if (shouldReadFromMemoryCache(memoryPolicy)) {   // 在LruCache中使用LinkedHashMap<String, Bitmap>来保存图片信息，key就是上面生成的requestKey   // 在LruCache的get方法中返回Bitmap对象，并记录命中或者未命中。   Bitmap bitmap = picasso.quickMemoryCacheCheck(requestKey);   if (bitmap != null) {    picasso.cancelRequest(target);    setBitmap(target, picasso.context, bitmap, MEMORY, noFade, picasso.indicatorsEnabled);    // 这个callback是异步加载图片的一个回调，之前忘记介绍了，看来需要再补充一篇文章来介绍异步和同步请求    if (callback != null) {     callback.onSuccess();    }    return;   }  }  // 如果有设置了默认显示的图片，则先将其显示出来  if (setPlaceholder) {   setPlaceholder(target, getPlaceholderDrawable());  }  // 又出来一个ImageViewAction，可以看到里面传递了前面准备好的全部数据，那么这个对象又是做什么的呢？  // 在ImageViewAction代码中提供了三个方法complete、error、cancel，所以可以猜想这个是用作处理最后的下载结果的  // 如果成功了就将其显示出来，如果失败则显示用户通过error方法设置的图片  Action action =    new ImageViewAction(picasso, target, request, memoryPolicy, networkPolicy, errorResId,      errorDrawable, requestKey, tag, callback, noFade);  // 这里又回到了Picasso类中，见下方详解2  picasso.enqueueAndSubmit(action); }

 private Request createRequest(long started) {  // 返回nextId的值并将其+1，有一个与之对应的方法是incrementAndGet，这个表示先+1再返回  int id = nextId.getAndIncrement();  // 这里面构造了一个Request对象，它是一个实体类用来存放我们请求图片的一些参数  // 包括地址，大小，填充方式，旋转参数，优先级等等  Request request = data.build();  request.id = id;  request.started = started;  // 判断是否有进行request转化，在上一篇文章中介绍了转换的方法  Request transformed = picasso.transformRequest(request);  if (transformed != request) {   transformed.id = id;   transformed.started = started;  }  return transformed; }

dispatcher.dispatchSubmit(action);

 void performSubmit(Action action, boolean dismissFailed) {  // 首先根据tag判断是否已经下发了暂停下载的命令,pausedTags是WeakHashMap类型的集合  if (pausedTags.contains(action.getTag())) {   pausedActions.put(action.getTarget(), action);   return;  }  // hunterMap是LinkedHashMap<String, BitmapHunter>()类型的对象，用来保存还未执行的下载请求  BitmapHunter hunter = hunterMap.get(action.getKey());  if (hunter != null) {   // 如果新的请求的key值在LinkedHashMap中存在，则合并两次请求，并重新处理优先级   hunter.attach(action);   return;  }  // 这个方法主要用来判断该请求采用哪一种requestHandler，Picasso提供了7种，我们也可以自定义  hunter = forRequest(action.getPicasso(), this, cache, stats, action);  // 将hunter添加到线程池中，hunter是Runnable的一个实现  hunter.future = service.submit(hunter);  hunterMap.put(action.getKey(), hunter);  if (dismissFailed) {   failedActions.remove(action.getTarget());  } }

// 这里只保留了关键的代码，调用了hunt方法，得到了result对象，然后再通过dispatcher进行分发 public void run() {  result = hunt();  if (result == null) {    dispatcher.dispatchFailed(this);  } else {    dispatcher.dispatchComplete(this);  } }

 Bitmap hunt() throws IOException {  Bitmap bitmap = null;  // 再次检查内存缓存，和之前的逻辑一样  if (shouldReadFromMemoryCache(memoryPolicy)) {   bitmap = cache.get(key);   if (bitmap != null) {    stats.dispatchCacheHit();    loadedFrom = MEMORY;    return bitmap;   }  }  // networkPolicy这个值怎么计算的呢？我们先看retryCount是如何得到的  // 在构造方法中this.retryCount = requestHandler.getRetryCount();  // 那么来看getRetryCount()方法得到的值是否为0，代码中一共有七个类重载了RequestHandler  // 在RequestHandler类中默认返回0，而只有NetworkRequestHandler重写了getRetryCount()方法，返回2  // 因此就是说当不是从网络请求图片时data.networkPolicy = NetworkPolicy.OFFLINE.index  data.networkPolicy = retryCount == 0 ? NetworkPolicy.OFFLINE.index : networkPolicy;  // 七个类重载了RequestHandler并且都实现了自己的load方法  // 这里面我们只看网络相关的NetworkRequestHandler，其余的感兴趣的童鞋可以自己看下代码  // 我们先看下下面的关于 NetworkRequestHandler中load方法的代码，再回来继续分析  RequestHandler.Result result = requestHandler.load(data, networkPolicy);  if (result != null) {   loadedFrom = result.getLoadedFrom();   exifRotation = result.getExifOrientation();   // 解析bitmap   bitmap = result.getBitmap();   if (bitmap == null) {    InputStream is = result.getStream();    try {     bitmap = decodeStream(is, data);    } finally {     Utils.closeQuietly(is);    }   }  }  // 这一段主要是看用户是否设置图片的转换处理  if (bitmap != null) {   stats.dispatchBitmapDecoded(bitmap);   if (data.needsTransformation() || exifRotation != 0) {    synchronized (DECODE_LOCK) {     if (data.needsMatrixTransform() || exifRotation != 0) {      bitmap = transformResult(data, bitmap, exifRotation);、     }     if (data.hasCustomTransformations()) {      bitmap = applyCustomTransformations(data.transformations, bitmap);     }    }    if (bitmap != null) {     stats.dispatchBitmapTransformed(bitmap);    }   }  }  return bitmap; }

/**  * OkHttpDownloader中的load方法，返回了Result对象 */ public Result load(Request request, int networkPolicy) throws IOException {  // 这里面如果我们自己没有自定义下载器，则执行的是OkHttpDownloader中的load方法，继续深入到load方法中一探究竟，代码在下方了，这里面得到的response是OkHttp给我们返回来的  Response response = downloader.load(request.uri, request.networkPolicy);  // 得到加载位置是SdCard还是网络  Picasso.LoadedFrom loadedFrom = response.cached ? DISK : NETWORK;  // 下面分别获取了Bitmap和InputStream，同时返回了Result对象，我们返回到上面继续分析  Bitmap bitmap = response.getBitmap();  if (bitmap != null) {   return new Result(bitmap, loadedFrom);  }  InputStream is = response.getInputStream();  if (loadedFrom == NETWORK && response.getContentLength() > 0) {   stats.dispatchDownloadFinished(response.getContentLength());  }  return new Result(is, loadedFrom); }

/**  * 这个方法中主要使用了CacheControl来承载缓存策略，同时将Request对象传入了OkHttp中 * 看到这里Picasso源码已经走到了尽头，如果想继续分析，只能查看OkHttp的代码了，目前我还没有通读过， * 所以我们将得到的结果向上继续看了,以后有时间我也会更新一些关于OkHttp的源码解析。 * BUT 我们目前只看到了判断内存中是否有缓存，SDCard的缓存还没有判断呢？ * 没错，关于SdCard的读取和写入都是有OkHttp来完成的，当然了我们也可以自定义下载器， * 在这里就能看出来Picasso和OkHttp果然是亲戚啊！连SdCard的缓存都帮忙实现了。 */public Response load(Uri uri, int networkPolicy) throws IOException {  CacheControl cacheControl = null;  if (networkPolicy != 0) {   if (NetworkPolicy.isOfflineOnly(networkPolicy)) {    cacheControl = CacheControl.FORCE_CACHE;   } else {    CacheControl.Builder builder = new CacheControl.Builder();    if (!NetworkPolicy.shouldReadFromDiskCache(networkPolicy)) {     builder.noCache();    }    if (!NetworkPolicy.shouldWriteToDiskCache(networkPolicy)) {     builder.noStore();    }    cacheControl = builder.build();   }  }  Request.Builder builder = new Request.Builder().url(uri.toString());  if (cacheControl != null) {   builder.cacheControl(cacheControl);  }  com.squareup.okhttp.Response response = client.newCall(builder.build()).execute();  int responseCode = response.code();  if (responseCode >= 300) {   response.body().close();   throw new ResponseException(responseCode + " " + response.message(), networkPolicy,     responseCode);  }  boolean fromCache = response.cacheResponse() != null;  ResponseBody responseBody = response.body();  return new Response(responseBody.byteStream(), fromCache, responseBody.contentLength()); }

 void performComplete(BitmapHunter hunter) {  // 判断用户是否设置了写缓存，默认是需要写入内存的  if (shouldWriteToMemoryCache(hunter.getMemoryPolicy())) {   cache.set(hunter.getKey(), hunter.getResult());  }  // hunterMap我们在前面介绍过了，用来保存还未执行的下载请求，因此下载完成之后将其remove到  hunterMap.remove(hunter.getKey());  // 接着看batch的实现  batch(hunter); }

 private void batch(BitmapHunter hunter) {  // 将BitmapHunter对象加入到了batch变量中，batch是一个ArrayList类型的集合  batch.add(hunter);  // 到这里并没有直接将图片显示出来，而是填加到list中，发送了一个延迟消息，延迟200ms  // 其实这是一个批处理，让本次事件尽快结束，不影响界面的其他操作  // 下面我们跟进handler的HUNTER_DELAY_NEXT_BATCH语句中  if (!handler.hasMessages(HUNTER_DELAY_NEXT_BATCH)) {   handler.sendEmptyMessageDelayed(HUNTER_DELAY_NEXT_BATCH, BATCH_DELAY);  } }

 void performBatchComplete() {  List<BitmapHunter> copy = new ArrayList<BitmapHunter>(batch);  batch.clear();  // 将batch里的数据复制了一份，又通过mainThreadHandler发送了一个HUNTER_BATCH_COMPLETE的消息  // mainThreadHandler是怎么来的呢？原来是在Dispatcher的构造方法中传进来的，那么我们就要回头找找什么时候创建的Dispatcher对象  // 原来是在Picasso的Builder类build的时候创建的，而Handler也就是在Picasso类中定义，代码如下  mainThreadHandler.sendMessage(mainThreadHandler.obtainMessage(HUNTER_BATCH_COMPLETE, copy));  logBatch(copy); }

 static final Handler HANDLER = new Handler(Looper.getMainLooper()) {  @Override   public void handleMessage(Message msg) {   switch (msg.what) {    case HUNTER_BATCH_COMPLETE: {     @SuppressWarnings("unchecked")      List<BitmapHunter> batch = (List<BitmapHunter>) msg.obj;     //noinspection ForLoopReplaceableByForEach     for (int i = 0, n = batch.size(); i < n; i++) {      BitmapHunter hunter = batch.get(i);      hunter.picasso.complete(hunter);     }     break;    }   }  } };

 void complete(BitmapHunter hunter) {  Action single = hunter.getAction();  List<Action> joined = hunter.getActions();  boolean hasMultiple = joined != null && !joined.isEmpty();  boolean shouldDeliver = single != null || hasMultiple;  if (!shouldDeliver) {   return;  }  Uri uri = hunter.getData().uri;  Exception exception = hunter.getException();  Bitmap result = hunter.getResult();  LoadedFrom from = hunter.getLoadedFrom();  // 这里面来说一下single和joined，还记不记得前面分析到Dispatcher类中的performSubmit方法时  // 判断了hunterMap中如果有相同的key值则执行hunter.attach(action);  // 因此single得到的action是hunterMap中没有相同的key值时的action  // 而当hunterMap中存在未处理的key与新的请求的key值相同时则将action添加到了BitmapHunter类的actions对象中  // 因此joined保存的就是与single中具有相同key值的数据，所以要分别处理  if (single != null) {   deliverAction(result, from, single);  }  if (hasMultiple) {   //noinspection ForLoopReplaceableByForEach   for (int i = 0, n = joined.size(); i < n; i++) {    Action join = joined.get(i);    deliverAction(result, from, join);   }  }  if (listener != null && exception != null) {   listener.onImageLoadFailed(this, uri, exception);  } }

 private void deliverAction(Bitmap result, LoadedFrom from, Action action) {  ...  // 关键代码就这一句  action.complete(result, from);  ... }

 @Override  public void complete(Bitmap result, Picasso.LoadedFrom from) {  ImageView target = this.target.get();  Context context = picasso.context;  boolean indicatorsEnabled = picasso.indicatorsEnabled;  // 关键代码，进入PicassoDrawable的setBitmap方法中一探究竟  PicassoDrawable.setBitmap(target, context, result, from, noFade, indicatorsEnabled);  if (callback != null) {   callback.onSuccess();  } }

 static void setBitmap(ImageView target, Context context, Bitmap bitmap,   Picasso.LoadedFrom loadedFrom, boolean noFade, boolean debugging) {  Drawable placeholder = target.getDrawable();  if (placeholder instanceof AnimationDrawable) {   ((AnimationDrawable) placeholder).stop();  }  // 这里面主要是对显示效果进行处理，最终得到了一个PicassoDrawable对象，继承了BitmapDrawable  PicassoDrawable drawable =    new PicassoDrawable(context, bitmap, placeholder, loadedFrom, noFade, debugging);  // 至此图片终于终于显示出来了～～～～～～  target.setImageDrawable(drawable); }