是否可以在 Gradle 中声明一个变量在 Java 中可用?

Is it possible to declare a variable in Gradle usable in Java?

提问人:klefevre 提问时间:6/20/2013 最后编辑:Mahozadklefevre 更新时间:11/8/2023 访问量:187178

问:

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

声明的一个例子是这样的......

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

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

java android gradle android-gradle-plugin build.gradle

评论

0赞 Ric17101 3/22/2021
stackoverflow.com/a/65624195/3970630

答:

869赞 rciovati 6/20/2013 #1

这里有两种方法可以将 Gradle 中的值传递给 Java 使用;

生成 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_nameR.string.app_name

评论

6赞 rciovati 3/15/2014
不,但您也可以生成资源。我已经更新了我的答案,包括那个。
2赞 elimirks 3/17/2014
太棒了,谢谢。我发现的一点很好,您可以为调试和发布版本指定备用目录。在 中,如果创建文件和另一个文件,也可以以稍微简洁的方式为调试和发布版本设置资源。<project>/src/debug/res/values/strings.xmlrelease/res/values/strings.xml
8赞 Zennichimaro 5/26/2014
@rciovati没有插件可以实现相同的目的?即只是使用?谢谢!androidapply plugin java
3赞 Jakob Eriksson 2/2/2015
如何为不同的构建风格和构建类型创建常量?
3赞 android developer 9/27/2016
是否可以将其中一个字段设置为当前年份,并且无论选择哪种构建类型(发布、调试等)都可以到达它?
33赞 michael 9/8/2014 #2

使用系统属性的示例,在 build.gradle 中设置,从 Java 应用程序读取(跟进评论中的问题):

基本上,使用 中的任务,测试任务方法设置在运行时传递的系统属性:testbuild.gradlesystemProperty

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-VAR1VALUE-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),日志文件显示结果(或者,运行;还有一些属性可以将stdout发送到控制台,但是,你知道,为什么):gradle --info cleanTest test

$ 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

评论

1赞 michael 9/8/2014
请注意,这是对已接受答案中评论的直接响应,因此它与原始问题略有偏差。
2赞 Nom1fan 7/25/2016
我可以以某种方式通过 Java 代码获取吗?version = '0.0.1-SNAPSHOT'
0赞 Stoycho Andreev 9/29/2018
SystemProperty 仅在 gradle 测试任务:(中可用。有人知道在库的 java 代码中使用 gradle 变量值的任何其他方法吗?
0赞 michael 10/4/2018
systemProperty真的只对测试有意义,所以我明白他们为什么这样做(这不是疏忽),但与此同时,我也尝试将 gradle 用于它不打算用于的东西(例如应用程序 DSL),以便我可以识别。作为替代方案,我建议只从属性文件(或配置服务等)加载属性,因为如果它不在“测试”模式下,那么它就是“生产”模式,需要应用程序逻辑。(反正就是这个理论。
129赞 Denis 2/26/2016 #3

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

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" />

评论

1赞 Jaswanth Manigundan 5/5/2017
如果我可以补充,这个变量也可以在运行时传递。在运行具有不同配置的测试时最有用。用./gradlew -PAppKey="1234" testdebug
1赞 rciovati 10/20/2018
若要为每个生成类型声明相同的属性,也可以使用该块:stackoverflow.com/a/51521146/321354defaultConfig
0赞 voghDev 5/26/2020
你有XML部分的工作示例吗?在 Github 存储库或 Gist 中。它对我不起作用,我无法参考@string/APP_KEY_2
16赞 Boris Treukhov 3/14/2017 #4

您可以在构建期间创建可通过系统环境变量覆盖的构建配置字段:

在开发时会使用回退,但在 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

评论

1赞 Wayne Piekarski 11/11/2017
谢谢你的回答!我一直在尝试研究如何让环境变量从 Android .java 文件中可见,这效果很好!
0赞 android_dev 12/26/2018
如果你想定义布尔变量,你应该使用 buildConfigField “boolean”, “CI_BUILD”, “${isCi}” 或 buildConfigField “boolean”, “CI_BUILD”, “Boolean.parseBoolean(” + '“' + isCi + '”' + “)” 如果你想逃避 lint 检查 (stackoverflow.com/questions/29889098/...)
15赞 s.pike 7/25/2018 #5

rciovati 的回答是完全正确的:我只是想再添加一个花絮,您还可以在 build.gradle 的默认配置部分为每种构建类型创建变量。这看起来像这样:

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

这将允许您通过访问

BuildConfig.App_NAME

如果您想要一个通用配置,也想记下这种情况。

3赞 Marc 10/22/2018 #6

我正在使用

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

它基于 Dennis 的答案,但从环境变量中获取它。

4赞 Hitesh sapra 11/1/2018 #7

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

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
    }
 }
}

}

评论

0赞 niclas_4 11/1/2018
如果您指定您修改的内容及其影响,从而产生您的工作解决方案,那就太好了。
3赞 anil 2/8/2019 #8

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

下面是人类可读格式集的构建日期示例:

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

def buildDate = getDate()

defaultConfig {
    buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
4赞 Rickard Elimää 6/24/2019 #9

以上答案都没有给我任何指导,所以我不得不花两个小时学习 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"
        }
    }

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

    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

2赞 Rahul Shyokand 2/8/2021 #10

https://stackoverflow.com/a/17201265/12021422答案 @rciovati作品

但请确保重新构建项目,以便能够从 Android Studio IDE 中删除错误

我花了 30 分钟试图弄清楚为什么无法访问新的属性变量。

如果标有红色的“制作项目”不起作用,请尝试使用标有绿色的“重建项目”按钮。

enter image description here

3赞 Mahozad 1/26/2022 #11

这适用于 Kotlin DSL (build.gradle.kts) 在 Java 和 Kotlin 中均可用:

buildTypes {
    getByName("debug") { // or simply  debug {  in newer version of Android Gradle Plugin (AGP)
        buildConfigField("Boolean", "isHappy", "true")
        buildConfigField("String", "favoriteSong", """"Black Forest"""")
        resValue("string", "myName", "Bunny")
    }
}