Gradle for Android

最新推荐文章于 2024-04-27 11:23:57 发布

Le_leezp

最新推荐文章于 2024-04-27 11:23:57 发布

阅读量518

点赞数 1

分类专栏： Android 软件工程师文章标签： gradle android

Android 同时被 2 个专栏收录

16 篇文章 0 订阅

订阅专栏

软件工程师

3 篇文章 0 订阅

订阅专栏

转载：http://wuxiaolong.me/2016/03/30/gradle4android1/

1. 基本配置与依赖管理

首先，我们先新建一个项目，在其中我们可以看到很多关于Gradle的配置文件

app/build.gradle

apply plugin: 'com.android.application'

android {
    compileSdkVersion 25
    buildToolsVersion "26.0.0"
    defaultConfig {
        applicationId "com.leezp.xingyun.studygradle"
        minSdkVersion 15
        targetSdkVersion 25
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    compile 'com.android.support:appcompat-v7:25.3.1'
    compile 'com.android.support.constraint:constraint-layout:1.0.0-beta4'
    testCompile 'junit:junit:4.12'
}

apply plugin: ‘com.android.application’，表示该module是一个app module，应用了com.android.application插件，如果是一个android library，那么这里写apply plugin: ‘com.android.library’
compileSdkVersion：基于哪个SDK编译，这里是API LEVEL
buildToolsVersion：基于哪个构建工具版本进行构建的。
defaultConfig：默认配置，如果没有其他的配置覆盖，就会使用这里的。
applicationId：配置包名的
versionCode：版本号
versionName：版本名称
buildTypes是构建类型，常用的有release和debug两种，可以在这里面启用混淆，启用zipAlign以及配置签名信息等。
dependencies：不属于Android专有的配置了，它定义了该module需要依赖的jar，aar，jcenter库信息。

gradle-wrapper.properties

声明了gradle的目录与下载路径以及当前项目使用的gradle版本，这些默认的路径我们一般不会更改的

#Wed Jul 26 11:07:05 CST 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https://services.gradle.org/distributions/gradle-3.3-all.zip

根目录的build.gradle

定义在这个工程下的所有模块的公共属性

    // Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    repositories {
        jcenter()//使用jcenter库
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.1'//依赖android提供的1.5.0的gradle build

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}
//为所有的工程的repositories配置为jcenters
allprojects {
    repositories {
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

setting.gradle

包含哪些模块，比如有app和library：

include ':app',':library'

本地依赖

jar

默认情况下，新建的Android项目会有一个lib文件夹

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])//即添加所有在libs文件夹中的jar
    //compile files('libs/Leezp.jar')//不需要这样一个个去写了
 }

so包

用c或者c++写的library会被叫做so包，Android插件默认情况下支持native包，你需要把.so文件放在对应的文件夹中

app
 ├── AndroidManifest.xml
 └── jniLibs
         ├── armeabi
         │     └── Leezp.so
         ├── armeabi-v7a
         │     └── Leezp.so
         ├── mips
         │     └── Leezp.so
         └── x86
               └── Leezp.so

library工程

直接依赖library库：

dependencies {
       compile project(':library名字')
       //多个library，libraries是文件夹名字
       compile project(':libraries:library名字')
  }

aar文件

library库输出文件是.aar文件，包含了Android资源文件，在library工程build/output/aar/下，然后app目录下创建一个aars文件夹，然后把.aar文件拷贝到该文件夹里面，然后添加该文件夹作为依赖库：

app/bulid.gradle

android {
    //...
}
repositories {
    flatDir {
        dirs 'aars' 
    }
}
dependencies {
       compile(name:'libraryname', ext:'aar')
}

如何生成.aar文件：
执行 ./gradlew assembleRelease，然后就可以在 build/outputs/aar 文件夹里生成aar文件

.jar和.aar区别：
*.jar：只包含了class文件与清单文件，不包含资源文件，如图片等所有res中的文件；

*.aar：包含所有资源，class以及res资源文件全部包含。

注意：
如果你的library依赖了第三方库aar，须app再次依赖。比如lib1依赖了lib2 的aar，app依赖lib1，需要：

dependencies {
    compile(name: 'library1-release', ext: 'aar')
    compile(name: 'library2-release', ext: 'aar')
}

远程仓库

dependencies {
        compile 'com.leezp.pullloadmorerecyclerview:library:1.0.4'
}

完整配置

https://github.com/WuXiaolong/Gradle4Android

