Android開発でAPIkeyを隠してGithubに上げる方法

はじめに

今回は、APIキーなどの機密情報を安全に管理するために、Secrets Gradleプラグインを使用する方法について説明します。この方法を用いることで、機密情報を秘匿しつつ、プロジェクトをGitHubにアップロードする手順を解説していきます。

手順

詳しい導入方法はこちらに書かれています。

その１

プロジェクトレベルのbuild.gradle.ktsに下記をコピーして貼り付けてください。

こちらより最新バージョンがある場合はそちらを記入して使ってください。

build.gradle.kts(Project)

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

その２

次にモジュールレベルのbuild.gradle.ktsに下記をコピーして貼り付けてください。

build.gradle.kts(Module)

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

その3

もう一度モジュールレベルのbuild.gradle.ktsのbuildFeaturesに"buildConfig = true"を追加してSyncしてください。

build.gradle.kts(Module)

    buildFeatures {
        compose = true
        buildConfig = true
    }

最後に

Gradle Scriptsの中にあるlocal.propertiesに隠す用のAPIキーを書いてください。

local.properties

APIKey = {"隠す用のAPIキー"}

書けたらBuildConfigで参照できるか一度確認してみてください

<例>

val APIKey = BuildConfig.APIKey

BuildConfigでアクセスできなかった場合は下記をお試しください。
（実際自分はこの過程を挟まないと絶対BuildConfigから参照できなかったです。）
1.FileからInvalidate Caches
2.buildからClean Project
3.buildからRebuild Project

この手順を組めばとりあえずはBuildConfigからアクセスできると思われます。

終わり

多くの場合、機密情報の秘匿にはCLIやコマンドラインの操作が必要で、初心者には難しいと感じることが多々ありましたが、こちらの方法ならもっと簡単に理解しやすいんじゃないんだろうかと思っていたので書けてよかったです。

また、下記の方のnoteも参考にしたのでぜひこちらもみて参考にしてください！