如何使用Gradle替换Google Maps API密钥？求相似密钥管理方案

嗨，我来帮你搞定这个问题！既然你已经在用gradle-credentials-plugin管理密钥，那扩展到Google Maps API密钥的思路其实是相通的——核心就是把密钥从代码中剥离，通过Gradle注入到需要的地方，同时利用系统密钥链/凭证存储来保护敏感信息。下面给你两种方案，从简单复用现有工具到更可靠的原生实现都有：

这个方案直接用你已经熟悉的插件，上手最快：

• 第一步：把Google Maps密钥存入凭证存储
  用插件提供的命令添加密钥（以Groovy DSL为例）：

  gradle addCredentials -PcredentialsKey=googleMapsApiKey -PcredentialsValue=你的Google Maps API密钥
  

  执行后密钥会被存在本地凭证存储（比如Mac的Keychain、Windows的Credential Manager），不会出现在代码仓库里。

• 第二步：在Gradle中读取密钥并注入到项目中
  打开你的build.gradle（或build.gradle.kts），在Android配置块里添加以下代码，把密钥注入到BuildConfig、Manifest占位符和资源文件中：

  plugins {
      id 'com.android.application'
      id 'gradle-credentials-plugin'
  }
  
  android {
      defaultConfig {
          // 注入到BuildConfig，代码中可通过BuildConfig.GOOGLE_MAPS_API_KEY调用
          buildConfigField "String", "GOOGLE_MAPS_API_KEY", "\"${credentials.googleMapsApiKey}\""
          
          // 替换AndroidManifest中的占位符
          manifestPlaceholders = [googleMapsApiKey: credentials.googleMapsApiKey]
          
          // 生成res/values下的字符串资源，布局中可使用@string/google_maps_api_key
          resValue "string", "google_maps_api_key", credentials.googleMapsApiKey
      }
  }
  

• 第三步：修改对应文件的占位符
  在AndroidManifest.xml中把硬编码的密钥替换成占位符：

  <meta-data
      android:name="com.google.android.geo.API_KEY"
      android:value="${googleMapsApiKey}" />
  

  如果之前是在res/values里写的密钥，现在直接用@string/google_maps_api_key即可，Gradle会自动替换成真实密钥。

如果你想完全不依赖第三方插件，用系统原生的凭证存储来管理密钥，这个方案更安全且通用：

• 第一步：把密钥存入系统凭证存储
  根据你的操作系统操作：

  • MacOS：打开「钥匙串访问」，添加一个「通用密码」，名称设为GoogleMapsApiKey，账户名随便填，密码是你的API密钥。
  • Windows：打开「凭据管理器」，添加「Windows凭据」，目标名称设为GoogleMapsApiKey，用户名随便，密码填密钥。
  • Linux：用secret-tool（GNOME Keyring）执行命令：

    secret-tool store --label='Google Maps API Key' service gradle name GoogleMapsApiKey
    

    执行后输入你的API密钥即可。

• 第二步：在Gradle中编写代码读取系统密钥
  在build.gradle中添加一个自定义方法读取系统密钥，然后注入到项目中：

  import java.io.IOException
  
  def getGoogleMapsApiKey() {
      String key = null
      def osName = System.getProperty("os.name").toLowerCase()
      
      if (osName.contains("mac")) {
          // 读取Mac钥匙串
          def proc = "security find-generic-password -w -a '你的钥匙串账户名' -s 'GoogleMapsApiKey'".execute()
          proc.waitFor()
          key = proc.in.text.trim()
      } else if (osName.contains("win")) {
          // 读取Windows凭据管理器
          def proc = "cmd /c powershell -Command \"Get-StoredCredential -Target 'GoogleMapsApiKey' | Select-Object -ExpandProperty Password\"".execute()
          proc.waitFor()
          key = proc.in.text.trim()
      } else if (osName.contains("nix") || osName.contains("nux")) {
          // 读取Linux密钥环
          def proc = "secret-tool lookup service gradle name GoogleMapsApiKey".execute()
          proc.waitFor()
          key = proc.in.text.trim()
      }
      
      // fallback到环境变量，方便CI/CD或本地临时测试
      return key ?: System.getenv("GOOGLE_MAPS_API_KEY")
  }
  
  android {
      defaultConfig {
          def mapsKey = getGoogleMapsApiKey()
          buildConfigField "String", "GOOGLE_MAPS_API_KEY", "\"${mapsKey}\""
          manifestPlaceholders = [googleMapsApiKey: mapsKey]
          resValue "string", "google_maps_api_key", mapsKey
      }
  }
  

• 团队协作时，要给队友说明如何在各自系统中添加密钥，或者告诉他们可以通过设置GOOGLE_MAPS_API_KEY环境变量来临时替代。
• CI/CD构建时，直接在构建服务器的环境变量中配置GOOGLE_MAPS_API_KEY，Gradle会自动读取这个 fallback 值，无需在服务器上配置密钥链。
• 如果用Kotlin DSL，只需要把上面的Groovy代码转换成对应的Kotlin语法即可，核心逻辑完全一致。

内容的提问来源于stack exchange，提问作者Kheldar