Можно ли объявить переменную в Gradle для использования в Java?

Можно ли объявить переменную в Gradle для использования в Java? По сути, я хотел бы объявить некоторые переменные в build.gradle, а затем получить их (очевидно) во время сборки. Так же, как макросы препроцессора в C / C ++ ...

Пример объявления будет что-то вроде этого:

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

Пример использования ключа приложения Api в приложении Android (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" />

• Ссылка на пример использования Api App Key в приложении Android
• Использование строковых констант, сгенерированных конфигурациями Gradle Build

Пример использования системных свойств, установленных в 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), и в файле журнала отображаются результаты (в качестве альтернативы run 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

Вы можете создать поле конфигурации сборки, которое можно переопределить с помощью системных переменных среды во время сборки:

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напрямую, что я и хотел сделать в первую очередь.