文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

Android build.gradle配置详解

2023-10-21 13:03

关注

Android Studio是采用gradle来构建项目的,gradle是基于groovy语言的,如果只是用它构建普通Android项目的话,是可以不去学groovy的。当我们创建一个Android项目时会包含两个Android build.gradle配置详解文件,如下图:
build.gradle位置.png

一、Project的build.gradle文件:

对应的build.gradle代码如下:

// Top-level build file where you can add configuration options common to all sub-projects/modules.buildscript {//这里是gradle脚本执行所需依赖,分别是对应的maven库和插件        repositories {        google()//从Android Studio3.0后新增了google()配置,可以引用google上的开源项目        jcenter()//是一个类似于github的代码托管仓库,声明了jcenter()配置,可以轻松引用 jcenter上的开源项目    }    dependencies {        classpath 'com.android.tools.build:gradle:3.0.0'此处是android的插件gradle,gradle是一个强大的项目构建工具                // NOTE: Do not place your application dependencies here; they belong        // in the individual module build.gradle files    }}allprojects {//这里是项目本身需要的依赖,比如项目所需的maven库    repositories {        google()        jcenter()    }}// 运行gradle clean时,执行此处定义的task任务。// 该任务继承自Delete,删除根目录中的build目录。// 相当于执行Delete.delete(rootProject.buildDir)。// gradle使用groovy语言,调用method时可以不用加()。task clean(type: Delete) {    delete rootProject.buildDir}
repositories{}闭包:配置远程仓库

该闭包中声明了jcenter()和google()的配置,其中jcenter是一个代码托管仓库,上面托管了很多Android开源项目,在这里配置了jcenter后我们可以在项目中方便引用jcenter上的开源项目,从Android Studio3.0后新增了google()配置,可以引用google上的开源项目。

dependencies{}闭包:配置构建工具

该闭包使用classpath声明了一个Gradle插件,由于Gradle并不只是用来构建Android项目,因此此处引入相关插件来构建Android项目,其中’3.0.0’为该插件的版本号,可以根据最新的版本号来调整。

二、Module的build.gradle文件:

从文件内容可以看出,主要分为三大部分,如下图所示:
Module的build.gradle.png

1、apply plugin:
// 声明是Android程序,//com.android.application 表示这是一个应用程序模块//com.android.library 标识这是一个库模块//而这区别:前者可以直接运行,后着是依附别的应用程序运行apply plugin: 'com.android.application'

文件中第一行使用apply plugin表示应用了一个插件,该插件一般有两种值可选:

2、android{}闭包:

