Android Gradle进阶配置指南

作者: df556ada620a | 来源:发表于2018-11-28 15:47 被阅读41次

    简单的总结一下gradle:

    1.Gradle是一种构建工具,它可以帮你管理项目中的差异,依赖,编译,打包,部署......你可以定义满足自己需要的构建逻辑,写入到build.gradle中供日后复用.

    2.Gradle不是一种编程语言,它不能帮你实现软件中的任何实际功能

    Gradle 基本

    如果你用Android Studio新建一个项目的时候,默认生成一大堆关于gradle的东西,其中最重要的是一个build.gradle的文件,内容如下:

    apply plugin: 'com.android.application'
    android {
     compileSdkVersion 26
     buildToolsVersion "26.0.0"
     defaultConfig {
     minSdkVersion 19
     targetSdkVersion 26
     versionCode 1
     versionName "1.0"
     }
     buildTypes {
     release {
     runProguard false
     proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'
     }
     }
    }
    dependencies {
     compile 'com.android.support:support-v4:26.0.+'
    }
    复制代码
    
    

    解读:

    apply plugin::指定用的是哪个插件,开发中常见的值有:
     'com.android.application':Android APP插件(打包得到的是.apk文件)
     'com.android.library':Android库插件(打包得到的是.aar文件)
     'java':普通的java插件(打包得到的是.jar文件)
    我目前用到的还有:
     kotlin-android : kotlin
     bugly.gradle : 腾讯bugly
     walle.gradle : 美团walle打包
    复制代码
    android{}用来指定Android打包插件的相关属性,包含如下节点:
    compileSdkVersion(apiLevel):设置编译时用的Android版本
    buildToolsVersion(buildToolsVersionName):设置编译时使用的构建工具的版本
    defaultConfig:设置一些默认属性,其可用属性是buildTypes(debug,release,其他+)和productFlavors(谷歌商店,豌豆荚,小米应用商店)之和。
     最终可以打出的APK的数量就是buildTypes乘以productFlavors。构建的变量名称是productFlavors+buildTypes。
    复制代码
    dependencies 配置依赖:
    各种外部依赖直接一行代码搞定,不用手动下依赖包了。
    其中compile fileTree(dir: 'libs', include: ['*.jar'])的意思是依赖libs目录下全部的jar文件。
    复制代码
    buildscript {
     repositories {
     google()
     jcenter()
     mavenCentral()
     }
     dependencies {
     classpath 'com.android.tools.build:gradle:3.2.1'
     }
    }
    
    
    

    buildscript节点,大概意思就是支持maven,google,声明Gradle的版本.如果用到一些其他插件也需要在此申明.

    signingConfigs {
     myConfig {
     storeFile file("xxx.keystore")
     storePassword "123123"
     keyAlias "xxx"
     keyPassword "123123"
     v2SigningEnabled true
     }
    }
    
    buildTypes{
     release {
     //应用myConfig
     signingConfig signingConfigs.myConfig
     minifyEnabled true
     proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'
     } 
    }
    
    签名配置:
    storeFile : keystore文件
    storePassword : 密码
    keyAlias : 别名
    keyPassword : 别名密码
    v2SigningEnabled : 启用V2签名方案
    minifyEnabled : 是否开启混淆
    shrinkResources : 是否移除无用资源文件,shrinkResources依赖于minifyEnabled,必须和minifyEnabled一起用
    
    
    

    以上只是最简单的gradle配置,实际项目中我们的app会很复杂,比如不仅引用到一些jar文件,也可能会引用一些Android Library项目以及一些.so文件,而且实际发布的时候我们可能不仅需要发布到一个平台上,目前Android大大小小可能得十几个平台,Gradle通过一些其他的配置都可以解决。顺便说下Gradle是Google大力支持的。

    进阶配置

    配置manifest变量

    很多第三方SDK需要在AndroidManifest.xml中配置你的一些key信息,以融云为例,测试包和正式包的key是不同的,那么就可以这么写::

    <meta-data
     android:name="RONG_CLOUD_APP_KEY"
     android:value="${rongKey}" />
    
    
    

    然后在productFlavors中的各个版本中加上不同的信息,这样你打出的不同包采用的appkey也会不一样。

    manifestPlaceholders = [rongKey: "8luwapkv8jrrl"]
    
    
    

    代码中读取变量

    有时候我们想根据不同的版本,设置相同变量不同的值,最常见的使用场景就是 Log 工具类,通过设置 isDubug 不同值判断是否打印日志.其他还包括获取包名,获取渠道名

    buildConfigField "String", "PlatformSource", "\"Google\""
    buildConfigField "String", "showProjName", "\"TestProj\""
    
    
    

    最后调用 : BuildConfig.PlatformSource

    public final class BuildConfig {
     public static final boolean DEBUG = Boolean.parseBoolean("true");
     public static final String APPLICATION_ID = "com.xxx.xxxx";
     public static final String BUILD_TYPE = "debug";
     public static final String PlatformSource = "Google";
     public static final String showProjName = "TestProj";
    
    
    

    上面的是加在defaultConfig 中的,而加在buildTypes或productFlavors中就会在不同构建版本出现不同的值。如果再配置上不同的applicationId,那么就可以在同一个手机上同时安装不同构建版本的应用。

    productFlavors {
     //国内版本
     china{
     applicationId "com.shy.china"
     versionCode "2.0.0"
     versionName "30"
     }
     //韩国版本
     korea{
     applicationId "com.shy.korea"
     versionCode "1.0.0"
     versionName "1"
     }
    }
    
    
    

    到这里你会发现buildTypes和productFlavors定义很相似,不过他们的差别在:

    • buildType 不会改变应用程序的代码,它们只是处理的东西不同,你可以通过 buildType 来获取更多的技术细节(例如:build optimization,log level minifyEnabled等等),但是app的内容不会改变.
    • productFlavor 配置可以改变app的内容(可以设想成 package 理解,buildType 没法改 applicationId).

    BuildVariants变体

    buildTypes+productFlavors相结合,组成构建变体,buildTypes构建类型,主要就是debug(测试),pre(预发布) ,release(线上)的分别。productFlavors产品口味,主要就是各种渠道版本。两个合体就会构建出不同的版本apk (总apk个数=构建类型个数*渠道个数).看图:

    • buildTypes构建类型
     buildTypes {
     release {
     multiDexKeepProguard file('multidex-config.pro')
     minifyEnabled true//是否开启混淆(上线)
     shrinkResources true
     proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
     }
     debug {
     multiDexKeepProguard file('multidex-config.pro')
     minifyEnabled false//是否开启混淆(上线)
     proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
     }
     }
    
    
    • productFlavors多维度
    • 当需要从多个维度区分app版本,比如是否付费和渠道时,就需要使用flavorDimensions来区分
     flavorDimensions "channel", "env"
     productFlavors {
     china {
     dimension "channel"
     applicationId "com.shy.china"
     versionCode project.CHINA_VERSION_CODE as int
     versionName project.CHINA_VERSION_NAME
     signingConfig signingConfigs.china
     buildConfigField "String", "PlatformSource", "\"china\""
     buildConfigField "String", "showProjName", "\"projName_china\""
     manifestPlaceholders = [
     package_name : applicationId,
     JPUSH_PKGNAME: applicationId,
     JPUSH_APPKEY : "xxxxxxxxxxxx", //JPush上注册的包名对应的appkey.
     JPUSH_CHANNEL: "developer-default", //暂时填写默认值即可.
     ]
     }
    
     korea {
     dimension "channel"
     applicationId "com.shy.korea"
     versionCode project.KOREA_VERSION_CODE as int
     versionName project.KOREA_VERSION_NAME
     signingConfig signingConfigs.korea
     manifestPlaceholders = [
     package_name : applicationId,
     JPUSH_PKGNAME: applicationId,
     JPUSH_APPKEY : "xxxxxxx", //JPush上注册的包名对应的appkey.
     JPUSH_CHANNEL: "developer-default", //暂时填写默认值即可.
     ]
     buildConfigField "String", "PlatformSource", "\"korea\""
     buildConfigField "String", "showProjName", "\"projName_korea\""
     }
    
     dev {
     dimension "env"
     }
     pre {
     dimension "env"
     }
     produce {
     dimension "env"
     }
     }
    
    
    

    此时在build一下 , BuildVariants中会生成12种变体(总apk个数=构建类型个数渠道个数维度个数) :

    chinaDevDebug(常用)

    chinaDevRelease

    chinaPreDebug

    chinaPreRelease(常用)

    chinaProduceDebug

    chinaProduceRelease(常用)

    koreaDevDebug(常用)

    koreaDevRelease

    koreaPreDebug

    koreaPreRelease(常用)

    koreaProduceDebug

    koreaProduceRelease(常用)

    注意!warning:

    1.当添加了flavorDimensions,必须为每个productFlavors添加dimension,否则会提示错误

    2.在gradle:3.0.0以上,在build.gradle里必须要有flavorDimensions字段,哪怕只有一个维度也要声明,否则报错

    打包

    一次生成所有渠道包 打开命令行窗口,进入到工程的根目录下,输入

    gradle assembleChinaProduceRelease


    其他技巧

    1.Gradle task

    Gradle task适合用来完成一些既繁琐又容易出错的重复性手工作,比如批量修改,复制,重命名文件。 比如applicationVariants.all这个task可以针对每个构建版本设置各种属性,比如修改每个构建版本生成的apk名字:

    applicationVariants.all { variant ->
     variant.outputs.each { output ->
     output.outputFile = new File(
     new File("${project.rootDir.absolutePath}/apk/",
     //最后在项目下的apk文件夹下打出来的包名:chinaDev-GooglePlay-1.0.0-20181126-193438.apk
     ("${flavorName}-${channel}-${buildType}-v${versionName}-${buildTime}.apk)
     }
     }
    
    
    

    2.Moudle动态依赖

    在组件化app里面,我们可能在测试包和正式包需要依赖不同组件。比如测试环境需要调试模块,但正式环境不需要。假如productFlavors如下,调试模块名字为module-test

    <pre style="margin: 0px; padding: 0px; border: 0px; font-style: inherit; font-variant: inherit; font-weight: inherit; font-stretch: inherit; font-size: inherit; line-height: inherit; font-family: inherit; vertical-align: baseline; word-break: break-word;">

    productFlavors {
     test{
     }
     publish{
     }
    }
    
    
    

    那么在dependencies里面就可以这么依赖test模块:

    ceshiCompile project(':module-test')

    同样buildTypes也是适用的,两者可以一起或单独使用:

    debugCompile project(':module-test')
    ceshidebugCompile project(':module-test')
    
    
    

    3.定义全局变量

    先在 project 根目录下创建ext_settings.gradle文件:

    ext {
     CHINA_VERSION_NAME = '2.0.0'
     KOREA_VERSION_NAME = '1.0.0'
     CHINA_VERSION_CODE = 20
     KOREA_VERSION_CODE = 1
     androidToolsVersion = '28.0.3'
     supportLibraryVersion = '27.1.1'
     fireBaseVersion = '12.0.1'
     minSdkVersion = 19
     androidSdkVersion = 27
     kotlin_version = '1.3.0'
     gradlePlugin = '3.2.1'
     sourceCompatibilityVersion = JavaVersion.VERSION_1_8
     targetCompatibilityVersion = JavaVersion.VERSION_1_8
    }
    
    
    

    然后在各 module 的 build.gradle 中可以通过rootProject.ext来引用:

    defaultConfig {
     minSdkVersion rootProject.ext.minSdkVersion
     targetSdkVersion rootProject.ext.androidSdkVersion
    }
    
    
    

    依赖也可以挪过来:

    ext.deps = [
    junit : 'junit:junit:4.12',
    truth : 'com.google.truth:truth:0.28',
    recyclerview : "com.android.support:recyclerview-v7:$supportLibraryVersion",
    ] 
    
    
    

    调用:

    dependencies {
     implementation deps.recyclerview
    }
    
    
    

    4.配置独立的签名信息 & 将密码等文件统一配置

    密码和签名这类的敏感信息可以统一进行存放,不进行硬编码。在gradle.properies中,我们可以随意的定义key-value。

    STORE_FILE_PATH=../china.keystore
    STORE_PASSWORD=123456
    KEY_ALIAS=china
    KEY_PASSWORD=test123
    复制代码
     signingConfigs {
     china {
     //使用gradle.properies的配置
     file(STORE_FILE_PATH)
     storePassword STORE_PASSWORD
     keyAlias KEY_ALIAS
     keyPassword KEY_PASSWORD
     v2SigningEnabled true
     }
     korea {
     //日常
     storeFile file('korea.keystore')
     storePassword "123456"
     keyAlias "kkk"
     keyPassword "123456"
     v2SigningEnabled true
     }
     }
    
    

    5.减少编译错误和忽略 lint 检查

     packagingOptions {
     //Espresso excludes
     exclude 'META-INF/DEPENDENCIES.txt'
     exclude 'META-INF/LICENSE.txt'
     exclude 'META-INF/NOTICE.txt'
     exclude 'META-INF/NOTICE'
     exclude 'META-INF/LICENSE'
     exclude 'META-INF/DEPENDENCIES'
     exclude 'META-INF/notice.txt'
     exclude 'META-INF/license.txt'
     exclude 'META-INF/dependencies.txt'
     exclude 'META-INF/LGPL2.1'
     exclude 'LICENSE.txt'
     }
    
    lintOptions {
     checkReleaseBuilds true
     abortOnError false
     }
    
    
    

    6.引用本地aar

    1.把aar文件放在某目录内,比如就放在某个module的libs目录内

    2.在这个module的build.gradle文件中添加:

    api fileTree(include: ['*.aar'], dir: 'libs')
    
    
    

    最后附上:

    gradle谷歌官方:developer.android.com/studio/buil…

    翻译版:avatarqing.github.io/Gradle-Plug…
    做Android开发的朋友们有兴趣可以加Android架构师群;701740775
    本群提供Android高级开发资料、职业生涯规划,面试,高级UI、性能优化、架构师课程、NDK、混合式开发(ReactNative+Weex)等相关资料和解答

    相关文章

      网友评论

        本文标题:Android Gradle进阶配置指南

        本文链接:https://www.haomeiwen.com/subject/wgxzqqtx.html