mirrors
/
SDWebImage
mirror of https://github.com/SDWebImage/SDWebImage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Feature: Introduce SDWebImageContextImageDecodeOptions, deprecate SDImageCoderWebImageContext 

This can solve the retain cycle from the scratch, instead of hacking
This commit is contained in:
DreamPiggy 2022-10-29 19:09:08 +08:00
parent b014808ddd
commit 2f3652dc2e
4 changed files with 28 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
SDWebImage/Core/SDImageCacheDefine.m
View File

@ -13,37 +13,6 @@
#import "UIImage+Metadata.h"
#import "SDInternalMacros.h"
static NSArray<NSString *>* GetKnownContextOptions(void) {
static NSArray<NSString *> *knownContextOptions;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
knownContextOptions =
[NSArray arrayWithObjects:
SDWebImageContextSetImageOperationKey,
SDWebImageContextCustomManager,
SDWebImageContextImageCache,
SDWebImageContextImageLoader,
SDWebImageContextImageCoder,
SDWebImageContextImageTransformer,
SDWebImageContextImageScaleFactor,
SDWebImageContextImagePreserveAspectRatio,
SDWebImageContextImageThumbnailPixelSize,
SDWebImageContextQueryCacheType,
SDWebImageContextStoreCacheType,
SDWebImageContextOriginalQueryCacheType,
SDWebImageContextOriginalStoreCacheType,
SDWebImageContextOriginalImageCache,
SDWebImageContextAnimatedImageClass,
SDWebImageContextDownloadRequestModifier,
SDWebImageContextDownloadResponseModifier,
SDWebImageContextDownloadDecryptor,
SDWebImageContextCacheKeyFilter,
SDWebImageContextCacheSerializer
, nil];
});
return knownContextOptions;
}
SDImageCoderOptions * _Nonnull SDGetDecodeOptionsFromContext(SDWebImageContext * _Nullable context, SDWebImageOptions options, NSString * _Nonnull cacheKey) {
BOOL decodeFirstFrame = SD_OPTIONS_CONTAINS(options, SDWebImageDecodeFirstFrameOnly);
NSNumber *scaleValue = context[SDWebImageContextImageScaleFactor];
@ -62,20 +31,23 @@ SDImageCoderOptions * _Nonnull SDGetDecodeOptionsFromContext(SDWebImageContext *
NSString *typeIdentifierHint = context[SDWebImageContextImageTypeIdentifierHint];
NSString *fileExtensionHint = cacheKey.pathExtension; // without dot
SDImageCoderMutableOptions *mutableCoderOptions = [NSMutableDictionary dictionaryWithCapacity:6];
// First check if user provided decode options
SDImageCoderMutableOptions *mutableCoderOptions;
if (context[SDWebImageContextImageDecodeOptions] != nil) {
mutableCoderOptions = [NSMutableDictionary dictionaryWithDictionary:context[SDWebImageContextImageDecodeOptions]];
} else {
mutableCoderOptions = [NSMutableDictionary dictionaryWithCapacity:6];
}
// Override individual options
mutableCoderOptions[SDImageCoderDecodeFirstFrameOnly] = @(decodeFirstFrame);
mutableCoderOptions[SDImageCoderDecodeScaleFactor] = @(scale);
mutableCoderOptions[SDImageCoderDecodePreserveAspectRatio] = preserveAspectRatioValue;
mutableCoderOptions[SDImageCoderDecodeThumbnailPixelSize] = thumbnailSizeValue;
mutableCoderOptions[SDImageCoderDecodeTypeIdentifierHint] = typeIdentifierHint;
mutableCoderOptions[SDImageCoderDecodeFileExtensionHint] = fileExtensionHint;
// Hack to remove all known context options before SDWebImage 5.14.0
SDImageCoderMutableOptions *mutableContext = [NSMutableDictionary dictionaryWithDictionary:context];
[mutableContext removeObjectsForKeys:GetKnownContextOptions()];
mutableCoderOptions[SDImageCoderWebImageContext] = [mutableContext copy];
SDImageCoderOptions *coderOptions = [mutableCoderOptions copy];
return coderOptions;
return [mutableCoderOptions copy];
}
UIImage * _Nullable SDImageCacheDecodeImageData(NSData * _Nonnull imageData, NSString * _Nonnull cacheKey, SDWebImageOptions options, SDWebImageContext * _Nullable context) {

4
SDWebImage/Core/SDImageCoder.h
View File

@ -109,9 +109,9 @@ FOUNDATION_EXPORT SDImageCoderOption _Nonnull const SDImageCoderEncodeEmbedThumb
But this may be useful for some custom coders, because some business logic may dependent on things other than image or image data information only.
Only the unknown context from top-level API (See SDWebImageDefine.h) may be passed in during image loading.
See `SDWebImageContext` for more detailed information.
@warning This option will be removed in 5.14.0
@warning Deprecated. This does nothing from 5.14.0. Use `SDWebImageContextImageDecodeOptions` to pass additional information in top-level API, and use `SDImageCoderOptions` to retrieve options from coder.
*/
FOUNDATION_EXPORT SDImageCoderOption _Nonnull const SDImageCoderWebImageContext API_DEPRECATED("The coder component will be seperated from Core subspec in the future. Update your code to not rely on this context option.", macos(10.10, API_TO_BE_DEPRECATED), ios(8.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED));
FOUNDATION_EXPORT SDImageCoderOption _Nonnull const SDImageCoderWebImageContext API_DEPRECATED("No longer supported. Use SDWebImageContextDecodeOptions in loader API to provide options. Use SDImageCoderOptions in coder API to retrieve options.", macos(10.10, 10.10), ios(8.0, 8.0), tvos(9.0, 9.0), watchos(2.0, 2.0));
#pragma mark - Coder
/**

16
SDWebImage/Core/SDWebImageDefine.h
View File

@ -207,7 +207,7 @@ typedef NS_OPTIONS(NSUInteger, SDWebImageOptions) {
};
#pragma mark - Context Options
#pragma mark - Manager Context Options
/**
A String to be used as the operation key for view category to store the image load operation. This is used for view instance which supports different image loading process. If nil, will use the class name as operation key. (NSString *)
@ -244,6 +244,16 @@ FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextImageC
*/
FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextImageTransformer;
#pragma mark - Image Decoder Context Options
/**
A Dictionary (SDImageCoderOptions) value, which pass the extra decoding options to the SDImageCoder. Introduced in SDWebImage 5.14.0
You can pass additional decoding related options to the decoder, extensible and control by you. And pay attention this dictionary may be retained by decoded image via `UIImage.sd_decodeOptions`
This context option replace the deprecated `SDImageCoderWebImageContext`, which may cause retain cycle (cache -> image -> options -> context -> cache)
@note There are already individual options below like `.imageScaleFactor`, `.imagePreserveAspectRatio`, each of individual options will override the same filed for this dictionary.
*/
FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextImageDecodeOptions;
/**
A CGFloat raw value which specify the image scale factor. The number should be greater than or equal to 1.0. If not provide or the number is invalid, we will use the cache key to specify the scale factor. (NSNumber)
*/
@ -271,6 +281,8 @@ FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextImageT
*/
FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextImageTypeIdentifierHint;
#pragma mark - Cache Context Options
/**
A SDImageCacheType raw value which specify the source of cache to query. Specify `SDImageCacheTypeDisk` to query from disk cache only; `SDImageCacheTypeMemory` to query from memory only. And `SDImageCacheTypeAll` to query from both memory cache and disk cache. Specify `SDImageCacheTypeNone` is invalid and totally ignore the cache query.
If not provide or the value is invalid, we will use `SDImageCacheTypeAll`. (NSNumber)
@ -309,6 +321,8 @@ FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextOrigin
*/
FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextAnimatedImageClass;
#pragma mark - Download Context Options
/**
A id<SDWebImageDownloaderRequestModifier> instance to modify the image download request. It's used for downloader to modify the original request from URL and options. If you provide one, it will ignore the `requestModifier` in downloader and use provided one instead. (id<SDWebImageDownloaderRequestModifier>)
*/

1
SDWebImage/Core/SDWebImageDefine.m
View File

@ -131,6 +131,7 @@ SDWebImageContextOption const SDWebImageContextImageCache = @"imageCache";
SDWebImageContextOption const SDWebImageContextImageLoader = @"imageLoader";
SDWebImageContextOption const SDWebImageContextImageCoder = @"imageCoder";
SDWebImageContextOption const SDWebImageContextImageTransformer = @"imageTransformer";
SDWebImageContextOption const SDWebImageContextImageDecodeOptions = @"imageDecodeOptions";
SDWebImageContextOption const SDWebImageContextImageScaleFactor = @"imageScaleFactor";
SDWebImageContextOption const SDWebImageContextImagePreserveAspectRatio = @"imagePreserveAspectRatio";
SDWebImageContextOption const SDWebImageContextImageThumbnailPixelSize = @"imageThumbnailPixelSize";