你所应该知道的 gradle 知识都在这里 (1)

阅读 1352
收藏 51
2017-01-03
原文链接:www.jianshu.com

心愈静,夜愈静

分享一篇整理的gradle的相关知识,部分结构略有混乱,但不影响阅读。

gradle是一个构建工具,具备编译、运行、签名、打包,依赖管理等功能的独立工具
最初是用来支持java的,为了能在AS上使用,专门有了个插件叫Android Gradle Plugin

AS中项目的根目录下有个build.gradle文件,其中有
classpath 'com.android.tools.build:gradle:2.1.2'
就是用来依赖gradle插件的代码,
ps:最后的版本号不是gradle的版本,而是google定义的

gradle下的project和tasks

在grade中的两大重要的概念,分别是project和tasks。每一次构建都是有至少一个project来完成,所以Android studio中的project和Gradle中的project不是一个概念。每个project有至少一个tasks。每一个build.grade文件代表着一个project。tasks在build.gradle中定义。当初始化构建进程,gradle会基于build文件,集合所有的project和tasks,一个tasks包含了一系列动作,然后它们将会按照顺序执行,一个动作就是一段被执行的代码,很像Java中的方法。

构建生命周期

一旦一个tasks被执行,那么它不会再次执行了,不包含依赖的Tasks总是优先执行,一次构建将会经历下列三个阶段:

初始化阶段:project实例在这儿创建,如果有多个模块,即有多个build.gradle文件,多个project将会被创建。

配置阶段:在该阶段,build.gradle脚本将会执行,为每个project创建和配置所有的tasks。

执行阶段:这一阶段,gradle会决定哪一个tasks会被执行,哪一个tasks会被执行完全依赖开始构建时传入的参数和当前所在的文件夹位置有关。

项目结构

gradle使用了一个叫做source set的概念,一个source set就是一系列资源文件,其将会被编译和执行,对于Android项目,main就是一个source set
而如果要写测试用例的话,需要另外开一个source set,叫做androidTest,这样才可以单独编译和执行测试用例。

module下的build.gradle

 apply plugin: 'com.android.application'
   android {
           compileSdkVersion 22
           buildToolsVersion "22.0.1"
           defaultConfig {
               applicationId "com.gradleforandroid.gettingstarted"
               minSdkVersion 14
               targetSdkVersion 22
               versionCode 1
               versionName "1.0"
           }
           buildTypes {
               release {
                   minifyEnabled false
                   proguardFiles getDefaultProguardFile
                    ('proguard-android.txt'), 'proguard-rules.pro'
               }
        } 
    }
    dependencies {
           compile fileTree(dir: 'libs', include: ['*.jar'])
           compile 'com.android.support:appcompat-v7:22.2.0'
     }

全局配置

1.在项目的根目录下创建config.gradle文件

ext {
    android = [
        compileSdkVersion: 23,
        buildToolsVersion: "23.0.2",
        minSdkVersion: 14,
        targetSdkVersion : 22,
       ]
    dependencies = [
            appcompatV7': 'com.android.support:appcompat-v7:23.2.1',
        design  : 'com.android.support:design:23.2.1'
    ]
}

2.在工程的build.gradle下

//引用配置文件
`apply from"config.gradle"`

3.app下的build.gradle使用

android {
    compileSdkVersion rootProject.ext.android.compileSdkVersion
    buildToolsVersion rootProject.ext.buildToolsVersion
    defaultConfig {
        applicationId "com.wuxiaolong.gradle4android"
        minSdkVersion rootProject.ext.android.minSdkVersion
        targetSdkVersion rootProject.ext.android.targetSdkVersion
        versionCode 1
        versionName "1.0"
    }


dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile rootProject.ext.dependencies.appcompatV7
    compile rootProject.ext.dependencies.design
}

Gradle Wrapper

Gradle Wrapper是一个管理gradle的包装,作用是给不同的项目分配不同的gradle
这样的所有的项目才能都正常运行。

每一个gradle wrapper对于一个可执行的脚本,windows下是bat,mac下是shell
在你的项目启动的时候,对应的脚本程序就会启动,去下载相应的gradle版本,
而下载好的gradle会存放在对于的配置文件properties中,如下图

  myapp/
   ├── gradlew
   ├── gradlew.bat
   └── gradle/wrapper/
       ├── gradle-wrapper.jar
       └── gradle-wrapper.properties

gradle常用命令

gradlew -v 查看当前项目所用的gradle版本

gradlew clean 清楚app目录下的build文件夹

gradlew build 检查依赖并编译打包 (正式和测试)

gradlew assembleDebug 编译并打Debug包

gradlew assembleRelease 编译并打Release包

gradle tasks 列出所有的tasks(可执行任务)

gradlew androidDependencies 列出所有的依赖文件

Android下的gradle

Android studio会在我们创建工程的时候,帮我们生成三个gradle文件,
两个build.gradle,一个setting.gradle文件

setting.gradle

include ':app'

setting.gradle一般的形式是这样的,这表示你的工程只包括一个app模块,这个gradle文件在会初始化时期执行,生成对应的project,而这个project会根据对应的build.gradle文件下生成一系列的tasks。
这些tasks才是具体执行的代码。

setting.gradle 主要是针对多模块操作的,单模块的攻城,setting.gradle没有多大用处。

