SDWebImageとは何か、主な概念とUIImageView

SDWebImageとは？

SDWebImageはAppleプラットフォーム（iOS、macOS、tvOS、watchOS）での非同期画像読み込みのためのライブラリです。UIImageViewのためのsd_setImageメソッドを提供し、コード一行でどのようなソースからでも画像を読み込み、キャッシュし、表示します。

このライブラリはプログレッシブロード（バイトを受信するにつれて画像が表示される）、アニメーション画像（GIF、APNG）、変換（丸み、クロップ、ウォーターマーク）、カスタムデコーダーをサポートしています。GitHub統計によると、SDWebImageは25,000以上のスターを持ち、Twitter、Pinterest、Instagramなどの主要アプリで使用されています。

アーキテクチャはコンポーネントチェーンで構築されています：Coder（デコーディング）、Cache（ストレージ）、Loader（ネットワーク）、Transformer（処理）。各コンポーネントは置き換え可能で、ライブラリをプロジェクトの特定の要件に適応させることができます。

SDWebImageの仕組み：マネージャーとキャッシュ

SDWebImageManagerは読み込みプロセスを統括する中心コンポーネントです。URLを受け取り、キャッシュを確認し、データを読み込み、UIImageにデコードし、ImageViewまたはCompletion Handlerに渡します。マネージャーは共有シングルトンを通じて動作し、アプリケーションのどこからでもアクセスできます。

読み込みプロセス

マネージャーはメモリキャッシュ（UIImageを持つNSDictionary）、ついでディスクキャッシュ（ファイルシステム）を順番に確認します。ミスした場合は、NSURLSessionを通じてネットワークリクエストが行われます。読み込み後、データはデコードされ、変換を経て、両方のキャッシュに保存されます。すべてのプロセスはバックグラウンドキューで実行され、結果はメインキューに届けられます。

• メモリキャッシュ — O(1)の参照、設定可能なメモリ制限でUIImageを保存
• ディスクキャッシュ — ファイルシステムから読み込み、圧縮データを保存
• NSURLSession — HTTP/2サポートと設定可能なタイムアウトで読み込み

UIImageViewカテゴリ

UIImageView+WebCacheはObjective-Cのカテゴリ（Swiftからアクセス可能）で、sd_setImageメソッドを追加します。このメソッドはURL、placeholder、オプション（SDWebImageOptions）、コンプリーションブロックを受け取ります。このカテゴリはsd_cancelCurrentImageLoadメカニズムを通じて、テーブルセルが再利用されたときに前回のリクエストを自動的にキャンセルします。

SDWebImageの主なクラス

SDWebImageのアーキテクチャは明確な責任範囲を持つ複数のモジュールに分かれています。各クラスは読み込みから表示までの1つの任務を解決します。

SDWebImageManager

SDWebImageManagerはすべての画像操作のファザードです。ImageCache（SDImageCache）およびImageLoader（SDWebImageDownloader）への参照を保持しています。SDWebImageManagerDelegateを通じて、読み込みを拦戮してURLや動作を変更できます。

SDImageCache

SDImageCacheは２レベルキャッシュ（メモリ + ディスク）で、固有のネームスペースで初期化されます。メモリキャッシュは設定可能な制限付きでUIImageを保存します（デフォルトではシステムメモリ警告まで）。ディスクキャッシュはLibrary/Cachesディレクトリに、設定可能な保存期間（デフォルト７日）でデータを保存します。

SDWebImageDownloader

SDWebImageDownloaderはNSURLSessionベースのHTTPクライアントで、ヘッダー、タイムアウト、再試行をサポートしています。ダウンローダーは同じリクエストを１つのネットワークコールに重複解除し、結果をすべてのサブスクライバーに分配します。

SDWebImageのキャッシュアーキテクチャ

SDWebImageは決定的な確認順序で２レベルのキャッシュを実装しています：最初にメモリ、その後にディスクです。キャッシュキーは、クエリパラメータのない絶対画像URLか、そのMD5ハッシュです。

メモリ警告を受けると、iOSはUIApplicationDidReceiveMemoryWarningNotificationを通じてSDImageCacheに通知し、その後メモリキャッシュは完全にクリアされます。ディスクキャッシュはTTLまたは制限を超えた場合にクリアされ、ファイルは最終アクセス日の順に並べ替えられます。

手動キャッシュ管理には、次のメソッドが利用可能です：clearMemory、clearDisk、calculateSize。SDWebImageCacheMemoryOnlyまたはSDWebImageAvoidAutoSetImageオプションを使用して、特定のリクエストのキャッシュを無効にできます。

SwiftでのSDWebImage使用例

SDWebImageは画像を読み込むためのいくつかのインターフェースを提供しています：シンプルなUIImageViewカテゴリから、カスタム処理をサポートする高度なマネージャーまで。

UIImageViewでの基本的な読み込み

