Jetpack Compose 图片库Coil 简单使用

官方文档

查看官方文档 Coil

这个库可以做到加载图片功能,类似 Glide 和 其他图片库一样。而且支持Compose 和传统的代码

支持功能:Gif,SVG,还有video Frames 的某一帧。而且是官方推荐的库,关键配合kotlin可以使用协程优势。

Jetpack Compose 支持(其他支持参考文档)

  • AsyncImage

AsyncImage 是可组合的,它异步执行图像请求并呈现结果。 它支持与标准 Image 可组合相同的参数,此外,它支持placeholder/error/fallback和 onLoading/onSuccess/onError 回调。

这是一个加载带有圆形裁剪、淡入淡出并设置占位符的图像的示例:

AsyncImage(
    model = ImageRequest.Builder(LocalContext.current)
        .data("https://example.com/image.jpg")
        .crossfade(true)
        .build(),
    placeholder = painterResource(R.drawable.placeholder),
    contentDescription = stringResource(R.string.description),
    contentScale = ContentScale.Crop,
    modifier = Modifier.clip(CircleShape)
)
  • SubcomposeAsyncImage

SubcomposeAsyncImage 是 AsyncImage 的变体,它使用 subcomposition 为 AsyncImagePainter 的状态提供插槽 API,而不是使用 Painters。

SubcomposeAsyncImage(
    model = "https://example.com/image.jpg",
    loading = {
        CircularProgressIndicator()
    },
    contentDescription = stringResource(R.string.description)
)

此外,您可以使用其 content 参数和渲染当前状态的 SubcomposeAsyncImageContent 拥有更复杂的逻辑:

SubcomposeAsyncImage(
    model = "https://example.com/image.jpg",
    contentDescription = stringResource(R.string.description)
) {
    val state = painter.state
    if (state is AsyncImagePainter.State.Loading || state is AsyncImagePainter.State.Error) {
        CircularProgressIndicator()
    } else {
        SubcomposeAsyncImageContent()
    }
}

重要关注的一个提示:

子组合的性能不如常规组合,因此这种组合可能不适合对高性能至关重要的 UI 部分
如果您使用 ImageRequest.Builder.size 为 ImageRequest 设置自定义大小(例如 size(Size.ORIGINAL)),SubcomposeAsyncImage 将不会使用子组合,因为它不需要解析可组合的约束。

  • AsyncImagePainter

在内部,AsyncImage 和 SubcomposeAsyncImage 使用 AsyncImagePainter 来加载模型。 如果您需要 Painter 并且不能使用 AsyncImage,您可以使用 rememberAsyncImagePainter 加载图像:

rememberAsyncImagePainter is a lower-level API that may not behave as expected in all cases. Read the method's documentation for more information.

如果在呈现 AsyncImagePainter 的图像上设置自定义 ContentScale,则还应该在 rememberAsyncImagePainter 中设置它。 有必要确定加载图像的正确尺寸。

  • Observing AsyncImagePainter.state

图像请求需要一个大小来确定输出图像的尺寸。 默认情况下,AsyncImage 和 AsyncImagePainter 在合成发生后,但在绘制第一帧之前解析请求的大小。 它以这种方式解决以最大限度地提高性能。 这意味着 AsyncImagePainter.state 将为第一个合成加载 - 即使图像存在于内存缓存中并且它将在第一帧中绘制。

如果您需要 AsyncImagePainter.state 在第一次合成期间保持最新,请使用 SubcomposeAsyncImage 或使用 ImageRequest.Builder.size 为图像请求设置自定义大小。 例如,在此示例中,AsyncImagePainter.state 在第一次合成期间将始终是最新的:

val painter = rememberAsyncImagePainter(
    model = ImageRequest.Builder(LocalContext.current)
        .data("https://example.com/image.jpg")
        .size(Size.ORIGINAL) // Set the target size to load the image at.
        .build()
)

if (painter.state is AsyncImagePainter.State.Success) {
    // This will be executed during the first composition if the image is in the memory cache.
}

Image(
    painter = painter,
    contentDescription = stringResource(R.string.description)
)

  • Transitions

您可以使用 ImageRequest.Builder.crossfade 启用内置的交叉淡入淡出过渡:

AsyncImage(
    model = ImageRequest.Builder(LocalContext.current)
        .data("https://example.com/image.jpg")
        .crossfade(true)
        .build(),
    contentDescription = null
)

高级使用

自定义转换不适用于 AsyncImage、SubcomposeAsyncImage 或 rememberAsyncImagePainter,因为它们需要 View 引用。 由于特殊的内部支持,CrossfadeTransition 有效。

也就是说,可以通过观察 AsyncImagePainter 的状态在 Compose 中创建自定义转换:

val painter = rememberAsyncImagePainter("https://example.com/image.jpg")

val state = painter.state
if (state is AsyncImagePainter.State.Success && state.dataSource != DataSource.MEMORY_CACHE) {
    // Perform the transition animation.
}

Image(
    painter = painter,
    contentDescription = stringResource(R.string.description)
)

注意

为了可测试,我试了不同版本
可能需要state.result.dataSource != DataSource.MEMORY_CACHE 这么写,不是官方文档错误,就是版本问题

if (state is AsyncImagePainter.State.Success && state.result.dataSource != DataSource.MEMORY_CACHE) {
        // Perform the transition animation.
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容