2. 全局设置、自定义BuildConfig与代码混淆

转载:http://wuxiaolong.me/2016/03/31/gradle4android2/

全局设置

根目录build.gradle

如果有很多项目，可以设置全局来统一管理版本号或依赖库，根目录下build.gradle添加：

def androidSupportVersion = '25.3.1'
ext {
    //编译的 SDK 版本，如API20
    compileSdkVersion = 25
    //构建工具的版本，其中包括了打包工具aapt、dx等,如API20对应的build-tool的版本就是20.0.0
    buildToolsVersion = "26.0.0"
    //兼容的最低 SDK 版本
    minSdkVersion = 14
    //向前兼容，保存新旧两种逻辑，并通过 if-else 方法来判断执行哪种逻辑
    targetSdkVersion = 22
    appcompatV7 = "com.android.support:appcompat-v7:$androidSupportVersion"
}

app/build.gradle

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

新建config.gradle

可以在根目录下建个config.gradle，然后只需在根目录下build.gradle最顶部加上下面一行代码，然后同步下，意思就是所有的子项目或者所有的modules都可以从这个配置文件里读取内容。

apply from: "config.gradle"

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'
    ]
}

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.properties

根项目下的gradle.properties：

COMPILE_SDK_VERSION=25
BUILDTOOLS_VERSION=26.0.0
SUPPORT_LIB_VERSION=25.3.1
MIN_SDK_VERSION=12
TARGET_SDK_VERSION=25

app/build.gradle

