是否可以在Gradle中声明一个可在Java中使用的变量？

417

是否可以在Gradle中声明一个可在Java中使用的变量？基本上，我想在build.gradle中声明一些var，然后在构建时（显然）获取它。就像C / C ++中的预处理器宏一样...

声明的示例可能是这样的...：

android {
    debug {
        A_VAR_RETRIEVABLE_IN_JAVA = 42
    }
    release {
        A_VAR_RETRIEVABLE_IN_JAVA = 42+52
    }
}

有没有办法做这样的事情？

java  android  gradle  android-gradle-plugin 
— 克莱夫夫尔
source

Answers:

796

生成Java常量

android {
    buildTypes {
        debug {
            buildConfigField "int", "FOO", "42"
            buildConfigField "String", "FOO_STRING", "\"foo\""
            buildConfigField "boolean", "LOG", "true"
        }

        release {
            buildConfigField "int", "FOO", "52"
            buildConfigField "String", "FOO_STRING", "\"bar\""
            buildConfigField "boolean", "LOG", "false"
        }
    }
}

您可以使用 BuildConfig.FOO

生成Android资源

android {
    buildTypes {
        debug{
            resValue "string", "app_name", "My App Name Debug"
        }
        release {
            resValue "string", "app_name", "My App Name"
        }
    }
}

您可以使用@string/app_name或以通常的方式访问它们R.string.app_name

— 乔瓦蒂
source
4
不，但是您也可以生成资源。我已经更新了我的答案。
— rciovati 2014年
2
很好，谢谢。我发现的一件好事就是您可以为调试和发布版本指定备用目录。在中<project>/src/，如果您创建该文件debug/res/values/strings.xml和另一个文件release/res/values/strings.xml，则可以设置调试资源，并以一种更简洁的方式发布版本。
— elimirks 2014年
6
@rciovati是否可以在没有android插件的情况下实现相同的效果？即只是使用apply plugin java？谢谢！
— Zennichimaro 2014年
2
如何为不同的构建风格和构建类型创建常量？
— 雅各布·埃里克森
3
是否可以将其中一个字段设置为当前年份，并且无论选择哪种构建类型（发布，调试等），也可以将其设置为当前年份？
— Android开发人员
102

在Android应用程序（Java和XML）中使用Api应用程序密钥的示例

gradle.properties

AppKey="XXXX-XXXX"

build.gradle

buildTypes {
//...
    buildTypes.each {
        it.buildConfigField 'String', 'APP_KEY_1', AppKey
        it.resValue 'string', 'APP_KEY_2', AppKey
    }
}

Java代码中的用法

Log.d("UserActivity", "onCreate, APP_KEY: " + getString(R.string.APP_KEY_2));

BuildConfig.APP_KEY_1

xml代码中的用法

<data android:scheme="@string/APP_KEY_2" />
— 丹尼斯
source
1
如果可以的话，也可以在运行时传递此变量。在运行具有不同配置的测试时最有用。使用./gradlew -PAppKey="1234" testdebug
— Jaswanth Manigundan
1
要为每种构建类型声明相同的属性，您也可以使用该defaultConfig块：stackoverflow.com/a/51521146/321354
— rciovati
您有XML部分的有效示例吗？在Github存储库或Gist中。它对我不起作用，我无法参考@string/APP_KEY_2
— voghDev
32

使用build.gradle中设置的系统属性示例，从Java应用程序中读取（紧跟注释中的问题）：

基本上，使用中的test任务build.gradle以及测试任务方法来systemProperty设置在运行时传递的系统属性：

apply plugin: 'java'
group = 'example'
version = '0.0.1-SNAPSHOT'

repositories {
    mavenCentral()
    // mavenLocal()
    // maven { url 'http://localhost/nexus/content/groups/public'; }
}

dependencies {
    testCompile 'junit:junit:4.8.2'
    compile 'ch.qos.logback:logback-classic:1.1.2'
}

test {
  logger.info '==test=='
  systemProperty 'MY-VAR1', 'VALUE-TEST'
}

