เป็นไปได้ไหมที่จะประกาศตัวแปรใน Gradle ที่ใช้งานได้ใน Java?

เป็นไปได้ไหมที่จะประกาศตัวแปรใน Gradle ที่ใช้งานได้ใน Java? โดยทั่วไปฉันต้องการประกาศ vars บางอย่างใน 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 App Key ในแอปพลิเคชัน 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.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...ใส่เครื่องหมาย" " (ซึ่ง btw จะใช้งานได้ในงานเท่านั้นtest) ดังนั้น:

example.HelloWorldTest > testEnv FAILED
    org.junit.ComparisonFailure at HelloWorldTest.java:14

เพื่อความสมบูรณ์นี่คือ logback config ( 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

คุณสามารถสร้างฟิลด์กำหนดค่า overridable ผ่านตัวแปรสภาพแวดล้อมระบบในระหว่างการสร้าง:

Fallback ถูกใช้ขณะกำลังพัฒนา แต่คุณสามารถลบล้างตัวแปรเมื่อคุณรัน build บน 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
    }
 }
}

}

คุณสามารถแทรกผลลัพธ์สตริงของฟังก์ชันใน 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

ฉันต้องการที่จะสามารถต่อต้านการผลิตแซนด์บ็อกซ์และสภาพแวดล้อมในท้องถิ่น เพราะฉันขี้เกียจฉันแค่ต้องการเปลี่ยน 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 เท่านั้น

    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โดยตรงซึ่งเป็นสิ่งที่ฉันต้องการจะทำในตอนแรก