Added option to specify custom cache key to ImageRequest and ImageRequestBuilder

Differential Revision: D91033614

fbshipit-source-id: b3e7e2ac2ca9750069e4d730e051df2bdfbd7810

Author: oprisnik

imagepipeline/src/main/java/com/facebook/imagepipeline/cache/DefaultCacheKeyFactory.java

@@ -32,9 +32,13 @@ public static synchronized DefaultCacheKeyFactory getInstance() {
 
   @Override
   public CacheKey getBitmapCacheKey(ImageRequest request, @Nullable Object callerContext) {
+    String sourceString = request.getCustomCacheKey();
+    if (sourceString == null) {
+      sourceString = getCacheKeySourceUri(request.getSourceUri()).toString();
+    }
     BitmapMemoryCacheKey cacheKey =
         new BitmapMemoryCacheKey(
-            getCacheKeySourceUri(request.getSourceUri()).toString(),
+            sourceString,
             request.getResizeOptions(),
             request.getRotationOptions(),
             request.getImageDecodeOptions(),
@@ -56,9 +60,13 @@ public CacheKey getPostprocessedBitmapCacheKey(
       postprocessorCacheKey = null;
       postprocessorName = null;
     }
+    String sourceString = request.getCustomCacheKey();
+    if (sourceString == null) {
+      sourceString = getCacheKeySourceUri(request.getSourceUri()).toString();
+    }
     BitmapMemoryCacheKey cacheKey =
         new BitmapMemoryCacheKey(
-            getCacheKeySourceUri(request.getSourceUri()).toString(),
+            sourceString,
             request.getResizeOptions(),
             request.getRotationOptions(),
             request.getImageDecodeOptions(),
@@ -75,6 +83,10 @@ public CacheKey getEncodedCacheKey(ImageRequest request, @Nullable Object caller
   @Override
   public CacheKey getEncodedCacheKey(
       ImageRequest request, Uri sourceUri, @Nullable Object callerContext) {
+    String customCacheKey = request.getCustomCacheKey();
+    if (customCacheKey != null) {
+      return new SimpleCacheKey(customCacheKey);
+    }
     return new SimpleCacheKey(getCacheKeySourceUri(sourceUri).toString());
   }
 

imagepipeline/src/main/java/com/facebook/imagepipeline/request/ImageRequest.java

@@ -132,6 +132,8 @@ public class ImageRequest {
 
   private final @Nullable String mDiskCacheId;
 
+  private final @Nullable String mCustomCacheKey;
+
   private final int mDelayMs;
 
   /** Whether to extract first frame thumbnail from video. */
@@ -196,6 +198,8 @@ protected ImageRequest(ImageRequestBuilder builder) {
 
     mDiskCacheId = builder.getDiskCacheId();
 
+    mCustomCacheKey = builder.getCustomCacheKey();
+
     mIsFirstFrameThumbnailEnabled = builder.getIsFirstFrameThumbnailEnabled();
   }
 
@@ -325,6 +329,10 @@ public synchronized File getSourceFile() {
     return mDiskCacheId;
   }
 
+  public @Nullable String getCustomCacheKey() {
+    return mCustomCacheKey;
+  }
+
   public Boolean isFirstFrameThumbnailEnabled() {
     return mIsFirstFrameThumbnailEnabled;
   }
@@ -348,6 +356,7 @@ public boolean equals(@Nullable Object o) {
     if (!Objects.equal(mSourceUri, request.mSourceUri)
         || !Objects.equal(mCacheChoice, request.mCacheChoice)
         || !Objects.equal(mDiskCacheId, request.mDiskCacheId)
+        || !Objects.equal(mCustomCacheKey, request.mCustomCacheKey)
         || !Objects.equal(mSourceFile, request.mSourceFile)
         || !Objects.equal(mBytesRange, request.mBytesRange)
         || !Objects.equal(mImageDecodeOptions, request.mImageDecodeOptions)
@@ -397,6 +406,7 @@ public int hashCode() {
       result = HashCode.extend(result, postprocessorCacheKey);
       result = HashCode.extend(result, mResizingAllowedOverride);
       result = HashCode.extend(result, mDownsampleOverride);
+      result = HashCode.extend(result, mCustomCacheKey);
       result = HashCode.extend(result, mDelayMs);
       result = HashCode.extend(result, mLoadThumbnailOnly);
       result = HashCode.extend(result, mIsFirstFrameThumbnailEnabled);
@@ -429,6 +439,7 @@ public String toString() {
         .add("isDiskCacheEnabled", mIsDiskCacheEnabled)
         .add("isMemoryCacheEnabled", mIsMemoryCacheEnabled)
         .add("decodePrefetches", mDecodePrefetches)
+        .add("customCacheKey", mCustomCacheKey)
         .add("delayMs", mDelayMs)
         .add("isFirstFrameThumbnailEnabled", mIsFirstFrameThumbnailEnabled)
         .toString();

imagepipeline/src/main/java/com/facebook/imagepipeline/request/ImageRequestBuilder.java

@@ -53,6 +53,7 @@ public class ImageRequestBuilder {
   private @Nullable DownsampleMode mDownsampleOverride = null;
   private int mDelayMs;
   private @Nullable String mDiskCacheId = null;
+  private @Nullable String mCustomCacheKey = null;
   private Boolean mIsFirstFrameThumbnailEnabled = false;
 
   /**
@@ -110,6 +111,7 @@ public static ImageRequestBuilder fromRequest(ImageRequest imageRequest) {
         .setShouldDecodePrefetches(imageRequest.shouldDecodePrefetches())
         .setDelayMs(imageRequest.getDelayMs())
         .setDiskCacheId(imageRequest.getDiskCacheId())
+        .setCustomCacheKey(imageRequest.getCustomCacheKey())
         .setDownsampleOverride(imageRequest.getDownsampleOverride())
         .setResizingAllowedOverride(imageRequest.getResizingAllowedOverride())
         .setIsFirstFrameThumbnailEnabled(imageRequest.isFirstFrameThumbnailEnabled())
@@ -454,6 +456,25 @@ public ImageRequestBuilder setDiskCacheId(@Nullable String diskCacheId) {
     return mDiskCacheId;
   }
 
+  /**
+   * Sets a custom cache key for this request. When set, this key will be used instead of deriving
+   * the cache key from the source URI.
+   *
+   * @param customCacheKey a custom cache key to use for caching this image.
+   * @return the modified builder instance
+   */
+  public ImageRequestBuilder setCustomCacheKey(@Nullable String customCacheKey) {
+    this.mCustomCacheKey = customCacheKey;
+    return this;
+  }
+
+  /**
+   * @return the custom cache key to use for caching this image.
+   */
+  public @Nullable String getCustomCacheKey() {
+    return mCustomCacheKey;
+  }
+
   /**
    * Builds the Request.
    *