这是其余的示例代码（您可能可以推断出，但无论如何都包含在此处）：它获得了一个系统属性MY-VAR1，在运行时期望将其设置为VALUE-TEST：

package example;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  static final Logger log=LoggerFactory.getLogger(HelloWorld.class);
  public static void main(String args[]) {
    log.info("entering main...");
    final String val = System.getProperty("MY-VAR1", "UNSET (MAIN)");
    System.out.println("(main.out) hello, world: " + val);
    log.info("main.log) MY-VAR1=" + val);
  }
}

测试用例：如果MY-VAR未设置，则测试应失败：

package example;
...
public class HelloWorldTest {
    static final Logger log=LoggerFactory.getLogger(HelloWorldTest.class);
    @Test public void testEnv() {
        HelloWorld.main(new String[]{});
        final String val = System.getProperty("MY-VAR1", "UNSET (TEST)");
        System.out.println("(test.out) var1=" + val);
        log.info("(test.log) MY-VAR1=" + val);
        assertEquals("env MY-VAR1 set.", "VALUE-TEST", val);
    }
}

运行（注意：测试通过）：

$ gradle cleanTest test
:cleanTest
:compileJava UP-TO-DATE
:processResources UP-TO-DATE
:classes UP-TO-DATE
:compileTestJava UP-TO-DATE
:processTestResources UP-TO-DATE
:testClasses UP-TO-DATE
:test

BUILD SUCCESSFUL

我发现棘手的部分实际上是从gradle获取输出...因此，在此处配置了日志记录（slf4j + logback），日志文件显示了结果（或者运行gradle --info cleanTest test；也有一些属性可以将stdout发送到控制台，但是，为什么？）：

$ cat app.log
INFO Test worker example.HelloWorld - entering main...
INFO Test worker example.HelloWorld - main.log) MY-VAR1=VALUE-TEST
INFO Test worker example.HelloWorldTest - (test.log) MY-VAR1=VALUE-TEST

如果您注释掉“ systemProperty...”（顺便说一句，它仅在test任务中起作用），则：

example.HelloWorldTest > testEnv FAILED
    org.junit.ComparisonFailure at HelloWorldTest.java:14

为了完整起见，这是logback配置（src/test/resources/logback-test.xml）：

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>app.log</file>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d %p %t %c - %m%n</pattern>
        </layout>
 </appender>
 <root level="info">
     <appender-ref ref="FILE"/>
</root>
</configuration>

档案：

  • build.gradle
  • src/main/java/example/HelloWorld.java
  • src/test/java/example/HelloWorldTest.java
  • src/test/resources/logback-test.xml
— 迈克尔
source
请注意，这是对已接受答案中评论的直接回应，因此与原始问题略有不同。
— 迈克尔
2
我可以version = '0.0.1-SNAPSHOT'通过Java代码获得某种方式吗？
— Nom1fan 2016年
SystemProperty仅在gradle测试任务中可用:( ..有人知道在库的Java代码中具有gradle变量值的任何其他方法吗？
— Stoycho Andreev 18/09/29
systemProperty确实只对测试有意义，所以我明白了他们为什么要这样做（这不是疏忽），但与此同时，我也尝试将gradle用于并非旨在进行的工作（例如应用程序DSL） ），这样我就可以识别。另外，我建议仅从属性文件（或配置服务等）中加载属性，因为如果未处于“测试”模式，则处于“生产”模式，并且需要应用程序逻辑。（无论如何，这都是理论。）
— 迈克尔
14

您可以在构建过程中通过系统环境变量创建可覆盖的构建配置字段：

在开发过程中会使用回退，但是在Jenkins或其他工具上运行构建时，您可以覆盖变量。

在您的应用程序build.gradle中：

buildTypes {
        def serverUrl =  '\"' + (System.getenv("SERVER_URL")?: "http://default.fallback.url.com")+'\"'
        debug{
            buildConfigField "String", "SERVER_URL", serverUrl
        }
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            buildConfigField "String", "SERVER_URL", serverUrl
        }
    }

