CODEWITHSUNDEEP
androidandroid-gradle-plugin
Abdullah
Abdullah

Reputation: 7233

How to generate buildConfigField with String type

In my Android Studio project there are two build configuration with some buildConfigField:

    buildTypes {
    def SERVER_URL = "SERVER_URL"
    def APP_VERSION = "APP_VERSION"

    debug {
        buildConfigField "String", SERVER_URL, "http://dev.myserver.com"
        buildConfigField "String", APP_VERSION, "0.0.1"
    }

    release {
        buildConfigField "String", SERVER_URL, "https://myserver.com"
        buildConfigField "String", APP_VERSION, "0.0.1"

        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

I am getting and error as follows:

/path/to/generated/BuildConfig.java
    Error:(14, 47) error: ';' expected
    Error:(15, 47) error: ';' expected

the generated BuildConfig.java is as follows:

public final class BuildConfig {
    public static final boolean DEBUG = Boolean.parseBoolean("true");
    public static final String APPLICATION_ID = "com.mycuteoffice.mcoapp";
    public static final String BUILD_TYPE = "debug";
    public static final String FLAVOR = "";
    public static final int VERSION_CODE = 1;
    public static final String VERSION_NAME = "1.0";
    // Fields from build type: debug
    public static final String APP_VERSION = 0.0.1;
    public static final String SERVER_URL = http://dev.mycuteoffice.com;
}

I think the APP_VERSION and SERVER_URL are not getting generated properly as being String type they do not have quotes.

I am not sure why it is being generated in such a way. Please let me know how can I resolve this issues.

Upvotes: 219

Views: 148427

Answers (13)

Shamivul ruvaid
Shamivul ruvaid

Reputation: 121

All the answers are groovy.

In .kts format it looks something like this

buildConfigField("String", "SERVER_URL", ""http://dev.myserver.com"")

Upvotes: 4

superjos
superjos

Reputation: 12725

I preferred to highlight that some of those values were strings. At the same time I was not really keen on the escaped quotes for readability reasons.

It might look a little naive, but in the end I settled for this alternative:

buildConfigField "String", "LIB_VERSION_NAME", '"' + "${versionName}" + '"'

and the outcome can look like this:

enter image description here

Upvotes: 2

Trang Đỗ
Trang Đỗ

Reputation: 180

Need have def variable

debug {
    ...
    def myVersion = '1.0.0'
    buildConfigField 'String', 'TEST', "\"${myVersion}\""
}

Upvotes: 0

Urvish Shiroya
Urvish Shiroya

Reputation: 674

  1. write code in gradle.properties
YOUR_ACCESS_PARAMS = "YOUR_VALUE"
  1. write code into app level build.gradle
android{
    ...
     buildTypes.each{
        it.buildConfigField 'String', 'ACCESS_PARAMS', YOUR_ACCESS_PARAMS
    }
}
  1. the generated BuildConfig.java is as follows:
public final class BuildConfig {  
    public static final boolean DEBUG = Boolean.parseBoolean("true");   
    public static final String APPLICATION_ID = "xxx.xxxxxxxx.xxx";   
    public static final String BUILD_TYPE = "debug";  
    public static final String FLAVOR = "";  
    public static final int VERSION_CODE = 1;  
    public static final String VERSION_NAME = "1.0.0";  
    // Fields from build type: debug  
    public static final String ACCESS_PARAMS = "YOUR_VALUE";  
}

Upvotes: 4

Gugelhupf
Gugelhupf

Reputation: 970

I need the variable in buildConfigField and manifestPaceholder. To solve this I do

def appAuthScheme= "appauth.myscheme"
buildConfigField 'String', 'APP_AUTH_SCHEME',"\"$appAuthScheme\""

manifestPlaceholders = [lowerApplicationId : applicationId.toLowerCase(),
                        appAuthRedirectScheme : appAuthScheme]

BuildConfig.APP_AUTH_SCHEME is a String !

Upvotes: 1

cesards
cesards

Reputation: 16339

We should scape our Gradle constant defined in our Gradle properties or somewhere else:

buildConfigField "String", "CONSTANT_NAME", "\"${CONSTANT_VALUE}\""

Where CONSTANT_VALUE is defined in our gradle.properties or somewhere else:

CONSTANT_VALUE=string_goes_here

It applies the same way when getting constants gotten from our environment:

buildConfigField "String", "CONSTANT_NAME", "\"${System.getenv('PATH')}\""

The most voted solution works in case we just need to add a String manually, this solution just goes a step further.

Upvotes: 5

yitai wei
yitai wei

Reputation: 91

in app build.gradle

def buildTimeAndVersion = releaseTime() + "-" + getSvnVersion()    
buildTypes {
debug {
    signingConfig signingConfigs.config
    buildConfigField "String", 'BIULD_TIME', "\"${buildTimeAndVersion}\""
    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}
...
}

static def releaseTime() {
return new Date().format("yyyyMMdd", TimeZone.getDefault())
}

def getSvnVersion() {
def pro = ("svnversion -c " + getBuildDir().parent).execute()
pro.waitFor()
def version = pro.in.text
Pattern p = Pattern.compile("(\\d+\\:)?(\\d+)\\D?")
Matcher m = p.matcher(version)
if (m.find()) {
version = m.group(m.groupCount())
}
try {
return version
} catch (e) {
println e.getMessage()
}
return 0
}

then in BuildConfig

public final class BuildConfig {  
public static final boolean DEBUG = Boolean.parseBoolean("true");   
public static final String APPLICATION_ID = "xxx.xxxxxxxx.xxx";   
public static final String BUILD_TYPE = "debug";  
public static final String FLAVOR = "";  
public static final int VERSION_CODE = 53;  
public static final String VERSION_NAME = "5.4.4";  
// Fields from build type: debug  
public static final String BIULD_TIME = "20181030-2595";  
}

Upvotes: 1

Vladyslav Matviienko
Vladyslav Matviienko

Reputation: 10881

String type build config fields should be declared like this:

buildConfigField "String", "SERVER_URL", "\"http://dev.myserver.com\""

the field name in quotes, the field value in escaped quotes additionally.

Upvotes: 356

Adolf Dsilva
Adolf Dsilva

Reputation: 14370

Use

 buildConfigField "String", "FILE_NAME", "\"{$fileName}\""

for variable. Reference from here

Upvotes: 19

Primexx
Primexx

Reputation: 431

If by "resolving the issues" you mean not having to double quote literals, I haven't come across anything as it seems to be working as designed.

I've been experimenting with moving the literals into "gradle.properties" as a workaround, turning potentially multiple ugly lines into one ugly line.

Like so:

buildTypes {
def SERVER_URL = "SERVER_URL"
def APP_VERSION = "APP_VERSION"

def CONFIG = { k -> "\"${project.properties.get(k)}\"" }

debug {
    buildConfigField "String", SERVER_URL, CONFIG("debug.server.url")
    buildConfigField "String", APP_VERSION, CONFIG("version")
}

release {
    buildConfigField "String", SERVER_URL, CONFIG("release.server.url")
    buildConfigField "String", APP_VERSION, CONFIG("version")

    minifyEnabled false
    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}

gradle.properties

version=0.1.1
...
debug.server.url=http://dev.myserver.com
...
release.server.url=http://myserver.com
...

Further thoughts:

def CONFIG = { b,k -> "\"${project.properties.get(b+'.'+k)}\"" }
def CONFIG_DEBUG = { k -> CONFIG('debug',k) }
def CONFIG_RELEASE = { k -> CONFIG('release',k) }

def CONFIG = { b,k -> "\"${project.properties.get(b+'.'+k)}\"" }
def CONFIG_INT = { b,k -> "${project.properties.get(b+'.'+k)}" }
...

Upvotes: 43

madhead
madhead

Reputation: 33441

Why everybody is so mad about escaping double quotes? Looks ugly! This is Groovy, guys, you can just mix single and double quotes:

buildConfigField "String", 'SERVER_URL', '"http://dev.myserver.com"'
buildConfigField "String", 'APP_VERSION', '"0.0.1"'

Upvotes: 128

Simas
Simas

Reputation: 44158

Escape your string quotes:

buildConfigField "String", 'SERVER_URL', "\"http://dev.myserver.com\""
buildConfigField "String", 'APP_VERSION', "\"0.0.1\""

Upvotes: 12

geiger
geiger

Reputation: 783

I was confused as well. But there is a sense - "String" defines the field's type, whereas the field value isn't get quoted automatically in order to allow us to use expressions here:

buildConfigField "String", "TEST", "new Integer(10).toString()"

Otherwise, it wouldn't be possible.

Upvotes: 10

Related Questions