BuildConfig not getting created correctly (Gradle Android)

Question

I am trying to convert our Android application to a gradle build. I have the project and it's libraries building successfully. I am now trying to create separate apks for our various environments (dev/test/prod have different urls for the restful services they consume).

In searching around, the best way that I feel to do this is with making different BuildConfig for each environment. This is what I tried:

import java.util.regex.Pattern

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:+'
    }
}

apply plugin: 'android'

task('increaseVersionCode') << {
    def manifestFile = file("AndroidManifest.xml")
    def pattern = Pattern.compile("versionCode=\"(\\d+)\"")
    def manifestText = manifestFile.getText()
    def matcher = pattern.matcher(manifestText)
    matcher.find()
    def versionCode = Integer.parseInt(matcher.group(1))
    def manifestContent = matcher.replaceAll("versionCode=\"" + ++versionCode + "\"")
    manifestFile.write(manifestContent)
}

tasks.whenTaskAdded { task ->
    if (task.name == 'generateReleaseBuildConfig') {
        task.dependsOn 'increaseVersionCode'
    }
}

dependencies {
    compile 'com.android.support:support-v4:19.0.0' 
    compile files('libs/commons-io-2.4.jar',
                  'libs/google-play-services.jar',
                  'libs/gson-2.2.4.jar',
                  'libs/universal-image-loader-1.8.6.jar',
                  'libs/wakeful-1.0.1.jar')
    compile project(':pulltorefresh_lib')
    compile project(':edgeeffect_lib')
    compile project(':viewpagerindicator_lib')        
}

android {
    buildToolsVersion "18.1.1"
    compileSdkVersion "Google Inc.:Google APIs:18"

    defaultConfig { 
       minSdkVersion 14
       targetSdkVersion 18
    }

    buildTypes {
        debug {
            packageNameSuffix ".debug"
        }
        dev.initWith(buildTypes.debug)
        dev {
            buildConfigField "String", "URL_SEARCH", "\"https://dev-search.example.com\";"
            buildConfigField "String", "URL_CONNECT", "\"https://dev-connect.example.com\";"
            buildConfigField "String", "URL_SVC_NEWSLIST", "\"https://dev-mobilenews.example.com/newslist\";"
            buildConfigField "String", "URL_SVC_NEWSDETAIL", "\"https://dev-mobilenews.example.com/newsdetail\";"
            buildConfigField "String", "URL_SVC_REGISTERENDPOINTS", "\"https://dev-mobilenews.example.com/registerendpoints\";"
        }
        prod.initWith(buildTypes.release)
        prod {
            buildConfigField "String", "URL_SEARCH", "\"https://search.example.com\";"
            buildConfigField "String", "URL_CONNECT", "\"https://connect.example.com\";"
            buildConfigField "String", "URL_SVC_NEWSLIST", "\"https://mobilenews.example.com/newslist\";"
            buildConfigField "String", "URL_SVC_NEWSDETAIL", "\"https://mobilenews.example.com/newsdetail\";"
            buildConfigField "String", "URL_SVC_REGISTERENDPOINTS", "\"https://mobilenews.pdc-np-cf.lmig.com/registerendpoints\";"          
        }
    }

    sourceSets {
        main {
            manifest.srcFile 'AndroidManifest.xml'
            java.srcDirs = ['src']
            resources.srcDirs = ['src']
            res.srcDirs = ['res']
            assets.srcDirs = ['assets']
        }
    }
}

The problem is that my BuildConfig.java doesn't seem to get the static variables injected, therefore I get errors similar to:

/Users/path/to/project/MainActivity.java:348: error: cannot find symbol
            startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(BuildConfig.URL_SEARCH)));
                                                                              ^
  symbol:   variable URL_SEARCH
  location: class BuildConfig
/Users/path/to/project/MainActivity.java:359: error: cannot find symbol
            startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(BuildConfig.URL_CONNECT)));
                                                                              ^
  symbol:   variable URL_CONNECT
  location: class BuildConfig
/Users/path/to/project/MainActivity.java:600: error: cannot find symbol
            HttpPost httpPost = new HttpPost(BuildConfig.URL_SVC_REGISTERENDPOINTS);
                                                        ^
  symbol:   variable URL_SVC_REGISTERENDPOINTS
  location: class BuildConfig
