Gradle BuildConfig 插件使用教程

1. 项目的目录结构及介绍

Gradle BuildConfig 插件的目录结构如下：

gradle-buildconfig-plugin/
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle.kts
├── src/
│   ├── main/
│   │   ├── groovy/
│   │   └── resources/
│   └── test/
│       ├── groovy/
│       └── resources/
├── LICENSE
└── README.md

目录结构介绍

• build.gradle.kts: 项目的构建脚本。
• gradle.properties: 包含项目的属性配置。
• gradlew 和 gradlew.bat: Gradle 包装器脚本，用于在不同平台上执行 Gradle 任务。
• settings.gradle.kts: 项目的设置脚本，用于配置多项目构建。
• src/: 源代码目录，包含主代码和测试代码。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 build.gradle.kts 和 settings.gradle.kts。

build.gradle.kts

build.gradle.kts 是项目的构建脚本，定义了项目的依赖、插件、任务等。以下是一个示例：

plugins {
    id("org.jetbrains.kotlin.jvm") version "1.5.31"
    id("com.github.gmazzo.buildconfig") version "3.0.0"
}

buildConfig {
    buildConfigField("String", "APP_NAME", "\"MyApp\"")
    buildConfigField("String", "APP_VERSION", provider { "\"${project.version}\"" })
    buildConfigField("String", "APP_SECRET", "\"Z3JhZGxlLWphdmEtYnVpbGRjb25maWctcGx1Z2lu\"")
    buildConfigField("long", "BUILD_TIME", System.currentTimeMillis())
    buildConfigField("boolean", "FEATURE_ENABLED", true)
}

settings.gradle.kts

settings.gradle.kts 是项目的设置脚本，用于配置多项目构建。以下是一个示例：

rootProject.name = "gradle-buildconfig-plugin"

3. 项目的配置文件介绍

项目的配置文件主要包括 gradle.properties 和 build.gradle.kts。

gradle.properties

gradle.properties 文件包含项目的属性配置，例如：

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
org.gradle.parallel=true

build.gradle.kts

build.gradle.kts 文件中包含了插件的配置，例如：

plugins {
    id("org.jetbrains.kotlin.jvm") version "1.5.31"
    id("com.github.gmazzo.buildconfig") version "3.0.0"
}

buildConfig {
    buildConfigField("String", "APP_NAME", "\"MyApp\"")
    buildConfigField("String", "APP_VERSION", provider { "\"${project.version}\"" })
    buildConfigField("String", "APP_SECRET", "\"Z3JhZGxlLWphdmEtYnVpbGRjb25maWctcGx1Z2lu\"")
    buildConfigField("long", "BUILD_TIME", System.currentTimeMillis())
    buildConfigField("boolean", "FEATURE_ENABLED", true)
}

通过这些配置，可以生成包含项目常量的 BuildConfig 类，方便在代码中使用。