【Android -- 开发工具】Gradle 配置技巧

随着 Android 的发展，新技术和新概念层出不穷。不同的测试环境、不同的分发渠道、不同的依赖方式，再加上各大厂家“优秀”的插件化方案，这些给我们的开发工作带来了新的需求。

Android Studio 目录层级

├── app #Android App目录
│   ├── app.iml
│   ├── build #构建输出目录
│   ├── build.gradle #构建脚本
│   ├── libs #so相关库
│   ├── proguard-rules.pro #proguard混淆配置
│   └── src #源代码，资源等
├── build
│   └── intermediates
├── build.gradle #工程构建文件
├── gradle
│   └── wrapper
├── gradle.properties #gradle的配置 外部属性
├── gradlew #gradle wrapper linux shell脚本
├── gradlew.bat
├── LibSqlite.iml
├── local.properties #配置Androod SDK位置文件
└── settings.gradle #工程配置

版本管理

常用属性：

• applicationId 配置包名的

• versionCode 版本号

• versionName 版本名称

• minSdkVersion app能够运行的最小版本

• targetSdkVersion 目标设备sdk（向前兼容）

比如像 compileSdkVersion 这种的可以通过一个单独的 gradle 文件来进行管理如下，新建一个version.gradle 文件，在里面定义一些配置的变量

ext{
    appCompileSdkVersion = 30
    appBuildToolsVersion = "30.0.3"
    appMinSdkVersion = 21
    appTargetSdkVersion = 30
    appVersionCode = 1
    appVersionName = "1.0"
}

build.gradle 文件中引用并使用定义的变量

//引入version.gradle文件
apply from:"../version.gradle"
android {
    compileSdkVersion appCompileSdkVersion
    buildToolsVersion appBuildToolsVersion

    defaultConfig {
        applicationId "com.itfitness.gradletest"
        minSdkVersion appMinSdkVersion
        targetSdkVersion appTargetSdkVersion
        versionCode appVersionCode
        versionName appVersionName

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
}

修改生成的 apk 名称

可以通过遍历 applicationVariants 来对生成的 apk 文件修改名字

applicationVariants.all{variant ->
        //遍历variant的outputs，一般每个variant的outputs有debug和release两个
        variant.outputs.all {
            //判断文件是以.apk结尾的就修改文件名
            if(outputFileName.endsWith(".apk")){
                outputFileName  = "itfitness_V" + versionName + "(" + versionCode + ").apk"
            }
        }
    }

隐藏签名文件信息

我们平时可能会将签名文件的信息配置在 signingConfigs 中，这样如果将代码提交到远程的代码仓库就可能被别人看到，因此我们可以通过配置properties文件的方式将签名信息放在自己本地的电脑上，然后通过读取配置信息来实现与以前同样的效果，代码如下：

signingConfigs{
        def signInfo = new ConfigSlurper().parse(new File("G:/signInfo.properties").toURI().toURL())
        release{
            storeFile file(signInfo.storeFilePath)
            keyAlias signInfo.keyAlias
            keyPassword signInfo.keyPassword
            storePassword signInfo.storePassword
        }
    }

其中我的 signInfo.properties 在 G 盘

signInfo.properties文件的内容如下:

storeFilePath = "G:/testjks.jks"
keyAlias = 'testjks'
keyPassword = 'testjks'
storePassword = 'testjks'

动态配置 AndroidManifest 的信息

首先我们需要在 module 的 build.gradle 文件中配置一个 productFlavor，然后在 manifestPlaceholders 属性中配置我们自定义的信息，如下:

productFlavors{
        itfitness{
            manifestPlaceholders = [
                    "MY_KEY":"Itfitness",
                    "APP_NAME":"Itfitness应用"
            ]
        }
    }

然后我们就可以在 AndroidManifest 文件中通过${}来引用了，比如我这是加了一个 meta-data 并且修改了应用名称

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.itfitness.androidgradledemo">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="${APP_NAME}"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.AndroidGradleDemo">
        <meta-data android:name="MY_KEY" android:value="${MY_KEY}"/>
        <activity
            android:name=".MainActivity"
            android:exported="true">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

然后可以在代码中获取 meta-data

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        val appInfo = packageManager.getApplicationInfo(packageName, PackageManager.GET_META_DATA)
        val myKey = appInfo.metaData.getString("MY_KEY")
        myKey?.let {
            Log.e("MetaData",myKey)
        }
    }
}

添加 BuildConfig 常量

我们可以在 productFlavor 中通过 buildConfigField 来添加 BuildConfig 常量，如下:

productFlavors{
        itfitness{
            buildConfigField 'String','MYNAME','"Itfitness"'
            manifestPlaceholders = [
                    "MY_KEY":"Itfitness",
                    "APP_NAME":"Itfitness应用"
            ]
        }
    }

注意:这三个值的意义分别是：类型、名称、常量值，这三个值生成了BuildConfig常量的时候都是纯替换的，因此如果是字符串类型的值也要在单引号中加入双引号，否则就会出错，如下所示

另外注意如果修改了 builde.gradle 文件后没有生成 BuildConfig 常量的话就需要 Make Project 一下

这里 BuildConfig 常量也可以在 BuildType 中定义如：

buildTypes {
        release {
            minifyEnabled false
            buildConfigField 'int','M_VERSION','999'
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
        debug {
            buildConfigField 'int','M_VERSION','666'
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

动态添加自定义资源

我们可以在 build.gradle 文件中动态添加些 string、color 等资源，如下

 productFlavors{
        itfitness{
            resValue 'color','ColorItfitness','#FF0000'
            buildConfigField 'String','MYNAME','"Itfitness"'
            manifestPlaceholders = [
                    "MY_KEY":"Itfitness",
                    "APP_NAME":"Itfitness应用"
            ]
        }
    }

然后我们 Make Project 后就可以找到

Java编译选项

我们可以通过配置 compileOptions 来指定 Java 的编译选项，如下：

compileOptions {
        encoding = 'utf-8' //源文件编码
        sourceCompatibility JavaVersion.VERSION_1_8 //源代码编译级别
        targetCompatibility JavaVersion.VERSION_1_8 //字节码生成的版本
    }

Dex选项配置

有的时候我们打包会提示 java.lang.OutOfMemoryError: GC overhead limit exceeded，这是因为我们打包生成 apk 用的是 dx 工具，当我们代码太多的时候，默认分配给 dx 工具的内存就不足以打包 apk 了，这时我们可以通过配置 dexOptions 来解决这个问题，如下：

 dexOptions{
        javaMaxHeapSize '4g'
    }

另外还有一些其他的可配置项，如：

• incremental 属性：是一个 boolean 类型的属性，用来配置是否启用 dx 的增量模式，默认为 false，增量模式虽然速度更快一点，但是可能会有一些限制，因此要慎用

 dexOptions{
        incremental true
    }

• jumboMode属性：boolean 类型的属性，有时候我们的程序项目工程比较大，代码太多，函数超过了 65535 个，5.0 以上那就需要强制开启 jumbo 模式才可以构建成功

 dexOptions{
        jumboMode true
    }

• preDexLibraries属性：boolean类型的属性，用来配置是否预执行dex Libraries库工程，开启后会大大提高增量构建的速度，不过可能会影响clean的构建速度。默认为true，但是如果我们需要使用dx的--multi-dex选项生成多个dex，这导致和库工程有冲突的时候，需要将该属性设为false

• threadCount 属性：integer类型，用来配置Android Gradle运行dx命令使用的线程数，适当的线程数量可以提高dx的效率：

 dexOptions{
        threadCount 2
    }