有可能在Gradle中声明一个变量在Java中可用吗?

小开

最佳答案

这里有两种方法从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_name或R.string.app_name来访问它们

小开

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

基本上，使用build.gradle中的test任务，测试任务方法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

小开

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

Android应用程序中Api App Key使用示例链接

使用Gradle Build Configurations生成的字符串常量

小开

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

在开发时使用回退，但是在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可用。

小开

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

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

这将使你有机会通过

BuildConfig.App_NAME

如果你想要一个通用的配置，我想把这个场景也记下来。

小开

我使用

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

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

小开

我正在使用这段代码，工作得很好。

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

｝

小开

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

下面是一个以人类可读格式设置的构建日期示例:

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


def buildDate = getDate()


defaultConfig {
buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}

小开

上面的答案都没有给我任何指导，所以我不得不花两个小时学习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，这是我首先想做的。

小开

https://stackoverflow.com/a/17201265/12021422回答@rciovati工作

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

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

如果“Make project”;如显示为红色，则不能正常工作，请尝试“重建项目”;按钮为绿色标记。

小开

这是在Java和Kotlin中都可用的芬兰湾的科特林DSL (build.gradle.kts):

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", "Lind")
}
}