是否可以在Gradle中声明一个在Java中可用的变量?
是否可以在Gradle中声明一个在Java中可用的变量? 基本上,我想在build.gradle中声明一些变量,然后(显然)在构建时得到它。就像C/C++中的预处理器宏一样 声明的一个例子是这样的…:是否可以在Gradle中声明一个在Java中可用的变量?,java,android,gradle,android-gradle-plugin,Java,Android,Gradle,Android Gradle Plugin,是否可以在Gradle中声明一个在Java中可用的变量? 基本上,我想在build.gradle中声明一些变量,然后(显然)在构建时得到它。就像C/C++中的预处理器宏一样 声明的一个例子是这样的…: android { debug { A_VAR_RETRIEVABLE_IN_JAVA = 42 } release { A_VAR_RETRIEVABLE_IN_JAVA = 42+52 } } 有没有这样的方法?这里有两种方法可
android {
debug {
A_VAR_RETRIEVABLE_IN_JAVA = 42
}
release {
A_VAR_RETRIEVABLE_IN_JAVA = 42+52
}
}
有没有这样的方法?这里有两种方法可以将Gradle的值传递到Java中使用 生成Java常量 您可以使用
BuildConfig.FOO
生成Android资源
您可以通过
@string/app\u name
或R.string.app\u 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);
}
}
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获得输出。。。因此,这里配置了日志记录(slf4j+logback),日志文件显示结果(或者,运行gradle--info cleanTest test
;还有一些属性可以将stdout发送到控制台,但是,您知道,为什么会这样):
如果您注释掉“systemProperty…
”(顺便说一句,它只在测试任务中有效),那么:
为了完整起见,这里是logback配置(src/test/resources/logback test.xml
):
app.log
%d%p%t%c-%m%n
档案:
build.gradle
src/main/java/example/HelloWorld.java
src/test/java/example/HelloWorldTest.java
src/test/resources/logback test.xml
在Android应用程序(Java和XML)中使用Api应用程序密钥的示例
格拉德尔酒店
格雷德尔先生
java代码中的用法
xml代码中的用法
您可以在生成期间通过系统环境变量创建可覆盖的生成配置字段:
回退在开发时使用,但在Jenkins或其他工具上运行构建时可以重写变量
在应用程序build.gradle中:
该变量将作为BuildConfig.SERVER\u 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方法
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"
}
我希望能够对抗生产、沙箱和当地环境。因为我很懒,所以我只想在一个地方更改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"
}
我很难理解的是字符串需要声明为带引号的字符串。由于这个限制,我不能直接使用referenceAPI\u HOST
,这正是我首先想要做的。由@rciovati works回答
但请确保重建项目,以便能够从Android Studio IDE中删除错误
我花了30分钟试图找出新属性变量无法访问的原因
如果红色标记的“创建项目”无效,请尝试绿色标记的“重建项目”按钮。
没有,但您也可以生成资源。我已经更新了我的答案,包括这个。太棒了,谢谢。我发现,您可以为调试和发布版本指定备用目录。在/src/
中,如果创建文件debug/res/values/strings.xml
和另一个文件release/res/values/strings.xml
,您还可以以稍微干净的方式为调试和发布版本设置资源。@rciovati没有android
插件,是否可以实现同样的功能?i、 e.仅仅使用应用插件java
?谢谢如何为不同的构建风格和构建类型创建常量?是否可以将其中一个字段设置为当前年份,并且无论选择哪种构建类型(发布、调试等)都可以访问该字段?请注意,这是对已接受答案中注释的直接响应,因此,它与原始问题有一点不同。我是否可以通过Java代码以某种方式获得version='0.0.1-SNAPSHOT'
?SystemProperty仅在gradle测试任务中可用:(.有人知道在库的java代码中使用gradle变量值的其他方法吗?systemProperty
实际上只对测试有意义,所以我明白他们为什么这样做(这不是疏忽),但同时,我也尝试将gradle用于它不打算用于的东西(如应用程序DSL)作为替代,我建议只从属性文件(或配置服务等)加载属性,因为如果它不处于“测试”模式,那么
Log.d("UserActivity", "onCreate, APP_KEY: " + getString(R.string.APP_KEY_2));
BuildConfig.APP_KEY_1
<data android:scheme="@string/APP_KEY_2" />
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
}
}
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
}
}
}
def getDate() {
return new SimpleDateFormat("dd MMMM yyyy", new Locale("ru")).format(new Date())
}
def buildDate = getDate()
defaultConfig {
buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
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"
}
}
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"
}