SDWebImage源碼解讀 之 SDWebImageCompat

第三篇

前言

本篇主要解讀SDWebImage的配置文件。正如compat的定義，該配置文件主要是兼容Apple的其他設備。也許我們真實的開發平台只有一個，但考慮各個平台的兼容性，對於框架有着很重要的意義。這篇文章的重點是抽取出對於iOS很重要的用法，能夠在項目開發中提高效率。

#import <TargetConditionals.h>

導入這個頭文件，我們就能訪問系統提供的配置選項了，我們接下來會對該文件出現的配置屬性做出解釋。

_OBJC_GC_

#ifdef __OBJC_GC__
    #error SDWebImage does not support Objective-C Garbage Collection
#endif

SDWebImage不支持垃圾回收機制，垃圾回收(Gargage-collection)是Objective-c提供的一種自動內存回收機制。在iPad/iPhone環境中不支持垃圾回收功能。
當啟動這個功能后，所有的retain,autorelease,release和dealloc方法都將被系統忽略。

SD_MAC

// Apple's defines from TargetConditionals.h are a bit weird.
// Seems like TARGET_OS_MAC is always defined (on all platforms).
// To determine if we are running on OSX, we can only relly on TARGET_OS_IPHONE=0 and all the other platforms
#if !TARGET_OS_IPHONE && !TARGET_OS_IOS && !TARGET_OS_TV && !TARGET_OS_WATCH
    #define SD_MAC 1
#else
    #define SD_MAC 0
#endif

該指令主要用於判斷當前平台是不是MAC，單純使用TARGET_OS_MAC是不靠譜的。這樣判斷的缺點是，當Apple出現新的平台時，判斷條件要修改。

• TARGET_OS_IPHONE
• TARGET_OS_IOS
• TARGET_OS_TV
• TARGET_OS_WATCH

SD_UIKIT

// iOS and tvOS are very similar, UIKit exists on both platforms
// Note: watchOS also has UIKit, but it's very limited
#if TARGET_OS_IOS || TARGET_OS_TV
    #define SD_UIKIT 1
#else
    #define SD_UIKIT 0
#endif

iOS 和 tvOS 是非常相似的，UIKit在這兩個平台中都存在，但是watchOS在使用UIKit時，是受限的。因此我們定義SD_UIKIT為真的條件是iOS 和 tvOS這兩個平台。至於為什么要定義SD_UIKIT后邊會解釋的。

SD_IOS

#if TARGET_OS_IOS
    #define SD_IOS 1
#else
    #define SD_IOS 0
#endif

SD_TV

#if TARGET_OS_TV
    #define SD_TV 1
#else
    #define SD_TV 0
#endif

SD_WATCH

#if TARGET_OS_WATCH
    #define SD_WATCH 1
#else
    #define SD_WATCH 0
#endif

平台兼容適配

#if SD_MAC
    #import <AppKit/AppKit.h>
    #ifndef UIImage
        #define UIImage NSImage
    #endif
    #ifndef UIImageView
        #define UIImageView NSImageView
    #endif
    #ifndef UIView
        #define UIView NSView
    #endif
#else
    #if __IPHONE_OS_VERSION_MIN_REQUIRED != 20000 && __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_5_0
        #error SDWebImage doesn't support Deployment Target version < 5.0
    #endif

    #if SD_UIKIT
        #import <UIKit/UIKit.h>
    #endif
    #if SD_WATCH
        #import <WatchKit/WatchKit.h>
    #endif
#endif

觀察上邊的代碼，可以發現，在MAC平台上進行了如下的轉換，這算是一個編程技巧：

• UIImage -----> NSImage
• UIImageView -----> NSImageView
• UIView -----> NSView

SDWebImage不支持5.0以下的iOS版本。SD_UIKIT為真時，導入UIKit，SD_WATCH為真時，導入WatchKit。

基礎設置

#ifndef NS_ENUM
#define NS_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
#endif

#ifndef NS_OPTIONS
#define NS_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
#endif

#if OS_OBJECT_USE_OBJC
    #undef SDDispatchQueueRelease
    #undef SDDispatchQueueSetterSementics
    #define SDDispatchQueueRelease(q)
    #define SDDispatchQueueSetterSementics strong
#else
    #undef SDDispatchQueueRelease
    #undef SDDispatchQueueSetterSementics
    #define SDDispatchQueueRelease(q) (dispatch_release(q))
    #define SDDispatchQueueSetterSementics assign
#endif

接口

extern UIImage *SDScaledImageForKey(NSString *key, UIImage *image);

typedef void(^SDWebImageNoParamsBlock)();

extern NSString *const SDWebImageErrorDomain;

static int64_t kAsyncTestTimeout = 5;

dispatch_main_async_safe

我們來看看這個宏，按理說我使用dispatch_main_async就可以了，為什么要加入safe呢？那么這個safe主要是解決那些不安全的問題呢？

#ifndef dispatch_main_async_safe
#define dispatch_main_async_safe(block)\
    if (strcmp(dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL), dispatch_queue_get_label(dispatch_get_main_queue())) == 0) {\
        block();\
    } else {\
        dispatch_async(dispatch_get_main_queue(), block);\
    }
#endif

• 第一，我們可以像這樣在定義宏的時候使用換行，但需要添加 \ 操作符
• 第二，如果當前線程已經是主線程了，那么在調用dispatch_async(dispatch_get_main_queue(), block)有可能會出現crash
• 第三，如果當前線程是主線程，直接調用，如果不是，調用dispatch_async(dispatch_get_main_queue(), block)

UIImage *SDScaledImageForKey(NSString *key, UIImage *image)

inline UIImage *SDScaledImageForKey(NSString * _Nullable key, UIImage * _Nullable image) {
    if (!image) {
        return nil;
    }
    
#if SD_MAC
    return image;
#elif SD_UIKIT || SD_WATCH
    if ((image.images).count > 0) {
        NSMutableArray<UIImage *> *scaledImages = [NSMutableArray array];

        for (UIImage *tempImage in image.images) {
            [scaledImages addObject:SDScaledImageForKey(key, tempImage)];
        }

        return [UIImage animatedImageWithImages:scaledImages duration:image.duration];
    }
    else {
#if SD_WATCH
        if ([[WKInterfaceDevice currentDevice] respondsToSelector:@selector(screenScale)]) {
#elif SD_UIKIT
        if ([[UIScreen mainScreen] respondsToSelector:@selector(scale)]) {
#endif
            CGFloat scale = 1;
            if (key.length >= 8) {
                NSRange range = [key rangeOfString:@"@2x."];
                if (range.location != NSNotFound) {
                    scale = 2.0;
                }
                
                range = [key rangeOfString:@"@3x."];
                if (range.location != NSNotFound) {
                    scale = 3.0;
                }
            }

            UIImage *scaledImage = [[UIImage alloc] initWithCGImage:image.CGImage scale:scale orientation:image.imageOrientation];
            image = scaledImage;
        }
        return image;
    }
#endif
}

這個方法是根據key來修改圖片的尺寸，需要注意的地方有：

• inline 內聯函數
• 遞歸函數

總結

通過對該配置文件的理解，讓我對配置相關的信息更加了解了，我產生了收集這些預編譯的想法，生成一個內容比較豐富的文件，能夠很好地讓別人拿過去用。代碼應該寫的簡潔，穩定。

1. SDWebImage源碼解讀 之 NSData+ImageContentType 簡書 博客園
2. SDWebImage源碼解讀 之 UIImage+GIF 簡書 博客園