我需要你帮我分析一个 kotlin 写的gradle脚本
- User
我需要你帮我分析一个 kotlin 写的gradle脚本
- Assistant
好的,可以请您提供这个 Kotlin 写的 Gradle 脚本吗?
- User
plugins { id("nowinandroid.android.library") id("nowinandroid.android.library.jacoco") id("nowinandroid.android.hilt") id("kotlinx-serialization") id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
android { buildFeatures { buildConfig = true } namespace = "com.google.samples.apps.nowinandroid.core.network" testOptions { unitTests { isIncludeAndroidResources = true } } }
secrets { defaultPropertiesFileName = "secrets.defaults.properties" }
dependencies { implementation(project(":core:common")) implementation(project(":core:model")) implementation(libs.coil.kt) implementation(libs.coil.kt.svg) implementation(libs.kotlinx.coroutines.android) implementation(libs.kotlinx.datetime) implementation(libs.kotlinx.serialization.json) implementation(libs.okhttp.logging) implementation(libs.retrofit.core) implementation(libs.retrofit.kotlin.serialization)
testImplementation(project(":core:testing"))}
- Assistant
这是一个使用 Kotlin DSL(领域特定语言)写的 Gradle 构建脚本。它的作用是构建一个 Android 应用程序模块,并声明了使用的插件和库。
-
使用
plugins插件声明使用的插件:nowinandroid.android.library:用于构建 Android 库项目的插件。nowinandroid.android.library.jacoco:用于测试覆盖率的插件。nowinandroid.android.hilt:用于集成 Hilt 依赖注入框架的插件。kotlinx-serialization:用于序列化和反序列化的插件。com.google.android.libraries.mapsplatform.secrets-gradle-plugin:用于处理项目中的敏感信息的插件。
-
使用
android定义 Android 应用程序的构建设置:buildFeatures属性指定里面的属性,这里是开启了buildConfig功能,允许在代码中访问构建配置参数。namespace命名空间用于生成 Binary 的名称(在构建结果中,通常是一个 AAR 文件)。testOptions属性可以配置测试,这里开启了isIncludeAndroidResources功能。
-
使用
secrets定义敏感信息的处理方法,如果使用了上面声明的com.google.android.libraries.mapsplatform.secrets-gradle-plugin,那么这个配置就会生效:defaultPropertiesFileName属性指定默认的敏感信息配置文件名称,在项目中的res/raw目录下。
-
使用
dependencies声明依赖的库和项目:implementation声明编译时依赖的库和项目。testImplementation声明测试时依赖的库和项目。
其中声明的库和项目有:
project(":core:common"):引用了一个在项目中的core:common子项目。project(":core:model"):引用了一个在项目中的core:model子项目。libs.coil.kt:引用了一个名为coil的第三方库,用于图像加载。libs.coil.kt.svg:引用了一个名为coil-kt-svg的第三方库,用于加载 SVG 图像。libs.kotlinx.coroutines.android:引用了一个名为kotlinx-coroutines-android的第三方库,用于异步处理。libs.kotlinx.datetime:引用了一个名为kotlinx-datetime的第三方库,用于处理日期和时间。libs.kotlinx.serialization.json:引用了一个名为kotlinx-serialization-json的第三方库,用于 JSON 序列化和反序列化。libs.okhttp.logging:引用了一个名为okhttp-logging-interceptor的第三方库,用于打印网络请求和响应的日志。libs.retrofit.core:引用了一个名为retrofit2的第三方库,用于创建和执行网络请求。libs.retrofit.kotlin.serialization:引用了一个名为retrofit2-kotlinx-serialization-converter的第三方库,用于使用 Kotlinx.serialization 库将 JSON 转换为对象。
-
- User
我没有见过像 implementation(libs.coil.kt) 这种引用方式, libs.coil.kt是怎么来的?
- Assistant
libs.coil.kt不是标准的 Gradle 引用方式,它可能是定义在项目中某个文件里的变量或属性。在 Kotlin 中,可以使用这种方式来定义常量或属性。如果你能提供更多项目中的代码,特别是与
libs.coil.kt有关的,我可以帮您更好地分析它。 - User
请再帮我分析一个 kotlin写的gralde插件代码
- Assistant
好的,请提供您想要分析的该 Kotlin 写的 Gradle 插件代码。
Gradle 插件本身也是一个 Gradle 项目,需要声明它使用的插件:
plugins { id("org.gradle.plugin.development") version "0.7.0" id("com.android.library") id("kotlin") }其中:
org.gradle.plugin.development插件是个开发插件,用于开发自定义插件。com.android.library插件用于开发 Android 库项目。kotlin插件用于 Kotlin 项目开发。
然后声明源码和依赖项:
dependencies { api(gradleApi()) implementation(repo.gradleToolkit()) implementation(localProject(":my-plugin")) implementation(kotlin("stdlib")) }api(gradleApi())声明依赖 Gradle API 库,这样可以在插件中访问 Gradle 的内部 API。implementation(repo.gradleToolkit())声明仓库地址上com.gradle.toolkit的库,这样可以使用 Toolkit API 和 DSL。implementation(localProject(":my-plugin"))声明对其它本地项目my-plugin的依赖,这种方式可以方便地在本地进行开发和测试。implementation(kotlin("stdlib"))声明 Kotlin 标准库的依赖,用于 Kotlin 项目开发。
除此之外,通常一个 Gradle 插件也需要开发者提供一些 API,在插件脚本中可以通过
org.gradle.api.Plugin接口实现这些 API。下面是一个例子,它展示了如何实现
Plugin接口,并在其中定义一些操作和扩展:class MyPlugin : Plugin<Project> { override fun apply(project: Project) { project.extensions.create("myPlugin", MyPluginExtension::class.java) project.task("myTask") { group = "myPlugin" description = "myTask description" doLast { println("Hello from $name!") } } project.afterEvaluate { val extension = project.extensions.findByName("myPlugin") as MyPluginExtension? if (extension?.message != null) { println(extension.message) } } } } open class MyPluginExtension(var message: String? = null) fun Project.myPlugin( message: String? = null ): MyPluginExtension = extensions.create("myPlugin", MyPluginExtension::class.java).apply { this.message = message }其中,实现了
Plugin接口:apply方法会在插件应用时执行,这里向项目添加了一个扩展、一个任务和一个监听器函数。MyPluginExtension类是一个插件的扩展类,将它作为插件的扩展,可以在插件中定义新的配置属性。
扩展和任务:
project.extensions.create方法使用MyPluginExtension类创建了一个扩展,并指定使用的名称myPlugin。project.task方法创建了一个名为myTask的任务,并且在每次执行时都会打印一条消息。
监听器函数:
project.afterEvaluate方法是一个项目构建周期中的一个阶段。- 它在项目所有代码执行完成后执行,此时可以使用执行后的项目状态进行后续处理。
最后是一个通过扩展定义
myPlugin的方法,该方法可以在使用插件时,对其进行配置:fun Project.myPlugin( message: String? = null ): MyPluginExtension = extensions.create("myPlugin", MyPluginExtension::class.java).apply { this.message = message }该方法创建了一个
MyPluginExtension扩展类,并将其附加到项目中。使用者可以通过这个方法配置扩展和进行链式调用。如果您有任何其他问题,欢迎继续提问。
- User
/*
- Copyright 2022 The Android Open Source Project
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
https://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. */
import org.gradle.api.Plugin import org.gradle.api.Project import org.gradle.api.artifacts.VersionCatalogsExtension import org.gradle.kotlin.dsl.dependencies import org.gradle.kotlin.dsl.getByType
class AndroidHiltConventionPlugin : Plugin { override fun apply(target: Project) { with(target) { with(pluginManager) { apply("dagger.hilt.android.plugin") // KAPT must go last to avoid build warnings. // See: https://stackoverflow.com/questions/70550883/warning-the-following-options-were-not-recognized-by-any-processor-dagger-f apply("org.jetbrains.kotlin.kapt") }
val libs = extensions.getByType<VersionCatalogsExtension>().named("libs") dependencies { "implementation"(libs.findLibrary("hilt.android").get()) "kapt"(libs.findLibrary("hilt.compiler").get()) "kaptAndroidTest"(libs.findLibrary("hilt.compiler").get()) } } }}
- Assistant
这段是一个类
AndroidHiltConventionPlugin,实现了 Gradle 的Plugin<Project>接口。该插件将dagger.hilt.android.plugin应用于目标项目并添加 Hilt 依赖项。插件中的
apply()方法用于应用插件到目标项目:with(pluginManager) { apply("dagger.hilt.android.plugin") apply("org.jetbrains.kotlin.kapt") }其中:
apply("dagger.hilt.android.plugin")应用了 Hilt 插件。apply("org.jetbrains.kotlin.kapt")应用了 Kotlin 的注解处理器插件。
接下来,定义了一个名为
libs的变量,用于获取VersionCatalogsExtension扩展,并指定其名称为libs:val libs = extensions.getByType<VersionCatalogsExtension>().named("libs")然后,通过
dependencies { ... }块来声明依赖项:dependencies { "implementation"(libs.findLibrary("hilt.android").get()) "kapt"(libs.findLibrary("hilt.compiler").get()) "kaptAndroidTest"(libs.findLibrary("hilt.compiler").get()) }其中:
libs.findLibrary("hilt.android").get()通过findLibrary方法查找名为hilt.android的库并返回其版本。- 各个依赖项的作用依次是:
"implementation":添加到实现依赖项中。"kapt":在生成代码时使用,用于处理注入。"kaptAndroidTest":同上,但增加作用范围为 Android 测试。
插件的作用,就是方便应用 Hilt 依赖项。可以通过在项目中应用该插件,来轻松引入 Hilt 依赖项,并在应用依赖时依赖版本约束。
- User
也就是说, 有了这段代码,我只需要在我的项目的build.gradle中应用这个plugin就可以以来 hilt.android 而不需要再在dependencies中添加相关依赖了对吗?
- Assistant
是的,你的理解是正确的。如果你在你的项目的 build.gradle 文件中应用了该插件,则不需要手动添加 hilt.android 相关的依赖,该插件会自动添加这些依赖,让你可以直接在代码中使用 Hilt,而不必添加依赖时考虑版本的问题。同时,该插件还会自动将 Hilt 所需的注解处理器添加到项目中。总之,这个插件可以为你的项目省去不少的繁琐的配置工作,从而使你能更加专注于业务代码的编写。
- User
我不太理解 extensions.getByType().named("libs") 这一段, 请再仔细讲讲
- Assistant
那么我来详细解释一下这段代码的意思,十分抱歉之前解释的不够清晰。
在 Gradle 中,可以通过
extensions属性访问到给定项目或子项目的所有扩展。getByType<someType>()方法用于获取给定类型的扩展。在这里,我们要获取类型为VersionCatalogsExtension的扩展,它允许我们在 Gradle 中管理和使用版本。该插件通过
with方法将target对象设置为默认的Project对象,因此extensions属性实际上是target.extensions的简写。接下来是
named()方法,它允许我们使用扩展的名称来访问特定的扩展。这里,名称为libs的扩展是一个org.gradle.api.artifacts.dsl.VersionCatalogsExtension对象,它带有一组名称-版本号的映射,允许我们通过名称来自动管理版本号。最后,使用
.运算符来访问其中的hilt.android和hilt.compiler版本。因此该插件依赖这个自定义的 version catalog 来维护
hilt.android和hilt.compiler依赖项的版本号,而不需要在 build.gradle 文件中直接指定它们的版本号。它可以更便捷地在应用程序中使用 Hilt,并且可以轻松升级版本。 - User
请给一个市里,我应该怎么做才能让这个Plugin找到 "libs"
- Assistant
在使用这个插件时,需要先在
gradle.properties文件中定义一个名为libs.version的属性,并将其设置为需要定义版本号的库的VersionCatalog字符串的路径(是一个.gradle文件),例如:libs.version=/path/to/libs_version_catalog.gradle接着,需要在
libs_version_catalog.gradle中定义库的版本对应关系,其中名称为libs,它是一个org.gradle.api.artifacts.dsl.VersionCatalogExtension对象,它的名称和版本号的映射值采用键值对的方式进行定义。示例:libs { // Library Versions hilt_android = "2.40.1" hilt_compiler = "2.40.1" }在这个示例中,
hilt_android和hilt_compiler是库的名称,而 "2.40.1" 是其对应的版本号。当使用
AndroidHiltConventionPlugin插件时,它会使用上述定义的版本号,你不需要去手动指定它们。在插件中的AndroidHiltConventionPlugin类的apply()方法中,可以看到如何使用libs来添加hilt.android和hilt.compiler依赖:val libs = extensions.getByType<VersionCatalogsExtension>().named("libs