如何共享 Android 不同模块的构建配置_andrid build-logic

提到预编译插件，很多人知道可以写在 buildSrc 目录下，但是这种方式还是有一些缺点的，比如任何更改都会导致整个项目重新编译，更好的方式是使用复合构建（composite build）

我们新建 1 个 build-logic 项目，文件结构如下，我们将在 AndroidLibraryConventionPlugin 中编写我们的要在 Android Library Module 中共享的构建逻辑。

AndroidStudy (Root Project)
├─…
└─build-logic
| settings.gradle.kts
└─ convention
| build.gradle.kts
└─ src
└─ main
└─ kotlin
└─ AndroidLibraryConventionPlugin.kt

因为复合构建项目里的构建是完全独立的，所以我们需要在 build-logic/settings.gradle.kts 中声明依赖仓库源，也要显式声明 versionCatalogs

dependencyResolutionManagement {
repositories {
google()
mavenCentral()
}
versionCatalogs {
create(“libs”) {
from(files(“…/gradle/libs.versions.toml”))
}
}
}

rootProject.name = “build-logic”
include(“:convention”)

build-logic/convention/build.gradle.kts:

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
kotlin-dsl
}

group = “com.bqliang.gradleconventionplugins.buildlogic”

// Configure the build-logic plugins to target JDK 17
// This matches the JDK used to build the project, and is not related to what is running on device.
java {
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
}
tasks.withType().configureEach {
kotlinOptions {
jvmTarget = JavaVersion.VERSION_17.toString()
}
}

dependencies {
compileOnly(libs.android.gradlePlugin)
compileOnly(libs.kotlin.gradlePlugin)
}

gradlePlugin {
// register the convention plugin
plugins {
register(“androidLibrary”) {
id = “bqliang.android.library”
implementationClass = “AndroidLibraryConventionPlugin”
}
}
}

这里的 sourceCompatibility、targetCompatibility、kotlinOptions 只是用来指定编译我们的 Gradle Convention Plugin 的 JDK 版本，和共享的构建逻辑没有关系。文件最后注册了我们的 Gradle Convention Plugin，为了后续方便引用，我们可以把 plugin id 写在 libs.versions.toml 里：

…
[plugins]
bqliang-android-library = { id = “bqliang.android.library”, version = “unspecified” }
…

build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt:

import com.android.build.api.dsl.CommonExtension
import com.android.build.gradle.LibraryExtension
import org.gradle.api.JavaVersion
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.kotlin.dsl.configure
import org.gradle.kotlin.dsl.withType
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

class AndroidLibraryConventionPlugin : Plugin {
override fun apply(target: Project) {
with(target) {
with(pluginManager) {
// Android Library Module 都需要这 2 个插件
apply(“com.android.library”)
apply(“org.jetbrains.kotlin.android”)
}

extensions.configure {
configureKotlinAndroid(this)
defaultConfig.targetSdk = 34
}
}
}

private fun Project.configureKotlinAndroid(
commonExtension: CommonExtension<*, *, *, *, *>,
) {
commonExtension.apply {
compileSdk = 34

defaultConfig {
minSdk = 26
}

compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}

configureKotlin()
}

private fun Project.configureKotlin() {
// Use withType to workaround https://youtrack.jetbrains.com/issue/KT-55947
tasks.withType().configureEach {
kotlinOptions {
// Set JVM target to 11
jvmTarget = JavaVersion.VERSION_11.toString()
}
}
}
}

注意，目前我们还没有在 root project 中 include 这个 build-logic 项目呢，因为复合构建会把项目里的构建配置包含进来，所以我们不能直接使用 include(“:build-logic”)，而是要使用 includeBuild(“build-logic”)

AndroidStudy/settings.gradle.kts:

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数HarmonyOS鸿蒙开发工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年HarmonyOS鸿蒙开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上HarmonyOS鸿蒙开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新

如果你觉得这些内容对你有帮助，可以添加VX：vip204888 （备注鸿蒙获取）

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

对你有帮助，可以添加VX：vip204888 （备注鸿蒙获取）**
[外链图片转存中…(img-p2k1yr99-1712760648637)]

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！