Sketch Image Loader

Sketch is a powerful and comprehensive image load library on Android, in addition to the basic functions, it also supports Jetpack Compose, GIF, SVG, video thumbnails, gesture zoom, huge images sampling, ExifInterface and other functions.
Sketch 是 Android 上的一个强大且全面的图片加载库，除了基础功能外，还支持 Jetpack Compose、GIF、SVG、视频缩略图、手势缩放、超大图采样、ExifInterface 等功能。

Features/简介

Support http, asset, content, android.resource and other URIs
Support playing GIFs, WebP, HEIF and other animated image
Support gesture zoom and large image sampling
Supports download, conversion results, and memory L3 cache
Support for correcting image orientation via Exif
Supports Base64, video frames, SVG images
Support for Jetpack Compose
Supports automatic resizing of images according to the size of the view
Supports loading only pictures to memory or downloading only pictures to disk
Supports various useful features such as saving cellular data
Support the extension of URI, cache, decoding, conversion, display, placeholder and other links
Based on Kotlin and Kotlin coroutines

-----------------------

支持 http、asset、content、android.resource 等多种 URI
支持播放 gif、webp、heif 等动图
支持手势缩放及超大图采样
支持下载、转换结果、内存三级缓存
支持通过 Exif 纠正图片方向
支持 Base64、视频帧、SVG 图片
支持 Jetpack Compose
支持根据 view 大小自动调整图片尺寸
支持仅加载图片到内存或仅下载图片到磁盘
支持节省蜂窝流量等各种实用功能
支持对 URI、缓存、解码、转换、显示、占位图等各个环节的扩展
基于 Kotlin 及 Kotlin 协程编写

Import/导入

Published to mavenCentral · 已发布到 mavenCentral

dependencies {
    implementation("io.github.panpf.sketch3:sketch:${LAST_VERSION}")
}

${LAST_VERSION}: (Not included 'v' · 不包含 'v')

There are also optional modules to extend the functionality of sketch:
还有一些可选的模块用来扩展 sketch 的功能：

dependencies {
    // Support for Jetpack Compose
    // 支持 Jetpack Compose
    implementation("io.github.panpf.sketch3:sketch-compose:${LAST_VERSION}")

    // Supports useful features such as download progress mask, pause loading during list swipe, save cellular traffic, image type corner marker, load apk file and installed app icon
    // 支持下载进度蒙层、列表滑动中暂停加载、节省蜂窝流量、图片类型角标、加载 apk 文件和已安装 app 图标等实用功能
    implementation("io.github.panpf.sketch3:sketch-extensions:${LAST_VERSION}")

    // GifDrawable through Koral's android-gif-drawable library
    // 通过 koral 的 android-gif-drawable 库的 GifDrawable 实现 gif 播放
    implementation("io.github.panpf.sketch3:sketch-gif-koral:${LAST_VERSION}")

    // GIF playback is achieved through Android's built-in Movie class
    // 通过 Android 内置的 Movie 类实现 gif 播放
    implementation("io.github.panpf.sketch3:sketch-gif-movie:${LAST_VERSION}")

    // Support for OkHttp
    // 支持 OkHttp
    implementation("io.github.panpf.sketch3:sketch-okhttp:${LAST_VERSION}")

    // SVG images are supported
    // 支持 SVG 图片
    implementation("io.github.panpf.sketch3:sketch-svg:${LAST_VERSION}")

    // Video frames are read through Android's built-in MediaMetadataRetriever class
    // 通过 Android 内置的 MediaMetadataRetriever 类实现读取视频帧
    implementation("io.github.panpf.sketch3:sketch-video:${LAST_VERSION}")

    // Video frames are read through wseemann's FFmpegMediaMetadataRetriever library
    // 通过 wseemann 的 FFmpegMediaMetadataRetriever 库实现读取视频帧
    implementation("io.github.panpf.sketch3:sketch-video-ffmpeg:${LAST_VERSION}")

    // Supports gesture zoom and jumbo sampling
    // 支持手势缩放以及超大图采样
    implementation("io.github.panpf.sketch3:sketch-zoom:${LAST_VERSION}")
}

R8 / Proguard

Sketch doesn't need to configure any obfuscation rules itself, but you may need to add obfuscation configurations for indirectly dependent Kotlin Coroutines, OkHttp, Okio.
Sketch 自己不需要配置任何混淆规则，但你可能需要为间接依赖的 Kotlin Coroutines, OkHttp, Okio 添加混淆配置

Get started/快速上手

ImageView

Sketch provides a series of extended functions called displayImage for ImageView, which can easily display images
Sketch 为 ImageView 提供了一系列的名为 displayImage 的扩展函数，可以方便的显示图片

// http
imageView.displayImage("https://www.sample.com/image.jpg")

// File
imageView.displayImage("/sdcard/download/image.jpg")

// asset
imageView.displayImage("asset://image.jpg")

// There is a lot more...

You can also configure parameters through a trailing lambda function:
还可以通过尾随的 lambda 函数配置参数：

imageView.displayImage("https://www.sample.com/image.jpg") {
    placeholder(R.drawable.placeholder)
    error(R.drawable.error)
    transformations(CircleCropTransformation())
    crossfade()
    // There is a lot more...
}

Jetpack Compose

Need import sketch-compose module · 需要导入 sketch-compose 模块

AsyncImage(
  imageUri = "https://www.sample.com/image.jpg",
  modifier = Modifier.size(300.dp, 200.dp),
  contentScale = ContentScale.Crop,
  contentDescription = ""
)

// config params
AsyncImage(
  rqeuest = DisplayRequest(LocalContext.current, "https://www.sample.com/image.jpg") {
    placeholder(R.drawable.placeholder)
    error(R.drawable.error)
    transformations(BlurTransformation())
    crossfade()
    // There is a lot more...
  },
  modifier = Modifier.size(300.dp, 200.dp),
  contentScale = ContentScale.Crop,
  contentDescription = ""
)

Document/文档

Basic features/基础功能：

Featured features/特色功能：

Changelog/更新日志

Please review the CHANGELOG.md file
请查看 CHANGELOG.md 文件

About version 3.0/关于 3.0 版本

The maven groupId was changed to 'io.github.panpf.sketch3', so version 2.* will not prompt for an upgrade
The package name was changed to 'com.github.panpf.sketch' so it does not conflict with version 2.*
Based on the kotlin coroutine rewrite, APIs and functions are all refactored as a new library
There is no longer a requirement to use a SketchImageView, any ImageView and its subclasses will do, and any View can be supported in combination with a custom Target
The Zoom function is split into independent modules that can be relied on separately, and the large image sampling function is refactored and supports multi-threaded decoding, which is faster
The gif module now directly depends on the android-gif-drawable library, no longer modified twice, and can be upgraded by itself
Support for Jetpack Compose
Support for request and decode interceptors
Referring to coil v2.2.0 and combining with the original functionality of sketch, there are the following differences compared to coil:
- sketch supports a minimum of API 16, while coil supports only API 21
- Sketch supports bitmap reuse, while coil does not
- Sketch supports more granular resizing of images
- sketch clearly distinguishes between display, load, and download requests
- sketch provides image scaling and display components and supports large image sampling