Using String Constants Generated by Gradle Build Configurations

September 23, 2014

If you’ve ever wanted to use different String constants in your Android project for debug and release builds, there is a way.

Gradle allows developers to insert different constants into their Java code and XML resources with different build configurations.

Google Maps API V2 Example

The Google Maps API V2 requires that your Maps API key be placed in your AndroidManifest.xml file, like this:

<meta-data
 android:name="com.google.android.maps.v2.API_KEY"
 android:value="(YOUR MAPS API KEY)"/>

Since this is in the manifest, you don’t have the option to change this API key at runtime. If you wanted to use a different Maps API key for your development and production build versions, you would have to change this entry in the manifest each time you built a release version of your app.

With Gradle however, you can specify different XML string resources for your debug and release builds. In this case, we can make a string resource for our Maps API key in our build.gradle file:

android {

 ...

 buildTypes {
 debug {
 ...

 resValue "string", "GOOGLE_MAPS_ANDROID_API_KEY", "(your development Maps API key)"
 }
 release {
 ...

 resValue "string", "GOOGLE_MAPS_ANDROID_API_KEY", "(your production Maps API key)"
 }
 }
}

The string resource “GOOGLE_MAPS_ANDROID_API_KEY” will be generated during a debug or release build. Now you can refer to this string in your manifest:

<meta-data
 android:name="com.google.android.maps.v2.API_KEY"
 android:value="@string/GOOGLE_MAPS_ANDROID_API_KEY"/>

Your IDE may complain about this string resource not existing, but it will build just fine.

String Constants in Your Java Code

Gradle can also insert String constants into your Java code. Let’s say we want to use different URL endpoints depending on whether this is our debug or release version. This can be done in your build.gradle file.

android {

 ...

 buildTypes {
 debug {
 ...

 buildConfigField "String", "URL_ENDPOINT", "\"http://your.development.endpoint.com/\""
 }
 release {
 ...

 buildConfigField "String", "URL_ENDPOINT", "\"http://your.production.endpoint.com/\""
 }
 }
}

The escaped double-quotes (\”) around the string itself are necessary in order for the String constants to have the double-quotes in the generated code.

Now we can refer to this String constant in our code.

import com.yourpackage.name.BuildConfig;

private void doSomethingWithUrlEndpoint() {
 String urlEndpoint = BuildConfig.URL_ENDPOINT;

 ...
}
Joseph Kreiser
Joseph Kreiser
Software Developer

Stay in the loop with our latest content!

Select the topics you’re interested to receive our new relevant content in your inbox. Don’t worry, we won’t spam you.

Finding Connectedness During COVID
Team

Finding Connectedness During COVID

February 17, 2021

When the world was turned upside down last March, our team was well set up for the technical side of what we do, but figuring out how to make us feel connected over a long stretch of remote work presented a new obstacle.

Read more
Working Remote vs. In-Person. Is there a balance?
Team

Working Remote vs. In-Person. Is there a balance?

December 2, 2019

There’s a battle being waged around the world—a battle between companies all-in on working remotely and those who prefer the traditional model of showing up to work each day. Okay, maybe it's not quite a battle. But, in an increasingly connected world, a growing number of companies are struggling to decide if mobile is right for them.

Read more
Why I use NextJS
Development Web

Why I use NextJS

December 21, 2022

Is NextJS right for your next project? In this post, David discusses three core functionalities that NextJS excels at, so that you can make a well-informed decision on your project’s major framework.

Read more
View more articles