Android gradle配置jar包加载顺序及延伸知识

---

前言

项目涉及到了要加载framework.jar，需要将libs文件夹下的framework.jar的依赖在原生framework依赖之前加载，触及到知识盲区，学习并记录下来。

项目的jdk环境:17.0.6

---

一、直接配置

1.APP目录下的build.gradle

先在app/libs文件夹下添加jar包,如果没有libs文件夹自行创建。

加入进项目后右击需要添加的jar，选择add as library，这时可以看到项目正在同步，同步完成过后可以发现APP目录下的build.gradle中的dependencies依赖下，新添加了依赖项

implementation files('libs\\framework.jar')

我们需要将 implementation 改为 compileOnly，like this：

compileOnly files('libs\\framework.jar')

然后再这个文件中加上这么一段代码,这时候APP目录下的build.gradle中我们应该改动了这些:

android {
   ...
   //加上这一块代码
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
        incremental true
    }
    ...
}

dependencies {
    compileOnly files('libs\\framework.jar')
   ...
}

2.项目级的build.gradle

项目级的需要import 相关的依赖来保证不出错，我这边的编译器会爆红，但是不影响编译
添加在顶部

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import org.jetbrains.kotlin.gradle.dsl.JvmTarget

然后添加如下代码：

...
allprojects {
   
    gradle.projectsEvaluated {
        tasks.withType(JavaCompile){
            options.compilerArgs << '-Xbootclasspath/p:CnsDVR/libs/framework.jar'
          
        }
    }
    tasks.withType(KotlinCompile).configureEach {
        compilerOptions.jvmTarget = JvmTarget.JVM_1_8
    }
}
...

3.其他问题

如果你的jar包没问题，那么应该就可以用了，代码会爆红，但是不影响编译，我跑的时候因为同时加入了另外一个wifi.jar，并且有依赖冲突报了，duplicate class这个错误，部分错误日志如下：

> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable

   > Duplicate class android.net.wifi.CoexUnsafeChannel found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.EasyConnectStatusCallback found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$Capabilities found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$ParcelableRttParams found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$ParcelableRttResults found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$ResponderCallback found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$ResponderConfig found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$RttCapabilities found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$RttListener found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

     Duplicate class android.net.wifi.RttManager$RttParams found in modules jetified-framework (framework.jar) and jetified-wifi (wifi.jar)

这个问题可以由两种解决方式，一种是把包里面的重复的类删除掉重新压缩放进去，另一种呢就是在APP目录下的build.gradle中排除掉多余的文件，类似如下：

android {
   ...
 
   
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
        incremental true
    }

//加上这一块代码
    packagingOptions {
        exclude 'com/android/internal/util/Preconditions.uau'
        exclude 'com/android/internal/util/AsyncChannel.uau'
    }
    ...
}

dependencies {
    compileOnly files('libs\\framework.jar')
   ...
}

这样就可以使用了。

二、gradle的生命周期及关键方法

1.关键方法

先复习下一些见名知意的方法

dependencies {
    compileOnly files('libs\\framework.jar')
   ...
}

compileOnly 用于将库添加为编译时依赖项，但在运行时不需要。这通常用于那些仅在编译时需要的库，例如某些测试库或编译时注解处理器。而implementation 用于将库添加为运行时依赖项。这是最常见的依赖关系类型，当你需要一个库在运行时可用时，你会使用它。

 packagingOptions {
        exclude 'com/android/internal/util/Preconditions.uau'
        exclude 'com/android/internal/util/AsyncChannel.uau'
    }

排除了两个路径文件，避免依赖冲突

tasks.withType(KotlinCompile).configureEach {  
    compilerOptions.jvmTarget = JvmTarget.JVM_1_8  
}

这里配置了Kotlin编译任务，设置其目标JVM版本为1.8。

2.gradle的生命周期

在使用的时候我们用到了这部分代码：