/Users/path/to/project/service/AlarmNotificationService.java:145: error: cannot find symbol
        String requestUrl = BuildConfig.URL_SVC_NEWSLIST + "?"
                                       ^
  symbol:   variable URL_SVC_NEWSLIST
  location: class BuildConfig
/Users/path/to/project/service/NewsService.java:240: error: cannot find symbol
        String requestUrl = BuildConfig.URL_SVC_NEWSLIST + "?"
                                       ^
  symbol:   variable URL_SVC_NEWSLIST
  location: class BuildConfig
/Users/path/to/project/service/NewsService.java:530: error: cannot find symbol
            HttpPost httpPost = new HttpPost(BuildConfig.URL_SVC_NEWSDETAIL);
                                                        ^
  symbol:   variable URL_SVC_NEWSDETAIL
  location: class BuildConfig
6 errors

My build/source/buildConfig/debug/com/.../BuildConfig.java file contains:

/**
 * Automatically generated file. DO NOT MODIFY
 */
package com....;

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String PACKAGE_NAME = "com.....debug";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 5;
}

What am I doing wrong?

Might make sense to remove those Liberty references. Not that there's any critical code here, but it's best to avoid sharing proprietary code on StackOverflow ;) — antonpug, May 30 '14 at 18:27
see below link: http://stackoverflow.com/questions/22604627/gradle-buildconfigfield-buildconfig-cannot-resolve-symbol — Michael, Jun 27 '16 at 09:29
Check answer here https://stackoverflow.com/questions/22604627/gradle-buildconfigfield-buildconfig-cannot-resolve-symbol — Muhammad Noman, Oct 04 '18 at 12:49

score 75 · Accepted Answer · edited Nov 19 '15 at 03:40

75

Please, be sure that you are building "dev" or "prod" variant. There is no BuildConfig definition in default "debug" and "release" variant. In Android Studio, you can select current variant in bottom left corner:

Build Variants

To simplify your build.gradle file, you can define:

buildTypes {
    debug {
        buildConfigField "String", "URL_SEARCH", "\"https://dev-search.example.com\""
        // etc.
    }
    release {
        buildConfigField "String", "URL_SEARCH", "\"https://search.example.com\""
        // etc.      
    }
}

and then just use default "debug" and "release" variants.

At last, delete semicolon (sign: ';') from the value of buildConfigField parameter.

edited Nov 19 '15 at 03:40

Youngjae

22,962
17
106
189

answered Dec 20 '13 at 16:06

Peter Knut

1,981
18
15

Thanks...it was me being daft, as I expected. "gradle installDev" works fine...."gradle build" was giving me errors. – Innova Dec 20 '13 at 16:19
6

you can also go like this `buildConfigField 'String', 'URL_SEARCH', '"https://search.example.com"'` – Androiderson Jul 03 '15 at 23:03
I want to add that you might require to rebuild the project (`Build` -> `Rebuild Project`) when changing the active build variant else the `BuildConfig` will not be regenerated. – acarlstein Sep 14 '21 at 20:52

savepopulation · Answer 2 · 2015-11-18T11:38:47.467

56

I had same issue and fixed it like below:

buildConfigField 'String', 'BASE_URL', '"https://api.example.com"'

edited Nov 18 '15 at 11:38

answered Oct 22 '15 at 13:40

savepopulation

11,248
4
53
71

6

for `String`, double-quotation does NOT generate properly. only single-quotation generates variable successfully. – Youngjae Nov 19 '15 at 05:02
2

For those like me who missed it the first time, the key part is that the value is in double-quotes inside of the single-quotes. – speckledcarp Dec 30 '16 at 20:34

score 44 · Answer 3 · answered Apr 09 '20 at 06:08

44

first do

File -> Invalidate Caches/Restart... -> Invalidate and Restart

then do

Build -> Clean Project

then do

Build - > Rebuild Project

answered Apr 09 '20 at 06:08

Mirza Ahmed Baig

4,845
1
20
37

1

After doing this Gradle finally reported that the minimum SDK of one of the libraries used is higher than the apps minsdk – Mars Aug 29 '20 at 22:43
1

confirm, it worked – vuhung3990 Sep 20 '21 at 05:10
2

Hurray ! It works! Thank you @Mirza Ahmed – Avramo Jan 17 '22 at 13:54

