Android Gradle 插件Android Studio 工程 Gradle 构建流程 ② ( settings.gradle 构建脚本分析 | 根目录下 build.gradle 分析 )

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件Android Studio 工程 Gradle 构建流程 ② ( settings.gradle 构建脚本分析 | 根目录下 build.gradle 分析 )相关的知识，希望对你有一定的参考价值。

文章目录





一、settings.gradle 构建脚本分析



1、Maven 远程仓库配置


pluginManagement 脚本块 ,

  • 用于 配置 Gradle 插件的 Maven 仓库 ,
  • 配置的是 构建过程 中 , 使用的仓库 ;

dependencyResolutionManagement 脚本块 ,

  • 用于 配置 依赖 的 Maven 仓库 ,
  • 配置的是 工程 或 模块 下的依赖使用的仓库 ;

在 dependencyResolutionManagement 脚本块 中 定义的 repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) 代码的含义是 解析依赖时 , 只能使用本脚本块中的 Maven 仓库 , 不能使用 Module 子项目中的依赖 ;


repositoriesMode 模式有两种 :

  • RepositoriesMode.PREFER_PROJECT : 解析依赖库时 , 优先使用本地仓库 , 本地仓库没有该依赖 , 则使用远程仓库 ;
  • RepositoriesMode.FAIL_ON_PROJECT_REPOS : 解析依赖库时 , 强行使用远程仓库 , 不管本地仓库有没有该依赖库 ;

参考之前的 【Android Gradle 插件】Android 依赖管理 ② ( 为工程配置依赖仓库 | 为工程构建添加依赖仓库 | classpath 引入依赖库 | 配置依赖仓库 ) 博客中的配置 ,

  • pluginManagement 脚本块中的 repositories 配置 , 对应之前的 buildscript 中的 repositories 配置 ;
  • dependencyResolutionManagement 脚本块中的 repositories 配置 , 对应之前的 allprojects 中的 repositories 配置 ;


2、目录配置


settings.gradle 构建脚本中的目录设置 :

  • rootProject.name 用于指定工程根目录 , 在该目录下有一个 build.gradle 构建脚本 , 声明后会自动执行该构建脚本 ;
	rootProject.name = "LiveDataDemo"
  • include 用于指定子项目 , 在子项目中也有一个 build.gradle 构建脚本 , 声明后会自动执行该构建脚本 ;
	include ':app'

3、完整代码示例


完整代码示例 :

pluginManagement 
    repositories 
        gradlePluginPortal()
        google()
        mavenCentral()
    

dependencyResolutionManagement 
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories 
        google()
        mavenCentral()
    

rootProject.name = "LiveDataDemo"
include ':app'




二、根目录下 build.gradle 构建脚本分析


根目录下 build.gradle 构建脚本如下 :

// Top-level build file where you can add configuration options common to all sub-projects/modules.
plugins 
    id 'com.android.application' version '7.3.1' apply false
    id 'com.android.library' version '7.3.1' apply false
    id 'org.jetbrains.kotlin.android' version '1.7.20' apply false

在 plugins 中使用

id 'com.android.application' version '7.3.1' apply false

配置 Gradle 插件 , 下面分析每个配置的含义 :

  • 引入 com.android.application 插件 ,
  • version '7.3.1' 说明引入插件的版本号 ,
  • apply false 表示当前不会马上引用该插件 , 在 Module 子项目 中使用到该插件时 , 才能正式应用 ;

在此处 主要是为了说明 Gradle 插件的版本 , 没有其它含义 ;


如 : 在 Module 子项目中 , 有如下配置 :

plugins 
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'

则会立刻应用 com.android.application 和 org.jetbrains.kotlin.android Gradle 插件 , 此处就不会有插件版本了 ;


在之前的 build.gradle 配置 中 , 在 " buildscript / dependencies / classpath " 中 , 配置 Android Gradle 插件版本 是 4.2.1 , 也就是

  • com.android.application
  • com.android.library

插件 的 版本 ;

buildscript 
    repositories 
        google()
        jcenter()
    
    dependencies 
        classpath 'com.android.tools.build:gradle:4.2.1'

Android Gradle 插件Gradle 自定义 Plugin 插件 ③ ( 自定义插件作用 | Android Gradle 插件的扩展 | 自定义 Extension 扩展 )

文章目录

Android Plugin DSL Reference 参考文档 :





一、自定义插件作用


在 Gradle 自定义插件 Plugin 中 , 如果要执行复杂的工作 , 可以在 实现的 Plugin 接口的 apply 函数中执行 ;

package org.gradle.api;

public interface Plugin<T> 
    void apply(T var1);

一般情况下 , 自定义插件工程都是针对 特定的 需求 , 开发固定功能的插件 ;





二、Android Gradle 插件的 AppExtension 扩展


Android Gradle 插件 也是一个 自定义插件 , 这个插件功能复杂 , 代码量较大 , 如 定义了 AppExtension , ProductFlavor 等上百个类 , 涉及到 Android 工程编译的方方面面 ; 详细参考 https://google.github.io/android-gradle-dsl 文档 ;


在 build.gradle 构建脚本 中的 android 脚本配置块 配置 , 其目的就是给 Android Gradle 插件 传递编译参数 ;

android 
    compileSdkVersion 31
    buildToolsVersion "30.0.3"

    defaultConfig 
        applicationId "kim.hsl.android_ui"
        minSdkVersion 18
        targetSdkVersion 31
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    

    buildTypes 
        release 
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        
    
    compileOptions 
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    
    kotlinOptions 
        jvmTarget = '1.8'




三、自定义 Extension 扩展


在 Android Gradle 插件中 , 定义了 AppExtension 扩展 , 对应的就是 build.gradle 构建脚本 中的 android 脚本块 ;

自定义 Gradle 插件中 , 可以定义自己的扩展 ;

首先 , 调用 project.extensions.create 方法 , 创建扩展 , 类似于 Android Gradle 插件中的 android , 引入了 MyPlugin 插件后 , 就可以使用 myplugin 配置块 ;

import org.gradle.api.Plugin
import org.gradle.api.Project

class MyPlugin implements Plugin<Project> 
    @Override
    void apply(Project project) 
        println 'MyPlugin'

        // 创建一个扩展
        // 类似于 Android Gradle 插件中的 android
        // 引入了 MyPlugin 插件后
        // 就可以使用 myplugin 配置块
        project.extensions.create("myplugin", MyPluginExtensions)

然后 , 创建 MyPluginExtensions 类 , 其中定义扩展项 ;

class MyPluginExtensions 
    def name
    def age

最后 , 在 build.gradle 构建脚本 中 , 配置自定义扩展 ;

apply plugin: MyPlugin

myplugin 
    name 'Tom'
    age 18

以上是关于Android Gradle 插件Android Studio 工程 Gradle 构建流程 ② ( settings.gradle 构建脚本分析 | 根目录下 build.gradle 分析 )的主要内容，如果未能解决你的问题，请参考以下文章

Android Gradle 插件Gradle 依赖管理 ① ( org.gradle.api.Project 配置 | Android Gradle 插件配置与 Gradle 配置关联 ) ★

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Gradle 依赖管理 ④ ( Android Gradle 插件中注册的依赖分组 | implementation | api | compileOnly )