在Java中,是否可以在Gradle中宣告一個變數?
問題描述
是否可以在Java中宣告一個可用於Gradle的變數?基本上我想在build.gradle中宣告一些vars,然後在構建時得到它(顯然)。就像在C /C++中的pre-processor巨集…
宣告的一個例子就是這樣:
android {
debug {
A_VAR_RETRIEVABLE_IN_JAVA = 42
}
release {
A_VAR_RETRIEVABLE_IN_JAVA = 42+52
}
}
有辦法做這樣的事嗎?
最佳解決方案
生成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
以常規方式訪問它們
次佳解決方案
Android應用程式中的Api應用程式鍵(Java和XML)的使用示例
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" />
第三種解決方案
使用系統屬性的示例,在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
,預計在run-time被設定為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...
”(其中btw僅適用於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
參考文獻
注:本文內容整合自google/baidu/bing輔助翻譯的英文資料結果。如果您對結果不滿意,可以加入我們改善翻譯效果:gxnotes#qq.com(#替換為@)。