Secrets Gradle Plugin 使用教程

1. 项目目录结构及介绍

secrets-gradle-plugin/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── secrets.defaults.properties
├── secrets.properties
├── settings.gradle.kts
├── github/
│   └── workflows/
├── gradle/
│   └── wrapper/
├── sample-app/
│   ├── build.gradle.kts
│   ├── gradle.properties
│   ├── settings.gradle.kts
│   └── src/
└── secrets-gradle-plugin/
    ├── build.gradle.kts
    ├── gradle.properties
    ├── settings.gradle.kts
    └── src/

目录结构介绍

• CODE_OF_CONDUCT.md: 项目的行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。
• build.gradle.kts: 项目的根构建脚本文件。
• gradle.properties: Gradle 配置属性文件。
• gradlew: Gradle 包装器脚本（Unix）。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• secrets.defaults.properties: 默认的密钥属性文件。
• secrets.properties: 密钥属性文件。
• settings.gradle.kts: 项目的设置脚本文件。
• github/workflows/: GitHub Actions 工作流配置文件。
• gradle/wrapper/: Gradle 包装器配置文件。
• sample-app/: 示例应用程序目录。
• secrets-gradle-plugin/: 插件源代码目录。

2. 项目启动文件介绍

启动文件

• gradlew: 用于在 Unix 系统上启动 Gradle 构建的脚本。
• gradlew.bat: 用于在 Windows 系统上启动 Gradle 构建的脚本。

启动步骤

1. 在项目根目录下打开终端或命令行工具。
2. 运行以下命令启动构建：
   • Unix 系统：./gradlew build
   • Windows 系统：gradlew.bat build

3. 项目配置文件介绍

配置文件

• build.gradle.kts: 项目的根构建脚本文件，包含插件的依赖和配置。
• gradle.properties: Gradle 配置属性文件，包含项目的全局属性。
• secrets.defaults.properties: 默认的密钥属性文件，包含默认的密钥值。
• secrets.properties: 密钥属性文件，包含项目的实际密钥值。
• settings.gradle.kts: 项目的设置脚本文件，包含项目的模块配置。

配置示例

build.gradle.kts

buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

plugins {
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

gradle.properties

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
android.useAndroidX=true
android.enableJetifier=true

secrets.defaults.properties

apiKey=DEFAULT_API_KEY

secrets.properties

apiKey=YOUR_API_KEY

settings.gradle.kts

rootProject.name = "secrets-gradle-plugin"
include(":sample-app")
include(":secrets-gradle-plugin")

通过以上配置，您可以安全地将密钥从版本控制中排除，并在构建过程中使用这些密钥。