该变量将以形式提供BuildConfig.SERVER_URL。

— 鲍里斯·特鲁霍夫（Boris Treukhov）
source
1
感谢您的回答！我一直在尝试找出如何从Android .java文件中看到环境变量的方法，这很好用！
— 韦恩·彼得卡斯基
如果要定义布尔变量，则应使用buildConfigField“ boolean”，“ CI_BUILD”，“ $ {isCi}”或buildConfigField“ boolean”，“ CI_BUILD”，“ Boolean.parseBoolean（” +'“'+ isCi +' “” + “）”如果你想逃避检查皮棉（stackoverflow.com/questions/29889098/...）
— android_dev
5

rciovati的答案是完全正确的，我只是想再添加一个提示，您也可以在build.gradle的默认配置部分内为每种构建类型创建变量。看起来像这样：

android {
    defaultConfig {
        buildConfigField "String", "APP_NAME", "\"APP_NAME\""
    }
}

这将使您可以通过访问

BuildConfig.App_NAME

如果您想要通用配置，也只想记下这种情况。

— 穗
source
3

我正在使用此代码，并且工作得很好。

def baseUrl = '\"http://patelwala.com/myapi/"'
def googleServerKey = '\"87171841097-opu71rk2ps35ibv96ud57g3ktto6ioio.apps.googleusercontent.com"'
android {
  buildTypes {
  release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id', googleServerKey
    }
    releasedebug {
        initWith debug
        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id' ,googleServerKey
    }
    debug {

        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id', googleServerKey
    }
 }
}

}

— Hitesh sapra
source
如果您指定修改的内容以及它所带来的影响，从而产生有效的解决方案，那将是很好的。
— Badgy
2

如何将字符串的函数结果插入buildConfigField

这是一个易于理解的格式设置日期示例：

def getDate() {
    return new SimpleDateFormat("dd MMMM yyyy", new Locale("ru")).format(new Date())
}

def buildDate = getDate()

defaultConfig {
    buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
— 阿尼尔
source
1

我在用着

buildTypes.each {
    it.buildConfigField 'String', 'GoogleMapsApiKey', "\"$System.env.GoogleMapsApiKey\""
}

它基于丹尼斯的答案，但从环境变量中获取。

— 渣
source
0

上述答案都没有给我任何指导，因此我不得不花两个小时来学习Groovy方法。

我希望能够与生产环境，沙箱环境和本地环境相抵触。因为我很懒，所以我只想在一个地方更改URL。这是我想出的：

 flavorDimensions 'environment'
    productFlavors {
        production {
            def SERVER_HOST = "evil-company.com"
            buildConfigField 'String', 'API_HOST', "\"${SERVER_HOST}\""
            buildConfigField 'String', 'API_URL', "\"https://${SERVER_HOST}/api/v1/\""
            buildConfigField 'String', 'WEB_URL', "\"https://${SERVER_HOST}/\""
            dimension 'environment'
        }
        rickard {
            def LOCAL_HOST = "192.168.1.107"
            buildConfigField 'String', 'API_HOST', "\"${LOCAL_HOST}\""
            buildConfigField 'String', 'API_URL', "\"https://${LOCAL_HOST}/api/v1/\""
            buildConfigField 'String', 'WEB_URL', "\"https://${LOCAL_HOST}/\""
            applicationIdSuffix ".dev"
        }
    }

替代语法，因为您只能${variable}在Groovy方法中使用双引号。

    rickard {
        def LOCAL_HOST = "192.168.1.107"
        buildConfigField 'String', 'API_HOST', '"' + LOCAL_HOST + '"'
        buildConfigField 'String', 'API_URL', '"https://' + LOCAL_HOST + '/api/v1/"'
        buildConfigField 'String', 'WEB_URL', '"https://' + LOCAL_HOST + '"'
        applicationIdSuffix ".dev"
    }

我很难理解的是，字符串需要声明为带引号的字符串。由于该限制，我不能API_HOST直接使用引用，而这正是我最初想要做的。

— 里卡德·埃利马（RickardElimää）
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.