score 22 · Answer 4 · answered Jul 27 '15 at 20:20

22

Just in case that helps somebody else, in my case it was a missing import: import uk.co.yourpackage.yourapp.BuildConfig;

Somehow, nowhere in the doc does it mention you need that include! Made me think it was automatically imported somehow but it ISN'T. not for me at least... So much time lost... Hope that helps another newbie like me!

answered Jul 27 '15 at 20:20

Litome

603
8
12

1

Amazing , it was import problem, I was import from android.support.v4.BuildConfig Thank you :) – Tarek El-Mallah Apr 10 '17 at 18:55
I had "org.koin.android" imported by accident and it has its own BuildConfig for some reason. Thank you for this comment, it reminded me to manually check the import! – Stylianos Gakis Feb 25 '21 at 23:58

score 13 · Answer 5 · edited Apr 18 '20 at 10:14

13

Try to do

Build -> Clean Project

then do

Build - > Rebuild Project

If it doesn't work, try

File -> Invalidate Caches/Restart... -> Invalidate and Restart

then do

Build -> Clean Project

then do

Build - > Rebuild Project

edited Apr 18 '20 at 10:14

Mustafa

4,870
3
23
37

answered Apr 18 '20 at 05:37

Rifat

147
2
4

Clean and rebuild should work - worked for me. – srinij Jan 12 '21 at 03:11

score 4 · Answer 6 · answered Feb 20 '19 at 21:19

4

Here is what fixed this for me:

File -> Invalidate Caches/Restart... -> Invalidate and Restart

answered Feb 20 '19 at 21:19

bartonstanley

1,075
12
25

score 4 · Answer 7 · answered Mar 13 '20 at 20:15

4

If you are modifying your Environment Variables, and they are not reflecting correctly in Android studio try doing:

Build -> Clean Project 
File -> Invalidate Caches/Restart... -> Invalidate and Restart

answered Mar 13 '20 at 20:15

Jmz

149
7

score 4 · Answer 8 · edited Mar 12 '21 at 08:14

4

I solve this problem as given below in this case Android studio will generate Build Config file itself

File -> Sync Project with Gradle Files

edited Mar 12 '21 at 08:14

Community

1
1

answered Dec 23 '20 at 03:42

ibrokhim

61
3

This one helped me – Neo Raiden X Apr 20 '21 at 06:48
work for me . thanks!! (android studio 2020.03.01 patch.3 ) – SamanSepahvand Nov 10 '21 at 06:55

score 1 · Answer 9 · answered Jul 09 '19 at 08:12

1

In the project.ext.envConfigFiles array, ensure you set the debug to the right .env file you are using for development

answered Jul 09 '19 at 08:12

chisom onwuegbuzie

399
3
5

score 1 · Answer 10 · answered Oct 24 '20 at 05:53

I did all the things in the answers but still didn't work. I solved my problem by changing the package name in the manifest.xml file which still hadn't been updated :

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="com.example.android">

score 1 · Answer 11 · edited Oct 27 '21 at 11:29

1

After trying everything, switching the build variant and selecting Build > Make Project worked for me.

edited Oct 27 '21 at 11:29

Dharman

26,923
21
73
125

answered Oct 27 '21 at 11:23

ravi

832
7
29

score 0 · Answer 12 · answered Apr 27 '15 at 00:56

I had similar problem related to build types being setup using .initWith(someotherbuildtype), BuildConfig was not being created properly. I had to switch to the parent build variant and build that first, then the build types that initWith the parent built fine.

score 0 · Answer 13 · answered Jul 29 '21 at 12:01

0

In my case, I was expecting the BuildConfig for my new gradle module created. But forgot to add it as a dependency in app: module.

answered Jul 29 '21 at 12:01

cgr

4,532
2
27
50

score 0 · Answer 14 · answered Feb 08 '22 at 13:00

In my case there was an string field resValue "string", "app_name", "MyApp" in strings.xml as well as in product flavours.

I did Invalidate Caches then Rebuild then android studion given the actual error of duplicate resources.

so Invalidate caches -> Rebuild -> Remove string resources which were already in buildconfigfield resvalue worked for me

I was using Android Studio Bumblebee 2021.1.1

BuildConfig not getting created correctly (Gradle Android)

14 Answers14

Linked