android {
    compileSdkVersion Integer.parseInt(COMPILE_SDK_VERSION)
    buildToolsVersion BUILDTOOLS_VERSION
    defaultConfig {
        minSdkVersion Integer.parseInt(MIN_SDK_VERSION)
        targetSdkVersion Integer.parseInt(TARGET_SDK_VERSION)
        versionName "0.0.1"
    }
dependencies {
    compile "com.android.support:support-v4:${SUPPORT_LIB_VERSION}"
    compile "com.android.support:appcompat-v7:${SUPPORT_LIB_VERSION}"
}

自定义BuildConfig

实际开发中服务器可能有正式环境和测试环境，gradle可以通过buildConfigField来配置。

defaultConfig {
       buildConfigField 'String','API_SERVER_URL','"http://wuxiaolong.me/"'
   }

buildConfigField 一共有3个参数，第一个是数据类型，和Java的类型是对等的；第二个参数是常量名，这里是API_SERVER_URL；第三个参数就是你要配置的值。

这里写图片描述

如图路径下就有个常量API_SERVER_URL，如何在代码取得这个常量值：

Log.d("wxl", "API_SERVER_URL=" + BuildConfig.API_SERVER_URL);

启用proguard混淆

一般release发布版本是需要启用混淆的，这样别人反编译之后就很难分析你的代码，而我们自己开发调试的时候是不需要混淆的，所以debug不启用混淆。对release启用混淆的配置如下：

android {
    buildTypes {
        release {
            minifyEnabled true//是否启动混淆
            shrinkResources true //是否移除无用资源文件，shrinkResources依赖于minifyEnabled，必须和minifyEnabled一起用
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
   }
}

minifyEnabled为true表示启用混淆，proguardFile是混淆使用的配置文件，这里是module根目录下的proguard-rules.pro文件

完整配置

https://github.com/WuXiaolong/Gradle4Android

3. 多渠道打包与配置签名信息

转载：http://wuxiaolong.me/2016/04/01/gradle4android3/

多渠道打包

国内有太多Android App市场，每次发版几十个渠道包。还好Android Gradle给我们提供了productFlavors，我们可以对生成的APK包进行定制。

productFlavors {//多渠道打包
    xiaomi {
        applicationId 'com.wuxiaolong.gradle4android1'
    }
    googlepaly {
        applicationId 'com.wuxiaolong.gradle4android2'
    }
}

定制生成的apk文件名

applicationVariants.all { variant ->
             if (variant.buildType.name.equals('release')) {
                 variant.outputs.each { output ->
                     def outputFile = output.outputFile
                     if (outputFile != null && outputFile.name.endsWith('.apk')) {
                         def fileName = "gradle4android_v${defaultConfig.versionName}_${releaseTime()}_${variant.flavorName}.apk"
                         output.outputFile = new File(outputFile.parent, fileName)
                     }
                 }
             }
         }

占位符

多渠道打包，还会遇到一个问题，比如友盟统计的渠道号，Gradle处理办法：manifestPlaceholders，它允许我们动态替换我们在AndroidManifest文件里定义的占位符。

AndroidManifest.xml：

<meta-data
           android:name="UMENG_CHANNEL"
           android:value="${UMENG_CHANNEL_VALUE}" />

如下，${UMENG_CHANNEL_VALUE}占位符会被dev替换。

defaultConfig {
       manifestPlaceholders = [UMENG_CHANNEL_VALUE: 'dev']
   }

如果渠道太多，不用这样一个个去写，可以循环：

productFlavors.all { flavor ->
               manifestPlaceholders.put("UMENG_CHANNEL_VALUE",name)
           }

渠道打包完整代码：

android {
//省略部分代码
     buildTypes {
        release {
            minifyEnabled false//是否启动混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            applicationVariants.all { variant ->
                if (variant.buildType.name.equals('release')) {
                    variant.outputs.each { output ->
                        def outputFile = output.outputFile
                        if (outputFile != null && outputFile.name.endsWith('.apk')) {
                            def fileName = "gradleTest_v${defaultConfig.versionName}_${releaseTime()}_${variant.flavorName}.apk"
                            output.outputFile = new File(outputFile.parent, fileName)
                        }
                    }
                }
            }
            //针对很多渠道
            //productFlavors.all { flavor ->
            //   manifestPlaceholders.put("UMENG_CHANNEL_VALUE",name)
            // }
        }
    }
    productFlavors {//多渠道打包，命令行打包：gradlew assembleRelease
        xiaomi {
            applicationId 'com.wuxiaolong.gradle4android1'
            manifestPlaceholders.put("UMENG_CHANNEL_VALUE", 'xiaomi')
        }
        googlepaly {
            applicationId 'com.wuxiaolong.gradle4android2'
            manifestPlaceholders.put("UMENG_CHANNEL_VALUE", 'googlepaly')
        }
    }
 //省略部分代码
def releaseTime() {
    return new Date().format("yyyy-MM-dd", TimeZone.getTimeZone("UTC"))
}

配置签名信息

Android Studio设置默认的签名文件

新浪微博SSO登录，微信分享这些都需要签名打包，才能看到效果，设置默认签名文件为自己的签名jks，这样就不需要打包了直接运行起来就是正式的签名。
在android.signingConfigs{}下定义一个或者多个签名信息，然后在buildTypes{}配置使用即可。
在app目录下添加你的.jks，然后app的build.gradle文件中的增加以下内容：
第一种：

android {  
    signingConfigs {  
        debug {  
            storeFile file("WuXiaolong.jks")
            storePassword 'android'
            keyAlias 'android'
            keyPassword 'android'
        }          
    }   
}

buildTypes没有配置，也是直接取得debug，是不是不配置默认取得是debug呢？
第二种：

android {  
    signingConfigs {  
        release {  
            storeFile file("WuXiaolong.jks")
            storePassword 'android'
            keyAlias 'android'
            keyPassword 'android'
        }          
    }  
    buildTypes {
        debug {
            signingConfig signingConfigs.release
        }        
    }
}

签名打包

通过Android Studio签名

这里不细说了。

通过命令行签名

如上那样配置签名信息

android {  
    signingConfigs {  
        release {  
            storeFile file("WuXiaolong.jks")
            storePassword 'android'
            keyAlias 'android'
            keyPassword 'android'
        }          
    }  
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }      
    }
}

先”build-clean Project”，然后Terminal输入命名行：

gradlew assembleRelease

打印信息如下：

E:\AndroidStudioProjects\Gradle4Android>gradlew assembleRelease
:app:preBuild UP-TO-DATE                                                             
:app:preReleaseBuild UP-TO-DATE     
:app:checkReleaseManifest                  
//省略部分               
:app:packageRelease                 
:app:zipalignRelease                 
:app:assembleRelease                 

BUILD SUCCESSFUL

OK，打包成功的apk路径如：E:\AndroidStudioProjects\Gradle4Android\app\build\outputs\apk\app-release.apk 这里写图片描述

完整配置

https://github.com/WuXiaolong/Gradle4Android

Le_leezp

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Gradle for Android

基本配置与依赖管理首先，我们先新建一个项目，在其中我们可以看到很多关于Gradle的配置文件 app/build.gradleapply plugin: 'com.android.application'android { compileSdkVersion 25 build
复制链接

扫一扫