Read value from local.properties via Kotlin DSL

Question

I want to retreive key from local.properties file that looks like :

sdk.dir=C\:\\Users\\i30mb1\\AppData\\Local\\Android\\Sdk
key="xxx"

and save this value in my BuildConfig.java via gradle Kotlin DSL. And later get access to this field from my project.

i30mb1 · Accepted Answer · 2022-04-27T17:47:37.340

Okay. I found solutions.

For Android Projects :

In my build.gradle.kts I create a value that retrieves my key:

import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties

val key: String = gradleLocalProperties(rootDir).getProperty("key")

And in the block buildTypes I write it:

buildTypes {
 getByName("debug") {
    buildConfigField("String", "key", key)
   }
}

And in my Activity now I can retrieve this value:

override fun onCreate() {
    super.onCreate()
    val key = BuildConfig.key
}

For Kotlin Projects:

We can create an extension that help us to retrieve desired key:

fun Project.getLocalProperty(key: String, file: String = "local.properties"): Any {
    val properties = java.util.Properties()
    val localProperties = File(file)
    if (localProperties.isFile) {
        java.io.InputStreamReader(java.io.FileInputStream(localProperties), Charsets.UTF_8).use { reader ->
            properties.load(reader)
        }
    } else error("File from not found")

    return properties.getProperty(key)
}

And use this extension when we would like

task("printKey") {
   doLast {
       val key = getLocalProperty("key")
       println(key)
   }
}

For plain kotlin projects you can refer to this answer: https://stackoverflow.com/a/69268957/1118475 — Michał Klimczak, Mar 07 '22 at 13:35

score 31 · Answer 2 · answered Sep 21 '21 at 12:32

31

If you don't have access to gradleLocalProperties (it's only accessible for android projects):

val prop = Properties().apply {
    load(FileInputStream(File(rootProject.rootDir, "local.properties")))
}
println("Property:" + prop.getProperty("propertyName"))

Don't forget imports:

import java.io.File
import java.io.FileInputStream
import java.util.*

answered Sep 21 '21 at 12:32

Michał Klimczak

12,674
8
66
99

2

This is a much better solution, thanks. Not only is the accepted answer specific to Android projects, it uses an API from an internal package which is probably not officially supported. – Damien Diehl Feb 22 '22 at 20:17
rootProject undefined. How do you retrieve rootDir ? – Pitos Nov 19 '22 at 02:18
you can call rootProject.projectdir – Selim Ajimi Apr 06 '23 at 17:08

score 3 · Answer 3 · answered Oct 23 '21 at 17:49

3

put your property in local.properties

and in build.gradle(app).kts file reference it as such: gradleLocalProperties(rootDir).getProperty("YOUR_PROP_NAME")

answered Oct 23 '21 at 17:49

Jean Raymond Daher

306
3
11

score 0 · Answer 4 · answered Jun 06 '23 at 06:59

for me the complete solution in android projects was :

1 - put your key in local properties.

2 - in build.gradle.kts => add 2 lines

val key: String = gradleLocalProperties(rootDir).getProperty("KEY") ?: ""
buildConfigField("String", "KEY", "\"$key\"")

== now you can get your key in code like this:

val key = BuildConfig.KEY

Read value from local.properties via Kotlin DSL

4 Answers4

== now you can get your key in code like this:

Linked