Можно ли объявить переменную в Gradle пригодной для использования в Java? В принципе, я хотел бы объявить некоторые vars в build.gradle, а затем получить его (очевидно) во время сборки. Так же, как макросы предварительного процессора в C/С++...
Пример объявления будет таким:...
android {
debug {
A_VAR_RETRIEVABLE_IN_JAVA = 42
}
release {
A_VAR_RETRIEVABLE_IN_JAVA = 42+52
}
}
Есть ли способ сделать что-то подобное?
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 {
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
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" />
Пример использования системных свойств, установленных в 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);
}
}
Testcase: если 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
Для полноты, вот конфигурация журнала (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.gradlesrc/main/java/example/HelloWorld.javasrc/test/java/example/HelloWorldTest.javasrc/test/resources/logback-test.xmlВы можете создать поле конфигурации сборки, которое можно переопределить с помощью системных переменных среды во время сборки:
Fallback используется при разработке, но вы можете переопределить переменную при запуске сборки на 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
Просто хотел бы отметить этот сценарий, если вы хотите общий конфиг.
Я использую этот код и работаю очень хорошо.
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
}
}
}
}
Как вы можете вставить результат String функции в buildConfigField
Вот пример набора даты в удобочитаемом формате:
def getDate() {
return new SimpleDateFormat("dd MMMM yyyy", new Locale("ru")).format(new Date())
}
def buildDate = getDate()
defaultConfig {
buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
я использую
buildTypes.each {
it.buildConfigField 'String', 'GoogleMapsApiKey', "\"$System.env.GoogleMapsApiKey\""
}
Он основан на ответе Денниса, но получает его из переменной окружения.
Ни один из приведенных выше ответов не дал мне никаких указаний, поэтому мне пришлось потратить два часа на изучение Groovy Methods.
Я хотел быть в состоянии пойти против производства, песочницы и местной среды. Поскольку я ленивый, я хотел изменить 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 Methods.
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 напрямую использовать ссылку API_HOST, что я и хотел сделать в первую очередь.