sd_setImageはUIImageViewに画像を読み込むための主なメソッドです。URL、placeholder、OptionsおよびContextを通じたオプショナルパラメーターを受け取ります。すべてのCompletion Handlerはメインスレッドで実行されます。

let imageView = UIImageView()
imageView.sd_setImage(
    with: URL(string: "https://example.com/photo.jpg"),
    placeholderImage: UIImage(named: "placeholder"),
    options: [.progressiveLoad, .retryFailed],
    context: [.imageThumbnailPixelSize : CGSize(width: 300, height: 300)]
)

このメソッドはSDWebImageToken（操作）を戻し、必要に応じてキャンセルできます。内部的に、sd_setImageはSDWebImageManager.loadを呼び出し、自動画像設定のためにImageViewをTargetとして渡します。

カスタム変換での読み込み

SDWebImageはTransformer—単一のtransformedImageメソッドを持つプロトコルをサポートしています。組み込みの変換には、円、丸く角、カラーフィルターオーバーレイ、サイズ変更があります。変換は&&演算子を使用して組み合わせることができます。

let transformer = SDImageResizingTransformer(
    size: CGSize(width: 200, height: 200),
    scaleMode: .aspectFill
)
let roundedTransformer = SDImageRoundCornerTransformer(
    radius: 16,
    corners: .allCorners,
    borderWidth: 0
)
imageView.sd_setImage(
    with: url,
    placeholderImage: placeholder,
    context: [.imageTransformer : transformer && roundedTransformer]
)

SwiftUIでの使用

このライブラリはWebImage—placeholder、進行状況インジケータ、エラー処理をサポートするSwiftUI用のビューコンポーネントを提供しています。このコンポーネントは自動的にビューのライフサイクルにサブスクライブし、消失時に読み込みをキャンセルします。

struct CachedImageView: View {
    let url: URL

    var body: some View {
        WebImage(url: url) { phase in
            if let image = phase.image {
                image.resizable()
            } else if phase.error {
                Color.red
            } else {
                ProgressView()
            }
        }
    }
}

SDWebImageでの画像変換

SDWebImageはSDImageTransformerプロトコルを通じて柔軟な変換システムを提供しています。変換はデコーディング後、キャッシュ前に適用されます—変換結果は新しいキーでディスクに保存され、後のリクエストでの再適用を防ぎます。

組み込みの変換には次のものがあります：SDImageResizingTransformer（mode付きサイズ変更）、SDImageRoundCornerTransformer（オプションの置きます

カスタム変換には、transformedImageWithImage:forKey:メソッドでSDImageTransformerプロトコルを実装すればそれで十分です。変換キーは自動的にキャッシュキーに追加され、同じ画像の異なるバージョン間の競合を防ぎます。

SDWebImageとKingfisherの比較

iOSプラットフォームにおけるSDWebImageの主な競合相手はKingfisher（純粋Swift）とNukeです。SDWebImageとKingfisherの選択は、プロジェクトの言語と必要な機能によって決まります。

SDWebImageはObjective-Cプロジェクトやハイブリッドプロジェクトで優先されます。KingfisherはタイプセーフティとネイティブなSwift構文により、純粋Swiftプロジェクトにより適しています。両ライブラリのキャッシュアーキテクチャとパフォーマンスは同様です。

iOSプロジェクトでのSDWebImage設定

SDWebImageはSwift Package Manager、CocoaPods、またはCarthageを通じて統合できます。ライブラリはモジュールに分けられています：コア（SDWebImage）、Coder（追加フォーマット）、MapKit（MKAnnotationView用）。

// Swiftパッケージマネージャ (Package.swift)
dependencies: [
    .package(
        url: "https://github.com/SDWebImage/SDWebImage.git",
        from: "5.19.0"
    )
]

// CocoaPods (Podfile)
pod 'SDWebImage', '~> 5.19.0'
// WebPやSVGのプラグイン:
pod 'SDWebImageWebPCoder'
pod 'SDWebImageSVGCoder'

インストール後、ライブラリは追加設定なしで使用できます。キャッシュをカスタマイズするには、固有のネームスペースを持つSDImageCacheのインスタンスを作成し、初期化時にSDWebImageManagerに渡します。グローバル設定はSDWebImageManager.sharedを通じて行います。

// キャッシュのカスタマイズ
let config = SDImageCacheConfig()
config.maxDiskAge = 14 * 86400 // 7日ではなく14日
config.maxDiskSize = 500 * 1024 * 1024 // 500 MB
config.shouldCacheImagesInMemory = .true

let cache = SDImageCache(
    namespace: "custom",
    diskCacheDirectory: FileManager.default.urls(
        for: .cachesDirectory,
        in: .userDomainMask
    ).first?.appendingPathComponent("custom_cache"),
    config: config
)
SDWebImageManager.sharedImageCache = cache