What is the equivalent of Android's BuildConfig in a Java library module?

Question

I am using Android Studio and I have the following modules in my project:

Android application named "app"
Java library named "communication"

In my "app" module's build.gradle file, I can declare variables for the BuildConfig.java file, as follows:

buildTypes {
    release {
        ...
        buildConfigField "String", "SERVER_URL", '"my_url"'
    }
    debug {
        buildConfigField "String", "SERVER_URL", '"my_url"'
    }
}

I can then access these variables using BuildConfig.SERVER_URL.

How do I achieve this in my "communication" module's build.gradle file?

To be clear, are you trying to access BuildConfig values in java library code while running inside an Android app? Do you ever use intend to use this library code outside an Android app? — Doug Stevenson
– Doug Stevenson, Commented Jun 6, 2016 at 17:07

Vojtěch Sázel · Accepted Answer · 2018-01-19 13:19:57Z

6

I think that you are looking for this Gradle plugin. It brings BuildConfig to pure Java module.

https://github.com/mfuerstenau/gradle-buildconfig-plugin

answered Jan 19, 2018 at 13:19

Vojtěch Sázel

5586 silver badges22 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Antonio Over a year ago

Oh, that’s interesting. I’ll try to test it on these days. Cannot do it atm

gmazzo Over a year ago

If you are looking for Kotlin support too, I've made this one: github.com/gmazzo/gradle-buildconfig-plugin

Sundara Raghavan Over a year ago

@gmazzo how to add release and debug flavors of configs?

gmazzo Over a year ago

Multi Flavor/Variants is an Android feature, but you may archieve something simillar by creating two SourceSets, debug and release, and making them extend from the main one. Then you may use my plugin to setup buildConfigFields on them

George Shalvashvili Over a year ago

is there a way to achieve this without a plugin?

Adil Hussain · Accepted Answer · 2022-06-28 14:36:19Z

1

If you search "BuildConfig" in plugins.gradle.org, you will find a number of Gradle plugins which offer this functionality.

The one I used in the past is de.fuerstenau.buildconfig. However, it hasn't been updated for a while (the last release was in February 2017) and it doesn't work so great with Gradle 7+ (see this issue) so I've recently migrated over to using com.github.gmazzo.buildconfig.

answered Jun 28, 2022 at 14:36

Adil Hussain

32.6k24 gold badges127 silver badges170 bronze badges

Comments

Community · Accepted Answer · 2017-05-23 12:31:36Z

0

If by Java library you mean Android module then :

Set buildTypes variables inside the build.gradle file into library module like app module.

Get it by using the correct BuildConfig Class.

my.package.app.BuildConfig.APP_VARIABLE
my.package.library.BuildConfig.LIBRARY_VARIABLE

In other way, maybe you can take a look to gradle task and System Environment this answer can help you https://stackoverflow.com/a/25714617/4681367

There is no other way to get build configuration outside an Android module.

Just set/add an environment variable based on your android BuildConfig variables.

edited May 23, 2017 at 12:31

CommunityBot

11 silver badge

answered Jun 4, 2016 at 20:36

Lionel Briand

1,5652 gold badges14 silver badges27 bronze badges

2 Comments

Antonio Over a year ago

Thanks for your answer, @Lionel. It is not an Android based project-module. It is a Java module that has plugin 'java'

CaptainCrunch Over a year ago

This helped my for Android in this case. A simple Java class that needs a reference from a product flavor. BuildConfig.MYVALUE did the trick. great!

Collectives™ on Stack Overflow

What is the equivalent of Android's BuildConfig in a Java library module?

3 Answers 3

5 Comments

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

5 Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related