Android Gradle 开发与应用 (七) : 实现打包自动复制文件插件

客官°小女子只卖身不卖艺 2024-04-25 20:26 4阅读 0赞

### 1. 前言 ###

项目中遇到了一个问题 :

其中一个模块`MyLibrary`的`assets`文件夹中，需要存放很多文件(`每个文件对应一个功能`)。

这样导致的问题是`MyLibrary`打出的这个`aar`包体积特别大。

如果把`MyLibrary`严谨地拆解成若干个`Module`又比较费时，对于现在业务现状来说也显得没那么必要。

那么能不能在上传`MyLibrary`这个`aar`的时候，自动复制相应的`文件`到`assets`目录下，打出不同功能的`aar`呢 ?

这就需要自己开发一个`Gradle`插件来完成这个功能了。

本文环境

*  `Android Studio 版本` : `Android Studio Hedgehog | 2023.1.1`
 *  `Gradle`版本 : `gradle-8.2`
 *  `AGP`版本 : `8.2.0`
 *  项目结构 : 项目有`app`模块和`MyLibrary`模块，使用`build.gradle` (`Groovy`语言)，`app`的`assets`目录下，有`test1.so`、`test2.so`、`test3.so`这三个文件

### 2. 配置上传Maven仓库 ###

首先我们把`MyLibrary`配置上传`Maven`的插件，也就是`maven-publish`。

对于这部分功能不了解的同学可以先看我的这篇博客 : [Android Module上传到Maven仓库 及 实现同时上传到多个Maven仓库][Android Module_Maven_ _ _Maven]

下面我们简单讲述一下

复制`maven_upload.gradle`到项目根目录下

apply plugin: 'maven-publish'
    
    //TODO 这里填你Maven仓库的地址
    def RELEASE_REPOSITORY_URL = "https://devops-maven.xxxxx.com/repository/yyyyy/"
    //TODO 这里填你Maven仓库的账号
    def NEXUS_USERNAME = "*********"
    //TODO 这里填你Maven仓库的密码
    def NEXUS_PASSWORD = "*********"
    
    afterEvaluate {
       
        
        publishing {
       
        
            repositories {
       
        
                maven {
       
        
                    name("ReleaseMaven")
                    url = RELEASE_REPOSITORY_URL
                    credentials {
       
        
                        username = NEXUS_USERNAME
                        password = NEXUS_PASSWORD
                    }
                }
            }
            publications {
       
        
                Production(MavenPublication) {
       
        
                    from components.release
                    groupId = rootProject.ext.GROUP
                    artifactId = rootProject.ext.POM_ARTIFACT_ID
                    version = rootProject.ext.VERSION_NAME
                }
            }
        }
    }

在`MyLibrary`中依赖

rootProject.ext.GROUP = "com.heiko.mytest"
    rootProject.ext.POM_ARTIFACT_ID = "mylibrary"
    rootProject.ext.VERSION_NAME = "1.0.0"
    apply from: "${
         
          project.rootDir}/maven_upload.gradle"

`Sync`一下，可以看到`gradle`中多了`publishing`这个文件夹，里面的`publishProductionPublicationToReleaseMavenRepository`就是用来将`MyLibrary`打包并上传到`Maven`仓库的`Gradle`命令了。

![在这里插入图片描述][e2bf0013ba50c9b3df154be3cb5dee59.png_pic_center]

### 3. Gradle相关操作 ###

#### 3.1 复制文件 ####

`from`是原目录，`into`是目标目录，`include`可以指定需要复制的文件，`onlyIf`可以用来判断是否执行复制任务。

task copyFiles(type: Copy) {
       
        
        from 'src/main/assets'
        into 'build/outputs/assets'
        //include 'test1.txt','test2.txt' //指定文件名
        include '**/*.txt' //根据*匹配符合要求的文件
        onlyIf {
       
        
             true
        }
    }

#### 3.2 删除文件 ####

task myDeleteFilesInDir(type: Delete) {
       
        
    	//delete 'src/main/assets/test1.txt'  //删除test1.txt
    	//delete 'src/main/assets/test1.txt' //删除文件夹下所有的文件，assets文件也会被删除
        delete fileTree('src/main/assets') //删除文件夹下所有的文件，assets文件不会被删除
    }

#### 3.3 dependsOn ####

`dependsOn`表示`一个任务`需要`另一个任务先完成`，可以理解为`依赖于`或`需要先做`，这意味着在执行这个任务之前，它所依赖的任务必须首先执行。

例如，如果你有一个任务叫做`compile`，它需要在`clean`任务之后执行，就可以像这样声明依赖关系：

task clearTask {
       
        
        doLast {
       
        
            println("执行 clear.doLast")
        }
    }
    
    task compileTask {
       
        
        doLast {
       
        
            println("执行 compile.dolast")
        }
    }
    
    compileTask.dependsOn(clearTask)

这样，每当你运行`compile`任务时，`Gradle`会首先运行`clean`任务。

![在这里插入图片描述][d0e392f276af53f76ee2b8a6a973ce63.png_pic_center]  
执行`compile`任务的日志如下

> Task :app:clearTask
    执行 clear.doLast
    
    > Task :app:compileTask
    执行 compile.dolast
    
    BUILD SUCCESSFUL in 510ms

更通俗的理解 :  
`dependsOn`就像是做饭的顺序：你首先需要准备食材，然后才能开始烹饪。同样地，如果你有一个任务依赖于另一个任务，那么你需要在开始当前任务之前先完成那个依赖任务。如果没有这种依赖关系，那么任务可能会在错误的时机执行，导致结果不正确或者出现错误。

//准备食材任务
    task prepareFood(){
       
        }
    
    //做饭任务
    task cooking(){
       
        }
    
    //做饭任务 依赖于 准备食材任务
    cooking.dependsOn(prepareFood)

![在这里插入图片描述][72d271a961bff4505bd55c77b6207194.png_pic_center]

#### 3.4 finalizedBy ####

`finalizedBy`用于指定`一个任务`在`另一个任务完成之后`执行，可以理解为`在完成后执行`。

在`Gradle`中，`finalizedBy`用于指定一个或多个任务，这些任务将在关联任务执行完毕后执行，无论关联任务是否成功。可以把这个理解为一种清理或收尾的工作。

举个例子，我们有一个任务A，它被`finalizedBy`任务B，那就意味着在任务A执行完之后，无论任务A是否成功，任务B都会被执行。

这就好比一个厨师在做完一道菜(`任务A`)之后，无论这道菜是否做

[Android Module_Maven_ _ _Maven]: https://blog.csdn.net/EthanCo/article/details/124277333
[e2bf0013ba50c9b3df154be3cb5dee59.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/3fef5c30373b447a8cc1c335f135c265.png
[d0e392f276af53f76ee2b8a6a973ce63.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/1f999af9e58348e19231a1ce15aad0ed.png
[72d271a961bff4505bd55c77b6207194.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/0ef3e417ebd24c119c90713cca34f811.png