根目录下的build.gradle

该gradle文件是定义工程下模块的公共属性的,默认配置

buildscript {
    //定义依赖包的来源
     repositories {
         jcenter() 
     }
    //定义构建过程所需要依赖的插件
    //比如在使用dagger2的时候,就需要在这里另外加入一个apt插件
      dependencies {
          classpath 'com.android.tools.build:gradle:1.2.3'
      }
}

//定义各模块的属性,你可以加入任意的tasks,也就是说这个build.gradle文件,allprojects下才是主要可以操作的地方
allprojects {
     repositories {
          jcenter() 
     }
}

模块内的build.gradle

模块内的gradle文件只对该模块起作用,而且会重写来自于根目录下gradle传过来的属性。
默认构造

//google团队所写的插件,提供关于Android应用和依赖库的构建,打包和测试
apply plugin: 'com.android.application'

   android {
       compileSdkVersion 22
       buildToolsVersion "22.0.1"
       defaultConfig {
           applicationId "com.gradleforandroid.gettingstarted"
           minSdkVersion 14
           targetSdkVersion 22
           versionCode 1
           versionName "1.0"
       }
       buildTypes {
           release {
               minifyEnabled false
               proguardFiles getDefaultProguardFile
                ('proguard-android.txt'), 'proguard-rules.pro'
           }
        } 
    }
    dependencies {
       compile fileTree(dir: 'libs', include: ['*.jar'])
       compile 'com.android.support:appcompat-v7:22.2.0'
     }

Android下
必须的属性为compileSdkVersion和buildToolsVersion

compileSdkVersion:编译该app时候,你想使用到的api版本。
buildToolsVersion:构建工具的版本号。

构建工具包含了很多实用的命令行命令,例如aapt,zipalign,dx等,这些命令能够被用来产生多种多样的应用程序。你可以通过sdk manager来下载这些构建工具。

defaultConfig方法包含了该app的核心属性,该属性会覆写在AndroidManifest.xml中的对应属性。

defaultConfig {
   //将会覆写AndroidMainifest文件下的packagename,但是作用不完全相同,packagename作为包名和R文件的包名,applicationId被用做唯一标识在不同的设备和各大应用市场上。
   applicationId "com.gradleforandroid.gettingstarted"
   minSdkVersion 14
   targetSdkVersion 22
    //版本标识
   versionCode 1
    //没什么作用,一般内部标识
   versionName "1.0"
}

依赖管理

gradle的依赖管理功能非常实用,只需要一行代码,gradle就会帮你在远程仓库拉取需要的jar包。

仓库
这里的仓库通常指的是远程仓库,比如Jcenter,Maven等。
仓库相当于一个jar文件的集合体,你只要定义好需要什么jar文件,gradle工具就会帮你从你制定的仓库里拉取jar文件。
jar文件会在你执行build构建的时候从远程仓库拉取,并且会在本地保留缓存,所以一个版本的依赖包只需要下载一次。

定义一个依赖通常需要三个元素
group:创建该library的组织名,通常也会是包名,
name :是该library的唯一标识
version:该library的版本号

常规写法

dependencies {
   compile 'com.google.code.gson:gson:2.3'
   compile 'com.squareup.retrofit:retrofit:1.9.0'
}

完成的写法

dependencies {
  compile group: 'com.google.code.gson', name: 'gson', version:'2.3'
  compile group: 'com.squareup.retrofit', name: 'retrofit'
       version: '1.9.0'
 }

当然还有一些类库不在maven或者jcenter中,
这个时候你可以这么定义,将url写在maven中

repositories {
       maven {
           url "http://repo.acmecorp.com/maven2"
       }
}

本地依赖

添加jar文件作为依赖

dependencies {
   compile files('libs/libraryname.jar')
}

libs目录下的所有jar包

dependencies {
   compile fileTree('libs')
 }
或者
dependencies {
   compile fileTree(dir: 'libs', include: ['*.jar'])
}

native包(c/c++写的library会被叫做so包)

app根目录下创建一个jniLibs目录,
dependencies {
compile fileTree(dir: 'jniLibs', include: ['*.so'])
}

arr文件(包含资源文件的依赖包)

将app下build.gradle的配置改为

apply plugin: 'com.android.library'
//删除
applicationId "com.***"

编译通过之后会在build/outputs/aar文件下生产aar包

使用方式,
aar文件也是属于jar包,所以也可以放入到libs目录下,
接着在build.gradle中android方法下

repositories {  
    flatDir {  
    dirs 'libs'  
}

在dependencies方法下

compile(name:'libraryname', ext:'aar')

这表示在libs目录下,有个叫libraryname,后缀是aar的文件

依赖的形式

 compile 'com.google.code.gson:gson:2.3'

这是我们正常情况下使用的方法,
complie:包含所有的依赖包,debug模式下和release模式下都会依赖
其他的还有

provided:意思是提供debug支持,但是不会写入release。
testCompile和androidTestCompile:主要针对测试使用

另外还有
debugCompile和releaseProvided方式可以配置

在不同的情况下需要配置不同的依赖方式

本人也只是Android开发路上一只稍大一点的菜鸟,如果各位读者中发现文章中有误之处,请帮忙指出,你的批评和鼓励都是我前进的动力。

评论