gradle.projectsEvaluated {  
    tasks.withType(JavaCompile){  
        options.compilerArgs << '-Xbootclasspath/p:CnsDVR/libs/framework.jar'  
     
    }  
}

这部分代码配置了Java编译任务。它为Java编译器提供了额外的命令行参数。这些参数指示Java虚拟机在启动时使用特定的类路径。

那么gradle.projectsEvaluated是什么呢？
gradle.projectsEvaluated 是一个Gradle的生命周期事件。在Gradle的构建生命周期中，有多个事件和阶段，每个阶段允许你执行或配置特定的任务。projectsEvaluated是这些事件之一。
当所有的项目都已经被评估，并且所有的build.gradle文件都已经被解析和执行后，projectsEvaluated事件就会被触发。换句话说，这是所有项目的配置阶段完成后的一个点。
为什么这个事件是有用的呢？
在某些情况下，你可能需要等待所有的项目配置完成后才能执行某些操作。例如，假设你有多个子项目，并且你想在主项目的build.gradle文件中对它们进行一些后处理或汇总操作。这样的操作可能依赖于所有子项目的配置信息，所以你需要确保在所有的项目都被评估后再执行这些操作。
在给出的代码示例中，gradle.projectsEvaluated被用来配置Java编译任务。这意味着只有当所有的项目都被评估后，这些Java编译的配置才会被应用。这可能是为了确保在配置Java编译选项之前，所有的其他插件或脚本都已经完成了它们的配置工作。
简而言之，gradle.projectsEvaluated为你提供了一个机会，在所有项目都被评估后执行某些操作或配置。

上面提到了Gradle的生命周期事件，那么Gradle的生命周期事件是什么呢？

Gradle的生命周期事件主要包括以下四个阶段：

1. 初始化阶段：在这个阶段，Gradle会读取项目的构建脚本并创建一个Project对象模型。同时，Gradle会检查构建脚本的语法和语义，以确保项目的正确性。此外，Gradle还会加载和执行插件，并根据插件中的规则来生成任务。如果有必要，Gradle还会执行一些预处理操作，例如解析依赖关系和配置项目属性。
2. 配置阶段：在这个阶段，Gradle会执行构建脚本中的所有语句，并将任务和属性配置好。在这个阶段，你可以使用代码来定义和配置任务，也可以使用插件来扩展和修改任务。同时，Gradle还会创建一个任务图，它表示所有任务之间的依赖关系。
3. 执行阶段：在配置阶段完成之后，Gradle会进入执行阶段。在这个阶段，Gradle会执行所有的任务，并根据任务之间的依赖关系来确定任务的执行顺序。如果任务之间存在依赖关系，Gradle会先执行依赖任务，然后再执行被依赖的任务。如果一个任务失败了，Gradle会停止构建过程并抛出异常。
4. 完成阶段：在所有任务执行完毕之后，Gradle会进入完成阶段。在这个阶段，Gradle会执行一些清理工作，例如关闭文件和网络连接等。如果有必要，Gradle还会生成报告和日志文件，并将构建的结果通知给用户。同时，Gradle也会处理用户的输入和输出，以确保构建过程的可交互性。

此外，在Gradle的生命周期中，每个阶段都有对应的钩子函数(Hook Function)，这些钩子函数可以在特定的阶段执行用户定义的代码。例如，在初始化阶段有settingsEvaluated和projectsEvaluated两个钩子函数；在配置阶段有beforeEvaluate和afterEvaluate两个钩子函数；在执行阶段有taskGraphReady、taskExecutionStarted、taskExecutionFinished等钩子函数；在完成阶段有buildFinished等钩子函数。通过使用这些钩子函数，你可以在Gradle生命周期的不同阶段执行自定义的操作，以满足特定的构建需求。

---

总结

以上就是今天要讲的内容，本文仅仅简单介绍了Android gradle配置jar包加载顺序及延伸知识。