前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Compose 与 AGP、KGP 的关系

Compose 与 AGP、KGP 的关系

作者头像
codelang
发布2022-11-30 14:44:02
1K0
发布2022-11-30 14:44:02
举报
文章被收录于专栏:codelang

在学习 Compose 的时候,有没有同学有一种困惑,Compose 到底是哪个 AGP 版本开始支持的,然后还会听到一些声音说,Compose 从 AGP 7.x 才开始支持,可当我使用 IntelliJ IDEA 创建 KMP 项目时,AGP 版本明明是 4.2.2,所以,为了搞清楚这个问题,我准备探索下 Compose 与他们之间的关系。

如果反编译过 Compose 项目的想必都知道,@Composable 注解下的方法会被生成各种 $composer 代码,那这块代码是谁来生成的呢?如果看过官方文档的话,是可以看到有一个叫 Compose Compiler[1] 库,他的主要目的借助 Kotlin 编译器插件,转换可组合函数(@Composable)并实现优化:

image.png

但如果你仔细去看 Compose 项目的话,怎么找都找不到这个依赖在哪,是不是很气?没关系,我们打印一下依赖树看看,是不是被谁给加进去了:

代码语言:javascript
复制
kotlin-extension - Configuration for Compose related kotlin compiler extension
\--- androidx.compose.compiler:compiler:1.1.1

诶,还真找到了,然后继续找 configurations 创建 kotlin-extension 的地方,在 AGP 的 TaskManager 里面找到了:

image.png

再想想,借助 Kotlin 编译插件来实现各种魔法的除了 Compose 还有谁?想必大家已经猜到了,就是被标记淘汰的 kotlin-android-extensions,刚开始用的时候,确实省了很多 findViewById 的操作。那么,这么多的魔法操作,在整个项目中的架构关系和依赖关系到底是什么样的呢?

架构梳理

江同学[2]在他的博文中贴了一张插件架构图,很清晰的展现了 AGP、KGP、Extension 的分层:

Compose Compiler 属于 Extension 这个层级,那他们是怎么参与 KGP 编译的呢?那就是 SPI,可以看下各个库的声明:

KGP 会通过 serviceLoader 加载所有的 CommandLineProcessor 和 ComponentRegistrar 参与 KCP 编译:

image.png

依赖梳理

现在我们已经知道了 Compose 是怎么参与 KGP 编译的了,那么,他们的依赖关系是什么样的呢?我画个图:

  • Compose Compiler 是被 AGP 依赖进去的,这也是困扰大家 Compose 与 AGP 版本到底是怎么配置的主要原因
  • KGP 的 pom.xml 将 kotlin-android-extension 依赖进来,所以,版本跟随 KGP
  • TGP 是霍老师的插件,直接在 build.gradle 通过 classpath 引入

一点疑惑:

  • compose compiler 为啥不做成单独插件呢?这样就可以从 AGP 里面剥离出来,通过 classpath 直接引入来减少版本困扰,现在改个 Compose 版本需要涉及 KGP 和 AGP
  • KGP 主要是 KCP 编译相关的东西,为啥又要将 android 相关的 kotlin-android-extension 放进 KGP 依赖进来呢?

解决 Compose 版本问题

虽然 Compose 会涉及到 KGP 和 AGP,但 AGP 还是很贴心的,提供了 extension 来设置 Compose 与 KCP 的版本,具体可以看 AGP 的 TaskManager 类:

image.png

从 TaskManager 来看,AGP 仅仅只是帮我们添加了 compose-compiler 和 KCP 依赖而已,这两个依赖版本号是可以通过 composeIOptions 来配置,如果没配置,则使用 AGP 内置写死的版本(很多人就是因为这个写死的版本导致 compose 配置不起来)

需要注意的是,KCP 的版本最好设置一下,不然,会强制 force 使用 AGP 内部配置的版本

所以,我们的项目可以改造成:

Project 下的 build.gradle

代码语言:javascript
复制
buildscript {
   ext.kotlin_version = '1.6.10'
   ext.compose_version = '1.1.0'
   ...
   dependencies {
      ...
      classpath 'com.android.tools.build:gradle:4.2.2'
      classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }
}

app 模块下的 build.gradle

代码语言:javascript
复制
android {
    ...
    buildFeatures{
        compose true
    }
    // 重点
    composeOptions{
        kotlinCompilerVersion  "$compose_version"
        kotlinCompilerExtensionVersion  "$kotlin_version"
    } 
}

dependencies {
   implementation "androidx.compose.ui:ui:$compose_version"
   ...
}

主要看 composeOptions 的设置:

  1. kotlinCompilerVersion : 指定 Compose Compiler 版本,与 Compose 版本保持一致
  2. kotlinCompilerExtensionVersion :指定 kotlin 的编译版本(KCP),与 kotlin-gradle-plugin 版本保持一致

其实,AGP 对 Compose 的影响仅仅只作用于 TaskManager 中是否有无添加 compose-compiler 依赖,如果 AGP 有,则 Compose 与 AGP 版本无关。所以,大家如果想了解自己老项目是否能直接接入 Compose ,可以看下自己项目的 AGP 版本,然后看下这个版本的 TaskManager 源码,目前我查看的 AGP 4.1.0 版本是有的。笔者的项目是 4.2.2 的 AGP ,已成功接入 Compose 1.1.0 版本并跑起来。

这里面唯一有关系的是 KCP 版本与 Compose-Compiler 版本,但 KCP 是被 KGP 引用进来的,所以,我们又可以简单的认为是 KGP 与 Compose 有关系,在上述配置的 composeOptions 代码块中,就是配置的这两个版本,这两个版本的关系官方文档也给出了,我列出几个主要版本的关系,具体的可以看官方文档《Compose 与 Kotlin 的兼容性对应关系 [4]》:

Compose Compiler 版本

兼容的 Kotlin 版本

1.2.0-rc01

1.6.21

1.1.1

1.6.10

1.1.0

1.6.10

1.0.5

1.5.31

1.0.4

1.5.31

1.0.3

1.5.30

1.0.2

1.5.21

1.0.1

1.5.21

1.0.0

1.5.10

总结

现在,终于理解了版本这层关系,所以,接下来你是否已经对 kotlin-android-extensioncompose-compiler是怎么生成代码而蠢蠢欲动了呢

参考资料

[1]

Compose Compiler: https://developer.android.com/jetpack/androidx/releases/compose-compiler?hl=zh_cn

[2]

江同学: https://juejin.cn/post/7051222120331739143

[3]

Kotlin-Trim-Indent: https://github.com/bennyhuo/Kotlin-Trim-Indent/blob/master/trimindent-compiler/src/main/java/com/bennyhuo/kotlin/trimindent/compiler/TrimIndentCommandLineProcessor.kt

[4]

Compose 与 Kotlin 的兼容性对应关系 : https://developer.android.com/jetpack/androidx/releases/compose-kotlin

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2022-07-11,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 扣浪 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 架构梳理
  • 依赖梳理
  • 解决 Compose 版本问题
  • 总结
    • 参考资料
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档