这个闭包主要为了配置项目构建的各种属性:
#####2.1、添加signingConfigs{}闭包:

    signingConfigs {// 自动化打包配置        release {// 线上环境            keyAlias 'test'            keyPassword '123456'            storeFile file('test.keystore')            storePassword '123456'        }        debug {// 开发环境            keyAlias 'test'            keyPassword '123456'            storeFile file('test.keystore')            storePassword '123456'        }    }

可以手动添加签名配置,也可以通过Project Structure 选中app,点击Singing添加,具体步骤如下图所示:
配置Singing.png
签名配置完成后可以方便带签名打包,在module的Build Variants中有两个Type,分别是debug和release,可以选择任意一个类型进行打包,并且他们会利用各自配置的Key进行打包,执行 Run app或者Build->Build apk就会自动在module name/app/build/outputs/apk路径下生成Apk文件。另一种打包方式是Build->Generate Signed APK填写签名信息生成Apk。

2.2、compileSdkVersion:设置编译时用的Android版本

3、buildToolsVersion:设置编译时使用的构建工具的版本,Android Studio3.0后去除此项配置

2.4、defaultConfig{}闭包:
    compileSdkVersion 27//设置编译时用的Android版本    defaultConfig {        applicationId "com.billy.myapplication"//项目的包名        minSdkVersion 16//项目最低兼容的版本        targetSdkVersion 27//项目的目标版本        versionCode 1//版本号        versionName "1.0"//版本名称        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//表明要使用AndroidJUnitRunner进行单元测试    }
2.5、 buildTypes{}闭包:

这个闭包主要指定生成安装文件的主要配置,一般包含两个子闭包,一个是debug闭包,用于指定生成测试版安装文件的配置,可以忽略不写;另一个是release闭包,用于指定生成正式版安装文件的配置。两者能配置的参数相同,最大的区别默认属性配置不一样,两种模式支持的属性配置如下图:
buildTypes配置.png

    buildTypes {// 生产/测试环境配置        release {// 生产环境            buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志            buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀            minifyEnabled false//是否对代码进行混淆            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件            signingConfig signingConfigs.release//设置签名信息            pseudoLocalesEnabled false//是否在APK中生成伪语言环境,帮助国际化的东西,一般使用的不多            zipAlignEnabled true//是否对APK包执行ZIP对齐优化,减小zip体积,增加运行效率            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多            versionNameSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多        }        debug {// 测试环境            buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志            buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀            minifyEnabled false//是否对代码进行混淆            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件            signingConfig signingConfigs.debug//设置签名信息            debuggable false//是否支持断点调试            jniDebuggable false//是否可以调试NDK代码            renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法            zipAlignEnabled true//是否对APK包执行ZIP对齐优化,减小zip体积,增加运行效率            pseudoLocalesEnabled false//是否在APK中生成伪语言环境,帮助国际化的东西,一般使用的不多            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多            versionNameSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多        }    }
release{}闭包和debug{}闭包两者能配置的参数相同,最大的区别默认属性配置不一样:
2.6、sourceSets{}闭包:配置目录指向
    sourceSets {//目录指向配置        main {            jniLibs.srcDirs = ['libs']//指定lib库目录        }    }

配置 jniLibs.srcDirs = [‘libs’],可以在Android studio的Android视图下生成jniLibs文件夹,可以方便我们存放jar包和库文件,其中Android视图下的jniLibs和project视图下的libs指向同一文件夹(app→libs),如下图所示:jniLibs.png

2.7、packagingOptions{}闭包:打包时的相关配置

当项目中依赖的第三方库越来越多时,有可能会出现两个依赖库中存在同一个(名称)文件。如果这样,Gradle在打包时就会提示错误(警告)。那么就可以根据提示,然后使用以下方法将重复的文件剔除,比较常用的是通过exclude去除重复的文件,例如:

    packagingOptions{        //pickFirsts做用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk        // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时  只用第一个 这样打包就不会报错        pickFirsts = ['META-INF/LICENSE']        //merges何必 当出现重复文件时 合并重复的文件 然后打包入apk        //这个是有默认值得 merges = [] 这样会把默默认值去掉  所以我们用下面这种方式 在默认值后添加        merge 'META-INF/LICENSE'        //这个是在同时使用butterknife、dagger2做的一个处理。同理,遇到类似的问题,只要根据gradle的提示,做类似处理即可。        exclude 'META-INF/services/javax.annotation.processing.Processor'    }
2.8、productFlavors{}闭包:多个渠道配置

这个配置是经常会使用到的,通常在适配多个渠道的时候,需要为特定的渠道做部分特殊的处理,比如设置不同的包名、应用名等。场景:当我们使用友盟统计时,通常需要设置一个渠道ID,那么我们就可以利用productFlavors来生成对应渠道信息的包,如:

android {      productFlavors {        wandoujia {            //豌豆荚渠道包配置            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]            //manifestPlaceholders的使用在后续章节(AndroidManifest里的占位符)中介绍        }        xiaomi {            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "xiaomi"]            applicationId "com.wiky.gradle.xiaomi" //配置包名        }        _360 {            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "_360"]        }        //...    }  }

当然也有更简洁的方式:

android {      productFlavors {        wandoujia {}        xiaomi {}        _360 {}       //...    }      productFlavors.all {         //批量修改,类似一个循序遍历        flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name]     }}

配置完之后,在命令行窗口中(Terminal)中输入gradlew assembleRelease(windows)即可开始打包,在Mac系统中对应指令应该是./gradlew assembleRelease。当然,如果想要debug版本的包,将指令中assembleRelease改为assembleDebug即可。最后生成的包还是在app/build/outputs/apk中,默认命名格式如app-wandoujia-release-unsigned.apk,在module的Build Variants中可以选择相应的渠道。
注:Android Studio3.0需在主app的build.gradle里面的
defaultConfig {
targetSdkVersion:***
minSdkVersion :***
versionCode:***
versionName :***
//版本名后面添加一句话,意思就是flavor dimension 它的维度就是该版本号,这样维度就是都是统一的了
flavorDimensions “versionCode”
}

2.9、lintOptions{}闭包:代码扫描分析

Lint 是Android Studio 提供的 代码扫描分析工具,它可以帮助我们发现代码结构/质量问题,同时提供一些解决方案,而且这个过程不需要我们手写测试用例。

Lint 发现的每个问题都有描述信息和等级(和测试发现 bug 很相似),我们可以很方便地定位问题,同时按照严重程度进行解决。

    //程序在编译的时候会检查lint,有任何错误提示会停止build,我们可以关闭这个开关    lintOptions {        abortOnError false //即使报错也不会停止打包        checkReleaseBuilds false  //打包release版本的时候进行检测    }
3、dependencies{}闭包:

该闭包定义了项目的依赖关系,一般项目都有三种依赖方式:本地依赖、库依赖和远程依赖。本地依赖可以对本地的jar包或目录添加依赖关系,库依赖可以对项目中的库模块添加依赖关系,远程依赖可以对jcener库上的开源项目添加依赖关系。从Android Studio3.0后compile引入库不在使用,而是通过api和implementation,api完全等同于以前的compile,用api引入的库整个项目都可以使用,用implementation引入的库只有对应的Module能使用,其他Module不能使用,由于之前的项目统一用compile依赖,导致的情况就是模块耦合性太高,不利于项目拆解,使用implementation之后虽然使用起来复杂了但是做到降低偶合兴提高安全性。

dependencies {//项目的依赖关系    implementation fileTree(include: ['*.jar'], dir: 'libs')//本地jar包依赖    implementation 'com.android.support:appcompat-v7:27.1.1'//远程依赖    implementation 'com.android.support.constraint:constraint-layout:1.1.2'    testImplementation 'junit:junit:4.12'//声明测试用例库    androidTestImplementation 'com.android.support.test:runner:1.0.2'    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'}

##Module完整的build.gradle配置如下:

// 声明是Android程序,//com.android.application 表示这是一个应用程序模块//com.android.library 标识这是一个库模块//而这区别:前者可以直接运行,后着是依附别的应用程序运行apply plugin: 'com.android.application'android {    signingConfigs {// 自动化打包配置        release {// 线上环境            keyAlias 'test'            keyPassword '123456'            storeFile file('test.jks')            storePassword '123456'        }        debug {// 开发环境            keyAlias 'test'            keyPassword '123456'            storeFile file('test.jks')            storePassword '123456'        }    }    compileSdkVersion 27//设置编译时用的Android版本    defaultConfig {        applicationId "com.billy.myapplication"//项目的包名        minSdkVersion 16//项目最低兼容的版本        targetSdkVersion 27//项目的目标版本        versionCode 1//版本号        versionName "1.0"//版本名称        flavorDimensions "versionCode"        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//表明要使用AndroidJUnitRunner进行单元测试    }    buildTypes {// 生产/测试环境配置        release {// 生产环境            buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志            buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀            minifyEnabled false//是否对代码进行混淆            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件            signingConfig signingConfigs.release//设置签名信息            pseudoLocalesEnabled false//是否在APK中生成伪语言环境,帮助国际化的东西,一般使用的不多            zipAlignEnabled true//是否对APK包执行ZIP对齐优化,减小zip体积,增加运行效率            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多            versionNameSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多        }        debug {// 测试环境            buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志            buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀            minifyEnabled false//是否对代码进行混淆            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件            signingConfig signingConfigs.debug//设置签名信息            debuggable false//是否支持断点调试            jniDebuggable false//是否可以调试NDK代码            renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法            zipAlignEnabled true//是否对APK包执行ZIP对齐优化,减小zip体积,增加运行效率            pseudoLocalesEnabled false//是否在APK中生成伪语言环境,帮助国际化的东西,一般使用的不多            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多            versionNameSuffix 'test'//在applicationId 中添加了一个后缀,一般使用的不多        }    }    sourceSets {//目录指向配置        main {            jniLibs.srcDirs = ['libs']//指定lib库目录        }    }    packagingOptions{//打包时的相关配置        //pickFirsts做用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk        // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时  只用第一个 这样打包就不会报错        pickFirsts = ['META-INF/LICENSE']        //merges何必 当出现重复文件时 合并重复的文件 然后打包入apk        //这个是有默认值得 merges = [] 这样会把默默认值去掉  所以我们用下面这种方式 在默认值后添加        merge 'META-INF/LICENSE'        //这个是在同时使用butterknife、dagger2做的一个处理。同理,遇到类似的问题,只要根据gradle的提示,做类似处理即可。        exclude 'META-INF/services/javax.annotation.processing.Processor'    }    productFlavors {        wandoujia {}        xiaomi {}        _360 {}    }    productFlavors.all {            //批量修改,类似一个循序遍历        flavor -> flavor.manifestPlaceholders = [IFLYTEK_CHANNEL: name]    }    //程序在编译的时候会检查lint,有任何错误提示会停止build,我们可以关闭这个开关    lintOptions {        abortOnError false        //即使报错也不会停止打包        checkReleaseBuilds false        //打包release版本的时候进行检测    }}dependencies {    //项目的依赖关系    implementation fileTree(include: ['*.jar'], dir: 'libs')    //本地jar包依赖    implementation 'com.android.support:appcompat-v7:27.1.1'    //远程依赖    implementation 'com.android.support.constraint:constraint-layout:1.1.2'    testImplementation 'junit:junit:4.12'    //声明测试用例库    androidTestImplementation 'com.android.support.test:runner:1.0.2'    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'}

来源地址:https://blog.csdn.net/Billy_Zuo/article/details/130391350

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-移动开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